Class MaplibreMeasureControl

Maplibre GL Terra Draw Measure Control

Hierarchy (View Summary)

MaplibreTerradrawControl
- MaplibreMeasureControl

Constructors

constructor

new MaplibreMeasureControl(
options?: MeasureControlOptions,
): MaplibreMeasureControl
Constructor
Parameters
- Optionaloptions: MeasureControlOptions
  Plugin control options
Returns MaplibreMeasureControl
Overrides MaplibreTerradrawControl.constructor
- Defined in src/lib/controls/MaplibreMeasureControl.ts:151

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

areaPrecision

get areaPrecision(): number
The precision of area value. Using setter to override the value if you want.

Returns number
- Defined in src/lib/controls/MaplibreMeasureControl.ts:78
set areaPrecision(value: number): void
Parameters
- value: number
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:81

areaUnit

get areaUnit(): AreaUnit
The unit of area can be metric (m², ha, km²) or imperial (yd², acre, mi²). Default is metric. The measuring result will be recalculated once new value is set

Returns AreaUnit
- Defined in src/lib/controls/MaplibreMeasureControl.ts:66
set areaUnit(value: AreaUnit): void
Parameters
- value: AreaUnit
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:69

computeElevation

get computeElevation(): boolean
The flag of whether computing elevation. Default is false. Using setter to override the value if you want.

Returns boolean
- Defined in src/lib/controls/MaplibreMeasureControl.ts:91
set computeElevation(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:94

distancePrecision

get distancePrecision(): number
The precision of distance value. It will be set different value dwhen distance unit is changed. Using setter to override the value if you want.

Returns number
- Defined in src/lib/controls/MaplibreMeasureControl.ts:53
set distancePrecision(value: number): void
Parameters
- value: number
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:56

distanceUnit

get distanceUnit(): DistanceUnit
The unit of distance can be degrees, radians, miles, or kilometers (default 'kilometers') The measuring result will be recalculated once new value is set

Returns DistanceUnit
- Defined in src/lib/controls/MaplibreMeasureControl.ts:34
set distanceUnit(value: DistanceUnit): void
Parameters
- value: DistanceUnit
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:37

fontGlyphs

get fontGlyphs(): string[]
Get/Set font glyph for measure control layers

As default, this maesure control uses maplibre's default font glyphs(Open Sans Regular,Arial Unicode MS Regular) described at https://maplibre.org/maplibre-style-spec/layers/#text-font

If you are using your own maplibre style or different map privider, you probably need to set the font glyphs to match your maplibre style.

Font glyph availability depends on what types of glyphs are supported by your maplibre style (e.g., Carto, Openmap tiles, Protomap, Maptiler, etc.) Please make sure the font glyphs are available in your maplibre style.

Usage:
```
const drawControl = new MaplibreMeasureControl()
drawControl.fontGlyphs = ['Open Sans Italic']
map.addControl(drawControl)
```
Returns string[]
- Defined in src/lib/controls/MaplibreMeasureControl.ts:118
set fontGlyphs(fontNames: string[]): void
Parameters
- fontNames: string[]
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:130

isExpanded

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

Returns boolean
Inherited from MaplibreTerradrawControl.isExpanded
- 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
Inherited from MaplibreTerradrawControl.isExpanded
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:35

Methods

activate

activate(): void
Activate Terra Draw to start drawing

Returns void
Overrides MaplibreTerradrawControl.activate
- Defined in src/lib/controls/MaplibreMeasureControl.ts:190

`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
Inherited from MaplibreTerradrawControl.addTerradrawButton
- 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
Overrides MaplibreTerradrawControl.cleanStyle
- Defined in src/lib/controls/MaplibreMeasureControl.ts:249

deactivate

deactivate(): void
Deactivate Terra Draw to stop drawing

Returns void
Inherited from MaplibreTerradrawControl.deactivate
- 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
Inherited from MaplibreTerradrawControl.dispatchEvent
- 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'
Inherited from MaplibreTerradrawControl.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
Overrides MaplibreTerradrawControl.getFeatures
- Defined in src/lib/controls/MaplibreMeasureControl.ts:1003

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
Inherited from MaplibreTerradrawControl.getTerraDrawInstance
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:276

`Protected`handleDownload

handleDownload(): void
Download button click event handler

Returns void
Inherited from MaplibreTerradrawControl.handleDownload
- 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
Inherited from MaplibreTerradrawControl.off
- 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
Inherited from MaplibreTerradrawControl.on
- 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
Overrides MaplibreTerradrawControl.onAdd
- Defined in src/lib/controls/MaplibreMeasureControl.ts:173

onRemove

onRemove(): void
Remove the plugin control from maplibre

Returns void
void
Overrides MaplibreTerradrawControl.onRemove
- Defined in src/lib/controls/MaplibreMeasureControl.ts:182

recalc

recalc(): void
Recalculate area and distance in TerraDraw snapshot

if you use addFeatures to restore GeoJSON features to TerraDraw, this recalc method needs to be called to re-measure again.

For example, the below code is an example usage.
```
drawInstance?.addFeatures(initData);
map?.once('idle', ()=>{
  drawControl.recalc()
})
```
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:208

`Protected`resetActiveMode

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

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

`Protected`toggleButtonsWhenNoFeature

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

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

`Protected`toggleDeleteSelectionButton

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

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

`Protected`toggleEditor

toggleEditor(): void
Toggle editor control

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

Class MaplibreMeasureControl

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MaplibreMeasureControl

Properties

Protected_isExpanded

Protected OptionalcontrolContainer

ProtecteddefaultMode

Protectedevents

Protected Optionalmap

ProtectedmodeButtons

Protectedoptions

Protected Optionalterradraw

Accessors

areaPrecision

Returns number

Parameters

Returns void

areaUnit

Returns AreaUnit

Parameters

Returns void

computeElevation

Returns boolean

Parameters

Returns void

distancePrecision

Returns number

Parameters

Returns void

distanceUnit

Returns DistanceUnit

Parameters

Returns void

fontGlyphs

Returns string[]

Parameters

Returns void

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

`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