SymbolLayer class

Package:

azure-maps-control

Renders point based data as symbols on the map using text and/or icons. Symbols can also be created for line and polygon data as well.

Extends

Layer

Constructors

SymbolLayer(string | Source, string, SymbolLayerOptions)

Constructs a new SymbolLayer.

Inherited Properties

metadata

A property for associating custom data with the layer.

Methods

getOptions()	Gets the options of the symbol layer.
getSource()	Gets the source provided when creating the layer.
setOptions(SymbolLayerOptions)	Sets the options of the symbol layer.

Inherited Methods

getId()	Gets the id of the layer
getMap()	Gets the map that the layer is currently added to, or null.
onAdd(Map)	Initialization method for the layer which is called when added to the map.
onRemove()	Method that is called when the layer is removed from the map. Should perform any necessary cleanup for the layer.

Constructor Details

SymbolLayer(string | Source, string, SymbolLayerOptions)

Constructs a new SymbolLayer.

new SymbolLayer(source: string | Source, id?: string, options?: SymbolLayerOptions)

Parameters

source

string | Source

The id or instance of a data source which the layer will render.

id

string

The id of the layer. If not specified a random one will be generated.

options

SymbolLayerOptions

The options of the polygon layer.

Inherited Property Details

metadata

A property for associating custom data with the layer.

metadata?: any

Property Value

any

Inherited From Layer.metadata

Method Details

getOptions()

Gets the options of the symbol layer.

function getOptions(): SymbolLayerOptions

Returns

SymbolLayerOptions

getSource()

Gets the source provided when creating the layer.

function getSource(): string | Source

Returns

string | Source

setOptions(SymbolLayerOptions)

Sets the options of the symbol layer.

function setOptions(options: SymbolLayerOptions)

Parameters

options

SymbolLayerOptions

Inherited Method Details

getId()

Gets the id of the layer

function getId(): string

Returns

string

Inherited From Layer.getId

getMap()

Gets the map that the layer is currently added to, or null.

function getMap(): Map

Returns

Map

Inherited From Layer.getMap

onAdd(Map)

Initialization method for the layer which is called when added to the map.

function onAdd(map: Map)

Parameters

map

Map

The map the layer has been added to.

Inherited From Layer.onAdd

onRemove()

Method that is called when the layer is removed from the map. Should perform any necessary cleanup for the layer.

function onRemove()

Inherited From Layer.onRemove