Indicates, that this layer is part of an exclusiveGroup
An array of arbitrary exclusive groups
directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.
True if this layer has been initialized, typically after its first activation.
returns the currently set locale. Can be used to provide locale specific URLs.
sets the locale and reloads the layer the if the URL is a locale aware Object.
A layers url, should on be configured, else an empty string
Static
classPrivate
_activatePrivate
_activateActivates this layer object, i.e. changes its internal view state and updates the map. The returned promise resolves, once the layer & any _implementations are initialized and all data is loaded. Once the promise resolves, the layer can still be inactive, if deactivate was called while initializing the layer.
creates an array of layer implementations for the given map.
Map
return the specific implementation
creates or returns a cached array of layer implementations for the given map.
initialized Map
return the specific implementation
checks if the currently active map supports this layer
is called from the map when the map is activated, and this layer is in the layerCollection of the map. Will create an implementation if it does not exits and will forward the activation call to the implementation.
is called from the map when the map is deactivated, and this layer is in the layerCollection of the map. will forward deactivation call to the map specific implementation
is called when a layer is removed from the layer collection of a map or said map is destroyed. destroys the associated implementation.
Optional
globalHider: GlobalHiderStatic
getOptional
[modulePrivate
_activePrivate
_allowPrivate
_exclusivePrivate
_globalProtected
Optional
_headersPrivate
_hiddenarray of object Ids which should be hidden within the context of the layers layerCollection, if this layer is active
Private
_implementationsPrivate
_initializedPrivate
_loadingPrivate
_localePrivate
_stateProtected
_supportedThe class names of the supported maps.
Protected
_urlPrivate
_zOptional
datasourceOptional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.
event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
An optional feature provider to provider features based on click events.
Readonly
nameunique Name
Event raised, if the layers state changes. Is passed the LayerState as its only parameter
Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
Generated using TypeDoc
Abstract base class for Layers. To create a layer Implementation the function
createImplementationsForMap
has to be implemented. To receive implementation options, implementgeImplementationOptions