The style the layer had at construction
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.
The splitDirection to be applied - for 3D vector features currently only working on points with a Model
style, use setStyle to change
A layers url, should on be configured, else an empty string
StaticclassProtected_ProtectedChanges features which use the layers style or if the layers style is a declarative style so they are re-rendered
Activates 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.
add features to the vector layer and return an array with their ids. The geometry will be mutated and transformed to EPSG 3857 mercator coordinate system features will be added an id, if they do not already have one.
returns the ids of the added features. if a feature has an id and the same id is alread in the layer, it will not be added.
Clears the style of this layer
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
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 an feature if found, otherwise null feature geometries are always in EPSG 3857 mercator coordinate system
returns an array with features Feature geometries are always in EPSG 3857 mercator coordinate system
returns an array with features feature geometries are always in EPSG 3857 mercator coordinate system
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 openlayers vector source
OptionalstyleOptions: StyleItem | VectorStyleItemOptions | DeclarativeStyleItemOptionsOptionaldefaultStyle: StyleItemReturns the configured Extent of this layer or tries to calculate the extent based on the current features. Returns null of no extent was configured and the layer is void of any features with a valid geometry.
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
removes all features from the vector layer
is called when a layer is removed from the layer collection of a map or said map is destroyed. destroys the associated implementation.
removes features from the vector layer
sets the highlightstyle of this layer
Sets the style based on a styleName on a layer
Optionalsilent: booleanSets the meta values based on a Object. Does not carry over the style
StaticgetProtected_Protected 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.
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.
FeatureVisibility tracks the highlighting and hiding of features on this layer
A flag to indicate, whether the features in the layer have a UUID, allowing certain interactions, e.g. hidding its features in plannings
If true, the cesium synchronizers are destroyed on map change
ReadonlymapReadonlynameunique Name
Readonlysplitraised if the split direction changes, is passed the split direction as its only argument
Event raised, if the layers state changes. Is passed the LayerState as its only parameter
ReadonlystyleAn event, called when the style of the layer changes. Is passed the new style item as its value.
Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
the vector layer is the standard layer to display vector features on the map. mostly, a specialization is used to load data from a certain source, e.g. GeoJSONLayer, FlatGeobufLayer, etc. But it can also be used as a generic layer to add features to, mostly at runtime.
This layer ignores the mapLayerTypes configuration by default, as it is mostly used to display user data. Be sure to configure this otherwise if needed and reset the default when extending this class to implement a layer for a specific data source.