@vcmap/core
    Preparing search index...

    Class FeatureStoreLayerExperimental

    FeatureStoreLayer Layer

    Hierarchy (View Summary)

    Index

    Accessors

    • get active(): boolean
      Experimental

      Returns boolean

    • get allowPicking(): boolean
      Experimental

      Returns boolean

    • set allowPicking(allowPicking: boolean): 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: (string | symbol)[]): void
      Experimental

      Parameters

      • groups: (string | symbol)[]

      Returns void

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

      directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.

      Returns Record<string, string> | undefined

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

      Parameters

      • headers: Record<string, string> | undefined

      Returns void

    • get hiddenObjectIds(): string[]
      Experimental

      Returns string[]

    • set hiddenObjectIds(hiddenObjectIds: string[]): void
      Experimental

      Parameters

      • hiddenObjectIds: string[]

      Returns void

    • get ignoreMapLayerTypes(): boolean
      Experimental

      Returns boolean

    • set ignoreMapLayerTypes(value: boolean): void
      Experimental

      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.

      Parameters

      • value: boolean

      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: string): void
      Experimental

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

      Parameters

      • value: string

      Returns void

    • get mapNames(): string[]
      Experimental

      Returns string[]

    • set mapNames(mapNames: string[]): void
      Experimental

      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.

      Parameters

      • mapNames: 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: SplitDirection): 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: string | Record<string, string>): void
      Experimental

      Parameters

      • url: string | Record<string, string>

      Returns void

    • get vectorClusterGroup(): string | undefined
      Experimental

      Returns string | undefined

    • set vectorClusterGroup(newGroup: string | undefined): void
      Experimental

      Parameters

      • newGroup: string | undefined

      Returns void

    • get visibility(): boolean
      Experimental

      Returns boolean

    • set visibility(visible: boolean): void
      Experimental

      Parameters

      • visible: boolean

      Returns void

    • get zIndex(): number
      Experimental

      Returns number

    • set zIndex(index: number): 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, { [x: string]: any }>[]

      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 Feature<Geometry, { [x: string]: any }> | null

    • Experimental

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

      Returns Feature<Geometry, { [x: string]: any }>[]

    • Experimental

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

      Parameters

      • ids: (string | number)[]

      Returns Feature<Geometry, { [x: string]: any }>[]

    • 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

      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

      Parameters

      Returns 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

      Parameters

      • symbol: symbol
      • OptionalfeatureType: 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<Feature<Geometry, { [x: string]: any }> | null>

    Properties

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

    The class names of the supported maps.

    _url: string | Record<string, string> | undefined
    "[moduleIdSymbol]"?: string
    activeOnStartup: boolean
    copyright: CopyrightOptions | undefined
    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: Extent | null
    featureProvider: AbstractFeatureProvider | AbstractAttributeProvider | undefined

    An optional feature or attribute provider to provide or augment features 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: VectorStyleItem | undefined
    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
    mapNamesChanged: VcsEvent<string[]> = ...
    maxResolution: number | undefined
    minResolution: number | undefined
    name: string

    unique Name

    projection: Projection
    properties: Record<string, unknown>
    screenSpaceError: number | undefined
    screenSpaceErrorMobile: number | undefined
    source: VectorSource = ...
    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
    vectorClusterGroupChanged: VcsEvent<{ newGroup?: string; oldGroup?: string }> = ...
    vectorProperties: VectorProperties
    zIndexChanged: VcsEvent<number>

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