Exported

Makie.MakieLayout.AxisType

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 (nothingorxlims, nothingorylims). 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: RGBAf0(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: RGBAf0(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: RGBf0(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: RGBAf0(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: RGBAf0(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: RGBf0(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.

source
Makie.MakieLayout.Axis3Type

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 (nothingorxlims, nothingorylims, nothingorzlims). 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: FRect3D(Vec3f0(0, 0, 0), Vec3f0(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: RGBAf0(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: RGBAf0(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: RGBAf0(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

source
Makie.MakieLayout.BoxType

Box has the following attributes:

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

color
Default: RGBf0(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: RGBf0(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.

source
Makie.MakieLayout.ButtonType

Button has the following attributes:

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

buttoncolor
Default: RGBf0(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.

source
Makie.MakieLayout.ColorbarType
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: RGBf0(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: RGBf0(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: RGBf0(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: RGBf0(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: RGBf0(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.

source
Makie.MakieLayout.IntervalSliderType

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: RGBf0(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.

source
Makie.MakieLayout.LSceneType

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.

source
Makie.MakieLayout.LabelType

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.

source
Makie.MakieLayout.LegendType

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: [Point2f0(0, 0.5), Point2f0(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: [Point2f0(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: [Point2f0(0, 0), Point2f0(1, 0), Point2f0(1, 1), Point2f0(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: false
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

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.

source
Makie.MakieLayout.LogTicksType
LogTicks{T}(linear_ticks::T)

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

source
Makie.MakieLayout.MenuType
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: RGBf0(0.97, 0.97, 0.97)
Cell color when inactive even

cell_color_inactive_odd
Default: RGBf0(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: RGBf0(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.

source
Makie.MakieLayout.MouseEventType
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
source
Makie.MakieLayout.MultiplesTicksType

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, "π")
source
Makie.MakieLayout.SliderType

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: RGBf0(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.

source
Makie.MakieLayout.TextboxType
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: RGBf0(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: RGBf0(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: RGBAf0(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: RGBf0(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.

source
Makie.MakieLayout.ToggleType

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: RGBf0(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.

source
Makie.MakieLayout.abline!Method
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.

source
Makie.MakieLayout.addmouseevents!Method
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
source
Makie.MakieLayout.autolimits!Method
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.

source
Makie.MakieLayout.axislegendMethod
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.

source
Makie.MakieLayout.hidespines!Method
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.

source
Makie.MakieLayout.hidexdecorations!Method
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.

source
Makie.MakieLayout.hideydecorations!Method
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.

source
Makie.MakieLayout.hlines!Method
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.

source
Makie.MakieLayout.labelslider!Method
labelslider!(scene, label, range; format = string, sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), 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. 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. All other keywords are forwarded to the GridLayout.

Example:

ls = labelslider!(scene, "Voltage:", 0:10; format = x -> "$(x)V")
layout[1, 1] = ls.layout
source
Makie.MakieLayout.labelslidergrid!Method
labelslidergrid!(scene, labels, ranges; formats = [string],
    sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), 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. 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. 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
source
Makie.MakieLayout.layoutsceneFunction
layoutscene(padding = 30; kwargs...)

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

source
Makie.MakieLayout.layoutsceneFunction
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).

source
Makie.MakieLayout.limits!Method
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.

source
Makie.MakieLayout.limits!Method
limits!(ax::Axis, xlims, ylims)

Set the axis limits to xlims and ylims. If limits are ordered high-low, this reverses the axis orientation.

source
Makie.MakieLayout.limits!Method
limits!(ax::Axis, rect::Rect2D)

Set the axis limits to rect. If limits are ordered high-low, this reverses the axis orientation.

source
Makie.MakieLayout.limits!Method
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.

source
Makie.MakieLayout.limits!Method
limits!(ax::Axis3, xlims, ylims)

Set the axis limits to xlims and ylims. If limits are ordered high-low, this reverses the axis orientation.

source
Makie.MakieLayout.limits!Method
limits!(ax::Axis3, rect::Rect3D)

Set the axis limits to rect. If limits are ordered high-low, this reverses the axis orientation.

source
Makie.MakieLayout.register_interaction!Method
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!.

source
Makie.MakieLayout.register_interaction!Method
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!.

source
Makie.MakieLayout.reset_limits!Method
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.

source
Makie.MakieLayout.tightlimits!Method
tightlimits!(la::Axis, sides::Union{Left, Right, Bottom, Top}...)

Sets the autolimit margins to zero on all given sides.

Example:

tightlimits!(laxis, Bottom())
source
Makie.MakieLayout.vlines!Method
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.

source

Unexported

Makie.MakieLayout.clear!Method
clear!(handle::MouseEventHandle)

Cut observable connections to the scene and remove any listeners to the mouse events.

source
Makie.MakieLayout.get_ticklabelsMethod
get_ticklabels(formatstring::AbstractString, values)

Gets tick labels by formatting each value in values according to a Formatting.format format string.

source
Makie.MakieLayout.get_ticksMethod
get_ticks(ticks, scale, formatter, vmin, vmax)

Base function that calls get_tickvalues(ticks, vmin, max) and get_ticklabels(formatter, tickvalues) and returns a tuple (tickvalues, ticklabels). For custom ticks / formatter combinations, this method can be overloaded directly, or both get_tickvalues and get_ticklabels separately.

source
Makie.MakieLayout.layoutableFunction
Legend(
    fig_or_scene,
    contents::AbstractArray,
    labels::AbstractArray{<:AbstractString},
    title::Optional{<:AbstractString} = nothing;
    kwargs...)

Create a legend from contents and labels where each label is associated to one content element. A content element can be an AbstractPlot, an array of AbstractPlots, a LegendElement, or any other object for which the legendelements method is defined.

source
Makie.MakieLayout.layoutableFunction
Legend(fig_or_scene, axis::Union{Axis, Scene, LScene}, title = nothing; merge = false, unique = false, kwargs...)

Create a single-group legend with all plots from axis that have the attribute label set.

If merge is true, all plot objects with the same label will be layered on top of each other into one legend entry. If unique is true, all plot objects with the same plot type and label will be reduced to one occurance.

source
Makie.MakieLayout.layoutableMethod
Legend(
    fig_or_scene,
    contentgroups::AbstractArray{<:AbstractArray},
    labelgroups::AbstractArray{<:AbstractArray},
    titles::AbstractArray{<:Optional{<:AbstractString}};
    kwargs...)

Create a multi-group legend from contentgroups, labelgroups and titles. Each group from contentgroups and labelgroups is associated with one title from titles (a title can be nothing to hide it).

Within each group, each content element is associated with one label. A content element can be an AbstractPlot, an array of AbstractPlots, a LegendElement, or any other object for which the legendelements method is defined.

source
Makie.MakieLayout.layoutableMethod
layoutable(Axis, fig_or_scene; bbox = nothing, kwargs...)

Creates an Axis object in the parent fig_or_scene which consists of a child scene with orthographic projection for 2D plots and axis decorations that live in the parent.

source
Makie.MakieLayout.layoutableMethod
layoutable(Axis3, fig_or_scene; bbox = nothing, kwargs...)

Creates an Axis3 object in the parent fig_or_scene which consists of a child scene with orthographic projection for 2D plots and axis decorations that live in the parent.

source
Makie.MakieLayout.on_deleteMethod

Overload to execute cleanup actions for specific layoutables that go beyond deleting elements and removing from gridlayout

source
Makie.MakieLayout.reset!Method
reset!(tb::Textbox)

Resets the stored_string of the given Textbox to nothing without triggering listeners, and resets the Textbox to the placeholder text.

source
Makie.MakieLayout.set!Method
set!(tb::Textbox, string::String)

Sets the storedstring of the given Textbox to string, triggering listeners of `tb.storedstring`.

source
Makie.MakieLayout.timed_ticklabelspace_resetMethod

Keeps the ticklabelspace static for a short duration and then resets it to its previous value. If that value is Makie.automatic, the reset will trigger new protrusions for the axis and the layout will adjust. This is so the layout doesn't immediately readjust during interaction, which would let the whole layout jitter around.

source
Makie.MakieLayout.@documented_attributesMacro

Take a sequence of variable definitions with docstrings above each and turn them into Attributes, a Dict of varname => docstring pairs and a Dict of varname => default_value pairs.

Example

attrs, docdict, defaultdict = @documented_attributes begin
    "The width."
    width = 10
    "The height."
    height = 20 + x
end

attrs == Attributes(
    width = 10,
    height = 20
)

docdict == Dict(
    width => "The width.",
    height => "The height."
)

defaultdict == Dict(
    width => "10",
    height => "20 + x"
)
source