Interface ControlsComponentProps

Props for the controls component.

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

Properties

buttons? clear? clearMessage? onMaybeClear? orientation? surface undoRedo? zoomToExtents?

Properties

Optional buttons

buttons?: ControlsComponentButtons

Optional extra buttons to add to the controls component.

Optional clear

clear?: boolean

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

Optional clearMessage

clearMessage?: string

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

Optional onMaybeClear

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.

Type declaration

    • (doClear): void

    • Parameters

      • doClear: (() => void)
          • (): void

          • Returns void

      Returns void

Optional orientation

orientation?: "row" | "column"

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

surface

surface: Surface

The surface to attach to.

Optional undoRedo

undoRedo?: boolean

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

Optional zoomToExtents

zoomToExtents?: boolean

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

Settings

Member Visibility

Theme

On This Page

buttonsclearclearMessageonMaybeClearorientationsurfaceundoRedozoomToExtents
Version :