..

...

The "splat" operator, ... , represents a sequence of arguments. ... can be used in function definitions, to indicate that the function accepts an arbitrary number of arguments. ... can also be used to apply a function to a sequence of arguments.

Examples

julia> add(xs...) = reduce(+, xs)
add (generic function with 1 method)

julia> add(1, 2, 3, 4, 5)
15

julia> add([1, 2, 3]...)
6

julia> add(7, 1:100..., 1000:1100...)
111107

@L_str

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$"

@extract

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

@extractvalue

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

@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

@key_str

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/.julia/packages/MakieCore/S8PkO/src/types.jl:40

@lift

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

Example:

x = Node(rand(100)) y = Node(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 a node.

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

@recipe

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 i th 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

Absolute

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

Absorption

No documentation found.

Makie.Absorption is of type Makie.RaymarchAlgorithm .

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

AbsorptionRGBA

No documentation found.

Makie.AbsorptionRGBA is of type Makie.RaymarchAlgorithm .

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

AbstractCamera

No documentation found.

Summary

abstract type Makie.AbstractCamera <: Any

Subtypes

Makie.Camera2D
Makie.Camera3D
Makie.EmptyCamera
Makie.OldCamera3D
Makie.PixelCamera

AbstractPlot

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

AbstractScene

No documentation found.

Summary

abstract type MakieCore.AbstractScene <: MakieCore.Transformable

Subtypes

Makie.Scene

Supertype Hierarchy

MakieCore.AbstractScene <: MakieCore.Transformable <: Any

AbstractScreen

No documentation found.

Summary

abstract type MakieCore.AbstractScreen <: AbstractDisplay

Subtypes

CairoMakie.CairoScreen
GLMakie.GLScreen

Supertype Hierarchy

MakieCore.AbstractScreen <: AbstractDisplay <: Any

Accum

Accum

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

Annotations

No documentation found.

Makie.Annotations is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Arc

No documentation found.

Makie.Arc is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Arrows

No documentation found.

Makie.Arrows is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Aspect

No documentation found.

Summary

struct GridLayoutBase.Aspect <: GridLayoutBase.ContentSize

Fields

index :: Int64
ratio :: Float64

Supertype Hierarchy

GridLayoutBase.Aspect <: GridLayoutBase.ContentSize <: Any

Atomic

No documentation found.

Makie.Atomic is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Attributes

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

Auto

struct Auto <: ContentSize

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.

Axis

Axis has the following attributes:

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

aspect
Default: nothing
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.

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

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

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

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

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

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

height
Default: nothing
The height of the axis.

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

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

limits
Default: (nothing, nothing)
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 (nothing or xlims, nothing or ylims). Are set by xlims! , ylims! and limits! .

palette
Default: if scene !== nothing && haskey(scene.attributes, :palette) deepcopy(scene.palette) else Attributes() end
Attributes with one palette per key, for example color = [:red, :green, :blue]

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

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

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

spinewidth
Default: 1.0
The width of the axis spines.

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

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

title
Default: ""
The axis title string.

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

titlecolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the title

titlefont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the title.

titlegap
Default: 4.0
The gap between axis and title.

titlesize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The title's font size.

titlevisible
Default: true
Controls if the title is visible.

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

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

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

width
Default: nothing
The width of the axis.

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

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

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

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

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

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

xlabel
Default: ""
The xlabel string.

xlabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the xlabel.

xlabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the xlabel.

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

xlabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the xlabel.

xlabelvisible
Default: true
Controls if the xlabel is visible.

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

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

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

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

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

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

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

xminorticksize
Default: 4.0
The tick size of x minor ticks

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

xminortickwidth
Default: 1.0
The tick width of x minor ticks

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

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

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

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

xscale
Default: identity
The x axis scale

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

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

xtickformat
Default: Makie.automatic
Format for xticks.

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

xticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of xticklabels.

xticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the xticklabels.

xticklabelpad
Default: 2.0
The space between xticks and xticklabels.

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

xticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the xticklabels.

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

xticklabelsvisible
Default: true
Controls if the xticklabels are visible.

xticks
Default: Makie.automatic
The xticks.

xticksize
Default: 6.0
The size of the xtick marks.

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

xtickwidth
Default: 1.0
The width of the xtick marks.

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

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

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

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

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

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

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

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

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

ylabel
Default: ""
The ylabel string.

ylabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the ylabel.

ylabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the ylabel.

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

ylabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the ylabel.

ylabelvisible
Default: true
Controls if the ylabel is visible.

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

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

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

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

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

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

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

yminorticksize
Default: 4.0
The tick size of y minor ticks

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

yminortickwidth
Default: 1.0
The tick width of y minor ticks

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

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

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

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

yscale
Default: identity
The y axis scale

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

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

ytickformat
Default: Makie.automatic
Format for yticks.

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

yticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of yticklabels.

yticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the yticklabels.

yticklabelpad
Default: 4.0
The space between yticks and yticklabels.

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

yticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the yticklabels.

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

yticklabelsvisible
Default: true
Controls if the yticklabels are visible.

yticks
Default: Makie.automatic
The yticks.

yticksize
Default: 6.0
The size of the ytick marks.

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

ytickwidth
Default: 1.0
The width of the ytick marks.

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

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

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

Axis3

Axis3 has the following attributes:

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

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

azimuth
Default: 1.275pi
The azimuth angle of the camera

backgroundcolor
Default: :transparent
The background color

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

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

height
Default: nothing
The height setting of the scene.

limits
Default: (nothing, nothing, nothing)
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 (nothing or xlims, nothing or ylims, nothing or zlims). Are set by xlims! , ylims! , zlims! and limits! .

palette
Default: if scene !== nothing && haskey(scene.attributes, :palette) deepcopy(scene.palette) else Attributes() end
Attributes with one palette per key, for example color = [:red, :green, :blue]

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

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

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

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

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

title
Default: ""
The axis title string.

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

titlecolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the title

titlefont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the title.

titlegap
Default: 4.0
The gap between axis and title.

titlesize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The title's font size.

titlevisible
Default: true
Controls if the title is visible.

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

viewmode
Default: :fitzoom
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.

width
Default: nothing
The width setting of the scene.

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

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

xgridvisible
Default: true
Controls if the x grid is visible

xgridwidth
Default: 1
The x grid width

xlabel
Default: "x"
The x label

xlabelalign
Default: Makie.automatic
The x label align

xlabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The x label color

xlabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The x label font

xlabeloffset
Default: 40
The x label offset

xlabelrotation
Default: Makie.automatic
The x label rotation

xlabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The x label size

xlabelvisible
Default: true
Controls if the x label is visible

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

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

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

xspinesvisible
Default: true
Controls if the x spine is visible

xspinewidth
Default: 1
The x spine width

xtickcolor
Default: :black
The x tick color

xtickformat
Default: Makie.automatic
The x tick format

xticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The x ticklabel color

xticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The x ticklabel font

xticklabelpad
Default: 5
The x ticklabel pad

xticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The x ticklabel size

xticklabelsvisible
Default: true
Controls if the x ticklabels are visible

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

xticksvisible
Default: true
Controls if the x ticks are visible

xtickwidth
Default: 1
The x tick width

xypanelcolor
Default: :transparent
The color of the xy panel

xypanelvisible
Default: true
Controls if the xy panel is visible

xzpanelcolor
Default: :transparent
The color of the xz panel

xzpanelvisible
Default: true
Controls if the xz panel is visible

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

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

ygridvisible
Default: true
Controls if the y grid is visible

ygridwidth
Default: 1
The y grid width

ylabel
Default: "y"
The y label

ylabelalign
Default: Makie.automatic
The y label align

ylabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The y label color

ylabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The y label font

ylabeloffset
Default: 40
The y label offset

ylabelrotation
Default: Makie.automatic
The y label rotation

ylabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The y label size

ylabelvisible
Default: true
Controls if the y label is visible

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

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

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

yspinesvisible
Default: true
Controls if the y spine is visible

yspinewidth
Default: 1
The y spine width

ytickcolor
Default: :black
The y tick color

ytickformat
Default: Makie.automatic
The y tick format

yticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The y ticklabel color

yticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The y ticklabel font

yticklabelpad
Default: 5
The y ticklabel pad

yticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The y ticklabel size

yticklabelsvisible
Default: true
Controls if the y ticklabels are visible

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

yticksvisible
Default: true
Controls if the y ticks are visible

ytickwidth
Default: 1
The y tick width

yzpanelcolor
Default: :transparent
The color of the yz panel

yzpanelvisible
Default: true
Controls if the yz panel is visible

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

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

zgridvisible
Default: true
Controls if the z grid is visible

zgridwidth
Default: 1
The z grid width

zlabel
Default: "z"
The z label

zlabelalign
Default: Makie.automatic
The z label align

zlabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The z label color

zlabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The z label font

zlabeloffset
Default: 50
The z label offset

zlabelrotation
Default: Makie.automatic
The z label rotation

zlabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The z label size

zlabelvisible
Default: true
Controls if the z label is visible

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

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

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

zspinesvisible
Default: true
Controls if the z spine is visible

zspinewidth
Default: 1
The z spine width

ztickcolor
Default: :black
The z tick color

ztickformat
Default: Makie.automatic
The z tick format

zticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The z ticklabel color

zticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The z ticklabel font

zticklabelpad
Default: 10
The z ticklabel pad

zticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The z ticklabel size

zticklabelsvisible
Default: true
Controls if the z ticklabels are visible

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

zticksvisible
Default: true
Controls if the z ticks are visible

ztickwidth
Default: 1
The z tick width

Axis3D

No documentation found.

Makie.Axis3D is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

AxisAspect

No documentation found.

Summary

struct Makie.MakieLayout.AxisAspect <: Any

Fields

aspect :: Float32

BBox

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/nYdeK/src/geometry_integration.jl:10

Band

No documentation found.

Makie.Band is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

BarPlot

No documentation found.

Makie.BarPlot is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Billboard

Billboard([angle::Real])
Billboard([angles::Vector{<: Real}])

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

Bottom

No documentation found.

Summary

struct GridLayoutBase.Bottom <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Bottom <: GridLayoutBase.Side <: Any

BottomLeft

No documentation found.

Summary

struct GridLayoutBase.BottomLeft <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.BottomLeft <: GridLayoutBase.Side <: Any

BottomRight

No documentation found.

Summary

struct GridLayoutBase.BottomRight <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.BottomRight <: GridLayoutBase.Side <: Any

Box

Box has the following attributes:

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

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

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

height
Default: nothing
The height setting of the rectangle.

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

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

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

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

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

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

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

visible
Default: true
Controls if the rectangle is visible.

width
Default: nothing
The width setting of the rectangle.

BoxPlot

No documentation found.

Makie.BoxPlot is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Button

Button has the following attributes:

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

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

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

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

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

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

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

font
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the button label.

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

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

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

labelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the label.

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

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

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

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

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

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

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

textsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the button label.

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

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

Camera

No documentation found.

Summary

mutable struct Makie.Camera <: Any

Fields

pixel_space    :: Observables.Observable{StaticArrays.SMatrix{4, 4, Float32, 16}}
view           :: Observables.Observable{StaticArrays.SMatrix{4, 4, Float32, 16}}
projection     :: Observables.Observable{StaticArrays.SMatrix{4, 4, Float32, 16}}
projectionview :: Observables.Observable{StaticArrays.SMatrix{4, 4, Float32, 16}}
resolution     :: Observables.Observable{GeometryBasics.Vec{2, Float32}}
eyeposition    :: Observables.Observable{GeometryBasics.Vec{3, Float32}}
steering_nodes :: Vector{Observables.ObserverFunction}

Camera2D

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

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)
translation_modifier = nothing sets additional keys that need to be held for mouse translations.
rotation_button = Mouse.left sets the mouse button for drag-rotations. (pan, tilt)
rotation_modifier = nothing sets additional keys that need to be held for mouse rotations.
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 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).

Circle

Circle{T}

An alias for a HyperSphere of dimension 2. (i.e. HyperSphere{2, T} )

Colorbar

Colorbar(parent; kwargs...)
Colorbar(parent, plotobject; kwargs...)
Colorbar(parent, heatmap::Heatmap; kwargs...)
Colorbar(parent, contourf::Contourf; kwargs...)

Add a Colorbar to parent . If you pass a plotobject , a heatmap or contourf , the Colorbar is set up automatically such that it tracks these objects' relevant attributes like colormap , colorrange , highclip and lowclip . If you want to adjust these attributes afterwards, change them in the plot object, otherwise the Colorbar and the plot object will go out of sync.

Colorbar has the following attributes:

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

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

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

colormap
Default: lift_parent_attribute(scene, :colormap, :viridis)
The colormap that the colorbar uses.

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

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

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

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

height
Default: Makie.automatic
The height setting of the colorbar.

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

label
Default: ""
The color bar label string.

labelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The label color.

labelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The label font family.

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

labelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The label font size.

labelvisible
Default: true
Controls if the label is visible.

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

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

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

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

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

minortickcolor
Default: :black
The tick color of minor ticks

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

minorticksize
Default: 4.0
The tick size of minor ticks

minorticksvisible
Default: false
Controls if minor ticks are visible

minortickwidth
Default: 1.0
The tick width of minor ticks

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

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

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

scale
Default: identity
The axis scale

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

spinewidth
Default: 1.0
The line width of the spines.

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

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

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

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

tickformat
Default: Makie.automatic
Format for ticks.

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

ticklabelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the tick labels.

ticklabelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the tick labels.

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

ticklabelrotation
Default: 0.0
The rotation of the ticklabels

ticklabelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the tick labels.

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

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

ticks
Default: Makie.automatic
The ticks.

ticksize
Default: 6.0
The size of the tick marks.

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

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

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

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

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

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

width
Default: Makie.automatic
The width setting of the colorbar. Use size to set width or height relative to colorbar orientation instead.

Combined

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

Consume

No documentation found.

Summary

struct Makie.Consume <: Any

Fields

x :: Bool

ContinuousSurface

No documentation found.

Summary

struct MakieCore.ContinuousSurface <: MakieCore.SurfaceLike

Supertype Hierarchy

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

Contour

No documentation found.

Makie.Contour is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Contour3d

No documentation found.

Makie.Contour3d is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Contourf

No documentation found.

Makie.Contourf is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

ConversionTrait

No documentation found.

Summary

abstract type MakieCore.ConversionTrait <: Any

Subtypes

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

CrossBar

No documentation found.

Makie.CrossBar is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Cycle

No documentation found.

Summary

struct Makie.MakieLayout.Cycle <: Any

Fields

cycle  :: Vector{Pair{Vector{Symbol}, Symbol}}
covary :: Bool

DataAspect

No documentation found.

Summary

struct Makie.MakieLayout.DataAspect <: Any

DataInspector

DataInspector(figure; kwargs...)

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 .

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 = "Dejavu Sans" : 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.

Density

No documentation found.

Makie.Density is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

DiscreteSurface

No documentation found.

Summary

struct MakieCore.DiscreteSurface <: MakieCore.SurfaceLike

Supertype Hierarchy

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

EmptyCamera

No documentation found.

Summary

struct Makie.EmptyCamera <: Makie.AbstractCamera

Supertype Hierarchy

Makie.EmptyCamera <: Makie.AbstractCamera <: Any

Errorbars

No documentation found.

Makie.Errorbars is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Events

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

Functions that act on a PriorityObservable 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 = Int8(20)) do event
    if is_correct_event(event)
        do_something()
        return Consume()
    end
    return
end

Fields

window_area::Makie.PriorityObservable{GeometryBasics.HyperRectangle{2, Int64}}

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

window_dpi::Makie.PriorityObservable{Float64}

The DPI resolution of the window, as a Float64 .

window_open::Makie.PriorityObservable{Bool}

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

mousebutton::Makie.PriorityObservable{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::Makie.PriorityObservable{Tuple{Float64, Float64}}

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

scroll::Makie.PriorityObservable{Tuple{Float64, Float64}}

The direction of scroll

keyboardbutton::Makie.PriorityObservable{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::Makie.PriorityObservable{Char}

Contains the last typed character.

dropped_files::Makie.PriorityObservable{Vector{String}}

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

hasfocus::Makie.PriorityObservable{Bool}

Whether the Scene window is in focus or not.

entered_window::Makie.PriorityObservable{Bool}

Whether the mouse is inside the window or not.

FRect

No documentation found.

GeometryBasics.FRect is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

FRect2D

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.

FRect3D

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.

Figure

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}

Fixed

No documentation found.

Summary

struct GridLayoutBase.Fixed <: GridLayoutBase.GapSize

Fields

x :: Float64

Supertype Hierarchy

GridLayoutBase.Fixed <: GridLayoutBase.GapSize <: GridLayoutBase.ContentSize <: Any

GLNormalUVMesh

No documentation found.

GeometryBasics.GLNormalUVMesh is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

GridLayout

No documentation found.

Summary

mutable struct GridLayoutBase.GridLayout <: Any

Fields

parent              :: Any
content             :: Vector{GridLayoutBase.GridContent}
nrows               :: Int64
ncols               :: Int64
rowsizes            :: Vector{GridLayoutBase.ContentSize}
colsizes            :: Vector{GridLayoutBase.ContentSize}
addedrowgaps        :: Vector{GridLayoutBase.GapSize}
addedcolgaps        :: Vector{GridLayoutBase.GapSize}
alignmode           :: Observables.Observable{GridLayoutBase.AlignMode}
equalprotrusiongaps :: Tuple{Bool, Bool}
needs_update        :: Observables.Observable{Bool}
block_updates       :: Bool
layoutobservables   :: GridLayoutBase.LayoutObservables
width               :: Observables.Observable
height              :: Observables.Observable
tellwidth           :: Observables.Observable
tellheight          :: Observables.Observable
halign              :: Observables.Observable
valign              :: Observables.Observable
default_rowgap      :: GridLayoutBase.GapSize
default_colgap      :: GridLayoutBase.GapSize
_update_func_handle :: Union{Nothing, Function}

GridLayoutSpec

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}

GridPosition

No documentation found.

Summary

struct GridLayoutBase.GridPosition <: Any

Fields

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

GridSubposition

No documentation found.

Summary

struct GridLayoutBase.GridSubposition <: Any

Fields

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

Heatmap

No documentation found.

MakieCore.Heatmap is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Hist

No documentation found.

Makie.Hist is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

IRect

No documentation found.

GeometryBasics.IRect is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

IRect2D

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.

IRect3D

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.

Image

No documentation found.

MakieCore.Image is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

IndexedAbsorptionRGBA

No documentation found.

Makie.IndexedAbsorptionRGBA is of type Makie.RaymarchAlgorithm .

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

Inside

AlignMode that excludes the protrusions from the bounding box.

IntervalSlider

IntervalSlider has the following attributes:

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

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

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

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

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

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

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

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

linewidth
Default: 15
The width of the slider line

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

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

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

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

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

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

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

IntervalsBetween

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

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

IsoValue

No documentation found.

Makie.IsoValue is of type Makie.RaymarchAlgorithm .

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

Keyboard

Backend independent enums which represent keyboard buttons.

KeysEvent

No documentation found.

Summary

struct Makie.MakieLayout.KeysEvent <: Any

Fields

keys :: Set{Makie.Keyboard.Button}

LScene

LScene has the following attributes:

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

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

height
Default: nothing
The height setting of the scene.

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

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

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

width
Default: nothing
The width setting of the scene.

Label

Label has the following attributes:

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

color
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the text.

font
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the text.

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

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

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

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

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

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

text
Default: "Text"
The displayed text string.

textsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the text.

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

visible
Default: true
Controls if the text is visible.

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

LayoutObservables

mutable struct LayoutObservables{T, G}

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

A collection of Observable s 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, T}} : 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.

Left

No documentation found.

Summary

struct GridLayoutBase.Left <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Left <: GridLayoutBase.Side <: Any

Legend

Legend has the following attributes:

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

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

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

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

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

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

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

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

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

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

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

label
Default: "undefined"
The default entry label.

labelcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the entry labels.

labelfont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the entry labels.

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

labelsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the entry labels.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

rowgap
Default: 3
The gap between the entry rows.

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

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

titlecolor
Default: lift_parent_attribute(scene, :textcolor, :black)
The color of the legend titles

titlefont
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
The font family of the legend group titles.

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

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

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

titlesize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
The font size of the legend group titles.

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

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

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

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

LegendElement

No documentation found.

Summary

abstract type Makie.MakieLayout.LegendElement <: Any

Subtypes

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

LegendEntry

No documentation found.

Summary

struct Makie.MakieLayout.LegendEntry <: Any

Fields

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

LineElement

No documentation found.

Summary

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

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

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

LineSegments

No documentation found.

MakieCore.LineSegments is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

LinearTicks

LinearTicks with ideally a number of n_ideal tick marks.

Lines

No documentation found.

MakieCore.Lines is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

LogTicks

LogTicks{T}(linear_ticks::T)

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

Makie

No documentation found.

No docstring found for module Makie .

MakieLayout

No documentation found.

No docstring found for module Makie.MakieLayout .

MarkerElement

No documentation found.

Summary

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

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

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

MaximumIntensityProjection

No documentation found.

Makie.MaximumIntensityProjection is of type Makie.RaymarchAlgorithm .

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

Menu

Menu(parent::Scene; bbox = nothing, kwargs...)

Create 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) .

If the menu is located close to the lower scene border, you can change its open direction to direction = :up .

Example

Menu with string entries:

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

Menu with two-element entries, label and function:

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

menu2 = Menu(scene, options = zip(labels, funcs))

Lifting on the selection value:

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

Menu has the following attributes:

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

cell_color_active
Default: COLOR_ACCENT[]
Cell color when active

cell_color_hover
Default: COLOR_ACCENT_DIMMED[]
Cell color when hovered

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

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

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

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

dropdown_arrow_size
Default: 12px
Size of the dropdown arrow

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

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

i_selected
Default: 0
Index of selected item

is_open
Default: false
Is the menu showing the available options

options
Default: ["no 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.

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

selection
Default: nothing
Selected item value

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

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

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

textcolor
Default: :black
Color of entry texts

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

textsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
Font size of the cell texts

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

width
Default: nothing
The width setting of the menu.

Mesh

No documentation found.

MakieCore.Mesh is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

MeshScatter

No documentation found.

MakieCore.MeshScatter is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Mixed

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 .

Mouse

Backend independent enums and fields which represent mouse actions.

MouseEvent

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

MouseEventTypes

No documentation found.

No docstring found for module Makie.MakieLayout.MouseEventTypes .

MultiplesTicks

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, "π")

NoConversion

No documentation found.

Summary

struct MakieCore.NoConversion <: MakieCore.ConversionTrait

Supertype Hierarchy

MakieCore.NoConversion <: MakieCore.ConversionTrait <: Any

Node

No documentation found.

Makie.Node is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Observable

obs = Observable(val)
obs = Observable{T}(val)

Like a Ref , but updates can be watched by adding a handler using on or map .

OldAxis

No documentation found.

Summary

struct Makie.OldAxis <: Any

Outside

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

Pattern

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 .

Pie

No documentation found.

Makie.Pie is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Pixel

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.

PixelSpace

No documentation found.

Makie.PixelSpace is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

PlotSpec

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.

Point

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

Point2

No documentation found.

GeometryBasics.Point2 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Point2f

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

Point2f0

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

Point3

No documentation found.

GeometryBasics.Point3 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Point3f

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

Point3f0

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

Point4

No documentation found.

GeometryBasics.Point4 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Point4f

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

Point4f0

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

PointBased

No documentation found.

Summary

struct MakieCore.PointBased <: MakieCore.ConversionTrait

Supertype Hierarchy

MakieCore.PointBased <: MakieCore.ConversionTrait <: Any

Poly

No documentation found.

Makie.Poly is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

PolyElement

No documentation found.

Summary

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

Fields

attributes :: MakieCore.Attributes

Supertype Hierarchy

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

QQNorm

No documentation found.

Makie.QQNorm is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

QQPlot

No documentation found.

Makie.QQPlot is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Quaternion

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

Quaternionf

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

RGBAf

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

RGBf

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).

Rangebars

No documentation found.

Makie.Rangebars is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

RaymarchAlgorithm

No documentation found.

Summary

primitive type Makie.RaymarchAlgorithm <: Enum{Int32}

Supertype Hierarchy

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

RealVector

No documentation found.

Makie.RealVector is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

RecordEvents

No documentation found.

Summary

struct Makie.RecordEvents <: Any

Fields

scene :: Makie.Scene
path  :: String

Rect

Rect(vals::Number...)

Rect(vals::Number...)

Rect constructor for indidually specified intervals. e.g. Rect(0,0,1,2) has origin == Vec(0,0) and width == Vec(1,2)

Construct a HyperRectangle enclosing all points.

Rect2

No documentation found.

GeometryBasics.Rect2 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Rect2D

No documentation found.

GeometryBasics.Rect2D is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Rect2f

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.

Rect2i

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.

Rect3

No documentation found.

GeometryBasics.Rect3 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Rect3D

No documentation found.

GeometryBasics.Rect3D is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Rect3f

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.

Rect3i

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.

Rectf

No documentation found.

GeometryBasics.Rectf is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Recti

No documentation found.

GeometryBasics.Recti is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Relative

No documentation found.

Summary

struct GridLayoutBase.Relative <: GridLayoutBase.GapSize

Fields

x :: Float64

Supertype Hierarchy

GridLayoutBase.Relative <: GridLayoutBase.GapSize <: GridLayoutBase.ContentSize <: Any

Reverse

Reverses the attribute T upon conversion

Right

No documentation found.

Summary

struct GridLayoutBase.Right <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Right <: GridLayoutBase.Side <: Any

Scatter

No documentation found.

MakieCore.Scatter is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

ScatterLines

No documentation found.

Makie.ScatterLines is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Scene

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.
data_limits

The limits of the data plotted in this scene. Can't be set by user and is only used to store calculated data bounds.

transformation

The Transformation of the Scene.
plots

The plots contained in the Scene.
theme
attributes
children

Children of the Scene inherit its transformation.
current_screens

The Screens which the Scene is displayed to.

updated

Signal to indicate whether layouting should happen. If updated to true, the Scene will be layouted according to its attributes ( raw , center , or scale_plot ).

SceneLike

No documentation found.

MakieCore.SceneLike is of type Union .

Summary

struct Union <: Type{T}

Fields

a :: Any
b :: Any

Supertype Hierarchy

Union <: Type{T} <: Any

SceneSpace

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

ScrollEvent

No documentation found.

Summary

struct Makie.MakieLayout.ScrollEvent <: Any

Fields

x :: Float32
y :: Float32

Series

No documentation found.

Makie.Series is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Slider

Slider has the following attributes:

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

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

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

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

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

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

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

linewidth
Default: 15
The width of the slider line

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

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

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

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

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

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

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

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

Sphere

Sphere{T}

An alias for a HyperSphere of dimension 3. (i.e. HyperSphere{3, T} )

Spy

No documentation found.

Makie.Spy is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Stairs

No documentation found.

Makie.Stairs is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Stem

No documentation found.

Makie.Stem is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Stepper

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:144
[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:146
[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:143

StreamPlot

No documentation found.

Makie.StreamPlot is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Surface

No documentation found.

MakieCore.Surface is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

SurfaceLike

No documentation found.

Summary

abstract type MakieCore.SurfaceLike <: MakieCore.ConversionTrait

Subtypes

MakieCore.ContinuousSurface
MakieCore.DiscreteSurface

Supertype Hierarchy

MakieCore.SurfaceLike <: MakieCore.ConversionTrait <: Any

Text

No documentation found.

MakieCore.Text is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Textbox

Textbox(parent::Scene; bbox = nothing, kwargs...)

Textbox has the following attributes: alignmode
Default: Inside()
The alignment of the textbox in its suggested bounding box.

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

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

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

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

borderwidth
Default: 2.0
Width of the box border.

boxcolor
Default: :transparent
Color of the box.

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

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

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

cornerradius
Default: 8
Corner radius of text box.

cornersegments
Default: 20
Corner segments of one rounded corner.

cursorcolor
Default: :transparent
The color of the cursor.

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

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

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

font
Default: lift_parent_attribute(scene, :font, "DejaVu Sans")
Font family.

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

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

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

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

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

stored_string
Default: nothing
The currently stored string.

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

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

textcolor
Default: lift_parent_attribute(scene, :textcolor, :black)
Text color.

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

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

textsize
Default: lift_parent_attribute(scene, :fontsize, 16.0f0)
Text size.

validator
Default: str->begin #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/defaultattributes.jl:969 =# true end
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) .

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

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

Theme

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

TimeSeries

No documentation found.

Makie.TimeSeries is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Toggle

Toggle has the following attributes:

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

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

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

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

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

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

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

height
Default: 28
The height of the toggle.

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

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

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

toggleduration
Default: 0.15
The duration of the toggle animation.

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

width
Default: 60
The width of the toggle.

Top

No documentation found.

Summary

struct GridLayoutBase.Top <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.Top <: GridLayoutBase.Side <: Any

TopLeft

No documentation found.

Summary

struct GridLayoutBase.TopLeft <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.TopLeft <: GridLayoutBase.Side <: Any

TopRight

No documentation found.

Summary

struct GridLayoutBase.TopRight <: GridLayoutBase.Side

Supertype Hierarchy

GridLayoutBase.TopRight <: GridLayoutBase.Side <: Any

Transformation

Holds the transformations for Scenes.

Fields

parent::Base.RefValue{MakieCore.Transformable}
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}}
flip::Observables.Observable{Tuple{Bool, Bool, Bool}}
align::Observables.Observable{GeometryBasics.Vec{2, Float32}}
transform_func::Observables.Observable{Any}

Unit

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

Vec

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

Vec2

No documentation found.

GeometryBasics.Vec2 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Vec2f

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

Vec2f0

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

Vec3

No documentation found.

GeometryBasics.Vec3 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Vec3f

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

Vec3f0

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

Vec4

No documentation found.

GeometryBasics.Vec4 is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Vec4f

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

Vec4f0

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

VecTypes

No documentation found.

GeometryBasics.VecTypes is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

VideoStream

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.

Violin

No documentation found.

Makie.Violin is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

Volume

No documentation found.

MakieCore.Volume is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

VolumeLike

No documentation found.

Summary

struct MakieCore.VolumeLike <: Any

VolumeSlices

No documentation found.

Makie.VolumeSlices is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

WilkinsonTicks

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

Wireframe

No documentation found.

Makie.Wireframe is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

_Inspector

No documentation found.

Makie._Inspector is of type UnionAll .

Summary

struct UnionAll <: Type{T}

Fields

var  :: TypeVar
body :: Any

Supertype Hierarchy

UnionAll <: Type{T} <: Any

_inspector

No documentation found.

Makie._inspector is a Function .

# 2 methods for generic function "_inspector":
[1] _inspector() in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:170
[2] _inspector(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:30

_inspector!

No documentation found.

Makie._inspector! is a Function .

# 1 method for generic function "_inspector!":
[1] _inspector!(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:34

abline!

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!

activate_interaction!(parent, name::Symbol)

Activate the interaction named name registered in parent .

addmouseevents!

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

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:

  _glyphlayout    "nothing"
  align           (:left, :bottom)
  ambient         Float32[0.55, 0.55, 0.55]
  color           :black
  diffuse         Float32[0.4, 0.4, 0.4]
  font            "Dejavu Sans"
  inspectable     true
  justification   MakieCore.Automatic()
  lightposition   :eyeposition
  lineheight      1.0
  linewidth       1
  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           :screen
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  strokecolor     (:black, 0.0)
  strokewidth     0
  textsize        20
  transparency    false
  visible         true

annotations!

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

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:

  ambient         Float32[0.55, 0.55, 0.55]
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lightposition   :eyeposition
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  resolution      361
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

arc!

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

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
  ambient         Float32[0.55, 0.55, 0.55]
  arrowcolor      MakieCore.Automatic()
  arrowhead       MakieCore.Automatic()
  arrowsize       MakieCore.Automatic()
  arrowtail       MakieCore.Automatic()
  color           :black
  colormap        :viridis
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lengthscale     1.0f0
  lightposition   :eyeposition
  linecolor       MakieCore.Automatic()
  linestyle       "nothing"
  linewidth       MakieCore.Automatic()
  markerspace     MakieCore.Pixel
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  normalize       false
  overdraw        false
  quality         32
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

arrows!

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:

assetpath

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:248

attributes

No documentation found.

MakieCore.attributes is a Function .

# 1 method for generic function "attributes":
[1] attributes(x::MakieCore.Attributes) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/attributes.jl:33

autolimits!

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

available_gradients()

Prints all available gradient names.

axis3d

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: ("Dejavu Sans", "Dejavu Sans", "Dejavu Sans")
        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: ("Dejavu Sans", "Dejavu Sans", "Dejavu Sans")
        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!

axis3d!(args; attributes...)

Plots a 3-dimensional OldAxis.

Attributes

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

axislegend

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.

band

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:

  ambient         Float32[0.55, 0.55, 0.55]
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color => :patchcolor]
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  interpolate     false
  lightposition   :eyeposition
  linewidth       1
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shading         true
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

band!

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

barplot(x, y; kwargs...)

Plots a barplot; y defines the height. x and y should be 1 dimensional.

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
  inspectable            true
  label_color            :black
  label_font             "Dejavu Sans"
  label_formatter        Makie.bar_label_formatter
  label_offset           5
  label_size             20
  marker                 GeometryBasics.HyperRectangle
  n_dodge                MakieCore.Automatic()
  offset                 0.0
  stack                  MakieCore.Automatic()
  strokecolor            :black
  strokewidth            0
  visible                true
  width                  MakieCore.Automatic()
  x_gap                  0.2

barplot!

barplot(x, y; kwargs...)

Plots a barplot; y defines the height. x and y should be 1 dimensional.

Attributes

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

bottom

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

boundingbox

No documentation found.

Makie.boundingbox is a Function .

# 7 methods for generic function "boundingbox":
[1] boundingbox(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:43
[2] 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:99
[3] boundingbox(layouts::AbstractArray{var"#s739", N} where {var"#s739"<:Makie.GlyphCollection, N}, positions, rotations) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:125
[4] boundingbox(x::MakieCore.Text{var"#s739"} where var"#s739"<:(Tuple{var"#s738"} where var"#s738"<:Makie.GlyphCollection)) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:143
[5] boundingbox(x::MakieCore.Text{var"#s739"} where var"#s739"<:(Tuple{var"#s738"} where var"#s738"<:(AbstractArray{var"#s737", N} where {var"#s737"<:Makie.GlyphCollection, N}))) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:151
[6] boundingbox(x::Union{MakieCore.Text{Arg}, MakieCore.MeshScatter{Arg}, MakieCore.Scatter{Arg}, MakieCore.Mesh{Arg}, MakieCore.LineSegments{Arg}, MakieCore.Lines{Arg}, MakieCore.Surface{Arg}, MakieCore.Volume{Arg}, MakieCore.Heatmap{Arg}, MakieCore.Image{Arg}} where Arg) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:38
[7] boundingbox(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:18

boxplot

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

orientation=:vertical : orientation of box ( :vertical or :horizontal )
width=0.8 : width of the box
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

boxplot!

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

orientation=:vertical : orientation of box ( :vertical or :horizontal )
width=0.8 : width of the box
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

broadcast_foreach

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 .

cam2d

Creates a subscene with a pixel camera

cam2d!

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

Creates a 2D camera for the given Scene.

cam3d!

No documentation found.

Makie.cam3d! is a Function .

# 1 method for generic function "cam3d!":
[1] cam3d!(scene; zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:223

cam3d_cad!

No documentation found.

Makie.cam3d_cad! is a Function .

# 1 method for generic function "cam3d_cad!":
[1] cam3d_cad!(scene; cad, zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:226

camera

No documentation found.

Makie.camera is a Function .

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

cameracontrols

No documentation found.

Makie.cameracontrols is a Function .

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

cameracontrols!

No documentation found.

Makie.cameracontrols! is a Function .

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

campixel

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:322

campixel!

campixel!(scene)

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

center!

No documentation found.

Makie.center! is a Function .

# 2 methods for generic function "center!":
[1] center!(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:484
[2] center!(scene::Makie.Scene, padding) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:484

cgrad

cgrad(colors, [values]; categorical = nothing, scale = nothing, rev = false, alpha = nothing)

Construct a Colorgradient with from colors and values .

colors can be a symbol for Colorschemes.jl ColorScheme s, a ColorScheme , a vectors of colors, a ColorGradient or a ColorPalettes . 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.

colgap!

No documentation found.

GridLayoutBase.colgap! is a Function .

# 4 methods for generic function "colgap!":
[1] colgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::GridLayoutBase.GapSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:572
[2] colgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:580
[3] colgap!(gl::GridLayoutBase.GridLayout, s::GridLayoutBase.GapSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:582
[4] colgap!(gl::GridLayoutBase.GridLayout, r::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:587

colsize!

No documentation found.

GridLayoutBase.colsize! is a Function .

# 2 methods for generic function "colsize!":
[1] colsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::GridLayoutBase.ContentSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:552
[2] colsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:560

connect!

connect!(o1::AbstractObservable, o2::AbstractObservable)

Forwards all updates from o2 to o1 .

Attributes

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

  alpha           1.0
  ambient         Float32[0.55, 0.55, 0.55]
  color           "nothing"
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  diffuse         Float32[0.4, 0.4, 0.4]
  fillrange       false
  inspectable     true
  levels          5
  lightposition   :eyeposition
  linewidth       1.0
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

contour!

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

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
  ambient         Float32[0.55, 0.55, 0.55]
  color           "nothing"
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  diffuse         Float32[0.4, 0.4, 0.4]
  fillrange       false
  inspectable     true
  levels          5
  lightposition   :eyeposition
  linewidth       1.0
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

contour3d!

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

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)

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

contourf!

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)

Attributes

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

convert_arguments

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 Rect x 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 AbstractVector x , y , and z and the AbstractMatrix i , 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 AbstractVector x , 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.

convert_attribute

`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`

Text align, e.g.:

font conversion

a string naming a font, e.g. helvetica

rotation accepts:
to_rotation(b, quaternion)
to_rotation(b, tuple_float)
to_rotation(b, vec4)

to_colormap(b, x)

An AbstractVector{T} with any object that to_color accepts.

Tuple(A, B) or Pair{A, B} with any object that to_color accepts

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.

to_volume_algorithm(b, x)

Enum values: IsoValue Absorption MaximumIntensityProjection AbsorptionRGBA AdditiveRGBA IndexedAbsorptionRGBA

Symbol/String: iso, absorption, mip, absorptionrgba, indexedabsorption

crossbar

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=0.8 : width of the box
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!

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=0.8 : width of the box
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

current_axis

Returns the current active axis (or the last axis that got created)

current_axis!

Set ax as the current active axis in fig

current_figure

Returns the current active figure (or the last figure that got created)

current_figure!

Set fig as the current active scene

deactivate_interaction!

deactivate_interaction!(parent, name::Symbol)

Deactivate the interaction named name registered in parent . It can be reactivated with activate_interaction! .

decompose

decompose(facetype, contour::AbstractArray{AbstractPoint})

Triangulate a Polygon without hole.

Returns a Vector{ facetype } defining indexes into contour .

default_theme

No documentation found.

MakieCore.default_theme is a Function .

# 43 methods for generic function "default_theme":
[1] default_theme(scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:3
[2] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.violin, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[3] default_theme(scene, ::Type{var"#s27"} where var"#s27"<:(MakieCore.Image{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[4] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Heatmap{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[5] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Volume{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[6] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Surface{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[7] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Lines{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[8] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.LineSegments{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[9] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Mesh{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[10] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Scatter{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[11] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.MeshScatter{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[12] default_theme(scene, ::Type{var"#s14"} where var"#s14"<:(MakieCore.Text{ArgType} where ArgType)) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[13] default_theme(scene, ::Type{var"#s1316"} where var"#s1316"<:(MakieCore.Combined{Makie.series, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[14] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie._inspector, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[15] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.boxplot, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[16] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.crossbar, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[17] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.qqplot, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[18] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.qqnorm, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[19] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.density, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[20] default_theme(scene, ::Type{var"#s736"} where var"#s736"<:(MakieCore.Combined{Makie.hist, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[21] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.wireframe, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[22] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.volumeslices, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[23] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.timeseries, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[24] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.streamplot, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[25] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.stem, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[26] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.stairs, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[27] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.spy, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[28] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.scatterlines, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[29] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.poly, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[30] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.pie, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[31] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.rangebars, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[32] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.errorbars, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[33] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.contourf, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[34] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.contour3d, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[35] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.contour, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[36] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.barplot, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[37] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.band, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[38] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.axis3d, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[39] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.annotations, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[40] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.arc, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[41] default_theme(scene, ::Type{var"#s265"} where var"#s265"<:(MakieCore.Combined{Makie.arrows, ArgType} where ArgType)) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[42] default_theme(scene, ::Type{var"#s45"} where var"#s45"<:(MakieCore.Combined{Main.FD_SANDBOX_3118400072356428703.stockchart, ArgType} where ArgType)) in Main.FD_SANDBOX_3118400072356428703 at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:174
[43] default_theme(scene, T) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:60

density

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.

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

density!

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.

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!

deregister_interaction!(parent, name::Symbol)

Deregister the interaction named name registered in parent .

disconnect!

No documentation found.

Makie.disconnect! is a Function .

# 13 methods for generic function "disconnect!":
[1] disconnect!(c::Makie.Camera) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:13
[2] disconnect!(nodes::Vector{T} where T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:21
[3] disconnect!(window::MakieCore.AbstractScreen, signal) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:1
[4] disconnect!(window::GLFW.Window, ::typeof(Makie.entered_window)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:287
[5] disconnect!(window::GLFW.Window, ::typeof(Makie.hasfocus)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:265
[6] disconnect!(window::GLFW.Window, ::typeof(Makie.scroll)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:242
[7] disconnect!(window::GLFW.Window, ::typeof(Makie.mouse_position)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:220
[8] disconnect!(window::GLFW.Window, ::typeof(Makie.unicode_input)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:154
[9] disconnect!(window::GLFW.Window, ::typeof(Makie.dropped_files)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:131
[10] disconnect!(window::GLFW.Window, ::typeof(Makie.keyboard_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:110
[11] disconnect!(window::GLFW.Window, ::typeof(Makie.mouse_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:95
[12] disconnect!(window::GLFW.Window, ::typeof(Makie.window_area)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:73
[13] disconnect!(window::GLFW.Window, ::typeof(Makie.window_open)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:34

dropped_files

Registers a callback for drag and drop of files. returns Node{Vector{String}} , which are absolute file paths GLFW Docs

entered_window

Registers a callback for if the mouse has entered the window. returns an Node{Bool} , which is true whenever the cursor enters the window. GLFW Docs

errorbars

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
  direction     :y
  inspectable   true
  linewidth     1.5
  visible       true
  whiskerwidth  0

errorbars!

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:

events

No documentation found.

Makie.events is a Function .

# 4 methods for generic function "events":
[1] events(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:401
[2] events(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:402
[3] events(fig::Makie.Figure) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figures.jl:132
[4] events(fap::Makie.FigureAxisPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figures.jl:133

fill_between!

fill_between!(x, y1, y2; where = nothing, scene = current_scene(), kw_args...)

fill the section between 2 lines with the condition where

force_update!

Forces the scene to be re-rendered

grid!

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.

gridnest!

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/nYdeK/src/gridlayout.jl:478

hasfocus

Registers a callback for the focus of a window. returns an Node{Bool} , which is true whenever the window has focus. GLFW Docs

heatmap

heatmap(x, y, values)
heatmap(values)

Plots a heatmap as an image on x, y (defaults to interpretation as dimensions).

heatmap!

heatmap(x, y, values)
heatmap(values)

Plots a heatmap as an image on x, y (defaults to interpretation as dimensions).

height

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/nYdeK/src/geometry_integration.jl:7

help

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

help_arguments([io], func)

Returns a list of signatures for function func .

help_attributes

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

hgrid!

hbox!(content::Vararg; kwargs...)

Creates a single-row GridLayout with all elements contained in content placed from left to right.

hidedecorations!

hidedecorations!(la::Axis)

Hide decorations of both x and y-axis: label, ticklabels, ticks and grid.

hidespines!

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!

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!

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

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.

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             "Dejavu Sans"
  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"

hist!

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.

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!

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

hovered_scene()

Returns the scene that the mouse is currently hovering over.

Properly identifies the scene for a plot with multiple sub-plots.

hspan!

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

image(x, y, image)
image(image)

Plots an image on range x, y (defaults to dimensions).

image!

image(x, y, image)
image(image)

Plots an image on range x, y (defaults to dimensions).

insertplots!

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:476

interactions

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

ispressed

ispressed(scene, buttons)

Returns true if all buttons are pressed in the given scene . buttons can be a Vector or Tuple of Keyboard buttons (e.g. Keyboard.a ), Mouse buttons (e.g. Mouse.left ) and nothing .

ispressed(scene, button)

Returns true if button is pressed in the given scene . The button can be a Keyboard button (e.g. Keyboard.a ), a Mouse button (e.g. Mouse.left ) or nothing . In the latter case true is always returned.

keyboard_buttons

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!

labelslider!(scene, label, range; format = string, sliderkw = Dict(),
labelkw = Dict(), valuekw = Dict(), value_column_width = automatic, layoutkw...)

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!

labelslidergrid!(scene, labels, ranges; formats = [string],
    sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(),
    value_column_width = automatic, layoutkw...)

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

layoutscene

layoutscene(padding = 30; kwargs...)

Create a Scene in campixel! mode and a GridLayout aligned to the scene's pixel area with alignmode = Outside(padding) .

layoutscene(nrows::Int, ncols::Int, padding = 30; kwargs...)

Create a Scene in campixel! mode and a GridLayout aligned to the scene's pixel area with size nrows x ncols and alignmode = Outside(padding) .

left

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

lift

lift(f, o1::Observables.AbstractObservable, rest...)

Create a new Observable by applying f to all observables in o1 and rest... . The initial value is determined by the first function evaluation.

limits!

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

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 NaN s.

lines!

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 NaN s.

linesegments

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!

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!

linkaxes!(a::Axis, others...)

Link both x and y axes of all given Axis so that they stay synchronized.

linkxaxes!

linkxaxes!(a::Axis, others...)

Link the x axes of all given Axis so that they stay synchronized.

linkyaxes!

linkyaxes!(a::Axis, others...)

Link the y axes of all given Axis so that they stay synchronized.

map_once

map_once(closure, inputs::Node....)::Node

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 Node and register a new one instead.

``` function test(s1::Node) s3 = map once(x-> (println("1 ", x); x), s1) s3 = map once(x-> (println("2 ", x); x), s1)

end test(Node(1), Node(2))

mesh

mesh(x, y, z)
mesh(mesh_object)
mesh(x, y, z, faces)
mesh(xyz, faces)

Plots a 3D or 2D mesh. Supported mesh_object s include Mesh types from GeometryBasics.jl .

mesh!

mesh(x, y, z)
mesh(mesh_object)
mesh(x, y, z, faces)
mesh(xyz, faces)

Plots a 3D or 2D mesh. Supported mesh_object s include Mesh types from GeometryBasics.jl .

meshscatter

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!

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 .

mouse_buttons

Registers a callback for the mouse buttons + modifiers returns Node{NTuple{4, Int}} GLFW Docs

mouse_position

Registers a callback for the mouse cursor position. returns an Node{Vec{2, Float64}} , which is not in scene coordinates, with the upper left window corner being 0 GLFW Docs

mouse_selection

mouse_selection(scene::Scene)

Returns the plot that is under the current mouse position

mouseover

mouseover(scene::SceneLike, plots::AbstractPlot...)

Returns true if the mouse currently hovers any of plots .

mouseposition

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.

must_update

Returns whether a scene needs to be updated

ncols

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/nYdeK/src/gridlayout.jl:1274

nrows

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/nYdeK/src/gridlayout.jl:1275

off

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!

old_cam3d!(scene; kwargs...)

An alias to old_cam3d_turntable! . Creates a 3D camera for scene , which rotates around the plot's axis.

old_cam3d_cad!

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

on(f, observable::AbstractObservable; weak = false)

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{Int64} 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

on(f, c::Camera, nodes::Node...)

When mapping over nodes for the camera, we store them in the steering_node vector, to make it easier to disconnect the camera steering signals later!

onany

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.

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
  vertex_per_deg  1

pie!

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:

pixelarea

No documentation found.

Makie.pixelarea is a Function .

# 2 methods for generic function "pixelarea":
[1] pixelarea(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:413
[2] pixelarea(scene::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:414

plot

No documentation found.

MakieCore.plot is a Function .

# 5 methods for generic function "plot":
[1] plot(P::Union{Type{Any}, Type{var"#s268"} where var"#s268"<:MakieCore.AbstractPlot}, gsp::GridLayoutBase.GridSubposition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:98
[2] plot(P::Union{Type{Any}, Type{var"#s268"} where var"#s268"<:MakieCore.AbstractPlot}, gp::GridLayoutBase.GridPosition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:50
[3] plot(P::Union{Type{Any}, Type{var"#s268"} where var"#s268"<:MakieCore.AbstractPlot}, args...; axis, figure, kw_attributes...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:16
[4] plot(scene::Makie.Scene, plot::MakieCore.AbstractPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:176
[5] plot(args...; attributes...) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:30

plot!

Main plotting signatures that plot/plot! route to if no Plot Type is given

plotkey

No documentation found.

MakieCore.plotkey is a Function .

# 2 methods for generic function "plotkey":
[1] plotkey(::Type{var"#s14"} where var"#s14"<:MakieCore.AbstractPlot{Typ}) where Typ in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:19
[2] plotkey(::T) where T<:MakieCore.AbstractPlot in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:20

plots

No documentation found.

Makie.plots is a Function .

# 1 method 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:416

poly

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
  strokecolor   :black
  strokewidth   0
  transparency  false
  visible       true

poly!

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:

px

No documentation found.

MakieCore.px is of type MakieCore.Pixel{Int64} .

Summary

struct MakieCore.Pixel{Int64} <: MakieCore.Unit{Int64}

Fields

value :: Int64

Supertype Hierarchy

MakieCore.Pixel{Int64} <: MakieCore.Unit{Int64} <: Number <: Any

qqnorm

No documentation found.

Makie.qqnorm is a Function .

# 2 methods for generic function "qqnorm":
[1] qqnorm() in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:170
[2] qqnorm(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:30

qqnorm!

No documentation found.

Makie.qqnorm! is a Function .

# 1 method for generic function "qqnorm!":
[1] qqnorm!(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:34

qqplot

No documentation found.

Makie.qqplot is a Function .

# 2 methods for generic function "qqplot":
[1] qqplot() in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:170
[2] qqplot(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:30

qqplot!

No documentation found.

Makie.qqplot! is a Function .

# 1 method for generic function "qqplot!":
[1] qqplot!(args...; attributes...) in Makie at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:34

qrotation

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

quiver

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
  ambient         Float32[0.55, 0.55, 0.55]
  arrowcolor      MakieCore.Automatic()
  arrowhead       MakieCore.Automatic()
  arrowsize       MakieCore.Automatic()
  arrowtail       MakieCore.Automatic()
  color           :black
  colormap        :viridis
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lengthscale     1.0f0
  lightposition   :eyeposition
  linecolor       MakieCore.Automatic()
  linestyle       "nothing"
  linewidth       MakieCore.Automatic()
  markerspace     MakieCore.Pixel
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  normalize       false
  overdraw        false
  quality         32
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

quiver!

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

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
  direction     :y
  inspectable   true
  linewidth     1.5
  visible       true
  whiskerwidth  0

rangebars!

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

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 .gif s 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

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!

recordframe!(io::VideoStream)

Adds a video frame to the VideoStream io .

register_callbacks

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!

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! .

replace_automatic!

Like get!(f, dict, key) but also calls f and replaces key when the corresponding value is nothing

replay_events

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 .

reset_limits!

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.

right

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!

rotate!(Accum, scene::Transformable, axis_rot...)

Apply a relative rotation to the Scene, by multiplying by the current rotation.

rotate!(scene::Transformable, axis_rot::Quaternion)
rotate!(scene::Transformable, axis_rot::AbstractFloat)
rotate!(scene::Transformable, axis_rot...)

Apply an absolute rotation to the Scene. Rotations are all internally converted to Quaternion s.

rotate_cam!

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 (α, β, γ).

rowgap!

No documentation found.

GridLayoutBase.rowgap! is a Function .

# 4 methods for generic function "rowgap!":
[1] rowgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::GridLayoutBase.GapSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:592
[2] rowgap!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:600
[3] rowgap!(gl::GridLayoutBase.GridLayout, s::GridLayoutBase.GapSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:602
[4] rowgap!(gl::GridLayoutBase.GridLayout, r::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:607

rowsize!

No documentation found.

GridLayoutBase.rowsize! is a Function .

# 2 methods for generic function "rowsize!":
[1] rowsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::GridLayoutBase.ContentSize) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:562
[2] rowsize!(gl::GridLayoutBase.GridLayout, i::Int64, s::Real) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/nYdeK/src/gridlayout.jl:570

save

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).
update : Update the scene and its children before saving ( update_limits! and center! ). One might want to set update=false e.g. when saving a zoomed scene.

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 .gif s 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!

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

scatter(positions)
scatter(x, y)
scatter(x, y, z)

Plots a marker for each element in (x, y, z) , (x, y) , or positions .

scatter!

scatter(positions)
scatter(x, y)
scatter(x, y, z)

Plots a marker for each element in (x, y, z) , (x, y) , or positions .

scatterlines

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()
  inspectable       true
  linestyle         "nothing"
  linewidth         1.5
  marker            GeometryBasics.Circle{T} where T
  markercolor       :black
  markercolormap    :viridis
  markercolorrange  MakieCore.Automatic()
  markersize        9
  strokecolor       :black
  strokewidth       0

scatterlines!

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:

scene_limits

No documentation found.

Makie.scene_limits is a Function .

# 1 method for generic function "scene_limits":
[1] scene_limits(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:348

scroll

Registers a callback for the mouse scroll. returns an Node{Vec{2, Float64}} , which is an x and y offset. GLFW Docs

select_line

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

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

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 observable rect 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

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!

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_close_to!

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, max.

set_theme!

set_theme(theme; kwargs...)

Set the global default theme to theme and add / override any attributes given as keyword arguments.

showgradients

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

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!

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

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:

  ambient         Float32[0.55, 0.55, 0.55]
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lightposition   :eyeposition
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  step            :pre
  transparency    false
  visible         true

stairs!

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

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!

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

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:

  ambient         Float32[0.55, 0.55, 0.55]
  arrow_head      MakieCore.Automatic()
  arrow_size      0.03
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  density         1.0
  diffuse         Float32[0.4, 0.4, 0.4]
  gridsize        (32, 32, 32)
  inspectable     true
  lightposition   :eyeposition
  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
  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!

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

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, or Matrices which define an irregular grid.

surface!

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, or Matrices which define an irregular grid.

swap!

Swaps or rotates the layout positions of the given elements to their neighbor's.

text

text(string)

Plots a text.

text!

text(string)

Plots a text.

theme

No documentation found.

MakieCore.theme is a Function .

# 6 methods for generic function "theme":
[1] theme(x::MakieCore.AbstractScene) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:54
[2] theme(x::MakieCore.AbstractScene, key) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:55
[3] theme(x::Union{MakieCore.AbstractScene, MakieCore.ScenePlot}, args...) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:53
[4] theme(x::MakieCore.AbstractPlot) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/attributes.jl:156
[5] theme(x::MakieCore.AbstractPlot, key) in MakieCore at /home/runner/.julia/packages/MakieCore/S8PkO/src/recipes.jl:56
[6] theme(::Nothing, key::Symbol) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/theming.jl:150

theme_black

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

theme_dark

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

theme_ggplot2

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

theme_light

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

theme_minimal

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

tight_ticklabel_spacing!

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:406
[2] tight_ticklabel_spacing!(la::Makie.MakieLayout.Axis) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/layoutables/axis.jl:1135
[3] tight_ticklabel_spacing!(lc::Makie.MakieLayout.Colorbar) in Makie.MakieLayout at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/layoutables/colorbar.jl:378

tight_xticklabel_spacing!

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/layoutables/axis.jl:1131

tight_yticklabel_spacing!

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/layoutables/axis.jl:1127

tightlimits!

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

timeseries(x::Node{{Union{Number, Point2}}})

Plots a sampled signal. Usage:

signal = Node(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!

timeseries(x::Node{{Union{Number, Point2}}})

Plots a sampled signal. Usage:

signal = Node(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

to_align

No documentation found.

Makie.to_align is a Function .

# 1 method for generic function "to_align":
[1] to_align(align) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:710

to_color

to_color(color)

Converts a color symbol (e.g. :blue ) to a color RGBA.

to_colormap

to_colormap(cm[, N = 20])

Converts a colormap cm symbol (e.g. :Spectral ) to a colormap RGB array, where N specifies the number of color points.

to_font

No documentation found.

Makie.to_font is a Function .

# 1 method for generic function "to_font":
[1] to_font(font) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:709

to_ndim

No documentation found.

Makie.to_ndim is a Function .

# 1 method for generic function "to_ndim":
[1] to_ndim(T::Type{var"#s12"} where var"#s12"<: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:203

to_rotation

No documentation found.

Makie.to_rotation is a Function .

# 1 method for generic function "to_rotation":
[1] to_rotation(rotation) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:708

to_textsize

No documentation found.

Makie.to_textsize is a Function .

# 1 method for generic function "to_textsize":
[1] to_textsize(textsize) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:711

to_value

to_value(x::Union{Any, AbstractObservable})

Extracts the value of an observable, and returns the object if it's not an observable!

to_vector

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:232
[2] to_vector(x::AbstractArray, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:233
[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:240

to_world

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:278
[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:308
[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:292

top

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!

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!

translate_cam!(scene::Scene, translation::VecTypes)

Translate the camera by a translation vector given in camera space.

translated

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:72
[2] translated(scene::Makie.Scene, translation...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:66

translation

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:143

trim!

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/nYdeK/src/gridlayout.jl:458

unicode_input

Registers a callback for keyboard unicode input. returns an Node{Vector{Char}} , containing the pressed char. Is empty, if no key is pressed. GLFW Docs

update!

`update!(p::Scene)`

Updates a Scene and all its children. Update will perform the following operations for every scene:

if !scene.raw[]
    scene.update_limits[] && update_limits!(scene)
    scene.center[] && center!(scene)
end

update_cam!

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 Node pipeline.

update_cam!(scene::Scene, eyeposition, lookat, up = Vec3f(0, 0, 1))

Updates the camera's controls to point to the specified location.

update_limits!

update_limits!(scene::Scene, limits::Union{Automatic, Rect} = scene.limits[], padding = scene.padding[])

This function updates the limits of the Scene passed to it based on its data. If an actual limit is set by the theme or its attributes (scene.limits !== automatic), it will not update the limits. Call update_limits!(scene, automatic) for that.

update_limits!(scene::Scene, new_limits::Rect, padding = Vec3f(0))

This function updates the limits of the given Scene according to the given Rect.

A Rect is a generalization of a rectangle to n dimensions. It contains two vectors. The first vector defines the origin; the second defines the displacement of the vertices from the origin. This second vector can be thought of in two dimensions as a vector of width (x-axis) and height (y-axis), and in three dimensions as a vector of the width (x-axis), breadth (y-axis), and height (z-axis).

Such a Rect can be constructed using the Rectf or Rect3f functions that are exported by Makie.jl . See their documentation for more information.

update_theme!

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

used_attributes(args...) = ()

function used to indicate what keyword args one wants to get passed in convert_arguments . 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

vgrid!

vbox!(content::Vararg; kwargs...)

Creates a single-column GridLayout with all elements contained in content placed from top to bottom.

violin

violin(x, y; kwargs...)

Draw a violin plot.

Arguments

x : positions of the categories
y : variables whose density is computed

Keywords

orientation=:vertical : orientation of the violins ( :vertical or :horizontal )
width=0.8 : width of the violin
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!

violin(x, y; kwargs...)

Draw a violin plot.

Arguments

x : positions of the categories
y : variables whose density is computed

Keywords

orientation=:vertical : orientation of the violins ( :vertical or :horizontal )
width=0.8 : width of the violin
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!

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(volume_data)

Plots a volume. Available algorithms are:

:iso => IsoValue
:absorption => Absorption
:mip => MaximumIntensityProjection
:absorptionrgba => AbsorptionRGBA
:additive => AdditiveRGBA
:indexedabsorption => IndexedAbsorptionRGBA

volume!

volume(volume_data)

Plots a volume. Available algorithms are:

:iso => IsoValue
:absorption => Absorption
:mip => MaximumIntensityProjection
:absorptionrgba => AbsorptionRGBA
:additive => AdditiveRGBA
:indexedabsorption => IndexedAbsorptionRGBA

volumeslices

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:

  colorrange  MakieCore.Automatic()
  heatmap     Attributes with 0 entries

volumeslices!

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!

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.

width

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/nYdeK/src/geometry_integration.jl:6

widths

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/WMp6v/src/primitives/rectangles.jl:162
[2] widths(c::GeometryBasics.HyperSphere{N, T}) where {N, T} in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/WMp6v/src/primitives/spheres.jl:28
[3] widths(x::AbstractRange) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/WMp6v/src/geometry_primitives.jl:4
[4] widths(scene::Makie.Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:306
[5] widths(x::GLMakie.Screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/screen.jl:42

window_area

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

window_open

Returns a signal, which is true as long as the window is open. returns Node{Bool} GLFW Docs

wireframe

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:

  ambient         Float32[0.55, 0.55, 0.55]
  color           :black
  colormap        :viridis
  colorrange      MakieCore.Automatic()
  cycle           [:color]
  diffuse         Float32[0.4, 0.4, 0.4]
  inspectable     true
  lightposition   :eyeposition
  linestyle       "nothing"
  linewidth       1.5
  nan_color       RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
  overdraw        false
  shininess       32.0f0
  specular        Float32[0.2, 0.2, 0.2]
  ssao            false
  transparency    false
  visible         true

wireframe!

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

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

with_updates_suspended

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/nYdeK/src/gridlayout.jl:121

xlabel!

xlabel!([scene,] xlabel)

Set the x-axis label for the given Scene. Defaults to using the current Scene.

xlims!

xlims!(limits::Real...)
xlims!(limits::NTuple{2, Real})
xlims!(scene, limits::Real...)
xlims!(scene, limits::NTuple{2, Real})

Set the x-limits for the given Scene (defaults to current Scene).

xticklabels

xticklabels(scene)

Returns the all the x-axis tick labels. See also ticklabels .

xtickrange

xtickrange(scene)

Returns the tick range along the x-axis. See also tickranges .

xtickrotation

xtickrotation(scene)

Returns the rotation of tick labels along the x-axis. See also tickrotations

xtickrotation!

xtickrotation!([scene,] xangle)

Set the rotation of tick labels along the x-axis. See also tickrotations! .

xticks!

xticks!([scene,]; xtickrange=xtickrange(scene), xticklabels=xticklabel(scene))

Set the tick labels and range along the x-axes. See also ticks! .

ylabel!

ylabel!([scene,] ylabel)

Set the y-axis label for the given Scene. Defaults to using the current Scene.

ylims!

ylims!(limits::Real...)
ylims!(limits::NTuple{2, Real})
ylims!(scene, limits::Real...)
ylims!(scene, limits::NTuple{2, Real})

Set the y-limits for the given Scene (defaults to current Scene).

yticklabels

yticklabels(scene)

Returns the all the y-axis tick labels. See also ticklabels .

ytickrange

ytickrange(scene)

Returns the tick range along the y-axis. See also tickranges .

ytickrotation

ytickrotation(scene)

Returns the rotation of tick labels along the y-axis. See also tickrotations

ytickrotation!

ytickrotation!([scene,] yangle)

Set the rotation of tick labels along the y-axis. See also tickrotations! .

yticks!

yticks!([scene,]; ytickrange=ytickrange(scene), yticklabels=yticklabel(scene))

Set the tick labels and range along all the y-axis. See also ticks! .

zlabel!

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.

zlims!

zlims!(limits::Real...)
zlims!(limits::NTuple{2, Real})
zlims!(scene, limits::Real...)
zlims!(scene, limits::NTuple{2, Real})

Set the z-limits for the given Scene (defaults to current Scene).

zoom!

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

zticklabels(scene)

Returns the all the z-axis tick labels. See also ticklabels .

ztickrange

ztickrange(scene)

Returns the tick range along the z-axis. See also tickranges .

ztickrotation

ztickrotation(scene)

Returns the rotation of tick labels along the z-axis. See also tickrotations

ztickrotation!

ztickrotation!([scene,] zangle)

Set the rotation of tick labels along the z-axis. See also tickrotations! .

zticks!

zticks!([scene,]; ztickranges=ztickrange(scene), zticklabels=zticklabel(scene))

Set the tick labels and range along all z-axis. See also ticks! .

Navigation

API reference

Examples

Example:

before

after

Plot Recipes in Makie

Type recipes

Full recipes with the @recipe macro

Summary

Supertype Hierarchy

Summary

Supertype Hierarchy

Summary

Subtypes

Summary

Fields

Supertype Hierarchy

Summary

Subtypes

Supertype Hierarchy

Summary

Subtypes

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Supertype Hierarchy

Summary

Supertype Hierarchy

Summary

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Summary

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Summary

Fields

Supertype Hierarchy

Plot Recipes in `Makie`

Full recipes with the `@recipe` macro