Class MaplibreTerradrawControl

Maplibre GL Terra Draw Control

Hierarchy (View Summary)

MaplibreTerradrawControl
- MaplibreMeasureControl

Implements

IControl

Constructors

constructor

new MaplibreTerradrawControl(
options?: TerradrawControlOptions,
): MaplibreTerradrawControl
Constructor
Parameters
- Optionaloptions: TerradrawControlOptions
  Plugin control options
Returns MaplibreTerradrawControl
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:77

Properties

`Protected`_isExpanded

_isExpanded: boolean = false

`Protected` `Optional`controlContainer

controlContainer?: HTMLElement

`Protected`defaultMode

defaultMode: string = 'render'

`Protected`events

events: { [key: string]: [(event: EventArgs) => void] } = {}

`Protected` `Optional`map

map?: Map$1

`Protected`modeButtons

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

`Protected`options

options: TerradrawControlOptions = defaultControlOptions

`Protected` `Optional`terradraw

terradraw?: TerraDraw

Accessors

isExpanded

get isExpanded(): boolean
get the state of whether the control is expanded or collapsed

Returns boolean
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:26
set isExpanded(value: boolean): void
set the state of the control either expanded or collapsed. terradraw mode will be reset if the state is changed. either expanded or collapsed event is dispatched when changed
Parameters
- value: boolean
Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:35

Methods

activate

activate(): void
Activate Terra Draw to start drawing

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:253

`Protected`addTerradrawButton

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
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:309

cleanStyle

cleanStyle(
    style: StyleSpecification,
    options?: {
        excludeTerraDrawLayers?: boolean;
        onlyTerraDrawLayers?: boolean;
    },
): StyleSpecification
clean maplibre style to filter only for terradraw related layers or without them. If options are not set, returns original style given to the function.

This can be useful incase users only want to get terradraw related layers or without it.

Usage: cleanStyle(map.getStyle, { excludeTerraDrawLayers: true}) cleanStyle(map.getStyle, { onlyTerraDrawLayers: true})
Parameters
- style: StyleSpecification
  maplibre style spec
- Optionaloptions: { excludeTerraDrawLayers?: boolean; onlyTerraDrawLayers?: boolean }
  - OptionalexcludeTerraDrawLayers?: boolean
    return maplibre style without terradraw layers and sources
  - OptionalonlyTerraDrawLayers?: boolean
    return maplibre style with only terradraw layers and sources
Returns StyleSpecification
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:428

deactivate

deactivate(): void
Deactivate Terra Draw to stop drawing

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:263

`Protected`dispatchEvent

dispatchEvent(event: EventType, args?: { [key: string]: unknown }): void
Dispatch an event. Pass the current snapshot of features and mode
Parameters
- event: EventType
  event type
- Optionalargs: { [key: string]: unknown }
  additional arguments
Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:236

getDefaultPosition

getDefaultPosition(): ControlPosition
Get the default control position

Returns ControlPosition
default control position. Default is 'top-right'
Implementation of IControl.getDefaultPosition
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:89

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
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:397

getTerraDrawInstance

getTerraDrawInstance(): undefined | TerraDraw
Get the Terra Draw instance. For the Terra Draw API, please refer to https://terradraw.io/#/api

Returns undefined | TerraDraw
Terra Draw instance
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:276

`Protected`handleDownload

handleDownload(): void
Download button click event handler

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:438

off

off(event: EventType, callback: (event: EventArgs) => void): void
Unregister an event for the plugin
Parameters
- event: EventType
  event type
- callback: (event: EventArgs) => void
Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:223

on

on(event: EventType, callback: (event: EventArgs) => void): void
Register an event for the plugin
Parameters
- event: EventType
  event type
- callback: (event: EventArgs) => void
Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:209

onAdd

onAdd(map: Map$1): HTMLElement
add the plugin control to maplibre
Parameters
- map: Map$1
  Maplibre Map object
Returns HTMLElement
HTML Element
Implementation of IControl.onAdd
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:99

onRemove

onRemove(): void
Remove the plugin control from maplibre

Returns void
void
Implementation of IControl.onRemove
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:193

`Protected`resetActiveMode

resetActiveMode(): void
Reset active mode to back to render mode

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:291

`Protected`toggleButtonsWhenNoFeature

toggleButtonsWhenNoFeature(): void
Toggle the state of buttons when there is no features

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:453

`Protected`toggleDeleteSelectionButton

toggleDeleteSelectionButton(): void
Toggle the state of delete-select button

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:476

`Protected`toggleEditor

toggleEditor(): void
Toggle editor control

Returns void
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:283

Class MaplibreTerradrawControl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MaplibreTerradrawControl

Properties

Protected_isExpanded

Protected OptionalcontrolContainer

ProtecteddefaultMode

Protectedevents

Protected Optionalmap

ProtectedmodeButtons

Protectedoptions

Protected Optionalterradraw

Accessors

isExpanded

Returns boolean

Parameters

Returns void

Methods

activate

Returns void

ProtectedaddTerradrawButton

Parameters

Returns void

cleanStyle

Parameters

OptionalexcludeTerraDrawLayers?: boolean

OptionalonlyTerraDrawLayers?: boolean

Returns StyleSpecification

deactivate

Returns void

ProtecteddispatchEvent

Parameters

Returns void

getDefaultPosition

Returns ControlPosition

getFeatures

Parameters

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

getTerraDrawInstance

Returns undefined | TerraDraw

ProtectedhandleDownload

Returns void

off

Parameters

Returns void

on

Parameters

Returns void

onAdd

Parameters

Returns HTMLElement

onRemove

Returns void

ProtectedresetActiveMode

Returns void

ProtectedtoggleButtonsWhenNoFeature

Returns void

ProtectedtoggleDeleteSelectionButton

Returns void

ProtectedtoggleEditor

Returns void

Settings

On This Page

`Protected`_isExpanded

`Protected` `Optional`controlContainer

`Protected`defaultMode

`Protected`events

`Protected` `Optional`map

`Protected`modeButtons

`Protected`options

`Protected` `Optional`terradraw

`Protected`addTerradrawButton

`Optional`excludeTerraDrawLayers?: boolean

`Optional`onlyTerraDrawLayers?: boolean

`Protected`dispatchEvent

`Protected`handleDownload

`Protected`resetActiveMode

`Protected`toggleButtonsWhenNoFeature

`Protected`toggleDeleteSelectionButton

`Protected`toggleEditor