API
iv = l..r
Construct a ClosedInterval
iv
spanning the region from
l
to
r
.
L"..."
Creates a
LaTeXString
and is equivalent to
latexstring(raw"...")
, except that
%$
can be used for interpolation.
julia> L"x = \sqrt{2}"
L"$x = \sqrt{2}$"
julia> L"x = %$(sqrt(2))"
L"$x = 1.4142135623730951$"
usage @exctract scene (a, b, c, d)
usage @extractvalue scene (a, b, c, d) will become:
begin
a = to_value(scene[:a])
b = to_value(scene[:b])
c = to_value(scene[:c])
(a, b, c)
end
@get_attribute scene (a, b, c, d)
This will extract attribute
a
,
b
,
c
,
d
from
scene
and apply the correct attribute conversions + will extract the value if it's a signal. It will make those attributes available as variables and return them as a tuple. So the above is equal to: will become:
begin
a = get_attribute(scene, :a)
b = get_attribute(scene, :b)
c = get_attribute(scene, :c)
(a, b, c)
end
No documentation found.
MakieCore.@key_str
is a macro.
# 1 method for macro "@key_str":
[1] var"@key_str"(__source__::LineNumberNode, __module__::Module, arg) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/types.jl:69
Replaces an expression with
lift(argtuple -> expression, args...)
, where
args
are all expressions inside the main one that begin with $.
Example:
x = Observable(rand(100))
y = Observable(rand(100))
before
z = lift((x, y) -> x .+ y, x, y)
after
z = @lift($x .+ $y)
You can also use parentheses around an expression if that expression evaluates to an observable.
nt = (x = Observable(1), y = Observable(2))
@lift($(nt.x) + $(nt.y))
Plot Recipes in
Makie
There's two types of recipes. Type recipes define a simple mapping from a user defined type to an existing plot type. Full recipes can customize the theme and define a custom plotting function.
Type recipes
Type recipe are really simple and just overload the argument conversion pipeline. This can be done for all plot types or for a subset of plot types:
# All plot types
convert_arguments(P::Type{<:AbstractPlot}, x::MyType) = convert_arguments(P, rand(10, 10))
# Only for scatter plots
convert_arguments(P::Type{<:Scatter}, x::MyType) = convert_arguments(P, rand(10, 10))
Optionally you may define the default plot type so that
plot(x::MyType)
will use this:
plottype(::MyType) = Surface
Full recipes with the
@recipe
macro
A full recipe for
MyPlot
comes in two parts. First is the plot type name, arguments and theme definition which are defined using the
@recipe
macro. Second is a custom
plot!
for
MyPlot
, implemented in terms of the atomic plotting functions.
We use an example to show how this works:
# arguments (x, y, z) && theme are optional
@recipe(MyPlot, x, y, z) do scene
Attributes(
plot_color = :red
)
end
This macro expands to several things. Firstly a type definition:
const MyPlot{ArgTypes} = Combined{myplot, ArgTypes}
The type parameter of
Combined
contains the function instead of e.g. a symbol. This way the mapping from
MyPlot
to
myplot
is safer and simpler. (The downside is we always need a function
myplot
- TODO: is this a problem?)
The following signatures are defined to make
MyPlot
nice to use:
myplot(args...; kw_args...) = ...
myplot!(scene, args...; kw_args...) = ...
myplot(kw_args::Dict, args...) = ...
myplot!(scene, kw_args::Dict, args...) = ...
#etc (not 100% settled what signatures there will be)
A specialization of
argument_names
is emitted if you have an argument list
(x,y,z)
provided to the recipe macro:
argument_names(::Type{<: MyPlot}) = (:x, :y, :z)
This is optional but it will allow the use of
plot_object[:x]
to fetch the first argument from the call
plot_object = myplot(rand(10), rand(10), rand(10))
, for example. Alternatively you can always fetch the
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.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Absolute
Force transformation to be absolute, not relative to the current state. This is the default setting.
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
No documentation found.
Summary
abstract type AbstractCamera
Subtypes
Camera2D
Camera3D
EmptyCamera
Makie.OldCamera3D
Makie.OrthographicCamera
Makie.PixelCamera
Makie.RelativeCamera
No documentation found.
Summary
abstract type AbstractPlot{Typ}
Subtypes
MakieCore.ScenePlot{Typ}
Supertype Hierarchy
AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
abstract type AbstractScene
Subtypes
Scene
Supertype Hierarchy
AbstractScene <: MakieCore.Transformable <: Any
Accum
Force transformation to be relative to the current state, not absolute.
A simple, one color ambient light.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Aspect
Fields
index :: Int64
ratio :: Float32
Union{Types...}
A type union is an abstract type which includes all instances of any of its argument types. The empty union
Union{}
is the bottom type of Julia.
Examples
julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}
julia> 1 :: IntOrString
1
julia> "Hello!" :: IntOrString
"Hello!"
julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64
Main structure for holding attributes, for theming plots etc! Will turn all values into observables, so that they can be updated.
struct Auto
If used as a
GridLayout
's row / column size and
trydetermine == true
, signals to the
GridLayout
that the row / column should shrink to match the largest determinable element inside. If no size of a content element can be determined, the remaining space is split between all
Auto
rows / columns according to their
ratio
.
If used as width / height of a layoutable element and
trydetermine == true
, the element's computed width / height will report the auto width / height if it can be determined. This enables a parent
GridLayout
to adjust its column / rowsize to the element's width / height. If
trydetermine == false
, the element's computed width / height will report
nothing
even if an auto width / height can be determined, which will prohibit a parent
GridLayout
from adjusting a row / column to the element's width / height. This is useful to, e.g., prohibit a
GridLayout
from shrinking a column's width to the width of a super title, even though the title's width can be auto-determined.
The
ratio
is ignored if
Auto
is used as an element size.
Axis <: Block
A 2D axis which can be plotted into.
Constructors
Axis(fig_or_scene; palette = nothing, kwargs...)
Examples
ax = Axis(fig[1, 1])
Attributes
Axis attributes :
-
aspect
: The forced aspect ratio of the axis.nothing
leaves the axis unconstrained,DataAspect()
forces the same ratio as the ratio in data limits between x and y axis,AxisAspect(ratio)
sets a manual ratio. Default:nothing
-
autolimitaspect
: Constrains the data aspect ratio (nothing
leaves the ratio unconstrained). Default:nothing
-
backgroundcolor
: The background color of the axis. Default::white
-
bottomspinecolor
: The color of the bottom axis spine. Default::black
-
bottomspinevisible
: Controls if the bottom axis spine is visible. Default:true
-
flip_ylabel
: Controls if the ylabel's rotation is flipped. Default:false
-
leftspinecolor
: The color of the left axis spine. Default::black
-
leftspinevisible
: Controls if the left axis spine is visible. Default:true
-
limits
: The limits that the user has manually set. They are reinstated when callingreset_limits!
and are set to nothing byautolimits!
. Can be either a tuple (xlow, xhigh, ylow, high) or a tuple (nothing or xlims, nothing or ylims). Are set byxlims!
,ylims!
andlimits!
. Default:(nothing, nothing)
-
panbutton
: The button for panning. Default:Makie.Mouse.right
-
rightspinecolor
: The color of the right axis spine. Default::black
-
rightspinevisible
: Controls if the right axis spine is visible. Default:true
-
spinewidth
: The width of the axis spines. Default:1.0
-
subtitle
: The axis subtitle string. Default:""
-
subtitlecolor
: The color of the subtitle Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:234 =# @inherit :textcolor :black
-
subtitlefont
: The font family of the subtitle. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:226 =# @inherit :font "TeX Gyre Heros Makie"
-
subtitlegap
: The gap between subtitle and title. Default:0
-
subtitlelineheight
: The axis subtitle line height multiplier. Default:1
-
subtitlesize
: The subtitle's font size. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:228 =# @inherit :fontsize 16.0f0
-
subtitlevisible
: Controls if the subtitle is visible. Default:true
-
title
: The axis title string. Default:""
-
titlealign
: The horizontal alignment of the title. Default::center
-
titlecolor
: The color of the title Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:220 =# @inherit :textcolor :black
-
titlefont
: The font family of the title. Default:"TeX Gyre Heros Makie Bold"
-
titlegap
: The gap between axis and title. Default:4.0
-
titlelineheight
: The axis title line height multiplier. Default:1
-
titlesize
: The title's font size. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:212 =# @inherit :fontsize 16.0f0
-
titlevisible
: Controls if the title is visible. Default:true
-
topspinecolor
: The color of the top axis spine. Default::black
-
topspinevisible
: Controls if the top axis spine is visible. Default:true
-
xautolimitmargin
: The relative margins added to the autolimits in x direction. Default:(0.05f0, 0.05f0)
-
xaxisposition
: The position of the x axis (:bottom
or:top
). Default::bottom
-
xgridcolor
: The color of the x grid lines. Default:RGBAf(0, 0, 0, 0.12)
-
xgridstyle
: The linestyle of the x grid lines. Default:nothing
-
xgridvisible
: Controls if the x grid lines are visible. Default:true
-
xgridwidth
: The width of the x grid lines. Default:1.0
-
xlabel
: The xlabel string. Default:""
-
xlabelcolor
: The color of the xlabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:242 =# @inherit :textcolor :black
-
xlabelfont
: The font family of the xlabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:238 =# @inherit :font "TeX Gyre Heros Makie"
-
xlabelpadding
: The padding between the xlabel and the ticks or axis. Default:3.0
-
xlabelsize
: The font size of the xlabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:246 =# @inherit :fontsize 16.0f0
-
xlabelvisible
: Controls if the xlabel is visible. Default:true
-
xminorgridcolor
: The color of the x minor grid lines. Default:RGBAf(0, 0, 0, 0.05)
-
xminorgridstyle
: The linestyle of the x minor grid lines. Default:nothing
-
xminorgridvisible
: Controls if the x minor grid lines are visible. Default:false
-
xminorgridwidth
: The width of the x minor grid lines. Default:1.0
-
xminortickalign
: The alignment of x minor ticks on the axis spine Default:0.0
-
xminortickcolor
: The tick color of x minor ticks Default::black
-
xminorticks
: The tick locator for the x minor ticks Default:IntervalsBetween(2)
-
xminorticksize
: The tick size of x minor ticks Default:4.0
-
xminorticksvisible
: Controls if minor ticks on the x axis are visible Default:false
-
xminortickwidth
: The tick width of x minor ticks Default:1.0
-
xpankey
: The key for limiting panning to the x direction. Default:Makie.Keyboard.x
-
xpanlock
: Locks interactive panning in the x direction. Default:false
-
xrectzoom
: Controls if rectangle zooming affects the x dimension. Default:true
-
xreversed
: Controls if the x axis goes rightwards (false) or leftwards (true) Default:false
-
xscale
: The x axis scale Default:identity
-
xtickalign
: The alignment of the xtick marks relative to the axis spine (0 = out, 1 = in). Default:0.0
-
xtickcolor
: The color of the xtick marks. Default:RGBf(0, 0, 0)
-
xtickformat
: Format for xticks. Default:Makie.automatic
-
xticklabelalign
: The horizontal and vertical alignment of the xticklabels. Default:Makie.automatic
-
xticklabelcolor
: The color of xticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:262 =# @inherit :textcolor :black
-
xticklabelfont
: The font family of the xticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:258 =# @inherit :font "TeX Gyre Heros Makie"
-
xticklabelpad
: The space between xticks and xticklabels. Default:2.0
-
xticklabelrotation
: The counterclockwise rotation of the xticklabels in radians. Default:0.0
-
xticklabelsize
: The font size of the xticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:266 =# @inherit :fontsize 16.0f0
-
xticklabelspace
: The space reserved for the xticklabels. Default:Makie.automatic
-
xticklabelsvisible
: Controls if the xticklabels are visible. Default:true
-
xticks
: The xticks. Default:Makie.automatic
-
xticksize
: The size of the xtick marks. Default:6.0
-
xticksmirrored
: Controls if the x ticks and minor ticks are mirrored on the other side of the Axis. Default:false
-
xticksvisible
: Controls if the xtick marks are visible. Default:true
-
xtickwidth
: The width of the xtick marks. Default:1.0
-
xtrimspine
: Controls if the x spine is limited to the furthest tick marks or not. Default:false
-
xzoomkey
: The key for limiting zooming to the x direction. Default:Makie.Keyboard.x
-
xzoomlock
: Locks interactive zooming in the x direction. Default:false
-
yautolimitmargin
: The relative margins added to the autolimits in y direction. Default:(0.05f0, 0.05f0)
-
yaxisposition
: The position of the y axis (:left
or:right
). Default::left
-
ygridcolor
: The color of the y grid lines. Default:RGBAf(0, 0, 0, 0.12)
-
ygridstyle
: The linestyle of the y grid lines. Default:nothing
-
ygridvisible
: Controls if the y grid lines are visible. Default:true
-
ygridwidth
: The width of the y grid lines. Default:1.0
-
ylabel
: The ylabel string. Default:""
-
ylabelcolor
: The color of the ylabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:244 =# @inherit :textcolor :black
-
ylabelfont
: The font family of the ylabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:240 =# @inherit :font "TeX Gyre Heros Makie"
-
ylabelpadding
: The padding between the ylabel and the ticks or axis. Default:5.0
-
ylabelsize
: The font size of the ylabel. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:248 =# @inherit :fontsize 16.0f0
-
ylabelvisible
: Controls if the ylabel is visible. Default:true
-
yminorgridcolor
: The color of the y minor grid lines. Default:RGBAf(0, 0, 0, 0.05)
-
yminorgridstyle
: The linestyle of the y minor grid lines. Default:nothing
-
yminorgridvisible
: Controls if the y minor grid lines are visible. Default:false
-
yminorgridwidth
: The width of the y minor grid lines. Default:1.0
-
yminortickalign
: The alignment of y minor ticks on the axis spine Default:0.0
-
yminortickcolor
: The tick color of y minor ticks Default::black
-
yminorticks
: The tick locator for the y minor ticks Default:IntervalsBetween(2)
-
yminorticksize
: The tick size of y minor ticks Default:4.0
-
yminorticksvisible
: Controls if minor ticks on the y axis are visible Default:false
-
yminortickwidth
: The tick width of y minor ticks Default:1.0
-
ypankey
: The key for limiting panning to the y direction. Default:Makie.Keyboard.y
-
ypanlock
: Locks interactive panning in the y direction. Default:false
-
yrectzoom
: Controls if rectangle zooming affects the y dimension. Default:true
-
yreversed
: Controls if the y axis goes upwards (false) or downwards (true) Default:false
-
yscale
: The y axis scale Default:identity
-
ytickalign
: The alignment of the ytick marks relative to the axis spine (0 = out, 1 = in). Default:0.0
-
ytickcolor
: The color of the ytick marks. Default:RGBf(0, 0, 0)
-
ytickformat
: Format for yticks. Default:Makie.automatic
-
yticklabelalign
: The horizontal and vertical alignment of the yticklabels. Default:Makie.automatic
-
yticklabelcolor
: The color of yticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:264 =# @inherit :textcolor :black
-
yticklabelfont
: The font family of the yticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:260 =# @inherit :font "TeX Gyre Heros Makie"
-
yticklabelpad
: The space between yticks and yticklabels. Default:4.0
-
yticklabelrotation
: The counterclockwise rotation of the yticklabels in radians. Default:0.0
-
yticklabelsize
: The font size of the yticklabels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:268 =# @inherit :fontsize 16.0f0
-
yticklabelspace
: The space reserved for the yticklabels. Default:Makie.automatic
-
yticklabelsvisible
: Controls if the yticklabels are visible. Default:true
-
yticks
: The yticks. Default:Makie.automatic
-
yticksize
: The size of the ytick marks. Default:6.0
-
yticksmirrored
: Controls if the y ticks and minor ticks are mirrored on the other side of the Axis. Default:false
-
yticksvisible
: Controls if the ytick marks are visible. Default:true
-
ytickwidth
: The width of the ytick marks. Default:1.0
-
ytrimspine
: Controls if the y spine is limited to the furthest tick marks or not. Default:false
-
yzoomkey
: The key for limiting zooming to the y direction. Default:Makie.Keyboard.y
-
yzoomlock
: Locks interactive zooming in the y direction. Default:false
Layout attributes :
-
alignmode
: The align mode of the axis in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the axis within its suggested bounding box. Default::center
-
height
: The height of the axis. Default:nothing
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the axis within its suggested bounding box. Default::center
-
width
: The width of the axis. Default:nothing
Axis3 <: Block
Attributes
Axis3 attributes :
-
aspect
: Aspects of the 3 axes with each other Default:(1.0, 1.0, 2 / 3)
-
azimuth
: The azimuth angle of the camera Default:1.275pi
-
backgroundcolor
: The background color Default::transparent
-
elevation
: The elevation angle of the camera Default:pi / 8
-
limits
: The limits that the user has manually set. They are reinstated when callingreset_limits!
and are set to nothing byautolimits!
. 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 byxlims!
,ylims!
,zlims!
andlimits!
. Default:(nothing, nothing, nothing)
-
perspectiveness
: A number between 0 and 1, where 0 is orthographic, and 1 full perspective Default:0.0
-
protrusions
: The protrusions on the sides of the axis, how much gap space is reserved for labels etc. Default:30
-
targetlimits
: The limits that the axis tries to set given other constraints like aspect. Don't set this directly, usexlims!
,ylims!
orlimits!
instead. Default:Rect3f(Vec3f(0, 0, 0), Vec3f(1, 1, 1))
-
title
: The axis title string. Default:""
-
titlealign
: The horizontal alignment of the title. Default::center
-
titlecolor
: The color of the title Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1348 =# @inherit :textcolor :black
-
titlefont
: The font family of the title. Default:"TeX Gyre Heros Makie Bold"
-
titlegap
: The gap between axis and title. Default:4.0
-
titlesize
: The title's font size. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1340 =# @inherit :fontsize 16.0f0
-
titlevisible
: Controls if the title is visible. Default:true
-
viewmode
: The view mode which affects the final projection.:fit
results in the projection that always fits the limits into the viewport, invariant to rotation.:fitzoom
keeps the x/y ratio intact but stretches the view so the corners touch the scene viewport.:stretch
scales separately in both x and y direction to fill the viewport, which can distort theaspect
that is set. Default::fitzoom
-
xautolimitmargin
: The relative margins added to the autolimits in x direction. Default:(0.05, 0.05)
-
xgridcolor
: The x grid color Default:RGBAf(0, 0, 0, 0.12)
-
xgridvisible
: Controls if the x grid is visible Default:true
-
xgridwidth
: The x grid width Default:1
-
xlabel
: The x label Default:"x"
-
xlabelalign
: The x label align Default:Makie.automatic
-
xlabelcolor
: The x label color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1184 =# @inherit :textcolor :black
-
xlabelfont
: The x label font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1214 =# @inherit :font "TeX Gyre Heros Makie"
-
xlabeloffset
: The x label offset Default:40
-
xlabelrotation
: The x label rotation Default:Makie.automatic
-
xlabelsize
: The x label size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1208 =# @inherit :fontsize 16.0f0
-
xlabelvisible
: Controls if the x label is visible Default:true
-
xspinecolor_1
: The color of x spine 1 where the ticks are displayed Default::black
-
xspinecolor_2
: The color of x spine 2 towards the center Default::black
-
xspinecolor_3
: The color of x spine 3 opposite of the ticks Default::black
-
xspinesvisible
: Controls if the x spine is visible Default:true
-
xspinewidth
: The x spine width Default:1
-
xtickcolor
: The x tick color Default::black
-
xtickformat
: The x tick format Default:Makie.automatic
-
xticklabelcolor
: The x ticklabel color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1238 =# @inherit :textcolor :black
-
xticklabelfont
: The x ticklabel font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1256 =# @inherit :font "TeX Gyre Heros Makie"
-
xticklabelpad
: The x ticklabel pad Default:5
-
xticklabelsize
: The x ticklabel size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1244 =# @inherit :fontsize 16.0f0
-
xticklabelsvisible
: Controls if the x ticklabels are visible Default:true
-
xticks
: The x ticks Default:WilkinsonTicks(5; k_min = 3)
-
xticksvisible
: Controls if the x ticks are visible Default:true
-
xtickwidth
: The x tick width Default:1
-
xypanelcolor
: The color of the xy panel Default::transparent
-
xypanelvisible
: Controls if the xy panel is visible Default:true
-
xzpanelcolor
: The color of the xz panel Default::transparent
-
xzpanelvisible
: Controls if the xz panel is visible Default:true
-
yautolimitmargin
: The relative margins added to the autolimits in y direction. Default:(0.05, 0.05)
-
ygridcolor
: The y grid color Default:RGBAf(0, 0, 0, 0.12)
-
ygridvisible
: Controls if the y grid is visible Default:true
-
ygridwidth
: The y grid width Default:1
-
ylabel
: The y label Default:"y"
-
ylabelalign
: The y label align Default:Makie.automatic
-
ylabelcolor
: The y label color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1186 =# @inherit :textcolor :black
-
ylabelfont
: The y label font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1216 =# @inherit :font "TeX Gyre Heros Makie"
-
ylabeloffset
: The y label offset Default:40
-
ylabelrotation
: The y label rotation Default:Makie.automatic
-
ylabelsize
: The y label size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1210 =# @inherit :fontsize 16.0f0
-
ylabelvisible
: Controls if the y label is visible Default:true
-
yspinecolor_1
: The color of y spine 1 where the ticks are displayed Default::black
-
yspinecolor_2
: The color of y spine 2 towards the center Default::black
-
yspinecolor_3
: The color of y spine 3 opposite of the ticks Default::black
-
yspinesvisible
: Controls if the y spine is visible Default:true
-
yspinewidth
: The y spine width Default:1
-
ytickcolor
: The y tick color Default::black
-
ytickformat
: The y tick format Default:Makie.automatic
-
yticklabelcolor
: The y ticklabel color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1240 =# @inherit :textcolor :black
-
yticklabelfont
: The y ticklabel font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1258 =# @inherit :font "TeX Gyre Heros Makie"
-
yticklabelpad
: The y ticklabel pad Default:5
-
yticklabelsize
: The y ticklabel size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1246 =# @inherit :fontsize 16.0f0
-
yticklabelsvisible
: Controls if the y ticklabels are visible Default:true
-
yticks
: The y ticks Default:WilkinsonTicks(5; k_min = 3)
-
yticksvisible
: Controls if the y ticks are visible Default:true
-
ytickwidth
: The y tick width Default:1
-
yzpanelcolor
: The color of the yz panel Default::transparent
-
yzpanelvisible
: Controls if the yz panel is visible Default:true
-
zautolimitmargin
: The relative margins added to the autolimits in z direction. Default:(0.05, 0.05)
-
zgridcolor
: The z grid color Default:RGBAf(0, 0, 0, 0.12)
-
zgridvisible
: Controls if the z grid is visible Default:true
-
zgridwidth
: The z grid width Default:1
-
zlabel
: The z label Default:"z"
-
zlabelalign
: The z label align Default:Makie.automatic
-
zlabelcolor
: The z label color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1188 =# @inherit :textcolor :black
-
zlabelfont
: The z label font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1218 =# @inherit :font "TeX Gyre Heros Makie"
-
zlabeloffset
: The z label offset Default:50
-
zlabelrotation
: The z label rotation Default:Makie.automatic
-
zlabelsize
: The z label size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1212 =# @inherit :fontsize 16.0f0
-
zlabelvisible
: Controls if the z label is visible Default:true
-
zspinecolor_1
: The color of z spine 1 where the ticks are displayed Default::black
-
zspinecolor_2
: The color of z spine 2 towards the center Default::black
-
zspinecolor_3
: The color of z spine 3 opposite of the ticks Default::black
-
zspinesvisible
: Controls if the z spine is visible Default:true
-
zspinewidth
: The z spine width Default:1
-
ztickcolor
: The z tick color Default::black
-
ztickformat
: The z tick format Default:Makie.automatic
-
zticklabelcolor
: The z ticklabel color Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1242 =# @inherit :textcolor :black
-
zticklabelfont
: The z ticklabel font Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1260 =# @inherit :font "TeX Gyre Heros Makie"
-
zticklabelpad
: The z ticklabel pad Default:10
-
zticklabelsize
: The z ticklabel size Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1248 =# @inherit :fontsize 16.0f0
-
zticklabelsvisible
: Controls if the z ticklabels are visible Default:true
-
zticks
: The z ticks Default:WilkinsonTicks(5; k_min = 3)
-
zticksvisible
: Controls if the z ticks are visible Default:true
-
ztickwidth
: The z tick width Default:1
Layout attributes :
-
alignmode
: The alignment of the scene in its suggested bounding box. Default:Inside()
-
halign
: The horizontal alignment of the scene in its suggested bounding box. Default::center
-
height
: The height setting of the scene. Default:nothing
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the scene in its suggested bounding box. Default::center
-
width
: The width setting of the scene. Default:nothing
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct AxisAspect
Fields
aspect :: Float32
No documentation found.
GridLayoutBase.BBox
is a
Function
.
# 1 method for generic function "BBox":
[1] BBox(left::Number, right::Number, bottom::Number, top::Number) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/helpers.jl:116
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct BezierPath
Fields
commands :: Vector{Union{ClosePath, CurveTo, EllipticalArc, LineTo, MoveTo}}
Billboard([angle::Real])
Billboard([angles::Vector{<: Real}])
Billboard attribute to always have a primitive face the camera. Can be used for rotation.
No documentation found.
Summary
struct Bottom
Supertype Hierarchy
Bottom <: GridLayoutBase.Side <: Any
No documentation found.
Summary
struct BottomLeft
Supertype Hierarchy
BottomLeft <: GridLayoutBase.Side <: Any
No documentation found.
Summary
struct BottomRight
Supertype Hierarchy
BottomRight <: GridLayoutBase.Side <: Any
Box <: Block
Attributes
Box attributes :
-
color
: The color of the rectangle. Default:RGBf(0.9, 0.9, 0.9)
-
padding
: The extra space added to the sides of the rectangle boundingbox. Default:(0.0f0, 0.0f0, 0.0f0, 0.0f0)
-
strokecolor
: The color of the border. Default:RGBf(0, 0, 0)
-
strokevisible
: Controls if the border of the rectangle is visible. Default:true
-
strokewidth
: The line width of the rectangle's border. Default:1.0
-
visible
: Controls if the rectangle is visible. Default:true
Layout attributes :
-
alignmode
: The align mode of the rectangle in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the rectangle in its suggested boundingbox Default::center
-
height
: The height setting of the rectangle. Default:nothing
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the rectangle in its suggested boundingbox Default::center
-
width
: The width setting of the rectangle. Default:nothing
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Button <: Block
Attributes
Button attributes :
-
buttoncolor
: The color of the button. Default:RGBf(0.94, 0.94, 0.94)
-
buttoncolor_active
: The color of the button when the mouse clicks the button. Default:COLOR_ACCENT[]
-
buttoncolor_hover
: The color of the button when the mouse hovers over the button. Default:COLOR_ACCENT_DIMMED[]
-
clicks
: The number of clicks that have been registered by the button. Default:0
-
cornerradius
: The radius of the rounded corners of the button. Default:4
-
cornersegments
: The number of poly segments used for each rounded corner. Default:10
-
font
: The font family of the button label. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:786 =# @inherit :font "TeX Gyre Heros Makie"
-
label
: The text of the button label. Default:"Button"
-
labelcolor
: The color of the label. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:806 =# @inherit :textcolor :black
-
labelcolor_active
: The color of the label when the mouse clicks the button. Default::white
-
labelcolor_hover
: The color of the label when the mouse hovers over the button. Default::black
-
padding
: The extra space added to the sides of the button label's boundingbox. Default:(10.0f0, 10.0f0, 10.0f0, 10.0f0)
-
strokecolor
: The color of the button border. Default::transparent
-
strokewidth
: The line width of the button border. Default:2.0
-
textsize
: The font size of the button label. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:782 =# @inherit :fontsize 16.0f0
Layout attributes :
-
alignmode
: The align mode of the button in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the button in its suggested boundingbox Default::center
-
height
: The height setting of the button. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the button in its suggested boundingbox Default::center
-
width
: The width setting of the button. Default:Auto()
Camera(pixel_area)
Struct to hold all relevant matrices and additional parameters, to let backends apply camera based transformations.
No documentation found.
Summary
struct Camera2D
Fields
area :: Observable{GeometryBasics.HyperRectangle{2, Float32}}
zoomspeed :: Observable{Float32}
zoombutton :: Observable{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button}}
panbutton :: Observable{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button, Vector{Union{Nothing, Makie.Keyboard.Button, Makie.Mouse.Button}}}}
padding :: Observable{Float32}
last_area :: Observable{Vec2{Int64}}
update_limits :: Observable{Bool}
Supertype Hierarchy
Camera2D <: AbstractCamera <: Any
Camera3D(scene[; attributes...])
Creates a 3d camera with a lot of controls.
The 3D camera is (or can be) unrestricted in terms of rotations and translations. Both
cam3d!(scene)
and
cam3d_cad!(scene)
create this camera type. Unlike the 2D camera, settings and controls are stored in the
cam.attributes
field rather than in the struct directly, but can still be passed as keyword arguments. The general camera settings include
-
fov = 45f0
sets the "neutral" field of view, i.e. the fov corresponding to no zoom. This is irrelevant if the camera uses an orthographic projection. -
near = automatic
sets the value of the near clip. By default this will be chosen based on the scenes bounding box. The final value is incam.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 incam.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 beOrthographic
orPerspective
. -
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 aroundlookat
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 movingeyepostion
away fromlookat
. -
contract_view_key = Keyboard.page_down
sets the key for movingeyeposition
towardslookat
. -
pan_left_key = Keyboard.j
sets the key for rotations around the screens vertical axis. -
pan_right_key = Keyboard.l
sets the key for rotations around the screens vertical axis. -
tilt_up_key = Keyboard.i
sets the key for rotations around the screens horizontal axis. -
tilt_down_key = Keyboard.k
sets the key for rotations around the screens horizontal axis. -
roll_clockwise_key = Keyboard.e
sets the key for rotations of the screen. -
roll_counterclockwise_key = Keyboard.q
sets the key for rotations of the screen. -
keyboard_rotationspeed = 1f0
sets the speed of keyboard based rotations. -
keyboard_translationspeed = 0.5f0
sets the speed of keyboard based translations. -
keyboard_zoomspeed = 1f0
sets the speed of keyboard based zooms. -
update_rate = 1/30
sets the rate at which keyboard based camera updates are evaluated.
and mouse interactions are controlled by
-
translation_button = Mouse.right
sets the mouse button for drag-translations. (up/down/left/right) -
scroll_mod = true
sets an additional modifier button for scroll-based zoom. (true being neutral) -
rotation_button = Mouse.left
sets the mouse button for drag-rotations. (pan, tilt) -
mouse_rotationspeed = 1f0
sets the speed of mouse rotations. -
mouse_translationspeed = 0.5f0
sets the speed of mouse translations. -
mouse_zoomspeed = 1f0
sets the speed of mouse zooming (mousewheel). -
circular_rotation = (true, true, true)
enables circular rotations for (fixed x, fixed y, fixed z) rotation axis. (This means drawing a circle with your mouse around the center of the scene will result in a continuous rotation.)
There are also a few generally applicable controls:
-
fix_x_key = Keyboard.x
sets the key for fixing translations and rotations to the (world/plot) x-axis. -
fix_y_key = Keyboard.y
sets the key for fixing translations and rotations to the (world/plot) y-axis. -
fix_z_key = Keyboard.z
sets the key for fixing translations and rotations to the (world/plot) z-axis. -
reset = Keyboard.home
sets the key for fully resetting the camera. This equivalent to settinglookat = Vec3f(0)
,upvector = Vec3f(0, 0, 1)
,eyeposition = Vec3f(3)
and then callingcenter!(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 vectorv
. -
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 orVec3f(0, 0, +-1)
iffixed_axis = true
, and the third will rotate around the view direction i.e. the axis out of the screen. The rotation respects the currentrotation_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 tocam.zoom_mult
which is used as a multiplier to the fov (perspective projection) or width and height (orthographic projection).
HyperSphere{N, T}
A
HyperSphere
is a generalization of a sphere into N-dimensions. A
center
and radius,
r
, must be specified.
No documentation found.
Summary
struct ClosePath
Colorbar <: Block
Create a colorbar that shows a continuous or categorical colormap with ticks chosen according to the colorrange.
You can set colorrange and colormap manually, or pass a plot object as the second argument to copy its respective attributes.
Constructors
Colorbar(fig_or_scene; kwargs...)
Colorbar(fig_or_scene, plot::AbstractPlot; kwargs...)
Colorbar(fig_or_scene, heatmap::Union{Heatmap, Image}; kwargs...)
Colorbar(fig_or_scene, contourf::Makie.Contourf; kwargs...)
Attributes
Colorbar attributes :
-
bottomspinecolor
: The color of the bottom spine. Default:RGBf(0, 0, 0)
-
bottomspinevisible
: Controls if the bottom spine is visible. Default:true
-
colormap
: The colormap that the colorbar uses. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:569 =# @inherit :colormap :viridis
-
colorrange
: The range of values depicted in the colorbar. Default:nothing
-
flip_vertical_label
: Flips the colorbar label if the axis is vertical. Default:false
-
flipaxis
: Flips the axis to the right if vertical and to the top if horizontal. Default:true
-
highclip
: The color of the high clip triangle. Default:nothing
-
label
: The color bar label string. Default:""
-
labelcolor
: The label color. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:493 =# @inherit :textcolor :black
-
labelfont
: The label font family. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:495 =# @inherit :font "TeX Gyre Heros Makie"
-
labelpadding
: The gap between the label and the ticks. Default:5.0
-
labelsize
: The label font size. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:497 =# @inherit :fontsize 16.0f0
-
labelvisible
: Controls if the label is visible. Default:true
-
leftspinecolor
: The color of the left spine. Default:RGBf(0, 0, 0)
-
leftspinevisible
: Controls if the left spine is visible. Default:true
-
limits
: The range of values depicted in the colorbar. Default:nothing
-
lowclip
: The color of the low clip triangle. Default:nothing
-
minortickalign
: The alignment of minor ticks on the axis spine Default:0.0
-
minortickcolor
: The tick color of minor ticks Default::black
-
minorticks
: The tick locator for the minor ticks Default:IntervalsBetween(5)
-
minorticksize
: The tick size of minor ticks Default:4.0
-
minorticksvisible
: Controls if minor ticks are visible Default:false
-
minortickwidth
: The tick width of minor ticks Default:1.0
-
nsteps
: The number of steps in the heatmap underlying the colorbar gradient. Default:100
-
rightspinecolor
: The color of the right spine. Default:RGBf(0, 0, 0)
-
rightspinevisible
: Controls if the right spine is visible. Default:true
-
scale
: The axis scale Default:identity
-
size
: The width or height of the colorbar, depending on if it's vertical or horizontal, unless overridden bywidth
/height
Default:16
-
spinewidth
: The line width of the spines. Default:1.0
-
tickalign
: The alignment of the tick marks relative to the axis spine (0 = out, 1 = in). Default:0.0
-
tickcolor
: The color of the tick marks. Default:RGBf(0, 0, 0)
-
tickformat
: Format for ticks. Default:Makie.automatic
-
ticklabelalign
: The horizontal and vertical alignment of the tick labels. Default:Makie.automatic
-
ticklabelcolor
: The color of the tick labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:509 =# @inherit :textcolor :black
-
ticklabelfont
: The font family of the tick labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:503 =# @inherit :font "TeX Gyre Heros Makie"
-
ticklabelpad
: The gap between tick labels and tick marks. Default:3.0
-
ticklabelrotation
: The rotation of the ticklabels Default:0.0
-
ticklabelsize
: The font size of the tick labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:505 =# @inherit :fontsize 16.0f0
-
ticklabelspace
: The space reserved for the tick labels. Default:Makie.automatic
-
ticklabelsvisible
: Controls if the tick labels are visible. Default:true
-
ticks
: The ticks. Default:Makie.automatic
-
ticksize
: The size of the tick marks. Default:6.0
-
ticksvisible
: Controls if the tick marks are visible. Default:true
-
tickwidth
: The line width of the tick marks. Default:1.0
-
topspinecolor
: The color of the top spine. Default:RGBf(0, 0, 0)
-
topspinevisible
: Controls if the top spine is visible. Default:true
-
vertical
: Controls if the colorbar is oriented vertically. Default:true
Layout attributes :
-
alignmode
: The align mode of the colorbar in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the colorbar in its suggested bounding box. Default::center
-
height
: The height setting of the colorbar. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the colorbar in its suggested bounding box. Default::center
-
width
: The width setting of the colorbar. Usesize
to set width or height relative to colorbar orientation instead. Default:Auto()
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Consume
Fields
x :: Bool
No documentation found.
Summary
struct ContinuousSurface
Supertype Hierarchy
ContinuousSurface <: SurfaceLike <: ConversionTrait <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
abstract type ConversionTrait
Subtypes
Makie.SampleBased
NoConversion
PointBased
SurfaceLike
VolumeLike
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct CurveTo
Fields
c1 :: Point2{Float64}
c2 :: Point2{Float64}
p :: Point2{Float64}
No documentation found.
Summary
struct Cycle
Fields
cycle :: Vector{Pair{Vector{Symbol}, Symbol}}
covary :: Bool
Cycled(i::Int)
If a
Cycled
value is passed as an attribute to a plotting function, it is replaced with the value from the cycler for this attribute (as long as there is one defined) at the index
i
.
No documentation found.
Summary
struct DataAspect
DataInspector(figure_axis_or_scene = current_figure(); kwargs...)
Creates a data inspector which will show relevant information in a tooltip when you hover over a plot.
This functionality can eb disabled on a per-plot basis by setting
plot.inspectable[] = false
. The displayed text can be adjusted by setting
plot.inspector_label
to a function
(plot, index, position) -> "my_label"
returning a label. See Makie documentation for more detail.
Keyword Arguments:
-
range = 10
: Controls the snapping range for selecting an element of a plot. -
priority = 100
: The priority of creating a tooltip on a mouse movement or scrolling event. -
enabled = true
: Disables inspection of plots when set to false. Can also be adjusted withenable!(inspector)
anddisable!(inspector)
. -
indicator_color = :red
: Color of the selection indicator. -
indicator_linewidth = 2
: Linewidth of the selection indicator. -
indicator_linestyle = nothing
: Linestyle of the selection indicator -
enable_indicators = true)
: Enables or disables indicators -
depth = 9e3
: Depth value of the tooltip. This should be high so that the tooltip is always in front. -
and all attributes from
Tooltip
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct DiscreteSurface
Supertype Hierarchy
DiscreteSurface <: SurfaceLike <: ConversionTrait <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct EllipticalArc
Fields
c :: Point2{Float64}
r1 :: Float64
r2 :: Float64
angle :: Float64
a1 :: Float64
a2 :: Float64
No documentation found.
Summary
struct EmptyCamera
Supertype Hierarchy
EmptyCamera <: AbstractCamera <: Any
An environment Light, that uses a spherical environment map to provide lighting. See: https://en.wikipedia.org/wiki/Reflection_mapping
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
This struct provides accessible
Observable
s to monitor the events associated with a Scene.
Functions that act on a
Observable
must return
Consume()
if the function consumes an event. When an event is consumed it does not trigger other observer functions. The order in which functions are exectued can be controlled via the
priority
keyword (default 0) in
on
.
Example:
on(events(scene).mousebutton, priority = 20) do event
if is_correct_event(event)
do_something()
return Consume()
end
return
end
Fields
-
window_area::Observable{GeometryBasics.HyperRectangle{2, Int64}}
The area of the window in pixels, as a
Rect2
.
-
window_dpi::Observable{Float64}
The DPI resolution of the window, as a
Float64
.
-
window_open::Observable{Bool}
The state of the window (open => true, closed => false).
-
mousebutton::Observable{Makie.MouseButtonEvent}
Most recently triggered
MouseButtonEvent
. Contains the relevantevent.button
andevent.action
(press/release)See also
ispressed
.
-
mousebuttonstate::Set{Makie.Mouse.Button}
A Set of all currently pressed mousebuttons.
-
mouseposition::Observable{Tuple{Float64, Float64}}
The position of the mouse as a
NTuple{2, Float64}
. Updates once per event poll/frame.
-
scroll::Observable{Tuple{Float64, Float64}}
The direction of scroll
-
keyboardbutton::Observable{Makie.KeyEvent}
Most recently triggered
KeyEvent
. Contains the relevantevent.key
andevent.action
(press/repeat/release)See also
ispressed
.
-
keyboardstate::Set{Makie.Keyboard.Button}
Contains all currently pressed keys.
-
unicode_input::Observable{Char}
Contains the last typed character.
-
dropped_files::Observable{Vector{String}}
Contains a list of filepaths to files dragged into the scene.
-
hasfocus::Observable{Bool}
Whether the Scene window is in focus or not.
-
entered_window::Observable{Bool}
Whether the mouse is inside the window or not.
Exclusively(x)
Marks a button, button collection or logical expression of buttons as the exclusive subset of buttons that must be pressed for
ispressed
to return true.
For example
Exclusively((Keyboard.left_control, Keyboard.c))
would require left control and c to be pressed without any other buttons.
Boolean expressions are lowered to multiple
Exclusive
sets in an
Or
. It is worth noting that
Not
branches are ignored here, i.e. it assumed that every button under a
Not
must not be pressed and that this follows automatically from the subset of buttons that must be pressed.
No documentation found.
Summary
struct Figure
Fields
scene :: Scene
layout :: GridLayout
content :: Vector
attributes :: Attributes
current_axis :: Ref{Any}
No documentation found.
Summary
struct Fixed
Fields
x :: Float32
GridLayout(; kwargs...)
Create a
GridLayout
without parent and with size [1, 1].
GridLayout(g::Union{GridPosition, GridSubposition}, args...; kwargs...)
Create a
GridLayout
at position
g
in the parent
GridLayout
of
g
if it is a
GridPosition
and in a nested child
GridLayout
if it is a
GridSubposition
. The
args
and
kwargs
are passed on to the normal
GridLayout
constructor.
function GridLayout(nrows::Int, ncols::Int;
parent = nothing,
rowsizes = nothing,
colsizes = nothing,
addedrowgaps = nothing,
addedcolgaps = nothing,
alignmode = Inside(),
equalprotrusiongaps = (false, false),
bbox = nothing,
width = Auto(),
height = Auto(),
tellwidth::Bool = true,
tellheight::Bool = true,
halign = :center,
valign = :center,
default_rowgap = get_default_rowgap(),
default_colgap = get_default_colgap(),
kwargs...)
Create a
GridLayout
with optional parent
parent
with
nrows
rows and
ncols
columns.
No documentation found.
Summary
struct GridLayoutSpec
Fields
content :: Vector{Pair{Tuple{Union{Colon, Int64, UnitRange}, Union{Colon, Int64, UnitRange}, GridLayoutBase.Side}, Any}}
kwargs :: Dict{Symbol, Any}
No documentation found.
Summary
struct GridPosition
Fields
layout :: GridLayout
span :: GridLayoutBase.Span
side :: GridLayoutBase.Side
No documentation found.
Summary
struct GridSubposition
Fields
parent :: Union{GridPosition, GridSubposition}
rows :: Any
cols :: Any
side :: GridLayoutBase.Side
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
AlignMode that excludes the protrusions from the bounding box.
IntervalSlider <: Block
Attributes
IntervalSlider attributes :
-
color_active
: The color of the slider when the mouse clicks and drags the slider. Default:COLOR_ACCENT[]
-
color_active_dimmed
: The color of the slider when the mouse hovers over it. Default:COLOR_ACCENT_DIMMED[]
-
color_inactive
: The color of the slider when it is not interacted with. Default:RGBf(0.94, 0.94, 0.94)
-
horizontal
: Controls if the slider has a horizontal orientation or not. Default:true
-
interval
: The current interval of the slider. Don't set this manually, use the functionset_close_to!
. Default:(0, 0)
-
linewidth
: The width of the slider line Default:15.0
-
range
: The range of values that the slider can pick from. Default:0:0.01:10
-
snap
: Controls if the buttons snap to valid positions or move freely Default:true
-
startvalues
: The start values of the slider or the values that are closest in the slider range. Default:Makie.automatic
Layout attributes :
-
alignmode
: The align mode of the slider in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the slider in its suggested bounding box. Default::center
-
height
: The height setting of the slider. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the slider in its suggested bounding box. Default::center
-
width
: The width setting of the slider. Default:Auto()
IntervalsBetween(n::Int, mirror::Bool = true)
Indicates to create n-1 minor ticks between every pair of adjacent major ticks.
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
Backend independent enums which represent keyboard buttons.
No documentation found.
Summary
struct KeysEvent
Fields
keys :: Set{Makie.Keyboard.Button}
LScene <: Block
Attributes
LScene attributes :
-
show_axis
: Controls the visibility of the 3D axis plot object. Default:true
Layout attributes :
-
alignmode
: The alignment of the scene in its suggested bounding box. Default:Inside()
-
halign
: The horizontal alignment of the scene in its suggested bounding box. Default::center
-
height
: The height setting of the scene. Default:nothing
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the scene in its suggested bounding box. Default::center
-
width
: The width setting of the scene. Default:nothing
Label <: Block
Attributes
Label attributes :
-
color
: The color of the text. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:608 =# @inherit :textcolor :black
-
font
: The font family of the text. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:612 =# @inherit :font "TeX Gyre Heros Makie"
-
justification
: The justification of the text (:left, :right, :center). Default::center
-
lineheight
: The lineheight multiplier for the text. Default:1.0
-
padding
: The extra space added to the sides of the text boundingbox. Default:(0.0f0, 0.0f0, 0.0f0, 0.0f0)
-
rotation
: The counterclockwise rotation of the text in radians. Default:0.0
-
text
: The displayed text string. Default:"Text"
-
textsize
: The font size of the text. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:610 =# @inherit :fontsize 16.0f0
-
visible
: Controls if the text is visible. Default:true
-
word_wrap
: Enable word wrapping to the suggested width of the Label. Default:false
Layout attributes :
-
alignmode
: The align mode of the text in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the text in its suggested boundingbox Default::center
-
height
: The height setting of the text. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the text in its suggested boundingbox Default::center
-
width
: The width setting of the text. Default:Auto()
struct LayoutObservables{G}
T
is the same type parameter of contained
GridContent
,
G
is
GridLayout
which is defined only after
LayoutObservables
.
A collection of
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'swidth
andheight
attributes, this is not necessarily equal to the computedbbox. -
protrusions::Observable{RectSides{Float32}}
: The sizes of content "sticking out" of the main element into theGridLayout
gaps. -
reporteddimensions::Observable{Dimensions}
: The dimensions (inner and outer) that the object communicates to the containingGridLayout
. -
autosize::Observable{NTuple{2, Optional{Float32}}}
: The width and height that the element reports to its parentGridLayout
. 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 tonothing
. -
computedbbox::Observable{Rect2f}
: The bounding box that the element computes for itself after it has received a suggestedbbox. -
gridcontent::Optional{GridContent{G}}
: A reference of aGridContent
if the element is currently placed in aGridLayout
. This can be used to retrieve the parent layout, remove the element from it or change its position, and assign it to a different layout.
No documentation found.
Summary
struct Left
Supertype Hierarchy
Left <: GridLayoutBase.Side <: Any
Legend <: Block
Attributes
Legend attributes :
-
bgcolor
: The background color of the legend. Default::white
-
colgap
: The gap between the label of one legend entry and the patch of the next. Default:16
-
framecolor
: The color of the legend border. Default::black
-
framevisible
: Controls if the legend border is visible. Default:true
-
framewidth
: The line width of the legend border. Default:1.0
-
gridshalign
: The horizontal alignment of entry groups in their parent GridLayout. Default::center
-
gridsvalign
: The vertical alignment of entry groups in their parent GridLayout. Default::center
-
groupgap
: The gap between each group and the next. Default:16
-
label
: The default entry label. Default:"undefined"
-
labelcolor
: The color of the entry labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:968 =# @inherit :textcolor :black
-
labelfont
: The font family of the entry labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:966 =# @inherit :font "TeX Gyre Heros Makie"
-
labelhalign
: The horizontal alignment of the entry labels. Default::left
-
labeljustification
: The justification of the label text. Default isautomatic
, which will set the justification to labelhalign. Default:automatic
-
labelsize
: The font size of the entry labels. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:964 =# @inherit :fontsize 16.0f0
-
labelvalign
: The vertical alignment of the entry labels. Default::center
-
linecolor
: The default line color used for LineElements Default:theme(scene, :linecolor)
-
linepoints
: The default points used for LineElements in normalized coordinates relative to each label patch. Default:[Point2f(0, 0.5), Point2f(1, 0.5)]
-
linestyle
: The default line style used for LineElements Default::solid
-
linewidth
: The default line width used for LineElements. Default:theme(scene, :linewidth)
-
margin
: The additional space between the legend and its suggested boundingbox. Default:(0.0f0, 0.0f0, 0.0f0, 0.0f0)
-
marker
: The default marker for MarkerElements Default:theme(scene, :marker)
-
markercolor
: The default marker color for MarkerElements Default:theme(scene, :markercolor)
-
markerpoints
: The default marker points used for MarkerElements in normalized coordinates relative to each label patch. Default:[Point2f(0.5, 0.5)]
-
markersize
: The default marker size used for MarkerElements. Default:theme(scene, :markersize)
-
markerstrokecolor
: The default marker stroke color used for MarkerElements. Default:theme(scene, :markerstrokecolor)
-
markerstrokewidth
: The default marker stroke width used for MarkerElements. Default:theme(scene, :markerstrokewidth)
-
nbanks
: The number of banks in which the legend entries are grouped. Columns if the legend is vertically oriented, otherwise rows. Default:1
-
orientation
: The orientation of the legend (:horizontal or :vertical). Default::vertical
-
padding
: The additional space between the legend content and the border. Default:(10.0f0, 10.0f0, 8.0f0, 8.0f0)
-
patchcolor
: The color of the patches containing the legend markers. Default::transparent
-
patchlabelgap
: The gap between the patch and the label of each legend entry. Default:5
-
patchsize
: The size of the rectangles containing the legend markers. Default:(20.0f0, 20.0f0)
-
patchstrokecolor
: The color of the border of the patches containing the legend markers. Default::transparent
-
patchstrokewidth
: The line width of the border of the patches containing the legend markers. Default:1.0
-
polycolor
: The default poly color used for PolyElements. Default:theme(scene, :patchcolor)
-
polypoints
: The default poly points used for PolyElements in normalized coordinates relative to each label patch. Default:[Point2f(0, 0), Point2f(1, 0), Point2f(1, 1), Point2f(0, 1)]
-
polystrokecolor
: The default poly stroke color used for PolyElements. Default:theme(scene, :patchstrokecolor)
-
polystrokewidth
: The default poly stroke width used for PolyElements. Default:theme(scene, :patchstrokewidth)
-
rowgap
: The gap between the entry rows. Default:3
-
titlecolor
: The color of the legend titles Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:960 =# @inherit :textcolor :black
-
titlefont
: The font family of the legend group titles. Default:"TeX Gyre Heros Makie Bold"
-
titlegap
: The gap between each group title and its group. Default:8
-
titlehalign
: The horizontal alignment of the legend group titles. Default::center
-
titleposition
: The group title positions relative to their groups. Can be:top
or:left
. Default::top
-
titlesize
: The font size of the legend group titles. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:952 =# @inherit :fontsize 16.0f0
-
titlevalign
: The vertical alignment of the legend group titles. Default::center
-
titlevisible
: Controls if the legend titles are visible. Default:true
Layout attributes :
-
alignmode
: The align mode of the legend in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the legend in its suggested bounding box. Default::center
-
height
: The height setting of the legend. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:automatic
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:automatic
-
valign
: The vertical alignment of the legend in its suggested bounding box. Default::center
-
width
: The width setting of the legend. Default:Auto()
No documentation found.
Summary
abstract type LegendElement
Subtypes
LineElement
MarkerElement
PolyElement
No documentation found.
Summary
struct LegendEntry
Fields
elements :: Vector{LegendElement}
attributes :: Attributes
No documentation found.
Summary
struct LineElement
Fields
attributes :: Attributes
Supertype Hierarchy
LineElement <: LegendElement <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct LineTo
Fields
p :: Point2{Float64}
LinearTicks with ideally a number of
n_ideal
tick marks.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
LogTicks{T}(linear_ticks::T)
Wraps any other tick object. Used to apply a linear tick searching algorithm on a log-transformed interval.
No docstring found for module
Makie
.
Exported names
..
,
@L_str
,
@extract
,
@extractvalue
,
@get_attribute
,
@key_str
,
@lift
,
@recipe
,
ABLines
,
Absolute
,
Absorption
,
AbsorptionRGBA
,
AbstractCamera
,
AbstractPlot
,
AbstractScene
,
Accum
,
AmbientLight
,
Annotations
,
Arc
,
Arrows
,
Aspect
,
Atomic
,
Attributes
,
Auto
,
Axis
,
Axis3
,
Axis3D
,
AxisAspect
,
BBox
,
Band
,
BarPlot
,
BezierPath
,
Billboard
,
Bottom
,
BottomLeft
,
BottomRight
,
Box
,
BoxPlot
,
Button
,
Camera
,
Camera2D
,
Camera3D
,
Circle
,
ClosePath
,
Colorbar
,
Combined
,
Consume
,
ContinuousSurface
,
Contour
,
Contour3d
,
Contourf
,
ConversionTrait
,
CrossBar
,
CurveTo
,
Cycle
,
Cycled
,
DataAspect
,
DataInspector
,
Density
,
DiscreteSurface
,
ECDFPlot
,
EllipticalArc
,
EmptyCamera
,
EnvironmentLight
,
Errorbars
,
Events
,
Exclusively
,
Figure
,
Fixed
,
GridLayout
,
GridLayoutSpec
,
GridPosition
,
GridSubposition
,
HLines
,
HSpan
,
Heatmap
,
Hexbin
,
Hist
,
Image
,
IndexedAbsorptionRGBA
,
Inside
,
IntervalSlider
,
IntervalsBetween
,
IsoValue
,
Keyboard
,
KeysEvent
,
LScene
,
Label
,
LayoutObservables
,
Left
,
Legend
,
LegendElement
,
LegendEntry
,
LineElement
,
LineSegments
,
LineTo
,
LinearTicks
,
Lines
,
LogTicks
,
MakieScreen
,
MarkerElement
,
MaximumIntensityProjection
,
Menu
,
Mesh
,
MeshScatter
,
Mixed
,
Mouse
,
MouseEvent
,
MouseEventTypes
,
MoveTo
,
MultiplesTicks
,
NoConversion
,
Observable
,
OldAxis
,
Outside
,
Pattern
,
Pie
,
Pixel
,
PixelSpace
,
PlotSpec
,
Point
,
Point2
,
Point2f
,
Point3
,
Point3f
,
Point4
,
Point4f
,
PointBased
,
PointLight
,
Poly
,
PolyElement
,
QQNorm
,
QQPlot
,
Quaternion
,
Quaternionf
,
RGBAf
,
RGBf
,
RainClouds
,
Rangebars
,
RaymarchAlgorithm
,
RealVector
,
Record
,
RecordEvents
,
Rect
,
Rect2
,
Rect2f
,
Rect2i
,
Rect3
,
Rect3f
,
Rect3i
,
Rectf
,
Recti
,
Relative
,
Reverse
,
Right
,
SSAO
,
Scatter
,
ScatterLines
,
Scene
,
SceneLike
,
SceneSpace
,
ScrollEvent
,
Series
,
Slider
,
SliderGrid
,
Sphere
,
Spy
,
Stairs
,
Stem
,
Stepper
,
StreamPlot
,
Surface
,
SurfaceLike
,
Text
,
Textbox
,
Theme
,
TimeSeries
,
Toggle
,
Tooltip
,
Top
,
TopLeft
,
TopRight
,
Transformation
,
Tricontourf
,
Unit
,
VLines
,
VSpan
,
Vec
,
Vec2
,
Vec2f
,
Vec3
,
Vec3f
,
Vec4
,
Vec4f
,
VecTypes
,
VideoStream
,
Violin
,
Volume
,
VolumeLike
,
VolumeSlices
,
Waterfall
,
WilkinsonTicks
,
Wireframe
,
abline!
,
ablines
,
ablines!
,
activate_interaction!
,
addmouseevents!
,
annotations
,
annotations!
,
arc
,
arc!
,
arrows
,
arrows!
,
assetpath
,
attributes
,
autolimits!
,
available_gradients
,
axis3d
,
axis3d!
,
axislegend
,
band
,
band!
,
barplot
,
barplot!
,
bottom
,
boundingbox
,
boxplot
,
boxplot!
,
broadcast_foreach
,
cam2d
,
cam2d!
,
cam3d!
,
cam3d_cad!
,
cam_relative!
,
camera
,
cameracontrols
,
cameracontrols!
,
campixel
,
campixel!
,
categorical_colors
,
center!
,
cgrad
,
colgap!
,
colsize!
,
connect!
,
connect_screen
,
content
,
contents
,
contour
,
contour!
,
contour3d
,
contour3d!
,
contourf
,
contourf!
,
convert_arguments
,
convert_attribute
,
crossbar
,
crossbar!
,
current_axis
,
current_axis!
,
current_figure
,
current_figure!
,
data_limits
,
deactivate_interaction!
,
decompose
,
default_theme
,
density
,
density!
,
deregister_interaction!
,
disconnect!
,
dropped_files
,
ecdfplot
,
ecdfplot!
,
entered_window
,
errorbars
,
errorbars!
,
events
,
fill_between!
,
grid!
,
gridnest!
,
hasfocus
,
heatmap
,
heatmap!
,
height
,
help
,
help_arguments
,
help_attributes
,
hexbin
,
hexbin!
,
hgrid!
,
hidedecorations!
,
hidespines!
,
hidexdecorations!
,
hideydecorations!
,
hist
,
hist!
,
hlines
,
hlines!
,
hovered_scene
,
hspan
,
hspan!
,
image
,
image!
,
insertplots!
,
interactions
,
is_mouseinside
,
ispressed
,
keyboard_buttons
,
labelslider!
,
labelslidergrid!
,
left
,
lift
,
limits!
,
lines
,
lines!
,
linesegments
,
linesegments!
,
linkaxes!
,
linkxaxes!
,
linkyaxes!
,
map_once
,
mesh
,
mesh!
,
meshscatter
,
meshscatter!
,
mouse_buttons
,
mouse_position
,
mouse_selection
,
mouseover
,
mouseposition
,
mouseposition_px
,
ncols
,
nrows
,
off
,
old_cam3d!
,
old_cam3d_cad!
,
on
,
onany
,
onmousedownoutside
,
onmouseenter
,
onmouseleftclick
,
onmouseleftdoubleclick
,
onmouseleftdown
,
onmouseleftdrag
,
onmouseleftdragstart
,
onmouseleftdragstop
,
onmouseleftup
,
onmousemiddleclick
,
onmousemiddledoubleclick
,
onmousemiddledown
,
onmousemiddledrag
,
onmousemiddledragstart
,
onmousemiddledragstop
,
onmousemiddleup
,
onmouseout
,
onmouseover
,
onmouserightclick
,
onmouserightdoubleclick
,
onmouserightdown
,
onmouserightdrag
,
onmouserightdragstart
,
onmouserightdragstop
,
onmouserightup
,
onpick
,
pick
,
pie
,
pie!
,
pixelarea
,
plot
,
plot!
,
plotkey
,
plots
,
poly
,
poly!
,
px
,
qqnorm
,
qqnorm!
,
qqplot
,
qqplot!
,
qrotation
,
quiver
,
quiver!
,
rainclouds
,
rainclouds!
,
rangebars
,
rangebars!
,
record
,
record_events
,
recordframe!
,
register_interaction!
,
replace_automatic!
,
replay_events
,
resample_cmap
,
reset_limits!
,
resize_to_layout!
,
right
,
rotate!
,
rotate_cam!
,
rowgap!
,
rowsize!
,
save
,
scale!
,
scatter
,
scatter!
,
scatterlines
,
scatterlines!
,
scroll
,
select_line
,
select_point
,
select_rectangle
,
series
,
series!
,
set_close_to!
,
set_theme!
,
showgradients
,
spy
,
spy!
,
stairs
,
stairs!
,
stem
,
stem!
,
streamplot
,
streamplot!
,
surface
,
surface!
,
swap!
,
text
,
text!
,
theme
,
theme_black
,
theme_dark
,
theme_ggplot2
,
theme_light
,
theme_minimal
,
tight_ticklabel_spacing!
,
tight_xticklabel_spacing!
,
tight_yticklabel_spacing!
,
tightlimits!
,
timeseries
,
timeseries!
,
to_align
,
to_color
,
to_colormap
,
to_font
,
to_ndim
,
to_rotation
,
to_textsize
,
to_value
,
to_vector
,
to_world
,
tooltip
,
tooltip!
,
top
,
translate!
,
translate_cam!
,
translated
,
translation
,
tricontourf
,
tricontourf!
,
trim!
,
unicode_input
,
update_cam!
,
update_theme!
,
used_attributes
,
vgrid!
,
violin
,
violin!
,
vlines
,
vlines!
,
volume
,
volume!
,
volumeslices
,
volumeslices!
,
vspan
,
vspan!
,
waterfall
,
waterfall!
,
width
,
widths
,
window_area
,
window_open
,
wireframe
,
wireframe!
,
with_theme
,
with_updates_suspended
,
xlabel!
,
xlims!
,
xticklabels
,
xtickrange
,
xtickrotation
,
xtickrotation!
,
xticks!
,
ylabel!
,
ylims!
,
yticklabels
,
ytickrange
,
ytickrotation
,
ytickrotation!
,
yticks!
,
zlabel!
,
zlims!
,
zoom!
,
zticklabels
,
ztickrange
,
ztickrotation
,
ztickrotation!
,
zticks!
Displaying contents of readme found at
/home/runner/work/Makie.jl/Makie.jl/README.md
<div align="center"> <img src="https://raw.githubusercontent.com/MakieOrg/Makie.jl/master/assets/makie logo canvas.svg" alt="Makie.jl"> </div>
From the japanese word Maki-e , which is a technique to sprinkle lacquer with gold and silver powder. Data is the gold and silver of our age, so let's spread it out beautifully on the screen!
Check out the documentation here!
[![][docs-stable-img]][docs-stable-url] [![][docs-master-img]][docs-master-url]
[gitlab-img]: https://gitlab.com/JuliaGPU/Makie.jl/badges/master/pipeline.svg [gitlab-url]: https://gitlab.com/JuliaGPU/Makie.jl/pipelines [docs-stable-img]: https://img.shields.io/badge/docs-stable-lightgrey.svg [docs-stable-url]: http://docs.makie.org/stable/ [docs-master-img]: https://img.shields.io/badge/docs-master-blue.svg [docs-master-url]: http://docs.makie.org/dev/
Citing Makie
If you use Makie for a scientific publication, please cite our JOSS paper the following way:
Danisch & Krumbiegel, (2021). Makie.jl: Flexible high-performance data visualization for Julia. Journal of Open Source Software, 6(65), 3349, https://doi.org/10.21105/joss.03349
BibTeX entry:
@article{DanischKrumbiegel2021,
doi = {10.21105/joss.03349},
url = {https://doi.org/10.21105/joss.03349},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {65},
pages = {3349},
author = {Simon Danisch and Julius Krumbiegel},
title = {Makie.jl: Flexible high-performance data visualization for Julia},
journal = {Journal of Open Source Software}
}
Installation
Please consider using the backends directly. As explained in the documentation, they re-export all of Makie's functionality. So, instead of installing Makie, just install e.g. GLMakie directly:
julia>]
pkg> add GLMakie
You may check the installed version with:
]st GLMakie
Start using the package:
using GLMakie
Developing Makie
Makie and its backends all live in the Makie monorepo. This makes it easier to change code across all packages. Therefore, dev'ing Makie almost works as with other Julia packages, just, that one needs to also dev the sub packages:
]dev --local Makie # local will clone the repository at ./dev/Makie
]dev dev/Makie/MakieCore dev/Makie/GLMakie dev/Makie/CairoMakie dev/Makie/WGLMakie dev/Makie/RPRMakie
To run the tests, you also should add:
]dev dev/Makie/ReferenceTests
For more info about ReferenceTests, check out its README
Quick start
The following examples are supposed to be self-explanatory. For further information check out the documentation!
A simple parabola
x = 1:10
fig = lines(x, x.^2; label = "Parabola")
axislegend()
save("./assets/parabola.png", fig, resolution = (600, 400))
fig
<img src="./assets/parabola.png">
A more complex plot with unicode characters and LaTeX strings:
Similar to the one on this link
x = -2pi:0.1:2pi
approx = fill(0.0, length(x))
set_theme!(palette = (; patchcolor = cgrad(:Egypt, alpha=0.65)))
fig, axis, lineplot = lines(x, sin.(x); label = L"sin(x)", linewidth = 3, color = :black,
axis = (; title = "Polynomial approximation of sin(x)",
xgridstyle = :dash, ygridstyle = :dash,
xticksize = 10, yticksize = 10, xtickalign = 1, ytickalign = 1,
xticks = (-π:π/2:π, ["π", "-π/2", "0", "π/2", "π"])
))
translate!(lineplot, 0, 0, 2) # move line to foreground
band!(x, sin.(x), approx .+= x; label = L"n = 0")
band!(x, sin.(x), approx .+= -x .^ 3 / 6; label = L"n = 1")
band!(x, sin.(x), approx .+= x .^ 5 / 120; label = L"n = 2")
band!(x, sin.(x), approx .+= -x .^ 7 / 5040; label = L"n = 3")
limits!(-3.8, 3.8, -1.5, 1.5)
axislegend(; position = :ct, bgcolor = (:white, 0.75), framecolor = :orange)
save("./assets/approxsin.png", fig, resolution = (600, 400))
fig
<img src="./assets/approxsin.png">
Simple layout: Heatmap, contour and 3D surface plot
x = y = -5:0.5:5
z = x .^ 2 .+ y' .^ 2
set_theme!(colormap = :Hiroshige)
fig = Figure()
ax3d = Axis3(fig[1, 1]; aspect = (1, 1, 1),
perspectiveness = 0.5, azimuth = 2.19, elevation = 0.57)
ax2d = Axis(fig[1, 2]; aspect = 1)
pltobj = surface!(ax3d, x, y, z; transparency = true)
heatmap!(ax2d, x, y, z; colormap = (:Hiroshige, 0.5))
contour!(ax2d, x, y, z; linewidth = 2, levels = 12, color = :black)
contour3d!(ax3d, x, y, z; linewidth = 4, levels = 12,
transparency = true)
Colorbar(fig[1, 3], pltobj)
colsize!(fig.layout, 1, Aspect(1, 1.0))
colsize!(fig.layout, 2, Aspect(1, 1.0))
resize_to_layout!(fig)
save("./assets/simpleLayout.png", fig)
fig
<img src="./assets/simpleLayout.png">
⚠️WARNING⚠️. Don't forget to reset to the default Makie settings by doing
set_theme!()
.
Interactive example by AlexisRenchon :
Example from InteractiveChaos.jl
You can follow Makie on twitter to get the latest, outstanding examples:
Sponsors
<img src="https://github.com/MakieOrg/Makie.jl/blob/master/assets/BMBF gefoerdert 2017_en.jpg?raw=true" width="300"/> Förderkennzeichen: 01IS10S27, 2020
Screen constructors implemented by all backends:
# Constructor aimed at showing the plot in a window.
Screen(scene::Scene; screen_config...)
# Screen to save a png/jpeg to file or io
Screen(scene::Scene, io::IO, mime; screen_config...)
# Screen that is efficient for `colorbuffer(screen, format)`
Screen(scene::Scene, format::Makie.ImageStorageFormat; screen_config...)
Interface implemented by all backends:
# Needs to be overload:
size(screen) # Size in pixel
empty!(screen) # empties screen state to reuse the screen, or to close it
# Optional
wait(screen) # waits as long window is open
# Provided by Makie:
push_screen!(scene, screen)
No documentation found.
Summary
struct MarkerElement
Fields
attributes :: Attributes
Supertype Hierarchy
MarkerElement <: LegendElement <: Any
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
Menu <: Block
A drop-down menu with multiple selectable options. You can pass options with the keyword argument
options
.
Options are given as an iterable of elements. For each element, the option label in the menu is determined with
optionlabel(element)
and the option value with
optionvalue(element)
. These functions can be overloaded for custom types. The default is that tuples of two elements are expected to be label and value, where
string(label)
is used as the label, while for all other objects, label =
string(object)
and value = object.
When an item is selected in the menu, the menu's
selection
attribute is set to
optionvalue(selected_element)
. When nothing is selected, that value is
nothing
.
You can set the initial selection by passing one of the labels with the
default
keyword.
Constructors
Menu(fig_or_scene; default = nothing, kwargs...)
Examples
Menu with string entries, second preselected:
menu1 = Menu(fig[1, 1], options = ["first", "second", "third"], default = "second")
Menu with two-element entries, label and function:
funcs = [sin, cos, tan]
labels = ["Sine", "Cosine", "Tangens"]
menu2 = Menu(fig[1, 1], options = zip(labels, funcs))
Executing a function when a selection is made:
on(menu2.selection) do selected_function
# do something with the selected function
end
Attributes
Menu attributes :
-
cell_color_active
: Cell color when active Default:COLOR_ACCENT[]
-
cell_color_hover
: Cell color when hovered Default:COLOR_ACCENT_DIMMED[]
-
cell_color_inactive_even
: Cell color when inactive even Default:RGBf(0.97, 0.97, 0.97)
-
cell_color_inactive_odd
: Cell color when inactive odd Default:RGBf(0.97, 0.97, 0.97)
-
direction
: The opening direction of the menu (:up or :down) Default:automatic
-
dropdown_arrow_color
: Color of the dropdown arrow Default:(:black, 0.2)
-
dropdown_arrow_size
: Size of the dropdown arrow Default:20
-
i_selected
: Index of selected item. Should not be set by the user. Default:0
-
is_open
: Is the menu showing the available options Default:false
-
options
: The list of options selectable in the menu. This can be any iterable of a mixture of strings and containers with one string and one other value. If an entry is just a string, that string is both label and selection. If an entry is a container with one string and one other value, the string is the label and the other value is the selection. Default:["no options"]
-
prompt
: The default message prompting a selection when i == 0 Default:"Select..."
-
selection
: Selected item value. This is the output observable that you should listen to to react to menu interaction. Should not be set by the user. Default:nothing
-
selection_cell_color_inactive
: Selection cell color when inactive Default:RGBf(0.94, 0.94, 0.94)
-
textcolor
: Color of entry texts Default::black
-
textpadding
: Padding of entry texts Default:(10, 10, 10, 10)
-
textsize
: Font size of the cell texts Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:897 =# @inherit :fontsize 16.0f0
Layout attributes :
-
alignmode
: The alignment of the menu in its suggested bounding box. Default:Inside()
-
halign
: The horizontal alignment of the menu in its suggested bounding box. Default::center
-
height
: The height setting of the menu. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the menu in its suggested bounding box. Default::center
-
width
: The width setting of the menu. Default:nothing
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
AlignMode that is Inside where padding is Nothing, Outside where it is Real, and overrides the protrusion with a fixed value where it is a
Protrusion
.
Backend independent enums and fields which represent mouse actions.
MouseEvent
Describes a mouse state change. Fields:
-
type
: MouseEventType -
t
: Time of the event -
data
: Mouse position in data coordinates -
px
: Mouse position in px relative to scene origin -
prev_t
: Time of previous event -
prev_data
: Previous mouse position in data coordinates -
prev_px
: Previous mouse position in data coordinates
No docstring or readme file found for module
Makie.MouseEventTypes
.
Exported names
MouseEventType
No documentation found.
Summary
struct MoveTo
Fields
p :: Point2{Float64}
Like LinearTicks but for multiples of
multiple
. Example where approximately 5 numbers should be found that are multiples of pi, printed like "1π", "2π", etc.:
MultiplesTicks(5, pi, "π")
No documentation found.
Summary
struct NoConversion
Supertype Hierarchy
NoConversion <: ConversionTrait <: Any
No documentation found.
Summary
struct OldAxis
AlignMode that includes the protrusions within the bounding box, plus paddings.
Pattern(image)
Pattern(mask[; color1, color2])
Creates an
ImagePattern
from an
image
(a matrix of colors) or a
mask
(a matrix of real numbers). The pattern can be passed as a
color
to a plot to texture it. If a
mask
is passed, one can specify to colors between which colors are interpolated.
Pattern(style::String = "/"; kwargs...)
Pattern(style::Char = '/'; kwargs...)
Creates a line pattern based on the given argument. Available patterns are
'/'
,
'\'
,
'-'
,
'|'
,
'x'
, and
'+'
. All keyword arguments correspond to the keyword arguments for
LinePattern
.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the
:pixel
camera type.
Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the
:pixel
camera type.
PlotSpec{P<:AbstractPlot}(args...; kwargs...)
Object encoding positional arguments (
args
), a
NamedTuple
of attributes (
kwargs
) as well as plot type
P
of a basic plot.
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Point{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Point{S, T} <: GeometryBasics.AbstractPoint{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct PointBased
Supertype Hierarchy
PointBased <: ConversionTrait <: Any
A positional point light, shining at a certain color. Color values can be bigger than 1 for brighter lights.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct PolyElement
Fields
attributes :: Attributes
Supertype Hierarchy
PolyElement <: LegendElement <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Quaternion{T}
Fields
data :: NTuple{4, T}
No documentation found.
Summary
struct Quaternion{T}
Fields
data :: NTuple{4, T}
No documentation found.
Summary
struct ColorTypes.RGBA{T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}}
Fields
r :: T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}
g :: T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}
b :: T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}
alpha :: T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}
Supertype Hierarchy
ColorTypes.RGBA{T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}} <: ColorTypes.ColorAlpha{ColorTypes.RGB{T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}}, T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}, 4} <: ColorTypes.TransparentColor{ColorTypes.RGB{T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}}, T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}, 4} <: ColorTypes.Colorant{T<:Union{AbstractFloat, FixedPointNumbers.FixedPoint}, 4} <: Any
RGB
is the standard Red-Green-Blue (sRGB) colorspace. Values of the individual color channels range from 0 (black) to 1 (saturated). If you want "Integer" storage types (e.g., 255 for full color), use
N0f8(1)
instead (see FixedPointNumbers).
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
primitive type RaymarchAlgorithm
Supertype Hierarchy
RaymarchAlgorithm <: Enum{Int32} <: Any
AbstractArray{T,N}
Supertype for
N
-dimensional arrays (or array-like types) with elements of type
T
.
Array
and other types are subtypes of this. See the manual section on the
AbstractArray
interface
.
See also:
AbstractVector
,
AbstractMatrix
,
eltype
,
ndims
.
Record(func, figlike, [iter]; kw_args...)
Check
Makie.record
for documentation.
No documentation found.
Summary
struct RecordEvents
Fields
scene :: Scene
path :: String
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
HyperRectangle{N, T}
A
HyperRectangle
is a generalization of a rectangle into N-dimensions. Formally it is the cartesian product of intervals, which is represented by the
origin
and
widths
fields, whose indices correspond to each of the
N
axes.
No documentation found.
Summary
struct Relative
Fields
x :: Float32
Reverses the attribute T upon conversion
No documentation found.
Summary
struct Right
Supertype Hierarchy
Right <: GridLayoutBase.Side <: Any
No documentation found.
Summary
struct SSAO
Fields
radius :: Observable{Float32}
bias :: Observable{Float32}
blur :: Observable{Int32}
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Scene TODO document this
Constructors
Fields
-
parent
The parent of the Scene; if it is a top-level Scene,
parent == nothing
. -
events
Events
associated with the Scene. -
px_area
The current pixel area of the Scene.
-
clear
Whether the scene should be cleared.
-
camera
The
Camera
associated with the Scene. -
camera_controls
The controls for the camera of the Scene.
-
transformation
The
Transformation
of the Scene. -
plots
The plots contained in the Scene.
-
theme
-
children
Children of the Scene inherit its transformation.
-
current_screens
The Screens which the Scene is displayed to.
-
backgroundcolor
-
visible
-
ssao
-
lights
Union{Types...}
A type union is an abstract type which includes all instances of any of its argument types. The empty union
Union{}
is the bottom type of Julia.
Examples
julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}
julia> 1 :: IntOrString
1
julia> "Hello!" :: IntOrString
"Hello!"
julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64
Unit space of the scene it's displayed on. Also referred to as data units
No documentation found.
Summary
struct ScrollEvent
Fields
x :: Float32
y :: Float32
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Slider <: Block
Attributes
Slider attributes :
-
color_active
: The color of the slider when the mouse clicks and drags the slider. Default:COLOR_ACCENT[]
-
color_active_dimmed
: The color of the slider when the mouse hovers over it. Default:COLOR_ACCENT_DIMMED[]
-
color_inactive
: The color of the slider when it is not interacted with. Default:RGBf(0.94, 0.94, 0.94)
-
horizontal
: Controls if the slider has a horizontal orientation or not. Default:true
-
linewidth
: The width of the slider line Default:15
-
range
: The range of values that the slider can pick from. Default:0:0.01:10
-
snap
: Controls if the button snaps to valid positions or moves freely Default:true
-
startvalue
: The start value of the slider or the value that is closest in the slider range. Default:0
-
value
: The current value of the slider. Don't set this manually, use the functionset_close_to!
. Default:0
Layout attributes :
-
alignmode
: The align mode of the slider in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the element in its suggested bounding box. Default::center
-
height
: The height setting of the element. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the element in its suggested bounding box. Default::center
-
width
: The width setting of the element. Default:Auto()
SliderGrid <: Block
A grid of horizontal
Slider
s, where each slider has one name label on the left, and a value label on the right.
Each
NamedTuple
you pass specifies one
Slider
. You always have to pass
range
and
label
, and optionally a
format
for the value label. Beyond that, you can set any keyword that
Slider
takes, such as
startvalue
.
The
format
keyword can be a
String
with Formatting.jl style, such as "{:.2f}Hz", or a function.
Constructors
SliderGrid(fig_or_scene, nts::NamedTuple...; kwargs...)
Examples
sg = SliderGrid(fig[1, 1],
(label = "Amplitude", range = 0:0.1:10, startvalue = 5),
(label = "Frequency", range = 0:0.5:50, format = "{:.1f}Hz", startvalue = 10),
(label = "Phase", range = 0:0.01:2pi,
format = x -> string(round(x/pi, digits = 2), "π"))
)
Working with slider values:
on(sg.sliders[1].value) do val
# do something with `val`
end
Attributes
SliderGrid attributes :
-
value_column_width
: The width of the value label column. Ifautomatic
, the width is determined by sampling a few values from the slider ranges and picking the largest label size found. Default:automatic
Layout attributes :
-
alignmode
: The align mode of the block in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the block in its suggested bounding box. Default::center
-
height
: The height setting of the block. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this block's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this block's width Default:true
-
valign
: The vertical alignment of the block in its suggested bounding box. Default::center
-
width
: The width setting of the block. Default:Auto()
HyperSphere{N, T}
A
HyperSphere
is a generalization of a sphere into N-dimensions. A
center
and radius,
r
, must be specified.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Makie.Stepper
is a
Function
.
# 3 methods for generic function "Stepper":
[1] Stepper(figlike::Union{Figure, Makie.FigureAxisPlot, Scene}; backend, format, visible, connect, srceen_kw...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/recording.jl:29
[2] Stepper(figlike::Union{Figure, Makie.FigureAxisPlot, Scene}, path::String; kw...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/recording.jl:41
[3] Stepper(figlike::Union{Figure, Makie.FigureAxisPlot, Scene}, path::String, step::Int64; format, backend, visible, connect, screen_config...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/recording.jl:35
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
abstract type SurfaceLike
Subtypes
ContinuousSurface
DiscreteSurface
Supertype Hierarchy
SurfaceLike <: ConversionTrait <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Textbox <: Block
Attributes
Textbox attributes :
-
bordercolor
: Color of the box border. Default:RGBf(0.8, 0.8, 0.8)
-
bordercolor_focused
: Color of the box border when focused. Default:COLOR_ACCENT[]
-
bordercolor_focused_invalid
: Color of the box border when focused and invalid. Default:RGBf(1, 0, 0)
-
bordercolor_hover
: Color of the box border when hovered. Default:COLOR_ACCENT_DIMMED[]
-
borderwidth
: Width of the box border. Default:2.0
-
boxcolor
: Color of the box. Default::transparent
-
boxcolor_focused
: Color of the box when focused. Default::transparent
-
boxcolor_focused_invalid
: Color of the box when focused. Default:RGBAf(1, 0, 0, 0.3)
-
boxcolor_hover
: Color of the box when hovered. Default::transparent
-
cornerradius
: Corner radius of text box. Default:8
-
cornersegments
: Corner segments of one rounded corner. Default:20
-
cursorcolor
: The color of the cursor. Default::transparent
-
defocus_on_submit
: Controls if the textbox is defocused when a string is submitted. Default:true
-
displayed_string
: The currently displayed string (for internal use). Default:nothing
-
focused
: If the textbox is focused and receives text input. Default:false
-
font
: Font family. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1105 =# @inherit :font "TeX Gyre Heros Makie"
-
placeholder
: A placeholder text that is displayed when the saved string is nothing. Default:"Click to edit..."
-
reset_on_defocus
: Controls if the displayed text is reset to the stored text when defocusing the textbox without submitting. Default:false
-
restriction
: Restricts the allowed unicode input via is_allowed(char, restriction). Default:nothing
-
stored_string
: The currently stored string. Default:nothing
-
textcolor
: Text color. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1101 =# @inherit :textcolor :black
-
textcolor_placeholder
: Text color for the placeholder. Default:RGBf(0.5, 0.5, 0.5)
-
textpadding
: Padding of the text against the box. Default:(10, 10, 10, 10)
-
textsize
: Text size. Default:#= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1099 =# @inherit :fontsize 16.0f0
-
validator
: Validator that is called with validate_textbox(string, validator) to determine if the current string is valid. Can by default be a RegEx that needs to match the complete string, or a function taking a string as input and returning a Bool. If the validator is a type T (for example Float64), validation will betryparse(string, T)
. Default:str->begin #= /home/runner/work/Makie.jl/Makie.jl/src/makielayout/types.jl:1133 =# true end
Layout attributes :
-
alignmode
: The alignment of the textbox in its suggested bounding box. Default:Inside()
-
halign
: The horizontal alignment of the textbox in its suggested bounding box. Default::center
-
height
: The height setting of the textbox. Default:Auto()
-
tellheight
: Controls if the parent layout can adjust to this element's height. Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width. Default:true
-
valign
: The vertical alignment of the textbox in its suggested bounding box. Default::center
-
width
: The width setting of the textbox. Default:Auto()
Main structure for holding attributes, for theming plots etc! Will turn all values into observables, so that they can be updated.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
Toggle <: Block
Attributes
Toggle attributes :
-
active
: Indicates if the toggle is active or not. Default:false
-
buttoncolor
: The color of the toggle button. Default:COLOR_ACCENT[]
-
cornersegments
: The number of poly segments in each rounded corner. Default:15
-
framecolor_active
: The color of the border when the toggle is hovered. Default:COLOR_ACCENT_DIMMED[]
-
framecolor_inactive
: The color of the border when the toggle is inactive. Default:RGBf(0.94, 0.94, 0.94)
-
rimfraction
: The border width as a fraction of the toggle height Default:0.33
-
toggleduration
: The duration of the toggle animation. Default:0.15
Layout attributes :
-
alignmode
: The align mode of the toggle in its parent GridLayout. Default:Inside()
-
halign
: The horizontal alignment of the toggle in its suggested bounding box. Default::center
-
height
: The height of the toggle. Default:28
-
tellheight
: Controls if the parent layout can adjust to this element's height Default:true
-
tellwidth
: Controls if the parent layout can adjust to this element's width Default:true
-
valign
: The vertical alignment of the toggle in its suggested bounding box. Default::center
-
width
: The width of the toggle. Default:60
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Top
Supertype Hierarchy
Top <: GridLayoutBase.Side <: Any
No documentation found.
Summary
struct TopLeft
Supertype Hierarchy
TopLeft <: GridLayoutBase.Side <: Any
No documentation found.
Summary
struct TopRight
Supertype Hierarchy
TopRight <: GridLayoutBase.Side <: Any
Holds the transformations for Scenes.
Fields
-
parent::Base.RefValue{Transformation}
-
translation::Observable{Vec{3, Float32}}
-
scale::Observable{Vec{3, Float32}}
-
rotation::Observable{Quaternionf}
-
model::Observable{StaticArraysCore.SMatrix{4, 4, Float32, 16}}
-
transform_func::Observable{Any}
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
abstract type Unit{T}
Subtypes
Makie.DeviceIndependentPixel{T<:Number}
Makie.Millimeter{T}
Pixel{T}
SceneSpace{T}
Supertype Hierarchy
Unit{T} <: Number <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
No documentation found.
Summary
struct Vec{S, T}
Fields
data :: Tuple{Vararg{T, S}}
Supertype Hierarchy
Vec{S, T} <: StaticArraysCore.StaticArray{Tuple{S}, T, 1} <: AbstractArray{T, 1} <: Any
Union{Types...}
A type union is an abstract type which includes all instances of any of its argument types. The empty union
Union{}
is the bottom type of Julia.
Examples
julia> IntOrString = Union{Int,AbstractString}
Union{Int64, AbstractString}
julia> 1 :: IntOrString
1
julia> "Hello!" :: IntOrString
"Hello!"
julia> 1.0 :: IntOrString
ERROR: TypeError: in typeassert, expected Union{Int64, AbstractString}, got a value of type Float64
VideoStream(fig::FigureLike;
format="mp4", framerate=24, compression=nothing, profile=nothing, pixel_format=nothing, loglevel="quiet",
visible=false, connect=false, backend=current_backend(),
screen_config...)
Returns a
VideoStream
which can pipe new frames into the ffmpeg process with few allocations via
recordframe!(stream)
. When done, use
save(path, stream)
to write the video out to a file.
Arguments
Video options
-
format = "mkv"
: The format of the video. If a path is present, will be inferred form the file extension. Can be one of the following:-
"mkv"
(open standard, the default) -
"mp4"
(good for Web, most supported format) -
"webm"
(smallest file size) -
"gif"
(largest file size for the same quality)
mp4
andmk4
are marginally bigger thanwebm
.gif
s can be significantly (as much as 6x) larger with worse quality (due to the limited color palette) and only should be used as a last resort, for playing in a context where videos aren't supported. -
-
framerate = 24
: The target framerate. -
compression = 20
: Controls the video compression viaffmpeg
's-crf
option, with smaller numbers giving higher quality and larger file sizes (lower compression), and and higher numbers giving lower quality and smaller file sizes (higher compression). The minimum value is0
(lossless encoding).-
For
mp4
,51
is the maximum. Note thatcompression = 0
only works withmp4
if
profile = high444
.-
For
webm
,63
is the maximum. -
compression
has no effect onmkv
andgif
outputs.
-
-
profile = "high422"
: A ffmpeg compatible profile. Currently only applies tomp4
. 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
.
!!! warning
`profile` and `pixel_format` are only used when `format` is `"mp4"`; a warning will be issued if `format`
is not `"mp4"` and those two arguments are not `nothing`. Similarly, `compression` is only
valid when `format` is `"mp4"` or `"webm"`.
Backend options
-
backend=current_backend()
: backend used to record frames -
visible=false
: make window visible or not -
connect=false
: connect window events or not -
screen_config...
: See?Backend.Screen
orBase.doc(Backend.Screen)
for applicable options that can be passed and forwarded to the backend.
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct VolumeLike
Supertype Hierarchy
VolumeLike <: ConversionTrait <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Summary
struct WilkinsonTicks
Fields
k_ideal :: Int64
k_min :: Int64
k_max :: Int64
Q :: Vector{Tuple{Float64, Float64}}
granularity_weight :: Float64
simplicity_weight :: Float64
coverage_weight :: Float64
niceness_weight :: Float64
min_px_dist :: Float64
No documentation found.
Summary
struct Combined{Typ, T}
Fields
parent :: Union{AbstractScene, MakieCore.ScenePlot}
transformation :: MakieCore.Transformable
attributes :: Attributes
input_args :: Tuple
converted :: Tuple
plots :: Vector{AbstractPlot}
Supertype Hierarchy
Combined{Typ, T} <: MakieCore.ScenePlot{Typ} <: AbstractPlot{Typ} <: MakieCore.Transformable <: Any
No documentation found.
Makie.abline!
is a
Function
.
# 1 method for generic function "abline!":
[1] abline!(args...; kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/basic_recipes/ablines.jl:49
ablines(intercepts, slopes; attrs...)
Creates a line defined by
f(x) = slope * x + intercept
crossing a whole
Scene
with 2D projection at its current limits. You can pass one or multiple intercepts or slopes.
All style attributes are the same as for
LineSegments
.
ablines(intercepts, slopes; attrs...)
Creates a line defined by
f(x) = slope * x + intercept
crossing a whole
Scene
with 2D projection at its current limits. You can pass one or multiple intercepts or slopes.
All style attributes are the same as for
LineSegments
.
activate_interaction!(parent, name::Symbol)
Activate the interaction named
name
registered in
parent
.
addmouseevents!(scene, elements...)
Returns a
MouseEventHandle
with an observable inside which is triggered by all mouse interactions with the
scene
and optionally restricted to all given plot objects in
elements
.
To react to mouse events, use the onmouse... handlers.
Example:
mouseevents = addmouseevents!(scene, scatterplot)
onmouseleftclick(mouseevents) do event
# do something with the mouseevent
end
annotations(strings::Vector{String}, positions::Vector{Point})
Plots an array of texts at each position in
positions
.
Attributes
Available attributes and their defaults for
Combined{Makie.annotations}
are:
align (:left, :bottom)
color :black
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
font "TeX Gyre Heros Makie"
inspectable true
justification MakieCore.Automatic()
lineheight 1.0
linewidth 1
markerspace :pixel
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
offset (0.0, 0.0)
overdraw false
position (0.0, 0.0)
rotation 0.0
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
strokecolor (:black, 0.0)
strokewidth 0
textsize 20
transparency false
visible true
word_wrap_width -1
annotations(strings::Vector{String}, positions::Vector{Point})
Plots an array of texts at each position in
positions
.
Attributes
Available attributes and their defaults for
Combined{Makie.annotations!}
are:
arc(origin, radius, start_angle, stop_angle; kwargs...)
This function plots a circular arc, centered at
origin
with radius
radius
, from
start_angle
to
stop_angle
.
origin
must be a coordinate in 2 dimensions (i.e., a
Point2
); the rest of the arguments must be
<: Number
.
Examples:
arc(Point2f(0), 1, 0.0, π)
arc(Point2f(1, 2), 0.3. π, -π)
Attributes
Available attributes and their defaults for
Combined{Makie.arc}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
linestyle "nothing"
linewidth 1.5
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
resolution 361
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
arc(origin, radius, start_angle, stop_angle; kwargs...)
This function plots a circular arc, centered at
origin
with radius
radius
, from
start_angle
to
stop_angle
.
origin
must be a coordinate in 2 dimensions (i.e., a
Point2
); the rest of the arguments must be
<: Number
.
Examples:
arc(Point2f(0), 1, 0.0, π)
arc(Point2f(1, 2), 0.3. π, -π)
Attributes
Available attributes and their defaults for
Combined{Makie.arc!}
are:
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)
Plots arrows at the specified points with the specified components.
u
and
v
are interpreted as vector components (
u
being the x and
v
being the y), and the vectors are plotted with the tails at
x
,
y
.
If
x, y, u, v
are
<: AbstractVector
, then each 'row' is plotted as a single vector.
If
u, v
are
<: AbstractMatrix
, then
x
and
y
are interpreted as specifications for a grid, and
u, v
are plotted as arrows along the grid.
arrows
can also work in three dimensions.
Attributes
Available attributes and their defaults for
Arrows
are:
align :origin
arrowcolor MakieCore.Automatic()
arrowhead MakieCore.Automatic()
arrowsize MakieCore.Automatic()
arrowtail MakieCore.Automatic()
color :black
colormap :viridis
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
lengthscale 1.0f0
linecolor MakieCore.Automatic()
linestyle "nothing"
linewidth MakieCore.Automatic()
markerspace :pixel
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
normalize false
overdraw false
quality 32
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
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:278
No documentation found.
MakieCore.attributes
is a
Function
.
# 1 method for generic function "attributes":
[1] attributes(x::Attributes) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/attributes.jl:33
autolimits!(la::Axis)
Reset manually specified limits of
la
to an automatically determined rectangle, that depends on the data limits of all plot objects in the axis, as well as the autolimit margins for x and y axis.
available_gradients()
Prints all available gradient names.
axis3d(args; attributes...)
Plots a 3-dimensional OldAxis.
Attributes
OldAxis attributes and their defaults for
Combined{Makie.axis3d}
are:
showaxis: (true, true, true)
showgrid: (true, true, true)
padding: 0.1
visible: true
ticks:
rotation: (-0.7071067811865475 + -0.0im + -0.0jm - 0.7071067811865476km, -4.371139e-8 + 0.0im + 0.0jm + 1.0km, -3.090861907263062e-8 + 3.090861907263061e-8im + 0.7071067811865475jm + 0.7071067811865476km)
font: ("TeX Gyre Heros Makie", "TeX Gyre Heros Makie", "TeX Gyre Heros Makie")
ranges_labels: (MakieCore.Automatic(), MakieCore.Automatic())
formatter: plain
textcolor: (RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.6f0))
align: ((:left, :center), (:right, :center), (:right, :center))
textsize: (5, 5, 5)
gap: 3
frame:
axiscolor: (:black, :black, :black)
axislinewidth: (1.5, 1.5, 1.5)
linewidth: (1, 1, 1)
linecolor: (RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0), RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.4f0))
names:
axisnames: ("x", "y", "z")
rotation: (-0.7071067811865475 + -0.0im + -0.0jm - 0.7071067811865476km, -4.371139e-8 + 0.0im + 0.0jm + 1.0km, -3.090861907263062e-8 + 3.090861907263061e-8im + 0.7071067811865475jm + 0.7071067811865476km)
font: ("TeX Gyre Heros Makie", "TeX Gyre Heros Makie", "TeX Gyre Heros Makie")
textcolor: (:black, :black, :black)
align: ((:left, :center), (:right, :center), (:right, :center))
textsize: (6.0, 6.0, 6.0)
gap: 3
inspectable: false
showticks: (true, true, true)
scale: Float32[1.0, 1.0, 1.0]
axis3d!(args; attributes...)
Plots a 3-dimensional OldAxis.
Attributes
Available attributes and their defaults for
Combined{Makie.axis3d!}
are:
axislegend(ax, args...; position = :rt, kwargs...)
axislegend(ax, args...; position = (1, 1), kwargs...)
axislegend(ax = current_axis(); kwargs...)
axislegend(title::AbstractString; kwargs...)
Create a legend that sits inside an Axis's plot area.
The position can be a Symbol where the first letter controls the horizontal alignment and can be l, r or c, and the second letter controls the vertical alignment and can be t, b or c. Or it can be a tuple where the first element is set as the Legend's halign and the second element as its valign.
With the keywords merge and unique you can control how plot objects with the same labels are treated. If merge is true, all plot objects with the same label will be layered on top of each other into one legend entry. If unique is true, all plot objects with the same plot type and label will be reduced to one occurrence.
band(x, ylower, yupper; kwargs...)
band(lower, upper; kwargs...)
Plots a band from
ylower
to
yupper
along
x
. The form
band(lower, upper)
plots a
ruled surface
between the points in
lower
and
upper
.
Attributes
Available attributes and their defaults for
Combined{Makie.band}
are:
backlight 0.0f0
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color => :patchcolor]
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
highclip MakieCore.Automatic()
inspectable true
interpolate true
linewidth 1
lowclip MakieCore.Automatic()
nan_color :transparent
overdraw false
shading false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
band(x, ylower, yupper; kwargs...)
band(lower, upper; kwargs...)
Plots a band from
ylower
to
yupper
along
x
. The form
band(lower, upper)
plots a
ruled surface
between the points in
lower
and
upper
.
Attributes
Available attributes and their defaults for
Combined{Makie.band!}
are:
barplot(x, y; kwargs...)
Plots a barplot;
y
defines the height.
x
and
y
should be 1 dimensional. Bar width is determined by the attribute
width
, shrunk by
gap
in the following way:
width -> width * (1 - gap)
.
Attributes
Available attributes and their defaults for
Combined{Makie.barplot}
are:
bar_labels "nothing"
color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
color_over_background MakieCore.Automatic()
color_over_bar MakieCore.Automatic()
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color => :patchcolor]
direction :y
dodge MakieCore.Automatic()
dodge_gap 0.03
fillto MakieCore.Automatic()
flip_labels_at Inf
gap 0.2
highclip MakieCore.Automatic()
inspectable true
label_color :black
label_font "TeX Gyre Heros Makie"
label_formatter Makie.bar_label_formatter
label_offset 5
label_rotation 0.0
label_size 20
lowclip MakieCore.Automatic()
marker GeometryBasics.HyperRectangle
n_dodge MakieCore.Automatic()
nan_color :transparent
offset 0.0
stack MakieCore.Automatic()
strokecolor :black
strokewidth 0
transparency false
visible true
width MakieCore.Automatic()
barplot(x, y; kwargs...)
Plots a barplot;
y
defines the height.
x
and
y
should be 1 dimensional. Bar width is determined by the attribute
width
, shrunk by
gap
in the following way:
width -> width * (1 - gap)
.
Attributes
Available attributes and their defaults for
Combined{Makie.barplot!}
are:
No documentation found.
Makie.bottom
is a
Function
.
# 1 method for generic function "bottom":
[1] bottom(rect::Rect2) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:4
No documentation found.
Makie.boundingbox
is a
Function
.
# 8 methods for generic function "boundingbox":
[1] boundingbox(glyphcollection::Makie.GlyphCollection, position::Point{3, Float32}, rotation::Quaternion) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:51
[2] boundingbox(glyphcollection::Makie.GlyphCollection, rotation::Quaternion) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:55
[3] boundingbox(layouts::AbstractArray{<:Makie.GlyphCollection}, positions, rotations) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:76
[4] boundingbox(x::MakieCore.Text{<:Tuple{var"#s873"} where var"#s873"<:Makie.GlyphCollection}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:93
[5] boundingbox(x::MakieCore.Text{<:Tuple{var"#s873"} where var"#s873"<:(AbstractArray{<:Makie.GlyphCollection})}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:104
[6] boundingbox(plot::MakieCore.Text) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:115
[7] boundingbox(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:6
[8] boundingbox(x, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/boundingbox.jl:6
boxplot(x, y; kwargs...)
Draw a Tukey style boxplot. The boxplot has 3 components:
-
a
crossbar
spanning the interquartile (IQR) range with a midline marking the median -
an
errorbar
whose whiskers spanrange * iqr
-
points marking outliers, that is, data outside the whiskers
Arguments
-
x
: positions of the categories -
y
: variables within the boxes
Keywords
-
weights
: vector of statistical weights (length of data). By default, each observation has weight1
. -
orientation=:vertical
: orientation of box (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_notch=false
: draw the notch -
notchwidth=0.5
: multiplier ofwidth
for narrowest width of notch -
show_median=true
: show median as midline -
range
: multiple of IQR controlling whisker length -
whiskerwidth
: multiplier ofwidth
for width of T's on whiskers, or:match
to matchwidth
-
show_outliers
: show outliers as points -
dodge
: vector ofInteger
(length of data) of grouping variable to create multiple side-by-side boxes at the samex
position -
dodge_gap = 0.03
: spacing between dodged boxes
boxplot(x, y; kwargs...)
Draw a Tukey style boxplot. The boxplot has 3 components:
-
a
crossbar
spanning the interquartile (IQR) range with a midline marking the median -
an
errorbar
whose whiskers spanrange * iqr
-
points marking outliers, that is, data outside the whiskers
Arguments
-
x
: positions of the categories -
y
: variables within the boxes
Keywords
-
weights
: vector of statistical weights (length of data). By default, each observation has weight1
. -
orientation=:vertical
: orientation of box (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_notch=false
: draw the notch -
notchwidth=0.5
: multiplier ofwidth
for narrowest width of notch -
show_median=true
: show median as midline -
range
: multiple of IQR controlling whisker length -
whiskerwidth
: multiplier ofwidth
for width of T's on whiskers, or:match
to matchwidth
-
show_outliers
: show outliers as points -
dodge
: vector ofInteger
(length of data) of grouping variable to create multiple side-by-side boxes at the samex
position -
dodge_gap = 0.03
: spacing between dodged boxes
broadcast_foreach(f, args...)
Like broadcast but for foreach. Doesn't care about shape and treats Tuples && StaticVectors as scalars. This method is meant for broadcasting across attributes that can either have scalar or vector / array form. An example would be a collection of scatter markers that have different sizes but a single color. The length of an attribute is determined with
attr_broadcast_length
and elements are accessed with
attr_broadcast_getindex
.
Creates a subscene with a pixel camera
cam2d!(scene::SceneLike, kwargs...)
Creates a 2D camera for the given Scene.
No documentation found.
Makie.cam3d!
is a
Function
.
# 2 methods for generic function "cam3d!":
[1] cam3d!(ax::LScene; kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/scene.jl:69
[2] cam3d!(scene; zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:230
No documentation found.
Makie.cam3d_cad!
is a
Function
.
# 2 methods for generic function "cam3d_cad!":
[1] cam3d_cad!(ax::LScene; kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/scene.jl:70
[2] cam3d_cad!(scene; cad, zoom_shift_lookat, fixed_axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera3d.jl:233
cam_relative!(scene)
Creates a pixel-level camera for the
Scene
. No controls!
No documentation found.
Makie.camera
is a
Function
.
# 3 methods for generic function "camera":
[1] camera(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:452
[2] camera(scene::Union{AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:453
[3] camera(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:451
No documentation found.
Makie.cameracontrols
is a
Function
.
# 3 methods for generic function "cameracontrols":
[1] cameracontrols(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:456
[2] cameracontrols(scene::Union{AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:457
[3] cameracontrols(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:455
No documentation found.
Makie.cameracontrols!
is a
Function
.
# 3 methods for generic function "cameracontrols!":
[1] cameracontrols!(scene::Scene, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:459
[2] cameracontrols!(scene::Union{AbstractScene, MakieCore.ScenePlot}, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:463
[3] cameracontrols!(x, cam) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:464
No documentation found.
Makie.campixel
is a
Function
.
# 1 method for generic function "campixel":
[1] campixel(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:337
campixel!(scene; nearclip=-1000f0, farclip=1000f0)
Creates a pixel-level camera for the
Scene
. No controls!
categorical_colors(colormaplike, categories::Integer)
Creates categorical colors and tries to match
categories
. Will error if color scheme doesn't contain enough categories. Will drop the n last colors, if request less colors than contained in scheme.
No documentation found.
Makie.center!
is a
Function
.
# 3 methods for generic function "center!":
[1] center!(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
[2] center!(scene::Scene, padding) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
[3] center!(scene::Scene, padding, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:513
cgrad(colors, [values]; categorical = nothing, scale = nothing, rev = false, alpha = nothing)
Construct a Colorgradient from
colors
and
values
.
colors
can be a symbol for ColorSchemes.jl
ColorScheme
s, a
ColorScheme
, a vector of colors, a
ColorGradient
or a
ColorPalette
. If
values
is an integer, it specifies the numbers of colors chosen equidistantly from the colorscheme specified by colors. Otherwise vectors are accepted. For continuous color gradients
values
indicate where between 0 and 1 the colors are positioned. For categorical color gradients
values
indicate where a color ends and where a new one begins between 0 and 1. 0 and 1 are added to
values
if not already present.
If
rev
is
true
colors are reversed.
scale
accepts the symbols
:log
,
:log10
,
:log2
,
:ln
,
:exp
,
:exp10
or functions. If
alpha
is set, it is applied to all colors.
colgap!(gl::GridLayout, i::Int64, s::Union{Fixed, Relative, Real})
colgap!(gl::GridLayout, s::Union{Fixed, Relative, Real})
Set the gap between columns in
gl
. The two-argument version sets all column gaps in
gl
. The three-argument version sets the gap between columns
i
and
i+1
. Passing a real number to
s
has the same behaviour as passing
Fixed(s)
.
connect!(o1::AbstractObservable, o2::AbstractObservable)
Forwards all updates from
o2
to
o1
.
See also
Observables.ObservablePair
.
No documentation found.
Makie.connect_screen
is a
Function
.
# 1 method for generic function "connect_screen":
[1] connect_screen(scene::Scene, screen) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:14
No documentation found.
GridLayoutBase.content
is a
Function
.
# 1 method for generic function "content":
[1] content(g::Union{GridPosition, GridSubposition}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:1672
contents(gp::GridPosition; exact::Bool = false)
Retrieve all objects placed in the
GridLayout
at the
Span
and
Side
stored in the
GridPosition
gp
. If
exact == true
, elements are only included if they match the
Span
exactly, otherwise they can also be contained within the spanned layout area.
contents(g::GridLayout)
Retrieve all objects placed in the
GridLayout
g
, in the order they are stored, extracted from their containing
GridContent
s.
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
Combined{Makie.contour}
are:
alpha 1.0
color "nothing"
colormap :viridis
colorrange MakieCore.Automatic()
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
enable_depth true
inspectable true
levels 5
linestyle "nothing"
linewidth 1.0
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
contour(x, y, z)
contour(z::Matrix)
Creates a contour plot of the plane spanning
x::Vector
,
y::Vector
,
z::Matrix
. If only
z::Matrix
is supplied, the indices of the elements in
z
will be used as the
x
and
y
locations when plotting the contour.
The attribute levels can be either
an Int that produces n equally wide levels or bands
an AbstractVector{<:Real} that lists n consecutive edges from low to high, which result in n-1 levels or bands
Attributes
Available attributes and their defaults for
Combined{Makie.contour!}
are:
contour3d(x, y, z)
Creates a 3D contour plot of the plane spanning x::Vector, y::Vector, z::Matrix, with z-elevation for each level.
Attributes
Available attributes and their defaults for
Combined{Makie.contour3d}
are:
alpha 1.0
color "nothing"
colormap :viridis
colorrange MakieCore.Automatic()
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
enable_depth true
inspectable true
levels 5
linestyle "nothing"
linewidth 1.0
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
contour3d(x, y, z)
Creates a 3D contour plot of the plane spanning x::Vector, y::Vector, z::Matrix, with z-elevation for each level.
Attributes
Available attributes and their defaults for
Combined{Makie.contour3d!}
are:
contourf(xs, ys, zs; kwargs...)
Plots a filled contour of the height information in
zs
at horizontal grid positions
xs
and vertical grid positions
ys
.
The attribute
levels
can be either
-
an
Int
that produces n equally wide levels or bands -
an
AbstractVector{<:Real}
that lists n consecutive edges from low to high, which result in n-1 levels or bands
You can also set the
mode
attribute to
:relative
. In this mode you specify edges by the fraction between minimum and maximum value of
zs
. This can be used for example to draw bands for the upper 90% while excluding the lower 10% with
levels = 0.1:0.1:1.0, mode = :relative
.
In :normal mode, if you want to show a band from
-Inf
to the low edge, set
extendlow
to
:auto
for the same color as the first level, or specify a different color (default
nothing
means no extended band) If you want to show a band from the high edge to
Inf
, set
extendhigh
to
:auto
for the same color as the last level, or specify a different color (default
nothing
means no extended band).
If
levels
is an
Int
, the contour plot will be rectangular as all
zs
will be covered. This is why
Axis
defaults to tight limits for such contourf plots. If you specify
levels
as an
AbstractVector{<:Real}
, however, note that the axis limits include the default margins because the contourf plot can have an irregular shape. You can use
tightlimits!(ax)
to tighten the limits similar to the
Int
behavior.
Attributes
Available attributes and their defaults for
Combined{Makie.contourf}
are:
colormap :viridis
extendhigh "nothing"
extendlow "nothing"
inspectable true
levels 10
mode :normal
nan_color :transparent
transparency false
contourf(xs, ys, zs; kwargs...)
Plots a filled contour of the height information in
zs
at horizontal grid positions
xs
and vertical grid positions
ys
.
The attribute
levels
can be either
-
an
Int
that produces n equally wide levels or bands -
an
AbstractVector{<:Real}
that lists n consecutive edges from low to high, which result in n-1 levels or bands
You can also set the
mode
attribute to
:relative
. In this mode you specify edges by the fraction between minimum and maximum value of
zs
. This can be used for example to draw bands for the upper 90% while excluding the lower 10% with
levels = 0.1:0.1:1.0, mode = :relative
.
In :normal mode, if you want to show a band from
-Inf
to the low edge, set
extendlow
to
:auto
for the same color as the first level, or specify a different color (default
nothing
means no extended band) If you want to show a band from the high edge to
Inf
, set
extendhigh
to
:auto
for the same color as the last level, or specify a different color (default
nothing
means no extended band).
If
levels
is an
Int
, the contour plot will be rectangular as all
zs
will be covered. This is why
Axis
defaults to tight limits for such contourf plots. If you specify
levels
as an
AbstractVector{<:Real}
, however, note that the axis limits include the default margins because the contourf plot can have an irregular shape. You can use
tightlimits!(ax)
to tighten the limits similar to the
Int
behavior.
Attributes
Available attributes and their defaults for
Combined{Makie.contourf!}
are:
Wrap a single point or equivalent object in a single-element array.
Enables to use scatter like a surface plot with x::Vector, y::Vector, z::Matrix spanning z over the grid spanned by x y
convert_arguments(P, x, y, z)::(Vector)
Takes vectors
x
,
y
, and
z
and turns it into a vector of 3D points of the values from
x
,
y
, and
z
.
P
is the plot Type (it is optional).
convert_arguments(P, x)::(Vector)
Takes an input GeometryPrimitive
x
and decomposes it to points.
P
is the plot Type (it is optional).
convert_arguments(P, y)::Vector
Takes vector
y
and generates a range from 1 to the length of
y
, for plotting on an arbitrary
x
axis.
P
is the plot Type (it is optional).
convert_arguments(P, x)::(Vector)
Takes an input
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.
to_color(color)
Converts a
color
symbol (e.g.
:blue
) to a color RGBA.
to_colormap(cm)
Converts a colormap
cm
symbol/string (e.g.
:Spectral
) to a colormap RGB array.
`AbstractVector{<:AbstractFloat}` for denoting sequences of fill/nofill. e.g.
[0.5, 0.8, 1.2] will result in 0.5 filled, 0.3 unfilled, 0.4 filled. 1.0 unit is one linewidth!
A `Symbol` equal to `:dash`, `:dot`, `:dashdot`, `:dashdotdot`
to_volume_algorithm(b, x)
Enum values:
IsoValue
Absorption
MaximumIntensityProjection
AbsorptionRGBA
AdditiveRGBA
IndexedAbsorptionRGBA
Symbol/String: iso, absorption, mip, absorptionrgba, indexedabsorption
crossbar(x, y, ymin, ymax; kwargs...)
Draw a crossbar. A crossbar represents a range with a (potentially notched) box. It is most commonly used as part of the
boxplot
.
Arguments
-
x
: position of the box -
y
: position of the midline within the box -
ymin
: lower limit of the box -
ymax
: upper limit of the box
Keywords
-
orientation=:vertical
: orientation of box (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_notch=false
: draw the notch -
notchmin=automatic
: lower limit of the notch -
notchmax=automatic
: upper limit of the notch -
notchwidth=0.5
: multiplier ofwidth
for narrowest width of notch -
show_midline=true
: show midline
crossbar(x, y, ymin, ymax; kwargs...)
Draw a crossbar. A crossbar represents a range with a (potentially notched) box. It is most commonly used as part of the
boxplot
.
Arguments
-
x
: position of the box -
y
: position of the midline within the box -
ymin
: lower limit of the box -
ymax
: upper limit of the box
Keywords
-
orientation=:vertical
: orientation of box (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_notch=false
: draw the notch -
notchmin=automatic
: lower limit of the notch -
notchmax=automatic
: upper limit of the notch -
notchwidth=0.5
: multiplier ofwidth
for narrowest width of notch -
show_midline=true
: show midline
Returns the current active axis (or the last axis that got created)
Set
ax
as the current active axis in
fig
Returns the current active figure (or the last figure that got created)
Set
fig
as the current active scene
No documentation found.
Makie.data_limits
is a
Function
.
# 8 methods for generic function "data_limits":
[1] data_limits(bars::Union{Combined{Makie.errorbars}, Combined{Makie.rangebars}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/basic_recipes/error_and_rangebars.jl:269
[2] data_limits(plot::Surface) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:230
[3] data_limits(plot::Heatmap) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:237
[4] data_limits(plot::Image) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:244
[5] data_limits(hb::Combined{Makie.hexbin}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/stats/hexbin.jl:60
[6] data_limits(plot::AbstractPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:195
[7] data_limits(scenelike) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:219
[8] data_limits(scenelike, exclude) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/data_limits.jl:219
deactivate_interaction!(parent, name::Symbol)
Deactivate the interaction named
name
registered in
parent
. It can be reactivated with
activate_interaction!
.
decompose(facetype, contour::AbstractArray{<:AbstractPoint})
Triangulate a Polygon without hole.
Returns a Vector{
facetype
} defining indexes into
contour
.
No documentation found.
MakieCore.default_theme
is a
Function
.
# 54 methods for generic function "default_theme":
[1] default_theme(scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:1
[2] default_theme(scene, ::Type{<:Arrows}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[3] default_theme(scene, ::Type{<:Image}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[4] default_theme(scene, ::Type{<:Heatmap}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[5] default_theme(scene, ::Type{<:Volume}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[6] default_theme(scene, ::Type{<:Surface}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[7] default_theme(scene, ::Type{<:Lines}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[8] default_theme(scene, ::Type{<:LineSegments}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[9] default_theme(scene, ::Type{<:Mesh}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[10] default_theme(scene, ::Type{<:Scatter}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[11] default_theme(scene, ::Type{<:MeshScatter}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[12] default_theme(scene, ::Type{<:MakieCore.Text}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[13] default_theme(scene, ::Type{<:Poly}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[14] default_theme(scene, ::Type{<:Wireframe}) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[15] default_theme(scene, ::Type{<:Combined{Makie.rainclouds}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[16] default_theme(scene, ::Type{<:Combined{Makie.series}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[17] default_theme(scene, ::Type{<:Combined{Makie.hexbin}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[18] default_theme(scene, ::Type{<:Combined{Makie.violin}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[19] default_theme(scene, ::Type{<:Combined{Makie.boxplot}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[20] default_theme(scene, ::Type{<:Combined{Makie.crossbar}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[21] default_theme(scene, ::Type{<:Combined{Makie.qqnorm}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[22] default_theme(scene, ::Type{<:Combined{Makie.qqplot}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[23] default_theme(scene, ::Type{<:Combined{Makie.ecdfplot}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[24] default_theme(scene, ::Type{<:Combined{Makie.density}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[25] default_theme(scene, ::Type{<:Combined{Makie.hist}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[26] default_theme(scene, ::Type{<:Combined{Makie.tooltip}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[27] default_theme(scene, ::Type{<:Combined{Makie.waterfall}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[28] default_theme(scene, ::Type{<:Combined{Makie.volumeslices}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[29] default_theme(scene, ::Type{<:Combined{Makie.tricontourf}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[30] default_theme(scene, ::Type{<:Combined{Makie.timeseries}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[31] default_theme(scene, ::Type{<:Combined{Makie.streamplot}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[32] default_theme(scene, ::Type{<:Combined{Makie.stem}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[33] default_theme(scene, ::Type{<:Combined{Makie.stairs}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[34] default_theme(scene, ::Type{<:Combined{Makie.spy}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[35] default_theme(scene, ::Type{<:Combined{Makie.scatterlines}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[36] default_theme(scene, ::Type{<:Combined{Makie.pie}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[37] default_theme(scene, ::Type{<:Combined{Makie.vspan}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[38] default_theme(scene, ::Type{<:Combined{Makie.hspan}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[39] default_theme(scene, ::Type{<:Combined{Makie.vlines}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[40] default_theme(scene, ::Type{<:Combined{Makie.hlines}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[41] default_theme(scene, ::Type{<:Combined{Makie.rangebars}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[42] default_theme(scene, ::Type{<:Combined{Makie.errorbars}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[43] default_theme(scene, ::Type{<:Combined{Makie.contourf}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[44] default_theme(scene, ::Type{<:Combined{Makie.contour3d}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[45] default_theme(scene, ::Type{<:Combined{Makie.contour}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[46] default_theme(scene, ::Type{<:Combined{Makie.barplot}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[47] default_theme(scene, ::Type{<:Combined{Makie.band}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[48] default_theme(scene, ::Type{<:Combined{Makie.axis3d}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[49] default_theme(scene, ::Type{<:Combined{Makie.arc}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[50] default_theme(scene, ::Type{<:Combined{Makie.annotations}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[51] default_theme(scene, ::Type{<:Combined{Makie.ablines}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[52] default_theme(scene, ::Type{<:Combined{RPRMakie.matball}}) in RPRMakie at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[53] default_theme(scene, ::Type{<:Combined{Main.FD_SANDBOX_3118400072356428703.stockchart}}) in Main.FD_SANDBOX_3118400072356428703 at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:177
[54] default_theme(scene, T) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:63
density(values; npoints = 200, offset = 0.0, direction = :x)
Plot a kernel density estimate of
values
.
npoints
controls the resolution of the estimate, the baseline can be shifted with
offset
and the
direction
set to :x or :y.
bandwidth
and
boundary
are determined automatically by default.
Statistical weights can be provided via the
weights
keyword argument.
color
is usually set to a single color, but can also be set to
:x
or
:y
to color with a gradient. If you use
:y
when direction =
:x
(or vice versa), note that only 2-element colormaps can work correctly.
Attributes
Available attributes and their defaults for
Combined{Makie.density}
are:
bandwidth MakieCore.Automatic()
boundary MakieCore.Automatic()
color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color => :patchcolor]
direction :x
inspectable true
linestyle "nothing"
npoints 200
offset 0.0
strokearound false
strokecolor :black
strokewidth 0
weights MakieCore.Automatic()
density(values; npoints = 200, offset = 0.0, direction = :x)
Plot a kernel density estimate of
values
.
npoints
controls the resolution of the estimate, the baseline can be shifted with
offset
and the
direction
set to :x or :y.
bandwidth
and
boundary
are determined automatically by default.
Statistical weights can be provided via the
weights
keyword argument.
color
is usually set to a single color, but can also be set to
:x
or
:y
to color with a gradient. If you use
:y
when direction =
:x
(or vice versa), note that only 2-element colormaps can work correctly.
Attributes
Available attributes and their defaults for
Combined{Makie.density!}
are:
deregister_interaction!(parent, name::Symbol)
Deregister the interaction named
name
registered in
parent
.
No documentation found.
Makie.disconnect!
is a
Function
.
# 16 methods for generic function "disconnect!":
[1] disconnect!(screen::GLMakie.Screen, ::typeof(mouse_position)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:229
[2] disconnect!(screen::GLMakie.Screen, ::typeof(window_area)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:81
[3] disconnect!(window::MakieScreen, signal) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:35
[4] disconnect!(observables::Vector) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:36
[5] disconnect!(window::GLFW.Window, ::typeof(entered_window)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:300
[6] disconnect!(window::GLFW.Window, ::typeof(hasfocus)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:278
[7] disconnect!(window::GLFW.Window, ::typeof(scroll)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:255
[8] disconnect!(window::GLFW.Window, ::typeof(mouse_position)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:233
[9] disconnect!(window::GLFW.Window, ::typeof(unicode_input)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:166
[10] disconnect!(window::GLFW.Window, ::typeof(dropped_files)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:143
[11] disconnect!(window::GLFW.Window, ::typeof(keyboard_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:122
[12] disconnect!(window::GLFW.Window, ::typeof(mouse_buttons)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:107
[13] disconnect!(::GLFW.Window, ::typeof(window_area)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:85
[14] disconnect!(window::GLFW.Window, ::typeof(window_open)) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:35
[15] disconnect!(c::Camera) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:24
[16] disconnect!(c::EmptyCamera) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/camera.jl:32
Registers a callback for drag and drop of files. returns
Observable{Vector{String}}
, which are absolute file paths
GLFW Docs
ecdfplot(values; npoints=10_000[, weights])
Plot the empirical cumulative distribution function (ECDF) of
values
.
npoints
controls the resolution of the plot. If
weights
for the values are provided, a weighted ECDF is plotted.
Attributes
Available attributes and their defaults for
Combined{Makie.ecdfplot}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
linestyle "nothing"
linewidth 1.5
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
step :pre
transparency false
visible true
ecdfplot(values; npoints=10_000[, weights])
Plot the empirical cumulative distribution function (ECDF) of
values
.
npoints
controls the resolution of the plot. If
weights
for the values are provided, a weighted ECDF is plotted.
Attributes
Available attributes and their defaults for
Combined{Makie.ecdfplot!}
are:
Registers a callback for if the mouse has entered the window. returns an
Observable{Bool}
, which is true whenever the cursor enters the window.
GLFW Docs
errorbars(x, y, error_both; kwargs...)
errorbars(x, y, error_low, error_high; kwargs...)
errorbars(x, y, error_low_high; kwargs...)
errorbars(xy, error_both; kwargs...)
errorbars(xy, error_low, error_high; kwargs...)
errorbars(xy, error_low_high; kwargs...)
errorbars(xy_error_both; kwargs...)
errorbars(xy_error_low_high; kwargs...)
Plots errorbars at xy positions, extending by errors in the given
direction
.
If you want to plot intervals from low to high values instead of relative errors, use
rangebars
.
Attributes
Available attributes and their defaults for
Combined{Makie.errorbars}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
direction :y
inspectable true
linewidth 1.5
transparency false
visible true
whiskerwidth 0
errorbars(x, y, error_both; kwargs...)
errorbars(x, y, error_low, error_high; kwargs...)
errorbars(x, y, error_low_high; kwargs...)
errorbars(xy, error_both; kwargs...)
errorbars(xy, error_low, error_high; kwargs...)
errorbars(xy, error_low_high; kwargs...)
errorbars(xy_error_both; kwargs...)
errorbars(xy_error_low_high; kwargs...)
Plots errorbars at xy positions, extending by errors in the given
direction
.
If you want to plot intervals from low to high values instead of relative errors, use
rangebars
.
Attributes
Available attributes and their defaults for
Combined{Makie.errorbars!}
are:
No documentation found.
Makie.events
is a
Function
.
# 3 methods for generic function "events":
[1] events(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:448
[2] events(scene::Union{AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:449
[3] events(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:447
fill_between!(scenelike, x, y1, y2; where = nothing, kw_args...)
fill the section between 2 lines with the condition
where
grid!(content::Vararg{Pair}; kwargs...)
Creates a GridLayout with all pairs contained in
content
. Each pair consists of an iterable with row and column spans, and a content object. Each content object is then placed in the GridLayout at the span from its pair.
Example:
grid!( [1, 1] => obj1, [1, 2] => obj2, [2, :] => obj3, )
grid!(content::AbstractMatrix; kwargs...)
Creates a GridLayout filled with matrix-like content. The size of the grid will be the size of the matrix.
No documentation found.
GridLayoutBase.gridnest!
is a
Function
.
# 1 method for generic function "gridnest!":
[1] gridnest!(gl::GridLayout, rows::Union{Colon, Int64, UnitRange}, cols::Union{Colon, Int64, UnitRange}) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:582
Registers a callback for the focus of a window. returns an
Observable{Bool}
, which is true whenever the window has focus.
GLFW Docs
heatmap(x, y, values)
heatmap(values)
Plots a heatmap as an image on
x, y
(defaults to interpretation as dimensions).
Attributes
Specific to
Heatmap
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = false
sets whether colors should be interpolated.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the heatmap. SeeMakie.spaces()
for possible inputs.
heatmap(x, y, values)
heatmap(values)
Plots a heatmap as an image on
x, y
(defaults to interpretation as dimensions).
Attributes
Specific to
Heatmap
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = false
sets whether colors should be interpolated.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the heatmap. SeeMakie.spaces()
for possible inputs.
No documentation found.
GeometryBasics.height
is a
Function
.
# 2 methods for generic function "height":
[1] height(prim::GeometryBasics.HyperRectangle) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/primitives/rectangles.jl:165
[2] height(c::GeometryBasics.Cylinder{N, T}) where {N, T} in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/primitives/cylinders.jl:26
help(func[; extended = false])
Welcome to the main help function of
Makie.jl
/
Makie.jl
.
For help on a specific function's arguments, type
help_arguments(function_name)
.
For help on a specific function's attributes, type
help_attributes(plot_Type)
.
Use the optional
extended = true
keyword argument to see more details.
help_arguments([io], func)
Returns a list of signatures for function
func
.
help_attributes([io], Union{PlotType, PlotFunction}; extended = false)
Returns a list of attributes for the plot type
Typ
. The attributes returned extend those attributes found in the
default_theme
.
Use the optional keyword argument
extended
(default =
false
) to show in addition the default values of each attribute. usage:
>help_attributes(scatter)
alpha
color
colormap
colorrange
distancefield
glowcolor
glowwidth
linewidth
marker
marker_offset
markersize
overdraw
rotations
strokecolor
strokewidth
transform_marker
transparency
uv_offset_width
visible
hexbin(xs, ys; kwargs...)
Plots a heatmap with hexagonal bins for the observations
xs
and
ys
.
Attributes
Specific to
Hexbin
-
bins = 20
: If anInt
, sets the number of bins in x and y direction. If aTuple{Int, Int}
, sets the number of bins for x and y separately. -
cellsize = nothing
: If aReal
, makes equally-sided hexagons with widthcellsize
. If aTuple{Real, Real}
specifies hexagon width and height separately. -
threshold::Int = 1
: The minimal number of observations in the bin to be shown. If 0, all zero-count hexagons fitting into the data limits will be shown. -
scale = identity
: A function to scale the number of observations in a bin, eg. log10.
Generic
-
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
-
colorrange::Tuple(<:Real,<:Real} = Makie.automatic
sets the values representing the start and end points ofcolormap
.
hexbin(xs, ys; kwargs...)
Plots a heatmap with hexagonal bins for the observations
xs
and
ys
.
Attributes
Specific to
Hexbin
-
bins = 20
: If anInt
, sets the number of bins in x and y direction. If aTuple{Int, Int}
, sets the number of bins for x and y separately. -
cellsize = nothing
: If aReal
, makes equally-sided hexagons with widthcellsize
. If aTuple{Real, Real}
specifies hexagon width and height separately. -
threshold::Int = 1
: The minimal number of observations in the bin to be shown. If 0, all zero-count hexagons fitting into the data limits will be shown. -
scale = identity
: A function to scale the number of observations in a bin, eg. log10.
Generic
-
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
-
colorrange::Tuple(<:Real,<:Real} = Makie.automatic
sets the values representing the start and end points ofcolormap
.
hbox!(content::Vararg; kwargs...)
Creates a single-row GridLayout with all elements contained in
content
placed from left to right.
hidedecorations!(la::Axis)
Hide decorations of both x and y-axis: label, ticklabels, ticks and grid.
hidespines!(la::Axis, spines::Symbol... = (:l, :r, :b, :t)...)
Hide all specified axis spines. Hides all spines by default, otherwise choose with the symbols :l, :r, :b and :t.
hidexdecorations!(la::Axis; label = true, ticklabels = true, ticks = true, grid = true,
minorgrid = true, minorticks = true)
Hide decorations of the x-axis: label, ticklabels, ticks and grid.
hideydecorations!(la::Axis; label = true, ticklabels = true, ticks = true, grid = true,
minorgrid = true, minorticks = true)
Hide decorations of the y-axis: label, ticklabels, ticks and grid.
hist(values; bins = 15, normalization = :none)
Plot a histogram of
values
.
bins
can be an
Int
to create that number of equal-width bins over the range of
values
. Alternatively, it can be a sorted iterable of bin edges. The histogram can be normalized by setting
normalization
. Possible values are:
-
:pdf
: Normalize by sum of weights and bin sizes. Resulting histogram has norm 1 and represents a PDF. -
:density
: Normalize by bin sizes only. Resulting histogram represents count density of input and does not have norm 1. Will not modify the histogram if it already represents a density (h.isdensity == 1
). -
:probability
: Normalize by sum of weights only. Resulting histogram represents the fraction of probability mass for each bin and does not have norm 1. -
:none
: Do not normalize.
Statistical weights can be provided via the
weights
keyword argument.
The following attributes can move the histogram around, which comes in handy when placing multiple histograms into one plot:
-
offset = 0.0
: adds an offset to every value -
fillto = 0.0
: defines where the bar starts -
scale_to = nothing
: allows to scale all values to a certain height -
flip = false
: flips all values
Color can either be:
-
a vector of
bins
colors -
a single color
-
:values
, to color the bars with the values from the histogram
Attributes
Available attributes and their defaults for
Combined{Makie.hist}
are:
bar_labels "nothing"
bins 15
color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.6f0)
cycle [:color => :patchcolor]
fillto MakieCore.Automatic()
flip_labels_at Inf
label_color :black
label_font "TeX Gyre Heros Makie"
label_formatter Makie.bar_label_formatter
label_offset 5
label_size 20
normalization :none
offset 0.0
over_background_color MakieCore.Automatic()
over_bar_color MakieCore.Automatic()
scale_to "nothing"
weights MakieCore.Automatic()
hist(values; bins = 15, normalization = :none)
Plot a histogram of
values
.
bins
can be an
Int
to create that number of equal-width bins over the range of
values
. Alternatively, it can be a sorted iterable of bin edges. The histogram can be normalized by setting
normalization
. Possible values are:
-
:pdf
: Normalize by sum of weights and bin sizes. Resulting histogram has norm 1 and represents a PDF. -
:density
: Normalize by bin sizes only. Resulting histogram represents count density of input and does not have norm 1. Will not modify the histogram if it already represents a density (h.isdensity == 1
). -
:probability
: Normalize by sum of weights only. Resulting histogram represents the fraction of probability mass for each bin and does not have norm 1. -
:none
: Do not normalize.
Statistical weights can be provided via the
weights
keyword argument.
The following attributes can move the histogram around, which comes in handy when placing multiple histograms into one plot:
-
offset = 0.0
: adds an offset to every value -
fillto = 0.0
: defines where the bar starts -
scale_to = nothing
: allows to scale all values to a certain height -
flip = false
: flips all values
Color can either be:
-
a vector of
bins
colors -
a single color
-
:values
, to color the bars with the values from the histogram
Attributes
Available attributes and their defaults for
Combined{Makie.hist!}
are:
hlines(ys; xmin = 0.0, xmax = 1.0, attrs...)
Create horizontal lines across a
Scene
with 2D projection. The lines will be placed at
ys
in data coordinates and
xmin
to
xmax
in scene coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.
All style attributes are the same as for
LineSegments
.
hlines(ys; xmin = 0.0, xmax = 1.0, attrs...)
Create horizontal lines across a
Scene
with 2D projection. The lines will be placed at
ys
in data coordinates and
xmin
to
xmax
in scene coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.
All style attributes are the same as for
LineSegments
.
hovered_scene()
Returns the
scene
that the mouse is currently hovering over.
Properly identifies the scene for a plot with multiple sub-plots.
hspan(ys_low, ys_high; xmin = 0.0, xmax = 1.0, attrs...)
Create horizontal bands spanning across a
Scene
with 2D projection. The bands will be placed from
ys_low
to
ys_high
in data coordinates and
xmin
to
xmax
in scene coordinates (0 to 1). All four of these can have single or multiple values because they are broadcast to calculate the final spans.
All style attributes are the same as for
Poly
.
hspan(ys_low, ys_high; xmin = 0.0, xmax = 1.0, attrs...)
Create horizontal bands spanning across a
Scene
with 2D projection. The bands will be placed from
ys_low
to
ys_high
in data coordinates and
xmin
to
xmax
in scene coordinates (0 to 1). All four of these can have single or multiple values because they are broadcast to calculate the final spans.
All style attributes are the same as for
Poly
.
image(x, y, image)
image(image)
Plots an image on range
x, y
(defaults to dimensions).
Attributes
Specific to
Image
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = true
sets whether colors should be interpolated.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = [:black, :white
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the image. SeeMakie.spaces()
for possible inputs.
image(x, y, image)
image(image)
Plots an image on range
x, y
(defaults to dimensions).
Attributes
Specific to
Image
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = true
sets whether colors should be interpolated.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = [:black, :white
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the image. SeeMakie.spaces()
for possible inputs.
No documentation found.
Makie.insertplots!
is a
Function
.
# 2 methods for generic function "insertplots!":
[1] insertplots!(screen::GLMakie.Screen, scene::Scene) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/screen.jl:420
[2] insertplots!(screen::AbstractDisplay, scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:499
No documentation found.
Makie.interactions
is a
Function
.
# 2 methods for generic function "interactions":
[1] interactions(ax::Axis) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/interactions.jl:4
[2] interactions(ax3::Axis3) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/interactions.jl:5
is_mouseinside(scene)
Returns true if the current mouseposition is inside the given scene.
ispressed(scene, result::Bool)
ispressed(scene, button::Union{Mouse.Button, Keyboard.Button)
ispressed(scene, collection::Union{Set, Vector, Tuple})
ispressed(scene, op::BooleanOperator)
This function checks if a button or combination of buttons is pressed.
If given a true or false,
ispressed
will return true or false respectively. This provides a way to turn an interaction "always on" or "always off" from the outside.
Passing a button or collection of buttons such as
Keyboard.enter
or
Mouse.left
will return true if all of the given buttons are pressed.
For more complicated combinations of buttons they can be combined into boolean expression with
&
,
|
and
!
. For example, you can have
ispressed(scene, !Keyboard.left_control & Keyboard.c))
and
ispressed(scene, Keyboard.left_control & Keyboard.c)
to avoid triggering both cases at the same time.
Furthermore you can also make any button, button collection or boolean expression exclusive by wrapping it in
Exclusively(...)
. With that
ispressed
will only return true if the currently pressed buttons match the request exactly.
No documentation found.
Makie.keyboard_buttons
is a
Function
.
# 3 methods for generic function "keyboard_buttons":
[1] keyboard_buttons(scene::Scene, window::GLFW.Window) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:111
[2] keyboard_buttons(scene::Scene, screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:110
[3] keyboard_buttons(scene, native_window) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:8
labelslider!(scene, label, range; format = string, sliderkw = Dict(),
labelkw = Dict(), valuekw = Dict(), value_column_width = automatic, layoutkw...)
labelslider!
is deprecated, use
SliderGrid
instead
Construct a horizontal GridLayout with a label, a slider and a value label in
scene
.
Returns a
NamedTuple
:
(slider = slider, label = label, valuelabel = valuelabel, layout = layout)
Specify a format function for the value label with the
format
keyword or pass a format string used by
Formatting.format
. The slider is forwarded the keywords from
sliderkw
. The label is forwarded the keywords from
labelkw
. The value label is forwarded the keywords from
valuekw
. You can set the column width for the value label column with the keyword
value_column_width
. By default, the width is determined heuristically by sampling a few values from the slider range. All other keywords are forwarded to the
GridLayout
.
Example:
ls = labelslider!(scene, "Voltage:", 0:10; format = x -> "$(x)V")
layout[1, 1] = ls.layout
labelslidergrid!(scene, labels, ranges; formats = [string],
sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(),
value_column_width = automatic, layoutkw...)
labelslidergrid!
is deprecated, use
SliderGrid
instead
Construct a GridLayout with a column of label, a column of sliders and a column of value labels in
scene
. The argument values are broadcast, so you can use scalars if you want to keep labels, ranges or formats constant across rows.
Returns a
NamedTuple
:
(sliders = sliders, labels = labels, valuelabels = valuelabels, layout = layout)
Specify format functions for the value labels with the
formats
keyword or pass format strings used by
Formatting.format
. The sliders are forwarded the keywords from
sliderkw
. The labels are forwarded the keywords from
labelkw
. The value labels are forwarded the keywords from
valuekw
. You can set the column width for the value label column with the keyword
value_column_width
. By default, the width is determined heuristically by sampling a few values from the slider ranges. All other keywords are forwarded to the
GridLayout
.
Example:
ls = labelslidergrid!(scene, ["Voltage", "Ampere"], Ref(0:0.1:100); format = x -> "$(x)V")
layout[1, 1] = ls.layout
No documentation found.
Makie.left
is a
Function
.
# 1 method for generic function "left":
[1] left(rect::Rect2) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:2
map(f, c...) -> collection
Transform collection
c
by applying
f
to each element. For multiple collection arguments, apply
f
elementwise, and stop when when any of them is exhausted.
See also
map!
,
foreach
,
mapreduce
,
mapslices
,
zip
,
Iterators.map
.
Examples
julia> map(x -> x * 2, [1, 2, 3])
3-element Vector{Int64}:
2
4
6
julia> map(+, [1, 2, 3], [10, 20, 30, 400, 5000])
3-element Vector{Int64}:
11
22
33
map(f, A::AbstractArray...) -> N-array
When acting on multi-dimensional arrays of the same
ndims
, they must all have the same
axes
, and the answer will too.
See also
broadcast
, which allows mismatched sizes.
Examples
julia> map(//, [1 2; 3 4], [4 3; 2 1])
2×2 Matrix{Rational{Int64}}:
1//4 2//3
3//2 4//1
julia> map(+, [1 2; 3 4], zeros(2,1))
ERROR: DimensionMismatch
julia> map(+, [1 2; 3 4], [1,10,100,1000], zeros(3,1)) # iterates until 3rd is exhausted
3-element Vector{Float64}:
2.0
13.0
102.0
obs = map(f, arg1::AbstractObservable, args...; ignore_equal_values=false)
Creates a new observable
obs
which contains the result of
f
applied to values extracted from
arg1
and
args
(i.e.,
f(arg1[], ...)
.
arg1
must be an observable for dispatch reasons.
args
may contain any number of
Observable
objects.
f
will be passed the values contained in the observables as the respective argument. All other objects in
args
are passed as-is.
If you don't need the value of
obs
, and just want to run
f
whenever the arguments update, use
on
or
onany
instead.
Example
julia> obs = Observable([1,2,3]);
julia> map(length, obs)
Observable(3)
limits!(ax::Axis, xlims, ylims)
Set the axis limits to
xlims
and
ylims
. If limits are ordered high-low, this reverses the axis orientation.
limits!(ax::Axis, x1, x2, y1, y2)
Set the axis x-limits to
x1
and
x2
and the y-limits to
y1
and
y2
. If limits are ordered high-low, this reverses the axis orientation.
limits!(ax::Axis, rect::Rect2)
Set the axis limits to
rect
. If limits are ordered high-low, this reverses the axis orientation.
limits!(ax::Axis3, xlims, ylims)
Set the axis limits to
xlims
and
ylims
. If limits are ordered high-low, this reverses the axis orientation.
limits!(ax::Axis3, x1, x2, y1, y2, z1, z2)
Set the axis x-limits to
x1
and
x2
and the y-limits to
y1
and
y2
. If limits are ordered high-low, this reverses the axis orientation.
limits!(ax::Axis3, rect::Rect3)
Set the axis limits to
rect
. If limits are ordered high-low, this reverses the axis orientation.
lines(positions)
lines(x, y)
lines(x, y, z)
Creates a connected line plot for each element in
(x, y, z)
,
(x, y)
or
positions
.
NaN
values are displayed as gaps in the line.
Attributes
Specific
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
) -
linewidth::Real = 1.5
sets the width of the line in pixel units.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that line plots already use a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each point in the line by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for line position. SeeMakie.spaces()
for possible inputs.
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
.
NaN
values are displayed as gaps in the line.
Attributes
Specific
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
) -
linewidth::Real = 1.5
sets the width of the line in pixel units.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that line plots already use a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each point in the line by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for line position. SeeMakie.spaces()
for possible inputs.
linesegments(positions)
linesegments(vector_of_2tuples_of_points)
linesegments(x, y)
linesegments(x, y, z)
Plots a line for each pair of points in
(x, y, z)
,
(x, y)
, or
positions
.
Attributes
Specific to
LineSegments
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
) -
linewidth::Real = 1.5
sets the width of the line in pixel units.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that line plots already use a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each point in the line by passing aVector
or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for line position. SeeMakie.spaces()
for possible inputs.
linesegments(positions)
linesegments(vector_of_2tuples_of_points)
linesegments(x, y)
linesegments(x, y, z)
Plots a line for each pair of points in
(x, y, z)
,
(x, y)
, or
positions
.
Attributes
Specific to
LineSegments
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
) -
linewidth::Real = 1.5
sets the width of the line in pixel units.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that line plots already use a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each point in the line by passing aVector
or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for line position. SeeMakie.spaces()
for possible inputs.
linkaxes!(a::Axis, others...)
Link both x and y axes of all given
Axis
so that they stay synchronized.
linkxaxes!(a::Axis, others...)
Link the x axes of all given
Axis
so that they stay synchronized.
linkyaxes!(a::Axis, others...)
Link the y axes of all given
Axis
so that they stay synchronized.
map_once(closure, inputs::Observable....)::Observable
Like Reactive.foreach, in the sense that it will be preserved even if no reference is kept. The difference is, that you can call map once multiple times with the same closure and it will close the old result Observable and register a new one instead.
``` function test(s1::Observable) s3 = map once(x-> (println("1 ", x); x), s1) s3 = map once(x-> (println("2 ", x); x), s1)
end test(Observable(1), Observable(2))
mesh(x, y, z)
mesh(mesh_object)
mesh(x, y, z, faces)
mesh(xyz, faces)
Plots a 3D or 2D mesh. Supported
mesh_object
s include
Mesh
types from
GeometryBasics.jl
.
Attributes
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. AVector
of any of these can be passed to define the color per vertex. (It may be helpful to checkGeometryBasics.coordinates(my_mesh)
for this.) AVector{<: Real}
can also be passed to sample a colormap for each vertex. And finally, if the mesh includes uv coordinates you can pass aMatrix
of colors to be used as a texture. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for vertex positions. SeeMakie.spaces()
for possible inputs. -
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = true
wether color=Matrix gets interpolated or not
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
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
.
Attributes
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. AVector
of any of these can be passed to define the color per vertex. (It may be helpful to checkGeometryBasics.coordinates(my_mesh)
for this.) AVector{<: Real}
can also be passed to sample a colormap for each vertex. And finally, if the mesh includes uv coordinates you can pass aMatrix
of colors to be used as a texture. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for vertex positions. SeeMakie.spaces()
for possible inputs. -
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
interpolate::Bool = true
wether color=Matrix gets interpolated or not
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
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
.
Attributes
Specific to
MeshScatter
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
marker::Union{Symbol, GeometryBasics.GeometryPrimitive, GeometryBasics.Mesh}
sets the scattered mesh. -
markersize::Union{<:Real, Vec3f} = 0.1
sets the scale of the mesh. This can be given as a Vector to apply to each scattered mesh individually. -
rotations::Union{Real, Vec3f, Quaternion} = 0
sets the rotation of the mesh. A numeric rotation is around the z-axis, aVec3f
causes the mesh to rotate such that the the z-axis is now that vector, and a quaternion describes a general rotation. This can be given as a Vector to apply to each scattered mesh individually.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered mesh by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the positions of meshes. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
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
.
Attributes
Specific to
MeshScatter
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
marker::Union{Symbol, GeometryBasics.GeometryPrimitive, GeometryBasics.Mesh}
sets the scattered mesh. -
markersize::Union{<:Real, Vec3f} = 0.1
sets the scale of the mesh. This can be given as a Vector to apply to each scattered mesh individually. -
rotations::Union{Real, Vec3f, Quaternion} = 0
sets the rotation of the mesh. A numeric rotation is around the z-axis, aVec3f
causes the mesh to rotate such that the the z-axis is now that vector, and a quaternion describes a general rotation. This can be given as a Vector to apply to each scattered mesh individually.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered mesh by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the positions of meshes. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
Registers a callback for the mouse buttons + modifiers returns
Observable{NTuple{4, Int}}
GLFW Docs
Registers a callback for the mouse cursor position. returns an
Observable{Vec{2, Float64}}
, which is not in scene coordinates, with the upper left window corner being 0
GLFW Docs
No documentation found.
Makie.mouse_selection
is a
Function
.
# 1 method for generic function "mouse_selection":
[1] mouse_selection(args...) in Makie at deprecated.jl:45
mouseover(fig/ax/scene, plots::AbstractPlot...)
Returns true if the mouse currently hovers any of
plots
.
mouseposition(scene = hovered_scene())
Return the current position of the mouse in
data coordinates
of the given
scene
.
By default uses the
scene
that the mouse is currently hovering over.
No documentation found.
Makie.mouseposition_px
is a
Function
.
# 3 methods for generic function "mouseposition_px":
[1] mouseposition_px() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:216
[2] mouseposition_px(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:216
[3] mouseposition_px(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/interactive_api.jl:215
No documentation found.
GridLayoutBase.ncols
is a
Function
.
# 1 method for generic function "ncols":
[1] ncols(g::GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:1582
No documentation found.
GridLayoutBase.nrows
is a
Function
.
# 1 method for generic function "nrows":
[1] nrows(g::GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:1581
off(observable::AbstractObservable, f)
Removes
f
from listeners of
observable
.
Returns
true
if
f
could be removed, otherwise
false
.
off(obsfunc::ObserverFunction)
Remove the listener function
obsfunc.f
from the listeners of
obsfunc.observable
. Once
obsfunc
goes out of scope, this should allow
obsfunc.f
and all the values it might have closed over to be garbage collected (unless there are other references to it).
old_cam3d_turntable!(scene; kw_args...)
Creates a 3D camera for
scene
, which rotates around the plot's axis.
old_cam3d_cad!(scene; kw_args...)
Creates a 3D camera for
scene
which rotates around the
viewer
's "up" axis - similarly to how it's done in CAD software cameras.
on(f, observable::AbstractObservable; weak = false, priority=0, update=false)::ObserverFunction
Adds function
f
as listener to
observable
. Whenever
observable
's value is set via
observable[] = val
,
f
is called with
val
.
Returns an
ObserverFunction
that wraps
f
and
observable
and allows to disconnect easily by calling
off(observerfunction)
instead of
off(f, observable)
. If instead you want to compute a new
Observable
from an old one, use
map(f, ::Observable)
.
If
weak = true
is set, the new connection will be removed as soon as the returned
ObserverFunction
is not referenced anywhere and is garbage collected. This is useful if some parent object makes connections to outside observables and stores the resulting
ObserverFunction
instances. Then, once that parent object is garbage collected, the weak observable connections are removed automatically.
Example
julia> obs = Observable(0)
Observable(0)
julia> on(obs) do val
println("current value is ", val)
end
ObserverFunction defined at REPL[17]:2 operating on Observable(0)
julia> obs[] = 5;
current value is 5
One can also give the callback a priority, to enable always calling a specific callback before/after others, independent of the order of registration. The callback with the highest priority gets called first, the default is zero, and the whole range of Int can be used. So one can do:
julia> obs = Observable(0)
julia> on(obs; priority=-1) do x
println("Hi from first added")
end
julia> on(obs) do x
println("Hi from second added")
end
julia> obs[] = 2
Hi from second added
Hi from first added
If you set
update=true
, on will call f(obs[]) immediately:
julia> on(Observable(1); update=true) do x
println("hi")
end
hi
on(f, c::Camera, observables::Observable...)
When mapping over observables for the camera, we store them in the
steering_node
vector, to make it easier to disconnect the camera steering signals later!
onany(f, args...)
Calls
f
on updates to any observable refs in
args
.
args
may contain any number of
Observable
objects.
f
will be passed the values contained in the refs as the respective argument. All other objects in
args
are passed as-is.
See also:
on
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === downoutside
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === enter
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftdoubleclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftdown
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftdrag
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftdragstart
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftdragstop
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === leftup
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middleclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middledoubleclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middledown
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middledrag
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middledragstart
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middledragstop
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === middleup
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === out
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === over
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightdoubleclick
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightdown
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightdrag
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightdragstart
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightdragstop
.
Executes the function f whenever the
MouseEventHandle
's observable is set to a MouseEvent with
event.type === rightup
.
onpick(func, plot)
Calls
func
if one clicks on
plot
. Implemented by the backend.
onpick(f, fig/ax/scene, plots::AbstractPlot...)
Calls
f(plot, idx)
whenever the mouse is over any of
plots
.
idx
is an index, e.g. when over a scatter plot, it will be the index of the hovered element
Picks a mouse position. Implemented by the backend.
pick(fig/ax/scene, x, y)
Returns the plot under pixel position
(x, y)
.
pick(fig/ax/scene, xy::VecLike)
Return the plot under pixel position xy.
pick(fig/ax/scene, xy::VecLike, range)
Return the plot closest to xy within a given range.
pick(scene::Scene, rect::Rect2i)
Return all
(plot, index)
pairs within the given rect. The rect must be within screen boundaries.
pie(fractions; kwargs...)
Creates a pie chart with the given
fractions
.
Attributes
Available attributes and their defaults for
Combined{Makie.pie}
are:
color :gray
inner_radius 0
inspectable true
normalize true
offset 0
radius 1
strokecolor :black
strokewidth 1
transparency false
vertex_per_deg 1
visible true
pie(fractions; kwargs...)
Creates a pie chart with the given
fractions
.
Attributes
Available attributes and their defaults for
Combined{Makie.pie!}
are:
No documentation found.
Makie.pixelarea
is a
Function
.
# 3 methods for generic function "pixelarea":
[1] pixelarea(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:467
[2] pixelarea(scene::Union{AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:468
[3] pixelarea(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:466
No documentation found.
MakieCore.plot
is a
Function
.
# 5 methods for generic function "plot":
[1] plot(P::Union{Type{Any}, Type{<:AbstractPlot}}, gsp::GridSubposition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:118
[2] plot(P::Union{Type{Any}, Type{<:AbstractPlot}}, gp::GridPosition, args...; axis, kwargs...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:69
[3] plot(P::Union{Type{Any}, Type{<:AbstractPlot}}, args...; axis, figure, kw_attributes...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/figureplotting.jl:31
[4] plot(scene::Scene, plot::AbstractPlot) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interfaces.jl:191
[5] plot(args...; attributes...) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:33
Main plotting signatures that plot/plot! route to if no Plot Type is given
No documentation found.
MakieCore.plotkey
is a
Function
.
# 3 methods for generic function "plotkey":
[1] plotkey(::Type{<:AbstractPlot{Typ}}) where Typ in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:21
[2] plotkey(::T) where T<:AbstractPlot in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:22
[3] plotkey(::Nothing) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:23
No documentation found.
Makie.plots
is a
Function
.
# 2 methods for generic function "plots":
[1] plots(scene::Union{AbstractScene, MakieCore.ScenePlot}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:471
[2] plots(x) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:470
poly(vertices, indices; kwargs...)
poly(points; kwargs...)
poly(shape; kwargs...)
poly(mesh; kwargs...)
Plots a polygon based on the arguments given. When vertices and indices are given, it functions similarly to
mesh
. When points are given, it draws one polygon that connects all the points in order. When a shape is given (essentially anything decomposable by
GeometryBasics
), it will plot
decompose(shape)
.
poly(coordinates, connectivity; kwargs...)
Plots polygons, which are defined by
coordinates
(the coordinates of the vertices) and
connectivity
(the edges between the vertices).
Attributes
Specific to
Poly
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
)
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = [:black, :white
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the image. SeeMakie.spaces()
for possible inputs. -
cycle::Vector{Symbol} = [:color => :patchcolor]
sets which attributes to cycle when creating multiple plots. -
shading = false
enables lighting.
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
Specific to
Poly
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
linestyle::Union{Nothing, Symbol, Vector} = nothing
sets the pattern of the line (e.g.:solid
,:dot
,:dashdot
)
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
color
is set by the plot. -
colormap::Union{Symbol, Vector{<:Colorant}} = [:black, :white
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for the position of the image. SeeMakie.spaces()
for possible inputs. -
cycle::Vector{Symbol} = [:color => :patchcolor]
sets which attributes to cycle when creating multiple plots. -
shading = false
enables lighting.
Unit in pixels on screen. This one is a bit tricky, since it refers to a static attribute (pixels on screen don't change) but since every visual is attached to a camera, the exact scale might change. So in the end, this is just relative to some normed camera - the value on screen, depending on the camera, will not actually sit on those pixels. Only camera that guarantees the correct mapping is the
:pixel
camera type.
qqnorm(y; kwargs...)
Shorthand for
qqplot(Normal(0,1), y)
, i.e., draw a Q-Q plot of
y
against the standard normal distribution. See
qqplot
for more details.
qqnorm(y; kwargs...)
Shorthand for
qqplot(Normal(0,1), y)
, i.e., draw a Q-Q plot of
y
against the standard normal distribution. See
qqplot
for more details.
qqplot(x, y; kwargs...)
Draw a Q-Q plot, comparing quantiles of two distributions.
y
must be a list of samples, i.e.,
AbstractVector{<:Real}
, whereas
x
can be
-
a list of samples,
-
an abstract distribution, e.g.
Normal(0, 1)
, -
a distribution type, e.g.
Normal
.
In the last case, the distribution type is fitted to the data
y
.
The attribute
qqline
(defaults to
:none
) determines how to compute a fit line for the Q-Q plot. Possible values are the following.
-
:identity
draws the identity line. -
:fit
computes a least squares line fit of the quantile pairs. -
:fitrobust
computes the line that passes through the first and third quartiles of the distributions. -
:none
omits drawing the line.
Broadly speaking,
qqline = :identity
is useful to see if
x
and
y
follow the same distribution, whereas
qqline = :fit
and
qqline = :fitrobust
are useful to see if the distribution of
y
can be obtained from the distribution of
x
via an affine transformation.
Graphical attributes are
-
color
to control color of both line and markers (ifmarkercolor
is not specified) -
linestyle
-
linewidth
-
markercolor
-
strokecolor
-
strokewidth
-
marker
-
markersize
qqplot(x, y; kwargs...)
Draw a Q-Q plot, comparing quantiles of two distributions.
y
must be a list of samples, i.e.,
AbstractVector{<:Real}
, whereas
x
can be
-
a list of samples,
-
an abstract distribution, e.g.
Normal(0, 1)
, -
a distribution type, e.g.
Normal
.
In the last case, the distribution type is fitted to the data
y
.
The attribute
qqline
(defaults to
:none
) determines how to compute a fit line for the Q-Q plot. Possible values are the following.
-
:identity
draws the identity line. -
:fit
computes a least squares line fit of the quantile pairs. -
:fitrobust
computes the line that passes through the first and third quartiles of the distributions. -
:none
omits drawing the line.
Broadly speaking,
qqline = :identity
is useful to see if
x
and
y
follow the same distribution, whereas
qqline = :fit
and
qqline = :fitrobust
are useful to see if the distribution of
y
can be obtained from the distribution of
x
via an affine transformation.
Graphical attributes are
-
color
to control color of both line and markers (ifmarkercolor
is not specified) -
linestyle
-
linewidth
-
markercolor
-
strokecolor
-
strokewidth
-
marker
-
markersize
No documentation found.
Makie.qrotation
is a
Function
.
# 1 method for generic function "qrotation":
[1] qrotation(axis::StaticArraysCore.StaticArray{Tuple{3}, T, 1} where T, theta::Number) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/quaternions.jl:39
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)
Plots arrows at the specified points with the specified components.
u
and
v
are interpreted as vector components (
u
being the x and
v
being the y), and the vectors are plotted with the tails at
x
,
y
.
If
x, y, u, v
are
<: AbstractVector
, then each 'row' is plotted as a single vector.
If
u, v
are
<: AbstractMatrix
, then
x
and
y
are interpreted as specifications for a grid, and
u, v
are plotted as arrows along the grid.
arrows
can also work in three dimensions.
Attributes
Available attributes and their defaults for
Arrows
are:
align :origin
arrowcolor MakieCore.Automatic()
arrowhead MakieCore.Automatic()
arrowsize MakieCore.Automatic()
arrowtail MakieCore.Automatic()
color :black
colormap :viridis
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
lengthscale 1.0f0
linecolor MakieCore.Automatic()
linestyle "nothing"
linewidth MakieCore.Automatic()
markerspace :pixel
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
normalize false
overdraw false
quality 32
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
rainclouds!(ax, category_labels, data_array; plot_boxplots=true, plot_clouds=true, kwargs...)
Plot a violin (/histogram), boxplot and individual data points with appropriate spacing between each.
Arguments
-
ax
: Axis used to place all these plots onto. -
category_labels
: TypicallyVector{String}
with a label for each element indata_array
-
data_array
: TypicallyVector{Float64}
used for to represent the datapoints to plot.
Keywords
-
gap=0.2
: Distance between elements of x-axis. -
side=:left
: Can take values of:left
,:right
, determines where the violin plot will be, relative to the scatter points -
dodge
: vector ofInteger
` (length of data) of grouping variable to create multiple side-by-side boxes at the same x position -
dodge_gap = 0.03
: spacing between dodged boxes -
n_dodge
: the number of categories to dodge (defaults to maximum(dodge)) -
color
: a single color, or a vector of colors, one for each point
Violin/Histogram Plot Specific Keywords
-
clouds=violin
: [violin, hist, nothing] to show cloud plots either as violin or histogram plot, or no cloud plot. -
hist_bins=30
: ifclouds=hist
, this passes down the number of bins to the histogram call. -
cloud_width=1.0
: Determines size of violin plot. Corresponds towidth
keyword arg in
violin
.
-
orientation=:vertical
orientation of raindclouds (:vertical
or:horizontal
) -
violin_limits=(-Inf, Inf)
: specify values to trim theviolin
. Can be aTuple
or aFunction
(e.g.datalimits=extrema
)
Box Plot Specific Keywords
-
plot_boxplots=true
: Boolean to show boxplots to summarize distribution of data. -
boxplot_width=0.1
: Width of the boxplot in category x-axis absolute terms. -
center_boxplot=true
: Determines whether or not to have the boxplot be centered in the category. -
whiskerwidth=0.5
: The width of the Q1, Q3 whisker in the boxplot. Value as a portion of theboxplot_width
. -
strokewidth=1.0
: Determines the stroke width for the outline of the boxplot. -
show_median=true
: Determines whether or not to have a line should the median value in the boxplot. -
boxplot_nudge=0.075
: Determines the distance away the boxplot should be placed from the center line whencenter_boxplot
isfalse
. This is the value used to recentering the boxplot. -
show_boxplot_outliers
: show outliers in the boxplot as points (usually confusing when
paired with the scatter plot so the default is to not show them)
Scatter Plot Specific Keywords
-
side_nudge
: Default value is 0.02 ifplot_boxplots
is true, otherwise0.075
default. -
jitter_width=0.05
: Determines the width of the scatter-plot bar in category x-axis absolute terms. -
markersize=2
: Size of marker used for the scatter plot.
Axis General Keywords
-
title
-
xlabel
-
ylabel
rainclouds!(ax, category_labels, data_array; plot_boxplots=true, plot_clouds=true, kwargs...)
Plot a violin (/histogram), boxplot and individual data points with appropriate spacing between each.
Arguments
-
ax
: Axis used to place all these plots onto. -
category_labels
: TypicallyVector{String}
with a label for each element indata_array
-
data_array
: TypicallyVector{Float64}
used for to represent the datapoints to plot.
Keywords
-
gap=0.2
: Distance between elements of x-axis. -
side=:left
: Can take values of:left
,:right
, determines where the violin plot will be, relative to the scatter points -
dodge
: vector ofInteger
` (length of data) of grouping variable to create multiple side-by-side boxes at the same x position -
dodge_gap = 0.03
: spacing between dodged boxes -
n_dodge
: the number of categories to dodge (defaults to maximum(dodge)) -
color
: a single color, or a vector of colors, one for each point
Violin/Histogram Plot Specific Keywords
-
clouds=violin
: [violin, hist, nothing] to show cloud plots either as violin or histogram plot, or no cloud plot. -
hist_bins=30
: ifclouds=hist
, this passes down the number of bins to the histogram call. -
cloud_width=1.0
: Determines size of violin plot. Corresponds towidth
keyword arg in
violin
.
-
orientation=:vertical
orientation of raindclouds (:vertical
or:horizontal
) -
violin_limits=(-Inf, Inf)
: specify values to trim theviolin
. Can be aTuple
or aFunction
(e.g.datalimits=extrema
)
Box Plot Specific Keywords
-
plot_boxplots=true
: Boolean to show boxplots to summarize distribution of data. -
boxplot_width=0.1
: Width of the boxplot in category x-axis absolute terms. -
center_boxplot=true
: Determines whether or not to have the boxplot be centered in the category. -
whiskerwidth=0.5
: The width of the Q1, Q3 whisker in the boxplot. Value as a portion of theboxplot_width
. -
strokewidth=1.0
: Determines the stroke width for the outline of the boxplot. -
show_median=true
: Determines whether or not to have a line should the median value in the boxplot. -
boxplot_nudge=0.075
: Determines the distance away the boxplot should be placed from the center line whencenter_boxplot
isfalse
. This is the value used to recentering the boxplot. -
show_boxplot_outliers
: show outliers in the boxplot as points (usually confusing when
paired with the scatter plot so the default is to not show them)
Scatter Plot Specific Keywords
-
side_nudge
: Default value is 0.02 ifplot_boxplots
is true, otherwise0.075
default. -
jitter_width=0.05
: Determines the width of the scatter-plot bar in category x-axis absolute terms. -
markersize=2
: Size of marker used for the scatter plot.
Axis General Keywords
-
title
-
xlabel
-
ylabel
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
Combined{Makie.rangebars}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
direction :y
inspectable true
linewidth 1.5
transparency false
visible true
whiskerwidth 0
rangebars(val, low, high; kwargs...)
rangebars(val, low_high; kwargs...)
rangebars(val_low_high; kwargs...)
Plots rangebars at
val
in one dimension, extending from
low
to
high
in the other dimension given the chosen
direction
.
If you want to plot errors relative to a reference value, use
errorbars
.
Attributes
Available attributes and their defaults for
Combined{Makie.rangebars!}
are:
record(func, figurelike, path; backend=current_backend(), kwargs...)
record(func, figurelike, path, iter; backend=current_backend(), 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.
Under the hood,
record
is just
video_io = Record(func, figurelike, [iter]; same_kw...); save(path, video_io)
.
Record
can be used directly as well to do the saving at a later point, or to inline a video directly into a Notebook (the video supports,
show(video_io, "text/html")
for that purpose).
Options one can pass via
kwargs...
:
-
backend::Module = current_backend()
: set the backend to write out video, can be set toCairoMakie
,GLMakie
,WGLMakie
,RPRMakie
.
Backend options
See
?Backend.Screen
or
Base.doc(Backend.Screen)
for applicable options that can be passed and forwarded to the backend.
Video options
-
format = "mkv"
: The format of the video. If a path is present, will be inferred form the file extension. Can be one of the following:-
"mkv"
(open standard, the default) -
"mp4"
(good for Web, most supported format) -
"webm"
(smallest file size) -
"gif"
(largest file size for the same quality)
mp4
andmk4
are marginally bigger thanwebm
.gif
s can be significantly (as much as 6x) larger with worse quality (due to the limited color palette) and only should be used as a last resort, for playing in a context where videos aren't supported. -
-
framerate = 24
: The target framerate. -
compression = 20
: Controls the video compression viaffmpeg
's-crf
option, with smaller numbers giving higher quality and larger file sizes (lower compression), and and higher numbers giving lower quality and smaller file sizes (higher compression). The minimum value is0
(lossless encoding).-
For
mp4
,51
is the maximum. Note thatcompression = 0
only works withmp4
if
profile = high444
.-
For
webm
,63
is the maximum. -
compression
has no effect onmkv
andgif
outputs.
-
-
profile = "high422"
: A ffmpeg compatible profile. Currently only applies tomp4
. 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
.
!!! warning
`profile` and `pixel_format` are only used when `format` is `"mp4"`; a warning will be issued if `format`
is not `"mp4"` and those two arguments are not `nothing`. Similarly, `compression` is only
valid when `format` is `"mp4"` or `"webm"`.
Typical usage
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
record_events(f, scene::Scene, path::String)
Records all window events that happen while executing function
f
for
scene
and serializes them to
path
.
recordframe!(io::VideoStream)
Adds a video frame to the VideoStream
io
.
register_interaction!(parent, name::Symbol, interaction)
Register
interaction
with
parent
under the name
name
. The parent will call
process_interaction(interaction, event, parent)
whenever suitable events happen.
The interaction can be removed with
deregister_interaction!
or temporarily toggled with
activate_interaction!
/
deactivate_interaction!
.
register_interaction!(interaction::Function, parent, name::Symbol)
Register
interaction
with
parent
under the name
name
. The parent will call
process_interaction(interaction, event, parent)
whenever suitable events happen. This form with the first
Function
argument is especially intended for
do
syntax.
The interaction can be removed with
deregister_interaction!
or temporarily toggled with
activate_interaction!
/
deactivate_interaction!
.
Like
get!(f, dict, key)
but also calls
f
and replaces
key
when the corresponding value is nothing
replay events(f, scene::Scene, path::String) replay events(scene::Scene, path::String)
Replays the serialized events recorded with
record_events
in
path
in
scene
.
resample_cmap(cmap, ncolors::Integer; alpha=1.0)
-
cmap: anything that
to_colormap
accepts -
ncolors: number of desired colors
-
alpha: additional alpha applied to each color. Can also be an array, matching
colors
, or a tuple giving a start + stop alpha value.
reset_limits!(ax; xauto = true, yauto = true)
Resets the axis limits depending on the value of
ax.limits
. If one of the two components of limits is nothing, that value is either copied from the targetlimits if
xauto
or
yauto
is false, respectively, or it is determined automatically from the plots in the axis. If one of the components is a tuple of two numbers, those are used directly.
resize_to_layout!(fig::Figure)
Resize
fig
so that it fits the current contents of its top
GridLayout
. If a
GridLayout
contains fixed-size content or aspect-constrained columns, for example, it is likely that the solved size of the
GridLayout
differs from the size of the
Figure
. This can result in superfluous whitespace at the borders, or content clipping at the figure edges. Once resized, all content should fit the available space, including the
Figure
's outer padding.
No documentation found.
Makie.right
is a
Function
.
# 1 method for generic function "right":
[1] right(rect::Rect2) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:3
rotate!(Accum, scene::Transformable, axis_rot...)
Apply a relative rotation to the Scene, by multiplying by the current rotation.
rotate!(t::Transformable, axis_rot::Quaternion)
rotate!(t::Transformable, axis_rot::AbstractFloat)
rotate!(t::Transformable, axis_rot...)
Apply an absolute rotation to the Scene. Rotations are all internally converted to
Quaternion
s.
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!(gl::GridLayout, i::Int64, s::Union{Fixed, Relative, Real})
rowgap!(gl::GridLayout, s::Union{Fixed, Relative, Real})
Set the gap between rows in
gl
. The two-argument version sets all row gaps in
gl
. The three-argument version sets the gap between rows
i
and
i+1
. Passing a real number to
s
has the same behaviour as passing
Fixed(s)
.
-
save(filename, data...)
saves the contents of a formatted file, trying to infer the format fromfilename
. -
save(Stream{format"PNG"}(io), data...)
specifies the format directly, and bypasses the formatquery
. -
save(File{format"PNG"}(filename), data...)
specifies the format directly, and bypasses the formatquery
. -
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 topx
for GLMakie and WGLMakie).
CairoMakie
-
pt_per_unit
: The size of one scene unit inpt
when exporting to a vector format. -
px_per_unit
: The size of one scene unit inpx
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)
Flushes the video stream and saves it to
path
. Ideally,
path
's file extension is the same as the format that the
VideoStream
was created with (e.g., if created with format "mp4" then
path
's file extension must be ".mp4"). Otherwise, the video will get converted to the target format. If using
record
then this is handled for you, as the
VideoStream
's format is deduced from the file extension of the path passed to
record
.
scale!(t::Transformable, x, y)
scale!(t::Transformable, x, y, z)
scale!(t::Transformable, xyz)
scale!(t::Transformable, xyz...)
Scale the given
Transformable
(a Scene or Plot) to the given arguments. Can take
x, y
or
x, y, z
. This is an absolute scaling, and there is no option to perform relative scaling.
scatter(positions)
scatter(x, y)
scatter(x, y, z)
Plots a marker for each element in
(x, y, z)
,
(x, y)
, or
positions
.
Attributes
Specific to
Scatter
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
marker::Union{Symbol, Char, Matrix{<:Colorant}, BezierPath, Polygon}
sets the scatter marker. -
markersize::Union{<:Real, Vec2f} = 9
sets the size of the marker. -
markerspace::Symbol = :pixel
sets the space in whichmarkersize
is given. SeeMakie.spaces()
for possible inputs. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
glowwidth::Real = 0
sets the size of a glow effect around the marker. -
glowcolor::Union{Symbol, <:Colorant} = (:black, 0)
sets the color of the glow effect. -
rotations::Union{Real, Billboard, Quaternion} = Billboard(0f0)
sets the rotation of the marker. ABillboard
rotation is always around the depth axis. -
transform_marker::Bool = false
controls whether the model matrix (without translation) applies to the marker itself, rather than just the positions. (If this is true,scale!
androtate!
will affect the marker.)
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that scatter plots already include a different form of anti-aliasing when plotting non-image markers. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered marker by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for positions of markers. SeeMakie.spaces()
for possible inputs.
scatter(positions)
scatter(x, y)
scatter(x, y, z)
Plots a marker for each element in
(x, y, z)
,
(x, y)
, or
positions
.
Attributes
Specific to
Scatter
-
cycle::Vector{Symbol} = [:color]
sets which attributes to cycle when creating multiple plots. -
marker::Union{Symbol, Char, Matrix{<:Colorant}, BezierPath, Polygon}
sets the scatter marker. -
markersize::Union{<:Real, Vec2f} = 9
sets the size of the marker. -
markerspace::Symbol = :pixel
sets the space in whichmarkersize
is given. SeeMakie.spaces()
for possible inputs. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
glowwidth::Real = 0
sets the size of a glow effect around the marker. -
glowcolor::Union{Symbol, <:Colorant} = (:black, 0)
sets the color of the glow effect. -
rotations::Union{Real, Billboard, Quaternion} = Billboard(0f0)
sets the rotation of the marker. ABillboard
rotation is always around the depth axis. -
transform_marker::Bool = false
controls whether the model matrix (without translation) applies to the marker itself, rather than just the positions. (If this is true,scale!
androtate!
will affect the marker.)
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that scatter plots already include a different form of anti-aliasing when plotting non-image markers. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered marker by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for positions of markers. SeeMakie.spaces()
for possible inputs.
scatterlines(xs, ys, [zs]; kwargs...)
Plots
scatter
markers and
lines
between them.
Attributes
Available attributes and their defaults for
Combined{Makie.scatterlines}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
inspectable true
linestyle "nothing"
linewidth 1.5
marker :circle
markercolor MakieCore.Automatic()
markercolormap :viridis
markercolorrange MakieCore.Automatic()
markersize 12
strokecolor :black
strokewidth 0
scatterlines(xs, ys, [zs]; kwargs...)
Plots
scatter
markers and
lines
between them.
Attributes
Available attributes and their defaults for
Combined{Makie.scatterlines!}
are:
Registers a callback for the mouse scroll. returns an
Observable{Vec{2, Float64}}
, which is an x and y offset.
GLFW Docs
select_line(scene; kwargs...) -> line
Interactively select a line (typically an arrow) on a 2D
scene
by clicking the left mouse button, dragging and then un-clicking. Return an
observable
whose value corresponds to the selected line on the scene. In addition the function
plots
the line on the scene as the user clicks and moves the mouse around. When the button is not clicked any more, the plotted line disappears.
The value of the returned line is updated only when the user un-clicks and only if the selected line has non-zero length.
The
kwargs...
are propagated into
lines!
which plots the selected line.
select_point(scene; kwargs...) -> point
Interactively select a point on a 2D
scene
by clicking the left mouse button, dragging and then un-clicking. Return an
observable
whose value corresponds to the selected point on the scene. In addition the function
plots
the point on the scene as the user clicks and moves the mouse around. When the button is not clicked any more, the plotted point disappears.
The value of the returned point is updated only when the user un-clicks.
The
kwargs...
are propagated into
scatter!
which plots the selected point.
select_rectangle(scene; kwargs...) -> rect
Interactively select a rectangle on a 2D
scene
by clicking the left mouse button, dragging and then un-clicking. The function returns an
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(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, whilex
goes from1:size(curves, 1)
-
AbstractVector, AbstractMatrix
: the same as the above, but the first argument sets the x values for all lines -
AbstractVector{<: Tuple{X<: AbstractVector, Y<: AbstractVector}}
: A vector of tuples, where each tuple contains a vector for the x and y coordinates
series(curves;
linewidth=2,
color=:lighttest,
solid_color=nothing,
labels=nothing,
# scatter arguments, if any is set != nothing, a scatterplot is added
marker=nothing,
markersize=nothing,
markercolor=automatic,
strokecolor=nothing,
strokewidth=nothing)
Curves can be:
-
AbstractVector{<: AbstractVector{<: Point2}}
: the native representation of a series as a vector of lines -
AbstractMatrix
: each row represents y coordinates of the line, whilex
goes from1:size(curves, 1)
-
AbstractVector, AbstractMatrix
: the same as the above, but the first argument sets the x values for all lines -
AbstractVector{<: Tuple{X<: AbstractVector, Y<: AbstractVector}}
: A vector of tuples, where each tuple contains a vector for the x and y coordinates
Set the
slider
to the value in the slider's range that is closest to
value
and return this value.
Set the
slider
to the values in the slider's range that are closest to
v1
and
v2
, and return those values ordered min, misl.
set_theme(theme; kwargs...)
Set the global default theme to
theme
and add / override any attributes given as keyword arguments.
showgradients(
cgrads::AbstractVector{Symbol};
h = 0.0, offset = 0.2, textsize = 0.7,
resolution = (800, length(cgrads) * 84)
)::Scene
Plots the given colour gradients arranged as horizontal colourbars. If you change the offsets or the font size, you may need to change the resolution.
spy(x::Range, y::Range, z::AbstractSparseArray)
Visualizes big sparse matrices. Usage:
N = 200_000
x = sprand(Float64, N, N, (3(10^6)) / (N*N));
spy(x)
# or if you want to specify the range of x and y:
spy(0..1, 0..1, x)
Attributes
Available attributes and their defaults for
Combined{Makie.spy}
are:
colormap :viridis
colorrange MakieCore.Automatic()
framecolor :black
framesize 1
inspectable true
marker MakieCore.Automatic()
markersize MakieCore.Automatic()
visible true
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
Combined{Makie.spy!}
are:
stairs(xs, ys; kwargs...)
Plot a stair function.
The
step
parameter can take the following values:
-
:pre
: horizontal part of step extends to the left of each value inxs
. -
:post
: horizontal part of step extends to the right of each value inxs
. -
:center
: horizontal part of step extends halfway between the two adjacent values ofxs
.
The conversion trait of stem is
PointBased
.
Attributes
Available attributes and their defaults for
Combined{Makie.stairs}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
linestyle "nothing"
linewidth 1.5
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
step :pre
transparency false
visible true
stairs(xs, ys; kwargs...)
Plot a stair function.
The
step
parameter can take the following values:
-
:pre
: horizontal part of step extends to the left of each value inxs
. -
:post
: horizontal part of step extends to the right of each value inxs
. -
:center
: horizontal part of step extends halfway between the two adjacent values ofxs
.
The conversion trait of stem is
PointBased
.
Attributes
Available attributes and their defaults for
Combined{Makie.stairs!}
are:
stem(xs, ys, [zs]; kwargs...)
Plots markers at the given positions extending from
offset
along stem lines.
offset
can be a number, in which case it sets y for 2D, and z for 3D stems. It can be a Point2 for 2D plots, as well as a Point3 for 3D plots. It can also be an iterable of any of these at the same length as xs, ys, zs.
The conversion trait of stem is
PointBased
.
Attributes
Available attributes and their defaults for
Combined{Makie.stem}
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [[:stemcolor, :color, :trunkcolor] => :color]
inspectable true
marker :circle
markersize 12
offset 0
stemcolor :black
stemcolormap :viridis
stemcolorrange MakieCore.Automatic()
stemlinestyle "nothing"
stemwidth 1.5
strokecolor :black
strokewidth 0
trunkcolor :black
trunkcolormap :viridis
trunkcolorrange MakieCore.Automatic()
trunklinestyle "nothing"
trunkwidth 1.5
visible true
stem(xs, ys, [zs]; kwargs...)
Plots markers at the given positions extending from
offset
along stem lines.
offset
can be a number, in which case it sets y for 2D, and z for 3D stems. It can be a Point2 for 2D plots, as well as a Point3 for 3D plots. It can also be an iterable of any of these at the same length as xs, ys, zs.
The conversion trait of stem is
PointBased
.
Attributes
Available attributes and their defaults for
Combined{Makie.stem!}
are:
streamplot(f::function, xinterval, yinterval; kwargs...)
f must either accept
f(::Point)
or
f(x::Number, y::Number)
. f must return a Point2.
Example:
v(x::Point2{T}) where T = Point2f(x[2], 4*x[1])
streamplot(v, -2..2, -2..2)
Attributes
Available attributes and their defaults for
Combined{Makie.streamplot}
are:
arrow_head MakieCore.Automatic()
arrow_size 10
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
density 1.0
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
gridsize (32, 32, 32)
inspectable true
linestyle "nothing"
linewidth 1.5
maxsteps 500
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
quality 16
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
stepsize 0.01
transparency false
visible true
Implementation
See the function
Makie.streamplot_impl
for implementation details.
streamplot(f::function, xinterval, yinterval; kwargs...)
f must either accept
f(::Point)
or
f(x::Number, y::Number)
. f must return a Point2.
Example:
v(x::Point2{T}) where T = Point2f(x[2], 4*x[1])
streamplot(v, -2..2, -2..2)
Attributes
Available attributes and their defaults for
Combined{Makie.streamplot!}
are:
Implementation
See the function
Makie.streamplot_impl
for implementation details.
surface(x, y, z)
Plots a surface, where
(x, y)
define a grid whose heights are the entries in
z
.
x
and
y
may be
Vectors
which define a regular grid,
or
Matrices
which define an irregular grid.
Surface
has the conversion trait
ContinuousSurface <: SurfaceLike
.
Attributes
Specific to
Surface
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
invert_normals::Bool = false
inverts the normals generated for the surface. This can be useful to illuminate the other side of the surface.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for vertices generated by surface. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
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
has the conversion trait
ContinuousSurface <: SurfaceLike
.
Attributes
Specific to
Surface
-
lowclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value below the colorrange. -
highclip::Union{Nothing, Symbol, <:Colorant} = nothing
sets a color for any value above the colorrange. -
invert_normals::Bool = false
inverts the normals generated for the surface. This can be useful to illuminate the other side of the surface.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for vertices generated by surface. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
Swaps or rotates the layout positions of the given elements to their neighbor's.
text(positions; text, kwargs...)
text(x, y; text, kwargs...)
text(x, y, z; text, kwargs...)
Plots one or multiple texts passed via the
text
keyword.
Text
uses the
PointBased
conversion trait.
Attributes
Specific to
Text
-
text
specifies one piece of text or a vector of texts to show, where the number has to match the number of positions given. Makie supportsString
which is used for all normal text andLaTeXString
which layouts mathematical expressions usingMathTeXEngine.jl
. -
align::Tuple{Union{Symbol, Real}, Union{Symbol, Real}} = (:left, :bottom)
sets the alignment of the string w.r.t.position
. Uses:left, :center, :right, :top, :bottom, :baseline
or fractions. -
font::Union{String, Vector{String}} = "TeX Gyre Heros Makie"
sets the font for the string or each character. -
justification::Union{Real, Symbol} = automatic
sets the alignment of text w.r.t its bounding box. Can be:left, :center, :right
or a fraction. Will default to the horizontal alignment inalign
. -
rotation::Union{Real, Quaternion}
rotates text around the given position. -
textsize::Union{Real, Vec2f}
sets the size of each character. -
markerspace::Symbol = :pixel
sets the space in whichtextsize
acts. SeeMakie.spaces()
for possible inputs. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
glowwidth::Real = 0
sets the size of a glow effect around the marker. -
glowcolor::Union{Symbol, <:Colorant} = (:black, 0)
sets the color of the glow effect. -
word_wrap_with::Real = -1
specifies a linewidth limit for text. If a word overflows this limit, a newline is inserted before it. Negative numbers disable word wrapping.
Generic attributes
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that text plots already include a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each character by passing aVector
of colors. -
space::Symbol = :data
sets the transformation space for text positions. SeeMakie.spaces()
for possible inputs.
text(positions; text, kwargs...)
text(x, y; text, kwargs...)
text(x, y, z; text, kwargs...)
Plots one or multiple texts passed via the
text
keyword.
Text
uses the
PointBased
conversion trait.
Attributes
Specific to
Text
-
text
specifies one piece of text or a vector of texts to show, where the number has to match the number of positions given. Makie supportsString
which is used for all normal text andLaTeXString
which layouts mathematical expressions usingMathTeXEngine.jl
. -
align::Tuple{Union{Symbol, Real}, Union{Symbol, Real}} = (:left, :bottom)
sets the alignment of the string w.r.t.position
. Uses:left, :center, :right, :top, :bottom, :baseline
or fractions. -
font::Union{String, Vector{String}} = "TeX Gyre Heros Makie"
sets the font for the string or each character. -
justification::Union{Real, Symbol} = automatic
sets the alignment of text w.r.t its bounding box. Can be:left, :center, :right
or a fraction. Will default to the horizontal alignment inalign
. -
rotation::Union{Real, Quaternion}
rotates text around the given position. -
textsize::Union{Real, Vec2f}
sets the size of each character. -
markerspace::Symbol = :pixel
sets the space in whichtextsize
acts. SeeMakie.spaces()
for possible inputs. -
strokewidth::Real = 0
sets the width of the outline around a marker. -
strokecolor::Union{Symbol, <:Colorant} = :black
sets the color of the outline around a marker. -
glowwidth::Real = 0
sets the size of a glow effect around the marker. -
glowcolor::Union{Symbol, <:Colorant} = (:black, 0)
sets the color of the glow effect. -
word_wrap_with::Real = -1
specifies a linewidth limit for text. If a word overflows this limit, a newline is inserted before it. Negative numbers disable word wrapping.
Generic attributes
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). Note that text plots already include a different form of anti-aliasing. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each character by passing aVector
of colors. -
space::Symbol = :data
sets the transformation space for text positions. SeeMakie.spaces()
for possible inputs.
No documentation found.
MakieCore.theme
is a
Function
.
# 6 methods for generic function "theme":
[1] theme(x::AbstractScene) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:57
[2] theme(x::AbstractScene, key) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:58
[3] theme(x::Union{AbstractScene, MakieCore.ScenePlot}, args...) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:56
[4] theme(x::AbstractPlot) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/attributes.jl:156
[5] theme(x::AbstractPlot, key) in MakieCore at /home/runner/work/Makie.jl/Makie.jl/MakieCore/src/recipes.jl:59
[6] theme(::Nothing, key::Symbol) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/theming.jl:191
No documentation found.
Makie.theme_black
is a
Function
.
# 1 method for generic function "theme_black":
[1] theme_black() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_black.jl:1
No documentation found.
Makie.theme_dark
is a
Function
.
# 1 method for generic function "theme_dark":
[1] theme_dark() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_dark.jl:1
No documentation found.
Makie.theme_ggplot2
is a
Function
.
# 1 method for generic function "theme_ggplot2":
[1] theme_ggplot2() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_ggplot2.jl:1
No documentation found.
Makie.theme_light
is a
Function
.
# 1 method for generic function "theme_light":
[1] theme_light() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_light.jl:1
No documentation found.
Makie.theme_minimal
is a
Function
.
# 1 method for generic function "theme_minimal":
[1] theme_minimal() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/themes/theme_minimal.jl:1
Sets the space allocated for the xticklabels and yticklabels of the
Axis
to the minimum that is needed.
space = tight_ticklabel_spacing!(cb::Colorbar)
Sets the space allocated for the ticklabels of the
Colorbar
to the minimum that is needed and returns that value.
space = tight_xticklabel_spacing!(ax::Axis)
Sets the space allocated for the yticklabels of the
Axis
to the minimum that is needed and returns that value.
space = tight_xticklabel_spacing!(ax::Axis)
Sets the space allocated for the xticklabels of the
Axis
to the minimum that is needed and returns that value.
tightlimits!(la::Axis)
Sets the autolimit margins to zero on all sides.
tightlimits!(la::Axis, sides::Union{Left, Right, Bottom, Top}...)
Sets the autolimit margins to zero on all given sides.
Example:
tightlimits!(laxis, Bottom())
timeseries(x::Observable{{Union{Number, Point2}}})
Plots a sampled signal. Usage:
signal = Observable(1.0)
scene = timeseries(signal)
display(scene)
# @async is optional, but helps to continue evaluating more code
@async while isopen(scene)
# aquire data from e.g. a sensor:
data = rand()
# update the signal
signal[] = data
# sleep/ wait for new data/ whatever...
# It's important to yield here though, otherwise nothing will be rendered
sleep(1/30)
end
timeseries(x::Observable{{Union{Number, Point2}}})
Plots a sampled signal. Usage:
signal = Observable(1.0)
scene = timeseries(signal)
display(scene)
# @async is optional, but helps to continue evaluating more code
@async while isopen(scene)
# aquire data from e.g. a sensor:
data = rand()
# update the signal
signal[] = data
# sleep/ wait for new data/ whatever...
# It's important to yield here though, otherwise nothing will be rendered
sleep(1/30)
end
Text align, e.g.:
No documentation found.
Makie.to_color
is a
Function
.
# 10 methods for generic function "to_color":
[1] to_color(c::Real) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:763
[2] to_color(c::ColorTypes.Colorant) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:764
[3] to_color(p::Makie.AbstractPattern) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:769
[4] to_color(c::AbstractArray{<:ColorTypes.Colorant, N}) where N in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:768
[5] to_color(c::AbstractArray) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:767
[6] to_color(c::Tuple{Any, Number}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:770
[7] to_color(p::Makie.Palette) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:756
[8] to_color(c::Nothing) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:762
[9] to_color(c::Symbol) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:765
[10] to_color(c::String) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:766
to_colormap(b::AbstractVector)
An
AbstractVector{T}
with any object that
to_color
accepts.
to_colormap(cs::Union{String, Symbol})::Vector{RGBAf}
A Symbol/String naming the gradient. For more on what names are available please see:
available_gradients()
. For now, we support gradients from
PlotUtils
natively.
font conversion
a string naming a font, e.g. helvetica
No documentation found.
Makie.to_ndim
is a
Function
.
# 1 method for generic function "to_ndim":
[1] to_ndim(T::Type{<:Union{Tuple{Vararg{ET, N}}, StaticArraysCore.StaticArray{Tuple{N}, ET, 1}}}, vec::Union{Tuple{Vararg{T, N2}}, StaticArraysCore.StaticArray{Tuple{N2}, T, 1}} where T, fillval) where {N, ET, N2} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:230
rotation accepts:
to_rotation(b, quaternion)
to_rotation(b, tuple_float)
to_rotation(b, vec4)
No documentation found.
Makie.to_textsize
is a
Function
.
# 2 methods for generic function "to_textsize":
[1] to_textsize(x::Number) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:985
[2] to_textsize(x::AbstractVector{T}) where T<:Number in Makie at /home/runner/work/Makie.jl/Makie.jl/src/conversions.jl:986
to_value(x::Union{Any, AbstractObservable})
Extracts the value of an observable, and returns the object if it's not an observable!
No documentation found.
Makie.to_vector
is a
Function
.
# 3 methods for generic function "to_vector":
[1] to_vector(x::AbstractVector, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:253
[2] to_vector(x::AbstractArray, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:254
[3] to_vector(x::IntervalSets.ClosedInterval, len, T) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/utilities/utilities.jl:261
No documentation found.
Makie.to_world
is a
Function
.
# 3 methods for generic function "to_world":
[1] to_world(scene::Scene, point::T) where T<:(StaticArraysCore.StaticArray{Tuple{N}, T, 1} where {N, T}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:241
[2] to_world(p::Vec{N, T}, prj_view_inv::StaticArraysCore.SMatrix{4, 4, T, 16} where T, cam_res::StaticArraysCore.StaticArray{Tuple{N}, T, 1} where {N, T}) where {N, T} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:272
[3] to_world(p::StaticArraysCore.StaticArray{Tuple{N}, T, 1}, prj_view_inv::StaticArraysCore.SMatrix{4, 4, T, 16} where T, cam_res::StaticArraysCore.StaticArray{Tuple{N}, T, 1} where {N, T}) where {N, T} in Makie at /home/runner/work/Makie.jl/Makie.jl/src/camera/projection_math.jl:256
tooltip(position, string)
tooltip(x, y, string)
Creates a tooltip pointing at
position
displaying the given
string
Attributes
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
space::Symbol = :data
sets the transformation space for positions of markers. SeeMakie.spaces()
for possible inputs.
Tooltip specific
-
offset = 10
sets the offset between the givenposition
and the tip of the triangle pointing at that position. -
placement = :above
sets where the tooltipü should be placed relative toposition
. Can be:above
,:below
,:left
,:right
. -
align = 0.5
sets the alignment of the tooltip relativeposition
. Withalign = 0.5
the tooltip is centered above/below/left/right theposition
. -
backgroundcolor = :white
sets the background color of the tooltip. -
triangle_size = 10
sets the size of the triangle pointing atposition
. -
outline_color = :black
sets the color of the tooltip outline. -
outline_linewidth = 2f0
sets the linewidth of the tooltip outline. -
outline_linestyle = nothing
sets the linestyle of the tooltip outline. -
textpadding = (4, 4, 4, 4)
sets the padding around text in the tooltip. This is given as(left, right, bottom top)
offsets. -
textcolor = theme(scene, :textcolor)
sets the text color. -
textsize = 16
sets the text size. -
font = theme(scene, :font)
sets the font. -
strokewidth = 0
: Gives text an outline if set to a positive value. -
strokecolor = :white
sets the text outline color. -
justification = :left
sets whether text is aligned to the:left
,:center
or:right
within its bounding box.
tooltip(position, string)
tooltip(x, y, string)
Creates a tooltip pointing at
position
displaying the given
string
Attributes
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
space::Symbol = :data
sets the transformation space for positions of markers. SeeMakie.spaces()
for possible inputs.
Tooltip specific
-
offset = 10
sets the offset between the givenposition
and the tip of the triangle pointing at that position. -
placement = :above
sets where the tooltipü should be placed relative toposition
. Can be:above
,:below
,:left
,:right
. -
align = 0.5
sets the alignment of the tooltip relativeposition
. Withalign = 0.5
the tooltip is centered above/below/left/right theposition
. -
backgroundcolor = :white
sets the background color of the tooltip. -
triangle_size = 10
sets the size of the triangle pointing atposition
. -
outline_color = :black
sets the color of the tooltip outline. -
outline_linewidth = 2f0
sets the linewidth of the tooltip outline. -
outline_linestyle = nothing
sets the linestyle of the tooltip outline. -
textpadding = (4, 4, 4, 4)
sets the padding around text in the tooltip. This is given as(left, right, bottom top)
offsets. -
textcolor = theme(scene, :textcolor)
sets the text color. -
textsize = 16
sets the text size. -
font = theme(scene, :font)
sets the font. -
strokewidth = 0
: Gives text an outline if set to a positive value. -
strokecolor = :white
sets the text outline color. -
justification = :left
sets whether text is aligned to the:left
,:center
or:right
within its bounding box.
No documentation found.
Makie.top
is a
Function
.
# 1 method for generic function "top":
[1] top(rect::Rect2) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/geometrybasics_extension.jl:5
translate!(scene::Transformable, xyz::VecTypes)
translate!(scene::Transformable, xyz...)
Apply an absolute translation to the Scene, translating it to
x, y, z
.
translate!(Accum, scene::Transformable, xyz...)
Translate the scene relative to its current position.
translate_cam!(scene::Scene, translation::VecTypes)
Translate the camera by a translation vector given in camera space.
No documentation found.
Makie.translated
is a
Function
.
# 2 methods for generic function "translated":
[1] translated(scene::Scene; kw_args...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:58
[2] translated(scene::Scene, translation...) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:52
No documentation found.
Makie.translation
is a
Function
.
# 1 method for generic function "translation":
[1] translation(scene::MakieCore.Transformable) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/layouting/transformation.jl:133
tricontourf(xs, ys, zs; kwargs...)
Plots a filled tricontour of the height information in
zs
at horizontal positions
xs
and vertical positions
ys
.
Attributes
Specific to
Tricontourf
-
levels = 10
can be either anInt
which results in n bands delimited by n+1 equally spaced levels, or it can be anAbstractVector{<:Real}
that lists n consecutive edges from low to high, which result in n-1 bands. -
mode = :normal
sets the way in which a vector of levels is interpreted, if it's set to:relative
, each number is interpreted as a fraction between the minimum and maximum values ofzs
. For example,levels = 0.1:0.1:1.0
would exclude the lower 10% of data. -
extendlow = nothing
. This sets the color of an optional additional band fromminimum(zs)
to the lowest value inlevels
. If it's:auto
, the lower end of the colormap is picked and the remaining colors are shifted accordingly. If it's any color representation, this color is used. If it'snothing
, no band is added. -
extendhigh = nothing
. This sets the color of an optional additional band from the highest value oflevels
tomaximum(zs)
. If it's:auto
, the high end of the colormap is picked and the remaining colors are shifted accordingly. If it's any color representation, this color is used. If it'snothing
, no band is added. -
triangulation = DelaunayTriangulation()
. The mode with which the points inxs
andys
are triangulated. PassingDelaunayTriangulation()
performs a delaunay triangulation. You can also pass a preexisting triangulation as anAbstractMatrix{<:Int}
with size (3, n), where each column specifies the vertex indices of one triangle.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered marker by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap from which the band colors are sampled.
Attributes
Available attributes and their defaults for
Combined{Makie.tricontourf}
are:
colormap :viridis
extendhigh "nothing"
extendlow "nothing"
inspectable true
levels 10
mode :normal
nan_color :transparent
transparency false
triangulation Makie.DelaunayTriangulation()
tricontourf(xs, ys, zs; kwargs...)
Plots a filled tricontour of the height information in
zs
at horizontal positions
xs
and vertical positions
ys
.
Attributes
Specific to
Tricontourf
-
levels = 10
can be either anInt
which results in n bands delimited by n+1 equally spaced levels, or it can be anAbstractVector{<:Real}
that lists n consecutive edges from low to high, which result in n-1 bands. -
mode = :normal
sets the way in which a vector of levels is interpreted, if it's set to:relative
, each number is interpreted as a fraction between the minimum and maximum values ofzs
. For example,levels = 0.1:0.1:1.0
would exclude the lower 10% of data. -
extendlow = nothing
. This sets the color of an optional additional band fromminimum(zs)
to the lowest value inlevels
. If it's:auto
, the lower end of the colormap is picked and the remaining colors are shifted accordingly. If it's any color representation, this color is used. If it'snothing
, no band is added. -
extendhigh = nothing
. This sets the color of an optional additional band from the highest value oflevels
tomaximum(zs)
. If it's:auto
, the high end of the colormap is picked and the remaining colors are shifted accordingly. If it's any color representation, this color is used. If it'snothing
, no band is added. -
triangulation = DelaunayTriangulation()
. The mode with which the points inxs
andys
are triangulated. PassingDelaunayTriangulation()
performs a delaunay triangulation. You can also pass a preexisting triangulation as anAbstractMatrix{<:Int}
with size (3, n), where each column specifies the vertex indices of one triangle.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = false
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
color
sets the color of the plot. It can be given as a named colorSymbol
or aColors.Colorant
. Transparency can be included either directly as an alpha value in theColorant
or as an additional float in a tuple(color, alpha)
. The color can also be set for each scattered marker by passing aVector
of colors or be used to index thecolormap
by passing aReal
number orVector{<: Real}
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap from which the band colors are sampled.
Attributes
Available attributes and their defaults for
Combined{Makie.tricontourf!}
are:
No documentation found.
GridLayoutBase.trim!
is a
Function
.
# 1 method for generic function "trim!":
[1] trim!(gl::GridLayout) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:562
Registers a callback for keyboard unicode input. returns an
Observable{Vector{Char}}
, containing the pressed char. Is empty, if no key is pressed.
GLFW Docs
update_cam!(scene::SceneLike, area)
Updates the camera for the given
scene
to cover the given
area
in 2d.
update_cam!(scene::SceneLike)
Updates the camera for the given
scene
to cover the limits of the
Scene
. Useful when using the
Observable
pipeline.
update_cam!(scene::Scene, eyeposition, lookat, up = Vec3f(0, 0, 1))
Updates the camera's controls to point to the specified location.
update_theme!(with_theme::Theme; kwargs...)
Updates the current theme incrementally, that means only the keys given in
with_theme
or through keyword arguments are changed, the rest is left intact. Nested attributes are either also updated incrementally, or replaced if they are not attributes in the new theme.
used_attributes(args...) = ()
Function used to indicate what keyword args one wants to get passed in
convert_arguments
. Those attributes will not be forwarded to the backend, but only used during the conversion pipeline. Usage:
struct MyType end
used_attributes(::MyType) = (:attribute,)
function convert_arguments(x::MyType; attribute = 1)
...
end
# attribute will get passed to convert_arguments
# without keyword_verload, this wouldn't happen
plot(MyType, attribute = 2)
#You can also use the convenience macro, to overload convert_arguments in one step:
@keywords convert_arguments(x::MyType; attribute = 1)
...
end
vbox!(content::Vararg; kwargs...)
Creates a single-column GridLayout with all elements contained in
content
placed from top to bottom.
violin(x, y; kwargs...)
Draw a violin plot.
Arguments
-
x
: positions of the categories -
y
: variables whose density is computed
Keywords
-
weights
: vector of statistical weights (length of data). By default, each observation has weight1
. -
orientation=:vertical
: orientation of the violins (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_median=false
: show median as midline -
side=:both
: specify:left
or:right
to only plot the violin on one side -
datalimits
: specify values to trim theviolin
. Can be aTuple
or aFunction
(e.g.datalimits=extrema
)
violin(x, y; kwargs...)
Draw a violin plot.
Arguments
-
x
: positions of the categories -
y
: variables whose density is computed
Keywords
-
weights
: vector of statistical weights (length of data). By default, each observation has weight1
. -
orientation=:vertical
: orientation of the violins (:vertical
or:horizontal
) -
width=1
: width of the box before shrinking -
gap=0.2
: shrinking factor,width -> width * (1 - gap)
-
show_median=false
: show median as midline -
side=:both
: specify:left
or:right
to only plot the violin on one side -
datalimits
: specify values to trim theviolin
. Can be aTuple
or aFunction
(e.g.datalimits=extrema
)
vlines(xs; ymin = 0.0, ymax = 1.0, attrs...)
Create vertical lines across a
Scene
with 2D projection. The lines will be placed at
xs
in data coordinates and
ymin
to
ymax
in scene coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.
All style attributes are the same as for
LineSegments
.
vlines(xs; ymin = 0.0, ymax = 1.0, attrs...)
Create vertical lines across a
Scene
with 2D projection. The lines will be placed at
xs
in data coordinates and
ymin
to
ymax
in scene coordinates (0 to 1). All three of these can have single or multiple values because they are broadcast to calculate the final line segments.
All style attributes are the same as for
LineSegments
.
volume(volume_data)
volume(x, y, z, volume_data)
Plots a volume, with optional physical dimensions
x, y, z
. Available algorithms are:
-
:iso
=> IsoValue -
:absorption
=> Absorption -
:mip
=> MaximumIntensityProjection -
:absorptionrgba
=> AbsorptionRGBA -
:additive
=> AdditiveRGBA -
:indexedabsorption
=> IndexedAbsorptionRGBA
Attributes
Specific to
Volume
-
algorithm::Union{Symbol, RaymarchAlgorithm} = :mip
sets the volume algorithm that is used. -
isorange::Real = 0.05
sets the range of values picked up by the IsoValue algorithm. -
isovalue = 0.5
sets the target value for the IsoValue algorithm.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for box encompassing the volume plot. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
volume(volume_data)
volume(x, y, z, volume_data)
Plots a volume, with optional physical dimensions
x, y, z
. Available algorithms are:
-
:iso
=> IsoValue -
:absorption
=> Absorption -
:mip
=> MaximumIntensityProjection -
:absorptionrgba
=> AbsorptionRGBA -
:additive
=> AdditiveRGBA -
:indexedabsorption
=> IndexedAbsorptionRGBA
Attributes
Specific to
Volume
-
algorithm::Union{Symbol, RaymarchAlgorithm} = :mip
sets the volume algorithm that is used. -
isorange::Real = 0.05
sets the range of values picked up by the IsoValue algorithm. -
isovalue = 0.5
sets the target value for the IsoValue algorithm.
Generic
-
visible::Bool = true
sets whether the plot will be rendered or not. -
overdraw::Bool = false
sets whether the plot will draw over other plots. This specifically means ignoring depth checks in GL backends. -
transparency::Bool = false
adjusts how the plot deals with transparency. In GLMakietransparency = true
results in using Order Independent Transparency. -
fxaa::Bool = true
adjusts whether the plot is rendered with fxaa (anti-aliasing). -
inspectable::Bool = true
sets whether this plot should be seen byDataInspector
. -
depth_shift::Float32 = 0f0
adjusts the depth value of a plot after all other transformations, i.e. in clip space, where0 <= depth <= 1
. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw). -
model::Makie.Mat4f
sets a model matrix for the plot. This replaces adjustments made withtranslate!
,rotate!
andscale!
. -
colormap::Union{Symbol, Vector{<:Colorant}} = :viridis
sets the colormap that is sampled for numericcolor
s. -
colorrange::Tuple{<:Real, <:Real}
sets the values representing the start and end points ofcolormap
. -
nan_color::Union{Symbol, <:Colorant} = RGBAf(0,0,0,0)
sets a replacement color forcolor = NaN
. -
space::Symbol = :data
sets the transformation space for box encompassing the volume plot. SeeMakie.spaces()
for possible inputs.
Generic 3D
-
shading = true
enables lighting. -
diffuse::Vec3f = Vec3f(0.4)
sets how strongly the red, green and blue channel react to diffuse (scattered) light. -
specular::Vec3f = Vec3f(0.2)
sets how strongly the object reflects light in the red, green and blue channels. -
shininess::Real = 32.0
sets how sharp the reflection is. -
ssao::Bool = false
adjusts whether the plot is rendered with ssao (screen space ambient occlusion). Note that this only makes sense in 3D plots and is only applicable withfxaa = true
.
VolumeSlices
volumeslices(x, y, z, v)
Draws heatmap slices of the volume v
Attributes
Available attributes and their defaults for
Combined{Makie.volumeslices}
are:
bbox_color RGBA{Float32}(0.5f0,0.5f0,0.5f0,0.5f0)
bbox_visible true
colormap :viridis
colorrange MakieCore.Automatic()
depth_shift 0.0f0
diffuse Float32[0.4, 0.4, 0.4]
highclip MakieCore.Automatic()
inspectable true
interpolate false
levels 1
linewidth 0.0
lowclip MakieCore.Automatic()
nan_color :transparent
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
VolumeSlices
volumeslices(x, y, z, v)
Draws heatmap slices of the volume v
Attributes
Available attributes and their defaults for
Combined{Makie.volumeslices!}
are:
vspan(xs_low, xs_high; ymin = 0.0, ymax = 1.0, attrs...)
Create vertical bands spanning across a
Scene
with 2D projection. The bands will be placed from
xs_low
to
xs_high
in data coordinates and
ymin
to
ymax
in scene coordinates (0 to 1). All four of these can have single or multiple values because they are broadcast to calculate the final spans.
All style attributes are the same as for
Poly
.
vspan(xs_low, xs_high; ymin = 0.0, ymax = 1.0, attrs...)
Create vertical bands spanning across a
Scene
with 2D projection. The bands will be placed from
xs_low
to
xs_high
in data coordinates and
ymin
to
ymax
in scene coordinates (0 to 1). All four of these can have single or multiple values because they are broadcast to calculate the final spans.
All style attributes are the same as for
Poly
.
waterfall(x, y; kwargs...)
Plots a waterfall chart to visualize individual positive and negative components that add up to a net result as a barplot with stacked bars next to each other.
Attributes
Available attributes and their defaults for
Combined{Makie.waterfall}
are:
cycle [:color => :patchcolor]
direction_color :white
dodge MakieCore.Automatic()
dodge_gap 0.03
final_color RGBA{Float64}(0.8980392156862745,0.8980392156862745,0.8980392156862745,0.5)
final_dodge_gap 0
final_gap MakieCore.Automatic()
gap 0.2
marker_neg :dtriangle
marker_pos :utriangle
n_dodge MakieCore.Automatic()
show_direction false
show_final false
stack MakieCore.Automatic()
width MakieCore.Automatic()
Furthermore the same attributes as for
barplot
are supported.
waterfall(x, y; kwargs...)
Plots a waterfall chart to visualize individual positive and negative components that add up to a net result as a barplot with stacked bars next to each other.
Attributes
Available attributes and their defaults for
Combined{Makie.waterfall!}
are:
Furthermore the same attributes as for
barplot
are supported.
No documentation found.
GeometryBasics.width
is a
Function
.
# 1 method for generic function "width":
[1] width(prim::GeometryBasics.HyperRectangle) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/primitives/rectangles.jl:164
No documentation found.
GeometryBasics.widths
is a
Function
.
# 4 methods for generic function "widths":
[1] widths(prim::GeometryBasics.HyperRectangle) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/primitives/rectangles.jl:162
[2] widths(c::GeometryBasics.HyperSphere{N, T}) where {N, T} in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/primitives/spheres.jl:28
[3] widths(x::AbstractRange) in GeometryBasics at /home/runner/.julia/packages/GeometryBasics/KE3OI/src/geometry_primitives.jl:4
[4] widths(scene::Scene) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/scenes.jl:288
No documentation found.
Makie.window_area
is a
Function
.
# 2 methods for generic function "window_area":
[1] window_area(scene::Scene, screen::GLMakie.Screen) in GLMakie at /home/runner/work/Makie.jl/Makie.jl/GLMakie/src/events.jl:70
[2] window_area(scene, native_window) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/interaction/events.jl:3
Returns a signal, which is true as long as the window is open. returns
Observable{Bool}
GLFW Docs
wireframe(x, y, z)
wireframe(positions)
wireframe(mesh)
Draws a wireframe, either interpreted as a surface or as a mesh.
Attributes
Available attributes and their defaults for
Wireframe
are:
color :black
colormap :viridis
colorrange MakieCore.Automatic()
cycle [:color]
depth_shift -1.0f-5
diffuse Float32[0.4, 0.4, 0.4]
inspectable true
linestyle "nothing"
linewidth 1.5
nan_color RGBA{Float32}(0.0f0,0.0f0,0.0f0,0.0f0)
overdraw false
shininess 32.0f0
space :data
specular Float32[0.2, 0.2, 0.2]
ssao false
transparency false
visible true
See
wireframe
.
with_theme(f, theme = Theme(); kwargs...)
Calls
f
with
theme
temporarily activated. Attributes in
theme
can be overridden or extended with
kwargs
. The previous theme is always restored afterwards, no matter if
f
succeeds or fails.
Example:
my_theme = Theme(resolution = (500, 500), color = :red)
with_theme(my_theme, color = :blue, linestyle = :dashed) do
scatter(randn(100, 2))
end
No documentation found.
GridLayoutBase.with_updates_suspended
is a
Function
.
# 1 method for generic function "with_updates_suspended":
[1] with_updates_suspended(f::Function, gl::GridLayout; update) in GridLayoutBase at /home/runner/.julia/packages/GridLayoutBase/lYdxT/src/gridlayout.jl:231
xlabel!([scene,] xlabel)
Set the x-axis label for the given Scene. Defaults to using the current Scene.
No documentation found.
Makie.xlims!
is a
Function
.
# 6 methods for generic function "xlims!":
[1] xlims!() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1258
[2] xlims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1254
[3] xlims!(ax::Axis3, xlims::Tuple{Union{Nothing, Real}, Union{Nothing, Real}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:836
[4] xlims!(ax::Axis, xlims) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1216
[5] xlims!(ax; low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1258
[6] xlims!(ax, low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1250
xticklabels(scene)
Returns the all the x-axis tick labels. See also
ticklabels
.
xtickrange(scene)
Returns the tick range along the x-axis. See also
tickranges
.
xtickrotation(scene)
Returns the rotation of tick labels along the x-axis. See also
tickrotations
xtickrotation!([scene,] xangle)
Set the rotation of tick labels along the x-axis. See also
tickrotations!
.
xticks!([scene,]; xtickrange=xtickrange(scene), xticklabels=xticklabel(scene))
Set the tick labels and range along the x-axes. See also
ticks!
.
ylabel!([scene,] ylabel)
Set the y-axis label for the given Scene. Defaults to using the current Scene.
No documentation found.
Makie.ylims!
is a
Function
.
# 6 methods for generic function "ylims!":
[1] ylims!() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1259
[2] ylims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1255
[3] ylims!(ax::Axis3, ylims::Tuple{Union{Nothing, Real}, Union{Nothing, Real}}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:853
[4] ylims!(ax::Axis, ylims) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1233
[5] ylims!(ax; low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1259
[6] ylims!(ax, low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1251
yticklabels(scene)
Returns the all the y-axis tick labels. See also
ticklabels
.
ytickrange(scene)
Returns the tick range along the y-axis. See also
tickranges
.
ytickrotation(scene)
Returns the rotation of tick labels along the y-axis. See also
tickrotations
ytickrotation!([scene,] yangle)
Set the rotation of tick labels along the y-axis. See also
tickrotations!
.
yticks!([scene,]; ytickrange=ytickrange(scene), yticklabels=yticklabel(scene))
Set the tick labels and range along all the y-axis. See also
ticks!
.
zlabel!([scene,] zlabel)
Set the z-axis label for the given Scene. Defaults to using the current Scene.
Warning
The Scene must have an Axis3D. If not, then this function will error.
No documentation found.
Makie.zlims!
is a
Function
.
# 5 methods for generic function "zlims!":
[1] zlims!() in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1260
[2] zlims!(low::Union{Nothing, Real}, high::Union{Nothing, Real}) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1256
[3] zlims!(ax::Axis3, zlims) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis3d.jl:870
[4] zlims!(ax; low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1260
[5] zlims!(ax, low, high) in Makie at /home/runner/work/Makie.jl/Makie.jl/src/makielayout/blocks/axis.jl:1252
zoom!(scene, zoom_step)
Zooms the camera in or out based on the multiplier
zoom_step
. A
zoom_step
of 1.0 is neutral, larger zooms out and lower zooms in.
Note that this method only applies to Camera3D.
zoom!(scene, point, zoom_step, shift_lookat::Bool)
Zooms the camera of
scene
in towards
point
by a factor of
zoom_step
. A positive
zoom_step
zooms in while a negative
zoom_step
zooms out.
zticklabels(scene)
Returns the all the z-axis tick labels. See also
ticklabels
.
ztickrange(scene)
Returns the tick range along the z-axis. See also
tickranges
.
ztickrotation(scene)
Returns the rotation of tick labels along the z-axis. See also
tickrotations
ztickrotation!([scene,] zangle)
Set the rotation of tick labels along the z-axis. See also
tickrotations!
.
zticks!([scene,]; ztickranges=ztickrange(scene), zticklabels=zticklabel(scene))
Set the tick labels and range along all z-axis. See also
ticks!
.
These docs were autogenerated using Makie: v0.18.4, GLMakie: v0.7.4, CairoMakie: v0.9.4, WGLMakie: v0.7.4