@vcmap/ui 5.0.2 → 5.1.0-rc.1

package/src/navigation/MapNavCompass.vue.d.ts

@@ -0,0 +1,25 @@
+declare const _default: import("vue").DefineComponent<{
+    canEmit: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    hideTicks: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {}, {}, {}, {
+    emit(event: any, dir: any): void;
+}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    canEmit: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    hideTicks: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    canEmit: boolean;
+    hideTicks: boolean;
+}>;
+export default _default;

package/src/navigation/MapNavigation.vue

@@ -53,7 +53,7 @@
 
   /**
    * @description Creates a go-to viewpoint action from a startingViewpointName defined in a module. If no startingViewpointName is defined, uses default map view as fallback.
-   * @param {VcsUiApp} app
+   * @param {import("@src/vcsUiApp.js").default} app
    * @returns {{ action: import("vue").Reactive<VcsAction>, destroy: function():void }}
    */
   function setupHomeButton(app) {
@@ -145,7 +145,7 @@
       VRow,
     },
     setup() {
-      /** @type {VcsUiApp} */
+      /** @type {import("@src/vcsUiApp.js").default} */
       const app = inject('vcsApp');
       const viewMode = ref(OrientationToolsViewMode.TWO_D);
       const headingRef = ref(0);

package/src/navigation/MapNavigation.vue.d.ts

@@ -0,0 +1,46 @@
+declare const _default: import("vue").DefineComponent<{}, {
+    viewMode: import("vue").Ref<string>;
+    heading: import("vue").WritableComputedRef<number>;
+    tilt: import("vue").WritableComputedRef<number>;
+    is3D: import("vue").ComputedRef<boolean>;
+    isOblique: import("vue").ComputedRef<boolean>;
+    zoomIn(): void;
+    zoomOut(): void;
+    overviewAction: {
+        /**
+         * - reactive and translatable name rendered in overflow
+         */
+        name: string;
+        /**
+         * - reactive and translatable title rendered as tooltip
+         */
+        title?: string | undefined;
+        /**
+         * - icon rendered on the button. If no icon provided, item is rendered in overflow
+         */
+        icon?: string | undefined;
+        /**
+         * - callback function is triggered when the button is clicked
+         */
+        callback: import("../actions/actionHelper.js").ActionCallback;
+        /**
+         * - optional state of button. If active, button is rendered in primary color
+         */
+        active?: boolean | undefined;
+        /**
+         * - optional hasUpdate of button. If true, a yellow notification is rendered next to the button
+         */
+        hasUpdate?: boolean | undefined;
+        /**
+         * - optional background state. If active and background, button is rendered in primary color outlined
+         */
+        background?: boolean | undefined;
+        /**
+         * - optional flag to indicate that the action is disabled
+         */
+        disabled?: boolean | undefined;
+    };
+    showOverviewButton: import("vue").Ref<boolean>;
+    homeAction: any;
+}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/src/navigation/ObliqueRotation.vue

@@ -56,12 +56,16 @@
     ::v-deep {
       .btn-orientation-tools {
         &:first-child {
-          box-shadow: rgba(0, 0, 0, 0.25) 2px 2px 1px -2px,
-            rgba(0, 0, 0, 0.02) -3px 2px 2px 0, rgba(0, 0, 0, 0.12) 0 1px 1px 0 !important;
+          box-shadow:
+            rgba(0, 0, 0, 0.25) 2px 2px 1px -2px,
+            rgba(0, 0, 0, 0.02) -3px 2px 2px 0,
+            rgba(0, 0, 0, 0.12) 0 1px 1px 0 !important;
         }
         &:last-child {
-          box-shadow: rgba(0, 0, 0, 0.02) 1px 4px 1px -2px,
-            rgba(0, 0, 0, 0.02) 1px 2px 1px 0, rgba(0, 0, 0, 0.1) 1px 1px 1px 0 !important;
+          box-shadow:
+            rgba(0, 0, 0, 0.02) 1px 4px 1px -2px,
+            rgba(0, 0, 0, 0.02) 1px 2px 1px 0,
+            rgba(0, 0, 0, 0.1) 1px 1px 1px 0 !important;
         }
       }
     }

package/src/navigation/ObliqueRotation.vue.d.ts

@@ -0,0 +1,14 @@
+declare const _default: import("vue").DefineComponent<{
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+}, {}, {}, {}, {
+    input(rotation: any): void;
+}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

package/src/navigation/OrientationToolsButton.vue.d.ts

@@ -0,0 +1,30 @@
+declare const _default: import("vue").DefineComponent<{
+    icon: {
+        type: StringConstructor;
+        required: true;
+    };
+    tooltip: {
+        type: StringConstructor;
+        required: true;
+    };
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    icon: {
+        type: StringConstructor;
+        required: true;
+    };
+    tooltip: {
+        type: StringConstructor;
+        required: true;
+    };
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    tooltipPosition: string;
+}>;
+export default _default;

package/src/navigation/TiltSlider.vue.d.ts

@@ -0,0 +1,19 @@
+declare const _default: import("vue").DefineComponent<{
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+}, {}, {
+    localValue: number;
+}, {
+    tilt: {
+        get(): number;
+        set(value: any): void;
+    };
+}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

package/src/navigation/VcsCompass.vue.d.ts

@@ -0,0 +1,25 @@
+declare const _default: import("vue").DefineComponent<{
+    viewMode: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, {
+    rotationValue: any;
+    compassRotation: import("vue").ComputedRef<number>;
+}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    viewMode: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>>, {
+    value: number;
+}>;
+export default _default;

package/src/navigation/VcsZoomButton.vue

@@ -38,11 +38,14 @@
     ::v-deep {
       .btn-orientation-tools {
         &:first-child {
-          box-shadow: rgba(0, 0, 0, 0.25) -2px 2px 1px -2px,
-            rgba(0, 0, 0, 0.08) 1px 0 0 0, rgba(0, 0, 0, 0.05) -1px 1px 1px 1px !important;
+          box-shadow:
+            rgba(0, 0, 0, 0.25) -2px 2px 1px -2px,
+            rgba(0, 0, 0, 0.08) 1px 0 0 0,
+            rgba(0, 0, 0, 0.05) -1px 1px 1px 1px !important;
         }
         &:last-child {
-          box-shadow: rgba(0, 0, 0, 0.25) -2px 3px 1px -2px,
+          box-shadow:
+            rgba(0, 0, 0, 0.25) -2px 3px 1px -2px,
             rgba(0, 0, 0, 0.08) 1px 4px 2px 0,
             rgba(0, 0, 0, 0.05) -1px 1px 1px 1px !important;
         }

package/src/navigation/VcsZoomButton.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, any, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/src/navigation/overviewMap.d.ts

@@ -0,0 +1,199 @@
+/**
+ * @returns {import("../manager/window/windowManager.js").WindowComponentOptions}
+ */
+export function getWindowComponentOptions(): import("../manager/window/windowManager.js").WindowComponentOptions;
+export const overviewMapLayerSymbol: unique symbol;
+export default OverviewMap;
+/**
+ * A 2D OverviewMap for cesium, openlayers and oblique map.
+ * Baselayers are added to the OverviewMap using `showInOverviewMap` flag within the properties bag of a layer configuration.
+ * @class
+ */
+declare class OverviewMap {
+    /**
+     * @param {import("@src/vcsUiApp.js").default} app
+     */
+    constructor(app: import("@src/vcsUiApp.js").default);
+    /**
+     * @type {import("@src/vcsUiApp.js").default}
+     * @private
+     */
+    private _app;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private _active;
+    /**
+     * @type {import("@vcmap/core").OpenlayersMap||null}
+     * @private
+     */
+    private _map;
+    /**
+     * @private
+     * @type {import("@vcmap/core").Viewpoint|null}
+     */
+    private _cachedViewpoint;
+    /**
+     * @type {import("@vcmap/core").VectorLayer}
+     * @private
+     */
+    private _obliqueTileLayer;
+    /**
+     * @type {import("@vcmap/core").VectorLayer}
+     * @private
+     */
+    private _obliqueImageLayer;
+    /**
+     * @type {import("@vcmap/core").VectorLayer}
+     * @private
+     */
+    private _obliqueSelectedImageLayer;
+    /**
+     * @type {VectorStyleItem}
+     */
+    obliqueSelectedStyle: VectorStyleItem;
+    /**
+     * A factor by witch to multiply the resolution when zooming to a single oblique image.
+     * @type {number}
+     * @private
+     */
+    private _obliqueResolutionFactor;
+    /**
+     * @type {import("@vcmap/core").ObliqueViewDirection}
+     * @private
+     */
+    private _obliqueViewDirection;
+    /**
+     * @type {import("@vcmap/core").VectorLayer}
+     * @private
+     */
+    private _cameraIconLayer;
+    /**
+     * The style of the camera icon in 2D and 3D
+     * @type {import("@vcmap/core").VectorStyleItem}
+     */
+    cameraIconStyle: import("@vcmap/core").VectorStyleItem;
+    /**
+     * The minimum height to give to the overview map when synchronizing the view in 2D and 3D
+     * @type {number}
+     */
+    minimumHeight: number;
+    /**
+     * Handles the events from the overview map. Available after first activation.
+     * @type {EventHandler|null}
+     * @private
+     */
+    private _eventHandler;
+    /**
+     * An event, available after first activation, which is triggered whenever the overview map is clicked.
+     * Is passed a {@link InteractionEvent} as its only argument
+     * @type {import("@vcmap/core").VcsEvent<import("@vcmap/core").InteractionEvent>|null}
+     * @private
+     */
+    private _mapClicked;
+    /**
+     * @type {Function}
+     */
+    _mapPointerListener: Function;
+    /**
+     * @type {Array<function():void>}
+     * @private
+     */
+    private _listeners;
+    /**
+     * @type {function():void}
+     * @private
+     */
+    private _mapActivatedListener;
+    /**
+     * @type {Array<function():void>}
+     * @private
+     */
+    private _collectionListeners;
+    /**
+     * @type {boolean}
+     */
+    get active(): boolean;
+    /**
+     * @type {import("@vcmap/core").OpenlayersMap|null}
+     */
+    get map(): OpenlayersMap | null;
+    /**
+     * @type {EventHandler|null}
+     */
+    get eventHandler(): EventHandler | null;
+    /**
+     * @type {import("@vcmap/core").VcsEvent<import("@vcmap/core").InteractionEvent>|null}
+     */
+    get mapClicked(): import("@vcmap/core/dist/src/vcsEvent.js").default<import("@vcmap/core").InteractionEvent> | null;
+    /**
+     * @private
+     */
+    private _updatePrimaryColor;
+    /**
+     * @private
+     */
+    private _setupMapInteraction;
+    /**
+     * activates the overview map and initializes handlers for current active map
+     * @private
+     * @returns {Promise<void>}
+     */
+    private _activate;
+    /**
+     * opens window and sets target
+     * @returns {Promise<void>}
+     */
+    activate(): Promise<void>;
+    /**
+     * closes window and clears all listeners
+     */
+    deactivate(): void;
+    /**
+     * @param {import("@vcmap/core").VcsMap} map
+     * @returns {Promise<void>}
+     * @private
+     */
+    private _initializePostRenderHandler;
+    /**
+     * @param {import("@vcmap/core").ObliqueMap} obliqueMap
+     * @returns {Promise<void>}
+     * @private
+     */
+    private _initializeForOblique;
+    /**
+     * @param {import("@vcmap/core").ObliqueCollection} collection
+     * @private
+     */
+    private _obliqueCollectionChanged;
+    /**
+     * @param {import("@vcmap/core").ObliqueImage=} image
+     * @private
+     */
+    private _obliqueImageChange;
+    /**
+     * @private
+     */
+    private _setupObliqueLayers;
+    /**
+     * @param {import("@vcmap/core").VcsMap} activeMap
+     * @returns {Function}
+     * @private
+     */
+    private _addNavigationListener;
+    _setupCameraIconLayer(): void;
+    /**
+     * Adds and maintains the view and camera feature
+     * @private
+     */
+    private _syncCameraViewAndFeature;
+    /**
+     * @private
+     */
+    private _clearListeners;
+    destroy(): void;
+}
+import { VectorStyleItem } from '@vcmap/core';
+import { OpenlayersMap } from '@vcmap/core';
+import { EventHandler } from '@vcmap/core';

package/src/navigation/overviewMap.js

@@ -30,7 +30,7 @@ import VcsMap from '../application/VcsMap.vue';
 export const overviewMapLayerSymbol = Symbol('overviewMapLayerSymbol');
 
 /**
- * @returns {WindowComponentOptions}
+ * @returns {import("../manager/window/windowManager.js").WindowComponentOptions}
  */
 export function getWindowComponentOptions() {
   return {
@@ -89,11 +89,11 @@ function getCameraIcon(color) {
  */
 class OverviewMap {
   /**
-   * @param {VcsUiApp} app
+   * @param {import("@src/vcsUiApp.js").default} app
    */
   constructor(app) {
     /**
-     * @type {VcsUiApp}
+     * @type {import("@src/vcsUiApp.js").default}
      * @private
      */
     this._app = app;
@@ -249,7 +249,6 @@ class OverviewMap {
 
   /**
    * @type {boolean}
-   * @readonly
    */
   get active() {
     return this._active;
@@ -257,7 +256,6 @@ class OverviewMap {
 
   /**
    * @type {import("@vcmap/core").OpenlayersMap|null}
-   * @readonly
    */
   get map() {
     return this._map;
@@ -265,7 +263,6 @@ class OverviewMap {
 
   /**
    * @type {EventHandler|null}
-   * @readonly
    */
   get eventHandler() {
     return this._eventHandler;
@@ -273,7 +270,6 @@ class OverviewMap {
 
   /**
    * @type {import("@vcmap/core").VcsEvent<import("@vcmap/core").InteractionEvent>|null}
-   * @readonly
    */
   get mapClicked() {
     return this._mapClicked;

package/src/navigation/overviewMapClickedInteraction.d.ts

@@ -0,0 +1,21 @@
+export default OverviewMapClickedInteraction;
+/**
+ * @class
+ * @extends {import("@vcmap/core").AbstractInteraction}
+ */
+declare class OverviewMapClickedInteraction {
+    /**
+     * @type {import("@vcmap/core").VcsEvent<import("@vcmap/core").InteractionEvent>}
+     */
+    mapClicked: import("@vcmap/core").VcsEvent<import("@vcmap/core").InteractionEvent>;
+    /**
+     * @inheritDoc
+     * @param {import("@vcmap/core").InteractionEvent} event
+     * @returns {Promise<import("@vcmap/core").InteractionEvent>}
+     */
+    pipe(event: import("@vcmap/core").InteractionEvent): Promise<import("@vcmap/core").InteractionEvent>;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}

package/src/notifier/NotifierComponent.vue.d.ts

@@ -0,0 +1,10 @@
+declare const _default: import("vue").DefineComponent<{}, {
+    notifications: any;
+    icon: {
+        [x: string]: string;
+    };
+    defaultTitle: {
+        [x: string]: string;
+    };
+}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/src/notifier/notifier.d.ts

@@ -0,0 +1,53 @@
+export type NotificationType = string;
+export namespace NotificationType {
+    let ERROR: string;
+    let WARNING: string;
+    let INFO: string;
+    let SUCCESS: string;
+}
+export default Notifier;
+export type NotificationOptions = {
+    message: string;
+    type: NotificationType;
+    title?: string | undefined;
+    timeout?: number | undefined;
+};
+export type Notification = {
+    id: string;
+    message: string;
+    type: NotificationType;
+    title?: string | undefined;
+    timeout: number;
+    open: import("vue").Ref<boolean>;
+    close: () => void;
+};
+/**
+ * API for adding snackbar notification to the VcsUiApp. This is simply a container and on its own will not render anything.
+ * Typically, you do not need to instantiate this yourself, but use the notifier on the {@see VcsUiApp}.
+ * @class
+ */
+declare class Notifier {
+    /**
+     * @type {import("vue").Ref<Array<Notification>>}
+     * @private
+     */
+    private _notifications;
+    /**
+     * @type {import("vue").Ref<Array<Notification>>}
+     */
+    get notifications(): import("vue").Ref<Notification[]>;
+    /**
+     * @param {NotificationOptions} notification
+     * @returns {Notification}
+     */
+    add(notification: NotificationOptions): Notification;
+    /**
+     * @param {Notification} notification
+     */
+    remove(notification: Notification): void;
+    /**
+     * @param {Notification} notification
+     * @returns {boolean}
+     */
+    has(notification: Notification): boolean;
+}

package/src/notifier/notifier.js

@@ -90,7 +90,6 @@ class Notifier {
 
   /**
    * @type {import("vue").Ref<Array<Notification>>}
-   * @readonly
    */
   get notifications() {
     return this._notifications;

package/src/pluginHelper.d.ts

@@ -0,0 +1,67 @@
+/**
+ * A helper function to create an absolute URL from a relative plugin asset URL. For example, when
+ * shipping your plugin with a "plugin-asset/icon.png", you can always retrieve said icon with getPluginAssetUrl(app, name, 'pluing-assets/icon.png')
+ * Sets the plugin version as searchParam.
+ * Returns null, if the plugin does not exist.
+ * @param {import("@src/vcsUiApp.js").default} app
+ * @param {string} pluginName
+ * @param {string} asset
+ * @returns {string|null}
+ */
+export function getPluginAssetUrl(app: import("@src/vcsUiApp.js").default, pluginName: string, asset: string): string | null;
+/**
+ * validates the name according to package name pattern
+ * @param {string} name
+ * @returns {boolean}
+ */
+export function isValidPackageName(name: string): boolean;
+/**
+ * @param {string} name
+ * @param {T} config
+ * @returns {Promise<import("@src/vcsUiApp.js").VcsPlugin<T, S>|null>}
+ * @template {Object} T
+ * @template {Object} S
+ */
+export function loadPlugin<T extends Object, S extends Object>(name: string, config: T): Promise<import("@src/vcsUiApp.js").VcsPlugin<T, S> | null>;
+/**
+ * Returns relative url, if base is same, otherwise absolute url
+ * Removes version from searchParams, since version is serialized itself
+ * @param {string} base
+ * @param {string} pluginUrl
+ * @returns {string}
+ */
+export function getPluginEntry(base: string, pluginUrl: string): string;
+/**
+ * @param {import("@src/vcsUiApp.js").VcsPlugin<Object, Object>} plugin
+ * @returns {Object}
+ */
+export function serializePlugin(plugin: import("@src/vcsUiApp.js").VcsPlugin<Object, Object>): Object;
+/**
+ * @param {Object} serializedPlugin
+ * @returns {Promise<import("@src/vcsUiApp.js").VcsPlugin<Object, Object>|null>}
+ */
+export function deserializePlugin(serializedPlugin: Object): Promise<import("@src/vcsUiApp.js").VcsPlugin<Object, Object> | null>;
+/**
+ * @type {symbol}
+ */
+export const vcsAppSymbol: symbol;
+/**
+ * @type {symbol}
+ * @private
+ */
+export const pluginFactorySymbol: symbol;
+/**
+ * A symbol added to each plugin which describes the base URL from which the plugin was loaded (without the filename)
+ * @type {symbol}
+ */
+export const pluginBaseUrlSymbol: symbol;
+/**
+ * A symbol added to each plugin which describes the module URL from which the plugin was loaded (with the filename and including searchParams)
+ * @type {symbol}
+ */
+export const pluginModuleUrlSymbol: symbol;
+/**
+ * A symbol added to each plugin which describes the configured version range
+ * @type {symbol}
+ */
+export const pluginVersionRangeSymbol: symbol;