Skip to main content
ControlsComponentProps
Props for the ControlsComponent
NameTypeDescription
className?stringOptional class name(s) to attach to the component's container element.
clear?booleanDefaults to true. Whether or not to show the 'clear dataset' button.
clearMessage?stringOptional message to use when the user presses the clear button. Defaults to 'Clear dataset?'.
onMaybeClear?FunctionA function to use instead of the browser's default prompt when the user presses the clear button.
orientation"row" | "column"Defaults to 'row' - whether to show buttons in a row or a column
surfaceId?stringID of the surface to attach to. Optional, a default will be used if not provided.
undoRedo?booleanDefaults to true, meaning show the undo/redo buttons.
zoomButtons?booleanDefaults to false, meaning the zoom in/zoom out buttons are not shown by default.
zoomToExtents?booleanDefaults to true, meaning the 'zoom to extents' button will be shown.