Skip to main content
ControlsComponentProps
Props for the controls component.
NameTypeDescription
buttons?ControlsComponentButtonsOptional extra buttons to add to the controls component.
className?stringOptional class name to append to the root element's class list.
clear?booleanWhether or not to show the clear button, defaults to true.
clearMessage?stringOptional message for the alert that the clear button shows by default. Defaults to Clear dataset?.
onMaybeClear?(doClear:() => void) => voidOptional callback to invoke when the user presses the clear button. If you provide this, the component will not show an alert, and instead call this method, passing in a function you can invoke if you wish to continue with the clear operation.
orientation?"row" | "column"Optional orientation for the controls. Defaults to 'row'.
style?Record<string,string>Optional style object to apply to the container element.
surfaceId?stringThe ID of surface to attach to. Optional. Will be inferred from context if not provided.
undoRedo?booleanWhether or not to show undo/redo buttons, defaults to true
zoomButtons?booleanWhether or not to show the zoom in/zoom out buttons, defaults to false
zoomToExtents?booleanWhether or not to show the zoom to extents button, defaults to true