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

    Interface TerradrawControlOptions

    Terradraw Control Plugin control constructor options

    interface TerradrawControlOptions {
        adapterOptions?: BaseAdapterConfig;
        modeOptions?: ModeOptions;
        modes?: (
            | "render"
            | "point"
            | "linestring"
            | "polygon"
            | "rectangle"
            | "circle"
            | "freehand"
            | "angled-rectangle"
            | "sensor"
            | "sector"
            | "select"
            | "delete-selection"
            | "delete"
            | "download"
        )[];
        open?: boolean;
    }
    Index

    Properties

    adapterOptions? modeOptions? modes? open?

    Properties

    adapterOptions?: BaseAdapterConfig

    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?: (
        | "render"
        | "point"
        | "linestring"
        | "polygon"
        | "rectangle"
        | "circle"
        | "freehand"
        | "angled-rectangle"
        | "sensor"
        | "sector"
        | "select"
        | "delete-selection"
        | "delete"
        | "download"
    )[]

    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

    Settings

    Member Visibility

    On This Page

    Properties