@vcmap/core 5.0.0-rc.8 → 5.0.0

package/dist/src/layer/dataSourceLayer.js

@@ -0,0 +1,132 @@
+import { EntityCollection, } from '@vcmap-cesium/engine';
+import Layer from './layer.js';
+import CesiumMap from '../map/cesiumMap.js';
+import DataSourceCesiumImpl from './cesium/dataSourceCesiumImpl.js';
+import { vcsLayerName } from './layerSymbols.js';
+import FeatureVisibility, { FeatureVisibilityAction, } from './featureVisibility.js';
+import { layerClassRegistry } from '../classRegistry.js';
+/**
+ * Represents a layer of Cesium.Entity
+ * @group Layer
+ */
+class DataSourceLayer extends Layer {
+    static get className() {
+        return 'DataSourceLayer';
+    }
+    /**
+     * The entities of this layer. Use the `addEntity` API to add Enitities to ensure interoperability with vcm interfaces
+     */
+    entities = new EntityCollection();
+    clock = undefined;
+    /**
+     * The feature visibility of this layer. NOTE: Entities cannot be highlighted at this moment.
+     */
+    featureVisibility = new FeatureVisibility();
+    _supportedMaps = [CesiumMap.className];
+    _featureVisibilityListeners = [];
+    setGlobalHider(globalHider) {
+        super.setGlobalHider(globalHider);
+        this._setUpFeatureVisibility();
+    }
+    /**
+     * Sets up listeners for featureVisibility and global hider
+     */
+    _setUpFeatureVisibility() {
+        this._featureVisibilityListeners.forEach((cb) => {
+            cb();
+        });
+        this._featureVisibilityListeners = [
+            this.featureVisibility.changed.addEventListener(({ action, ids }) => {
+                if (action === FeatureVisibilityAction.HIDE) {
+                    ids.forEach((id) => {
+                        const entity = this.entities.getById(id);
+                        if (entity) {
+                            this.featureVisibility.addHiddenFeature(id, entity);
+                        }
+                    });
+                } // highlight is _possible_ but very tricky with all the possible entity values with potential materials
+            }),
+            this.entities.collectionChanged.addEventListener((_c, added) => {
+                added.forEach((entity) => {
+                    if (this.featureVisibility.hiddenObjects[entity.id]) {
+                        this.featureVisibility.addHiddenFeature(entity.id, entity);
+                    }
+                    if (this.globalHider && this.globalHider.hiddenObjects[entity.id]) {
+                        this.globalHider.addFeature(entity.id, entity);
+                    }
+                });
+            }),
+        ];
+        if (this.globalHider) {
+            this._featureVisibilityListeners.push(this.globalHider.changed.addEventListener(({ action, ids }) => {
+                if (action === FeatureVisibilityAction.HIDE) {
+                    ids.forEach((id) => {
+                        const entity = this.entities.getById(id);
+                        if (entity) {
+                            this.globalHider.addFeature(id, entity);
+                        }
+                    });
+                }
+            }));
+        }
+    }
+    initialize() {
+        if (!this.initialized) {
+            this._setUpFeatureVisibility();
+        }
+        return super.initialize();
+    }
+    getImplementationOptions() {
+        return {
+            ...super.getImplementationOptions(),
+            entities: this.entities,
+            clock: this.clock,
+        };
+    }
+    createImplementationsForMap(map) {
+        if (map instanceof CesiumMap) {
+            return [new DataSourceCesiumImpl(map, this.getImplementationOptions())];
+        }
+        return [];
+    }
+    /**
+     * adds an entity
+     * @param  options - Cesium Entity options or the entity
+     * @param  attributes - a set of properties, typically used for rendering a balloon
+     * @param  allowPicking - whether to override the layers allowPicking setting for this entity
+     * @returns  the entities id
+     */
+    addEntity(options, attributes, allowPicking) {
+        const entity = this.entities.add(options);
+        entity[vcsLayerName] = this.name;
+        entity.attributes = attributes;
+        entity.allowPicking = allowPicking;
+        return entity.id;
+    }
+    /**
+     * Zooms to an entity with the given id
+     */
+    flyToEntity(id) {
+        this.getImplementations().forEach((impl) => {
+            impl.flyToEntity(id);
+        });
+    }
+    /**
+     * Removes an entity from this layer by id
+     */
+    removeEntityById(id) {
+        this.entities.removeById(id);
+    }
+    destroy() {
+        this.entities.removeAll();
+        this._featureVisibilityListeners.forEach((cb) => {
+            cb();
+        });
+        this._featureVisibilityListeners = [];
+        this.featureVisibility.destroy();
+        super.destroy();
+    }
+}
+layerClassRegistry.registerClass(DataSourceLayer.className, DataSourceLayer);
+export default DataSourceLayer;
+//# sourceMappingURL=dataSourceLayer.js.map

package/dist/src/layer/dataSourceLayer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataSourceLayer.js","sourceRoot":"","sources":["../../../src/layer/dataSourceLayer.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAqC,MAAM,YAAY,CAAC;AAC/D,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,iBAAiB,EAAE,EACxB,uBAAuB,GACxB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAQzD;;;GAGG;AACH,MAAM,eAAgB,SAAQ,KAA2B;IACvD,MAAM,KAAK,SAAS;QAClB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,QAAQ,GAAqB,IAAI,gBAAgB,EAAE,CAAC;IAEpD,KAAK,GAAgC,SAAS,CAAC;IAE/C;;OAEG;IACH,iBAAiB,GAAsB,IAAI,iBAAiB,EAAE,CAAC;IAErD,cAAc,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAEzC,2BAA2B,GAAmB,EAAE,CAAC;IAEzD,cAAc,CAAC,WAAwB;QACrC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAClC,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,uBAAuB;QAC7B,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YAC9C,EAAE,EAAE,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,2BAA2B,GAAG;YACjC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE;gBAClE,IAAI,MAAM,KAAK,uBAAuB,CAAC,IAAI,EAAE;oBAC3C,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;wBACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAY,CAAC,CAAC;wBACnD,IAAI,MAAM,EAAE;4BACV,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;yBACrD;oBACH,CAAC,CAAC,CAAC;iBACJ,CAAC,uGAAuG;YAC3G,CAAC,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;gBAC7D,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACvB,IAAI,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;wBACnD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;qBAC5D;oBACD,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;wBACjE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;qBAChD;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC;SACH,CAAC;QAEF,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,2BAA2B,CAAC,IAAI,CACnC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE;gBAC5D,IAAI,MAAM,KAAK,uBAAuB,CAAC,IAAI,EAAE;oBAC3C,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;wBACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAY,CAAC,CAAC;wBACnD,IAAI,MAAM,EAAE;4BACV,IAAI,CAAC,WAAY,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;yBAC1C;oBACH,CAAC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CACH,CAAC;SACH;IACH,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,uBAAuB,EAAE,CAAC;SAChC;QACD,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,wBAAwB;QACtB,OAAO;YACL,GAAG,KAAK,CAAC,wBAAwB,EAAE;YACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IAED,2BAA2B,CAAC,GAAc;QACxC,IAAI,GAAG,YAAY,SAAS,EAAE;YAC5B,OAAO,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC;SACzE;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CACP,OAA2C,EAC3C,UAAoC,EACpC,YAAsB;QAEtB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACjC,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,OAAO,MAAM,CAAC,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,EAAU;QACpB,IAAI,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO;QACL,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YAC9C,EAAE,EAAE,CAAC;QACP,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,2BAA2B,GAAG,EAAE,CAAC;QACtC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;QACjC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AAC7E,eAAe,eAAe,CAAC"}

package/dist/src/layer/featureLayer.d.ts

@@ -0,0 +1,85 @@
+import Style, { type StyleFunction } from 'ol/style/Style.js';
+import { SplitDirection } from '@vcmap-cesium/engine';
+import Layer, { LayerImplementationOptions, LayerOptions, SplitLayer } from './layer.js';
+import StyleItem, { StyleItemOptions } from '../style/styleItem.js';
+import { type VectorStyleItemOptions } from '../style/vectorStyleItem.js';
+import FeatureVisibility from './featureVisibility.js';
+import VcsEvent from '../vcsEvent.js';
+import type GlobalHider from './globalHider.js';
+import type LayerImplementation from './layerImplementation.js';
+import type VcsMap from '../map/vcsMap.js';
+import type { DeclarativeStyleItemOptions } from '../style/declarativeStyleItem.js';
+export type FeatureLayerOptions = LayerOptions & {
+    style?: VectorStyleItemOptions | DeclarativeStyleItemOptions | StyleItem;
+    balloonHeightOffset?: number;
+    splitDirection?: string;
+    featureVisibility?: FeatureVisibility;
+};
+export type FeatureLayerImplementationOptions = LayerImplementationOptions & {
+    globalHider?: GlobalHider;
+    splitDirection: SplitDirection;
+    featureVisibility: FeatureVisibility;
+    style: StyleItem;
+};
+export interface FeatureLayerImplementation {
+    updateStyle(style: StyleItem, silent?: boolean): void;
+    updateSplitDirection(direction: SplitDirection): void;
+}
+/**
+ * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
+ * @group Layer
+ */
+declare class FeatureLayer<T extends LayerImplementation<VcsMap> & FeatureLayerImplementation> extends Layer<T> implements SplitLayer {
+    static get className(): string;
+    static getDefaultOptions(): FeatureLayerOptions;
+    private _style;
+    protected _defaultStyle: StyleItem;
+    /**
+     * An event, called when the style of the layer changes. Is passed the new style item as its value.
+     */
+    readonly styleChanged: VcsEvent<StyleItem>;
+    /**
+     * a height offset for rendering of a balloon for a feature of this layer.
+     */
+    balloonHeightOffset: number;
+    private _splitDirection;
+    /**
+     * raised if the split direction changes, is passed the split direction as its only argument
+     */
+    readonly splitDirectionChanged: VcsEvent<SplitDirection>;
+    /**
+     * FeatureVisibility tracks the highlighting and hiding of features on this layer
+     */
+    featureVisibility: FeatureVisibility;
+    /**
+     * @param  options
+     */
+    constructor(options: FeatureLayerOptions);
+    /**
+     * The style the layer had at construction
+     */
+    get defaultStyle(): StyleItem;
+    /**
+     * style, use setStyle to change
+     */
+    get style(): StyleItem;
+    /**
+     * The splitDirection to be applied - for 3D vector features currently only working on points with a Model
+     */
+    get splitDirection(): SplitDirection;
+    set splitDirection(direction: SplitDirection);
+    getImplementationOptions(): FeatureLayerImplementationOptions;
+    setGlobalHider(globalHider: GlobalHider): void;
+    getStyleOrDefaultStyle(styleOptions?: StyleItemOptions | StyleItem, defaultStyle?: StyleItem): StyleItem;
+    /**
+     * Sets the style based on a styleName on a layer
+     */
+    setStyle(style: Style | StyleFunction | StyleItem, silent?: boolean): void;
+    /**
+     * Clears the style of this layer
+     */
+    clearStyle(): void;
+    toJSON(): FeatureLayerOptions;
+    destroy(): void;
+}
+export default FeatureLayer;

package/dist/src/layer/featureLayer.js

@@ -0,0 +1,155 @@
+import Style from 'ol/style/Style.js';
+import { check } from '@vcsuite/check';
+import { parseInteger } from '@vcsuite/parsers';
+import { SplitDirection } from '@vcmap-cesium/engine';
+import Layer from './layer.js';
+import StyleItem from '../style/styleItem.js';
+import VectorStyleItem from '../style/vectorStyleItem.js';
+import FeatureVisibility from './featureVisibility.js';
+import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
+import VcsEvent from '../vcsEvent.js';
+import { layerClassRegistry } from '../classRegistry.js';
+/**
+ * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
+ * @group Layer
+ */
+class FeatureLayer extends Layer {
+    static get className() {
+        return 'FeatureLayer';
+    }
+    static getDefaultOptions() {
+        return {
+            ...Layer.getDefaultOptions(),
+            style: undefined,
+            balloonHeightOffset: 10,
+            splitDirection: undefined,
+        };
+    }
+    _style;
+    _defaultStyle;
+    /**
+     * An event, called when the style of the layer changes. Is passed the new style item as its value.
+     */
+    styleChanged = new VcsEvent();
+    /**
+     * a height offset for rendering of a balloon for a feature of this layer.
+     */
+    balloonHeightOffset;
+    _splitDirection = SplitDirection.NONE;
+    /**
+     * raised if the split direction changes, is passed the split direction as its only argument
+     */
+    splitDirectionChanged = new VcsEvent();
+    /**
+     * FeatureVisibility tracks the highlighting and hiding of features on this layer
+     */
+    featureVisibility;
+    /**
+     * @param  options
+     */
+    constructor(options) {
+        super(options);
+        const defaultOptions = FeatureLayer.getDefaultOptions();
+        this._style = this.getStyleOrDefaultStyle(options.style);
+        this._defaultStyle = this._style;
+        this.balloonHeightOffset = parseInteger(options.balloonHeightOffset, defaultOptions.balloonHeightOffset);
+        if (options.splitDirection) {
+            this._splitDirection =
+                options.splitDirection === 'left'
+                    ? SplitDirection.LEFT
+                    : SplitDirection.RIGHT;
+        }
+        this.featureVisibility =
+            options.featureVisibility || new FeatureVisibility();
+    }
+    /**
+     * The style the layer had at construction
+     */
+    get defaultStyle() {
+        return this._defaultStyle;
+    }
+    /**
+     * style, use setStyle to change
+     */
+    get style() {
+        return this._style;
+    }
+    /**
+     * The splitDirection to be applied - for 3D vector features currently only working on points with a Model
+     */
+    get splitDirection() {
+        return this._splitDirection;
+    }
+    set splitDirection(direction) {
+        if (direction !== this._splitDirection) {
+            this.getImplementations().forEach((impl) => {
+                impl.updateSplitDirection(direction);
+            });
+            this._splitDirection = direction;
+            this.splitDirectionChanged.raiseEvent(this._splitDirection);
+        }
+    }
+    getImplementationOptions() {
+        return {
+            ...super.getImplementationOptions(),
+            globalHider: this.globalHider,
+            featureVisibility: this.featureVisibility,
+            style: this.style,
+            splitDirection: this.splitDirection,
+        };
+    }
+    setGlobalHider(globalHider) {
+        super.setGlobalHider(globalHider);
+        // eslint-disable-next-line no-void
+        void this.forceRedraw();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getStyleOrDefaultStyle(styleOptions, defaultStyle) {
+        return getStyleOrDefaultStyle(styleOptions, defaultStyle);
+    }
+    /**
+     * Sets the style based on a styleName on a layer
+     */
+    setStyle(style, silent) {
+        check(style, [Style, StyleItem, Function]);
+        if (style instanceof StyleItem) {
+            this._style = style;
+        }
+        else {
+            this._style = new VectorStyleItem({});
+            this._style.style = style;
+        }
+        this.getImplementations().forEach((impl) => {
+            impl.updateStyle(this._style, silent);
+        });
+        this.styleChanged.raiseEvent(this._style);
+    }
+    /**
+     * Clears the style of this layer
+     */
+    clearStyle() {
+        this.setStyle(this.defaultStyle);
+    }
+    toJSON() {
+        const config = super.toJSON();
+        if (!this.getStyleOrDefaultStyle().equals(this._style)) {
+            config.style = this.style.toJSON();
+        }
+        if (this._splitDirection !== SplitDirection.NONE) {
+            config.splitDirection =
+                this._splitDirection === SplitDirection.RIGHT ? 'right' : 'left';
+        }
+        return config;
+    }
+    destroy() {
+        if (this.featureVisibility) {
+            this.featureVisibility.destroy();
+        }
+        this.styleChanged.destroy();
+        this.splitDirectionChanged.destroy();
+        super.destroy();
+    }
+}
+layerClassRegistry.registerClass(FeatureLayer.className, FeatureLayer);
+export default FeatureLayer;
+//# sourceMappingURL=featureLayer.js.map

package/dist/src/layer/featureLayer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureLayer.js","sourceRoot":"","sources":["../../../src/layer/featureLayer.ts"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAIN,MAAM,YAAY,CAAC;AACpB,OAAO,SAA+B,MAAM,uBAAuB,CAAC;AACpE,OAAO,eAEN,MAAM,6BAA6B,CAAC;AACrC,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAyBzD;;;GAGG;AACH,MAAM,YAGJ,SAAQ,KAAQ;IAGhB,MAAM,KAAK,SAAS;QAClB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO;YACL,GAAG,KAAK,CAAC,iBAAiB,EAAE;YAC5B,KAAK,EAAE,SAAS;YAChB,mBAAmB,EAAE,EAAE;YACvB,cAAc,EAAE,SAAS;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAY;IAEhB,aAAa,CAAY;IAEnC;;OAEG;IACM,YAAY,GAAwB,IAAI,QAAQ,EAAE,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAS;IAEpB,eAAe,GAAmB,cAAc,CAAC,IAAI,CAAC;IAE9D;;OAEG;IACM,qBAAqB,GAA6B,IAAI,QAAQ,EAAE,CAAC;IAE1E;;OAEG;IACH,iBAAiB,CAAoB;IAErC;;OAEG;IACH,YAAY,OAA4B;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,cAAc,GAAG,YAAY,CAAC,iBAAiB,EAAE,CAAC;QAExD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC;QAEjC,IAAI,CAAC,mBAAmB,GAAG,YAAY,CACrC,OAAO,CAAC,mBAAmB,EAC3B,cAAc,CAAC,mBAAmB,CACnC,CAAC;QAEF,IAAI,OAAO,CAAC,cAAc,EAAE;YAC1B,IAAI,CAAC,eAAe;gBAClB,OAAO,CAAC,cAAc,KAAK,MAAM;oBAC/B,CAAC,CAAC,cAAc,CAAC,IAAI;oBACrB,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC;SAC5B;QAED,IAAI,CAAC,iBAAiB;YACpB,OAAO,CAAC,iBAAiB,IAAI,IAAI,iBAAiB,EAAE,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAI,cAAc,CAAC,SAAyB;QAC1C,IAAI,SAAS,KAAK,IAAI,CAAC,eAAe,EAAE;YACtC,IAAI,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAEvC,IACD,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YACjC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SAC7D;IACH,CAAC;IAED,wBAAwB;QACtB,OAAO;YACL,GAAG,KAAK,CAAC,wBAAwB,EAAE;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC;IACJ,CAAC;IAED,cAAc,CAAC,WAAwB;QACrC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAClC,mCAAmC;QACnC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;IAC1B,CAAC;IAED,kDAAkD;IAClD,sBAAsB,CACpB,YAA2C,EAC3C,YAAwB;QAExB,OAAO,sBAAsB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAwC,EAAE,MAAgB;QACjE,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE3C,IAAI,KAAK,YAAY,SAAS,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;SACrB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;SAC3B;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAEvC,IACD,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAwB,KAAK,CAAC,MAAM,EAAE,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACtD,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,IAAI,EAAE;YAChD,MAAM,CAAC,cAAc;gBACnB,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;SACpE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;SAClC;QACD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;QACrC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AACvE,eAAe,YAAY,CAAC"}

package/dist/src/layer/featureStoreLayer.d.ts

@@ -0,0 +1,123 @@
+import Feature from 'ol/Feature.js';
+import type { Feature as GeojsonFeature } from 'geojson';
+import Style, { StyleFunction } from 'ol/style/Style.js';
+import VectorLayer, { VectorOptions } from './vectorLayer.js';
+import FeatureStoreLayerChanges from './featureStoreLayerChanges.js';
+import CesiumTilesetCesiumImpl from './cesium/cesiumTilesetCesiumImpl.js';
+import { VcsMeta } from './vectorProperties.js';
+import VectorOpenlayersImpl from './openlayers/vectorOpenlayersImpl.js';
+import VectorObliqueImpl from './oblique/vectorObliqueImpl.js';
+import Extent from '../util/extent.js';
+import StyleItem from '../style/styleItem.js';
+import VcsMap from '../map/vcsMap.js';
+import VectorCesiumImpl from './cesium/vectorCesiumImpl.js';
+export type FeatureStoreStaticRepresentation = {
+    /**
+     * 3D static representation of this layer
+     */
+    threeDim?: string;
+    /**
+     * 2D static representation of this layer
+     */
+    twoDim?: string;
+};
+export type FeatureStoreLayerSchema = VectorOptions & {
+    /**
+     * layer mongo id
+     */
+    id: string;
+    type: string;
+    featureType: string;
+    /**
+     * URLs to static representations for 2D and 3D maps
+     */
+    staticRepresentation?: FeatureStoreStaticRepresentation;
+    /**
+     * an array of IDs of features to hide from the static representation
+     */
+    hiddenStaticFeatureIds: (string | number)[];
+    /**
+     * the array of features to represent dynamic features
+     */
+    features: GeojsonFeature[];
+    /**
+     * vector style implemented by the map and base64-encoded png icons used for custom styles
+     */
+    vcsMeta: VcsMeta;
+};
+export type FetchDynamicFeatureCallback = (id: string | number) => Promise<string | GeojsonFeature>;
+export type FeatureStoreOptions = FeatureStoreLayerSchema & {
+    /**
+     * injected function for fetching dynamic features from a remote FeatureStoreLayer server
+     */
+    injectedFetchDynamicFeatureFunc?: FetchDynamicFeatureCallback;
+};
+export declare const isTiledFeature: unique symbol;
+/**
+ * FeatureStoreLayer Layer
+ * @group Layer
+ * @experimental
+ */
+declare class FeatureStoreLayer extends VectorLayer {
+    static get className(): string;
+    static getDefaultOptions(): FeatureStoreOptions;
+    /**
+     * Feature Store layers have feature UUIDs by design
+     */
+    hasFeatureUUID: boolean;
+    layerId: string;
+    staticRepresentation: FeatureStoreStaticRepresentation;
+    hiddenStaticFeatureIds: Set<string | number>;
+    changeTracker: FeatureStoreLayerChanges;
+    vcsMeta: VcsMeta;
+    screenSpaceErrorMobile: number | undefined;
+    screenSpaceError: number | undefined;
+    private _removeVectorPropertiesChangeHandler;
+    /**
+     * Synchronize featureVisibilities, while maintaining static features hidden.
+     */
+    private _featureVisibilitySyncListeners;
+    /**
+     * a function to retrieve a single feature from the server
+     */
+    injectedFetchDynamicFeatureFunc: FetchDynamicFeatureCallback;
+    private _staticFeatureVisibility;
+    private _setEditing;
+    private _twoDimLoaded;
+    private _twoDimStyleChanged;
+    private _twoDimStaticSource;
+    constructor(options: FeatureStoreOptions);
+    initialize(): Promise<void>;
+    private _loadTwoDim;
+    private _getTwoDimStaticImplOptions;
+    createImplementationsForMap(map: VcsMap): (VectorObliqueImpl | VectorOpenlayersImpl | VectorCesiumImpl | CesiumTilesetCesiumImpl)[];
+    reload(): Promise<void>;
+    activate(): Promise<void>;
+    protected _trackStyleChanges(): void;
+    setStyle(style: Style | StyleFunction | StyleItem, silent?: boolean): void;
+    setEditing(symbol: symbol, featureType?: number): void;
+    getZoomToExtent(): Extent | null;
+    /**
+     * set the maximum screen space error of this layer
+     */
+    setMaximumScreenSpaceError(value: number): void;
+    /**
+     * 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
+     * @param  [featureId] input static feature ID
+     */
+    switchStaticFeatureToDynamic(featureId: string | number): Promise<Feature | null>;
+    /**
+     * removes a static feature from featureStore layer
+     * @param  featureId
+     */
+    removeStaticFeature(featureId: string): void;
+    /**
+     * Resets a feature which used to be static but is now dynamic. called from featureStoreChanges API.
+     * @param  featureId
+     */
+    resetStaticFeature(featureId: string | number): void;
+    toJSON(): FeatureStoreOptions;
+    destroy(): void;
+}
+export default FeatureStoreLayer;