Skip to main content

ControlsComponentProps

Props for the controls component.

Properties​

buttons?​

optional buttons: ControlsComponentButtons

Optional extra buttons to add to the controls component.

className?​

optional className: string

Optional class name to append to the root element's class list.

clear?​

optional clear: boolean

Whether or not to show the clear button, defaults to true.

clearMessage?​

optional clearMessage: string

Optional message for the alert that the clear button shows by default. Defaults to Clear dataset?.

onMaybeClear()?​

optional onMaybeClear: (doClear) => void

Optional 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.

Parameters​

doClear​

() => void

Returns​

void

orientation?​

optional orientation: "row" | "column"

Optional orientation for the controls. Defaults to 'row'.

style?​

optional style: Record<string, string>

Optional style object to apply to the container element.

surfaceId?​

optional surfaceId: string

The ID of surface to attach to. Optional. Will be inferred from context if not provided.

undoRedo?​

optional undoRedo: boolean

Whether or not to show undo/redo buttons, defaults to true

zoomButtons?​

optional zoomButtons: boolean

Whether or not to show the zoom in/zoom out buttons, defaults to false

zoomToExtents?​

optional zoomToExtents: boolean

Whether or not to show the zoom to extents button, defaults to true