API

Makie.ABLines Type

ABLines is the plot type associated with plotting function ablines. Check the docstring for ablines for further information.

source

Makie.Absolute Type

julia

Absolute

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

source

Makie.Accum Type

julia

Accum

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

source

Makie.AmbientLight Type

julia

AmbientLight(color) <: AbstractLight

A simple ambient light that uniformly lights every object based on its light color.

Availability:

All backends with shading = FastShading or MultiLightShading

source

Makie.Annotations Type

Annotations is the plot type associated with plotting function annotations. Check the docstring for annotations for further information.

source

Makie.Arc Type

Arc is the plot type associated with plotting function arc. Check the docstring for arc for further information.

source

Makie.Axis Type

Makie.Axis <: Block

A 2D axis which can be plotted into.

Constructors

julia

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

Attributes

(type ?Makie.Axis.x in the REPL for more information about attribute x)

alignmode, aspect, autolimitaspect, backgroundcolor, bottomspinecolor, bottomspinevisible, dim1_conversion, dim2_conversion, flip_ylabel, halign, height, leftspinecolor, leftspinevisible, limits, panbutton, rightspinecolor, rightspinevisible, spinewidth, subtitle, subtitlecolor, subtitlefont, subtitlegap, subtitlelineheight, subtitlesize, subtitlevisible, tellheight, tellwidth, title, titlealign, titlecolor, titlefont, titlegap, titlelineheight, titlesize, titlevisible, topspinecolor, topspinevisible, valign, width, xautolimitmargin, xaxisposition, xgridcolor, xgridstyle, xgridvisible, xgridwidth, xlabel, xlabelcolor, xlabelfont, xlabelpadding, xlabelrotation, xlabelsize, xlabelvisible, xminorgridcolor, xminorgridstyle, xminorgridvisible, xminorgridwidth, xminortickalign, xminortickcolor, xminorticks, xminorticksize, xminorticksvisible, xminortickwidth, xpankey, xpanlock, xrectzoom, xreversed, xscale, xtickalign, xtickcolor, xtickformat, xticklabelalign, xticklabelcolor, xticklabelfont, xticklabelpad, xticklabelrotation, xticklabelsize, xticklabelspace, xticklabelsvisible, xticks, xticksize, xticksmirrored, xticksvisible, xtickwidth, xtrimspine, xzoomkey, xzoomlock, yautolimitmargin, yaxisposition, ygridcolor, ygridstyle, ygridvisible, ygridwidth, ylabel, ylabelcolor, ylabelfont, ylabelpadding, ylabelrotation, ylabelsize, ylabelvisible, yminorgridcolor, yminorgridstyle, yminorgridvisible, yminorgridwidth, yminortickalign, yminortickcolor, yminorticks, yminorticksize, yminorticksvisible, yminortickwidth, ypankey, ypanlock, yrectzoom, yreversed, yscale, ytickalign, ytickcolor, ytickformat, yticklabelalign, yticklabelcolor, yticklabelfont, yticklabelpad, yticklabelrotation, yticklabelsize, yticklabelspace, yticklabelsvisible, yticks, yticksize, yticksmirrored, yticksvisible, ytickwidth, ytrimspine, yzoomkey, yzoomlock, zoombutton

source

Makie.Axis3 Type

Makie.Axis3 <: Block

No docstring defined.

Attributes

(type ?Makie.Axis3.x in the REPL for more information about attribute x)

alignmode, aspect, axis_translation_mod, azimuth, backgroundcolor, clip_decorations, cursorfocuskey, dim1_conversion, dim2_conversion, dim3_conversion, elevation, front_spines, halign, height, limits, near, perspectiveness, protrusions, targetlimits, tellheight, tellwidth, title, titlealign, titlecolor, titlefont, titlegap, titlesize, titlevisible, valign, viewmode, width, xautolimitmargin, xgridcolor, xgridvisible, xgridwidth, xlabel, xlabelalign, xlabelcolor, xlabelfont, xlabeloffset, xlabelrotation, xlabelsize, xlabelvisible, xreversed, xspinecolor_1, xspinecolor_2, xspinecolor_3, xspinecolor_4, xspinesvisible, xspinewidth, xtickcolor, xtickformat, xticklabelcolor, xticklabelfont, xticklabelpad, xticklabelsize, xticklabelsvisible, xticks, xticksize, xticksvisible, xtickwidth, xtranslationkey, xtranslationlock, xypanelcolor, xypanelvisible, xzoomkey, xzoomlock, xzpanelcolor, xzpanelvisible, yautolimitmargin, ygridcolor, ygridvisible, ygridwidth, ylabel, ylabelalign, ylabelcolor, ylabelfont, ylabeloffset, ylabelrotation, ylabelsize, ylabelvisible, yreversed, yspinecolor_1, yspinecolor_2, yspinecolor_3, yspinecolor_4, yspinesvisible, yspinewidth, ytickcolor, ytickformat, yticklabelcolor, yticklabelfont, yticklabelpad, yticklabelsize, yticklabelsvisible, yticks, yticksize, yticksvisible, ytickwidth, ytranslationkey, ytranslationlock, yzoomkey, yzoomlock, yzpanelcolor, yzpanelvisible, zautolimitmargin, zgridcolor, zgridvisible, zgridwidth, zlabel, zlabelalign, zlabelcolor, zlabelfont, zlabeloffset, zlabelrotation, zlabelsize, zlabelvisible, zoommode, zreversed, zspinecolor_1, zspinecolor_2, zspinecolor_3, zspinecolor_4, zspinesvisible, zspinewidth, ztickcolor, ztickformat, zticklabelcolor, zticklabelfont, zticklabelpad, zticklabelsize, zticklabelsvisible, zticks, zticksize, zticksvisible, ztickwidth, ztranslationkey, ztranslationlock, zzoomkey, zzoomlock

source

Makie.Band Type

Band is the plot type associated with plotting function band. Check the docstring for band for further information.

source

Makie.BarPlot Type

BarPlot is the plot type associated with plotting function barplot. Check the docstring for barplot for further information.

source

Makie.BezierPath Type

julia

BezierPath(commands::Vector)

Construct a BezierPath with a vector of path commands. The available path commands are

MoveTo
LineTo
CurveTo
EllipticalArc
ClosePath

A BezierPath can be used in certain places in Makie as an alternative to a polygon or a collection of lines, for example as an input to poly or lines, or as a marker for scatter.

The benefit of using a BezierPath is that curves do not need to be converted into a vector of vertices by the user. CairoMakie can use the path commands directly when it writes vector graphics which is more efficient and uses less space than approximating them visually using line segments.

source

Makie.BezierPath Method

julia

BezierPath(svg::AbstractString; fit = false, bbox = nothing, flipy = false, flipx = false, keep_aspect = true)

Construct a BezierPath using a string of SVG path commands. The commands will be parsed first into MoveTo, LineTo, CurveTo, EllipticalArc and ClosePath objects which are then passed to the BezierPath constructor.

If fit === true, the path will be scaled to fit into a square of width 1 centered on the origin. If, additionally, bbox is set to some Rect, the path will be fit into this rectangle instead. If you want to use a path as a scatter marker, it is usually good to fit it so that it's centered and of a comparable size relative to other scatter markers.

If flipy === true or flipx === true, the respective dimensions of the path will be flipped. Makie uses a coordinate system where y=0 is at the bottom and y increases upwards while in SVG, y=0 is at the top and y increases downwards, so for most SVG paths flipy = true will be needed.

If keep_aspect === true, the path will be fit into the bounding box such that its longer dimension fits and the other one is scaled to retain the original aspect ratio. If you set keep_aspect = false, the new boundingbox of the path will be the one it is fit to, but note that this can result in a squished appearance.

Example

Construct a triangular BezierPath out of a path command string and use it as a scatter marker:

julia

str = "M 0,0 L 10,0 L 5,10 z"
bp = BezierPath(str, fit = true)
scatter(1:10, marker = bp, markersize = 20)

source

Makie.Box Type

Makie.Box <: Block

No docstring defined.

Attributes

(type ?Makie.Box.x in the REPL for more information about attribute x)

alignmode, color, cornerradius, halign, height, linestyle, strokecolor, strokevisible, strokewidth, tellheight, tellwidth, valign, visible, width

source

Makie.BoxPlot Type

BoxPlot is the plot type associated with plotting function boxplot. Check the docstring for boxplot for further information.

source

Makie.Bracket Type

Bracket is the plot type associated with plotting function bracket. Check the docstring for bracket for further information.

source

Makie.Button Type

Makie.Button <: Block

No docstring defined.

Attributes

(type ?Makie.Button.x in the REPL for more information about attribute x)

alignmode, buttoncolor, buttoncolor_active, buttoncolor_hover, clicks, cornerradius, cornersegments, font, fontsize, halign, height, label, labelcolor, labelcolor_active, labelcolor_hover, padding, strokecolor, strokewidth, tellheight, tellwidth, valign, width

source

Makie.Camera Type

julia

Camera(pixel_area)

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

Fields

pixel_space::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}: projection used to convert pixel to device units
view::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}: View matrix is usually used to rotate, scale and translate the scene
projection::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}: Projection matrix is used for any perspective transformation
projectionview::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}: just projection * view
resolution::Observable{Vec{2, Float32}}: resolution of the canvas this camera draws to
view_direction::Observable{Vec{3, Float32}}: Direction in which the camera looks.
eyeposition::Observable{Vec{3, Float32}}: Eye position of the camera, used for e.g. ray tracing.
upvector::Observable{Vec{3, Float32}}: Up direction of the current camera (e.g. Vec3f(0, 1, 0) for 2d)
steering_nodes::Vector{Observables.ObserverFunction}: To make camera interactive, steering observables are connected to the different matrices. We need to keep track of them, so, that we can connect and disconnect them.
calculated_values::Dict{Symbol, Observable}

source

Makie.Camera3D Method

julia

Camera3D(scene[; kwargs...])

Sets up a 3D camera with mouse and keyboard controls.

The behavior of the camera can be adjusted via keyword arguments or the fields settings and controls.

Settings

Settings include anything that isn't a mouse or keyboard button.

projectiontype = Perspective sets the type of the projection. Can be Orthographic or Perspective.
rotation_center = :lookat sets the default center for camera rotations. Currently allows :lookat or :eyeposition.
fixed_axis = true: If true panning uses the (world/plot) z-axis instead of the camera up direction.
zoom_shift_lookat = true: If true keeps the data under the cursor when zooming.
cad = false: If true rotates the view around lookat when zooming off-center.
clipping_mode = :adaptive: Controls how near and far get processed. Options:
- :static passes near and far as is
- :adaptive scales near by norm(eyeposition - lookat) and passes far as is
- :view_relative scales near and far by norm(eyeposition - lookat)
- :bbox_relative scales near and far to the scene bounding box as passed to the camera with update_cam!(..., bbox). (More specifically far = 1 is scaled to the furthest point of a bounding sphere and near is generally overwritten to be the closest point.)
center = true: Controls whether the camera placement gets reset when calling center!(scene), which is called when a new plot is added.
keyboard_rotationspeed = 1.0 sets the speed of keyboard based rotations.
keyboard_translationspeed = 0.5 sets the speed of keyboard based translations.
keyboard_zoomspeed = 1.0 sets the speed of keyboard based zooms.
mouse_rotationspeed = 1.0 sets the speed of mouse rotations.
mouse_translationspeed = 0.5 sets the speed of mouse translations.
mouse_zoomspeed = 1.0 sets the speed of mouse zooming (mousewheel).
circular_rotation = (false, false, false) 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.)

Controls

Controls include any kind of hotkey setting.

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 (translate eyeposition towards lookat).
zoom_out_key = Keyboard.o sets the key for zooming out of the scene (translate eyeposition away from lookat).
increase_fov_key = Keyboard.b sets the key for increasing the fov.
decrease_fov_key = Keyboard.n sets the key for decreasing the fov.
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.
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.left_control & Mouse.left sets the key for resetting the camera. This equivalent to calling center!(scene).
reposition_button = Keyboard.left_alt & Mouse.left sets the key for focusing the camera on a plot object.
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)

Other kwargs

Some keyword arguments are used to initialize fields. These include

eyeposition = Vec3d(3): The position of the camera.
lookat = Vec3d(0): The point the camera is focused on.
upvector = Vec3d(0, 0, 1): The world direction corresponding to the up direction of the screen.
fov = 45.0 is the field of view. This is irrelevant if the camera uses an orthographic projection.
near = automatic sets the position of the near clip plane. Anything between the camera and the near clip plane is hidden. Must be greater 0. Usage depends on clipping_mode.
far = automatic sets the position of the far clip plane. Anything further away than the far clip plane is hidden. Usage depends on clipping_mode. Defaults to 1 for clipping_mode = :bbox_relative, 2 for :view_relative or a value derived from limits for :static.

Note that updating these observables in an active camera requires a call to update_cam(scene) for them to be applied. For updating eyeposition, lookat and/or upvector update_cam!(scene, eyeposition, lookat, upvector = Vec3d(0,0,1)) is preferred.

The camera position and orientation can also be adjusted via the functions

translate_cam!(scene, v) will translate the camera by the given world/plot space vector v.
rotate_cam!(scene, angles) will rotate the camera around its axes with the corresponding angles. The first angle will rotate around the cameras "right" that is the screens horizontal axis, the second around the up vector/vertical axis or Vec3d(0, 0, +-1) if fixed_axis = true, and the third will rotate around the view direction i.e. the axis out of the screen. The rotation respects the current rotation_center of the camera.
zoom!(scene, zoom_step) will change the zoom level of the scene without translating or rotating the scene. zoom_step applies multiplicatively to cam.zoom_mult which is used as a multiplier to the fov (perspective projection) or width and height (orthographic projection).

source

Makie.Categorical Type

julia

Categorical(colormaplike)

Accepts all colormap values that the colormap attribute of a plot accepts. Will make sure to map one value to one color and create the correct Colorbar for the plot.

Example:

julia

fig, ax, pl = barplot(1:3; color=1:3, colormap=Makie.Categorical(:viridis))

Warning

This feature might change outside breaking releases, since the API is not yet finalized

source

Makie.Checkbox Type

Makie.Checkbox <: Block

No docstring defined.

Attributes

(type ?Makie.Checkbox.x in the REPL for more information about attribute x)

alignmode, checkboxcolor_checked, checkboxcolor_unchecked, checkboxstrokecolor_checked, checkboxstrokecolor_unchecked, checkboxstrokewidth, checked, checkmark, checkmarkcolor_checked, checkmarkcolor_unchecked, checkmarksize, halign, height, onchange, roundness, size, tellheight, tellwidth, valign, width

source

Makie.ClosePath Type

julia

ClosePath()

A path command for use within a BezierPath which closes the current subpath. The resulting path will have an implicit line segment between the last point and the first point if they do not match.

source

Makie.Colorbar Type

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

julia

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

(type ?Makie.Colorbar.x in the REPL for more information about attribute x)

alignmode, bottomspinecolor, bottomspinevisible, colormap, colorrange, flip_vertical_label, flipaxis, halign, height, highclip, label, labelcolor, labelfont, labelpadding, labelrotation, labelsize, labelvisible, leftspinecolor, leftspinevisible, limits, lowclip, minortickalign, minortickcolor, minorticks, minorticksize, minorticksvisible, minortickwidth, nsteps, rightspinecolor, rightspinevisible, scale, size, spinewidth, tellheight, tellwidth, tickalign, tickcolor, tickformat, ticklabelalign, ticklabelcolor, ticklabelfont, ticklabelpad, ticklabelrotation, ticklabelsize, ticklabelspace, ticklabelsvisible, ticks, ticksize, ticksvisible, tickwidth, topspinecolor, topspinevisible, valign, vertical, width

source

Makie.Contour Type

Contour is the plot type associated with plotting function contour. Check the docstring for contour for further information.

source

Makie.Contour3d Type

Contour3d is the plot type associated with plotting function contour3d. Check the docstring for contour3d for further information.

source

Makie.Contourf Type

Contourf is the plot type associated with plotting function contourf. Check the docstring for contourf for further information.

source

Makie.CrossBar Type

CrossBar is the plot type associated with plotting function crossbar. Check the docstring for crossbar for further information.

source

Makie.CurveTo Type

julia

CurveTo(c1::VecTypes, c2::VecTypes, p::VecTypes)
CurveTo(cx1::Real, cy1::Real, cx2::Real, cy2::Real, px::Real, py::Real)

A path command for use within a BezierPath which continues the current subpath with a cubic bezier curve to point p, with the first control point c1 and the second control point c2.

source

Makie.Cycled Type

julia

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.

source

Makie.DataInspector Method

julia

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 be 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 with enable!(inspector) and disable!(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.
apply_tooltip_offset = true: Enables or disables offsetting tooltips based on, for example, markersize.
and all attributes from Tooltip

source

Makie.DataShader Type

DataShader is the plot type associated with plotting function datashader. Check the docstring for datashader for further information.

source

Makie.Density Type

Density is the plot type associated with plotting function density. Check the docstring for density for further information.

source

Makie.DirectionalLight Type

julia

DirectionalLight(color, direction[, camera_relative = false])

A light type which simulates a distant light source with parallel light rays going in the given direction.

Availability:

All backends with shading = FastShading or MultiLightShading

source

Makie.ECDFPlot Type

ECDFPlot is the plot type associated with plotting function ecdfplot. Check the docstring for ecdfplot for further information.

source

Makie.EllipticalArc Type

julia

EllipticalArc(c::VecTypes, r1::Real, r2::Real, angle::Real, a1::Real, a2::Real)
EllipticalArc(cx::Real, cy::Real, r1::Real, r2::Real, angle::Real, a1::Real, a2::Real)

A path command for use within a BezierPath which continues the current subpath with an elliptical arc. The ellipse is centered at c and has two radii, r1 and r2, the orientation of which depends on angle.

If angle == 0, r1 goes in x direction and r2 in y direction. A positive angle in radians rotates the ellipse counterclockwise, and a negative angle clockwise.

The angles a1 and a2 are the start and stop positions of the arc on the ellipse. A value of 0 is where the radius r1 points to, pi/2 is where the radius r2 points to, and so on. If a2 > a1, the arc turns counterclockwise. If a1 > a2, it turns clockwise.

If the last position of the subpath does not equal the start of the arc, the resulting path will have an implicit line segment between the two.

source

Makie.EllipticalArc Method

julia

EllipticalArc(x1::Real, y1::Real, x2::Real, y2::Real, rx::Real, ry::Real, ϕ::Real, largearc::Bool, sweepflag::Bool)

Construct an EllipticalArc using the endpoint parameterization.

x1, y1 is the starting point and x2, y2 the end point, rx and ry are the two ellipse radii. ϕ is the angle of rx vs the x axis.

Usually, four arcs can be constructed between two points given these ellipse parameters. One of them is chosen using two boolean flags:

If largearc === true, the arc will be longer than 180 degrees. If sweepflag === true, the arc will sweep through increasing angles.

source

Makie.EnvironmentLight Type

julia

EnvironmentLight(intensity, image)

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

Availability:

RPRMakie

source

Makie.Errorbars Type

Errorbars is the plot type associated with plotting function errorbars. Check the docstring for errorbars for further information.

source

Makie.Events Type

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

Functions that act on an 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 executed 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 relevant event.button and event.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 relevant event.key and event.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.
tick::Observable{Makie.Tick}: A tick is triggered whenever a new frame is requested, i.e. during normal rendering (even if the renderloop is paused) or when an image is produced for save or record. A Tick contains:
- state which identifies what caused the tick (see Makie.TickState)
- count which increments with every tick
- time which is the total time since the screen has been created
- delta_time which is the time since the last frame

source

Makie.Exclusively Type

julia

Exclusively(x)

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

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

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

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

source

Makie.FastPixel Type

julia

FastPixel()

Use

julia

scatter(..., marker=FastPixel())

For significantly faster plotting times for large amount of points. Note, that this will draw markers always as 1 pixel.

source

Makie.Figure Method

julia

Figure(; [figure_padding,] kwargs...)

Construct a Figure which allows to place Blocks like Axis, Colorbar and Legend inside. The outer padding of the figure (the distance of the content to the edges) can be set by passing either one number or a tuple of four numbers for left, right, bottom and top paddings via the figure_padding keyword.

All other keyword arguments such as size and backgroundcolor are forwarded to the Scene owned by the figure which acts as the container for all other visual objects.

source

Makie.HLines Type

HLines is the plot type associated with plotting function hlines. Check the docstring for hlines for further information.

source

Makie.HSpan Type

HSpan is the plot type associated with plotting function hspan. Check the docstring for hspan for further information.

source

Makie.Hexbin Type

Hexbin is the plot type associated with plotting function hexbin. Check the docstring for hexbin for further information.

source

Makie.Hist Type

Hist is the plot type associated with plotting function hist. Check the docstring for hist for further information.

source

Makie.IntervalSlider Type

Makie.IntervalSlider <: Block

No docstring defined.

Attributes

(type ?Makie.IntervalSlider.x in the REPL for more information about attribute x)

alignmode, color_active, color_active_dimmed, color_inactive, halign, height, horizontal, interval, linewidth, range, snap, startvalues, tellheight, tellwidth, valign, width

source

Makie.IntervalsBetween Type

julia

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

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

source

Makie.LScene Type

Makie.LScene <: Block

No docstring defined.

Attributes

(type ?Makie.LScene.x in the REPL for more information about attribute x)

alignmode, dim1_conversion, dim2_conversion, dim3_conversion, halign, height, show_axis, tellheight, tellwidth, valign, width

source

Makie.Label Type

Makie.Label <: Block

No docstring defined.

Attributes

(type ?Makie.Label.x in the REPL for more information about attribute x)

alignmode, color, font, fontsize, halign, height, justification, lineheight, padding, rotation, tellheight, tellwidth, text, valign, visible, width, word_wrap

source

Makie.Legend Type

julia

Legend(
    fig_or_scene,
    contents::AbstractArray,
    labels::AbstractArray,
    title = nothing;
    kwargs...)

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

source

Makie.Legend Type

julia

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

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

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

source

Makie.Legend Type

Makie.Legend <: Block

No docstring defined.

Attributes

(type ?Makie.Legend.x in the REPL for more information about attribute x)

alignmode, backgroundcolor, bgcolor, colgap, framecolor, framevisible, framewidth, gridshalign, gridsvalign, groupgap, halign, height, label, labelcolor, labelfont, labelhalign, labeljustification, labelsize, labelvalign, linecolor, linecolormap, linecolorrange, linepoints, linestyle, linewidth, margin, marker, markercolor, markercolormap, markercolorrange, markerpoints, markersize, markerstrokecolor, markerstrokewidth, nbanks, orientation, padding, patchcolor, patchlabelgap, patchsize, patchstrokecolor, patchstrokewidth, polycolor, polycolormap, polycolorrange, polypoints, polystrokecolor, polystrokewidth, rowgap, tellheight, tellwidth, titlecolor, titlefont, titlegap, titlehalign, titleposition, titlesize, titlevalign, titlevisible, valign, width

source

Makie.Legend Method

julia

Legend(
    fig_or_scene,
    contentgroups::AbstractVector{<:AbstractVector},
    labelgroups::AbstractVector{<:AbstractVector},
    titles::AbstractVector;
    kwargs...)

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

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

source

Makie.LineTo Type

julia

LineTo(p::VecTypes)
LineTo(x::Real, y::Real)

A path command for use within a BezierPath which continues the current subpath with a line to the given point.

source

Makie.LinearTicks Type

LinearTicks with ideally a number of n_ideal tick marks.

source

Makie.Linestyle Type

julia

Linestyle(value::Vector{<:Real})

A type that can be used as value for the linestyle keyword argument of plotting functions to arbitrarily customize the linestyle.

The value is a vector specifying the boundaries of the dashes in the line. Values 1 and 2 demarcate the first dash, values 2 and 3 the first gap, and so on. This means that usually, a pattern should have an odd number of values so that there's always a gap after a dash.

Here's an example in ASCII code. If we specify [0, 3, 6, 11, 16] then we get the following pattern:

#  0  3   6   11   16  3  6   11
#   ---   -----     ---   -----

source

Makie.LogTicks Type

julia

LogTicks{T}(linear_ticks::T)

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

source

Type

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

julia

Menu(fig_or_scene; default = nothing, kwargs...)

Examples

Menu with string entries, second preselected:

julia

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

Menu with two-element entries, label and function:

julia

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:

julia

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

Attributes

(type ?Makie.Menu.x in the REPL for more information about attribute x)

alignmode, cell_color_active, cell_color_hover, cell_color_inactive_even, cell_color_inactive_odd, direction, dropdown_arrow_color, dropdown_arrow_size, fontsize, halign, height, i_selected, is_open, options, prompt, scroll_speed, selection, selection_cell_color_inactive, tellheight, tellwidth, textcolor, textpadding, valign, width

source

Makie.MouseEvent Type

julia

MouseEvent

Describes a mouse state change. Fields:

type: MouseEventType
t: Time of the event
data: Mouse position in data coordinates
px: Mouse position in px relative to scene origin
prev_t: Time of previous event
prev_data: Previous mouse position in data coordinates
prev_px: Previous mouse position in data coordinates

source

Makie.MoveTo Type

julia

MoveTo(p::VecTypes)
MoveTo(x::Real, y::Real)

A path command for use within a BezierPath which starts a new subpath at the given point.

source

Makie.MultiplesTicks Type

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

If strip_zero == true, then the resulting labels will be checked and any label that is a multiple of 0 will be set to "0".

source

Makie.Pie Type

Pie is the plot type associated with plotting function pie. Check the docstring for pie for further information.

source

Makie.PlotSpec Type

julia

PlotSpec(plottype, args...; kwargs...)

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

source

Makie.PointLight Type

julia

PointLight(color, position[, attenuation = Vec2f(0)])
PointLight(color, position, range::Real)

A point-like light source placed at the given position with the given light color.

Optionally an attenuation parameter can be used to reduce the brightness of the light source with distance. The reduction is given by 1 / (1 + attenuation[1] * distance + attenuation[2] * distance^2). Alternatively you can pass a light range to generate matching default attenuation parameters. Note that you may need to set the light intensity, i.e. the light color to values greater than 1 to get satisfying results.

Availability:

GLMakie with shading = MultiLightShading
RPRMakie

source

Makie.PolarAxis Type

Makie.PolarAxis <: Block

No docstring defined.

Attributes

(type ?Makie.PolarAxis.x in the REPL for more information about attribute x)

alignmode, axis_rotation_button, backgroundcolor, clip, clip_r, clipcolor, dim1_conversion, dim2_conversion, direction, fixrmin, gridz, halign, height, normalize_theta_ticks, r_translation_button, radius_at_origin, rautolimitmargin, reset_axis_orientation, reset_button, rgridcolor, rgridstyle, rgridvisible, rgridwidth, rlimits, rminorgridcolor, rminorgridstyle, rminorgridvisible, rminorgridwidth, rminorticks, rtickangle, rtickformat, rticklabelcolor, rticklabelfont, rticklabelpad, rticklabelrotation, rticklabelsize, rticklabelstrokecolor, rticklabelstrokewidth, rticklabelsvisible, rticks, rzoomkey, rzoomlock, sample_density, spinecolor, spinestyle, spinevisible, spinewidth, tellheight, tellwidth, theta_0, theta_as_x, theta_translation_button, thetaautolimitmargin, thetagridcolor, thetagridstyle, thetagridvisible, thetagridwidth, thetalimits, thetaminorgridcolor, thetaminorgridstyle, thetaminorgridvisible, thetaminorgridwidth, thetaminorticks, thetatickformat, thetaticklabelcolor, thetaticklabelfont, thetaticklabelpad, thetaticklabelsize, thetaticklabelstrokecolor, thetaticklabelstrokewidth, thetaticklabelsvisible, thetaticks, thetazoomkey, thetazoomlock, title, titlealign, titlecolor, titlefont, titlegap, titlesize, titlevisible, valign, width, zoomspeed

source

Makie.QQNorm Type

QQNorm is the plot type associated with plotting function qqnorm. Check the docstring for qqnorm for further information.

source

Makie.QQPlot Type

QQPlot is the plot type associated with plotting function qqplot. Check the docstring for qqplot for further information.

source

Makie.RainClouds Type

RainClouds is the plot type associated with plotting function rainclouds. Check the docstring for rainclouds for further information.

source

Makie.Rangebars Type

Rangebars is the plot type associated with plotting function rangebars. Check the docstring for rangebars for further information.

source

Makie.RectLight Type

julia

RectLight(color, r::Rect2[, direction = -normal])
RectLight(color, center::Point3f, b1::Vec3f, b2::Vec3f[, direction = -normal])

Creates a RectLight with a given color. The first constructor derives the light from a Rect2 extending in x and y directions. The second specifies the center of the rect (or more accurately parallelogram) with b1 and b2 specifying the width and height vectors (including scale).

Note that RectLight implements translate!, rotate! and scale! to simplify adjusting the light.

Availability:

GLMakie with Shading = MultiLightShading

source

Makie.Resampler Type

julia

Resampler(matrix; resolution=automatic, method=Interpolations.Linear(), update_while_button_pressed=false)

Creates a resampling type which can be used with heatmap, to display large images/heatmaps. Passed can be any array that supports array(linrange, linrange), as the interpolation interface from Interpolations.jl. If the array doesn't support this, it will be converted to an interpolation object via: Interpolations.interpolate(data, Interpolations.BSpline(method)).

resolution can be set to automatic to use the full resolution of the screen, or a tuple of the desired resolution.
method is the interpolation method used, defaulting to Interpolations.Linear().
update_while_button_pressed will update the heatmap while a mouse button is pressed, useful for zooming/panning. Set it to false for e.g. WGLMakie to avoid updating while dragging.

source

Makie.Reverse Type

Reverses the attribute T upon conversion

source

Makie.ReversibleScale Type

julia

ReversibleScale

Custom scale struct, taking a forward and inverse arbitrary scale function.

Fields

forward::Function: forward transformation (e.g. log10)
inverse::Function: inverse transformation (e.g. exp10 for log10 such that inverse ∘ forward ≡ identity)
limits::Tuple{Float32, Float32}: default limits (optional)
interval::IntervalSets.AbstractInterval: valid limits interval (optional)
name::Symbol

source

Makie.ScatterLines Type

ScatterLines is the plot type associated with plotting function scatterlines. Check the docstring for scatterlines for further information.

source

Makie.Scene Type

julia

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.
viewport: 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.
float32convert: A transformation rescaling data to a Float32-save range.
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
deregister_callbacks
cycler
conversions
isclosed

source

Makie.SceneSpace Type

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

source

Makie.Series Type

Series is the plot type associated with plotting function series. Check the docstring for series for further information.

source

Makie.Slider Type

Makie.Slider <: Block

No docstring defined.

Attributes

(type ?Makie.Slider.x in the REPL for more information about attribute x)

alignmode, color_active, color_active_dimmed, color_inactive, halign, height, horizontal, linewidth, range, snap, startvalue, tellheight, tellwidth, valign, value, width

source

Makie.SliderGrid Type

Makie.SliderGrid <: Block

A grid of one or more horizontal Sliders, where each slider has a 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 Format.jl style, such as "{:.2f}Hz", or a function.

Constructors

julia

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

Examples

julia

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:

julia

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

Attributes

(type ?Makie.SliderGrid.x in the REPL for more information about attribute x)

alignmode, halign, height, tellheight, tellwidth, valign, value_column_width, width

source

Makie.SpotLight Type

julia

SpotLight(color, position, direction, angles)

Creates a spot light which illuminates objects in a light cone starting at position pointing in direction. The opening angle is defined by an inner and outer angle given in angles, between which the light intensity drops off.

Availability:

GLMakie with shading = MultiLightShading
RPRMakie

source

Makie.Spy Type

Spy is the plot type associated with plotting function spy. Check the docstring for spy for further information.

source

Makie.Stairs Type

Stairs is the plot type associated with plotting function stairs. Check the docstring for stairs for further information.

source

Makie.Stem Type

Stem is the plot type associated with plotting function stem. Check the docstring for stem for further information.

source

Makie.StepHist Type

StepHist is the plot type associated with plotting function stephist. Check the docstring for stephist for further information.

source

Makie.StreamPlot Type

StreamPlot is the plot type associated with plotting function streamplot. Check the docstring for streamplot for further information.

source

Makie.Textbox Type

Makie.Textbox <: Block

No docstring defined.

Attributes

(type ?Makie.Textbox.x in the REPL for more information about attribute x)

alignmode, bordercolor, bordercolor_focused, bordercolor_focused_invalid, bordercolor_hover, borderwidth, boxcolor, boxcolor_focused, boxcolor_focused_invalid, boxcolor_hover, cornerradius, cornersegments, cursorcolor, defocus_on_submit, displayed_string, focused, font, fontsize, halign, height, placeholder, reset_on_defocus, restriction, stored_string, tellheight, tellwidth, textcolor, textcolor_placeholder, textpadding, validator, valign, width

source

Makie.TimeSeries Type

TimeSeries is the plot type associated with plotting function timeseries. Check the docstring for timeseries for further information.

source

Makie.Toggle Type

Makie.Toggle <: Block

A switch with two states.

Constructors

julia

Toggle(fig_or_scene; kwargs...)

Examples

julia

t_horizontal = Toggle(fig[1, 1])
t_vertical = Toggle(fig[2, 1], orientation = :vertical)
t_diagonal = Toggle(fig[3, 1], orientation = pi/4)
on(t_vertical.active) do switch_is_on
    switch_is_on ? println("good morning!") : println("good night")
end

Attributes

(type ?Makie.Toggle.x in the REPL for more information about attribute x)

active, alignmode, buttoncolor, cornersegments, framecolor_active, framecolor_inactive, halign, height, length, markersize, orientation, rimfraction, tellheight, tellwidth, toggleduration, valign, width

source

Makie.Tooltip Type

Tooltip is the plot type associated with plotting function tooltip. Check the docstring for tooltip for further information.

source

Makie.Transformation Type

Holds the transformations for Scenes.

Fields

parent::Base.RefValue{Transformation}
translation::Observable{Vec{3, Float64}}
scale::Observable{Vec{3, Float64}}
rotation::Observable{Quaternionf}
origin::Observable{Vec{3, Float64}}
model::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}
parent_model::Observable{StaticArraysCore.SMatrix{4, 4, Float64, 16}}
transform_func::Observable{Any}

source

Makie.Tricontourf Type

Tricontourf is the plot type associated with plotting function tricontourf. Check the docstring for tricontourf for further information.

source

Makie.Triplot Type

Triplot is the plot type associated with plotting function triplot. Check the docstring for triplot for further information.

source

Makie.VLines Type

VLines is the plot type associated with plotting function vlines. Check the docstring for vlines for further information.

source

Makie.VSpan Type

VSpan is the plot type associated with plotting function vspan. Check the docstring for vspan for further information.

source

Makie.VideoStream Method

julia

VideoStream(fig::FigureLike;
        format="mp4", framerate=24, compression=nothing, profile=nothing, pixel_format=nothing, loop=nothing,
        loglevel="quiet", visible=false, connect=false, filter_ticks=true, 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 from 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 and mk4 are marginally bigger than webm. gifs 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 via ffmpeg's -crf option, with smaller numbers giving higher quality and larger file sizes (lower compression), and higher numbers giving lower quality and smaller file sizes (higher compression). The minimum value is 0 (lossless encoding).
- For mp4, 51 is the maximum. Note that compression = 0 only works with mp4 if
profile = "high444".
- For webm, 63 is the maximum.
- compression has no effect on mkv and gif outputs.
profile = "high422": A ffmpeg compatible profile. Currently only applies to mp4. If

you have issues playing a video, try profile = "high" or profile = "main".

pixel_format = "yuv420p": A ffmpeg compatible pixel format (-pix_fmt). Currently only

applies to mp4. Defaults to yuv444p for profile = "high444".

loop = 0: Number of times the video is repeated, for a gif or html output. Defaults to 0, which

means infinite looping. A value of -1 turns off looping, and a value of n > 0 means n repetitions (i.e. the video is played n+1 times) when supported by backend.

!!! 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 or Base.doc(Backend.Screen) for applicable options that can be passed and forwarded to the backend.

Other

filter_ticks: When true, tick events other than tick.state = Makie.OneTimeRenderTick are removed until save() is called or the VideoStream object gets deleted.

source

Makie.Violin Type

Violin is the plot type associated with plotting function violin. Check the docstring for violin for further information.

source

Makie.VolumeSlices Type

VolumeSlices is the plot type associated with plotting function volumeslices. Check the docstring for volumeslices for further information.

source

Makie.Voronoiplot Type

Voronoiplot is the plot type associated with plotting function voronoiplot. Check the docstring for voronoiplot for further information.

source

Makie.Waterfall Type

Waterfall is the plot type associated with plotting function waterfall. Check the docstring for waterfall for further information.

source

Makie.WilkinsonTicks Method

julia

WilkinsonTicks(
    k_ideal::Int;
    k_min = 2, k_max = 10,
    Q = [(1.0, 1.0), (5.0, 0.9), (2.0, 0.7), (2.5, 0.5), (3.0, 0.2)],
    granularity_weight = 1/4,
    simplicity_weight = 1/6,
    coverage_weight = 1/3,
    niceness_weight = 1/4
)

WilkinsonTicks is a thin wrapper over PlotUtils.optimize_ticks, the docstring of which is reproduced below:

optimize_ticks(xmin, xmax; extend_ticks::Bool = false, Q = [(1.0,1.0), (5.0, 0.9), (2.0, 0.7), (2.5, 0.5), (3.0, 0.2)], k_min = 2, k_max = 10, k_ideal = 5, granularity_weight = 1/4, simplicity_weight = 1/6, coverage_weight = 1/3, niceness_weight = 1/4, strict_span = true, span_buffer = nothing)

Find some reasonable values for tick marks.

This is basically Wilkinson's ad-hoc scoring method that tries to balance tight fit around the data, optimal number of ticks, and simple numbers.

Arguments:

xmax: The maximum value occurring in the data.
xmin: The minimum value occurring in the data.
extend_ticks: Determines whether to extend tick computation. Defaults to false.
strict_span: True if no ticks should be outside [x_min, x_max]. Defaults to true.
Q: A distribution of nice numbers from which labellings are sampled. Stored in the form (number, score).
k_min: The minimum number of ticks.
k_max: The maximum number of ticks.
k_ideal: The ideal number of ticks.
granularity_weight: Encourages returning roughly the number of labels requested.
simplicity_weight: Encourages nicer labeling sequences by preferring step sizes that appear earlier in Q. Also rewards labelings that include 0 as a way to ground the sequence.
coverage_weight: Encourages labelings that do not extend far beyond the range of the data, penalizing unnecessary whitespace.
niceness_weight: Encourages labellings to produce nice ranges.

Returns:

(ticklocations::Vector{Float64}, x_min, x_max)

Mathematical details

Wilkinson’s optimization function is defined as the sum of three components. If the user requests m labels and a possible labeling has k labels, then the components are simplicity, coverage and granularity.

These components are defined as follows:

\begin{aligned} &\text{simplicity} = 1 - \frac{i}{|Q|} + \frac{v}{|Q|}
&\text{coverage} = \frac{x_{max} - x_{min}}{\mathrm{label}{max} - \mathrm{label}{min}}
&\text{granularity}= 1 - \frac{\left|k - m\right|}{m} \end{aligned} $

and the variables here are:

q: element of Q.
i: index of q ∈ Q.
v: 1 if label range includes 0, 0 otherwise.

source

FileIO.save Method

julia

FileIO.save(filename, scene; size = 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
CairoMakie: .svg, .pdf and .png
WGLMakie: .png

Supported Keyword Arguments

All Backends

size: (width::Int, height::Int) of the scene in dimensionless units.
update: Whether the figure should be updated before saving. This resets the limits of all Axes in the figure. Defaults to true.
backend: Specify the Makie backend that should be used for saving. Defaults to the current backend.
px_per_unit: The size of one scene unit in px when exporting to a bitmap format. This provides a mechanism to export the same scene with higher or lower resolution.
Further keywords will be forwarded to the screen.

CairoMakie

pt_per_unit: The size of one scene unit in pt when exporting to a vector format.

source

FileIO.save Method

julia

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.

source

Makie.Pattern Method

julia

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.

source

Makie.Pattern Method

julia

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.

source

Makie.Record Method

julia

Record(func, figlike, [iter]; kw_args...)

Check Makie.record for documentation.

source

Makie.ablines Function

julia

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.

Plot type

The plot type alias for the ablines function is ABLines.

Attributes

alpha = 1.0 — The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5), will get multiplied.

clip_planes = automatic — Clip planes offer a way to do clipping in 3D space. You can set a Vector of up to 8 Plane3f planes here, behind which plots will be clipped (i.e. become invisible). By default clip planes are inherited from the parent plot or scene. You can remove parent clip_planes by passing Plane3f[].

color = @inherit linecolor — The color of the line.

colormap = @inherit colormap :viridis — Sets the colormap that is sampled for numeric colors. PlotUtils.cgrad(...), Makie.Reverse(any_colormap) can be used as well, or any symbol from ColorBrewer or PlotUtils. To see all available color gradients, you can call Makie.available_gradients().

colorrange = automatic — The values representing the start and end points of colormap.

colorscale = identity — The color transform function. Can be any function, but only works well together with Colorbar for identity, log, log2, log10, sqrt, logit, Makie.pseudolog10 and Makie.Symlog10.

cycle = [:color] — Sets which attributes to cycle when creating multiple plots.

depth_shift = 0.0 — adjusts the depth value of a plot after all other transformations, i.e. in clip space, where 0 <= depth <= 1. This only applies to GLMakie and WGLMakie and can be used to adjust render order (like a tunable overdraw).

fxaa = false — adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).

highclip = automatic — The color for any value above the colorrange.

inspectable = true — sets whether this plot should be seen by DataInspector.

inspector_clear = automatic — Sets a callback function (inspector, plot) -> ... for cleaning up custom indicators in DataInspector.

inspector_hover = automatic — Sets a callback function (inspector, plot, index) -> ... which replaces the default show_data methods.

inspector_label = automatic — Sets a callback function (plot, index, position) -> string which replaces the default label generated by DataInspector.

linecap = @inherit linecap — Sets the type of linecap used, i.e. :butt (flat with no extrusion), :square (flat with 1 linewidth extrusion) or :round.

linestyle = nothing — Sets the dash pattern of the line. Options are :solid (equivalent to nothing), :dot, :dash, :dashdot and :dashdotdot. These can also be given in a tuple with a gap style modifier, either :normal, :dense or :loose. For example, (:dot, :loose) or (:dashdot, :dense).

For custom patterns have a look at Makie.Linestyle.

linewidth = @inherit linewidth — Sets the width of the line in pixel units

lowclip = automatic — The color for any value below the colorrange.

model = automatic — Sets a model matrix for the plot. This overrides adjustments made with translate!, rotate! and scale!.

nan_color = :transparent — The color for NaN values.

overdraw = false — Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends

space = :data — sets the transformation space for box encompassing the plot. See Makie.spaces() for possible inputs.

ssao = 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 with fxaa = true.

transformation = automatic — No docs available.

transparency = false — Adjusts how the plot deals with transparency. In GLMakie transparency = true results in using Order Independent Transparency.

visible = true — Controls whether the plot will be rendered or not.

source

Makie.ablines! Function

ablines! is the mutating variant of plotting function ablines. Check the docstring for ablines for further information.

source

Makie.activate_interaction! Method

julia

activate_interaction!(parent, name::Symbol)

Activate the interaction named name registered in parent.

source

Makie.addmouseevents! Method

julia

addmouseevents!(scene, elements...)

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

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

Example:

mouseevents = addmouseevents!(scene, scatterplot)

onmouseleftclick(mouseevents) do event
    # do something with the mouseevent
end

source

Makie.annotations Function

julia

annotations(strings::Vector{String}, positions::Vector{Point})

Plots an array of texts at each position in positions.

Plot type

The plot type alias for the annotations function is Annotations.

Attributes

align = (:left, :bottom) — Sets the alignment of the string w.r.t. position. Uses :left, :center, :right, :top, :bottom, :baseline or fractions.

alpha = 1.0 — The alpha value of the colormap or color attribute. Multiple alphas like in plot(alpha=0.2, color=(:red, 0.5), will get multiplied.

color = @inherit textcolor — Sets the color of the text. One can set one color per glyph by passing a Vector{<:Colorant}, or one colorant for the whole text. If color is a vector of numbers, the colormap args are used to map the numbers to colors.

colorrange = automatic — The values representing the start and end points of colormap.

font = @inherit font — Sets the font. Can be a Symbol which will be looked up in the fonts dictionary or a String specifying the (partial) name of a font or the file path of a font file

fonts = @inherit fonts — Used as a dictionary to look up fonts specified by Symbol, for example :regular, :bold or :italic.

fontsize = @inherit fontsize — The fontsize in units depending on markerspace.

fxaa = false — adjusts whether the plot is rendered with fxaa (anti-aliasing, GLMakie only).

glowcolor = (:black, 0.0) — Sets the color of the glow effect around the text.

glowwidth = 0.0 — Sets the size of a glow effect around the text.

highclip = automatic — The color for any value above the colorrange.

inspectable = true — sets whether this plot should be seen by DataInspector.

inspector_clear = automatic — Sets a callback function (inspector, plot) -> ... for cleaning up custom indicators in DataInspector.

inspector_hover = automatic — Sets a callback function (inspector, plot, index) -> ... which replaces the default show_data methods.

inspector_label = automatic — Sets a callback function (plot, index, position) -> string which replaces the default label generated by DataInspector.

justification = 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 in align.

lineheight = 1.0 — The lineheight multiplier.

lowclip = automatic — The color for any value below the colorrange.

markerspace = :pixel — Sets the space in which fontsize acts. See Makie.spaces() for possible inputs.

model = automatic — Sets a model matrix for the plot. This overrides adjustments made with translate!, rotate! and scale!.

nan_color = :transparent — The color for NaN values.

offset = (0.0, 0.0) — The offset of the text from the given position in markerspace units.

overdraw = false — Controls if the plot will draw over other plots. This specifically means ignoring depth checks in GL backends

position = (0.0, 0.0) — Deprecated: Specifies the position of the text. Use the positional argument to text instead.

rotation = 0.0 — Rotates text around the given position

space = :data — sets the transformation space for box encompassing the plot. See Makie.spaces() for possible inputs.

ssao = 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 with fxaa = true.

strokecolor = (:black, 0.0) — Sets the color of the outline around a marker.

strokewidth = 0 — Sets the width of the outline around a marker.

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 supports String which is used for all normal text and LaTeXString which layouts mathematical expressions using MathTeXEngine.jl.

transform_marker = false — Controls whether the model matrix (without translation) applies to the glyph itself, rather than just the positions. (If this is true, scale! and rotate! will affect the text glyphs.)

transformation = automatic — No docs available.

transparency = false — Adjusts how the plot deals with transparency. In GLMakie transparency = true results in using Order Independent Transparency.

visible = true — Controls whether the plot will be rendered or not.

word_wrap_width = -1 — Specifies a linewidth limit for text. If a word overflows this limit, a newline is inserted before it. Negative numbers disable word wrapping.

source

Makie.annotations! Function

annotations! is the mutating variant of plotting function annotations. Check the docstring for annotations for further information.

source

Makie.arc Function

julia

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

Plot type

The plot type alias for the arc function is Arc.