Interface ControlsComponentProps

Props for the controls component.

interface ControlsComponentProps {
    buttons?: ControlsComponentButtons;
    className?: string;
    clear?: boolean;
    clearMessage?: string;
    onMaybeClear?: ((doClear: (() => void)) => void);
    orientation?: "row" | "column";
    surfaceId?: string;
    undoRedo?: boolean;
    zoomToExtents?: boolean;
}

Properties

buttons? className? clear? clearMessage? onMaybeClear? orientation? surfaceId? undoRedo? zoomToExtents?

Properties

Optionalbuttons

buttons?: ControlsComponentButtons

Optional extra buttons to add to the controls component.

OptionalclassName

className?: string

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

Optionalclear

clear?: boolean

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

OptionalclearMessage

clearMessage?: string

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

OptionalonMaybeClear

onMaybeClear?: ((doClear: (() => void)) => 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.

Optionalorientation

orientation?: "row" | "column"

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

OptionalsurfaceId

surfaceId?: string

The ID of surface to attach to. Optional.

OptionalundoRedo

undoRedo?: boolean

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

OptionalzoomToExtents

zoomToExtents?: boolean

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

Settings

Member Visibility

On This Page

Properties
Version :