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.
if set to true, the layer types of the map will be ignored when checking if the layer is supported. Changes will call reload on the layer.
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.
if provided, the layer will only be shown in the given MapNames. An empty array will show the layer in all configured maps. Changes will call reload on the layer.
A layers url, should on be configured, else an empty string
StaticclassActivates 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.
adds an entity
Cesium Entity options or the entity
Optionalattributes: Record<string, unknown>a set of properties, typically used for rendering a balloon
OptionalallowPicking: booleanwhether to override the layers allowPicking setting for this entity
the entities id
creates an array of layer implementations for the given map.
return the specific implementation
Deactivates a layer, changing the internal view state
disposes of this layer, removes instances from the current maps and the framework
Zooms to an entity with the given id
destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes
returns the Extent of this layer
Returns all implementation of this layer for all maps
creates or returns a cached array of layer implementations for the given map.
initialized Map
return the specific implementation
returns the Extent of this layer or null, if the layers extent was not defined or cannot be established
initializes the layer, can be used to defer loading
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
Reloads all the data loaded and forces a redraw
is called when a layer is removed from the layer collection of a map or said map is destroyed. destroys the associated implementation.
Removes an entity from this layer by id
StaticgetProtected Optional_Protected_The class names of the supported maps.
Protected_Optional[moduleOptionaldatasourceOptional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.
The entities of this layer. Use the addEntity API to add Enitities to ensure interoperability with vcm interfaces
event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument
An optional feature or attribute provider to provide or augment features on click events.
The feature visibility of this layer. NOTE: Entities cannot be highlighted at this moment.
ReadonlymapReadonlynameunique 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.
Represents a layer of Cesium.Entity