@vcmap/ui 5.0.2 → 5.1.0-rc.1

package/src/i18n/en.d.ts

@@ -0,0 +1,352 @@
+export default messages;
+declare namespace messages {
+    export namespace navbar {
+        namespace maps {
+            let CesiumMap: string;
+            let OpenlayersMap: string;
+            let ObliqueMap: string;
+        }
+        namespace menu {
+            let tooltip: string;
+        }
+        namespace share {
+            let tooltip_1: string;
+            export { tooltip_1 as tooltip };
+        }
+    }
+    export namespace content {
+        let title: string;
+        let empty: string;
+        namespace search {
+            let placeholder: string;
+        }
+        namespace infoAction {
+            let title_1: string;
+            export { title_1 as title };
+        }
+        namespace viewpointAction {
+            let title_2: string;
+            export { title_2 as title };
+        }
+        namespace styleAction {
+            let title_3: string;
+            export { title_3 as title };
+        }
+        namespace layerExtentAction {
+            export let name: string;
+            let title_4: string;
+            export { title_4 as title };
+        }
+    }
+    export namespace navigation {
+        let obliqueLeftTooltip: string;
+        let obliqueRightTooltip: string;
+        let zoomInTooltip: string;
+        let zoomOutTooltip: string;
+        let pitchTooltip: string;
+        let overviewMapTooltip: string;
+        let homeButton: string;
+    }
+    export namespace categoryManager {
+        let title_5: string;
+        export { title_5 as title };
+        let tooltip_2: string;
+        export { tooltip_2 as tooltip };
+    }
+    export namespace collectionManager {
+        export let more: string;
+        export let less: string;
+        let empty_1: string;
+        export { empty_1 as empty };
+    }
+    export namespace components {
+        export let pin: string;
+        export let close: string;
+        export let add: string;
+        export let apply: string;
+        export let cancel: string;
+        export namespace _import {
+            let submit: string;
+            let fileDrop: string;
+        }
+        export { _import as import };
+        export namespace vcsFormSection {
+            let help: string;
+        }
+        export namespace vcsTable {
+            let key: string;
+            let value: string;
+        }
+        export namespace vcsDataTable {
+            let searchbarPlaceholder: string;
+            let itemsPerPage: string;
+            let ofItems: string;
+            let nextPage: string;
+            let formerPage: string;
+            let noDataPlaceholder: string;
+            let noResultsPlaceholder: string;
+        }
+        export namespace style {
+            let fill: string;
+            let stroke: string;
+            let reset: string;
+            let lineWidth: string;
+            let type: string;
+            let points: string;
+            let radius: string;
+            let radius2: string;
+            let angle: string;
+            let rotation: string;
+            let scale: string;
+            let opacity: string;
+            let image: string;
+            let icon: string;
+            let shape: string;
+            let presets: string;
+            let circle: string;
+            let square: string;
+            let rectangle: string;
+            let triangle: string;
+            let star: string;
+            let cross: string;
+            let x: string;
+            let custom: string;
+            let bold: string;
+            let italic: string;
+            let text: string;
+            let enterText: string;
+            let offset: string;
+        }
+        export namespace flight {
+            export let general: string;
+            let name_1: string;
+            export { name_1 as name };
+            let title_6: string;
+            export { title_6 as title };
+            export let titlePlaceholder: string;
+            export let interpolation: string;
+            export let duration: string;
+            export let spline: string;
+            export let linear: string;
+            export let loop: string;
+            export let anchors: string;
+            export let hidePath: string;
+            export let addAnchor: string;
+            export let removeAnchor: string;
+            export let editAnchor: string;
+            export let zoomToAnchor: string;
+            export let noAnchor: string;
+            export let invalidDuration: string;
+        }
+        export namespace viewpoint {
+            let name_2: string;
+            export { name_2 as name };
+            export let viewpointTitle: string;
+            let titlePlaceholder_1: string;
+            export { titlePlaceholder_1 as titlePlaceholder };
+            export let groundPosition: string;
+            export let cameraPosition: string;
+            export let distance: string;
+            export let heading: string;
+            export let pitch: string;
+            export let roll: string;
+            export let animate: string;
+            let duration_1: string;
+            export { duration_1 as duration };
+            let general_1: string;
+            export { general_1 as general };
+            export let positionAndOrientation: string;
+            export let updateFromView: string;
+            export let sync: string;
+            export let syncOff: string;
+            export let finiteNumber: string;
+            export let positiveNumber: string;
+        }
+        export namespace coordinate {
+            let outOfRange: string;
+        }
+        export namespace extent {
+            let title_7: string;
+            export { title_7 as title };
+            export let projection: string;
+            export let min: string;
+            export let max: string;
+            export let show: string;
+            export let hide: string;
+            export let create: string;
+            export let zoom: string;
+            export let invalid: string;
+            export let editVertices: string;
+            export let translate: string;
+        }
+        export namespace editor {
+            let translate_1: string;
+            export { translate_1 as translate };
+            export let rotate: string;
+            let scale_1: string;
+            export { scale_1 as scale };
+            export let extrude: string;
+            export let header: string;
+            export let placeOnTerrain: string;
+            export let cw: string;
+            export let ccw: string;
+            let angle_1: string;
+            export { angle_1 as angle };
+            export let edit: string;
+            export let modifyHeader: string;
+            export let modifyInfo: string;
+            export let styleHeader: string;
+        }
+        export namespace vectorProperties {
+            let header_1: string;
+            export { header_1 as header };
+            export let altitudeMode: string;
+            export let clampToGround: string;
+            export let absolute: string;
+            export let relativeToGround: string;
+            export let groundLevel: string;
+            export let classificationType: string;
+            export let none: string;
+            export let both: string;
+            export let cesium3DTile: string;
+            export let terrain: string;
+            export let heightAboveGround: string;
+            export let allowPicking: string;
+            export let scaleByDistance: string;
+            export let eyeOffset: string;
+            export let storeys: string;
+            export let storeyHeights: string;
+            export let aboveGround: string;
+            export let belowGround: string;
+            export let modelUrl: string;
+            export let modelHeading: string;
+            export let modelPitch: string;
+            export let modelRoll: string;
+            export let baseUrl: string;
+            export let extrudedHeight: string;
+            export let skirt: string;
+            export let modelScale: string;
+        }
+        export namespace validation {
+            let allowedRange: string;
+            let notValid: string;
+            let required: string;
+        }
+    }
+    export namespace settings {
+        let title_8: string;
+        export { title_8 as title };
+        let tooltip_3: string;
+        export { tooltip_3 as tooltip };
+        export let languageSelector: string;
+        export namespace theme {
+            let title_9: string;
+            export { title_9 as title };
+            export let dark: string;
+            export let light: string;
+        }
+    }
+    export namespace help_1 {
+        let title_10: string;
+        export { title_10 as title };
+        let tooltip_4: string;
+        export { tooltip_4 as tooltip };
+    }
+    export { help_1 as help };
+    export namespace featureInfo {
+        let activateToolTitle: string;
+        let deactivateToolTitle: string;
+    }
+    export namespace legend {
+        let title_11: string;
+        export { title_11 as title };
+        let tooltip_5: string;
+        export { tooltip_5 as tooltip };
+        let empty_2: string;
+        export { empty_2 as empty };
+        export let openInNew: string;
+        export let defaultLabelText: string;
+    }
+    export namespace search_1 {
+        let title_12: string;
+        export { title_12 as title };
+        let tooltip_6: string;
+        export { tooltip_6 as tooltip };
+        export let select: string;
+        let placeholder_1: string;
+        export { placeholder_1 as placeholder };
+        export let zoomToFeatureAction: string;
+        export let zoomToAll: string;
+    }
+    export { search_1 as search };
+    export namespace toolbox {
+        let flight_1: string;
+        export { flight_1 as flight };
+        export let miscellaneous: string;
+    }
+    export namespace footer {
+        let title_13: string;
+        export { title_13 as title };
+        export namespace attributions {
+            let title_14: string;
+            export { title_14 as title };
+            let tooltip_7: string;
+            export { tooltip_7 as tooltip };
+            let empty_3: string;
+            export { empty_3 as empty };
+        }
+        export namespace imprint {
+            let title_15: string;
+            export { title_15 as title };
+            let tooltip_8: string;
+            export { tooltip_8 as tooltip };
+        }
+        export namespace dataprotection {
+            let title_16: string;
+            export { title_16 as title };
+            let tooltip_9: string;
+            export { tooltip_9 as tooltip };
+        }
+        export namespace positionDisplay {
+            let title_17: string;
+            export { title_17 as title };
+            let projection_1: string;
+            export { projection_1 as projection };
+        }
+    }
+    export namespace notification {
+        let error: string;
+        let warning: string;
+        let information: string;
+        let success: string;
+    }
+    export namespace datePicker {
+        let today: string;
+    }
+    export namespace list {
+        export let selectAll: string;
+        export let clearSelection: string;
+        export let renameItem: string;
+        export let deleteItem: string;
+        export let editItem: string;
+        let _import_1: string;
+        export { _import_1 as import };
+        let _export: string;
+        export { _export as export };
+        let _delete: string;
+        export { _delete as delete };
+        let edit_1: string;
+        export { edit_1 as edit };
+    }
+    export namespace flight_2 {
+        let player: string;
+        let playTooltip: string;
+        let pauseTooltip: string;
+        let stopTooltip: string;
+        let forwardFastTooltip: string;
+        let backwardFastTooltip: string;
+        let forwardStepTooltip: string;
+        let backwardStepTooltip: string;
+    }
+    export { flight_2 as flight };
+}

package/src/i18n/en.js

@@ -1,3 +1,5 @@
+import { TransformationMode } from '@vcmap/core';
+
 const messages = {
   navbar: {
     maps: {
@@ -46,14 +48,20 @@ const messages = {
     tooltip: 'My Workspace',
   },
   collectionManager: {
-    more: 'Show more...',
+    more: 'Show all...',
+    less: 'Show less...',
     empty: 'There are no entries yet.',
   },
   components: {
     pin: 'Dock window',
     close: 'Close window',
+    add: 'Add',
     apply: 'Apply',
     cancel: 'Cancel',
+    import: {
+      submit: 'Import',
+      fileDrop: 'Drop files here',
+    },
     vcsFormSection: {
       help: 'Show help',
     },
@@ -101,6 +109,77 @@ const messages = {
       enterText: 'Enter text here',
       offset: 'Offset',
     },
+    flight: {
+      general: 'Flight settings',
+      name: 'Name (ID)',
+      title: 'Title',
+      titlePlaceholder: 'Title of flight',
+      interpolation: 'Interpolation',
+      duration: 'Total flight duration',
+      spline: 'Spline',
+      linear: 'Linear',
+      loop: 'Loop',
+      anchors: 'Flight anchors',
+      hidePath: 'Visualization of flight path',
+      addAnchor: 'Add current view as new anchor',
+      removeAnchor: 'Remove anchor',
+      editAnchor: 'Edit anchor',
+      zoomToAnchor: 'Zoom to anchor',
+      noAnchor: 'No flight anchor available yet.',
+      invalidDuration: 'The total flight duration must be greater zero!',
+    },
+    viewpoint: {
+      name: 'Name (ID)',
+      viewpointTitle: 'Title',
+      titlePlaceholder: 'Title of viewpoint',
+      groundPosition: 'Ground position',
+      cameraPosition: 'Camera position',
+      distance: 'Distance',
+      heading: 'Azimuth',
+      pitch: 'Pitch',
+      roll: 'Roll',
+      animate: 'Animate',
+      duration: 'Animation duration',
+      general: 'General settings',
+      positionAndOrientation: 'Position & Orientation',
+      updateFromView: 'Apply current map position',
+      sync: 'Turn on synchronization of the camera',
+      syncOff: 'Turn off synchronization for editing',
+      finiteNumber: 'Finite number is required!',
+      positiveNumber: 'Positive number is required!',
+    },
+    coordinate: {
+      outOfRange: 'Value out of valid range!',
+    },
+    extent: {
+      title: 'Extent',
+      projection: 'Projection',
+      min: 'Min',
+      max: 'Max',
+      show: 'Show extent in map',
+      hide: 'Hide extent in map',
+      create: 'Draw new extent in map',
+      zoom: 'Zoom to extent',
+      invalid: 'Coordinates do not result in a valid extent!',
+      editVertices: 'Edit extent corners',
+      translate: 'Translate extent',
+    },
+    editor: {
+      [TransformationMode.TRANSLATE]: 'Translate features',
+      [TransformationMode.ROTATE]: 'Rotate features',
+      [TransformationMode.SCALE]: 'Scale features',
+      [TransformationMode.EXTRUDE]: 'Extrude features',
+      header: 'Transform',
+      placeOnTerrain: 'Place on terrain',
+      cw: 'Rotate 90° clockwise',
+      ccw: 'Rotate 90° counter clockwise',
+      angle: 'Angle',
+      edit: 'Edit geometry',
+      modifyHeader: 'Modify',
+      modifyInfo:
+        'For modifying the selected feature(s), click on one of the icons in the header above.',
+      styleHeader: 'Style',
+    },
     vectorProperties: {
       header: 'Vector properties',
       altitudeMode: 'Altitude mode',
@@ -180,6 +259,18 @@ const messages = {
       tooltip: 'Open attributions window',
       empty: 'Currently there are no attribution entries available.',
     },
+    imprint: {
+      title: 'Imprint',
+      tooltip: 'Open imprint window',
+    },
+    dataprotection: {
+      title: 'Data Protection',
+      tooltip: 'Open data protection window',
+    },
+    positionDisplay: {
+      title: 'Position display',
+      projection: 'Select projection',
+    },
   },
   notification: {
     error: 'Error',
@@ -190,6 +281,27 @@ const messages = {
   datePicker: {
     today: 'Today',
   },
+  list: {
+    selectAll: 'Select all',
+    clearSelection: 'Clear selection',
+    renameItem: 'Rename item',
+    deleteItem: 'Remove item',
+    editItem: 'Edit item',
+    import: 'Import',
+    export: 'Export selection',
+    delete: 'Delete selection',
+    edit: 'Edit selection',
+  },
+  flight: {
+    player: 'Player',
+    playTooltip: 'Play this flight',
+    pauseTooltip: 'Pause this flight at the current position',
+    stopTooltip: 'Stop playing this flight',
+    forwardFastTooltip: 'Fast forward playing',
+    backwardFastTooltip: 'Fast backward playing',
+    forwardStepTooltip: 'Step forward to next position',
+    backwardStepTooltip: 'Step backward to previous position',
+  },
 };
 
 export default messages;

package/src/i18n/i18nCollection.d.ts

@@ -0,0 +1,82 @@
+/**
+ * returns true if the given value is of type object and not an array.
+ * This function does not handle Maps and Sets and also returns true for these.
+ * This helper function is mainly used for the i18nCollection mergeDeep function
+ * @param {unknown} item
+ * @returns {boolean}
+ */
+export function isObject(item: unknown): boolean;
+/**
+ * Deep merge objects into a new Object. Can only handle stringifyable content.
+ * This will create a new deep copy of the given sources. No copy by reference.
+ * @param {...Object} sources
+ * @returns {Object}
+ */
+export function mergeDeep(...sources: Object[]): Object;
+/**
+ * Item for internationalization containing an object with key value mapping for each locale (de, en, nl, pl, ...).
+ * Other locales can be supported by adding corresponding mapping objects with associated locale key.
+ * @typedef {Object} I18nConfigurationItem
+ * @property {string} [name] - optional name for the item. If not provided checksum is used.
+ * @property {Object} [properties]
+ * @property {Object} [de]
+ * @property {Object} [en]
+ * ...
+ */
+/**
+ * A symbol added to plugin messages added to this collection.
+ * @type {symbol}
+ */
+export const i18nPluginSymbol: symbol;
+export default I18nCollection;
+/**
+ * Item for internationalization containing an object with key value mapping for each locale (de, en, nl, pl, ...).
+ * Other locales can be supported by adding corresponding mapping objects with associated locale key.
+ */
+export type I18nConfigurationItem = {
+    /**
+     * - optional name for the item. If not provided checksum is used.
+     */
+    name?: string | undefined;
+    properties?: Object | undefined;
+    de?: Object | undefined;
+    /**
+     * ...
+     */
+    en?: Object | undefined;
+};
+/**
+ * @extends {IndexedCollection<I18nConfigurationItem>}
+ */
+declare class I18nCollection extends IndexedCollection<I18nConfigurationItem> {
+    /**
+     * @param {import("@vcmap/core").OverrideCollection<import("@src/vcsUiApp.js").VcsPlugin<Object, Object>>} pluginCollection
+     */
+    constructor(pluginCollection: import("@vcmap/core").OverrideCollection<import("@src/vcsUiApp.js").VcsPlugin<Object, Object>>);
+    /**
+     * VC Map default I18n Messages
+     * @type {Object}
+     * @private
+     */
+    private _defaultMessages;
+    /**
+     * @type {import("@vcmap/core").OverrideCollection<import("@src/vcsUiApp.js").VcsPlugin>}
+     * @private
+     */
+    private _pluginCollection;
+    _pluginI18nListeners: (() => void)[];
+    _i18nListener: (() => void)[];
+    /**
+     * Event raised, whenever a I18nConfigurationItem is added or removed or when a plugin with i18n keys is added or removed
+     * @type {VcsEvent<I18nConfigurationItem>}
+     */
+    changed: VcsEvent<I18nConfigurationItem>;
+    /**
+     * Returns a merged Message Object with the locale as a key and an Object with all the translated keys.
+     * Includes all available plugin messages.
+     * @returns {Object}
+     */
+    getMergedMessages(): Object;
+}
+import { IndexedCollection } from '@vcmap/core';
+import { VcsEvent } from '@vcmap/core';

package/src/i18n/i18nCollection.js

@@ -7,7 +7,7 @@ import de from './de.js';
  * returns true if the given value is of type object and not an array.
  * This function does not handle Maps and Sets and also returns true for these.
  * This helper function is mainly used for the i18nCollection mergeDeep function
- * @param {*} item
+ * @param {unknown} item
  * @returns {boolean}
  */
 export function isObject(item) {
@@ -66,7 +66,7 @@ export function mergeDeep(...sources) {
  */
 class I18nCollection extends IndexedCollection {
   /**
-   * @param {import("@vcmap/core").OverrideCollection<VcsPlugin>} pluginCollection
+   * @param {import("@vcmap/core").OverrideCollection<import("@src/vcsUiApp.js").VcsPlugin<Object, Object>>} pluginCollection
    */
   constructor(pluginCollection) {
     super();
@@ -77,7 +77,7 @@ class I18nCollection extends IndexedCollection {
      */
     this._defaultMessages = { name: 'default', en, de };
     /**
-     * @type {import("@vcmap/core").OverrideCollection<VcsPlugin>}
+     * @type {import("@vcmap/core").OverrideCollection<import("@src/vcsUiApp.js").VcsPlugin>}
      * @private
      */
     this._pluginCollection = pluginCollection;

package/src/init.d.ts

@@ -0,0 +1,58 @@
+/**
+ * creates and mounts a vcsApp
+ * @param {string} mountTarget
+ * @returns {Promise<import("@src/vcsUiApp.js").default>}
+ */
+export default function initApp(mountTarget: string): Promise<import("@src/vcsUiApp.js").default>;
+/**
+ * Initializes app with an optional single config
+ * @param {string} mountTarget
+ * @param {string=} configUrl optional config
+ * @returns {Promise<import("@src/vcsUiApp.js").default>}
+ */
+export function initAppFromModule(mountTarget: string, configUrl?: string | undefined): Promise<import("@src/vcsUiApp.js").default>;
+/**
+ * Initializes app with a map config containing a set of config urls
+ * @param {string} mountTarget
+ * @param {string} appUrl app config containing further modules to be loaded
+ * @returns {Promise<import("@src/vcsUiApp.js").default>}
+ */
+export function initAppFromAppConfig(mountTarget: string, appUrl: string): Promise<import("@src/vcsUiApp.js").default>;
+export namespace VcsUiAppConfigPattern {
+    let id: (StringConstructor | undefined)[];
+    let layers: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let maps: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let styles: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let viewpoints: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let startingViewpointName: (StringConstructor | undefined)[];
+    let startingMapName: (StringConstructor | undefined)[];
+    let projection: (ObjectConstructor | undefined)[];
+    let categories: ({
+        name: StringConstructor;
+        items: ObjectConstructor[];
+    }[] | undefined)[];
+    let obliqueCollections: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let plugins: (ObjectConstructor[] | undefined)[];
+    let contentTree: (ObjectConstructor[] | undefined)[];
+    let uiConfig: (ObjectConstructor[] | undefined)[];
+    let featureInfo: ({
+        type: StringConstructor;
+        name: StringConstructor;
+    }[] | undefined)[];
+    let i18n: (ObjectConstructor[] | undefined)[];
+}