Skip to main content

ControlsComponentProps

Props for the ControlsComponent

Properties​

className?​

optional className: string

Optional class name(s) to attach to the component's container element.

clear?​

optional clear: boolean

Defaults to true. Whether or not to show the 'clear dataset' button.

clearMessage?​

optional clearMessage: string

Optional message to use when the user presses the clear button. Defaults to 'Clear dataset?'.

onMaybeClear?​

optional onMaybeClear: Function

A function to use instead of the browser's default prompt when the user presses the clear button.

orientation​

orientation: "row" | "column"

Defaults to 'row' - whether to show buttons in a row or a column

surfaceId?​

optional surfaceId: string

ID of the surface to attach to. Optional, a default will be used if not provided.

undoRedo?​

optional undoRedo: boolean

Defaults to true, meaning show the undo/redo buttons.

zoomButtons?​

optional zoomButtons: boolean

Defaults to false, meaning the zoom in/zoom out buttons are not shown by default.

zoomToExtents?​

optional zoomToExtents: boolean

Defaults to true, meaning the 'zoom to extents' button will be shown.