Class MaplibreValhallaControl

Maplibre GL Terra Draw Measure Control

Hierarchy (View Summary)

MaplibreTerradrawControl
- MaplibreValhallaControl

Constructors

constructor

new MaplibreValhallaControl(
options?: ValhallaControlOptions,
): MaplibreValhallaControl
Constructor
Parameters
- Optionaloptions: ValhallaControlOptions
  Plugin control options
Returns MaplibreValhallaControl
Overrides MaplibreTerradrawControl.constructor
- Defined in controls/MaplibreValhallaControl.ts:219

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

`Protected`cssPrefix

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

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

distanceIsochroneCostingModel

get distanceIsochroneCostingModel(): "auto" | "pedestrian" | "bicycle"
Get the means of transport for Valhalla distance isochrone api

Returns "auto" | "pedestrian" | "bicycle"
isochroneCostingModelType
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:127
set distanceIsochroneCostingModel(
value: "auto" | "pedestrian" | "bicycle",
): void
Set the means of transport for Valhalla distance isochrone api
Parameters
- value: "auto" | "pedestrian" | "bicycle"
  isochroneCostingModelType
Returns void
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:135

fontGlyphs

get fontGlyphs(): string[]
Get/Set font glyph for valhalla 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 MaplibreValhallaControl()
drawControl.fontGlyphs = ['Open Sans Italic']
map.addControl(drawControl)
```
Returns string[]
- Defined in controls/MaplibreValhallaControl.ts:181
set fontGlyphs(fontNames: string[]): void
Parameters
- fontNames: string[]
Returns void
- Defined in controls/MaplibreValhallaControl.ts:189

isExpanded

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

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

isochroneContours

get isochroneContours(): Contour[]
Get the list of contours for Valhalla isochrone api

Returns Contour[]
Contour[]
- Defined in controls/MaplibreValhallaControl.ts:147
set isochroneContours(value: Contour[]): void
Set the list of contours for Valhalla isochrone api
Parameters
- value: Contour[]
  Contour[]
Returns void
- Defined in controls/MaplibreValhallaControl.ts:155

routingCostingModel

get routingCostingModel(): "auto" | "pedestrian" | "bicycle"
Get the means of transport for Valhalla routing api

Returns "auto" | "pedestrian" | "bicycle"
costingModelType
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:63
set routingCostingModel(value: "auto" | "pedestrian" | "bicycle"): void
Set the means of transport for Valhalla routing api
Parameters
- value: "auto" | "pedestrian" | "bicycle"
  costingModelType
Returns void
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:71

routingDistanceUnit

get routingDistanceUnit(): "kilometers" | "miles"
Get the distance unit for Valhalla routing api

Returns "kilometers" | "miles"
routingDistanceUnitType
Example
```
'kilometers', 'miles'
```
- Defined in controls/MaplibreValhallaControl.ts:84
set routingDistanceUnit(value: "kilometers" | "miles"): void
Set the distance unit for Valhalla routing api
Parameters
- value: "kilometers" | "miles"
  routingDistanceUnitType
Returns void
Example
```
'kilometers', 'miles'
```
- Defined in controls/MaplibreValhallaControl.ts:93

settingDialog

get settingDialog(): ModalDialog
Get the dialog instance for settings

Returns ModalDialog
- Defined in controls/MaplibreValhallaControl.ts:205
set settingDialog(value: ModalDialog): void
Set the dialog instance for settings
Parameters
- value: ModalDialog
Returns void
- Defined in controls/MaplibreValhallaControl.ts:211

showDeleteConfirmation

get showDeleteConfirmation(): boolean
Show delete confirmation popup when deleting features if true. Default is false

Returns boolean
Inherited from MaplibreTerradrawControl.showDeleteConfirmation
- Defined in controls/MaplibreTerradrawControl.ts:88
set showDeleteConfirmation(value: boolean): void
Set show delete confirmation popup when deleting features if true. Default is false
Parameters
- value: boolean
Returns void
Inherited from MaplibreTerradrawControl.showDeleteConfirmation
- Defined in controls/MaplibreTerradrawControl.ts:95

timeIsochroneCostingModel

get timeIsochroneCostingModel(): "auto" | "pedestrian" | "bicycle"
Get the means of transport for Valhalla time isochrone api

Returns "auto" | "pedestrian" | "bicycle"
isochroneCostingModelType
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:106
set timeIsochroneCostingModel(value: "auto" | "pedestrian" | "bicycle"): void
Set the means of transport for Valhalla time isochrone api
Parameters
- value: "auto" | "pedestrian" | "bicycle"
  isochroneCostingModelType
Returns void
Example
```
'pedestrian', 'bicycle', 'auto'
```
- Defined in controls/MaplibreValhallaControl.ts:114

valhallaUrl

get valhallaUrl(): string
Get the URL of Valhalla API

Returns string
- Defined in controls/MaplibreValhallaControl.ts:47
set valhallaUrl(value: string): void
Set the URL of Valhalla API
Parameters
- value: string
  URL of Valhalla API
Returns void
- Defined in controls/MaplibreValhallaControl.ts:54

Methods

activate

activate(): void
Activate Terra Draw to start drawing

Returns void
Overrides MaplibreTerradrawControl.activate
- Defined in controls/MaplibreValhallaControl.ts:320

`Protected`addTerradrawButton

addTerradrawButton(mode: TerradrawMode): void
Add Terra Draw drawing mode button
Parameters
- mode: TerradrawMode
  Terra Draw mode name
Returns void
Overrides MaplibreTerradrawControl.addTerradrawButton
- Defined in controls/MaplibreValhallaControl.ts:752

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 controls/MaplibreValhallaControl.ts:340

`Protected`clearExtendedFeatures

clearExtendedFeatures(sourceIds: string[], ids?: FeatureId[]): 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
  the array of feature ID. Optional, if undefined, delete all labels for source
Returns void
void
Inherited from MaplibreTerradrawControl.clearExtendedFeatures
- Defined in controls/MaplibreTerradrawControl.ts:689

deactivate

deactivate(): void
Deactivate Terra Draw to stop drawing

Returns void
Inherited from MaplibreTerradrawControl.deactivate
- Defined in controls/MaplibreTerradrawControl.ts:307

`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 controls/MaplibreTerradrawControl.ts:280

getDefaultPosition

getDefaultPosition(): ControlPosition
Get the default control position

Returns ControlPosition
default control position. Default is 'top-right'
Inherited from MaplibreTerradrawControl.getDefaultPosition
- Defined in controls/MaplibreTerradrawControl.ts:130

getFeatures

getFeatures(
    onlySelected?: boolean,
): {
    features: GeoJSONStoreFeatures<GeoJSONStoreGeometries>[];
    type: string;
}
get GeoJSON features
Parameters
- onlySelected: boolean = false
  If true, returns only selected features. Default is false.
Returns { features: GeoJSONStoreFeatures<GeoJSONStoreGeometries>[]; type: string }
FeatureCollection in GeoJSON format
Overrides MaplibreTerradrawControl.getFeatures
- Defined in controls/MaplibreValhallaControl.ts:1286

getTerraDrawInstance

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

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

`Protected`handleDeleteAllFeatures

handleDeleteAllFeatures(): void
Delete all features from the store

Returns void
Inherited from MaplibreTerradrawControl.handleDeleteAllFeatures
- Defined in controls/MaplibreTerradrawControl.ts:567

`Protected`handleDeleteSelectedFeatures

handleDeleteSelectedFeatures(): void
Delete selected features from the store

Returns void
Inherited from MaplibreTerradrawControl.handleDeleteSelectedFeatures
- Defined in controls/MaplibreTerradrawControl.ts:589

`Protected`handleDownload

handleDownload(): void
Download button click event handler

Returns void
Inherited from MaplibreTerradrawControl.handleDownload
- Defined in controls/MaplibreTerradrawControl.ts:613

`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 controls/MaplibreTerradrawControl.ts:321

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 controls/MaplibreTerradrawControl.ts:267

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 controls/MaplibreTerradrawControl.ts:253

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 controls/MaplibreValhallaControl.ts:302

onRemove

onRemove(): void
Remove the plugin control from maplibre

Returns void
void
Overrides MaplibreTerradrawControl.onRemove
- Defined in controls/MaplibreValhallaControl.ts:312

resetActiveMode

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

Returns void
Inherited from MaplibreTerradrawControl.resetActiveMode
- Defined in controls/MaplibreTerradrawControl.ts:401

`Protected`showDeleteConfirmationDialog

showDeleteConfirmationDialog(onConfirm: () => void): void
Show delete confirmation dialog.
Parameters
- onConfirm: () => void
  Callback function that will be invoked when the user confirms deletion by clicking the "Delete" button in the dialog; typically used to delete all features before the dialog is closed.
Returns void
Inherited from MaplibreTerradrawControl.showDeleteConfirmationDialog
- Defined in controls/MaplibreTerradrawControl.ts:523

`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 controls/MaplibreTerradrawControl.ts:342

`Protected`toggleButtonsWhenNoFeature

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

Returns void
Inherited from MaplibreTerradrawControl.toggleButtonsWhenNoFeature
- Defined in controls/MaplibreTerradrawControl.ts:628

`Protected`toggleDeleteSelectionButton

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

Returns void
Inherited from MaplibreTerradrawControl.toggleDeleteSelectionButton
- Defined in controls/MaplibreTerradrawControl.ts:652

`Protected`toggleEditor

toggleEditor(): void
Toggle editor control

Returns void
Inherited from MaplibreTerradrawControl.toggleEditor
- Defined in controls/MaplibreTerradrawControl.ts:393

Class MaplibreValhallaControl

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MaplibreValhallaControl

Properties

Protected_cssPrefix

Protected_isExpanded

Protected OptionalcontrolContainer

ProtecteddefaultMode

Protectedevents

Protected Optionalmap

ProtectedmodeButtons

Protectedoptions

Protected Optionalterradraw

Accessors

ProtectedcssPrefix

Returns string

distanceIsochroneCostingModel

Returns "auto" | "pedestrian" | "bicycle"

Example

Parameters

Returns void

Example

fontGlyphs

Returns string[]

Parameters

Returns void

isExpanded

Returns boolean

Parameters

Returns void

isochroneContours

Returns Contour[]

Parameters

Returns void

routingCostingModel

Returns "auto" | "pedestrian" | "bicycle"

Example

Parameters

Returns void

Example

routingDistanceUnit

Returns "kilometers" | "miles"

Example

Parameters

Returns void

Example

settingDialog

Returns ModalDialog

Parameters

Returns void

showDeleteConfirmation

Returns boolean

Parameters

Returns void

timeIsochroneCostingModel

Returns "auto" | "pedestrian" | "bicycle"

Example

Parameters

Returns void

Example

valhallaUrl

Returns string

Parameters

Returns void

Methods

activate

Returns void

ProtectedaddTerradrawButton

Parameters

Returns void

cleanStyle

Parameters

`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`handleDeleteAllFeatures

`Protected`handleDeleteSelectedFeatures

`Protected`handleDownload

`Protected`handleModeChange

`Protected`showDeleteConfirmationDialog

`Protected`syncButtonStates

`Protected`toggleButtonsWhenNoFeature

`Protected`toggleDeleteSelectionButton

`Protected`toggleEditor