Polyline | MapGL | Urbi Documentation
MapGL JS API
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

Polyline

Class for creating a polyline on the map

Extends: EventedEventedDynamicObjectEventTableEventedEventedDynamicObjectEventTablePolyline
new constructor(map, options)

Example:

const polyline = new mapgl.Polyline(map, {
    coordinates: [
        [82.878543, 54.975937],
        [82.903049, 54.981333],
        [82.929373, 54.973391],
    ],
});
Parameters
map
Map

The map instance

options
PolylineOptions

Polyline options

Returns
Methods
destroy()

Destroys the polyline

Returns
void
emit(type, data?)

Calls all event listeners with event type type

Parameters
type
K

Event type

data?
DynamicObjectEventTable<Polyline>[K]

Data transferred to events

Returns
this
off(type, listener)

Removes event listener registered with on

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable<Polyline>[K]) => void

Event handler

Returns
this
on(type, listener)

Registers event listener

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable<Polyline>[K]) => void

Event handler

Returns
this
once(type, listener)

Registers event listener which will be called once

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable<Polyline>[K]) => void

Event handler

Returns
this