Class VectorLayer

VectorLayer Layer for OpenlayersMap, Cesium and ObliqueMap

Hierarchy

Implements

Accessors

  • get className(): string
  • Returns string

  • get exclusive(): boolean
  • Indicates, that this layer is part of an exclusiveGroup

    Returns boolean

  • get exclusiveGroups(): (string | symbol)[]
  • An array of arbitrary exclusive groups

    Returns (string | symbol)[]

  • set exclusiveGroups(groups): void
  • Parameters

    • groups: (string | symbol)[]

    Returns void

  • get headers(): undefined | Record<string, string>
  • directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.

    Returns undefined | Record<string, string>

  • set headers(headers): void
  • Parameters

    • headers: undefined | Record<string, string>

    Returns void

  • get hiddenObjectIds(): string[]
  • Returns string[]

  • set hiddenObjectIds(hiddenObjectIds): void
  • Parameters

    • hiddenObjectIds: string[]

    Returns void

  • get initialized(): boolean
  • True if this layer has been initialized, typically after its first activation.

    Returns boolean

  • get locale(): string
  • returns the currently set locale. Can be used to provide locale specific URLs.

    Returns string

  • set locale(value): void
  • sets the locale and reloads the layer the if the URL is a locale aware Object.

    Parameters

    • value: string

    Returns void

  • get url(): string
  • A layers url, should on be configured, else an empty string

    Returns string

  • set url(url): void
  • Parameters

    • url: string | Record<string, string>

    Returns void

  • get zIndex(): number
  • Returns number

  • set zIndex(index): void
  • Parameters

    • index: number

    Returns void

Constructors

Methods

  • Protected

    Changes features which use the layers style or if the layers style is a declarative style so they are re-rendered

    Returns void

  • 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.

    Returns Promise<void>

  • 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.

    Parameters

    • features: Feature<Geometry>[]

    Returns (string | number)[]

    Todo

    mechanism to enforce XYZ coordinate layout for internal usage

  • destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes

    Returns Promise<void>

  • returns an feature if found, otherwise null feature geometries are always in EPSG 3857 mercator coordinate system

    Parameters

    • id: string | number

    Returns null | Feature<Geometry>

  • returns an array with features Feature geometries are always in EPSG 3857 mercator coordinate system

    Returns Feature<Geometry>[]

  • returns an array with features feature geometries are always in EPSG 3857 mercator coordinate system

    Parameters

    • ids: (string | number)[]

    Returns Feature<Geometry>[]

  • returns the openlayers vector source

    Returns VectorSource<Geometry>

  • Returns 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.

    Returns null | Extent

  • 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.

    Parameters

    Returns Promise<void>

    Link

  • removes features from the vector layer

    Parameters

    • ids: (string | number)[]

    Returns void

  • Sets the meta values based on a Object. Does not carry over the style

    Parameters

    Returns void

Properties

[moduleIdSymbol]?: string
_defaultStyle: StyleItem
_headers?: Record<string, string>
_initialStyle: undefined | StyleItemOptions
_onStyleChangeRemover: null | (() => void) = null

Type declaration

    • (): void
    • Returns void

_supportedMaps: string[] = ...

The class names of the supported maps.

_url: undefined | string | Record<string, string>
_visibility: boolean = true
activeOnStartup: boolean
balloonHeightOffset: number

a height offset for rendering of a balloon for a feature of this layer.

copyright: undefined | CopyrightOptions
datasourceId?: string

Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.

dontUseTerrainForOblique: boolean
exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>

event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument

extent: null | Extent
featureProvider: undefined | AbstractFeatureProvider

An optional feature provider to provider features based on click events.

featureVisibility: FeatureVisibility

FeatureVisibility tracks the highlighting and hiding of features on this layer

hasFeatureUUID: boolean = false

A flag to indicate, whether the features in the layer have a UUID, allowing certain interactions, e.g. hidding its features in plannings

highlightStyle: undefined | VectorStyleItem
isDestroyed: boolean
isDynamic: boolean

If true, the cesium synchronizers are destroyed on map change

mapNames: string[]
maxResolution: undefined | number
minResolution: undefined | number
name: string

unique Name

projection: Projection
properties: Record<string, unknown>
source: VectorSource<Geometry> = ...
splitDirectionChanged: VcsEvent<SplitDirection> = ...

raised if the split direction changes, is passed the split direction as its only argument

stateChanged: VcsEvent<LayerState>

Event raised, if the layers state changes. Is passed the LayerState as its only parameter

styleChanged: VcsEvent<StyleItem> = ...

An event, called when the style of the layer changes. Is passed the new style item as its value.

vectorProperties: VectorProperties
zIndexChanged: VcsEvent<number>

Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.

Generated using TypeDoc