@vcmap/ui 5.0.2 → 5.1.0-rc.2

package/src/featureInfo/featureInfo.js

@@ -33,13 +33,13 @@ import BalloonFeatureInfoView from './balloonFeatureInfoView.js';
 import { getDefaultPrimaryColor } from '../vuePlugins/vuetify.js';
 import { ToolboxType } from '../manager/toolbox/toolboxManager.js';
 
-/** @typedef {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Entity} FeatureType */
+/** @typedef {import("ol").Feature|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Entity} FeatureType */
 
 /**
  * @typedef {Object} FeatureInfoEvent
  * @property {FeatureType} feature
- * @property {import("ol/coordinate").Coordinate} [position] - potential position to place the balloon at
- * @property {import("ol/coordinate").Coordinate} [windowPosition] - potential window position to initially place the balloon at
+ * @property {import("ol/coordinate.js").Coordinate} [position] - potential position to place the balloon at
+ * @property {import("ol/coordinate.js").Coordinate} [windowPosition] - potential window position to initially place the balloon at
  */
 
 /**
@@ -53,7 +53,7 @@ function getLogger() {
  * @param {FeatureType} feature
  * @param {import("@vcmap/core").Layer} layer
  * @param {string} defaultFillColor
- * @returns {import("ol/style/Style").default|import("@vcmap/core").VectorStyleItem}
+ * @returns {import("ol/style/Style.js").default|import("@vcmap/core").VectorStyleItem}
  */
 export function getHighlightStyle(feature, layer, defaultFillColor) {
   if (layer && layer.highlightStyle) {
@@ -93,7 +93,7 @@ export function getHighlightStyle(feature, layer, defaultFillColor) {
 }
 
 /**
- * @param {VcsUiApp} app
+ * @param {import("../vcsUiApp.js").default} app
  * @returns {FeatureInfoSession}
  */
 export function createFeatureInfoSession(app) {
@@ -123,7 +123,7 @@ export function createFeatureInfoSession(app) {
 }
 
 /**
- * @param {VcsUiApp} app
+ * @param {import("../vcsUiApp.js").default} app
  * @returns {function():void}
  */
 function setupFeatureInfoTool(app) {
@@ -205,7 +205,7 @@ function setupFeatureInfoTool(app) {
  */
 
 /**
- * @type {ClassRegistry<AbstractFeatureInfoView>}
+ * @type {ClassRegistry<import("@vcmap/core").Ctor<typeof AbstractFeatureInfoView>>}
  */
 export const featureInfoClassRegistry = new ClassRegistry();
 
@@ -219,17 +219,16 @@ export const featureInfoViewSymbol = Symbol('featureInfoView');
  * @class FeatureInfo
  * @description Provides registration of featureInfoClasses and stores featureInfoView instances.
  * @extends {Collection<AbstractFeatureInfoView>}
- * @implements {import("@vcmap/core").OverrideCollectionInterface<AbstractFeatureInfoView>}
  */
 class FeatureInfo extends Collection {
   /**
-   * @param {VcsUiApp} app
+   * @param {import("@src/vcsUiApp.js").default} app
    */
   constructor(app) {
     super();
 
     /**
-     * @type {VcsUiApp}
+     * @type {import("@src/vcsUiApp.js").default}
      * @private
      */
     this._app = app;
@@ -311,7 +310,6 @@ class FeatureInfo extends Collection {
 
   /**
    * @type {VcsEvent<null|FeatureType>}
-   * @readonly
    */
   get featureChanged() {
     return this._featureChanged;
@@ -319,7 +317,6 @@ class FeatureInfo extends Collection {
 
   /**
    * @type {null|FeatureType}
-   * @readonly
    */
   get selectedFeature() {
     return this._selectedFeature;
@@ -327,7 +324,6 @@ class FeatureInfo extends Collection {
 
   /**
    * @type {null|string}
-   * @readonly
    */
   get selectedFeatureId() {
     return this._selectedFeatureId;
@@ -336,7 +332,6 @@ class FeatureInfo extends Collection {
   /**
    * The window id of the current features FeatureInfoView window
    * @type {string|null}
-   * @readonly
    */
   get windowId() {
     return this._windowId;
@@ -386,8 +381,8 @@ class FeatureInfo extends Collection {
    * collection.
    * If passing a feature create by a FeatureProvider, the feature will be highlighted on an internal scratch layer.
    * @param {FeatureType} feature
-   * @param {import("ol/coordinate").Coordinate=} [position] - optional clicked position. If not given feature's center point is used to place balloons
-   * @param {import("ol/coordinate").Coordinate=} [windowPosition] - optional clicked window position. If not given derived from position for balloons
+   * @param {import("ol/coordinate.js").Coordinate=} [position] - optional clicked position. If not given feature's center point is used to place balloons
+   * @param {import("ol/coordinate.js").Coordinate=} [windowPosition] - optional clicked window position. If not given derived from position for balloons
    * @param {AbstractFeatureInfoView=} featureInfoView
    * @returns {Promise<void>}
    */

package/src/featureInfo/featureInfoInteraction.d.ts

@@ -0,0 +1,21 @@
+export default FeatureInfoInteraction;
+/**
+ * @class
+ * @extends {import("@vcmap/core").AbstractInteraction}
+ */
+declare class FeatureInfoInteraction {
+    /**
+     * @param {import("./featureInfo.js").default} featureInfo
+     */
+    constructor(featureInfo: import("./featureInfo.js").default);
+    /**
+     * @type {import("./featureInfo.js").default}
+     * @private
+     */
+    private _featureInfo;
+    /**
+     * @param {import("@vcmap/core").InteractionEvent} event
+     * @returns {Promise<import("@vcmap/core").InteractionEvent>}
+     */
+    pipe(event: import("@vcmap/core").InteractionEvent): Promise<import("@vcmap/core").InteractionEvent>;
+}

package/src/featureInfo/featureInfoInteraction.js

@@ -10,12 +10,12 @@ import {
  */
 class FeatureInfoInteraction extends AbstractInteraction {
   /**
-   * @param {FeatureInfo} featureInfo
+   * @param {import("./featureInfo.js").default} featureInfo
    */
   constructor(featureInfo) {
     super(EventType.CLICK, ModificationKeyType.NONE);
     /**
-     * @type {FeatureInfo}
+     * @type {import("./featureInfo.js").default}
      * @private
      */
     this._featureInfo = featureInfo;

package/src/featureInfo/iframeFeatureInfoView.d.ts

@@ -0,0 +1,48 @@
+export default IframeFeatureInfoView;
+export type IframeFeatureInfoViewOptions = import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & {
+    src: string;
+    title?: string;
+};
+export type IframeFeatureInfoViewProps = any & {
+    src: string;
+    title?: string;
+};
+/**
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & { src: string, title?: string }} IframeFeatureInfoViewOptions
+ * @property {string} src - Specifies the address of the document to embed in the <iframe>. Variables wrapped in `${}` are replaced by their values, e.g. `${featureId}` or `${attributes.gml:name}`
+ * @property {string} [title] - optional title for the <iframe>
+ */
+/**
+ * @typedef {import("./abstractFeatureInfoView.js.js").FeatureInfoProps & { src: string, title?: string }} IframeFeatureInfoViewProps
+ */
+/**
+ * @class
+ * @description An iframe view.
+ * @extends {AbstractFeatureInfoView}
+ */
+declare class IframeFeatureInfoView extends AbstractFeatureInfoView {
+    /**
+     * @param {IframeFeatureInfoViewOptions} options
+     */
+    constructor(options: IframeFeatureInfoViewOptions);
+    /**
+     * @type {string}
+     */
+    src: string;
+    /**
+     * @type {string|undefined}
+     */
+    title: string | undefined;
+    /**
+     * Variables wrapped in `${}` within `src` are replaced by their values, e.g. `${featureId}` or `${attributes.gml:name}`
+     * @param {import("./featureInfo.js").FeatureInfoEvent} featureInfo
+     * @param {import("@vcmap/core").Layer} layer
+     * @returns {IframeFeatureInfoViewProps}
+     */
+    getProperties(featureInfo: import("./featureInfo.js").FeatureInfoEvent, layer: import("@vcmap/core").Layer): IframeFeatureInfoViewProps;
+    /**
+     * @returns {IframeFeatureInfoViewOptions}
+     */
+    toJSON(): IframeFeatureInfoViewOptions;
+}
+import AbstractFeatureInfoView from './abstractFeatureInfoView.js';

package/src/featureInfo/iframeFeatureInfoView.js

@@ -21,15 +21,13 @@ const IframeComponent = {
 };
 
 /**
- * @typedef {FeatureInfoViewOptions} IframeFeatureInfoViewOptions
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & { src: string, title?: string }} IframeFeatureInfoViewOptions
  * @property {string} src - Specifies the address of the document to embed in the <iframe>. Variables wrapped in `${}` are replaced by their values, e.g. `${featureId}` or `${attributes.gml:name}`
  * @property {string} [title] - optional title for the <iframe>
  */
 
 /**
- * @typedef {FeatureInfoProps} IframeFeatureInfoViewProps
- * @property {string} src
- * @property {string|undefined} title
+ * @typedef {import("./abstractFeatureInfoView.js.js").FeatureInfoProps & { src: string, title?: string }} IframeFeatureInfoViewProps
  */
 
 /**
@@ -63,7 +61,7 @@ class IframeFeatureInfoView extends AbstractFeatureInfoView {
 
   /**
    * Variables wrapped in `${}` within `src` are replaced by their values, e.g. `${featureId}` or `${attributes.gml:name}`
-   * @param {FeatureInfoEvent} featureInfo
+   * @param {import("./featureInfo.js").FeatureInfoEvent} featureInfo
    * @param {import("@vcmap/core").Layer} layer
    * @returns {IframeFeatureInfoViewProps}
    */

package/src/featureInfo/tableFeatureInfoView.d.ts

@@ -0,0 +1,75 @@
+export default TableFeatureInfoView;
+export type TableFeatureInfoViewOptions = import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & {
+    itemsPerPage?: number;
+    itemsPerPageArray?: number[];
+    showSearchbar?: boolean;
+    searchbarPlaceholder?: string;
+};
+export type TableFeatureInfoViewProps = import("./abstractFeatureInfoView.js").FeatureInfoProps & {
+    itemsPerPage?: number;
+    itemsPerPageArray?: number[];
+    showGroupBtn?: boolean;
+    showSearchbar?: boolean;
+    searchbarPlaceholder?: string;
+};
+/**
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & {
+ *   itemsPerPage?: number,
+ *   itemsPerPageArray?: number[],
+ *   showSearchbar?: boolean,
+ *   searchbarPlaceholder?: string
+ * }} TableFeatureInfoViewOptions
+ * @property {number} [itemsPerPage=10] - default has to be one of itemsPerPageArray
+ * @property {number[]} [itemsPerPageArray=[5, 10, 15]]
+ * @property {boolean} [showSearchbar]
+ * @property {string} [searchbarPlaceholder]
+ */
+/**
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoProps & {
+ *   itemsPerPage?: number,
+ *   itemsPerPageArray?: number[],
+ *   showGroupBtn?: boolean,
+ *   showSearchbar?: boolean,
+ *   searchbarPlaceholder?: string
+ * }} TableFeatureInfoViewProps
+ */
+/**
+ * @class
+ * @description A table view for feature attributes
+ * @extends {AbstractFeatureInfoView}
+ */
+declare class TableFeatureInfoView extends AbstractFeatureInfoView {
+    /** @returns {TableFeatureInfoViewOptions} */
+    static getDefaultOptions(): TableFeatureInfoViewOptions;
+    /**
+     * @param {TableFeatureInfoViewOptions} options
+     */
+    constructor(options: TableFeatureInfoViewOptions);
+    /**
+     * @type {number[]}
+     */
+    itemsPerPageArray: number[];
+    /**
+     * @type {number}
+     */
+    itemsPerPage: number;
+    /**
+     * @type {boolean}
+     */
+    showSearchbar: boolean;
+    /**
+     * @type {string}
+     */
+    searchbarPlaceholder: string;
+    /**
+     * @param {import("./featureInfo.js").FeatureInfoEvent} featureInfo
+     * @param {import("@vcmap/core").Layer} layer
+     * @returns {TableFeatureInfoViewProps}
+     */
+    getProperties(featureInfo: import("./featureInfo.js").FeatureInfoEvent, layer: import("@vcmap/core").Layer): TableFeatureInfoViewProps;
+    /**
+     * @returns {TableFeatureInfoViewOptions}
+     */
+    toJSON(): TableFeatureInfoViewOptions;
+}
+import AbstractFeatureInfoView from './abstractFeatureInfoView.js';

package/src/featureInfo/tableFeatureInfoView.js

@@ -1,8 +1,14 @@
+import { parseBoolean } from '@vcsuite/parsers';
 import AbstractFeatureInfoView from './abstractFeatureInfoView.js';
 import VcsTable from '../components/tables/VcsTable.vue';
 
 /**
- * @typedef {FeatureInfoViewOptions} TableFeatureInfoViewOptions
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoViewOptions & {
+ *   itemsPerPage?: number,
+ *   itemsPerPageArray?: number[],
+ *   showSearchbar?: boolean,
+ *   searchbarPlaceholder?: string
+ * }} TableFeatureInfoViewOptions
  * @property {number} [itemsPerPage=10] - default has to be one of itemsPerPageArray
  * @property {number[]} [itemsPerPageArray=[5, 10, 15]]
  * @property {boolean} [showSearchbar]
@@ -10,12 +16,13 @@ import VcsTable from '../components/tables/VcsTable.vue';
  */
 
 /**
- * @typedef {FeatureInfoProps} TableFeatureInfoViewProps
- * @property {number} [itemsPerPage=10]
- * @property {number[]} [itemsPerPageArray=[5, 10, 15]]
- * @property {boolean} [showGroupBtn]
- * @property {boolean} [showSearchbar]
- * @property {string} [searchbarPlaceholder]
+ * @typedef {import("./abstractFeatureInfoView.js").FeatureInfoProps & {
+ *   itemsPerPage?: number,
+ *   itemsPerPageArray?: number[],
+ *   showGroupBtn?: boolean,
+ *   showSearchbar?: boolean,
+ *   searchbarPlaceholder?: string
+ * }} TableFeatureInfoViewProps
  */
 
 /**
@@ -62,7 +69,10 @@ class TableFeatureInfoView extends AbstractFeatureInfoView {
     /**
      * @type {boolean}
      */
-    this.showSearchbar = options.showSearchbar || defaultOptions.showSearchbar;
+    this.showSearchbar = parseBoolean(
+      options.showSearchbar,
+      defaultOptions.showSearchbar,
+    );
     /**
      * @type {string}
      */
@@ -70,7 +80,7 @@ class TableFeatureInfoView extends AbstractFeatureInfoView {
   }
 
   /**
-   * @param {FeatureInfoEvent} featureInfo
+   * @param {import("./featureInfo.js").FeatureInfoEvent} featureInfo
    * @param {import("@vcmap/core").Layer} layer
    * @returns {TableFeatureInfoViewProps}
    */