@watergis/maplibre-gl-terradraw
    Preparing search index...

    Interface TerradrawControlOptions

    Terradraw Control Plugin control constructor options

    interface TerradrawControlOptions {
        adapterOptions?: TerraDrawMapLibreGLAdapterConfig;
        modeOptions?: ModeOptions;
        modes?: TerradrawMode[];
        open?: boolean;
        showDeleteConfirmation?: boolean;
        undoRedo?: {
            keyboardShortcuts?: TerraDrawUndoRedoKeyboardShortcutsInterface;
            modeLevel?: TerraDrawModeUndoRedoInterface;
            sessionLevel?: TerraDrawSessionUndoRedoInterface;
        };
    }
    Index

    Properties

    adapterOptions? modeOptions? modes? open? showDeleteConfirmation? undoRedo?

    Properties

    adapterOptions?: TerraDrawMapLibreGLAdapterConfig

    TerraDrawMaplibreGLAdapter options. Please refer the default adapter settings (BaseAdapterConfig) at the below TerraDraw code. https://github.com/JamesLMilner/terra-draw/blob/806e319d5680a3f69edeff7dd629da3f1b4ff9bf/src/adapters/common/base.adapter.ts#L28-L48

    modeOptions?: ModeOptions

    Overwrite Terra Draw mode options if you specified.

    modes?: TerradrawMode[]

    Terradraw modes added to the control. The mode will be added in the same order of the array. Default is all modes in the below order: ['point', 'linestring', 'polygon', 'rectangle', 'angled-rectangle', 'circle', 'freehand', 'select']

    You can change the order of modes, or can get rid of some modes which you don't need for your app.

    open?: boolean

    Open editor as default if true. Default is false

    showDeleteConfirmation?: boolean

    Show delete confirmation popup when deleting features if true. Default is false

    undoRedo?: {
        keyboardShortcuts?: TerraDrawUndoRedoKeyboardShortcutsInterface;
        modeLevel?: TerraDrawModeUndoRedoInterface;
        sessionLevel?: TerraDrawSessionUndoRedoInterface;
    }

    Undo/Redo configuration for TerraDraw. If not specified, defaults to:

    • modeLevel: TerraDrawModeUndoRedo({ maxStackSize: 100 })
    • sessionLevel: TerraDrawSessionUndoRedo({ maxStackSize: 100 })
    • keyboardShortcuts: TerraDrawUndoRedoKeyboardShortcuts()

    Settings

    Member Visibility

    On This Page

    Properties