SimpleDataLayer class

Package:

azure-maps-spatial-io

A layer that simplifies the rendering of geospatial data on the map. Note: Because this layer wraps other layers which will be added/removed with this some layer ordering operations are not supported. Adding this layer before another, adding another layer before this, and moving this layer are not supported. These restrictions only apply to this layer and not the layers wrapped by this.

Extends

Layer

Constructors

SimpleDataLayer(azmaps.source.DataSource, SimpleDataLayerOptions)

Constructs a new SimpleDataLayer.

Inherited Properties

metadata

A property for associating custom data with the layer.

Methods

closePopup()	Closes the popup.
dispose()	Cleans up any resources this layer is consuming.
getLayers()	Gets the group of layers wrapped by this class, used for rendering data.
getOptions()	Gets the options of the layer.
onAdd(azmaps.Map)	The event logic that processes when the layer is added to the map.
onRemove()	The event logic that processes when the layer is removed from the map.
setOptions(SimpleDataLayerOptions)	Sets the options of the layer.

Inherited Methods

getId()	Gets the id of the layer
getMap()	Gets the map that the layer is currently added to, or null.

Constructor Details

SimpleDataLayer(azmaps.source.DataSource, SimpleDataLayerOptions)

Constructs a new SimpleDataLayer.

new SimpleDataLayer(datasource: azmaps.source.DataSource, options?: SimpleDataLayerOptions)

Parameters

datasource

azmaps.source.DataSource

The data source that contains the data.

options

SimpleDataLayerOptions

The options of the simple data 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

closePopup()

Closes the popup.

function closePopup()

dispose()

Cleans up any resources this layer is consuming.

function dispose()

getLayers()

Gets the group of layers wrapped by this class, used for rendering data.

function getLayers(): SimpleDataLayerGroup

Returns

SimpleDataLayerGroup

getOptions()

Gets the options of the layer.

function getOptions(): SimpleDataLayerOptions

Returns

SimpleDataLayerOptions

onAdd(azmaps.Map)

The event logic that processes when the layer is added to the map.

function onAdd(map: azmaps.Map)

Parameters

map

azmaps.Map

onRemove()

The event logic that processes when the layer is removed from the map.

function onRemove()

setOptions(SimpleDataLayerOptions)

Sets the options of the layer.

function setOptions(options: SimpleDataLayerOptions)

Parameters

options

SimpleDataLayerOptions

The new options for the layer.

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