Class FeatureStoreLayerExperimental

FeatureStoreLayer Layer

Hierarchy (view full)

Accessors

  • get active(): boolean
  • Experimental

    Returns boolean

  • get allowPicking(): boolean
  • Experimental

    Returns boolean

  • set allowPicking(allowPicking): void
  • Experimental

    Parameters

    • allowPicking: boolean

    Returns void

  • get className(): string
  • Experimental

    Returns string

  • get exclusive(): boolean
  • Experimental

    Indicates, that this layer is part of an exclusiveGroup

    Returns boolean

  • get exclusiveGroups(): (string | symbol)[]
  • Experimental

    An array of arbitrary exclusive groups

    Returns (string | symbol)[]

  • set exclusiveGroups(groups): void
  • Experimental

    Parameters

    • groups: (string | symbol)[]

    Returns void

  • get headers(): undefined | Record<string, string>
  • Experimental

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

    Parameters

    • headers: undefined | Record<string, string>

    Returns void

  • get hiddenObjectIds(): string[]
  • Experimental

    Returns string[]

  • set hiddenObjectIds(hiddenObjectIds): void
  • Experimental

    Parameters

    • hiddenObjectIds: string[]

    Returns void

  • get initialized(): boolean
  • Experimental

    True if this layer has been initialized, typically after its first activation.

    Returns boolean

  • get loading(): boolean
  • Experimental

    Returns boolean

  • get locale(): string
  • Experimental

    returns the currently set locale. Can be used to provide locale specific URLs.

    Returns string

  • set locale(value): void
  • Experimental

    sets the locale and reloads the layer the if the URL is a locale aware Object.

    Parameters

    • value: string

    Returns void

  • get splitDirection(): SplitDirection
  • Experimental

    The splitDirection to be applied - for 3D vector features currently only working on points with a Model

    Returns SplitDirection

  • set splitDirection(direction): void
  • Experimental

    Parameters

    • direction: SplitDirection

    Returns void

  • get url(): string
  • Experimental

    A layers url, should on be configured, else an empty string

    Returns string

  • set url(url): void
  • Experimental

    Parameters

    • url: string | Record<string, string>

    Returns void

  • get visibility(): boolean
  • Experimental

    Returns boolean

  • set visibility(visible): void
  • Experimental

    Parameters

    • visible: boolean

    Returns void

  • get zIndex(): number
  • Experimental

    Returns number

  • set zIndex(index): void
  • Experimental

    Parameters

    • index: number

    Returns void

Constructors

Methods

  • Experimental

    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>

  • Experimental

    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)[]

    mechanism to enforce XYZ coordinate layout for internal usage

  • Experimental

    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>

  • Experimental

    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>

  • Experimental

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

    Returns Feature<Geometry>[]

  • Experimental

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

    Parameters

    • ids: (string | number)[]

    Returns Feature<Geometry>[]

  • Experimental

    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>

  • Experimental

    removes a static feature from featureStore layer

    Parameters

    • featureId: string

    Returns void

  • Experimental

    Resets a feature which used to be static but is now dynamic. called from featureStoreChanges API.

    Parameters

    • featureId: string | number

    Returns void

  • Experimental

    set the maximum screen space error of this layer

    Parameters

    • value: number

    Returns void

  • Experimental

    switch an array of static features to dynamic features This is done by hiding the static features and adding their dynamic counterparts to the FeatureStoreLayer layer

    Parameters

    • OptionalfeatureId: string | number

      input static feature ID

    Returns Promise<null | Feature<Geometry>>

Properties

_defaultStyle: StyleItem
_headers?: Record<string, string>
_supportedMaps: string[] = ...

The class names of the supported maps.

_url: undefined | string | Record<string, string>
[moduleIdSymbol]?: string
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: FeatureStoreFeatureVisibility

FeatureVisibility tracks the highlighting and hiding of features on this layer

hasFeatureUUID: boolean = true

Feature Store layers have feature UUIDs by design

hiddenStaticFeatureIds: Set<string | number>
highlightStyle: undefined | VectorStyleItem
injectedFetchDynamicFeatureFunc: FetchDynamicFeatureCallback = ...

a function to retrieve a single feature from the server

isDestroyed: boolean
isDynamic: boolean

If true, the cesium synchronizers are destroyed on map change

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

unique Name

projection: Projection
properties: Record<string, unknown>
screenSpaceError: undefined | number
screenSpaceErrorMobile: undefined | number
source: VectorSource<Feature<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

staticRepresentation: FeatureStoreStaticRepresentation
styleChanged: VcsEvent<StyleItem> = ...

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

vcsMeta: VcsMeta
vectorProperties: VectorProperties
zIndexChanged: VcsEvent<number>

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