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

Label

Class for creating labels on the map.

Extends: EventedEventedDynamicObjectEventTableEventedEventedDynamicObjectEventTableLabel
new constructor(map, options)

Example:

const label = new mapgl.Label(map, {
    coordinates: map.getCenter(),
    text: 'There is hope',
    color: '#ff0000',
    fontSize: 24,
});
Parameters
map
Map

The map instance.

options
LabelOptions

Label options.

Returns
Methods
destroy()

Destroys the label.

Returns
void
emit(type, data?)

Calls all event listeners with event type type

Parameters
type
K

Event type

data?
DynamicObjectEventTable<Label>[K]

Data transferred to events

Returns
this
getCoordinates()

Returns geographical coordinates [longitude, latitude] of the label.

Returns
number[]
hide()

Hides the label.

Returns
this
off(type, listener)

Removes event listener registered with on

Parameters
type
K

Event type

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

Event handler

Returns
this
on(type, listener)

Registers event listener

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable<Label>[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<Label>[K]) => void

Event handler

Returns
this
setCoordinates(coordinates)

Sets geographical coordinates of the label.

Parameters
coordinates
number[]

Coordinates [longitude, latitude] where the center of the label with its anchor should be set.

Returns
this
show()

Displays hidden label.

Returns
this