Monitor
Wraps the Tweakpane monitor binding functionality for boolean
, number
, and string
values.
Technically, any unbound value on a normal Svelte Tweakpane UI component effectively acts as a monitor, but additional monitor-specific components are provided to expose additional view options (e.g. rows
).
<Monitor>
is a dynamic component, and the availability of additional props will vary depending on the type of the defined value
Note that interval
is not exposed on boolean
and string
monitors because updates are driven by reactive changes in the value
.
However, interval
is exposed on number
monitors Note to allow independent control over the reactive value's update rate and the graph's update rate.
See also the <Waveform>
component for a more advanced number visualization.
Usage outside of a <Pane>
component will implicitly wrap the monitor in a <Pane position="inline">
component.
optional | |
Description | Prevent interactivity and gray out the control. |
---|---|
Type | boolean |
Default | false |
optional | |
Description | Text displayed next to control. |
---|---|
Type | string |
Default | undefined |
optional | |
Description | Custom color scheme. |
---|---|
Type | Theme |
Default | undefined Inherits default Tweakpane theme equivalent to ThemeUtils.presets.standard , or the theme set with setGlobalDefaultTheme() . |
bindablerequired | |
Description | The value to control. A |
---|---|
Type | string | number | boolean |
optional | |
Description | Number of visible rows of state history. If |
---|---|
Type | number |
Default | 1 Or 3 if value is string and multiline is true . |
optional | |
Description | Number of past states to retain. |
---|---|
Type | number |
Default | 1 Or 64 if value is number and graph is true . |
optional | |
Description | Time between value samples in milliseconds. Useful when |
---|---|
Type | number |
Default | 0 |
optionaldynamic | |
Description | A function to customize the number's string representation (e.g. rounding, etc.). |
---|---|
Type | ((value: number) => string) |
Default | undefined Normal .toString() formatting. |
Conditions | Available when value is of type number . |
optionaldynamic | |
Description | Display a graph of the value's changes over time. |
---|---|
Type | boolean |
Default | false |
Conditions | Available when value is of type number . |
optionaldynamic | |
Description | Maximum bound when |
---|---|
Type | number |
Default | 100 |
Conditions | Available when value is of type number . |
optionaldynamic | |
Description | Minimum bound when |
---|---|
Type | number |
Default | 0 |
Conditions | Available when value is of type number . |
optionaldynamic | |
Description | Display multiline strings. |
---|---|
Type | boolean |
Default | false |
Conditions | Available when value is of type string . |