Variable ControlsComponentConst

ControlsComponent: {
    data: (() => {
        hasLasso: boolean;
        ready: boolean;
    });
    methods: {
        doClear: (() => void);
        panMode: (() => void);
        redo: (() => void);
        selectMode: (() => void);
        undo: (() => void);
        zoomToFit: (() => void);
    };
    name: string;
    props: {
        className: {
            default: string;
            type: StringConstructor;
        };
        clear: {
            default: boolean;
            type: BooleanConstructor;
        };
        clearMessage: {
            default: string;
            type: StringConstructor;
        };
        onMaybeClear: {
            type: FunctionConstructor;
        };
        orientation: {
            default: string;
            type: StringConstructor;
        };
        surfaceId: {
            default: string;
            type: StringConstructor;
        };
        undoRedo: {
            default: boolean;
            type: BooleanConstructor;
        };
        zoomToExtents: {
            default: boolean;
            type: BooleanConstructor;
        };
    };
    mounted(): void;
    render(): VNode<RendererNode, RendererElement, {
        [key: string]: any;
    }>;
} = ...

Provides a controls component offering buttons to zoom to extents, set surface mode, undo/redo etc.

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

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

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

'row' or 'column'. Defaults to 'row'.

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

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

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

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

Version :