Class MaplibreTerradrawControl

Maplibre GL Terra Draw Control

Hierarchy (View Summary)

Implements

  • IControl

Constructors

constructor

Properties

controlContainer? defaultMode events isExpanded map? modeButtons options terradraw?

Methods

activate addTerradrawButton capitalize deactivate dispatchEvent getDefaultPosition getFeatures getTerraDrawInstance handleDownload off on onAdd onRemove resetActiveMode toggleButtonsWhenNoFeature toggleDeleteSelectionButton toggleEditor

Constructors

constructor

Properties

Protected OptionalcontrolContainer

controlContainer?: HTMLElement

ProtecteddefaultMode

defaultMode: string = 'render'

Protectedevents

events: {
    [key: string]: [
        (
            event?: {
                feature?: GeoJSONStoreFeatures[];
                mode?:
                    | "render"
                    | "point"
                    | "linestring"
                    | "polygon"
                    | "rectangle"
                    | "circle"
                    | "freehand"
                    | "angled-rectangle"
                    | "sensor"
                    | "sector"
                    | "select"
                    | "delete-selection"
                    | "delete"
                    | "download";
            },
        ) => void,
    ];
} = {}

ProtectedisExpanded

isExpanded: boolean = false

Protected Optionalmap

map?: Map$1

ProtectedmodeButtons

modeButtons: { [key: string]: HTMLButtonElement } = {}

Protectedoptions

options: TerradrawControlOptions = defaultControlOptions

Protected Optionalterradraw

terradraw?: TerraDraw

Methods

activate

ProtectedaddTerradrawButton

  • addTerradrawButton(
        mode:
            | "render"
            | "point"
            | "linestring"
            | "polygon"
            | "rectangle"
            | "circle"
            | "freehand"
            | "angled-rectangle"
            | "sensor"
            | "sector"
            | "select"
            | "delete-selection"
            | "delete"
            | "download",
    ): void

  • Add Terra Draw drawing mode button

    Parameters

    • mode:
          | "render"
          | "point"
          | "linestring"
          | "polygon"
          | "rectangle"
          | "circle"
          | "freehand"
          | "angled-rectangle"
          | "sensor"
          | "sector"
          | "select"
          | "delete-selection"
          | "delete"
          | "download"

      Terra Draw mode name

    Returns void

Protectedcapitalize

deactivate

ProtecteddispatchEvent

getDefaultPosition

  • getDefaultPosition(): ControlPosition

  • Get the default control position

    Returns ControlPosition

    default control position. Default is 'top-right'

getFeatures

  • getFeatures(
        onlySelected?: boolean,
    ): undefined | { features: GeoJSONStoreFeatures[]; type: string }

  • get GeoJSON features

    Parameters

    • onlySelected: boolean = false

      If true, returns only selected features. Default is false.

    Returns undefined | { features: GeoJSONStoreFeatures[]; type: string }

    FeatureCollection in GeoJSON format

getTerraDrawInstance

ProtectedhandleDownload

off

  • off(
        event: EventType,
        callback: (event?: { feature?: GeoJSONStoreFeatures[] }) => void,
    ): void

  • Unregister an event for the plugin

    Parameters

    • event: EventType

      event type

    • callback: (event?: { feature?: GeoJSONStoreFeatures[] }) => void

    Returns void

on

  • on(
        event: EventType,
        callback: (event?: { feature?: GeoJSONStoreFeatures[] }) => void,
    ): void

  • Register an event for the plugin

    Parameters

    • event: EventType

      event type

    • callback: (event?: { feature?: GeoJSONStoreFeatures[] }) => void

    Returns void

onAdd

  • onAdd(map: Map$1): HTMLElement

  • add the plugin control to maplibre

    Parameters

    • map: Map$1

      Maplibre Map object

    Returns HTMLElement

    HTML Element

onRemove

ProtectedresetActiveMode

ProtectedtoggleButtonsWhenNoFeature

ProtectedtoggleDeleteSelectionButton

ProtectedtoggleEditor

Settings

Member Visibility

On This Page

Constructors
Properties
Methods