Skip to main content

ControlsPluginOptions

Options for the controls plugin.

Extends​

Properties​

buttons?​

optional buttons: ControlsComponentButtons

Optional extra buttons to add to the controls component.

Inherited from​

ControlsComponentOptions.buttons

clear?​

optional clear: boolean

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

Inherited from​

ControlsComponentOptions.clear

clearMessage?​

optional clearMessage: string

Optional message to show the user when prompting them to confirm they want to clear the dataset

Inherited from​

ControlsComponentOptions.clearMessage

container​

container: BrowserElement

The element that will host the controls

orientation?​

optional orientation: "row" | "column"

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

Inherited from​

ControlsComponentOptions.orientation

undoRedo?​

optional undoRedo: boolean

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

Inherited from​

ControlsComponentOptions.undoRedo

zoom?​

optional zoom: boolean

Whether or not to show zoom in/zoom out buttons. Defaults to false when the UI's zoom method is "wheel", and defaults to true when the UI's zoom method is "click".

Inherited from​

ControlsComponentOptions.zoom

zoomToExtents?​

optional zoomToExtents: boolean

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

Inherited from​

ControlsComponentOptions.zoomToExtents