Skip to main content

ItineraryLayer

wemap-sdk-js


Class: ItineraryLayer

Renders a route path on the map with multilevel level-split geometry.

WemapMap.remove() does not destroy this layer — call destroy explicitly.

Constructors​

Constructor​

new ItineraryLayer(wemapMap): ItineraryLayer

Parameters​

wemapMap​

WemapMap

Returns​

ItineraryLayer

Methods​

clear()​

clear(): void

Remove the route and cancel any pending deferred set.

Returns​

void


destroy()​

destroy(): void

Remove the route and detach listeners. Idempotent.

Returns​

void


set()​

set(input, options?): void

Render a route path. Empty coords clears the route. Before the style loads, the call is deferred until style.load.

Parameters​

input​

ItineraryInput

options?​

ItineraryLayerSetOptions = {}

Returns​

void