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:190

Properties

`Protected`_cssPrefix

_cssPrefix: string = ''

`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:90
set areaPrecision(value: number): void
Parameters
- value: number
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:93

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:130
set computeElevation(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:133

`Protected`cssPrefix

get cssPrefix(): string
CSS prefix for the control buttons. Default is empty string

Returns string
Inherited from MaplibreTerradrawControl.cssPrefix
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:42

distancePrecision

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

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

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:157
set fontGlyphs(fontNames: string[]): void
Parameters
- fontNames: string[]
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:169

forceAreaUnit

get forceAreaUnit(): forceAreaUnitType
Default is auto. If auto is set, unit is converted depending on the value and selection of area unit. If a specific unit is specified, it returns the value always the same. If a selected unit is not the same type of unit either metric of imperial, it will be ignored, and auto will be applied.

Returns forceAreaUnitType
- Defined in src/lib/controls/MaplibreMeasureControl.ts:102
set forceAreaUnit(value: forceAreaUnitType): void
Parameters
- value: forceAreaUnitType
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:105

forceDistanceUnit

get forceDistanceUnit(): forceDistanceUnitType
Default is auto. If auto is set, the unit is converted automatically based on the value. If a specific unit is specified (e.g., 'km', 'm', 'cm', 'mi', 'ft', 'in'), the value is always returned in that unit. This property is only effective when distanceUnit is set to 'kilometers' or 'miles'. If distanceUnit is set to other values (e.g., 'degrees', 'radians'), it will be ignored, and auto will be applied. If you need to force other unit type, please use DistanceUnit property.

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

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:34
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:51

measureUnitSymbols

get measureUnitSymbols(): MeasureUnitSymbolType
Measure unit symbols. If you want to change the default symbol, please overwrite the symbol by this option.

Returns MeasureUnitSymbolType
- Defined in src/lib/controls/MaplibreMeasureControl.ts:114
set measureUnitSymbols(value: MeasureUnitSymbolType): void
Parameters
- value: MeasureUnitSymbolType
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:120

measureUnitType

get measureUnitType(): MeasureUnitType
The unit of measurement can be metric or imperial. Default is metric. The measuring result will be recalculated once new value is set

Returns MeasureUnitType
- Defined in src/lib/controls/MaplibreMeasureControl.ts:44
set measureUnitType(value: MeasureUnitType): void
Parameters
- value: MeasureUnitType
Returns void
- Defined in src/lib/controls/MaplibreMeasureControl.ts:47

Methods

activate

activate(): void
Activate Terra Draw to start drawing

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

`Protected`addTerradrawButton

addTerradrawButton(
    mode:
        | "render"
        | "select"
        | "point"
        | "linestring"
        | "polygon"
        | "rectangle"
        | "circle"
        | "freehand"
        | "freehand-linestring"
        | "angled-rectangle"
        | "sector"
        | "marker"
        | "sensor"
        | "delete-selection"
        | "delete"
        | "download",
): void
Add Terra Draw drawing mode button
Parameters
- mode:
      | "render"
      | "select"
      | "point"
      | "linestring"
      | "polygon"
      | "rectangle"
      | "circle"
      | "freehand"
      | "freehand-linestring"
      | "angled-rectangle"
      | "sector"
      | "marker"
      | "sensor"
      | "delete-selection"
      | "delete"
      | "download"
  Terra Draw mode name
Returns void
Inherited from MaplibreTerradrawControl.addTerradrawButton
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:400

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:326

`Protected`clearExtendedFeatures

clearExtendedFeatures(sourceIds: string[], ids?: FeatureId[] | undefined): void
Clear GeoJSON feature related to extended control such as measure and valhalla by TerraDraw feature ID
Parameters
- sourceIds: string[]
  the array of source ID to delete
- ids: FeatureId[] | undefined = undefined
  the array of feature ID. Optional, if undefined, delete all labels for source
Returns void
void
Inherited from MaplibreTerradrawControl.clearExtendedFeatures
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:610

deactivate

deactivate(): void
Deactivate Terra Draw to stop drawing

Returns void
Inherited from MaplibreTerradrawControl.deactivate
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:293

`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:266

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:116

getFeatures

getFeatures(
onlySelected?: boolean,
): { features: GeoJSONStoreFeatures[]; type: string } | undefined
get GeoJSON features
Parameters
- onlySelected: boolean = false
  If true, returns only selected features. Default is false.
Returns { features: GeoJSONStoreFeatures[]; type: string } | undefined
FeatureCollection in GeoJSON format
Inherited from MaplibreTerradrawControl.getFeatures
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:488

getTerraDrawInstance

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

Returns TerraDraw | undefined
Terra Draw instance with additional extensions for the plugin control
Inherited from MaplibreTerradrawControl.getTerraDrawInstance
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:361

`Protected`handleDownload

handleDownload(): void
Download button click event handler

Returns void
Inherited from MaplibreTerradrawControl.handleDownload
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:534

`Protected`handleModeChange

handleModeChange(mode: string, target: TerraDraw): void
Handle mode change operations that should be executed after setMode is called
Parameters
- mode: string
  The active mode name
- target: TerraDraw
  The Terra Draw instance
Returns void
The result of the setMode operation
Inherited from MaplibreTerradrawControl.handleModeChange
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:307

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:253

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:239

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:250

onRemove

onRemove(): void
Remove the plugin control from maplibre

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

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:285

resetActiveMode

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

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

`Protected`syncButtonStates

syncButtonStates(mode: string): void
Synchronize button states with the current Terra Draw mode
Parameters
- mode: string
  The active mode name
Returns void
Inherited from MaplibreTerradrawControl.syncButtonStates
- Defined in src/lib/controls/MaplibreTerradrawControl.ts:328

`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:549

`Protected`toggleDeleteSelectionButton

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

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

`Protected`toggleEditor

toggleEditor(): void
Toggle editor control

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

Class MaplibreMeasureControl

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MaplibreMeasureControl

Properties

Protected_cssPrefix

Protected_isExpanded

Protected OptionalcontrolContainer

ProtecteddefaultMode

Protectedevents

Protected Optionalmap

ProtectedmodeButtons

Protectedoptions

Protected Optionalterradraw

Accessors

areaPrecision

Returns number

Parameters

Returns void

computeElevation

Returns boolean

Parameters

Returns void

ProtectedcssPrefix

Returns string

distancePrecision

Returns number

Parameters

Returns void

fontGlyphs

Returns string[]

Parameters

Returns void

forceAreaUnit

Returns forceAreaUnitType

Parameters

Returns void

forceDistanceUnit

Returns forceDistanceUnitType

Parameters

Returns void

isExpanded

Returns boolean

Parameters

Returns void

measureUnitSymbols

Returns MeasureUnitSymbolType

Parameters

Returns void

measureUnitType

Returns MeasureUnitType

Parameters

Returns void

Methods

activate

Returns void

ProtectedaddTerradrawButton

Parameters

Returns void

cleanStyle

Parameters

OptionalexcludeTerraDrawLayers?: boolean

OptionalonlyTerraDrawLayers?: boolean

Returns StyleSpecification

ProtectedclearExtendedFeatures

Parameters

Returns void

deactivate

Returns void

ProtecteddispatchEvent

Parameters

Returns void

getDefaultPosition

`Protected`_cssPrefix

`Protected`_isExpanded

`Protected` `Optional`controlContainer

`Protected`defaultMode

`Protected`events

`Protected` `Optional`map

`Protected`modeButtons

`Protected`options

`Protected` `Optional`terradraw

`Protected`cssPrefix

`Protected`addTerradrawButton

`Optional`excludeTerraDrawLayers?: boolean

`Optional`onlyTerraDrawLayers?: boolean

`Protected`clearExtendedFeatures

`Protected`dispatchEvent

`Protected`handleDownload

`Protected`handleModeChange

`Protected`syncButtonStates

`Protected`toggleButtonsWhenNoFeature

`Protected`toggleDeleteSelectionButton

`Protected`toggleEditor