Skip to content

Checkbox

julia
using GLMakie
f = Figure()

gl = GridLayout(f[2, 1], tellwidth = false)
subgl = GridLayout(gl[1, 1])

cb1 = Checkbox(subgl[1, 1], checked = false)
cb2 = Checkbox(subgl[2, 1], checked = true)
cb3 = Checkbox(subgl[3, 1], checked = true)

Label(subgl[1, 2], "Show grid", halign = :left)
Label(subgl[2, 2], "Show ticklabels", halign = :left)
Label(subgl[3, 2], "Show title", halign = :left)
rowgap!(subgl, 8)
colgap!(subgl, 8)

ax = Axis(
    f[1, 1],
    title = "Checkboxes",
    xgridvisible = cb1.checked,
    ygridvisible = cb1.checked,
    xticklabelsvisible = cb2.checked,
    yticklabelsvisible = cb2.checked,
    xticksvisible = cb2.checked,
    yticksvisible = cb2.checked,
    titlevisible = cb3.checked,
    alignmode = Outside(),
)

f

Attributes

alignmode

Defaults to Inside()

The align mode of the checkbox in its parent GridLayout.

checkboxcolor_checked

Defaults to COLOR_ACCENT[]

The color of the checkbox background when checked.

checkboxcolor_unchecked

Defaults to @inherit :backgroundcolor :white

The color of the checkbox background when unchecked.

checkboxstrokecolor_checked

Defaults to COLOR_ACCENT[]

The strokecolor of the checkbox background when checked.

checkboxstrokecolor_unchecked

Defaults to COLOR_ACCENT[]

The strokecolor of the checkbox background when unchecked.

checkboxstrokewidth

Defaults to 1.5

The strokewidth of the checkbox poly.

checked

Defaults to false

If the checkbox is currently checked. This value should not be modified directly.

checkmark

Defaults to CHECKMARK_BEZIER

The checkmark marker symbol. Anything that scatter can use.

checkmarkcolor_checked

Defaults to :white

The color of the checkmark when the mouse clicks the checkbox.

checkmarkcolor_unchecked

Defaults to :transparent

The color of the checkmark when unchecked.

checkmarksize

Defaults to 0.85

The size of the checkmark, relative to the size.

halign

Defaults to :center

The horizontal alignment of the checkbox in its suggested boundingbox

height

Defaults to Auto()

The height setting of the checkbox.

onchange

Defaults to !

A function that is called when the user clicks to check or uncheck. The function is passed the current status as a Bool and needs to return a Bool that decides the checked status after the click. Intended for implementation of radio buttons.

roundness

Defaults to 0.15

Roundness of the checkbox poly, 0 is square, 1 is circular.

size

Defaults to 11

The size (width/height) of the checkbox

tellheight

Defaults to true

Controls if the parent layout can adjust to this element's height

tellwidth

Defaults to true

Controls if the parent layout can adjust to this element's width

valign

Defaults to :center

The vertical alignment of the checkbox in its suggested boundingbox

width

Defaults to Auto()

The width setting of the checkbox.