API reference / @zaes/military-symbols/maplibre / MilitarySymbolsMapLibre

Class: MilitarySymbolsMapLibre

Extends

• SymbolMapLibre<MilitaryFeature>

Constructors

Constructor

new MilitarySymbolsMapLibre(
   map, 
   collection, 
   options?
): MilitarySymbolsMapLibre;

Parameters

map

Map$1

collection

MilitaryCollection

options?

MilitaryMapLibreOptions = {}

Returns

MilitarySymbolsMapLibre

Overrides

SymbolMapLibre<MilitaryFeature>.constructor

Properties

collection

readonly collection: MilitaryCollection;

Overrides

SymbolMapLibre.collection

---

map

readonly map: Map$1;

Inherited from

SymbolMapLibre.map

---

painter

readonly painter: SymbolPainter<MilitaryFeature>;

Inherited from

SymbolMapLibre.painter

---

view

readonly view: ViewAdapter;

Inherited from

SymbolMapLibre.view

Methods

dispose()

dispose(): void;

Returns

void

Inherited from

SymbolMapLibre.dispose

---

listen()

listen(handlers): () => void;

Listen for pointer and key events. Returns the function that stops listening.

Parameters

handlers

MapHostHandlers

Returns

() => void

Inherited from

SymbolMapLibre.listen

---

onViewChange()

onViewChange(listener): () => void;

Called when the view's resolution changes, so an overlay painted for it can be repainted.

Parameters

listener

() => void

Returns

() => void

Inherited from

SymbolMapLibre.onViewChange

---

refresh()

refresh(): void;

Repaint everything, as after a change to the family's configuration.

Returns

void

Inherited from

SymbolMapLibre.refresh

---

resolution()

resolution(): number;

Projected meters per CSS pixel on the current view, for painting an overlay.

Returns

number

Inherited from

SymbolMapLibre.resolution

---

setCursor()

setCursor(cursor): void;

Parameters

cursor

string

Returns

void

Inherited from

SymbolMapLibre.setCursor

---

setLeaderLines()

setLeaderLines(leaders): void;

Stand the symbols on leader lines, or lay them on the map again (false), as a setting changes.

Parameters

leaders

boolean | MilitaryPointLeader

Returns

void

---

setOverlay()

setOverlay(overlay): void;

Replace the overlay, or clear it with null.

Parameters

overlay

HostOverlay | null

Returns

void

Inherited from

SymbolMapLibre.setOverlay

---

setPointLeaders()

setPointLeaders(leaders): void;

Stand point symbols on leader lines, or lay them on the map again (undefined), as a host's setting changes: a tilted map with terrain wants them, a flat one does not.

Parameters

leaders

| MapLibrePointLeaders<MilitaryFeature> | undefined

Returns

void

Inherited from

SymbolMapLibre.setPointLeaders

---

viewAdapter()

viewAdapter(): ViewAdapter;

The view adapter.

Returns

ViewAdapter

Inherited from

SymbolMapLibre.viewAdapter