HMPlot

Checkbox

True or false, set by the viewer and read by name.

Scatter plot of y against x, with line chart of y against x. x from 0.9 to 4.1, y from 0.9 to 4.1. 4 points.

Static preview; loading the interactive plot

import hmplot as hm

data = {"x": [1, 2, 3, 4], "y": [3, 1, 4, 2]}
with hm.Scene() as scene:
    hm.Checkbox(name="line")
    with hm.Plot(data=data, height=300, axes2d=True):
        hm.Points(x="x", y="y")
        hm.Line(x="x", y="y", visible=hm.input.line)
scene

Options

Keywords are snake_case.

valueboolean
The value before the viewer sets it. Default: False.
namestring
The name readers use (input("name"), hm.input.name, or "$name" where a string names a column): an identifier, unique in its input context.
labelstring
The text shown beside the control. Default: the name.

Usage

An input sends its value up to the nearest input context (an InputContext, a Python Scene, or a Template instance), and everything in that context reads it by name: input("name") in JavaScript, hm.input.name in Python, or the string "$name" where a string names a column. A read is replaced by the value before its reader sees it, so moving an input re-runs its readers once, and the change animates like any other data change. Inputs go beside Plots (in a Row or Column), not inside them.

Related examples

Inputs