API

iv = l..r

Construct a ClosedInterval iv spanning the region from l to r.

L"..."

Creates a LaTeXString and is equivalent to latexstring(raw"..."), except that %$ can be used for interpolation.

julia> L"x = \sqrt{2}"
L"$x = \sqrt{2}$"

julia> L"x = %$(sqrt(2))"
L"$x = 1.4142135623730951$"

usage @exctract scene (a, b, c, d)

usage @extractvalue scene (a, b, c, d) will become:

begin
    a = to_value(scene[:a])
    b = to_value(scene[:b])
    c = to_value(scene[:c])
    (a, b, c)
end
@get_attribute scene (a, b, c, d)

This will extract attribute a, b, c, d from scene and apply the correct attribute conversions + will extract the value if it's a signal. It will make those attributes available as variables and return them as a tuple. So the above is equal to: will become:

begin
    a = get_attribute(scene, :a)
    b = get_attribute(scene, :b)
    c = get_attribute(scene, :c)
    (a, b, c)
end

No documentation found.

MakieCore.@key_str is a macro.

# 1 method for macro "@key_str":
[1] var"@key_str"(__source__::LineNumberNode, __module__::Module, arg) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/types.jl:40

Replaces an expression with lift(argtuple -> expression, args...), where args are all expressions inside the main one that begin with $.

Example:

x = Observable(rand(100))
y = Observable(rand(100))

before

z = lift((x, y) -> x .+ y, x, y)

after

z = @lift($x .+ $y)

You can also use parentheses around an expression if that expression evaluates to an observable.

nt = (x = Observable(1), y = Observable(2))
@lift($(nt.x) + $(nt.y))

Plot Recipes in Makie

There's two types of recipes. Type recipes define a simple mapping from a user defined type to an existing plot type. Full recipes can customize the theme and define a custom plotting function.

Type recipes

Type recipe are really simple and just overload the argument conversion pipeline. This can be done for all plot types or for a subset of plot types:

# All plot types
convert_arguments(P::Type{<:AbstractPlot}, x::MyType) = convert_arguments(P, rand(10, 10))
# Only for scatter plots
convert_arguments(P::Type{<:Scatter}, x::MyType) = convert_arguments(P, rand(10, 10))

Optionally you may define the default plot type so that plot(x::MyType) will use this:

plottype(::MyType) = Surface

Full recipes with the @recipe macro

A full recipe for MyPlot comes in two parts. First is the plot type name, arguments and theme definition which are defined using the @recipe macro. Second is a custom plot! for MyPlot, implemented in terms of the atomic plotting functions.

We use an example to show how this works:

# arguments (x, y, z) && theme are optional
@recipe(MyPlot, x, y, z) do scene
    Attributes(
        plot_color => :red
    )
end

This macro expands to several things. Firstly a type definition:

const MyPlot{ArgTypes} = Combined{myplot, ArgTypes}

The type parameter of Combined contains the function instead of e.g. a symbol. This way the mapping from MyPlot to myplot is safer and simpler. (The downside is we always need a function myplot - TODO: is this a problem?)

The following signatures are defined to make MyPlot nice to use:

myplot(args...; kw_args...) = ...
myplot!(scene, args...; kw_args...) = ...
myplot(kw_args::Dict, args...) = ...
myplot!(scene, kw_args::Dict, args...) = ...
#etc (not 100% settled what signatures there will be)

A specialization of argument_names is emitted if you have an argument list (x,y,z) provided to the recipe macro:

argument_names(::Type{<: MyPlot}) = (:x, :y, :z)

This is optional but it will allow the use of plot_object[:x] to fetch the first argument from the call plot_object = myplot(rand(10), rand(10), rand(10)), for example. Alternatively you can always fetch the ith argument using plot_object[i], and if you leave out the (x,y,z), the default version of argument_names will provide plot_object[:arg1] etc.

The theme given in the body of the @recipe invocation is inserted into a specialization of default_theme which inserts the theme into any scene that plots MyPlot:

function default_theme(scene, ::MyPlot)
    Attributes(
        plot_color => :red
    )
end

As the second part of defining MyPlot, you should implement the actual plotting of the MyPlot object by specializing plot!:

function plot!(plot::MyPlot)
    # normal plotting code, building on any previously defined recipes
    # or atomic plotting operations, and adding to the combined `plot`:
    lines!(plot, rand(10), color = plot[:plot_color])
    plot!(plot, plot[:x], plot[:y])
    plot
end

It's possible to add specializations here, depending on the argument types supplied to myplot. For example, to specialize the behavior of myplot(a) when a is a 3D array of floating point numbers:

const MyVolume = MyPlot{Tuple{<:AbstractArray{<: AbstractFloat, 3}}}
argument_names(::Type{<: MyVolume}) = (:volume,) # again, optional
function plot!(plot::MyVolume)
    # plot a volume with a colormap going from fully transparent to plot_color
    volume!(plot, plot[:volume], colormap = :transparent => plot[:plot_color])
    plot
end

The docstring given to the recipe will be transferred to the functions it generates.

Absolute

Force transformation to be absolute, not relative to the current state. This is the default setting.

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any

No documentation found.

Summary

abstract type Makie.AbstractCamera <: Any

Subtypes

Makie.Camera2D
Makie.Camera3D
Makie.EmptyCamera
Makie.MakieLayout.OrthographicCamera
Makie.OldCamera3D
Makie.PixelCamera
Makie.RelativeCamera

No documentation found.

MakieCore.AbstractPlot is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

abstract type MakieCore.AbstractScene <: MakieCore.Transformable

Subtypes

Makie.Scene

Supertype Hierarchy

MakieCore.AbstractScene <: MakieCore.Transformable <: Any

No documentation found.

Summary

abstract type MakieCore.AbstractScreen <: AbstractDisplay

Subtypes

CairoMakie.CairoScreen
GLMakie.GLScreen
RPRMakie.RPRScreen
WGLMakie.ThreeDisplay
WGLMakie.WebDisplay

Supertype Hierarchy

MakieCore.AbstractScreen <: AbstractDisplay <: Any
Accum

Force transformation to be relative to the current state, not absolute.

A simple, one color ambient light.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct GridLayoutBase.Aspect <: Any

Fields

index :: Int64
ratio :: Float32
Union{Types...}

A type union is an abstract type which includes all instances of any of its argument types. The empty union Union{} is the bottom type of Julia.

Examples

julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}

julia> 1 :: IntOrString
1

julia> "Hello!" :: IntOrString
"Hello!"

julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64

Main structure for holding attributes, for theming plots etc! Will turn all values into observables, so that they can be updated.

struct Auto

If used as a GridLayout's row / column size and trydetermine == true, signals to the GridLayout that the row / column should shrink to match the largest determinable element inside. If no size of a content element can be determined, the remaining space is split between all Auto rows / columns according to their ratio.

If used as width / height of a layoutable element and trydetermine == true, the element's computed width / height will report the auto width / height if it can be determined. This enables a parent GridLayout to adjust its column / rowsize to the element's width / height. If trydetermine == false, the element's computed width / height will report nothing even if an auto width / height can be determined, which will prohibit a parent GridLayout from adjusting a row / column to the element's width / height. This is useful to, e.g., prohibit a GridLayout from shrinking a column's width to the width of a super title, even though the title's width can be auto-determined.

The ratio is ignored if Auto is used as an element size.

Makie.MakieLayout.Axis <: Block

A 2D axis which can be plotted into.

Constructors

Axis(fig_or_scene; palette = nothing, kwargs...)

Examples

ax = Axis(fig[1, 1])

Attributes

Makie.MakieLayout.Axis attributes:

  • aspect: The forced aspect ratio of the axis. nothing leaves the axis unconstrained, DataAspect() forces the same ratio as the ratio in data limits between x and y axis, AxisAspect(ratio) sets a manual ratio. Default: nothing

  • autolimitaspect: Constrains the data aspect ratio (nothing leaves the ratio unconstrained). Default: nothing

  • backgroundcolor: The background color of the axis. Default: :white

  • bottomspinecolor: The color of the bottom axis spine. Default: :black

  • bottomspinevisible: Controls if the bottom axis spine is visible. Default: true

  • flip_ylabel: Controls if the ylabel's rotation is flipped. Default: false

  • leftspinecolor: The color of the left axis spine. Default: :black

  • leftspinevisible: Controls if the left axis spine is visible. Default: true

  • limits: The limits that the user has manually set. They are reinstated when calling reset_limits! and are set to nothing by autolimits!. Can be either a tuple (xlow, xhigh, ylow, high) or a tuple (nothingorxlims, nothingorylims). Are set by xlims!, ylims! and limits!. Default: (nothing, nothing)

  • panbutton: The button for panning. Default: Makie.Mouse.right

  • rightspinecolor: The color of the right axis spine. Default: :black

  • rightspinevisible: Controls if the right axis spine is visible. Default: true

  • spinewidth: The width of the axis spines. Default: 1.0

  • subtitle: The axis subtitle string. Default: ""

  • subtitlecolor: The color of the subtitle Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:225 =# @inherit :textcolor :black

  • subtitlefont: The font family of the subtitle. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:217 =# @inherit :font "TeX Gyre Heros Makie"

  • subtitlegap: The gap between subtitle and title. Default: 0

  • subtitlelineheight: The axis subtitle line height multiplier. Default: 1

  • subtitlesize: The subtitle's font size. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:219 =# @inherit :fontsize 16.0f0

  • subtitlevisible: Controls if the subtitle is visible. Default: true

  • title: The axis title string. Default: ""

  • titlealign: The horizontal alignment of the title. Default: :center

  • titlecolor: The color of the title Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:211 =# @inherit :textcolor :black

  • titlefont: The font family of the title. Default: "TeX Gyre Heros Makie Bold"

  • titlegap: The gap between axis and title. Default: 4.0

  • titlelineheight: The axis title line height multiplier. Default: 1

  • titlesize: The title's font size. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:203 =# @inherit :fontsize 16.0f0

  • titlevisible: Controls if the title is visible. Default: true

  • topspinecolor: The color of the top axis spine. Default: :black

  • topspinevisible: Controls if the top axis spine is visible. Default: true

  • xautolimitmargin: The relative margins added to the autolimits in x direction. Default: (0.05f0, 0.05f0)

  • xaxisposition: The position of the x axis (:bottom or :top). Default: :bottom

  • xgridcolor: The color of the x grid lines. Default: RGBAf(0, 0, 0, 0.12)

  • xgridstyle: The linestyle of the x grid lines. Default: nothing

  • xgridvisible: Controls if the x grid lines are visible. Default: true

  • xgridwidth: The width of the x grid lines. Default: 1.0

  • xlabel: The xlabel string. Default: ""

  • xlabelcolor: The color of the xlabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:233 =# @inherit :textcolor :black

  • xlabelfont: The font family of the xlabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:229 =# @inherit :font "TeX Gyre Heros Makie"

  • xlabelpadding: The padding between the xlabel and the ticks or axis. Default: 3.0

  • xlabelsize: The font size of the xlabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:237 =# @inherit :fontsize 16.0f0

  • xlabelvisible: Controls if the xlabel is visible. Default: true

  • xminorgridcolor: The color of the x minor grid lines. Default: RGBAf(0, 0, 0, 0.05)

  • xminorgridstyle: The linestyle of the x minor grid lines. Default: nothing

  • xminorgridvisible: Controls if the x minor grid lines are visible. Default: false

  • xminorgridwidth: The width of the x minor grid lines. Default: 1.0

  • xminortickalign: The alignment of x minor ticks on the axis spine Default: 0.0

  • xminortickcolor: The tick color of x minor ticks Default: :black

  • xminorticks: The tick locator for the x minor ticks Default: IntervalsBetween(2)

  • xminorticksize: The tick size of x minor ticks Default: 4.0

  • xminorticksvisible: Controls if minor ticks on the x axis are visible Default: false

  • xminortickwidth: The tick width of x minor ticks Default: 1.0

  • xpankey: The key for limiting panning to the x direction. Default: Makie.Keyboard.x

  • xpanlock: Locks interactive panning in the x direction. Default: false

  • xrectzoom: Controls if rectangle zooming affects the x dimension. Default: true

  • xreversed: Controls if the x axis goes rightwards (false) or leftwards (true) Default: false

  • xscale: The x axis scale Default: identity

  • xtickalign: The alignment of the xtick marks relative to the axis spine (0 = out, 1 = in). Default: 0.0

  • xtickcolor: The color of the xtick marks. Default: RGBf(0, 0, 0)

  • xtickformat: Format for xticks. Default: Makie.automatic

  • xticklabelalign: The horizontal and vertical alignment of the xticklabels. Default: Makie.automatic

  • xticklabelcolor: The color of xticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:253 =# @inherit :textcolor :black

  • xticklabelfont: The font family of the xticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:249 =# @inherit :font "TeX Gyre Heros Makie"

  • xticklabelpad: The space between xticks and xticklabels. Default: 2.0

  • xticklabelrotation: The counterclockwise rotation of the xticklabels in radians. Default: 0.0

  • xticklabelsize: The font size of the xticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:257 =# @inherit :fontsize 16.0f0

  • xticklabelspace: The space reserved for the xticklabels. Default: Makie.automatic

  • xticklabelsvisible: Controls if the xticklabels are visible. Default: true

  • xticks: The xticks. Default: Makie.automatic

  • xticksize: The size of the xtick marks. Default: 6.0

  • xticksvisible: Controls if the xtick marks are visible. Default: true

  • xtickwidth: The width of the xtick marks. Default: 1.0

  • xtrimspine: Controls if the x spine is limited to the furthest tick marks or not. Default: false

  • xzoomkey: The key for limiting zooming to the x direction. Default: Makie.Keyboard.x

  • xzoomlock: Locks interactive zooming in the x direction. Default: false

  • yautolimitmargin: The relative margins added to the autolimits in y direction. Default: (0.05f0, 0.05f0)

  • yaxisposition: The position of the y axis (:left or :right). Default: :left

  • ygridcolor: The color of the y grid lines. Default: RGBAf(0, 0, 0, 0.12)

  • ygridstyle: The linestyle of the y grid lines. Default: nothing

  • ygridvisible: Controls if the y grid lines are visible. Default: true

  • ygridwidth: The width of the y grid lines. Default: 1.0

  • ylabel: The ylabel string. Default: ""

  • ylabelcolor: The color of the ylabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:235 =# @inherit :textcolor :black

  • ylabelfont: The font family of the ylabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:231 =# @inherit :font "TeX Gyre Heros Makie"

  • ylabelpadding: The padding between the ylabel and the ticks or axis. Default: 5.0

  • ylabelsize: The font size of the ylabel. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:239 =# @inherit :fontsize 16.0f0

  • ylabelvisible: Controls if the ylabel is visible. Default: true

  • yminorgridcolor: The color of the y minor grid lines. Default: RGBAf(0, 0, 0, 0.05)

  • yminorgridstyle: The linestyle of the y minor grid lines. Default: nothing

  • yminorgridvisible: Controls if the y minor grid lines are visible. Default: false

  • yminorgridwidth: The width of the y minor grid lines. Default: 1.0

  • yminortickalign: The alignment of y minor ticks on the axis spine Default: 0.0

  • yminortickcolor: The tick color of y minor ticks Default: :black

  • yminorticks: The tick locator for the y minor ticks Default: IntervalsBetween(2)

  • yminorticksize: The tick size of y minor ticks Default: 4.0

  • yminorticksvisible: Controls if minor ticks on the y axis are visible Default: false

  • yminortickwidth: The tick width of y minor ticks Default: 1.0

  • ypankey: The key for limiting panning to the y direction. Default: Makie.Keyboard.y

  • ypanlock: Locks interactive panning in the y direction. Default: false

  • yrectzoom: Controls if rectangle zooming affects the y dimension. Default: true

  • yreversed: Controls if the y axis goes upwards (false) or downwards (true) Default: false

  • yscale: The y axis scale Default: identity

  • ytickalign: The alignment of the ytick marks relative to the axis spine (0 = out, 1 = in). Default: 0.0

  • ytickcolor: The color of the ytick marks. Default: RGBf(0, 0, 0)

  • ytickformat: Format for yticks. Default: Makie.automatic

  • yticklabelalign: The horizontal and vertical alignment of the yticklabels. Default: Makie.automatic

  • yticklabelcolor: The color of yticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:255 =# @inherit :textcolor :black

  • yticklabelfont: The font family of the yticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:251 =# @inherit :font "TeX Gyre Heros Makie"

  • yticklabelpad: The space between yticks and yticklabels. Default: 4.0

  • yticklabelrotation: The counterclockwise rotation of the yticklabels in radians. Default: 0.0

  • yticklabelsize: The font size of the yticklabels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:259 =# @inherit :fontsize 16.0f0

  • yticklabelspace: The space reserved for the yticklabels. Default: Makie.automatic

  • yticklabelsvisible: Controls if the yticklabels are visible. Default: true

  • yticks: The yticks. Default: Makie.automatic

  • yticksize: The size of the ytick marks. Default: 6.0

  • yticksvisible: Controls if the ytick marks are visible. Default: true

  • ytickwidth: The width of the ytick marks. Default: 1.0

  • ytrimspine: Controls if the y spine is limited to the furthest tick marks or not. Default: false

  • yzoomkey: The key for limiting zooming to the y direction. Default: Makie.Keyboard.y

  • yzoomlock: Locks interactive zooming in the y direction. Default: false

Layout attributes:

  • alignmode: The align mode of the axis in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the axis within its suggested bounding box. Default: :center

  • height: The height of the axis. Default: nothing

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the axis within its suggested bounding box. Default: :center

  • width: The width of the axis. Default: nothing

Makie.MakieLayout.Axis3 <: Block

Attributes

Makie.MakieLayout.Axis3 attributes:

  • aspect: Aspects of the 3 axes with each other Default: (1.0, 1.0, 2 / 3)

  • azimuth: The azimuth angle of the camera Default: 1.275pi

  • backgroundcolor: The background color Default: :transparent

  • elevation: The elevation angle of the camera Default: pi / 8

  • limits: The limits that the user has manually set. They are reinstated when calling reset_limits! and are set to nothing by autolimits!. Can be either a tuple (xlow, xhigh, ylow, high, zlow, zhigh) or a tuple (nothingorxlims, nothingorylims, nothingorzlims). Are set by xlims!, ylims!, zlims! and limits!. Default: (nothing, nothing, nothing)

  • perspectiveness: A number between 0 and 1, where 0 is orthographic, and 1 full perspective Default: 0.0

  • protrusions: The protrusions on the sides of the axis, how much gap space is reserved for labels etc. Default: 30

  • targetlimits: The limits that the axis tries to set given other constraints like aspect. Don't set this directly, use xlims!, ylims! or limits! instead. Default: Rect3f(Vec3f(0, 0, 0), Vec3f(1, 1, 1))

  • title: The axis title string. Default: ""

  • titlealign: The horizontal alignment of the title. Default: :center

  • titlecolor: The color of the title Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1333 =# @inherit :textcolor :black

  • titlefont: The font family of the title. Default: "TeX Gyre Heros Makie Bold"

  • titlegap: The gap between axis and title. Default: 4.0

  • titlesize: The title's font size. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1325 =# @inherit :fontsize 16.0f0

  • titlevisible: Controls if the title is visible. Default: true

  • viewmode: The view mode which affects the final projection. :fit results in the projection that always fits the limits into the viewport, invariant to rotation. :fitzoom keeps the x/y ratio intact but stretches the view so the corners touch the scene viewport. :stretch scales separately in both x and y direction to fill the viewport, which can distort the aspect that is set. Default: :fitzoom

  • xautolimitmargin: The relative margins added to the autolimits in x direction. Default: (0.05, 0.05)

  • xgridcolor: The x grid color Default: RGBAf(0, 0, 0, 0.12)

  • xgridvisible: Controls if the x grid is visible Default: true

  • xgridwidth: The x grid width Default: 1

  • xlabel: The x label Default: "x"

  • xlabelalign: The x label align Default: Makie.automatic

  • xlabelcolor: The x label color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1169 =# @inherit :textcolor :black

  • xlabelfont: The x label font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1199 =# @inherit :font "TeX Gyre Heros Makie"

  • xlabeloffset: The x label offset Default: 40

  • xlabelrotation: The x label rotation Default: Makie.automatic

  • xlabelsize: The x label size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1193 =# @inherit :fontsize 16.0f0

  • xlabelvisible: Controls if the x label is visible Default: true

  • xspinecolor_1: The color of x spine 1 where the ticks are displayed Default: :black

  • xspinecolor_2: The color of x spine 2 towards the center Default: :black

  • xspinecolor_3: The color of x spine 3 opposite of the ticks Default: :black

  • xspinesvisible: Controls if the x spine is visible Default: true

  • xspinewidth: The x spine width Default: 1

  • xtickcolor: The x tick color Default: :black

  • xtickformat: The x tick format Default: Makie.automatic

  • xticklabelcolor: The x ticklabel color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1223 =# @inherit :textcolor :black

  • xticklabelfont: The x ticklabel font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1241 =# @inherit :font "TeX Gyre Heros Makie"

  • xticklabelpad: The x ticklabel pad Default: 5

  • xticklabelsize: The x ticklabel size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1229 =# @inherit :fontsize 16.0f0

  • xticklabelsvisible: Controls if the x ticklabels are visible Default: true

  • xticks: The x ticks Default: WilkinsonTicks(5; k_min = 3)

  • xticksvisible: Controls if the x ticks are visible Default: true

  • xtickwidth: The x tick width Default: 1

  • xypanelcolor: The color of the xy panel Default: :transparent

  • xypanelvisible: Controls if the xy panel is visible Default: true

  • xzpanelcolor: The color of the xz panel Default: :transparent

  • xzpanelvisible: Controls if the xz panel is visible Default: true

  • yautolimitmargin: The relative margins added to the autolimits in y direction. Default: (0.05, 0.05)

  • ygridcolor: The y grid color Default: RGBAf(0, 0, 0, 0.12)

  • ygridvisible: Controls if the y grid is visible Default: true

  • ygridwidth: The y grid width Default: 1

  • ylabel: The y label Default: "y"

  • ylabelalign: The y label align Default: Makie.automatic

  • ylabelcolor: The y label color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1171 =# @inherit :textcolor :black

  • ylabelfont: The y label font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1201 =# @inherit :font "TeX Gyre Heros Makie"

  • ylabeloffset: The y label offset Default: 40

  • ylabelrotation: The y label rotation Default: Makie.automatic

  • ylabelsize: The y label size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1195 =# @inherit :fontsize 16.0f0

  • ylabelvisible: Controls if the y label is visible Default: true

  • yspinecolor_1: The color of y spine 1 where the ticks are displayed Default: :black

  • yspinecolor_2: The color of y spine 2 towards the center Default: :black

  • yspinecolor_3: The color of y spine 3 opposite of the ticks Default: :black

  • yspinesvisible: Controls if the y spine is visible Default: true

  • yspinewidth: The y spine width Default: 1

  • ytickcolor: The y tick color Default: :black

  • ytickformat: The y tick format Default: Makie.automatic

  • yticklabelcolor: The y ticklabel color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1225 =# @inherit :textcolor :black

  • yticklabelfont: The y ticklabel font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1243 =# @inherit :font "TeX Gyre Heros Makie"

  • yticklabelpad: The y ticklabel pad Default: 5

  • yticklabelsize: The y ticklabel size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1231 =# @inherit :fontsize 16.0f0

  • yticklabelsvisible: Controls if the y ticklabels are visible Default: true

  • yticks: The y ticks Default: WilkinsonTicks(5; k_min = 3)

  • yticksvisible: Controls if the y ticks are visible Default: true

  • ytickwidth: The y tick width Default: 1

  • yzpanelcolor: The color of the yz panel Default: :transparent

  • yzpanelvisible: Controls if the yz panel is visible Default: true

  • zautolimitmargin: The relative margins added to the autolimits in z direction. Default: (0.05, 0.05)

  • zgridcolor: The z grid color Default: RGBAf(0, 0, 0, 0.12)

  • zgridvisible: Controls if the z grid is visible Default: true

  • zgridwidth: The z grid width Default: 1

  • zlabel: The z label Default: "z"

  • zlabelalign: The z label align Default: Makie.automatic

  • zlabelcolor: The z label color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1173 =# @inherit :textcolor :black

  • zlabelfont: The z label font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1203 =# @inherit :font "TeX Gyre Heros Makie"

  • zlabeloffset: The z label offset Default: 50

  • zlabelrotation: The z label rotation Default: Makie.automatic

  • zlabelsize: The z label size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1197 =# @inherit :fontsize 16.0f0

  • zlabelvisible: Controls if the z label is visible Default: true

  • zspinecolor_1: The color of z spine 1 where the ticks are displayed Default: :black

  • zspinecolor_2: The color of z spine 2 towards the center Default: :black

  • zspinecolor_3: The color of z spine 3 opposite of the ticks Default: :black

  • zspinesvisible: Controls if the z spine is visible Default: true

  • zspinewidth: The z spine width Default: 1

  • ztickcolor: The z tick color Default: :black

  • ztickformat: The z tick format Default: Makie.automatic

  • zticklabelcolor: The z ticklabel color Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1227 =# @inherit :textcolor :black

  • zticklabelfont: The z ticklabel font Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1245 =# @inherit :font "TeX Gyre Heros Makie"

  • zticklabelpad: The z ticklabel pad Default: 10

  • zticklabelsize: The z ticklabel size Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1233 =# @inherit :fontsize 16.0f0

  • zticklabelsvisible: Controls if the z ticklabels are visible Default: true

  • zticks: The z ticks Default: WilkinsonTicks(5; k_min = 3)

  • zticksvisible: Controls if the z ticks are visible Default: true

  • ztickwidth: The z tick width Default: 1

Layout attributes:

  • alignmode: The alignment of the scene in its suggested bounding box. Default: Inside()

  • halign: The horizontal alignment of the scene in its suggested bounding box. Default: :center

  • height: The height setting of the scene. Default: nothing

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the scene in its suggested bounding box. Default: :center

  • width: The width setting of the scene. Default: nothing

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Makie.MakieLayout.AxisAspect <: Any

Fields

aspect :: Float32

No documentation found.

GridLayoutBase.BBox is a Function.

# 1 method for generic function "BBox":
[1] BBox(left::Number, right::Number, bottom::Number, top::Number) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/helpers.jl:120

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any
Billboard([angle::Real])
Billboard([angles::Vector{<: Real}])

Billboard attribute to always have a primitive face the camera. Can be used for rotation.

No documentation found.

Summary

struct GridLayoutBase.Bottom <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Bottom <: GridLayoutBase.Side <: Any

No documentation found.

Summary

struct GridLayoutBase.BottomLeft <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.BottomLeft <: GridLayoutBase.Side <: Any

No documentation found.

Summary

struct GridLayoutBase.BottomRight <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.BottomRight <: GridLayoutBase.Side <: Any

Makie.MakieLayout.Box <: Block

Attributes

Makie.MakieLayout.Box attributes:

  • color: The color of the rectangle. Default: RGBf(0.9, 0.9, 0.9)

  • padding: The extra space added to the sides of the rectangle boundingbox. Default: (0.0f0, 0.0f0, 0.0f0, 0.0f0)

  • strokecolor: The color of the border. Default: RGBf(0, 0, 0)

  • strokevisible: Controls if the border of the rectangle is visible. Default: true

  • strokewidth: The line width of the rectangle's border. Default: 1.0

  • visible: Controls if the rectangle is visible. Default: true

Layout attributes:

  • alignmode: The align mode of the rectangle in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the rectangle in its suggested boundingbox Default: :center

  • height: The height setting of the rectangle. Default: nothing

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the rectangle in its suggested boundingbox Default: :center

  • width: The width setting of the rectangle. Default: nothing

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Makie.MakieLayout.Button <: Block

Attributes

Makie.MakieLayout.Button attributes:

  • buttoncolor: The color of the button. Default: RGBf(0.94, 0.94, 0.94)

  • buttoncolor_active: The color of the button when the mouse clicks the button. Default: COLOR_ACCENT[]

  • buttoncolor_hover: The color of the button when the mouse hovers over the button. Default: COLOR_ACCENT_DIMMED[]

  • clicks: The number of clicks that have been registered by the button. Default: 0

  • cornerradius: The radius of the rounded corners of the button. Default: 4

  • cornersegments: The number of poly segments used for each rounded corner. Default: 10

  • font: The font family of the button label. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:771 =# @inherit :font "TeX Gyre Heros Makie"

  • label: The text of the button label. Default: "Button"

  • labelcolor: The color of the label. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:791 =# @inherit :textcolor :black

  • labelcolor_active: The color of the label when the mouse clicks the button. Default: :white

  • labelcolor_hover: The color of the label when the mouse hovers over the button. Default: :black

  • padding: The extra space added to the sides of the button label's boundingbox. Default: (10.0f0, 10.0f0, 10.0f0, 10.0f0)

  • strokecolor: The color of the button border. Default: :transparent

  • strokewidth: The line width of the button border. Default: 2.0

  • textsize: The font size of the button label. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:767 =# @inherit :fontsize 16.0f0

Layout attributes:

  • alignmode: The align mode of the button in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the button in its suggested boundingbox Default: :center

  • height: The height setting of the button. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the button in its suggested boundingbox Default: :center

  • width: The width setting of the button. Default: Auto()

Camera(pixel_area)

Struct to hold all relevant matrices and additional parameters, to let backends apply camera based transformations.

No documentation found.

Summary

struct Makie.Camera2D <: Makie.AbstractCamera

Fields

area          :: Observables.Observable{GeometryBasics.HyperRectangle{2, Float32}}
zoomspeed     :: Observables.Observable{Float32}
zoombutton    :: Observables.Observable{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button}}
panbutton     :: Observables.Observable{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button, Vector{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button}}}}
padding       :: Observables.Observable{Float32}
last_area     :: Observables.Observable{GeometryBasics.Vec2{Int64}}
update_limits :: Observables.Observable{Bool}

Supertype Hierarchy

Makie.Camera2D <: Makie.AbstractCamera <: Any
Camera3D(scene[; attributes...])

Creates a 3d camera with a lot of controls.

The 3D camera is (or can be) unrestricted in terms of rotations and translations. Both cam3d!(scene) and cam3d_cad!(scene) create this camera type. Unlike the 2D camera, settings and controls are stored in the cam.attributes field rather than in the struct directly, but can still be passed as keyword arguments. The general camera settings include

  • fov = 45f0 sets the "neutral" field of view, i.e. the fov corresponding to no zoom. This is irrelevant if the camera uses an orthographic projection.

  • near = automatic sets the value of the near clip. By default this will be chosen based on the scenes bounding box. The final value is in cam.near.

  • far = automatic sets the value of the far clip. By default this will be chosen based on the scenes bounding box. The final value is in cam.far.

  • rotation_center = :lookat sets the default center for camera rotations. Currently allows :lookat or :eyeposition.

  • projectiontype = Perspective sets the type of the projection. Can be Orthographic or Perspective.

  • fixed_axis = false: If true panning uses the (world/plot) z-axis instead of the camera up direction.

  • zoom_shift_lookat = true: If true attempts to keep data under the cursor in view when zooming.

  • cad = false: If true rotates the view around lookat when zooming off-center.

The camera view follows from the position of the camera eyeposition, the point which the camera focuses lookat and the up direction of the camera upvector. These can be accessed as cam.eyeposition etc and adjusted via update_cam!(scene, cameracontrols(scene), eyeposition, lookat[, upvector = Vec3f(0, 0, 1)]). They can also be passed as keyword arguments when the camera is constructed.

The camera can be controlled by keyboard and mouse. The keyboard has the following available attributes

  • up_key = Keyboard.r sets the key for translations towards the top of the screen.

  • down_key = Keyboard.f sets the key for translations towards the bottom of the screen.

  • left_key = Keyboard.a sets the key for translations towards the left of the screen.

  • right_key = Keyboard.d sets the key for translations towards the right of the screen.

  • forward_key = Keyboard.w sets the key for translations into the screen.

  • backward_key = Keyboard.s sets the key for translations out of the screen.

  • zoom_in_key = Keyboard.u sets the key for zooming into the scene (enlarge, via fov).

  • zoom_out_key = Keyboard.o sets the key for zooming out of the scene (shrink, via fov).

  • stretch_view_key = Keyboard.page_up sets the key for moving eyepostion away from lookat.

  • contract_view_key = Keyboard.page_down sets the key for moving eyeposition towards lookat.

  • pan_left_key = Keyboard.j sets the key for rotations around the screens vertical axis.

  • pan_right_key = Keyboard.l sets the key for rotations around the screens vertical axis.

  • tilt_up_key = Keyboard.i sets the key for rotations around the screens horizontal axis.

  • tilt_down_key = Keyboard.k sets the key for rotations around the screens horizontal axis.

  • roll_clockwise_key = Keyboard.e sets the key for rotations of the screen.

  • roll_counterclockwise_key = Keyboard.q sets the key for rotations of the screen.

  • keyboard_rotationspeed = 1f0 sets the speed of keyboard based rotations.

  • keyboard_translationspeed = 0.5f0 sets the speed of keyboard based translations.

  • keyboard_zoomspeed = 1f0 sets the speed of keyboard based zooms.

  • update_rate = 1/30 sets the rate at which keyboard based camera updates are evaluated.

and mouse interactions are controlled by

  • translation_button = Mouse.right sets the mouse button for drag-translations. (up/down/left/right)

  • scroll_mod = true sets an additional modifier button for scroll-based zoom. (true being neutral)

  • rotation_button = Mouse.left sets the mouse button for drag-rotations. (pan, tilt)

  • mouse_rotationspeed = 1f0 sets the speed of mouse rotations.

  • mouse_translationspeed = 0.5f0 sets the speed of mouse translations.

  • mouse_zoomspeed = 1f0 sets the speed of mouse zooming (mousewheel).

  • circular_rotation = (true, true, true) enables circular rotations for (fixed x, fixed y, fixed z) rotation axis. (This means drawing a circle with your mouse around the center of the scene will result in a continuous rotation.)

There are also a few generally applicable controls:

  • fix_x_key = Keyboard.x sets the key for fixing translations and rotations to the (world/plot) x-axis.

  • fix_y_key = Keyboard.y sets the key for fixing translations and rotations to the (world/plot) y-axis.

  • fix_z_key = Keyboard.z sets the key for fixing translations and rotations to the (world/plot) z-axis.

  • reset = Keyboard.home sets the key for fully resetting the camera. This equivalent to setting lookat = Vec3f(0), upvector = Vec3f(0, 0, 1), eyeposition = Vec3f(3) and then calling center!(scene).

You can also make adjustments to the camera position, rotation and zoom by calling relevant functions:

  • translate_cam!(scene, v) will translate the camera by the given world/plot space vector v.

  • rotate_cam!(scene, angles) will rotate the camera around its axes with the corresponding angles. The first angle will rotate around the cameras "right" that is the screens horizontal axis, the second around the up vector/vertical axis or Vec3f(0, 0, +-1) if fixed_axis = true, and the third will rotate around the view direction i.e. the axis out of the screen. The rotation respects the current rotation_center of the camera.

  • zoom!(scene, zoom_step) will change the zoom level of the scene without translating or rotating the scene. zoom_step applies multiplicatively to cam.zoom_mult which is used as a multiplier to the fov (perspective projection) or width and height (orthographic projection).

HyperSphere{N, T}

A HyperSphere is a generalization of a sphere into N-dimensions. A center and radius, r, must be specified.

Makie.MakieLayout.Colorbar <: Block

Create a colorbar that shows a continuous or categorical colormap with ticks chosen according to the colorrange.

You can set colorrange and colormap manually, or pass a plot object as the second argument to copy its respective attributes.

Constructors

Colorbar(fig_or_scene; kwargs...)
Colorbar(fig_or_scene, plot::AbstractPlot; kwargs...)
Colorbar(fig_or_scene, heatmap::Union{Heatmap, Image}; kwargs...)
Colorbar(fig_or_scene, contourf::Makie.Contourf; kwargs...)

Attributes

Makie.MakieLayout.Colorbar attributes:

  • bottomspinecolor: The color of the bottom spine. Default: RGBf(0, 0, 0)

  • bottomspinevisible: Controls if the bottom spine is visible. Default: true

  • colormap: The colormap that the colorbar uses. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:554 =# @inherit :colormap :viridis

  • colorrange: The range of values depicted in the colorbar. Default: nothing

  • flip_vertical_label: Flips the colorbar label if the axis is vertical. Default: false

  • flipaxis: Flips the axis to the right if vertical and to the top if horizontal. Default: true

  • highclip: The color of the high clip triangle. Default: nothing

  • label: The color bar label string. Default: ""

  • labelcolor: The label color. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:478 =# @inherit :textcolor :black

  • labelfont: The label font family. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:480 =# @inherit :font "TeX Gyre Heros Makie"

  • labelpadding: The gap between the label and the ticks. Default: 5.0

  • labelsize: The label font size. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:482 =# @inherit :fontsize 16.0f0

  • labelvisible: Controls if the label is visible. Default: true

  • leftspinecolor: The color of the left spine. Default: RGBf(0, 0, 0)

  • leftspinevisible: Controls if the left spine is visible. Default: true

  • limits: The range of values depicted in the colorbar. Default: nothing

  • lowclip: The color of the low clip triangle. Default: nothing

  • minortickalign: The alignment of minor ticks on the axis spine Default: 0.0

  • minortickcolor: The tick color of minor ticks Default: :black

  • minorticks: The tick locator for the minor ticks Default: IntervalsBetween(5)

  • minorticksize: The tick size of minor ticks Default: 4.0

  • minorticksvisible: Controls if minor ticks are visible Default: false

  • minortickwidth: The tick width of minor ticks Default: 1.0

  • nsteps: The number of steps in the heatmap underlying the colorbar gradient. Default: 100

  • rightspinecolor: The color of the right spine. Default: RGBf(0, 0, 0)

  • rightspinevisible: Controls if the right spine is visible. Default: true

  • scale: The axis scale Default: identity

  • size: The width or height of the colorbar, depending on if it's vertical or horizontal, unless overridden by width / height Default: 16

  • spinewidth: The line width of the spines. Default: 1.0

  • tickalign: The alignment of the tick marks relative to the axis spine (0 = out, 1 = in). Default: 0.0

  • tickcolor: The color of the tick marks. Default: RGBf(0, 0, 0)

  • tickformat: Format for ticks. Default: Makie.automatic

  • ticklabelalign: The horizontal and vertical alignment of the tick labels. Default: Makie.automatic

  • ticklabelcolor: The color of the tick labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:494 =# @inherit :textcolor :black

  • ticklabelfont: The font family of the tick labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:488 =# @inherit :font "TeX Gyre Heros Makie"

  • ticklabelpad: The gap between tick labels and tick marks. Default: 3.0

  • ticklabelrotation: The rotation of the ticklabels Default: 0.0

  • ticklabelsize: The font size of the tick labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:490 =# @inherit :fontsize 16.0f0

  • ticklabelspace: The space reserved for the tick labels. Default: Makie.automatic

  • ticklabelsvisible: Controls if the tick labels are visible. Default: true

  • ticks: The ticks. Default: Makie.automatic

  • ticksize: The size of the tick marks. Default: 6.0

  • ticksvisible: Controls if the tick marks are visible. Default: true

  • tickwidth: The line width of the tick marks. Default: 1.0

  • topspinecolor: The color of the top spine. Default: RGBf(0, 0, 0)

  • topspinevisible: Controls if the top spine is visible. Default: true

  • vertical: Controls if the colorbar is oriented vertically. Default: true

Layout attributes:

  • alignmode: The align mode of the colorbar in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the colorbar in its suggested bounding box. Default: :center

  • height: The height setting of the colorbar. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the colorbar in its suggested bounding box. Default: :center

  • width: The width setting of the colorbar. Use size to set width or height relative to colorbar orientation instead. Default: Auto()

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Observables.Consume <: Any

Fields

x :: Bool

No documentation found.

Summary

struct MakieCore.ContinuousSurface <: MakieCore.SurfaceLike

Supertype Hierarchy

MakieCore.ContinuousSurface <: MakieCore.SurfaceLike <: MakieCore.ConversionTrait <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

abstract type MakieCore.ConversionTrait <: Any

Subtypes

Makie.SampleBased
MakieCore.NoConversion
MakieCore.PointBased
MakieCore.SurfaceLike
MakieCore.VolumeLike

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Makie.MakieLayout.Cycle <: Any

Fields

cycle  :: Vector{Pair{Vector{Symbol}, Symbol}}
covary :: Bool
Cycled(i::Int)

If a Cycled value is passed as an attribute to a plotting function, it is replaced with the value from the cycler for this attribute (as long as there is one defined) at the index i.

No documentation found.

Summary

struct Makie.MakieLayout.DataAspect <: Any
DataInspector(figure; kwargs...)
DataInspector()

Creates a data inspector which will show relevant information in a tooltip when you hover over a plot. If you wish to exclude a plot you may set plot.inspectable[] = false. Defaults to the current plot when called without arguments.

Keyword Arguments:

  • range = 10: Controls the snapping range for selecting an element of a plot.

  • enabled = true: Disables inspection of plots when set to false. Can also be adjusted with enable!(inspector) and disable!(inspector).

  • text_padding = Vec4f(5, 5, 3, 3): Padding for the box drawn around the tooltip text. (left, right, bottom, top)

  • text_align = (:left, :bottom): Alignment of text within the tooltip. This does not affect the alignment of the tooltip relative to the cursor.

  • textcolor = :black: Tooltip text color.

  • textsize = 20: Tooltip text size.

  • font = "TeX Gyre Heros Makie": Tooltip font.

  • background_color = :white: Background color of the tooltip.

  • outline_color = :grey: Outline color of the tooltip.

  • outline_linestyle = nothing: Linestyle of the tooltip outline.

  • outline_linewidth = 2: Linewidth of the tooltip outline.

  • indicator_color = :red: Color of the selection indicator.

  • indicator_linewidth = 2: Linewidth of the selection indicator.

  • indicator_linestyle = nothing: Linestyle of the selection indicator

  • tooltip_align = (:center, :top): Default position of the tooltip relative to the cursor or current selection. The real align may adjust to keep the tooltip in view.

  • tooltip_offset = Vec2f(20): Offset from the indicator to the tooltip.

  • depth = 9e3: Depth value of the tooltip. This should be high so that the tooltip is always in front.

  • priority = 100: The priority of creating a tooltip on a mouse movement or scrolling event.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct MakieCore.DiscreteSurface <: MakieCore.SurfaceLike

Supertype Hierarchy

MakieCore.DiscreteSurface <: MakieCore.SurfaceLike <: MakieCore.ConversionTrait <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Makie.EmptyCamera <: Makie.AbstractCamera

Supertype Hierarchy

Makie.EmptyCamera <: Makie.AbstractCamera <: Any

An environment Light, that uses a spherical environment map to provide lighting. See: https://en.wikipedia.org/wiki/Reflection_mapping

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

This struct provides accessible Observables to monitor the events associated with a Scene.

Functions that act on a Observable must return Consume() if the function consumes an event. When an event is consumed it does not trigger other observer functions. The order in which functions are exectued can be controlled via the priority keyword (default 0) in on.

Example:

on(events(scene).mousebutton, priority = 20) do event
    if is_correct_event(event)
        do_something()
        return Consume()
    end
    return
end

Fields

  • window_area::Observables.Observable{GeometryBasics.HyperRectangle{2, Int64}}

    The area of the window in pixels, as a Rect2.

  • window_dpi::Observables.Observable{Float64}

    The DPI resolution of the window, as a Float64.

  • window_open::Observables.Observable{Bool}

    The state of the window (open => true, closed => false).

  • mousebutton::Observables.Observable{Makie.MouseButtonEvent}

    Most recently triggered MouseButtonEvent. Contains the relevant event.button and event.action (press/release)

    See also ispressed.

  • mousebuttonstate::Set{Makie.Mouse.Button}

    A Set of all currently pressed mousebuttons.

  • mouseposition::Observables.Observable{Tuple{Float64, Float64}}

    The position of the mouse as a NTuple{2, Float64}. Updates once per event poll/frame.

  • scroll::Observables.Observable{Tuple{Float64, Float64}}

    The direction of scroll

  • keyboardbutton::Observables.Observable{Makie.KeyEvent}

    Most recently triggered KeyEvent. Contains the relevant event.key and event.action (press/repeat/release)

    See also ispressed.

  • keyboardstate::Set{Makie.Keyboard.Button}

    Contains all currently pressed keys.

  • unicode_input::Observables.Observable{Char}

    Contains the last typed character.

  • dropped_files::Observables.Observable{Vector{String}}

    Contains a list of filepaths to files dragged into the scene.

  • hasfocus::Observables.Observable{Bool}

    Whether the Scene window is in focus or not.

  • entered_window::Observables.Observable{Bool}

    Whether the mouse is inside the window or not.

Exclusively(x)

Marks a button, button collection or logical expression of buttons as the exclusive subset of buttons that must be pressed for ispressed to return true.

For example Exclusively((Keyboard.left_control, Keyboard.c)) would require left control and c to be pressed without any other buttons.

Boolean expressions are lowered to multiple Exclusive sets in an Or. It is worth noting that Not branches are ignored here, i.e. it assumed that every button under a Not must not be pressed and that this follows automatically from the subset of buttons that must be pressed.

See also: And, Or, Not, ispressed, &, |, !

No documentation found.

Summary

struct Makie.Figure <: Any

Fields

scene        :: Makie.Scene
layout       :: GridLayoutBase.GridLayout
content      :: Vector{T} where T
attributes   :: MakieCore.Attributes
current_axis :: Ref{Any}

No documentation found.

Summary

struct GridLayoutBase.Fixed <: Any

Fields

x :: Float32

No documentation found.

Summary

mutable struct GridLayoutBase.GridLayout <: Any

Fields

parent              :: Any
content             :: Vector{GridLayoutBase.GridContent{GridLayoutBase.GridLayout}}
size                :: Tuple{Int64, Int64}
offsets             :: Tuple{Int64, Int64}
rowsizes            :: Vector{Union{GridLayoutBase.Aspect, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}}
colsizes            :: Vector{Union{GridLayoutBase.Aspect, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}}
addedrowgaps        :: Vector{Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}}
addedcolgaps        :: Vector{Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}}
alignmode           :: Observables.Observable{Union{GridLayoutBase.Inside, GridLayoutBase.Outside, GridLayoutBase.Mixed}}
equalprotrusiongaps :: Tuple{Bool, Bool}
block_updates       :: Bool
layoutobservables   :: GridLayoutBase.LayoutObservables{GridLayoutBase.GridLayout}
width               :: Observables.Observable{Union{Nothing, Float32, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}}
height              :: Observables.Observable{Union{Nothing, Float32, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}}
tellwidth           :: Observables.Observable{Bool}
tellheight          :: Observables.Observable{Bool}
halign              :: Observables.Observable{GridLayoutBase.HorizontalAlignment}
valign              :: Observables.Observable{GridLayoutBase.VerticalAlignment}
default_rowgap      :: Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}
default_colgap      :: Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}

No documentation found.

Summary

struct GridLayoutBase.GridLayoutSpec <: Any

Fields

content :: Vector{Pair{Tuple{Union{Colon, Int64, UnitRange}, Union{Colon, Int64, UnitRange}, GridLayoutBase.Side}, Any}}
kwargs  :: Dict{Symbol, Any}

No documentation found.

Summary

struct GridLayoutBase.GridPosition <: Any

Fields

layout :: GridLayoutBase.GridLayout
span   :: GridLayoutBase.Span
side   :: GridLayoutBase.Side

No documentation found.

Summary

struct GridLayoutBase.GridSubposition <: Any

Fields

parent :: Union{GridLayoutBase.GridPosition, GridLayoutBase.GridSubposition}
rows   :: Any
cols   :: Any
side   :: GridLayoutBase.Side

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any

AlignMode that excludes the protrusions from the bounding box.

Makie.MakieLayout.IntervalSlider <: Block

Attributes

Makie.MakieLayout.IntervalSlider attributes:

  • color_active: The color of the slider when the mouse clicks and drags the slider. Default: COLOR_ACCENT[]

  • color_active_dimmed: The color of the slider when the mouse hovers over it. Default: COLOR_ACCENT_DIMMED[]

  • color_inactive: The color of the slider when it is not interacted with. Default: RGBf(0.94, 0.94, 0.94)

  • horizontal: Controls if the slider has a horizontal orientation or not. Default: true

  • interval: The current interval of the slider. Don't set this manually, use the function set_close_to!. Default: (0, 0)

  • linewidth: The width of the slider line Default: 15.0

  • range: The range of values that the slider can pick from. Default: 0:0.01:10

  • snap: Controls if the buttons snap to valid positions or move freely Default: true

  • startvalues: The start values of the slider or the values that are closest in the slider range. Default: Makie.automatic

Layout attributes:

  • alignmode: The align mode of the slider in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the slider in its suggested bounding box. Default: :center

  • height: The height setting of the slider. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the slider in its suggested bounding box. Default: :center

  • width: The width setting of the slider. Default: Auto()

IntervalsBetween(n::Int, mirror::Bool = true)

Indicates to create n-1 minor ticks between every pair of adjacent major ticks.

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any

Backend independent enums which represent keyboard buttons.

No documentation found.

Summary

struct Makie.MakieLayout.KeysEvent <: Any

Fields

keys :: Set{Makie.Keyboard.Button}

Makie.MakieLayout.LScene <: Block

Attributes

Makie.MakieLayout.LScene attributes:

  • show_axis: Controls the visibility of the 3D axis plot object. Default: true

Layout attributes:

  • alignmode: The alignment of the scene in its suggested bounding box. Default: Inside()

  • halign: The horizontal alignment of the scene in its suggested bounding box. Default: :center

  • height: The height setting of the scene. Default: nothing

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the scene in its suggested bounding box. Default: :center

  • width: The width setting of the scene. Default: nothing

Makie.MakieLayout.Label <: Block

Attributes

Makie.MakieLayout.Label attributes:

  • color: The color of the text. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:593 =# @inherit :textcolor :black

  • font: The font family of the text. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:597 =# @inherit :font "TeX Gyre Heros Makie"

  • justification: The justification of the text (:left, :right, :center). Default: :center

  • lineheight: The lineheight multiplier for the text. Default: 1.0

  • padding: The extra space added to the sides of the text boundingbox. Default: (0.0f0, 0.0f0, 0.0f0, 0.0f0)

  • rotation: The counterclockwise rotation of the text in radians. Default: 0.0

  • text: The displayed text string. Default: "Text"

  • textsize: The font size of the text. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:595 =# @inherit :fontsize 16.0f0

  • visible: Controls if the text is visible. Default: true

  • word_wrap: Enable word wrapping to the suggested width of the Label. Default: false

Layout attributes:

  • alignmode: The align mode of the text in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the text in its suggested boundingbox Default: :center

  • height: The height setting of the text. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the text in its suggested boundingbox Default: :center

  • width: The width setting of the text. Default: Auto()

struct LayoutObservables{G}

T is the same type parameter of contained GridContent, G is GridLayout which is defined only after LayoutObservables.

A collection of Observables and an optional GridContent that are needed to interface with the MakieLayout layouting system.

  • suggestedbbox::Observable{Rect2f}: The bounding box that an element should place itself in. Depending on the element's width and height attributes, this is not necessarily equal to the computedbbox.

  • protrusions::Observable{RectSides{Float32}}: The sizes of content "sticking out" of the main element into the GridLayout gaps.

  • reportedsize::Observable{NTuple{2, Optional{Float32}}}: The width and height that the element computes for itself if possible (else nothing).

  • autosize::Observable{NTuple{2, Optional{Float32}}}: The width and height that the element reports to its parent GridLayout. If the element doesn't want to cause the parent to adjust to its size, autosize can hide the reportedsize from it by being set to nothing.

  • computedbbox::Observable{Rect2f}: The bounding box that the element computes for itself after it has received a suggestedbbox.

  • gridcontent::Optional{GridContent{G}}: A reference of a GridContent if the element is currently placed in a GridLayout. This can be used to retrieve the parent layout, remove the element from it or change its position, and assign it to a different layout.

No documentation found.

Summary

struct GridLayoutBase.Left <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Left <: GridLayoutBase.Side <: Any

Makie.MakieLayout.Legend <: Block

Attributes

Makie.MakieLayout.Legend attributes:

  • bgcolor: The background color of the legend. Default: :white

  • colgap: The gap between the label of one legend entry and the patch of the next. Default: 16

  • framecolor: The color of the legend border. Default: :black

  • framevisible: Controls if the legend border is visible. Default: true

  • framewidth: The line width of the legend border. Default: 1.0

  • gridshalign: The horizontal alignment of entry groups in their parent GridLayout. Default: :center

  • gridsvalign: The vertical alignment of entry groups in their parent GridLayout. Default: :center

  • groupgap: The gap between each group and the next. Default: 16

  • label: The default entry label. Default: "undefined"

  • labelcolor: The color of the entry labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:953 =# @inherit :textcolor :black

  • labelfont: The font family of the entry labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:951 =# @inherit :font "TeX Gyre Heros Makie"

  • labelhalign: The horizontal alignment of the entry labels. Default: :left

  • labeljustification: The justification of the label text. Default is automatic, which will set the justification to labelhalign. Default: automatic

  • labelsize: The font size of the entry labels. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:949 =# @inherit :fontsize 16.0f0

  • labelvalign: The vertical alignment of the entry labels. Default: :center

  • linecolor: The default line color used for LineElements Default: theme(scene, :linecolor)

  • linepoints: The default points used for LineElements in normalized coordinates relative to each label patch. Default: [Point2f(0, 0.5), Point2f(1, 0.5)]

  • linestyle: The default line style used for LineElements Default: :solid

  • linewidth: The default line width used for LineElements. Default: theme(scene, :linewidth)

  • margin: The additional space between the legend and its suggested boundingbox. Default: (0.0f0, 0.0f0, 0.0f0, 0.0f0)

  • marker: The default marker for MarkerElements Default: theme(scene, :marker)

  • markercolor: The default marker color for MarkerElements Default: theme(scene, :markercolor)

  • markerpoints: The default marker points used for MarkerElements in normalized coordinates relative to each label patch. Default: [Point2f(0.5, 0.5)]

  • markersize: The default marker size used for MarkerElements. Default: theme(scene, :markersize)

  • markerstrokecolor: The default marker stroke color used for MarkerElements. Default: theme(scene, :markerstrokecolor)

  • markerstrokewidth: The default marker stroke width used for MarkerElements. Default: theme(scene, :markerstrokewidth)

  • nbanks: The number of banks in which the legend entries are grouped. Columns if the legend is vertically oriented, otherwise rows. Default: 1

  • orientation: The orientation of the legend (:horizontal or :vertical). Default: :vertical

  • padding: The additional space between the legend content and the border. Default: (10.0f0, 10.0f0, 8.0f0, 8.0f0)

  • patchcolor: The color of the patches containing the legend markers. Default: :transparent

  • patchlabelgap: The gap between the patch and the label of each legend entry. Default: 5

  • patchsize: The size of the rectangles containing the legend markers. Default: (20.0f0, 20.0f0)

  • patchstrokecolor: The color of the border of the patches containing the legend markers. Default: :transparent

  • patchstrokewidth: The line width of the border of the patches containing the legend markers. Default: 1.0

  • polycolor: The default poly color used for PolyElements. Default: theme(scene, :patchcolor)

  • polypoints: The default poly points used for PolyElements in normalized coordinates relative to each label patch. Default: [Point2f(0, 0), Point2f(1, 0), Point2f(1, 1), Point2f(0, 1)]

  • polystrokecolor: The default poly stroke color used for PolyElements. Default: theme(scene, :patchstrokecolor)

  • polystrokewidth: The default poly stroke width used for PolyElements. Default: theme(scene, :patchstrokewidth)

  • rowgap: The gap between the entry rows. Default: 3

  • titlecolor: The color of the legend titles Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:945 =# @inherit :textcolor :black

  • titlefont: The font family of the legend group titles. Default: "TeX Gyre Heros Makie Bold"

  • titlegap: The gap between each group title and its group. Default: 8

  • titlehalign: The horizontal alignment of the legend group titles. Default: :center

  • titleposition: The group title positions relative to their groups. Can be :top or :left. Default: :top

  • titlesize: The font size of the legend group titles. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:937 =# @inherit :fontsize 16.0f0

  • titlevalign: The vertical alignment of the legend group titles. Default: :center

  • titlevisible: Controls if the legend titles are visible. Default: true

Layout attributes:

  • alignmode: The align mode of the legend in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the legend in its suggested bounding box. Default: :center

  • height: The height setting of the legend. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: automatic

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: automatic

  • valign: The vertical alignment of the legend in its suggested bounding box. Default: :center

  • width: The width setting of the legend. Default: Auto()

No documentation found.

Summary

abstract type Makie.MakieLayout.LegendElement <: Any

Subtypes

Makie.MakieLayout.LineElement
Makie.MakieLayout.MarkerElement
Makie.MakieLayout.PolyElement

No documentation found.

Summary

struct Makie.MakieLayout.LegendEntry <: Any

Fields

elements   :: Vector{Makie.MakieLayout.LegendElement}
attributes :: MakieCore.Attributes

No documentation found.

Summary

struct Makie.MakieLayout.LineElement <: Makie.MakieLayout.LegendElement

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

Makie.MakieLayout.LineElement <: Makie.MakieLayout.LegendElement <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

LinearTicks with ideally a number of n_ideal tick marks.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any
LogTicks{T}(linear_ticks::T)

Wraps any other tick object. Used to apply a linear tick searching algorithm on a log-transformed interval.

No documentation found.

No docstring found for module Makie.

No documentation found.

No docstring found for module Makie.MakieLayout.

No documentation found.

Summary

struct Makie.MakieLayout.MarkerElement <: Makie.MakieLayout.LegendElement

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

Makie.MakieLayout.MarkerElement <: Makie.MakieLayout.LegendElement <: Any

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any

Makie.MakieLayout.Menu <: Block

A drop-down menu with multiple selectable options. You can pass options with the keyword argument options.

Options are given as an iterable of elements. For each element, the option label in the menu is determined with optionlabel(element) and the option value with optionvalue(element). These functions can be overloaded for custom types. The default is that tuples of two elements are expected to be label and value, where string(label) is used as the label, while for all other objects, label = string(object) and value = object.

When an item is selected in the menu, the menu's selection attribute is set to optionvalue(selected_element).

Constructors

Menu(fig_or_scene; kwargs...)

Examples

Menu with string entries:

menu1 = Menu(fig[1, 1], options = ["first", "second", "third"])

Menu with two-element entries, label and function:

funcs = [sin, cos, tan]
labels = ["Sine", "Cosine", "Tangens"]

menu2 = Menu(fig[1, 1], options = zip(labels, funcs))

Executing a function when a selection is made:

on(menu2.selection) do selected_function
    # do something with the selected function
end

Attributes

Makie.MakieLayout.Menu attributes:

  • cell_color_active: Cell color when active Default: COLOR_ACCENT[]

  • cell_color_hover: Cell color when hovered Default: COLOR_ACCENT_DIMMED[]

  • cell_color_inactive_even: Cell color when inactive even Default: RGBf(0.97, 0.97, 0.97)

  • cell_color_inactive_odd: Cell color when inactive odd Default: RGBf(0.97, 0.97, 0.97)

  • direction: The opening direction of the menu (:up or :down) Default: automatic

  • dropdown_arrow_color: Color of the dropdown arrow Default: (:black, 0.2)

  • dropdown_arrow_size: Size of the dropdown arrow Default: 12px

  • i_selected: Index of selected item Default: 0

  • is_open: Is the menu showing the available options Default: false

  • options: The list of options selectable in the menu. This can be any iterable of a mixture of strings and containers with one string and one other value. If an entry is just a string, that string is both label and selection. If an entry is a container with one string and one other value, the string is the label and the other value is the selection. Default: ["no options"]

  • prompt: The default message prompting a selection when i == 0 Default: "Select..."

  • selection: Selected item value Default: nothing

  • selection_cell_color_inactive: Selection cell color when inactive Default: RGBf(0.94, 0.94, 0.94)

  • textcolor: Color of entry texts Default: :black

  • textpadding: Padding of entry texts Default: (10, 10, 10, 10)

  • textsize: Font size of the cell texts Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:882 =# @inherit :fontsize 16.0f0

Layout attributes:

  • alignmode: The alignment of the menu in its suggested bounding box. Default: Inside()

  • halign: The horizontal alignment of the menu in its suggested bounding box. Default: :center

  • height: The height setting of the menu. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the menu in its suggested bounding box. Default: :center

  • width: The width setting of the menu. Default: nothing

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

AlignMode that is Inside where padding is Nothing, Outside where it is Real, and overrides the protrusion with a fixed value where it is a Protrusion.

Backend independent enums and fields which represent mouse actions.

MouseEvent

Describes a mouse state change. Fields:

  • type: MouseEventType

  • t: Time of the event

  • data: Mouse position in data coordinates

  • px: Mouse position in px relative to scene origin

  • prev_t: Time of previous event

  • prev_data: Previous mouse position in data coordinates

  • prev_px: Previous mouse position in data coordinates

No documentation found.

No docstring found for module Makie.MakieLayout.MouseEventTypes.

Like LinearTicks but for multiples of multiple. Example where approximately 5 numbers should be found that are multiples of pi, printed like "1π", "2π", etc.:

MultiplesTicks(5, pi, "π")

No documentation found.

Summary

struct MakieCore.NoConversion <: MakieCore.ConversionTrait

Supertype Hierarchy

MakieCore.NoConversion <: MakieCore.ConversionTrait <: Any
obs = Observable(val; ignore_equal_values=false)
obs = Observable{T}(val; ignore_equal_values=false)

Like a Ref, but updates can be watched by adding a handler using on or map. Set ignore_equal_values=true to not trigger an event for observable[] = new_value if isequel(observable[], new_value).

No documentation found.

Summary

struct Makie.OldAxis <: Any

AlignMode that includes the protrusions within the bounding box, plus paddings.

Pattern(image)
Pattern(mask[; color1, color2])

Creates an ImagePattern from an image (a matrix of colors) or a mask (a matrix of real numbers). The pattern can be passed as a color to a plot to texture it. If a mask is passed, one can specify to colors between which colors are interpolated.

Pattern(style::String = "/"; kwargs...)
Pattern(style::Char = '/'; kwargs...)

Creates a line pattern based on the given argument. Available patterns are '/', '\', '-', '|', 'x', and '+'. All keyword arguments correspond to the keyword arguments for LinePattern.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the :pixel camera type.

Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the :pixel camera type.

PlotSpec{P<:AbstractPlot}(args...; kwargs...)

Object encoding positional arguments (args), a NamedTuple of attributes (kwargs) as well as plot type P of a basic plot.

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Point is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct MakieCore.PointBased <: MakieCore.ConversionTrait

Supertype Hierarchy

MakieCore.PointBased <: MakieCore.ConversionTrait <: Any

A positional point light, shining at a certain color. Color values can be bigger than 1 for brighter lights.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Makie.MakieLayout.PolyElement <: Makie.MakieLayout.LegendElement

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

Makie.MakieLayout.PolyElement <: Makie.MakieLayout.LegendElement <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Makie.Quaternion is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Makie.Quaternion is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

ColorTypes.RGBA is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

RGB is the standard Red-Green-Blue (sRGB) colorspace. Values of the individual color channels range from 0 (black) to 1 (saturated). If you want "Integer" storage types (e.g., 255 for full color), use N0f8(1) instead (see FixedPointNumbers).

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

Makie.RaymarchAlgorithm <: Enum{Int32} <: Any
AbstractArray{T,N}

Supertype for N-dimensional arrays (or array-like types) with elements of type T. Array and other types are subtypes of this. See the manual section on the AbstractArray interface.

No documentation found.

Summary

struct Makie.RecordEvents <: Any

Fields

scene :: Makie.Scene
path  :: String
HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

HyperRectangle{N, T}

A HyperRectangle is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the origin and widths fields, whose indices correspond to each of the N axes.

No documentation found.

Summary

struct GridLayoutBase.Relative <: Any

Fields

x :: Float32

Reverses the attribute T upon conversion

No documentation found.

Summary

struct GridLayoutBase.Right <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Right <: GridLayoutBase.Side <: Any

No documentation found.

Summary

struct Makie.SSAO <: Any

Fields

radius :: Observables.Observable{Float32}
bias   :: Observables.Observable{Float32}
blur   :: Observables.Observable{Int32}

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any
Scene TODO document this

Constructors

Fields

  • parent

    The parent of the Scene; if it is a top-level Scene, parent == nothing.

  • events

    Events associated with the Scene.

  • px_area

    The current pixel area of the Scene.

  • clear

    Whether the scene should be cleared.

  • camera

    The Camera associated with the Scene.

  • camera_controls

    The controls for the camera of the Scene.

  • transformation

    The Transformation of the Scene.

  • plots

    The plots contained in the Scene.

  • theme

  • children

    Children of the Scene inherit its transformation.

  • current_screens

    The Screens which the Scene is displayed to.

  • backgroundcolor

  • visible

  • ssao

  • lights

Union{Types...}

A type union is an abstract type which includes all instances of any of its argument types. The empty union Union{} is the bottom type of Julia.

Examples

julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}

julia> 1 :: IntOrString
1

julia> "Hello!" :: IntOrString
"Hello!"

julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64

Unit space of the scene it's displayed on. Also referred to as data units

No documentation found.

Summary

struct Makie.MakieLayout.ScrollEvent <: Any

Fields

x :: Float32
y :: Float32

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Makie.MakieLayout.Slider <: Block

Attributes

Makie.MakieLayout.Slider attributes:

  • color_active: The color of the slider when the mouse clicks and drags the slider. Default: COLOR_ACCENT[]

  • color_active_dimmed: The color of the slider when the mouse hovers over it. Default: COLOR_ACCENT_DIMMED[]

  • color_inactive: The color of the slider when it is not interacted with. Default: RGBf(0.94, 0.94, 0.94)

  • horizontal: Controls if the slider has a horizontal orientation or not. Default: true

  • linewidth: The width of the slider line Default: 15

  • range: The range of values that the slider can pick from. Default: 0:0.01:10

  • snap: Controls if the button snaps to valid positions or moves freely Default: true

  • startvalue: The start value of the slider or the value that is closest in the slider range. Default: 0

  • value: The current value of the slider. Don't set this manually, use the function set_close_to!. Default: 0

Layout attributes:

  • alignmode: The align mode of the slider in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the element in its suggested bounding box. Default: :center

  • height: The height setting of the element. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the element in its suggested bounding box. Default: :center

  • width: The width setting of the element. Default: Auto()

Makie.MakieLayout.SliderGrid <: Block

A grid of horizontal Sliders, where each slider has one name label on the left, and a value label on the right.

Each NamedTuple you pass specifies one Slider. You always have to pass range and label, and optionally a format for the value label. Beyond that, you can set any keyword that Slider takes, such as startvalue.

The format keyword can be a String with Formatting.jl style, such as "{:.2f}Hz", or a function.

Constructors

SliderGrid(fig_or_scene, nts::NamedTuple...; kwargs...)

Examples

sg = SliderGrid(fig[1, 1],
    (label = "Amplitude", range = 0:0.1:10, startvalue = 5),
    (label = "Frequency", range = 0:0.5:50, format = "{:.1f}Hz", startvalue = 10),
    (label = "Phase", range = 0:0.01:2pi,
        format = x -> string(round(x/pi, digits = 2), "π"))
)

Working with slider values:

on(sg.sliders[1].value) do val
    # do something with `val`
end

Attributes

Makie.MakieLayout.SliderGrid attributes:

  • value_column_width: The width of the value label column. If automatic, the width is determined by sampling a few values from the slider ranges and picking the largest label size found. Default: automatic

Layout attributes:

  • alignmode: The align mode of the block in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the block in its suggested bounding box. Default: :center

  • height: The height setting of the block. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this block's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this block's width Default: true

  • valign: The vertical alignment of the block in its suggested bounding box. Default: :center

  • width: The width setting of the block. Default: Auto()

HyperSphere{N, T}

A HyperSphere is a generalization of a sphere into N-dimensions. A center and radius, r, must be specified.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Makie.Stepper is a Function.

# 3 methods for generic function "Stepper":
[1] Stepper(scene::Union{Makie.Figure, Makie.FigureAxisPlot, Makie.Scene}; format) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/display.jl:140
[2] Stepper(scene::Union{Makie.Figure, Makie.FigureAxisPlot, Makie.Scene}, path::String; format) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/display.jl:142
[3] Stepper(scene::Union{Makie.Figure, Makie.FigureAxisPlot, Makie.Scene}, path::String, step::Int64; format) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/display.jl:139

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

abstract type MakieCore.SurfaceLike <: MakieCore.ConversionTrait

Subtypes

MakieCore.ContinuousSurface
MakieCore.DiscreteSurface

Supertype Hierarchy

MakieCore.SurfaceLike <: MakieCore.ConversionTrait <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Makie.MakieLayout.Textbox <: Block

Attributes

Makie.MakieLayout.Textbox attributes:

  • bordercolor: Color of the box border. Default: RGBf(0.8, 0.8, 0.8)

  • bordercolor_focused: Color of the box border when focused. Default: COLOR_ACCENT[]

  • bordercolor_focused_invalid: Color of the box border when focused and invalid. Default: RGBf(1, 0, 0)

  • bordercolor_hover: Color of the box border when hovered. Default: COLOR_ACCENT_DIMMED[]

  • borderwidth: Width of the box border. Default: 2.0

  • boxcolor: Color of the box. Default: :transparent

  • boxcolor_focused: Color of the box when focused. Default: :transparent

  • boxcolor_focused_invalid: Color of the box when focused. Default: RGBAf(1, 0, 0, 0.3)

  • boxcolor_hover: Color of the box when hovered. Default: :transparent

  • cornerradius: Corner radius of text box. Default: 8

  • cornersegments: Corner segments of one rounded corner. Default: 20

  • cursorcolor: The color of the cursor. Default: :transparent

  • defocus_on_submit: Controls if the textbox is defocused when a string is submitted. Default: true

  • displayed_string: The currently displayed string (for internal use). Default: nothing

  • focused: If the textbox is focused and receives text input. Default: false

  • font: Font family. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1090 =# @inherit :font "TeX Gyre Heros Makie"

  • placeholder: A placeholder text that is displayed when the saved string is nothing. Default: "Click to edit..."

  • reset_on_defocus: Controls if the displayed text is reset to the stored text when defocusing the textbox without submitting. Default: false

  • restriction: Restricts the allowed unicode input via is_allowed(char, restriction). Default: nothing

  • stored_string: The currently stored string. Default: nothing

  • textcolor: Text color. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1086 =# @inherit :textcolor :black

  • textcolor_placeholder: Text color for the placeholder. Default: RGBf(0.5, 0.5, 0.5)

  • textpadding: Padding of the text against the box. Default: (10, 10, 10, 10)

  • textsize: Text size. Default: #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1084 =# @inherit :fontsize 16.0f0

  • validator: Validator that is called with validate_textbox(string, validator) to determine if the current string is valid. Can by default be a RegEx that needs to match the complete string, or a function taking a string as input and returning a Bool. If the validator is a type T (for example Float64), validation will be tryparse(string, T). Default: str->begin #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1118 =# true end

Layout attributes:

  • alignmode: The alignment of the textbox in its suggested bounding box. Default: Inside()

  • halign: The horizontal alignment of the textbox in its suggested bounding box. Default: :center

  • height: The height setting of the textbox. Default: Auto()

  • tellheight: Controls if the parent layout can adjust to this element's height. Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width. Default: true

  • valign: The vertical alignment of the textbox in its suggested bounding box. Default: :center

  • width: The width setting of the textbox. Default: Auto()

Main structure for holding attributes, for theming plots etc! Will turn all values into observables, so that they can be updated.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Makie.MakieLayout.Toggle <: Block

Attributes

Makie.MakieLayout.Toggle attributes:

  • active: Indicates if the toggle is active or not. Default: false

  • buttoncolor: The color of the toggle button. Default: COLOR_ACCENT[]

  • cornersegments: The number of poly segments in each rounded corner. Default: 15

  • framecolor_active: The color of the border when the toggle is hovered. Default: COLOR_ACCENT_DIMMED[]

  • framecolor_inactive: The color of the border when the toggle is inactive. Default: RGBf(0.94, 0.94, 0.94)

  • rimfraction: The border width as a fraction of the toggle height Default: 0.33

  • toggleduration: The duration of the toggle animation. Default: 0.15

Layout attributes:

  • alignmode: The align mode of the toggle in its parent GridLayout. Default: Inside()

  • halign: The horizontal alignment of the toggle in its suggested bounding box. Default: :center

  • height: The height of the toggle. Default: 28

  • tellheight: Controls if the parent layout can adjust to this element's height Default: true

  • tellwidth: Controls if the parent layout can adjust to this element's width Default: true

  • valign: The vertical alignment of the toggle in its suggested bounding box. Default: :center

  • width: The width of the toggle. Default: 60

No documentation found.

Summary

struct GridLayoutBase.Top <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Top <: GridLayoutBase.Side <: Any

No documentation found.

Summary

struct GridLayoutBase.TopLeft <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.TopLeft <: GridLayoutBase.Side <: Any

No documentation found.

Summary

struct GridLayoutBase.TopRight <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.TopRight <: GridLayoutBase.Side <: Any

Holds the transformations for Scenes.

Fields

  • parent::Base.RefValue{Makie.Transformation}

  • translation::Observables.Observable{GeometryBasics.Vec{3, Float32}}

  • scale::Observables.Observable{GeometryBasics.Vec{3, Float32}}

  • rotation::Observables.Observable{Makie.Quaternionf}

  • model::Observables.Observable{StaticArrays.SMatrix{4, 4, Float32, 16}}

  • transform_func::Observables.Observable{Any}

No documentation found.

MakieCore.Unit is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

GeometryBasics.Vec is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any
Union{Types...}

A type union is an abstract type which includes all instances of any of its argument types. The empty union Union{} is the bottom type of Julia.

Examples

julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}

julia> 1 :: IntOrString
1

julia> "Hello!" :: IntOrString
"Hello!"

julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64
VideoStream(scene::Scene, framerate = 24)

Returns a stream and a buffer that you can use, which don't allocate for new frames. Use recordframe!(stream) to add new video frames to the stream, and save(path, stream) to save the video.

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct MakieCore.VolumeLike <: MakieCore.ConversionTrait

Supertype Hierarchy

MakieCore.VolumeLike <: MakieCore.ConversionTrait <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Summary

struct Makie.MakieLayout.WilkinsonTicks <: Any

Fields

k_ideal            :: Int64
k_min              :: Int64
k_max              :: Int64
Q                  :: Vector{Tuple{Float64, Float64}}
granularity_weight :: Float64
simplicity_weight  :: Float64
coverage_weight    :: Float64
niceness_weight    :: Float64
min_px_dist        :: Float64

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

MakieCore.Combined is of type UnionAll.

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

No documentation found.

Makie._inspector is a Function.

# 2 methods for generic function "_inspector":
[1] _inspector() in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:172
[2] _inspector(args...; attributes...) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:32

No documentation found.

Makie._inspector! is a Function.

# 1 method for generic function "_inspector!":
[1] _inspector!(args...; attributes...) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:36
abline!(axis::Axis, a::Number, b::Number; line_kw_args...)

Adds a line defined by f(x) = x * b + a to the axis. kwargs are the same as for a line plot and are passed directly to the line attributess.

activate_interaction!(parent, name::Symbol)

Activate the interaction named name registered in parent.

addmouseevents!(scene, elements...)

Returns a MouseEventHandle with an observable inside which is triggered by all mouse interactions with the scene and optionally restricted to all given plot objects in elements.

To react to mouse events, use the onmouse... handlers.

Example:

mouseevents = addmouseevents!(scene, scatterplot)

onmouseleftclick(mouseevents) do event
    # do something with the mouseevent
end
annotations(strings::Vector{String}, positions::Vector{Point})

Plots an array of texts at each position in positions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.annotations, T} where T are:

  align            (:left, :bottom)
  color            :black
  depth_shift      0.0f0
  diffuse          Float32[0.4, 0.4, 0.4]
  font             "TeX Gyre Heros Makie"
  inspectable      true
  justification    MakieCore.Automatic()
  lineheight       1.0
  linewidth        1
  markerspace      :pixel
  nan_color        RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  offset           (0.0, 0.0)
  overdraw         false
  position         (0.0, 0.0)
  rotation         0.0
  shininess        32.0f0
  space            :data
  specular         Float32[0.2, 0.2, 0.2]
  ssao             false
  strokecolor      (:black, 0.0)
  strokewidth      0
  textsize         20
  transparency     false
  visible          true
  word_wrap_width  -1
annotations(strings::Vector{String}, positions::Vector{Point})

Plots an array of texts at each position in positions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.annotations!, T} where T are:

arc(origin, radius, start_angle, stop_angle; kwargs...)

This function plots a circular arc, centered at origin with radius radius, from start_angle to stop_angle. origin must be a coordinate in 2 dimensions (i.e., a Point2); the rest of the arguments must be <: Number.

Examples:

arc(Point2f(0), 1, 0.0, π)arc(Point2f(1, 2), 0.3. π, -π)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arc, T} where T are:

  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  resolution      361
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
arc(origin, radius, start_angle, stop_angle; kwargs...)

This function plots a circular arc, centered at origin with radius radius, from start_angle to stop_angle. origin must be a coordinate in 2 dimensions (i.e., a Point2); the rest of the arguments must be <: Number.

Examples:

arc(Point2f(0), 1, 0.0, π)arc(Point2f(1, 2), 0.3. π, -π)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arc!, T} where T are:

arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)

Plots arrows at the specified points with the specified components. u and v are interpreted as vector components (u being the x and v being the y), and the vectors are plotted with the tails at x, y.

If x, y, u, v are <: AbstractVector, then each 'row' is plotted as a single vector.

If u, v are <: AbstractMatrix, then x and y are interpreted as specifications for a grid, and u, v are plotted as arrows along the grid.

arrows can also work in three dimensions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arrows, T} where T are:

  align           :origin
  arrowcolor      MakieCore.Automatic()
  arrowhead       MakieCore.Automatic()
  arrowsize       MakieCore.Automatic()
  arrowtail       MakieCore.Automatic()
  color           :black
  colormap        :viridis
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lengthscale     1.0f0
  linecolor       MakieCore.Automatic()
  linestyle       "nothing"
  linewidth       MakieCore.Automatic()
  markerspace     :pixel
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  normalize       false
  overdraw        false
  quality         32
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)

Plots arrows at the specified points with the specified components. u and v are interpreted as vector components (u being the x and v being the y), and the vectors are plotted with the tails at x, y.

If x, y, u, v are <: AbstractVector, then each 'row' is plotted as a single vector.

If u, v are <: AbstractMatrix, then x and y are interpreted as specifications for a grid, and u, v are plotted as arrows along the grid.

arrows can also work in three dimensions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arrows!, T} where T are:

No documentation found.

Makie.assetpath is a Function.

# 1 method for generic function "assetpath":
[1] assetpath(files...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/Makie.jl:255

No documentation found.

MakieCore.attributes is a Function.

# 1 method for generic function "attributes":
[1] attributes(x::MakieCore.Attributes) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/attributes.jl:33
autolimits!(la::Axis)

Reset manually specified limits of la to an automatically determined rectangle, that depends on the data limits of all plot objects in the axis, as well as the autolimit margins for x and y axis.

available_gradients()

Prints all available gradient names.

axis3d(args; attributes...)

Plots a 3-dimensional OldAxis.

Attributes

OldAxis attributes and their defaults for MakieCore.Combined{Makie.axis3d, T} where T are:

    showaxis: (true, true, true)
    showgrid: (true, true, true)
    padding: 0.1
    visible: true
    ticks: 
        rotation: (-0.7071067811865475 + -0.0im + -0.0jm - 0.7071067811865476km, -4.371139e-8 + 0.0im + 0.0jm + 1.0km, -3.090861907263062e-8 + 3.090861907263061e-8im + 0.7071067811865475jm + 0.7071067811865476km)
        font: ("TeX Gyre Heros Makie", "TeX Gyre Heros Makie", "TeX Gyre Heros Makie")
        ranges_labels: (MakieCore.Automatic(), MakieCore.Automatic())
        formatter: plain
        textcolor: (RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0))
        align: ((:left, :center), (:right, :center), (:right, :center))
        textsize: (5, 5, 5)
        gap: 3
    frame: 
        axiscolor: (:black, :black, :black)
        axislinewidth: (1.5, 1.5, 1.5)
        linewidth: (1, 1, 1)
        linecolor: (RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0))
    names: 
        axisnames: ("x", "y", "z")
        rotation: (-0.7071067811865475 + -0.0im + -0.0jm - 0.7071067811865476km, -4.371139e-8 + 0.0im + 0.0jm + 1.0km, -3.090861907263062e-8 + 3.090861907263061e-8im + 0.7071067811865475jm + 0.7071067811865476km)
        font: ("TeX Gyre Heros Makie", "TeX Gyre Heros Makie", "TeX Gyre Heros Makie")
        textcolor: (:black, :black, :black)
        align: ((:left, :center), (:right, :center), (:right, :center))
        textsize: (6.0, 6.0, 6.0)
        gap: 3
    inspectable: false
    showticks: (true, true, true)
    scale: Float32[1.0, 1.0, 1.0]
axis3d!(args; attributes...)

Plots a 3-dimensional OldAxis.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.axis3d!, T} where T are:

axislegend(ax, args...; position = :rt, kwargs...)
axislegend(ax, args...; position = (1, 1), kwargs...)
axislegend(ax = current_axis(); kwargs...)
axislegend(title::AbstractString; kwargs...)

Create a legend that sits inside an Axis's plot area.

The position can be a Symbol where the first letter controls the horizontal alignment and can be l, r or c, and the second letter controls the vertical alignment and can be t, b or c. Or it can be a tuple where the first element is set as the Legend's halign and the second element as its valign.

With the keywords merge and unique you can control how plot objects with the same labels are treated. If merge is true, all plot objects with the same label will be layered on top of each other into one legend entry. If unique is true, all plot objects with the same plot type and label will be reduced to one occurrence.

band(x, ylower, yupper; kwargs...)
band(lower, upper; kwargs...)

Plots a band from ylower to yupper along x. The form band(lower, upper) plots a ruled surface between the points in lower and upper.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.band, T} where T are:

  backlight       0.0f0
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color => :patchcolor]
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  interpolate     true
  linewidth       1
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shading         false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
band(x, ylower, yupper; kwargs...)
band(lower, upper; kwargs...)

Plots a band from ylower to yupper along x. The form band(lower, upper) plots a ruled surface between the points in lower and upper.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.band!, T} where T are:

barplot(x, y; kwargs...)

Plots a barplot; y defines the height. x and y should be 1 dimensional. Bar width is determined by the attribute width, shrunk by gap in the following way: width -> width * (1 - gap).

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.barplot, T} where T are:

  bar_labels             "nothing"
  color                  RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
  color_over_background  MakieCore.Automatic()
  color_over_bar         MakieCore.Automatic()
  colormap               :viridis
  colorrange             MakieCore.Automatic()
  cycle                  [:color => :patchcolor]
  direction              :y
  dodge                  MakieCore.Automatic()
  dodge_gap              0.03
  fillto                 MakieCore.Automatic()
  flip_labels_at         Inf
  gap                    0.2
  inspectable            true
  label_color            :black
  label_font             "TeX Gyre Heros Makie"
  label_formatter        Makie.bar_label_formatter
  label_offset           5
  label_rotation         0.0
  label_size             20
  marker                 GeometryBasics.HyperRectangle
  n_dodge                MakieCore.Automatic()
  offset                 0.0
  stack                  MakieCore.Automatic()
  strokecolor            :black
  strokewidth            0
  transparency           false
  visible                true
  width                  MakieCore.Automatic()
barplot(x, y; kwargs...)

Plots a barplot; y defines the height. x and y should be 1 dimensional. Bar width is determined by the attribute width, shrunk by gap in the following way: width -> width * (1 - gap).

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.barplot!, T} where T are:

No documentation found.

Makie.MakieLayout.bottom is a Function.

# 1 method for generic function "bottom":
[1] bottom(rect::GeometryBasics.Rect2{T} where T) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:4

No documentation found.

Makie.boundingbox is a Function.

# 6 methods for generic function "boundingbox":
[1] boundingbox(glyphcollection::Makie.GlyphCollection, position::GeometryBasics.Point{3, Float32}, rotation::Makie.Quaternion) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:48
[2] boundingbox(layouts::AbstractArray{var"#s672", N} where {var"#s672"<:Makie.GlyphCollection, N}, positions, rotations) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:70
[3] boundingbox(x::MakieCore.Text{var"#s672"} where var"#s672"<:(Tuple{var"#s671"} where var"#s671"<:Makie.GlyphCollection)) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:88
[4] boundingbox(x::MakieCore.Text{var"#s672"} where var"#s672"<:(Tuple{var"#s671"} where var"#s671"<:(AbstractArray{var"#s670", N} where {var"#s670"<:Makie.GlyphCollection, N}))) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:96
[5] boundingbox(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:6
[6] boundingbox(x, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:6
boxplot(x, y; kwargs...)

Draw a Tukey style boxplot. The boxplot has 3 components:

  • a crossbar spanning the interquartile (IQR) range with a midline marking the median

  • an errorbar whose whiskers span range * iqr

  • points marking outliers, that is, data outside the whiskers

Arguments

  • x: positions of the categories

  • y: variables within the boxes

Keywords

  • weights: vector of statistical weights (length of data). By default, each observation has weight 1.

  • orientation=:vertical: orientation of box (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_notch=false: draw the notch

  • notchwidth=0.5: multiplier of width for narrowest width of notch

  • show_median=true: show median as midline

  • range: multiple of IQR controlling whisker length

  • whiskerwidth: multiplier of width for width of T's on whiskers, or :match to match width

  • show_outliers: show outliers as points

  • dodge: vector of Integer (length of data) of grouping variable to create multiple side-by-side boxes at the same x position

  • dodge_gap = 0.03: spacing between dodged boxes

boxplot(x, y; kwargs...)

Draw a Tukey style boxplot. The boxplot has 3 components:

  • a crossbar spanning the interquartile (IQR) range with a midline marking the median

  • an errorbar whose whiskers span range * iqr

  • points marking outliers, that is, data outside the whiskers

Arguments

  • x: positions of the categories

  • y: variables within the boxes

Keywords

  • weights: vector of statistical weights (length of data). By default, each observation has weight 1.

  • orientation=:vertical: orientation of box (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_notch=false: draw the notch

  • notchwidth=0.5: multiplier of width for narrowest width of notch

  • show_median=true: show median as midline

  • range: multiple of IQR controlling whisker length

  • whiskerwidth: multiplier of width for width of T's on whiskers, or :match to match width

  • show_outliers: show outliers as points

  • dodge: vector of Integer (length of data) of grouping variable to create multiple side-by-side boxes at the same x position

  • dodge_gap = 0.03: spacing between dodged boxes

broadcast_foreach(f, args...)

Like broadcast but for foreach. Doesn't care about shape and treats Tuples && StaticVectors as scalars. This method is meant for broadcasting across attributes that can either have scalar or vector / array form. An example would be a collection of scatter markers that have different sizes but a single color. The length of an attribute is determined with attr_broadcast_length and elements are accessed with attr_broadcast_getindex.

Creates a subscene with a pixel camera

cam2d!(scene::SceneLike, kwargs...)

Creates a 2D camera for the given Scene.

No documentation found.

Makie.cam3d! is a Function.

# 2 methods for generic function "cam3d!":
[1] cam3d!(ax::Makie.MakieLayout.LScene; kwargs...) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/scene.jl:67
[2] cam3d!(scene; zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:230

No documentation found.

Makie.cam3d_cad! is a Function.

# 2 methods for generic function "cam3d_cad!":
[1] cam3d_cad!(ax::Makie.MakieLayout.LScene; kwargs...) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/scene.jl:68
[2] cam3d_cad!(scene; cad, zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:233
cam_relative!(scene)

Creates a pixel-level camera for the Scene. No controls!

No documentation found.

Makie.camera is a Function.

# 3 methods for generic function "camera":
[1] camera(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:452
[2] camera(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:453
[3] camera(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:451

No documentation found.

Makie.cameracontrols is a Function.

# 3 methods for generic function "cameracontrols":
[1] cameracontrols(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:456
[2] cameracontrols(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:457
[3] cameracontrols(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:455

No documentation found.

Makie.cameracontrols! is a Function.

# 3 methods for generic function "cameracontrols!":
[1] cameracontrols!(scene::Makie.Scene, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:459
[2] cameracontrols!(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:463
[3] cameracontrols!(x, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:464

No documentation found.

Makie.campixel is a Function.

# 1 method for generic function "campixel":
[1] campixel(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:337
campixel!(scene; nearclip=-1000f0, farclip=1000f0)

Creates a pixel-level camera for the Scene. No controls!

categorical_colors(colormaplike, categories::Integer)

Creates categorical colors and tries to match categories. Will error if color scheme doesn't contain enough categories. Will drop the n last colors, if request less colors than contained in scheme.

No documentation found.

Makie.center! is a Function.

# 3 methods for generic function "center!":
[1] center!(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
[2] center!(scene::Makie.Scene, padding) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
[3] center!(scene::Makie.Scene, padding, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
cgrad(colors, [values]; categorical = nothing, scale = nothing, rev = false, alpha = nothing)

Construct a Colorgradient from colors and values.

colors can be a symbol for ColorSchemes.jl ColorSchemes, a ColorScheme, a vector of colors, a ColorGradient or a ColorPalette. If values is an integer, it specifies the numbers of colors chosen equidistantly from the colorscheme specified by colors. Otherwise vectors are accepted. For continuous color gradients values indicate where between 0 and 1 the colors are positioned. For categorical color gradients values indicate where a color ends and where a new one begins between 0 and 1. 0 and 1 are added to values if not already present.

If rev is true colors are reversed. scale accepts the symbols :log, :log10, :log2, :ln, :exp, :exp10 or functions. If alpha is set, it is applied to all colors.

No documentation found.

GridLayoutBase.colgap! is a Function.

# 4 methods for generic function "colgap!":
[1] colgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:624
[2] colgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:632
[3] colgap!(gl::GridLayoutBase.GridLayout, s::Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:634
[4] colgap!(gl::GridLayoutBase.GridLayout, r::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:639

No documentation found.

GridLayoutBase.colsize! is a Function.

# 2 methods for generic function "colsize!":
[1] colsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Union{GridLayoutBase.Aspect, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:602
[2] colsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:611
connect!(o1::AbstractObservable, o2::AbstractObservable)

Forwards all updates from o2 to o1.

See also Observables.ObservablePair.

No documentation found.

GridLayoutBase.content is a Function.

# 1 method for generic function "content":
[1] content(g::Union{GridLayoutBase.GridPosition, GridLayoutBase.GridSubposition}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:1587
contents(gp::GridPosition; exact::Bool = false)

Retrieve all objects placed in the GridLayout at the Span and Side stored in the GridPositiongp. If exact == true, elements are only included if they match the Span exactly, otherwise they can also be contained within the spanned layout area.

contents(g::GridLayout)

Retrieve all objects placed in the GridLayoutg, in the order they are stored, extracted from their containing GridContents.

contour(x, y, z)
contour(z::Matrix)

Creates a contour plot of the plane spanning x::Vector, y::Vector, z::Matrix If only z::Matrix is supplied, the indices of the elements in z will be used as the x and y locations when plotting the contour.

The attribute levels can be either

an Int that produces n equally wide levels or bands

an AbstractVector{<:Real} that lists n consecutive edges from low to high, which result in n-1 levels or bands

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contour, T} where T are:

  alpha           1.0
  color           "nothing"
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  enable_depth    true
  fillrange       false
  inspectable     true
  levels          5
  linewidth       1.0
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
contour(x, y, z)
contour(z::Matrix)

Creates a contour plot of the plane spanning x::Vector, y::Vector, z::Matrix If only z::Matrix is supplied, the indices of the elements in z will be used as the x and y locations when plotting the contour.

The attribute levels can be either

an Int that produces n equally wide levels or bands

an AbstractVector{<:Real} that lists n consecutive edges from low to high, which result in n-1 levels or bands

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contour!, T} where T are:

contour3d(x, y, z)

Creates a 3D contour plot of the plane spanning x::Vector, y::Vector, z::Matrix, with z-elevation for each level.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contour3d, T} where T are:

  alpha           1.0
  color           "nothing"
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  enable_depth    true
  fillrange       false
  inspectable     true
  levels          5
  linewidth       1.0
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
contour3d(x, y, z)

Creates a 3D contour plot of the plane spanning x::Vector, y::Vector, z::Matrix, with z-elevation for each level.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contour3d!, T} where T are:

contourf(xs, ys, zs; kwargs...)

Plots a filled contour of the height information in zs at horizontal grid positions xs and vertical grid positions ys.

The attribute levels can be either

  • an Int that produces n equally wide levels or bands

  • an AbstractVector{<:Real} that lists n consecutive edges from low to high, which result in n-1 levels or bands

You can also set the mode attribute to :relative. In this mode you specify edges by the fraction between minimum and maximum value of zs. This can be used for example to draw bands for the upper 90% while excluding the lower 10% with levels = 0.1:0.1:1.0, mode = :relative.

In :normal mode, if you want to show a band from -Inf to the low edge, set extendlow to :auto for the same color as the first level, or specify a different color (default nothing means no extended band) If you want to show a band from the high edge to Inf, set extendhigh to :auto for the same color as the last level, or specify a different color (default nothing means no extended band)

If levels is an Int, the contour plot will be rectangular as all zs will be covered. This is why Axis defaults to tight limits for such contourf plots. If you specify levels as an AbstractVector{<:Real}, however, note that the axis limits include the default margins because the contourf plot can have an irregular shape. You can use tightlimits!(ax) to tighten the limits similar to the Int behavior.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contourf, T} where T are:

  colormap      :viridis
  extendhigh    "nothing"
  extendlow     "nothing"
  inspectable   true
  levels        10
  mode          :normal
  transparency  false
contourf(xs, ys, zs; kwargs...)

Plots a filled contour of the height information in zs at horizontal grid positions xs and vertical grid positions ys.

The attribute levels can be either

  • an Int that produces n equally wide levels or bands

  • an AbstractVector{<:Real} that lists n consecutive edges from low to high, which result in n-1 levels or bands

You can also set the mode attribute to :relative. In this mode you specify edges by the fraction between minimum and maximum value of zs. This can be used for example to draw bands for the upper 90% while excluding the lower 10% with levels = 0.1:0.1:1.0, mode = :relative.

In :normal mode, if you want to show a band from -Inf to the low edge, set extendlow to :auto for the same color as the first level, or specify a different color (default nothing means no extended band) If you want to show a band from the high edge to Inf, set extendhigh to :auto for the same color as the last level, or specify a different color (default nothing means no extended band)

If levels is an Int, the contour plot will be rectangular as all zs will be covered. This is why Axis defaults to tight limits for such contourf plots. If you specify levels as an AbstractVector{<:Real}, however, note that the axis limits include the default margins because the contourf plot can have an irregular shape. You can use tightlimits!(ax) to tighten the limits similar to the Int behavior.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.contourf!, T} where T are:

Wrap a single point or equivalent object in a single-element array.

Enables to use scatter like a surface plot with x::Vector, y::Vector, z::Matrix spanning z over the grid spanned by x y

convert_arguments(P, x, y, z)::(Vector)

Takes vectors x, y, and z and turns it into a vector of 3D points of the values from x, y, and z. P is the plot Type (it is optional).

convert_arguments(P, x)::(Vector)

Takes an input GeometryPrimitive x and decomposes it to points. P is the plot Type (it is optional).

convert_arguments(P, y)::Vector

Takes vector y and generates a range from 1 to the length of y, for plotting on an arbitrary x axis.

P is the plot Type (it is optional).

convert_arguments(P, x)::(Vector)

Takes an input Rectx and decomposes it to points.

P is the plot Type (it is optional).

convert_arguments(PB, LineString)

Takes an input LineString and decomposes it to points.

convert_arguments(PB, Union{Array{<:LineString}, MultiLineString})

Takes an input Array{LineString} or a MultiLineString and decomposes it to points.

convert_arguments(PB, Polygon)

Takes an input Polygon and decomposes it to points.

convert_arguments(PB, Union{Array{<:Polygon}, MultiPolygon})

Takes an input Array{Polygon} or a MultiPolygon and decomposes it to points.

convert_arguments(SL::SurfaceLike, x::VecOrMat, y::VecOrMat, z::Matrix)

If SL is Heatmap and x and y are vectors, infer from length of x and y whether they represent edges or centers of the heatmap bins. If they are centers, convert to edges. Convert eltypes to Float32 and return outputs as a Tuple.

convert_arguments(P, x, y, z)::Tuple{ClosedInterval, ClosedInterval, Matrix}

Takes 2 ClosedIntervals's x, y, and an AbstractMatrix z, and converts the closed range to linspaces with size(z, 1/2) P is the plot Type (it is optional).

convert_arguments(P, Matrix)::Tuple{ClosedInterval, ClosedInterval, Matrix}

Takes an AbstractMatrix, converts the dimesions n and m into ClosedInterval, and stores the ClosedInterval to n and m, plus the original matrix in a Tuple.

P is the plot Type (it is optional).

convert_arguments(P, x, y, f)::(Vector, Vector, Matrix)

Takes vectors x and y and the function f, and applies f on the grid that x and y span. This is equivalent to f.(x, y'). P is the plot Type (it is optional).

convert_arguments(P, Matrix)::Tuple{ClosedInterval, ClosedInterval, ClosedInterval, Matrix}

Takes an array of {T, 3} where T, converts the dimesions n, m and k into ClosedInterval, and stores the ClosedInterval to n, m and k, plus the original array in a Tuple.

P is the plot Type (it is optional).

convert_arguments(P, x, y, z, i)::(Vector, Vector, Vector, Matrix)

Takes 3 AbstractVectorx, y, and z and the AbstractMatrixi, and puts everything in a Tuple.

P is the plot Type (it is optional).

convert_arguments(P, x, y, z, f)::(Vector, Vector, Vector, Matrix)

Takes AbstractVectorx, y, and z and the function f, evaluates f on the volume spanned by x, y and z, and puts x, y, z and f(x,y,z) in a Tuple.

P is the plot Type (it is optional).

Accepts a Vector of Pair of Points (e.g. [Point(0, 0) => Point(1, 1), ...]) to encode e.g. linesegments or directions.

convert_arguments(Mesh, x, y, z)::GLNormalMesh

Takes real vectors x, y, z and constructs a mesh out of those, under the assumption that every 3 points form a triangle.

convert_arguments(Mesh, xyz::AbstractVector)::GLNormalMesh

Takes an input mesh and a vector xyz representing the vertices of the mesh, and creates indices under the assumption, that each triplet in xyz forms a triangle.

convert_arguments(Mesh, x, y, z, indices)::GLNormalMesh

Takes real vectors x, y, z and constructs a triangle mesh out of those, using the faces in indices, which can be integers (every 3 -> one triangle), or GeometryBasics.NgonFace{N, <: Integer}.

convert_arguments(Mesh, vertices, indices)::GLNormalMesh

Takes vertices and indices, and creates a triangle mesh out of those. See to_vertices and to_triangles for more information about accepted types.

to_color(color)

Converts a color symbol (e.g. :blue) to a color RGBA.

to_colormap(cm)

Converts a colormap cm symbol/string (e.g. :Spectral) to a colormap RGB array.

`AbstractVector{<:AbstractFloat}` for denoting sequences of fill/nofill. e.g.

[0.5, 0.8, 1.2] will result in 0.5 filled, 0.3 unfilled, 0.4 filled. 1.0 unit is one linewidth!

A `Symbol` equal to `:dash`, `:dot`, `:dashdot`, `:dashdotdot`
to_volume_algorithm(b, x)

Enum values: IsoValueAbsorptionMaximumIntensityProjectionAbsorptionRGBAAdditiveRGBAIndexedAbsorptionRGBA

Symbol/String: iso, absorption, mip, absorptionrgba, indexedabsorption

crossbar(x, y, ymin, ymax; kwargs...)

Draw a crossbar. A crossbar represents a range with a (potentially notched) box. It is most commonly used as part of the boxplot.

Arguments

  • x: position of the box

  • y: position of the midline within the box

  • ymin: lower limit of the box

  • ymax: upper limit of the box

Keywords

  • orientation=:vertical: orientation of box (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_notch=false: draw the notch

  • notchmin=automatic: lower limit of the notch

  • notchmax=automatic: upper limit of the notch

  • notchwidth=0.5: multiplier of width for narrowest width of notch

  • show_midline=true: show midline

crossbar(x, y, ymin, ymax; kwargs...)

Draw a crossbar. A crossbar represents a range with a (potentially notched) box. It is most commonly used as part of the boxplot.

Arguments

  • x: position of the box

  • y: position of the midline within the box

  • ymin: lower limit of the box

  • ymax: upper limit of the box

Keywords

  • orientation=:vertical: orientation of box (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_notch=false: draw the notch

  • notchmin=automatic: lower limit of the notch

  • notchmax=automatic: upper limit of the notch

  • notchwidth=0.5: multiplier of width for narrowest width of notch

  • show_midline=true: show midline

Returns the current active axis (or the last axis that got created)

Set ax as the current active axis in fig

Returns the current active figure (or the last figure that got created)

Set fig as the current active scene

No documentation found.

Makie.data_limits is a Function.

# 7 methods for generic function "data_limits":
[1] data_limits(bars::Union{MakieCore.Combined{Makie.errorbars, ArgType} where ArgType, MakieCore.Combined{Makie.rangebars, ArgType} where ArgType}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/basic_recipes/error_and_rangebars.jl:269
[2] data_limits(plot::MakieCore.Surface{ArgType} where ArgType) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:196
[3] data_limits(plot::MakieCore.Heatmap{ArgType} where ArgType) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:203
[4] data_limits(plot::MakieCore.Image{ArgType} where ArgType) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:210
[5] data_limits(plot::MakieCore.AbstractPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:175
[6] data_limits(scenelike) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:185
[7] data_limits(scenelike, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:185
deactivate_interaction!(parent, name::Symbol)

Deactivate the interaction named name registered in parent. It can be reactivated with activate_interaction!.

decompose(facetype, contour::AbstractArray{<:AbstractPoint})

Triangulate a Polygon without hole.

Returns a Vector{facetype} defining indexes into contour.

No documentation found.

MakieCore.default_theme is a Function.

# 45 methods for generic function "default_theme":
[1] default_theme(scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:1
[2] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.violin, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[3] default_theme(scene, ::Type{var"#s27"} where var"#s27"<:(MakieCore.Image{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[4] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Heatmap{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[5] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Volume{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[6] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Surface{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[7] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Lines{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[8] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.LineSegments{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[9] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Mesh{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[10] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Scatter{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[11] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.MeshScatter{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[12] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Text{ArgType} where ArgType)) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[13] default_theme(scene, ::Type{var"#s1141"} where var"#s1141"<:(MakieCore.Combined{Makie.series, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[14] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie._inspector, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[15] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.boxplot, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[16] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.crossbar, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[17] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.qqnorm, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[18] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.qqplot, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[19] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.ecdfplot, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[20] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.density, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[21] default_theme(scene, ::Type{var"#s669"} where var"#s669"<:(MakieCore.Combined{Makie.hist, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[22] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.wireframe, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[23] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.volumeslices, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[24] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.timeseries, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[25] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.streamplot, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[26] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.stem, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[27] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.stairs, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[28] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.spy, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[29] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.scatterlines, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[30] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.poly, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[31] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.pie, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[32] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.rangebars, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[33] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.errorbars, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[34] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.contourf, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[35] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.contour3d, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[36] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.contour, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[37] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.barplot, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[38] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.band, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[39] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.axis3d, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[40] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.annotations, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[41] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.arc, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[42] default_theme(scene, ::Type{var"#s211"} where var"#s211"<:(MakieCore.Combined{Makie.arrows, ArgType} where ArgType)) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[43] default_theme(scene, ::Type{var"#s40"} where var"#s40"<:(MakieCore.Combined{RPRMakie.matball, ArgType} where ArgType)) in RPRMakie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[44] default_theme(scene, ::Type{var"#s31"} where var"#s31"<:(MakieCore.Combined{Main.FD_SANDBOX_3118400072356428703.stockchart, ArgType} where ArgType)) in Main.FD_SANDBOX_3118400072356428703 at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:176
[45] default_theme(scene, T) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:62
density(values; npoints = 200, offset = 0.0, direction = :x)

Plot a kernel density estimate of values. npoints controls the resolution of the estimate, the baseline can be shifted with offset and the direction set to :x or :y. bandwidth and boundary are determined automatically by default.

Statistical weights can be provided via the weights keyword argument.

color is usually set to a single color, but can also be set to :x or :y to color with a gradient. If you use :y when direction = :x (or vice versa), note that only 2-element colormaps can work correctly.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.density, T} where T are:

  bandwidth     MakieCore.Automatic()
  boundary      MakieCore.Automatic()
  color         RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
  colormap      :viridis
  colorrange    MakieCore.Automatic()
  cycle         [:color => :patchcolor]
  direction     :x
  inspectable   true
  linestyle     "nothing"
  npoints       200
  offset        0.0
  strokearound  false
  strokecolor   :black
  strokewidth   0
  weights       MakieCore.Automatic()
density(values; npoints = 200, offset = 0.0, direction = :x)

Plot a kernel density estimate of values. npoints controls the resolution of the estimate, the baseline can be shifted with offset and the direction set to :x or :y. bandwidth and boundary are determined automatically by default.

Statistical weights can be provided via the weights keyword argument.

color is usually set to a single color, but can also be set to :x or :y to color with a gradient. If you use :y when direction = :x (or vice versa), note that only 2-element colormaps can work correctly.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.density!, T} where T are:

deregister_interaction!(parent, name::Symbol)

Deregister the interaction named name registered in parent.

No documentation found.

Makie.disconnect! is a Function.

# 14 methods for generic function "disconnect!":
[1] disconnect!(window::MakieCore.AbstractScreen, signal) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:1
[2] disconnect!(observables::Vector{T} where T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:36
[3] disconnect!(window::GLFW.Window, ::typeof(Makie.entered_window)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:287
[4] disconnect!(window::GLFW.Window, ::typeof(Makie.hasfocus)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:265
[5] disconnect!(window::GLFW.Window, ::typeof(Makie.scroll)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:242
[6] disconnect!(window::GLFW.Window, ::typeof(Makie.mouse_position)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:220
[7] disconnect!(window::GLFW.Window, ::typeof(Makie.unicode_input)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:154
[8] disconnect!(window::GLFW.Window, ::typeof(Makie.dropped_files)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:131
[9] disconnect!(window::GLFW.Window, ::typeof(Makie.keyboard_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:110
[10] disconnect!(window::GLFW.Window, ::typeof(Makie.mouse_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:95
[11] disconnect!(window::GLFW.Window, ::typeof(Makie.window_area)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:73
[12] disconnect!(window::GLFW.Window, ::typeof(Makie.window_open)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:34
[13] disconnect!(c::Makie.EmptyCamera) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:32
[14] disconnect!(c::Makie.Camera) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:24

Registers a callback for drag and drop of files. returns Observable{Vector{String}}, which are absolute file paths GLFW Docs

ecdfplot(values; npoints=10_000[, weights])

Plot the empirical cumulative distribution function (ECDF) of values.

npoints controls the resolution of the plot. If weights for the values are provided, a weighted ECDF is plotted.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.ecdfplot, T} where T are:

  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  step            :pre
  transparency    false
  visible         true
ecdfplot(values; npoints=10_000[, weights])

Plot the empirical cumulative distribution function (ECDF) of values.

npoints controls the resolution of the plot. If weights for the values are provided, a weighted ECDF is plotted.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.ecdfplot!, T} where T are:

Registers a callback for if the mouse has entered the window. returns an Observable{Bool}, which is true whenever the cursor enters the window. GLFW Docs

errorbars(x, y, error_both; kwargs...)
errorbars(x, y, error_low, error_high; kwargs...)
errorbars(x, y, error_low_high; kwargs...)

errorbars(xy, error_both; kwargs...)
errorbars(xy, error_low, error_high; kwargs...)
errorbars(xy, error_low_high; kwargs...)

errorbars(xy_error_both; kwargs...)
errorbars(xy_error_low_high; kwargs...)

Plots errorbars at xy positions, extending by errors in the given direction.

If you want to plot intervals from low to high values instead of relative errors, use rangebars.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.errorbars, T} where T are:

  color         :black
  colormap      :viridis
  colorrange    MakieCore.Automatic()
  direction     :y
  inspectable   true
  linewidth     1.5
  transparency  false
  visible       true
  whiskerwidth  0
errorbars(x, y, error_both; kwargs...)
errorbars(x, y, error_low, error_high; kwargs...)
errorbars(x, y, error_low_high; kwargs...)

errorbars(xy, error_both; kwargs...)
errorbars(xy, error_low, error_high; kwargs...)
errorbars(xy, error_low_high; kwargs...)

errorbars(xy_error_both; kwargs...)
errorbars(xy_error_low_high; kwargs...)

Plots errorbars at xy positions, extending by errors in the given direction.

If you want to plot intervals from low to high values instead of relative errors, use rangebars.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.errorbars!, T} where T are:

No documentation found.

Makie.events is a Function.

# 3 methods for generic function "events":
[1] events(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:448
[2] events(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:449
[3] events(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:447
fill_between!(scenelike, x, y1, y2; where = nothing, kw_args...)

fill the section between 2 lines with the condition where

grid!(content::Vararg{Pair}; kwargs...)

Creates a GridLayout with all pairs contained in content. Each pair consists of an iterable with row and column spans, and a content object. Each content object is then placed in the GridLayout at the span from its pair.

Example:

grid!( [1, 1] => obj1, [1, 2] => obj2, [2, :] => obj3, )

grid!(content::AbstractMatrix; kwargs...)

Creates a GridLayout filled with matrix-like content. The size of the grid will be the size of the matrix.

No documentation found.

GridLayoutBase.gridnest! is a Function.

# 1 method for generic function "gridnest!":
[1] gridnest!(gl::GridLayoutBase.GridLayout, rows::Union{Colon, Int64, UnitRange}, cols::Union{Colon, Int64, UnitRange}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:525

Registers a callback for the focus of a window. returns an Observable{Bool}, which is true whenever the window has focus. GLFW Docs

heatmap(x, y, values)
heatmap(values)

Plots a heatmap as an image on x, y (defaults to interpretation as dimensions).

heatmap(x, y, values)
heatmap(values)

Plots a heatmap as an image on x, y (defaults to interpretation as dimensions).

No documentation found.

GridLayoutBase.height is a Function.

# 1 method for generic function "height":
[1] height(rect::GeometryBasics.Rect2{T} where T) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/helpers.jl:117
help(func[; extended = false])

Welcome to the main help function of Makie.jl / Makie.jl.

For help on a specific function's arguments, type help_arguments(function_name).

For help on a specific function's attributes, type help_attributes(plot_Type).

Use the optional extended = true keyword argument to see more details.

help_arguments([io], func)

Returns a list of signatures for function func.

help_attributes([io], Union{PlotType, PlotFunction}; extended = false)

Returns a list of attributes for the plot type Typ. The attributes returned extend those attributes found in the default_theme.

Use the optional keyword argument extended (default = false) to show in addition the default values of each attribute. usage:

>help_attributes(scatter)
    alpha
    color
    colormap
    colorrange
    distancefield
    glowcolor
    glowwidth
    linewidth
    marker
    marker_offset
    markersize
    overdraw
    rotations
    strokecolor
    strokewidth
    transform_marker
    transparency
    uv_offset_width
    visible
hbox!(content::Vararg; kwargs...)

Creates a single-row GridLayout with all elements contained in content placed from left to right.

hidedecorations!(la::Axis)

Hide decorations of both x and y-axis: label, ticklabels, ticks and grid.

hidespines!(la::Axis, spines::Symbol... = (:l, :r, :b, :t)...)

Hide all specified axis spines. Hides all spines by default, otherwise choose with the symbols :l, :r, :b and :t.

hidexdecorations!(la::Axis; label = true, ticklabels = true, ticks = true, grid = true,
    minorgrid = true, minorticks = true)

Hide decorations of the x-axis: label, ticklabels, ticks and grid.

hideydecorations!(la::Axis; label = true, ticklabels = true, ticks = true, grid = true,
    minorgrid = true, minorticks = true)

Hide decorations of the y-axis: label, ticklabels, ticks and grid.

hist(values; bins = 15, normalization = :none)

Plot a histogram of values. bins can be an Int to create that number of equal-width bins over the range of values. Alternatively, it can be a sorted iterable of bin edges. The histogram can be normalized by setting normalization. Possible values are:

  • :pdf: Normalize by sum of weights and bin sizes. Resulting histogram has norm 1 and represents a PDF.

  • :density: Normalize by bin sizes only. Resulting histogram represents count density of input and does not have norm 1. Will not modify the histogram if it already represents a density (h.isdensity == 1).

  • :probability: Normalize by sum of weights only. Resulting histogram represents the fraction of probability mass for each bin and does not have norm 1.

  • :none: Do not normalize.

Statistical weights can be provided via the weights keyword argument.

The following attributes can move the histogram around, which comes in handy when placing multiple histograms into one plot:

  • offset = 0.0: adds an offset to every value

  • fillto = 0.0: defines where the bar starts

  • scale_to = nothing: allows to scale all values to a certain height

  • flip = false: flips all values

Color can either be:

  • a vector of bins colors

  • a single color

  • :values, to color the bars with the values from the histogram

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.hist, T} where T are:

  bar_labels             "nothing"
  bins                   15
  color                  RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
  cycle                  [:color => :patchcolor]
  fillto                 MakieCore.Automatic()
  flip_labels_at         Inf
  label_color            :black
  label_font             "TeX Gyre Heros Makie"
  label_formatter        Makie.bar_label_formatter
  label_offset           5
  label_size             20
  normalization          :none
  offset                 0.0
  over_background_color  MakieCore.Automatic()
  over_bar_color         MakieCore.Automatic()
  scale_to               "nothing"
  weights                MakieCore.Automatic()
hist(values; bins = 15, normalization = :none)

Plot a histogram of values. bins can be an Int to create that number of equal-width bins over the range of values. Alternatively, it can be a sorted iterable of bin edges. The histogram can be normalized by setting normalization. Possible values are:

  • :pdf: Normalize by sum of weights and bin sizes. Resulting histogram has norm 1 and represents a PDF.

  • :density: Normalize by bin sizes only. Resulting histogram represents count density of input and does not have norm 1. Will not modify the histogram if it already represents a density (h.isdensity == 1).

  • :probability: Normalize by sum of weights only. Resulting histogram represents the fraction of probability mass for each bin and does not have norm 1.

  • :none: Do not normalize.

Statistical weights can be provided via the weights keyword argument.

The following attributes can move the histogram around, which comes in handy when placing multiple histograms into one plot:

  • offset = 0.0: adds an offset to every value

  • fillto = 0.0: defines where the bar starts

  • scale_to = nothing: allows to scale all values to a certain height

  • flip = false: flips all values

Color can either be:

  • a vector of bins colors

  • a single color

  • :values, to color the bars with the values from the histogram

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.hist!, T} where T are:

hlines!(ax::Axis, ys; xmin = 0.0, xmax = 1.0, attrs...)

Create horizontal lines across ax at ys in data coordinates and xmin to xmax in axis coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.

hovered_scene()

Returns the scene that the mouse is currently hovering over.

Properly identifies the scene for a plot with multiple sub-plots.

hspan!(ax::Axis, y_lows, y_highs; xmin = 0.0, xmax = 1.0, attrs...)

Create horizontal spans across ax from y_lows to y_highs in data coordinates and xmin to xmax in axis coordinates (0 to 1 by default). All four of these can have single or multiple values because they are broadcast to calculate the final spans.

image(x, y, image)
image(image)

Plots an image on range x, y (defaults to dimensions).

image(x, y, image)
image(image)

Plots an image on range x, y (defaults to dimensions).

No documentation found.

Makie.insertplots! is a Function.

# 2 methods for generic function "insertplots!":
[1] insertplots!(screen::GLMakie.GLScreen, scene::Makie.Scene) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/screen.jl:49
[2] insertplots!(screen::AbstractDisplay, scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:499

No documentation found.

Makie.MakieLayout.interactions is a Function.

# 2 methods for generic function "interactions":
[1] interactions(ax::Makie.MakieLayout.Axis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/interactions.jl:4
[2] interactions(ax3::Makie.MakieLayout.Axis3) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/interactions.jl:5
is_mouseinside(scene)

Returns true if the current mouseposition is inside the given scene.

ispressed(scene, result::Bool)
ispressed(scene, button::Union{Mouse.Button, Keyboard.Button)
ispressed(scene, collection::Union{Set, Vector, Tuple})
ispressed(scene, op::BooleanOperator)

This function checks if a button or combination of buttons is pressed.

If given a true or false, ispressed will return true or false respectively. This provides a way to turn an interaction "always on" or "always off" from the outside.

Passing a button or collection of buttons such as Keyboard.enter or Mouse.left will return true if all of the given buttons are pressed.

For more complicated combinations of buttons they can be combined into boolean expression with &, | and !. For example, you can have ispressed(scene, !Keyboard.left_control & Keyboard.c)) and ispressed(scene, Keyboard.left_control & Keyboard.c) to avoid triggering both cases at the same time.

Furthermore you can also make any button, button collection or boolean expression exclusive by wrapping it in Exclusively(...). With that ispressed will only return true if the currently pressed buttons match the request exactly.

See also: And, Or, Not, Exclusively, &, |, !

No documentation found.

Makie.keyboard_buttons is a Function.

# 3 methods for generic function "keyboard_buttons":
[1] keyboard_buttons(scene::Makie.Scene, window::GLFW.Window) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:99
[2] keyboard_buttons(scene::Makie.Scene, screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:98
[3] keyboard_buttons(scene, native_window) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:9
labelslider!(scene, label, range; format = string, sliderkw = Dict(),
labelkw = Dict(), valuekw = Dict(), value_column_width = automatic, layoutkw...)

labelslider! is deprecated, use SliderGrid instead

Construct a horizontal GridLayout with a label, a slider and a value label in scene.

Returns a NamedTuple:

(slider = slider, label = label, valuelabel = valuelabel, layout = layout)

Specify a format function for the value label with the format keyword or pass a format string used by Formatting.format. The slider is forwarded the keywords from sliderkw. The label is forwarded the keywords from labelkw. The value label is forwarded the keywords from valuekw. You can set the column width for the value label column with the keyword value_column_width. By default, the width is determined heuristically by sampling a few values from the slider range. All other keywords are forwarded to the GridLayout.

Example:

ls = labelslider!(scene, "Voltage:", 0:10; format = x -> "$(x)V")
layout[1, 1] = ls.layout
labelslidergrid!(scene, labels, ranges; formats = [string],
    sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(),
    value_column_width = automatic, layoutkw...)

labelslidergrid! is deprecated, use SliderGrid instead

Construct a GridLayout with a column of label, a column of sliders and a column of value labels in scene. The argument values are broadcast, so you can use scalars if you want to keep labels, ranges or formats constant across rows.

Returns a NamedTuple:

(sliders = sliders, labels = labels, valuelabels = valuelabels, layout = layout)

Specify format functions for the value labels with the formats keyword or pass format strings used by Formatting.format. The sliders are forwarded the keywords from sliderkw. The labels are forwarded the keywords from labelkw. The value labels are forwarded the keywords from valuekw. You can set the column width for the value label column with the keyword value_column_width. By default, the width is determined heuristically by sampling a few values from the slider ranges. All other keywords are forwarded to the GridLayout.

Example:

ls = labelslidergrid!(scene, ["Voltage", "Ampere"], Ref(0:0.1:100); format = x -> "$(x)V")
layout[1, 1] = ls.layout

No documentation found.

Makie.MakieLayout.left is a Function.

# 1 method for generic function "left":
[1] left(rect::GeometryBasics.Rect2{T} where T) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:2
map(f, c...) -> collection

Transform collection c by applying f to each element. For multiple collection arguments, apply f elementwise.

See also: mapslices

Examples

julia> map(x -> x * 2, [1, 2, 3])
3-element Vector{Int64}:
 2
 4
 6

julia> map(+, [1, 2, 3], [10, 20, 30])
3-element Vector{Int64}:
 11
 22
 33
obs = map(f, arg1::AbstractObservable, args...; ignore_equal_values=false)

Creates a new observable obs which contains the result of f applied to values extracted from arg1 and args (i.e., f(arg1[], ...). arg1 must be an observable for dispatch reasons. args may contain any number of Observable objects. f will be passed the values contained in the observables as the respective argument. All other objects in args are passed as-is.

If you don't need the value of obs, and just want to run f whenever the arguments update, use on or onany instead.

Example

julia> obs = Observable([1,2,3]);

julia> map(length, obs)
Observable{Int64} with 0 listeners. Value:
3
limits!(ax::Axis, xlims, ylims)

Set the axis limits to xlims and ylims. If limits are ordered high-low, this reverses the axis orientation.

limits!(ax::Axis, x1, x2, y1, y2)

Set the axis x-limits to x1 and x2 and the y-limits to y1 and y2. If limits are ordered high-low, this reverses the axis orientation.

limits!(ax::Axis, rect::Rect2)

Set the axis limits to rect. If limits are ordered high-low, this reverses the axis orientation.

limits!(ax::Axis3, xlims, ylims)

Set the axis limits to xlims and ylims. If limits are ordered high-low, this reverses the axis orientation.

limits!(ax::Axis3, x1, x2, y1, y2, z1, z2)

Set the axis x-limits to x1 and x2 and the y-limits to y1 and y2. If limits are ordered high-low, this reverses the axis orientation.

limits!(ax::Axis3, rect::Rect3)

Set the axis limits to rect. If limits are ordered high-low, this reverses the axis orientation.

lines(positions)
lines(x, y)
lines(x, y, z)

Creates a connected line plot for each element in (x, y, z), (x, y) or positions.

Tip

You can separate segments by inserting NaNs.

lines(positions)
lines(x, y)
lines(x, y, z)

Creates a connected line plot for each element in (x, y, z), (x, y) or positions.

Tip

You can separate segments by inserting NaNs.

linesegments(positions)
linesegments(x, y)
linesegments(x, y, z)

Plots a line for each pair of points in (x, y, z), (x, y), or positions.

linesegments(positions)
linesegments(x, y)
linesegments(x, y, z)

Plots a line for each pair of points in (x, y, z), (x, y), or positions.

linkaxes!(a::Axis, others...)

Link both x and y axes of all given Axis so that they stay synchronized.

linkxaxes!(a::Axis, others...)

Link the x axes of all given Axis so that they stay synchronized.

linkyaxes!(a::Axis, others...)

Link the y axes of all given Axis so that they stay synchronized.

map_once(closure, inputs::Observable....)::Observable

Like Reactive.foreach, in the sense that it will be preserved even if no reference is kept. The difference is, that you can call map once multiple times with the same closure and it will close the old result Observable and register a new one instead.

``` function test(s1::Observable) s3 = maponce(x-> (println("1 ", x); x), s1) s3 = maponce(x-> (println("2 ", x); x), s1)

end test(Observable(1), Observable(2))

mesh(x, y, z)
mesh(mesh_object)
mesh(x, y, z, faces)
mesh(xyz, faces)

Plots a 3D or 2D mesh. Supported mesh_objects include Mesh types from GeometryBasics.jl.

mesh(x, y, z)
mesh(mesh_object)
mesh(x, y, z, faces)
mesh(xyz, faces)

Plots a 3D or 2D mesh. Supported mesh_objects include Mesh types from GeometryBasics.jl.

meshscatter(positions)
meshscatter(x, y)
meshscatter(x, y, z)

Plots a mesh for each element in (x, y, z), (x, y), or positions (similar to scatter). markersize is a scaling applied to the primitive passed as marker.

meshscatter(positions)
meshscatter(x, y)
meshscatter(x, y, z)

Plots a mesh for each element in (x, y, z), (x, y), or positions (similar to scatter). markersize is a scaling applied to the primitive passed as marker.

Registers a callback for the mouse buttons + modifiers returns Observable{NTuple{4, Int}}GLFW Docs

Registers a callback for the mouse cursor position. returns an Observable{Vec{2, Float64}}, which is not in scene coordinates, with the upper left window corner being 0 GLFW Docs

No documentation found.

Makie.mouse_selection is a Function.

# 1 method for generic function "mouse_selection":
[1] mouse_selection(args...) in Makie at deprecated.jl:45
mouseover(fig/ax/scene, plots::AbstractPlot...)

Returns true if the mouse currently hovers any of plots.

mouseposition(scene = hovered_scene())

Return the current position of the mouse in data coordinates of the given scene.

By default uses the scene that the mouse is currently hovering over.

No documentation found.

Makie.mouseposition_px is a Function.

# 3 methods for generic function "mouseposition_px":
[1] mouseposition_px() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:218
[2] mouseposition_px(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:218
[3] mouseposition_px(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:217

No documentation found.

GridLayoutBase.ncols is a Function.

# 1 method for generic function "ncols":
[1] ncols(g::GridLayoutBase.GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:1497

No documentation found.

GridLayoutBase.nrows is a Function.

# 1 method for generic function "nrows":
[1] nrows(g::GridLayoutBase.GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:1496
off(observable::AbstractObservable, f)

Removes f from listeners of observable.

Returns true if f could be removed, otherwise false.

off(obsfunc::ObserverFunction)

Remove the listener function obsfunc.f from the listeners of obsfunc.observable. Once obsfunc goes out of scope, this should allow obsfunc.f and all the values it might have closed over to be garbage collected (unless there are other references to it).

old_cam3d_turntable!(scene; kw_args...)

Creates a 3D camera for scene, which rotates around the plot's axis.

old_cam3d_cad!(scene; kw_args...)

Creates a 3D camera for scene which rotates around the viewer's "up" axis - similarly to how it's done in CAD software cameras.

on(f, observable::AbstractObservable; weak = false, priority=0, update=false)::ObserverFunction

Adds function f as listener to observable. Whenever observable's value is set via observable[] = val, f is called with val.

Returns an ObserverFunction that wraps f and observable and allows to disconnect easily by calling off(observerfunction) instead of off(f, observable). If instead you want to compute a new Observable from an old one, use map(f, ::Observable).

If weak = true is set, the new connection will be removed as soon as the returned ObserverFunction is not referenced anywhere and is garbage collected. This is useful if some parent object makes connections to outside observables and stores the resulting ObserverFunction instances. Then, once that parent object is garbage collected, the weak observable connections are removed automatically.

Example

julia> obs = Observable(0)
Observable{Int} with 0 listeners. Value:
0

julia> on(obs) do val
           println("current value is ", val)
       end
(::Observables.ObserverFunction) (generic function with 0 methods)

julia> obs[] = 5;
current value is 5

One can also give the callback a priority, to enable always calling a specific callback before/after others, independent of the order of registration. The callback with the highest priority gets called first, the default is zero, and the whole range of Int can be used. So one can do:

julia> obs = Observable(0)
julia> on(obs; priority=-1) do x
           println("Hi from first added")
       end
julia> on(obs) do x
           println("Hi from second added")
       end
julia> obs[] = 2
Hi from second added
Hi from first added

If you set update=true, on will call f(obs[]) immediately:

julia> on(Observable(1); update=true) do x
    println("hi")
end
hi
on(f, c::Camera, observables::Observable...)

When mapping over observables for the camera, we store them in the steering_node vector, to make it easier to disconnect the camera steering signals later!

onany(f, args...)

Calls f on updates to any observable refs in args. args may contain any number of Observable objects. f will be passed the values contained in the refs as the respective argument. All other objects in args are passed as-is.

See also: on.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === downoutside.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === enter.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftdoubleclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftdown.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftdrag.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftdragstart.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftdragstop.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === leftup.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middleclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middledoubleclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middledown.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middledrag.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middledragstart.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middledragstop.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === middleup.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === out.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === over.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightdoubleclick.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightdown.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightdrag.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightdragstart.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightdragstop.

Executes the function f whenever the MouseEventHandle's observable is set to a MouseEvent with event.type === rightup.

onpick(func, plot)

Calls func if one clicks on plot. Implemented by the backend.

onpick(f, fig/ax/scene, plots::AbstractPlot...)

Calls f(plot, idx) whenever the mouse is over any of plots. idx is an index, e.g. when over a scatter plot, it will be the index of the hovered element

Picks a mouse position. Implemented by the backend.

pick(fig/ax/scene, x, y)

Returns the plot under pixel position (x, y).

pick(fig/ax/scene, xy::VecLike)

Return the plot under pixel position xy.

pick(fig/ax/scene, xy::VecLike, range)

Return the plot closest to xy within a given range.

pick(scene::Scene, rect::Rect2i)

Return all (plot, index) pairs within the given rect. The rect must be within screen boundaries.

pie(fractions; kwargs...)

Creates a pie chart with the given fractions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.pie, T} where T are:

  color           :gray
  inner_radius    0
  inspectable     true
  normalize       true
  offset          0
  radius          1
  strokecolor     :black
  strokewidth     1
  transparency    false
  vertex_per_deg  1
  visible         true
pie(fractions; kwargs...)

Creates a pie chart with the given fractions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.pie!, T} where T are:

No documentation found.

Makie.pixelarea is a Function.

# 3 methods for generic function "pixelarea":
[1] pixelarea(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:467
[2] pixelarea(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:468
[3] pixelarea(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:466

No documentation found.

MakieCore.plot is a Function.

# 5 methods for generic function "plot":
[1] plot(P::Union{Type{Any}, Type{var"#s214"} where var"#s214"<:MakieCore.AbstractPlot}, gsp::GridLayoutBase.GridSubposition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:96
[2] plot(P::Union{Type{Any}, Type{var"#s214"} where var"#s214"<:MakieCore.AbstractPlot}, gp::GridLayoutBase.GridPosition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:49
[3] plot(P::Union{Type{Any}, Type{var"#s214"} where var"#s214"<:MakieCore.AbstractPlot}, args...; axis, figure, kw_attributes...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:14
[4] plot(scene::Makie.Scene, plot::MakieCore.AbstractPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:175
[5] plot(args...; attributes...) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:32

Main plotting signatures that plot/plot! route to if no Plot Type is given

No documentation found.

MakieCore.plotkey is a Function.

# 3 methods for generic function "plotkey":
[1] plotkey(::Type{var"#s15"} where var"#s15"<:MakieCore.AbstractPlot{Typ}) where Typ in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:21
[2] plotkey(::T) where T<:MakieCore.AbstractPlot in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:22
[3] plotkey(::Nothing) in WGLMakie at /home/runner/work/Makie.jl/Makie.jl/WGLMakie/src/serialization.jl:5

No documentation found.

Makie.plots is a Function.

# 2 methods for generic function "plots":
[1] plots(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:471
[2] plots(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:470
poly(vertices, indices; kwargs...)
poly(points; kwargs...)
poly(shape; kwargs...)
poly(mesh; kwargs...)

Plots a polygon based on the arguments given. When vertices and indices are given, it functions similarly to mesh. When points are given, it draws one polygon that connects all the points in order. When a shape is given (essentially anything decomposable by GeometryBasics), it will plot decompose(shape).

poly(coordinates, connectivity; kwargs...)

Plots polygons, which are defined by coordinates (the coordinates of the vertices) and connectivity (the edges between the vertices).

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.poly, T} where T are:

  color         RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
  colormap      :viridis
  colorrange    MakieCore.Automatic()
  cycle         [:color => :patchcolor]
  inspectable   true
  linestyle     "nothing"
  overdraw      false
  shading       false
  space         :data
  strokecolor   :black
  strokewidth   0
  transparency  false
  visible       true
poly(vertices, indices; kwargs...)
poly(points; kwargs...)
poly(shape; kwargs...)
poly(mesh; kwargs...)

Plots a polygon based on the arguments given. When vertices and indices are given, it functions similarly to mesh. When points are given, it draws one polygon that connects all the points in order. When a shape is given (essentially anything decomposable by GeometryBasics), it will plot decompose(shape).

poly(coordinates, connectivity; kwargs...)

Plots polygons, which are defined by coordinates (the coordinates of the vertices) and connectivity (the edges between the vertices).

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.poly!, T} where T are:

Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the :pixel camera type.

qqnorm(y; kwargs...)

Shorthand for qqplot(Normal(0,1), y), i.e., draw a Q-Q plot of y against the standard normal distribution. See qqplot for more details.

qqnorm(y; kwargs...)

Shorthand for qqplot(Normal(0,1), y), i.e., draw a Q-Q plot of y against the standard normal distribution. See qqplot for more details.

qqplot(x, y; kwargs...)

Draw a Q-Q plot, comparing quantiles of two distributions. y must be a list of samples, i.e., AbstractVector{<:Real}, whereas x can be

  • a list of samples,

  • an abstract distribution, e.g. Normal(0, 1),

  • a distribution type, e.g. Normal.

In the last case, the distribution type is fitted to the data y.

The attribute qqline (defaults to :none) determines how to compute a fit line for the Q-Q plot. Possible values are the following.

  • :identity draws the identity line.

  • :fit computes a least squares line fit of the quantile pairs.

  • :fitrobust computes the line that passes through the first and third quartiles of the distributions.

  • :none omits drawing the line.

Broadly speaking, qqline = :identity is useful to see if x and y follow the same distribution, whereas qqline = :fit and qqline = :fitrobust are useful to see if the distribution of y can be obtained from the distribution of x via an affine transformation.

Graphical attributes are

  • color to control color of both line and markers (if markercolor is not specified)

  • linestyle

  • linewidth

  • markercolor

  • strokecolor

  • strokewidth

  • marker

  • markersize

qqplot(x, y; kwargs...)

Draw a Q-Q plot, comparing quantiles of two distributions. y must be a list of samples, i.e., AbstractVector{<:Real}, whereas x can be

  • a list of samples,

  • an abstract distribution, e.g. Normal(0, 1),

  • a distribution type, e.g. Normal.

In the last case, the distribution type is fitted to the data y.

The attribute qqline (defaults to :none) determines how to compute a fit line for the Q-Q plot. Possible values are the following.

  • :identity draws the identity line.

  • :fit computes a least squares line fit of the quantile pairs.

  • :fitrobust computes the line that passes through the first and third quartiles of the distributions.

  • :none omits drawing the line.

Broadly speaking, qqline = :identity is useful to see if x and y follow the same distribution, whereas qqline = :fit and qqline = :fitrobust are useful to see if the distribution of y can be obtained from the distribution of x via an affine transformation.

Graphical attributes are

  • color to control color of both line and markers (if markercolor is not specified)

  • linestyle

  • linewidth

  • markercolor

  • strokecolor

  • strokewidth

  • marker

  • markersize

No documentation found.

Makie.qrotation is a Function.

# 1 method for generic function "qrotation":
[1] qrotation(axis::StaticArrays.StaticVector{3, T} where T, theta::Number) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/quaternions.jl:39
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)

Plots arrows at the specified points with the specified components. u and v are interpreted as vector components (u being the x and v being the y), and the vectors are plotted with the tails at x, y.

If x, y, u, v are <: AbstractVector, then each 'row' is plotted as a single vector.

If u, v are <: AbstractMatrix, then x and y are interpreted as specifications for a grid, and u, v are plotted as arrows along the grid.

arrows can also work in three dimensions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arrows, T} where T are:

  align           :origin
  arrowcolor      MakieCore.Automatic()
  arrowhead       MakieCore.Automatic()
  arrowsize       MakieCore.Automatic()
  arrowtail       MakieCore.Automatic()
  color           :black
  colormap        :viridis
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lengthscale     1.0f0
  linecolor       MakieCore.Automatic()
  linestyle       "nothing"
  linewidth       MakieCore.Automatic()
  markerspace     :pixel
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  normalize       false
  overdraw        false
  quality         32
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)

Plots arrows at the specified points with the specified components. u and v are interpreted as vector components (u being the x and v being the y), and the vectors are plotted with the tails at x, y.

If x, y, u, v are <: AbstractVector, then each 'row' is plotted as a single vector.

If u, v are <: AbstractMatrix, then x and y are interpreted as specifications for a grid, and u, v are plotted as arrows along the grid.

arrows can also work in three dimensions.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.arrows!, T} where T are:

rangebars(val, low, high; kwargs...)
rangebars(val, low_high; kwargs...)
rangebars(val_low_high; kwargs...)

Plots rangebars at val in one dimension, extending from low to high in the other dimension given the chosen direction.

If you want to plot errors relative to a reference value, use errorbars.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.rangebars, T} where T are:

  color         :black
  colormap      :viridis
  colorrange    MakieCore.Automatic()
  direction     :y
  inspectable   true
  linewidth     1.5
  transparency  false
  visible       true
  whiskerwidth  0
rangebars(val, low, high; kwargs...)
rangebars(val, low_high; kwargs...)
rangebars(val_low_high; kwargs...)

Plots rangebars at val in one dimension, extending from low to high in the other dimension given the chosen direction.

If you want to plot errors relative to a reference value, use errorbars.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.rangebars!, T} where T are:

record(func, figure, path; framerate = 24, compression = 20, kwargs...)
record(func, figure, path, iter; framerate = 24, compression = 20, kwargs...)

The first signature provides func with a VideoStream, which it should call recordframe!(io) on when recording a frame.

The second signature iterates iter, calling recordframe!(io) internally after calling func with the current iteration element.

Both notations require a Figure, FigureAxisPlot or Scene figure to work.

The animation is then saved to path, with the format determined by path's extension. Allowable extensions are:

  • .mkv (the default, doesn't need to convert)

  • .mp4 (good for Web, most supported format)

  • .webm (smallest file size)

  • .gif (largest file size for the same quality)

.mp4 and .mk4 are marginally bigger than webm and .gifs are up to 6 times bigger with the same quality!

The compression argument controls the compression ratio; 51 is the highest compression, and 0 or 1 is the lowest (with 0 being lossless).

Typical usage patterns would look like:

record(figure, "video.mp4", itr) do i
    func(i) # or some other manipulation of the figure
end

or, for more tweakability,

record(figure, "test.gif") do io
    for i = 1:100
        func!(figure)     # animate figure
        recordframe!(io)  # record a new frame
    end
end

If you want a more tweakable interface, consider using VideoStream and save.

Extended help

Examples

fig, ax, p = lines(rand(10))
record(fig, "test.gif") do io
    for i in 1:255
        p[:color] = RGBf(i/255, (255 - i)/255, 0) # animate figure
        recordframe!(io)
    end
end

or

fig, ax, p = lines(rand(10))
record(fig, "test.gif", 1:255) do i
    p[:color] = RGBf(i/255, (255 - i)/255, 0) # animate figure
end

Keyword Arguments:

  • framrate = 24: The target framerate.

  • compression = 0: Controls the video compression with 0 being lossless and 51 being the highest compression. Note that compression = 0 only works with .mp4 if profile = high444.

  • profile = "high422: A ffmpeg compatible profile. Currently only applies to .mp4. If you have issues playing a video, try profile = "high" or profile = "main".

  • pixel_format = "yuv420p": A ffmpeg compatible pixel format (pix_fmt). Currently only applies to .mp4. Defaults to yuv444p for profile = high444.

record_events(f, scene::Scene, path::String)

Records all window events that happen while executing function f for scene and serializes them to path.

recordframe!(io::VideoStream)

Adds a video frame to the VideoStream io.

No documentation found.

Makie.register_callbacks is a Function.

# 1 method for generic function "register_callbacks":
[1] register_callbacks(scene::Makie.Scene, native_window) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:15
register_interaction!(parent, name::Symbol, interaction)

Register interaction with parent under the name name. The parent will call process_interaction(interaction, event, parent) whenever suitable events happen.

The interaction can be removed with deregister_interaction! or temporarily toggled with activate_interaction! / deactivate_interaction!.

register_interaction!(interaction::Function, parent, name::Symbol)

Register interaction with parent under the name name. The parent will call process_interaction(interaction, event, parent) whenever suitable events happen. This form with the first Function argument is especially intended for do syntax.

The interaction can be removed with deregister_interaction! or temporarily toggled with activate_interaction! / deactivate_interaction!.

Like get!(f, dict, key) but also calls f and replaces key when the corresponding value is nothing

replay_events(f, scene::Scene, path::String)
replay_events(scene::Scene, path::String)

Replays the serialized events recorded with record_events in path in scene.

resample_cmap(cmap, ncolors::Integer; alpha=1.0)
  • cmap: anything that to_colormap accepts

  • ncolors: number of desired colors

  • alpha: additional alpha applied to each color. Can also be an array, matching colors, or a tuple giving a start + stop alpha value.

reset_limits!(ax; xauto = true, yauto = true)

Resets the axis limits depending on the value of ax.limits. If one of the two components of limits is nothing, that value is either copied from the targetlimits if xauto or yauto is false, respectively, or it is determined automatically from the plots in the axis. If one of the components is a tuple of two numbers, those are used directly.

resize_to_layout!(fig::Figure)

Resize fig so that it fits the current contents of its top GridLayout. If a GridLayout contains fixed-size content or aspect-constrained columns, for example, it is likely that the solved size of the GridLayout differs from the size of the Figure. This can result in superfluous whitespace at the borders, or content clipping at the figure edges. Once resized, all content should fit the available space, including the Figure's outer padding.

No documentation found.

Makie.MakieLayout.right is a Function.

# 1 method for generic function "right":
[1] right(rect::GeometryBasics.Rect2{T} where T) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:3
rotate!(Accum, scene::Transformable, axis_rot...)

Apply a relative rotation to the Scene, by multiplying by the current rotation.

rotate!(t::Transformable, axis_rot::Quaternion)
rotate!(t::Transformable, axis_rot::AbstractFloat)
rotate!(t::Transformable, axis_rot...)

Apply an absolute rotation to the Scene. Rotations are all internally converted to Quaternions.

rotate_cam!(scene::Scene, theta_v::Number...)
rotate_cam!(scene::Scene, theta_v::VecTypes)

Rotate the camera of the Scene by the given rotation. Passing theta_v = (α, β, γ) will rotate the camera according to the Euler angles (α, β, γ).

No documentation found.

GridLayoutBase.rowgap! is a Function.

# 4 methods for generic function "rowgap!":
[1] rowgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:644
[2] rowgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:652
[3] rowgap!(gl::GridLayoutBase.GridLayout, s::Union{GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:654
[4] rowgap!(gl::GridLayoutBase.GridLayout, r::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:659

No documentation found.

GridLayoutBase.rowsize! is a Function.

# 2 methods for generic function "rowsize!":
[1] rowsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Union{GridLayoutBase.Aspect, GridLayoutBase.Auto, GridLayoutBase.Fixed, GridLayoutBase.Relative}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:613
[2] rowsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:622
  • save(filename, data...) saves the contents of a formatted file, trying to infer the format from filename.

  • save(Stream{format"PNG"}(io), data...) specifies the format directly, and bypasses the format query.

  • save(File{format"PNG"}(filename), data...) specifies the format directly, and bypasses the format query.

  • save(f, data...; options...) passes keyword arguments on to the saver.

FileIO.save(filename, scene; resolution = size(scene), pt_per_unit = 0.75, px_per_unit = 1.0)

Save a Scene with the specified filename and format.

Supported Formats

  • GLMakie: .png, .jpeg, and .bmp

  • CairoMakie: .svg, .pdf, .png, and .jpeg

  • WGLMakie: .png

Supported Keyword Arguments

All Backends

  • resolution: (width::Int, height::Int) of the scene in dimensionless units (equivalent to px for GLMakie and WGLMakie).

CairoMakie

  • pt_per_unit: The size of one scene unit in pt when exporting to a vector format.

  • px_per_unit: The size of one scene unit in px when exporting to a bitmap format. This provides a mechanism to export the same scene with higher or lower resolution.

save(path::String, io::VideoStream[; kwargs...])

Flushes the video stream and converts the file to the extension found in path, which can be one of the following:

  • .mkv (the default, doesn't need to convert)

  • .mp4 (good for Web, most supported format)

  • .webm (smallest file size)

  • .gif (largest file size for the same quality)

.mp4 and .mk4 are marginally bigger and .gifs are up to 6 times bigger with the same quality!

See the docs of VideoStream for how to create a VideoStream. If you want a simpler interface, consider using record.

Keyword Arguments:

  • framrate = 24: The target framerate.

  • compression = 0: Controls the video compression with 0 being lossless and 51 being the highest compression. Note that compression = 0 only works with .mp4 if profile = high444.

  • profile = "high422": A ffmpeg compatible profile. Currently only applies to .mp4. If you have issues playing a video, try profile = "high" or profile = "main".

  • pixel_format = "yuv420p": A ffmpeg compatible pixel format (pix_fmt). Currently only applies to .mp4. Defaults to yuv444p for profile = high444.

scale!(t::Transformable, x, y)
scale!(t::Transformable, x, y, z)
scale!(t::Transformable, xyz)
scale!(t::Transformable, xyz...)

Scale the given Transformable (a Scene or Plot) to the given arguments. Can take x, y or x, y, z. This is an absolute scaling, and there is no option to perform relative scaling.

scatter(positions)
scatter(x, y)
scatter(x, y, z)

Plots a marker for each element in (x, y, z), (x, y), or positions.

scatter(positions)
scatter(x, y)
scatter(x, y, z)

Plots a marker for each element in (x, y, z), (x, y), or positions.

scatterlines(xs, ys, [zs]; kwargs...)

Plots scatter markers and lines between them.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.scatterlines, T} where T are:

  color             :black
  colormap          :viridis
  colorrange        MakieCore.Automatic()
  cycle             [:color]
  inspectable       true
  linestyle         "nothing"
  linewidth         1.5
  marker            GeometryBasics.Circle{T} where T
  markercolor       MakieCore.Automatic()
  markercolormap    :viridis
  markercolorrange  MakieCore.Automatic()
  markersize        9
  strokecolor       :black
  strokewidth       0
scatterlines(xs, ys, [zs]; kwargs...)

Plots scatter markers and lines between them.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.scatterlines!, T} where T are:

Registers a callback for the mouse scroll. returns an Observable{Vec{2, Float64}}, which is an x and y offset. GLFW Docs

select_line(scene; kwargs...) -> line

Interactively select a line (typically an arrow) on a 2D scene by clicking the left mouse button, dragging and then un-clicking. Return an observable whose value corresponds to the selected line on the scene. In addition the function plots the line on the scene as the user clicks and moves the mouse around. When the button is not clicked any more, the plotted line disappears.

The value of the returned line is updated only when the user un-clicks and only if the selected line has non-zero length.

The kwargs... are propagated into lines! which plots the selected line.

select_point(scene; kwargs...) -> point

Interactively select a point on a 2D scene by clicking the left mouse button, dragging and then un-clicking. Return an observable whose value corresponds to the selected point on the scene. In addition the function plots the point on the scene as the user clicks and moves the mouse around. When the button is not clicked any more, the plotted point disappears.

The value of the returned point is updated only when the user un-clicks.

The kwargs... are propagated into scatter! which plots the selected point.

select_rectangle(scene; kwargs...) -> rect

Interactively select a rectangle on a 2D scene by clicking the left mouse button, dragging and then un-clicking. The function returns an observablerect whose value corresponds to the selected rectangle on the scene. In addition the function plots the selected rectangle on the scene as the user clicks and moves the mouse around. When the button is not clicked any more, the plotted rectangle disappears.

The value of the returned observable is updated only when the user un-clicks (i.e. when the final value of the rectangle has been decided) and only if the rectangle has area > 0.

The kwargs... are propagated into lines! which plots the selected rectangle.

series(curves;
    linewidth=2,
    color=:lighttest,
    solid_color=nothing,
    labels=nothing,
    # scatter arguments, if any is set != nothing, a scatterplot is added
    marker=nothing,
    markersize=nothing,
    markercolor=automatic,
    strokecolor=nothing,
    strokewidth=nothing)

Curves can be:

  • AbstractVector{<: AbstractVector{<: Point2}}: the native representation of a series as a vector of lines

  • AbstractMatrix: each row represents y coordinates of the line, while x goes from 1:size(curves, 1)

  • AbstractVector, AbstractMatrix: the same as the above, but the first argument sets the x values for all lines

  • AbstractVector{<: Tuple{X<: AbstractVector, Y<: AbstractVector}}: A vector of tuples, where each tuple contains a vector for the x and y coordinates

series(curves;
    linewidth=2,
    color=:lighttest,
    solid_color=nothing,
    labels=nothing,
    # scatter arguments, if any is set != nothing, a scatterplot is added
    marker=nothing,
    markersize=nothing,
    markercolor=automatic,
    strokecolor=nothing,
    strokewidth=nothing)

Curves can be:

  • AbstractVector{<: AbstractVector{<: Point2}}: the native representation of a series as a vector of lines

  • AbstractMatrix: each row represents y coordinates of the line, while x goes from 1:size(curves, 1)

  • AbstractVector, AbstractMatrix: the same as the above, but the first argument sets the x values for all lines

  • AbstractVector{<: Tuple{X<: AbstractVector, Y<: AbstractVector}}: A vector of tuples, where each tuple contains a vector for the x and y coordinates

Set the slider to the value in the slider's range that is closest to value and return this value.

Set the slider to the values in the slider's range that are closest to v1 and v2, and return those values ordered min, misl.

set_theme(theme; kwargs...)

Set the global default theme to theme and add / override any attributes given as keyword arguments.

showgradients(
    cgrads::AbstractVector{Symbol};
    h = 0.0, offset = 0.2, textsize = 0.7,
    resolution = (800, length(cgrads) * 84)
)::Scene

Plots the given colour gradients arranged as horizontal colourbars. If you change the offsets or the font size, you may need to change the resolution.

spy(x::Range, y::Range, z::AbstractSparseArray)

Visualizes big sparse matrices. Usage:

N = 200_000
x = sprand(Float64, N, N, (3(10^6)) / (N*N));
spy(x)
# or if you want to specify the range of x and y:
spy(0..1, 0..1, x)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.spy, T} where T are:

  colormap     :viridis
  colorrange   MakieCore.Automatic()
  framecolor   :black
  framesize    1
  inspectable  true
  marker       MakieCore.Automatic()
  markersize   MakieCore.Automatic()

spy(x::Range, y::Range, z::AbstractSparseArray)

Visualizes big sparse matrices. Usage:

N = 200_000
x = sprand(Float64, N, N, (3(10^6)) / (N*N));
spy(x)
# or if you want to specify the range of x and y:
spy(0..1, 0..1, x)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.spy!, T} where T are:

stairs(xs, ys; kwargs...)

Plot a stair function.

The step parameter can take the following values:

  • :pre: horizontal part of step extends to the left of each value in xs.

  • :post: horizontal part of step extends to the right of each value in xs.

  • :center: horizontal part of step extends halfway between the two adjacent values of xs.

The conversion trait of stem is PointBased.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.stairs, T} where T are:

  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  step            :pre
  transparency    false
  visible         true
stairs(xs, ys; kwargs...)

Plot a stair function.

The step parameter can take the following values:

  • :pre: horizontal part of step extends to the left of each value in xs.

  • :post: horizontal part of step extends to the right of each value in xs.

  • :center: horizontal part of step extends halfway between the two adjacent values of xs.

The conversion trait of stem is PointBased.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.stairs!, T} where T are:

stem(xs, ys, [zs]; kwargs...)

Plots markers at the given positions extending from offset along stem lines.

offset can be a number, in which case it sets y for 2D, and z for 3D stems. It can be a Point2 for 2D plots, as well as a Point3 for 3D plots. It can also be an iterable of any of these at the same length as xs, ys, zs.

The conversion trait of stem is PointBased.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.stem, T} where T are:

  color            :black
  colormap         :viridis
  colorrange       MakieCore.Automatic()
  cycle            [[:stemcolor, :color, :trunkcolor] => :color]
  inspectable      true
  marker           :circle
  markersize       9
  offset           0
  stemcolor        :black
  stemcolormap     :viridis
  stemcolorrange   MakieCore.Automatic()
  stemlinestyle    "nothing"
  stemwidth        1.5
  strokecolor      :black
  strokewidth      0
  trunkcolor       :black
  trunkcolormap    :viridis
  trunkcolorrange  MakieCore.Automatic()
  trunklinestyle   "nothing"
  trunkwidth       1.5
  visible          true
stem(xs, ys, [zs]; kwargs...)

Plots markers at the given positions extending from offset along stem lines.

offset can be a number, in which case it sets y for 2D, and z for 3D stems. It can be a Point2 for 2D plots, as well as a Point3 for 3D plots. It can also be an iterable of any of these at the same length as xs, ys, zs.

The conversion trait of stem is PointBased.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.stem!, T} where T are:

streamplot(f::function, xinterval, yinterval; kwargs...)

f must either accept f(::Point) or f(x::Number, y::Number). f must return a Point2.

Example:

v(x::Point2{T}) where T = Point2f(x[2], 4*x[1])
streamplot(v, -2..2, -2..2)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.streamplot, T} where T are:

  arrow_head      MakieCore.Automatic()
  arrow_size      10
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  density         1.0
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  gridsize        (32, 32, 32)
  inspectable     true
  linestyle       "nothing"
  linewidth       1.5
  maxsteps        500
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  quality         16
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  stepsize        0.01
  transparency    false
  visible         true

Implementation

See the function Makie.streamplot_impl for implementation details.

streamplot(f::function, xinterval, yinterval; kwargs...)

f must either accept f(::Point) or f(x::Number, y::Number). f must return a Point2.

Example:

v(x::Point2{T}) where T = Point2f(x[2], 4*x[1])
streamplot(v, -2..2, -2..2)

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.streamplot!, T} where T are:

Implementation

See the function Makie.streamplot_impl for implementation details.

surface(x, y, z)

Plots a surface, where (x, y) define a grid whose heights are the entries in z. x and y may be Vectors which define a regular grid, orMatrices which define an irregular grid.

surface(x, y, z)

Plots a surface, where (x, y) define a grid whose heights are the entries in z. x and y may be Vectors which define a regular grid, orMatrices which define an irregular grid.

Swaps or rotates the layout positions of the given elements to their neighbor's.

text(string)

Plots a text.

text(string)

Plots a text.

No documentation found.

MakieCore.theme is a Function.

# 6 methods for generic function "theme":
[1] theme(x::MakieCore.AbstractScene) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:56
[2] theme(x::MakieCore.AbstractScene, key) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:57
[3] theme(x::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}, args...) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:55
[4] theme(x::MakieCore.AbstractPlot) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/attributes.jl:156
[5] theme(x::MakieCore.AbstractPlot, key) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:58
[6] theme(::Nothing, key::Symbol) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/theming.jl:145

No documentation found.

Makie.theme_black is a Function.

# 1 method for generic function "theme_black":
[1] theme_black() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_black.jl:1

No documentation found.

Makie.theme_dark is a Function.

# 1 method for generic function "theme_dark":
[1] theme_dark() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_dark.jl:1

No documentation found.

Makie.theme_ggplot2 is a Function.

# 1 method for generic function "theme_ggplot2":
[1] theme_ggplot2() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_ggplot2.jl:1

No documentation found.

Makie.theme_light is a Function.

# 1 method for generic function "theme_light":
[1] theme_light() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_light.jl:1

No documentation found.

Makie.theme_minimal is a Function.

# 1 method for generic function "theme_minimal":
[1] theme_minimal() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_minimal.jl:1

No documentation found.

Makie.MakieLayout.tight_ticklabel_spacing! is a Function.

# 3 methods for generic function "tight_ticklabel_spacing!":
[1] tight_ticklabel_spacing!(la::Makie.MakieLayout.LineAxis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/lineaxis.jl:405
[2] tight_ticklabel_spacing!(la::Makie.MakieLayout.Axis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1139
[3] tight_ticklabel_spacing!(lc::Makie.MakieLayout.Colorbar) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/colorbar.jl:365

No documentation found.

Makie.MakieLayout.tight_xticklabel_spacing! is a Function.

# 1 method for generic function "tight_xticklabel_spacing!":
[1] tight_xticklabel_spacing!(la::Makie.MakieLayout.Axis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1135

No documentation found.

Makie.MakieLayout.tight_yticklabel_spacing! is a Function.

# 1 method for generic function "tight_yticklabel_spacing!":
[1] tight_yticklabel_spacing!(la::Makie.MakieLayout.Axis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1131
tightlimits!(la::Axis)

Sets the autolimit margins to zero on all sides.

tightlimits!(la::Axis, sides::Union{Left, Right, Bottom, Top}...)

Sets the autolimit margins to zero on all given sides.

Example:

tightlimits!(laxis, Bottom())
timeseries(x::Observable{{Union{Number, Point2}}})

Plots a sampled signal. Usage:

signal = Observable(1.0)
scene = timeseries(signal)
display(scene)
# @async is optional, but helps to continue evaluating more code
@async while isopen(scene)
    # aquire data from e.g. a sensor:
    data = rand()
    # update the signal
    signal[] = data
    # sleep/ wait for new data/ whatever...
    # It's important to yield here though, otherwise nothing will be rendered
    sleep(1/30)
end
timeseries(x::Observable{{Union{Number, Point2}}})

Plots a sampled signal. Usage:

signal = Observable(1.0)
scene = timeseries(signal)
display(scene)
# @async is optional, but helps to continue evaluating more code
@async while isopen(scene)
    # aquire data from e.g. a sensor:
    data = rand()
    # update the signal
    signal[] = data
    # sleep/ wait for new data/ whatever...
    # It's important to yield here though, otherwise nothing will be rendered
    sleep(1/30)
end
Text align, e.g.:

No documentation found.

Makie.to_color is a Function.

# 10 methods for generic function "to_color":
[1] to_color(p::Makie.Palette) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:748
[2] to_color(c::Nothing) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:754
[3] to_color(c::Number) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:755
[4] to_color(c::ColorTypes.Colorant) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:756
[5] to_color(c::Symbol) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:757
[6] to_color(c::String) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:758
[7] to_color(p::Makie.AbstractPattern) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:761
[8] to_color(c::AbstractArray{var"#s214", N} where var"#s214"<:ColorTypes.Colorant) where N in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:760
[9] to_color(c::AbstractArray) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:759
[10] to_color(c::Tuple{Any, Number}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:762
to_colormap(b::AbstractVector)

An AbstractVector{T} with any object that to_color accepts.

to_colormap(cs::Union{String, Symbol})::Vector{RGBAf}

A Symbol/String naming the gradient. For more on what names are available please see: available_gradients(). For now, we support gradients from PlotUtils natively.

font conversion

a string naming a font, e.g. helvetica

No documentation found.

Makie.to_ndim is a Function.

# 1 method for generic function "to_ndim":
[1] to_ndim(T::Type{var"#s8"} where var"#s8"<:Union{Tuple{Vararg{ET, N}}, StaticArrays.StaticVector{N, ET}}, vec::Union{Tuple{Vararg{T, N2}}, StaticArrays.StaticVector{N2, T}} where T, fillval) where {N, ET, N2} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:225
rotation accepts:
to_rotation(b, quaternion)
to_rotation(b, tuple_float)
to_rotation(b, vec4)

No documentation found.

Makie.to_textsize is a Function.

# 2 methods for generic function "to_textsize":
[1] to_textsize(x::Number) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:977
[2] to_textsize(x::AbstractVector{T}) where T<:Number in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:978
to_value(x::Union{Any, AbstractObservable})

Extracts the value of an observable, and returns the object if it's not an observable!

No documentation found.

Makie.to_vector is a Function.

# 3 methods for generic function "to_vector":
[1] to_vector(x::AbstractVector{T} where T, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:254
[2] to_vector(x::AbstractArray, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:255
[3] to_vector(x::IntervalSets.ClosedInterval{T} where T, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:262

No documentation found.

Makie.to_world is a Function.

# 3 methods for generic function "to_world":
[1] to_world(scene::Makie.Scene, point::T) where T<:(StaticArrays.StaticVector{N, T} where {N, T}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:241
[2] to_world(p::GeometryBasics.Vec{N, T}, prj_view_inv::StaticArrays.SMatrix{4, 4, T, 16} where T, cam_res::StaticArrays.StaticVector{N, T} where {N, T}) where {N, T} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:272
[3] to_world(p::StaticArrays.StaticVector{N, T}, prj_view_inv::StaticArrays.SMatrix{4, 4, T, 16} where T, cam_res::StaticArrays.StaticVector{N, T} where {N, T}) where {N, T} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:256

No documentation found.

Makie.MakieLayout.top is a Function.

# 1 method for generic function "top":
[1] top(rect::GeometryBasics.Rect2{T} where T) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:5
translate!(scene::Transformable, xyz::VecTypes)
translate!(scene::Transformable, xyz...)

Apply an absolute translation to the Scene, translating it to x, y, z.

translate!(Accum, scene::Transformable, xyz...)

Translate the scene relative to its current position.

translate_cam!(scene::Scene, translation::VecTypes)

Translate the camera by a translation vector given in camera space.

No documentation found.

Makie.translated is a Function.

# 2 methods for generic function "translated":
[1] translated(scene::Makie.Scene; kw_args...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:58
[2] translated(scene::Makie.Scene, translation...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:52

No documentation found.

Makie.translation is a Function.

# 1 method for generic function "translation":
[1] translation(scene::MakieCore.Transformable) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:133

No documentation found.

GridLayoutBase.trim! is a Function.

# 1 method for generic function "trim!":
[1] trim!(gl::GridLayoutBase.GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:505

Registers a callback for keyboard unicode input. returns an Observable{Vector{Char}}, containing the pressed char. Is empty, if no key is pressed. GLFW Docs

update_cam!(scene::SceneLike, area)

Updates the camera for the given scene to cover the given area in 2d.

update_cam!(scene::SceneLike)

Updates the camera for the given scene to cover the limits of the Scene. Useful when using the Observable pipeline.

update_cam!(scene::Scene, eyeposition, lookat, up = Vec3f(0, 0, 1))

Updates the camera's controls to point to the specified location.

update_theme!(with_theme::Theme; kwargs...)

Updates the current theme incrementally, that means only the keys given in with_theme or through keyword arguments are changed, the rest is left intact. Nested attributes are either also updated incrementally, or replaced if they are not attributes in the new theme.

used_attributes(args...) = ()

Function used to indicate what keyword args one wants to get passed in convert_arguments. Those attributes will not be forwarded to the backend, but only used during the conversion pipeline. Usage:

    struct MyType end
    used_attributes(::MyType) = (:attribute,)
    function convert_arguments(x::MyType; attribute = 1)
        ...
    end
    # attribute will get passed to convert_arguments
    # without keyword_verload, this wouldn't happen
    plot(MyType, attribute = 2)
    #You can also use the convenience macro, to overload convert_arguments in one step:
    @keywords convert_arguments(x::MyType; attribute = 1)
        ...
    end
vbox!(content::Vararg; kwargs...)

Creates a single-column GridLayout with all elements contained in content placed from top to bottom.

violin(x, y; kwargs...)

Draw a violin plot.

Arguments

  • x: positions of the categories

  • y: variables whose density is computed

Keywords

  • weights: vector of statistical weights (length of data). By default, each observation has weight 1.

  • orientation=:vertical: orientation of the violins (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_median=true: show median as midline

  • side=:both: specify :left or :right to only plot the violin on one side

  • datalimits: specify values to trim the violin. Can be a Tuple or a Function (e.g. datalimits=extrema)

violin(x, y; kwargs...)

Draw a violin plot.

Arguments

  • x: positions of the categories

  • y: variables whose density is computed

Keywords

  • weights: vector of statistical weights (length of data). By default, each observation has weight 1.

  • orientation=:vertical: orientation of the violins (:vertical or :horizontal)

  • width=1: width of the box before shrinking

  • gap=0.2: shrinking factor, width -> width * (1 - gap)

  • show_median=true: show median as midline

  • side=:both: specify :left or :right to only plot the violin on one side

  • datalimits: specify values to trim the violin. Can be a Tuple or a Function (e.g. datalimits=extrema)

vlines!(ax::Axis, xs; ymin = 0.0, ymax = 1.0, attrs...)

Create vertical lines across ax at xs in data coordinates and ymin to ymax in axis coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.

volume(volume_data)
volume(x, y, z, volume_data)

Plots a volume, with optional physical dimensions x, y, z. Available algorithms are:

  • :iso => IsoValue

  • :absorption => Absorption

  • :mip => MaximumIntensityProjection

  • :absorptionrgba => AbsorptionRGBA

  • :additive => AdditiveRGBA

  • :indexedabsorption => IndexedAbsorptionRGBA

volume(volume_data)
volume(x, y, z, volume_data)

Plots a volume, with optional physical dimensions x, y, z. Available algorithms are:

  • :iso => IsoValue

  • :absorption => Absorption

  • :mip => MaximumIntensityProjection

  • :absorptionrgba => AbsorptionRGBA

  • :additive => AdditiveRGBA

  • :indexedabsorption => IndexedAbsorptionRGBA

VolumeSlices

volumeslices(x, y, z, v)

Draws heatmap slices of the volume v

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.volumeslices, T} where T are:

  bbox_color      RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.5f0)
  bbox_visible    true
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  depth_shift     0.0f0
  diffuse         Float32[0.4, 0.4, 0.4]
  highclip        "nothing"
  inspectable     true
  interpolate     false
  levels          1
  linewidth       0.0
  lowclip         "nothing"
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

VolumeSlices

volumeslices(x, y, z, v)

Draws heatmap slices of the volume v

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.volumeslices!, T} where T are:

vspan!(ax::Axis, x_lows, x_highs; ymin = 0.0, ymax = 1.0, attrs...)

Create vertical spans across ax from x_lows to x_highs in data coordinates and ymin to ymax in axis coordinates (0 to 1 by default). All four of these can have single or multiple values because they are broadcast to calculate the final spans.

No documentation found.

GridLayoutBase.width is a Function.

# 1 method for generic function "width":
[1] width(rect::GeometryBasics.Rect2{T} where T) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/helpers.jl:116

No documentation found.

GeometryBasics.widths is a Function.

# 5 methods for generic function "widths":
[1] widths(prim::GeometryBasics.HyperRectangle) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/3PqdK/src/primitives/rectangles.jl:162
[2] widths(c::GeometryBasics.HyperSphere{N, T}) where {N, T} in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/3PqdK/src/primitives/spheres.jl:28
[3] widths(x::AbstractRange) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/3PqdK/src/geometry_primitives.jl:4
[4] widths(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:288
[5] widths(x::GLMakie.Screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/screen.jl:42

No documentation found.

Makie.window_area is a Function.

# 2 methods for generic function "window_area":
[1] window_area(scene::Makie.Scene, screen::GLMakie.Screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:43
[2] window_area(scene, native_window) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:4

Returns a signal, which is true as long as the window is open. returns Observable{Bool}GLFW Docs

wireframe(x, y, z)
wireframe(positions)
wireframe(mesh)

Draws a wireframe, either interpreted as a surface or as a mesh.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.wireframe, T} where T are:

  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  depth_shift     -1.0f-5
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  space           :data
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true
wireframe(x, y, z)
wireframe(positions)
wireframe(mesh)

Draws a wireframe, either interpreted as a surface or as a mesh.

Attributes

Available attributes and their defaults for MakieCore.Combined{Makie.wireframe!, T} where T are:

with_theme(f, theme = Theme(); kwargs...)

Calls f with theme temporarily activated. Attributes in theme can be overridden or extended with kwargs. The previous theme is always restored afterwards, no matter if f succeeds or fails.

Example:

my_theme = Theme(resolution = (500, 500), color = :red)
with_theme(my_theme, color = :blue, linestyle = :dashed) do
    scatter(randn(100, 2))
end

No documentation found.

GridLayoutBase.with_updates_suspended is a Function.

# 1 method for generic function "with_updates_suspended":
[1] with_updates_suspended(f::Function, gl::GridLayoutBase.GridLayout; update) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/ZQ2p1/src/gridlayout.jl:180
xlabel!([scene,] xlabel)

Set the x-axis label for the given Scene. Defaults to using the current Scene.

No documentation found.

Makie.xlims! is a Function.

# 6 methods for generic function "xlims!":
[1] xlims!() in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1200
[2] xlims!(ax::Makie.MakieLayout.Axis, xlims) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1158
[3] xlims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1196
[4] xlims!(ax::Makie.MakieLayout.Axis3, xlims::Tuple{Union{Nothing, Real}, Union{Nothing, Real}}) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:827
[5] xlims!(ax; low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1200
[6] xlims!(ax, low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1192
xticklabels(scene)

Returns the all the x-axis tick labels. See also ticklabels.

xtickrange(scene)

Returns the tick range along the x-axis. See also tickranges.

xtickrotation(scene)

Returns the rotation of tick labels along the x-axis. See also tickrotations

xtickrotation!([scene,] xangle)

Set the rotation of tick labels along the x-axis. See also tickrotations!.

xticks!([scene,]; xtickrange=xtickrange(scene), xticklabels=xticklabel(scene))

Set the tick labels and range along the x-axes. See also ticks!.

ylabel!([scene,] ylabel)

Set the y-axis label for the given Scene. Defaults to using the current Scene.

No documentation found.

Makie.ylims! is a Function.

# 6 methods for generic function "ylims!":
[1] ylims!() in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1201
[2] ylims!(ax::Makie.MakieLayout.Axis, ylims) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1175
[3] ylims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1197
[4] ylims!(ax::Makie.MakieLayout.Axis3, ylims::Tuple{Union{Nothing, Real}, Union{Nothing, Real}}) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:844
[5] ylims!(ax; low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1201
[6] ylims!(ax, low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1193
yticklabels(scene)

Returns the all the y-axis tick labels. See also ticklabels.

ytickrange(scene)

Returns the tick range along the y-axis. See also tickranges.

ytickrotation(scene)

Returns the rotation of tick labels along the y-axis. See also tickrotations

ytickrotation!([scene,] yangle)

Set the rotation of tick labels along the y-axis. See also tickrotations!.

yticks!([scene,]; ytickrange=ytickrange(scene), yticklabels=yticklabel(scene))

Set the tick labels and range along all the y-axis. See also ticks!.

zlabel!([scene,] zlabel)

Set the z-axis label for the given Scene. Defaults to using the current Scene.

Warning

The Scene must have an Axis3D. If not, then this function will error.

No documentation found.

Makie.zlims! is a Function.

# 5 methods for generic function "zlims!":
[1] zlims!() in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1202
[2] zlims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1198
[3] zlims!(ax::Makie.MakieLayout.Axis3, zlims) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:861
[4] zlims!(ax; low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1202
[5] zlims!(ax, low, high) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1194
zoom!(scene, zoom_step)

Zooms the camera in or out based on the multiplier zoom_step. A zoom_step of 1.0 is neutral, larger zooms out and lower zooms in.

Note that this method only applies to Camera3D.

zoom!(scene, point, zoom_step, shift_lookat::Bool)

Zooms the camera of scene in towards point by a factor of zoom_step. A positive zoom_step zooms in while a negative zoom_step zooms out.

zticklabels(scene)

Returns the all the z-axis tick labels. See also ticklabels.

ztickrange(scene)

Returns the tick range along the z-axis. See also tickranges.

ztickrotation(scene)

Returns the rotation of tick labels along the z-axis. See also tickrotations

ztickrotation!([scene,] zangle)

Set the rotation of tick labels along the z-axis. See also tickrotations!.

zticks!([scene,]; ztickranges=ztickrange(scene), zticklabels=zticklabel(scene))

Set the tick labels and range along all z-axis. See also ticks!.