Class default<POIMeta>

constructor

• new default<POIMeta>(options): default<POIMeta>

• Type Parameters

  • POIMeta

  Parameters

  • options: Options

  Returns default<POIMeta>

snapping

historyEntryCount

• get historyEntryCount(): number

• Returns number

historyPosition

• get historyPosition(): number

• Returns number

  current position in history

historySize

• get historySize(): number

• Returns number

  number of entries in history

map

• get map(): Map

• Returns Map

mode

• get mode(): TrackMode

• Returns TrackMode

• set mode(mode): void

• Parameters

  • mode: TrackMode

  Returns void

profiler

• get profiler(): Profiler

• Returns Profiler

router

• get router(): Router

• Returns Router

submode

• get submode(): TrackSubMode

• Returns TrackSubMode

• set submode(submode): void

• Parameters

  • submode: TrackSubMode

  Returns void

trackLayer

• get trackLayer(): VectorLayer<VectorSource<Feature<Geometry>>>

• Returns VectorLayer<VectorSource<Feature<Geometry>>>

addManualHistoryEntry

• addManualHistoryEntry(): void

• Returns void

addPOI

• addPOI(coordinates, meta): void

• Add a POI and notify track change listeners.

  Parameters

  • coordinates: number[]
  • meta: POIMeta

  Returns void

addTrackChangeEventListener

• addTrackChangeEventListener(fn): void

• Add new event listener to be notified on track changes.

  Parameters

  • fn: Function

  Returns void

addTrackHoverEventListener

• addTrackHoverEventListener(fn): void

• Add new event listener to be notified on track hover.

  Parameters

  • fn: Function

  Returns void

clear

• clear(): void

• Returns void

deleteLastPoint

• deleteLastPoint(): void

• Returns void

deletePOI

• deletePOI(index): void

• Delete a POI and notify track change listeners.

  Parameters

  • index: number

  Returns void

getControlPoints

• getControlPoints(): readonly Feature<Point>[]

• The library creates and keeps the control points consistently with the segments. It is generally a bad idea to update control points manually.

  Returns readonly Feature<Point>[]

  the internal control points as a readonly array

getPOIs

• getPOIs(): readonly Feature<Point>[]

• See addPOI, deletePOI, updatePOIMeta`. The library maintains the POI indexes and geometries so don't modify them.

  Returns readonly Feature<Point>[]

  the internal POIs as a readonly array

getSegments

• getSegments(): readonly Feature<LineString>[]

• The library manages the segments together with the control points. It is probably a bad idea to update segments manually.

  Returns readonly Feature<LineString>[]

  the internal segments as a readonly array

onTrackChanged_

• onTrackChanged_(): void

• Returns void

onTrackHovered_

• onTrackHovered_(point): void

• Parameters

  • point: ClosestPoint

  Returns void

redo

• redo(): Promise<void>

• Redo one drawing step

  Returns Promise<void>

removeTrackChangeEventListener

• removeTrackChangeEventListener(fn): void

• Remove registered event listener.

  Parameters

  • fn: Function

  Returns void

removeTrackHoverEventListener

• removeTrackHoverEventListener(fn): void

• Remove registered event listener.

  Parameters

  • fn: Function

  Returns void

render

• render(): void

• Returns void

restoreFeatures

• restoreFeatures(features): Promise<void>

• Parameters

  • features: Feature<LineString | Point>[]

  Returns Promise<void>

reverse

• reverse(): Promise<void>

• Returns Promise<void>

undo

• undo(): Promise<void>

• Undo one drawing step

  Returns Promise<void>

updatePOIMeta

• updatePOIMeta(index, meta): void

• Update the meta of a POI given by its index

  Parameters

  • index: number
  • meta: POIMeta

  Returns void