@vcmap/ui 5.3.7 → 6.0.0-rc.10

package/src/uiConfig.d.ts

@@ -45,7 +45,7 @@ export type UiConfigObject = {
      */
     appTitle?: string | undefined;
     /**
-     * - an optional primary color to use in all themes
+     * - an optional primary color to use in all themes, can be overwritten by `vuetifyTheme`
      */
     primaryColor?: string | undefined;
     /**
@@ -88,10 +88,62 @@ export type UiConfigObject = {
      * - an optional flag whether to show the Locator in the map.
      */
     showLocator?: boolean | undefined;
+    /**
+     * - can be used to hide the default Header of the map
+     */
+    hideHeader?: boolean | undefined;
+    /**
+     * - can be used to hide the integrated Search bar
+     */
+    hideSearch?: boolean | undefined;
+    /**
+     * - can be used to hide the default Map Buttons
+     */
+    hideMapButtons?: boolean | undefined;
+    /**
+     * - can be used to hide the toolbox
+     */
+    hideToolbox?: boolean | undefined;
+    /**
+     * - can be used to hide the navigation
+     */
+    hideMapNavigation?: boolean | undefined;
+    /**
+     * - can be used to hide the footer
+     */
+    hideFooter?: boolean | undefined;
+    /**
+     * - can be used to hide the myWorkspace button
+     */
+    hideMyWorkspace?: boolean | undefined;
+    /**
+     * - can be used to hide the contentTree
+     */
+    hideContentTree?: boolean | undefined;
+    /**
+     * - can be used to hide the legend
+     */
+    hideLegend?: boolean | undefined;
+    /**
+     * - can be used to hide the settings Window
+     */
+    hideSettings?: boolean | undefined;
+    /**
+     * - can be used to activate the overviewMap on startup
+     */
+    overviewMapActiveOnStartup?: boolean | undefined;
     /**
      * - the display quality settings
      */
     displayQuality?: import("@vcmap/core").DisplayQualityOptions | undefined;
+    /**
+     * - Vuetify Theming, also see vuetify configuraton https://vuetifyjs.com/en/features/theme/
+     */
+    vuetifyTheme?: any;
+    /**
+     * - open the legend window, if new layer has a config
+     */
+    openLegendOnAdd?: boolean | undefined;
 };
 /**
  * @typedef {{
@@ -135,7 +187,7 @@ export type UiConfigObject = {
  * @property {string} [logo] - the company logo to display. this will override any and all css overrides.
  * @property {string} [mobileLogo] - an alternative logo to display in mobile view
  * @property {string} [appTitle] - an optional title to display next to the company logo
- * @property {string} [primaryColor] - an optional primary color to use in all themes
+ * @property {string} [primaryColor] - an optional primary color to use in all themes, can be overwritten by `vuetifyTheme`
  * @property {boolean} [startingFeatureInfo] - an optional flag whether to activate feature info on startup (default active)
  * @property {string} [positionDisplayEventType] - mouse event, when position display is updated. Either 'click' (default) or 'move'.
  * @property {string} [helpBaseUrl='https://help.vc.systems/'] - an optional URL to a help landing page
@@ -146,7 +198,20 @@ export type UiConfigObject = {
  * @property {string} [favicon] - the favicon to set
  * @property {string} [headerTitle] - the title to display in the tab of the browser
  * @property {boolean} [showLocator] - an optional flag whether to show the Locator in the map.
+ * @property {boolean} [hideHeader] - can be used to hide the default Header of the map
+ * @property {boolean} [hideSearch] - can be used to hide the integrated Search bar
+ * @property {boolean} [hideMapButtons] - can be used to hide the default Map Buttons
+ * @property {boolean} [hideToolbox] - can be used to hide the toolbox
+ * @property {boolean} [hideMapNavigation] - can be used to hide the navigation
+ * @property {boolean} [hideFooter] - can be used to hide the footer
+ * @property {boolean} [hideMyWorkspace] - can be used to hide the myWorkspace button
+ * @property {boolean} [hideContentTree] - can be used to hide the contentTree
+ * @property {boolean} [hideLegend] - can be used to hide the legend
+ * @property {boolean} [hideSettings] - can be used to hide the settings Window
+ * @property {boolean} [overviewMapActiveOnStartup] - can be used to activate the overviewMap on startup
  * @property {import("@vcmap/core").DisplayQualityOptions} [displayQuality] - the display quality settings
+ * @property {import("./vuetifyPlugins/vuetify.js").VcsThemes} [vuetifyTheme] - Vuetify Theming, also see vuetify configuraton https://vuetifyjs.com/en/features/theme/
+ * @property {boolean} [openLegendOnAdd] - open the legend window, if new layer has a config
  */
 /**
  * @extends {Collection<UiConfigurationItem<unknown>>}
@@ -157,20 +222,271 @@ declare class UiConfig extends Collection<UiConfigurationItem<unknown>> {
      */
     constructor(getDynamicModuleId: () => string);
     /**
-     * @type {import("vue").Ref<Object<string, *>>}
+     * @type {import("vue").UnwrapNestedRefs<Object<string, *> & UiConfigObject>}
      * @private
      */
     private _config;
+    /**
+     * @type {import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Object<string, *> & UiConfigObject>>}
+     */
+    _readonlyConfig: import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<{
+        [x: string]: any;
+    } & UiConfigObject>>;
     /**
      * @type {Array<function():void>}
      * @private
      */
     private _listeners;
     /**
-     * @type {import("vue").Ref<Object<string, unknown>|UiConfigObject>}
+     * @type {import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Record<string, *> & UiConfigObject>>}
      */
-    get config(): import("vue").Ref<{
-        [x: string]: unknown;
-    } | UiConfigObject>;
+    get config(): {
+        readonly [x: string]: any;
+        /**
+         * - the company logo to display. this will override any and all css overrides.
+         */
+        readonly logo?: string | undefined;
+        /**
+         * - an alternative logo to display in mobile view
+         */
+        readonly mobileLogo?: string | undefined;
+        /**
+         * - an optional title to display next to the company logo
+         */
+        readonly appTitle?: string | undefined;
+        /**
+         * - an optional primary color to use in all themes, can be overwritten by `vuetifyTheme`
+         */
+        readonly primaryColor?: string | undefined;
+        /**
+         * - an optional flag whether to activate feature info on startup (default active)
+         */
+        readonly startingFeatureInfo?: boolean | undefined;
+        /**
+         * - mouse event, when position display is updated. Either 'click' (default) or 'move'.
+         */
+        readonly positionDisplayEventType?: string | undefined;
+        /**
+         * - an optional URL to a help landing page
+         */
+        readonly helpBaseUrl?: string | undefined;
+        /**
+         * - an option imprint, will show a link in the footer. Default title is 'footer.imprint.title'.
+         */
+        readonly imprint?: {
+            readonly title?: string | undefined;
+            readonly url?: string | {
+                readonly hash: string;
+                readonly host: string;
+                readonly hostname: string;
+                readonly href: string;
+                readonly toString: () => string;
+                readonly origin: string;
+                readonly password: string;
+                readonly pathname: string;
+                readonly port: string;
+                readonly protocol: string;
+                readonly search: string;
+                readonly searchParams: ReadonlyMap<string, string | null>;
+                readonly username: string;
+                readonly toJSON: () => string;
+            } | undefined;
+            readonly content?: string | undefined;
+        } | undefined;
+        /**
+         * - an option dataProtection, will show a link in the footer. Default title is 'footer.dataProtection.title'.
+         */
+        readonly dataProtection?: {
+            readonly title?: string | undefined;
+            readonly url?: string | {
+                readonly hash: string;
+                readonly host: string;
+                readonly hostname: string;
+                readonly href: string;
+                readonly toString: () => string;
+                readonly origin: string;
+                readonly password: string;
+                readonly pathname: string;
+                readonly port: string;
+                readonly protocol: string;
+                readonly search: string;
+                readonly searchParams: ReadonlyMap<string, string | null>;
+                readonly username: string;
+                readonly toJSON: () => string;
+            } | undefined;
+            readonly content?: string | undefined;
+        } | undefined;
+        /**
+         * - an option splashScreen, will show a splash Screen on Map Load.
+         */
+        readonly splashScreen?: {
+            readonly title?: string | undefined;
+            readonly icon?: string | undefined;
+            readonly content?: string | undefined;
+            readonly name?: string | undefined;
+            readonly checkBoxText?: string | undefined;
+            readonly buttonTitle?: string | undefined;
+            readonly menuEntry?: boolean | undefined;
+            readonly acceptInput?: boolean | undefined;
+            readonly position?: {
+                readonly width?: string | undefined;
+                readonly height?: string | undefined;
+                readonly maxHeight?: string | undefined;
+                readonly maxWidth?: string | undefined;
+            } | undefined;
+        } | undefined;
+        /**
+         * - an option customScreen, will show a Custom Menu Point that opens a window with custom content.
+         */
+        readonly customScreen?: {
+            readonly title?: string | undefined;
+            readonly icon?: string | undefined;
+            readonly content?: string | undefined;
+            readonly name?: string | undefined;
+            readonly windowPosition?: {
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly left?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly top?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly right?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly bottom?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly width?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly height?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly maxHeight?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly maxWidth?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly minHeight?: string | number | undefined;
+                /**
+                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
+                 */
+                readonly minWidth?: string | number | undefined;
+            } | undefined;
+        } | undefined;
+        /**
+         * - the favicon to set
+         */
+        readonly favicon?: string | undefined;
+        /**
+         * - the title to display in the tab of the browser
+         */
+        readonly headerTitle?: string | undefined;
+        /**
+         * - an optional flag whether to show the Locator in the map.
+         */
+        readonly showLocator?: boolean | undefined;
+        /**
+         * - can be used to hide the default Header of the map
+         */
+        readonly hideHeader?: boolean | undefined;
+        /**
+         * - can be used to hide the integrated Search bar
+         */
+        readonly hideSearch?: boolean | undefined;
+        /**
+         * - can be used to hide the default Map Buttons
+         */
+        readonly hideMapButtons?: boolean | undefined;
+        /**
+         * - can be used to hide the toolbox
+         */
+        readonly hideToolbox?: boolean | undefined;
+        /**
+         * - can be used to hide the navigation
+         */
+        readonly hideMapNavigation?: boolean | undefined;
+        /**
+         * - can be used to hide the footer
+         */
+        readonly hideFooter?: boolean | undefined;
+        /**
+         * - can be used to hide the myWorkspace button
+         */
+        readonly hideMyWorkspace?: boolean | undefined;
+        /**
+         * - can be used to hide the contentTree
+         */
+        readonly hideContentTree?: boolean | undefined;
+        /**
+         * - can be used to hide the legend
+         */
+        readonly hideLegend?: boolean | undefined;
+        /**
+         * - can be used to hide the settings Window
+         */
+        readonly hideSettings?: boolean | undefined;
+        /**
+         * - can be used to activate the overviewMap on startup
+         */
+        readonly overviewMapActiveOnStartup?: boolean | undefined;
+        /**
+         * - the display quality settings
+         */
+        readonly displayQuality?: {
+            readonly startingQualityLevel?: import("@vcmap/core").DisplayQualityLevel | undefined;
+            readonly startingMobileQualityLevel?: import("@vcmap/core").DisplayQualityLevel | undefined;
+            readonly low?: {
+                readonly sse?: number | undefined;
+                readonly fxaa?: boolean | undefined;
+                readonly fogEnabled?: boolean | undefined;
+                readonly fogDensity?: number | undefined;
+                readonly fogScreenSpaceErrorFactor?: number | undefined;
+                readonly resolutionScale?: number | undefined;
+                readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
+            } | undefined;
+            readonly medium?: {
+                readonly sse?: number | undefined;
+                readonly fxaa?: boolean | undefined;
+                readonly fogEnabled?: boolean | undefined;
+                readonly fogDensity?: number | undefined;
+                readonly fogScreenSpaceErrorFactor?: number | undefined;
+                readonly resolutionScale?: number | undefined;
+                readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
+            } | undefined;
+            readonly high?: {
+                readonly sse?: number | undefined;
+                readonly fxaa?: boolean | undefined;
+                readonly fogEnabled?: boolean | undefined;
+                readonly fogDensity?: number | undefined;
+                readonly fogScreenSpaceErrorFactor?: number | undefined;
+                readonly resolutionScale?: number | undefined;
+                readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
+            } | undefined;
+        } | undefined;
+        /**
+         * - Vuetify Theming, also see vuetify configuraton https://vuetifyjs.com/en/features/theme/
+         */
+        readonly vuetifyTheme?: any;
+        /**
+         * - open the legend window, if new layer has a config
+         */
+        readonly openLegendOnAdd?: boolean | undefined;
+    };
 }
 import { Collection } from '@vcmap/core';

package/src/uiConfig.js

@@ -1,5 +1,5 @@
 import { Collection, makeOverrideCollection } from '@vcmap/core';
-import { ref } from 'vue';
+import { reactive, readonly } from 'vue';
 
 /**
  * @typedef {{
@@ -47,7 +47,7 @@ import { ref } from 'vue';
  * @property {string} [logo] - the company logo to display. this will override any and all css overrides.
  * @property {string} [mobileLogo] - an alternative logo to display in mobile view
  * @property {string} [appTitle] - an optional title to display next to the company logo
- * @property {string} [primaryColor] - an optional primary color to use in all themes
+ * @property {string} [primaryColor] - an optional primary color to use in all themes, can be overwritten by `vuetifyTheme`
  * @property {boolean} [startingFeatureInfo] - an optional flag whether to activate feature info on startup (default active)
  * @property {string} [positionDisplayEventType] - mouse event, when position display is updated. Either 'click' (default) or 'move'.
  * @property {string} [helpBaseUrl='https://help.vc.systems/'] - an optional URL to a help landing page
@@ -58,7 +58,20 @@ import { ref } from 'vue';
  * @property {string} [favicon] - the favicon to set
  * @property {string} [headerTitle] - the title to display in the tab of the browser
  * @property {boolean} [showLocator] - an optional flag whether to show the Locator in the map.
+ * @property {boolean} [hideHeader] - can be used to hide the default Header of the map
+ * @property {boolean} [hideSearch] - can be used to hide the integrated Search bar
+ * @property {boolean} [hideMapButtons] - can be used to hide the default Map Buttons
+ * @property {boolean} [hideToolbox] - can be used to hide the toolbox
+ * @property {boolean} [hideMapNavigation] - can be used to hide the navigation
+ * @property {boolean} [hideFooter] - can be used to hide the footer
+ * @property {boolean} [hideMyWorkspace] - can be used to hide the myWorkspace button
+ * @property {boolean} [hideContentTree] - can be used to hide the contentTree
+ * @property {boolean} [hideLegend] - can be used to hide the legend
+ * @property {boolean} [hideSettings] - can be used to hide the settings Window
+ * @property {boolean} [overviewMapActiveOnStartup] - can be used to activate the overviewMap on startup
  * @property {import("@vcmap/core").DisplayQualityOptions} [displayQuality] - the display quality settings
+ * @property {import("./vuetifyPlugins/vuetify.js").VcsThemes} [vuetifyTheme] - Vuetify Theming, also see vuetify configuraton https://vuetifyjs.com/en/features/theme/
+ * @property {boolean} [openLegendOnAdd] - open the legend window, if new layer has a config
  */
 
 /**
@@ -70,19 +83,18 @@ class UiConfig extends Collection {
    */
   constructor(getDynamicModuleId) {
     super();
-
     makeOverrideCollection(this, getDynamicModuleId);
     /**
-     * This object just acts as a go between for reactivity until we have vue3
-     * @todo vue3 cleanup
-     * @type {Object<string, *>}
+     * @type {import("vue").UnwrapNestedRefs<Object<string, *> & UiConfigObject>}
+     * @private
      */
-    const configObject = {};
+    this._config = reactive({});
+
     /**
-     * @type {import("vue").Ref<Object<string, *>>}
-     * @private
+     * @type {import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Object<string, *> & UiConfigObject>>}
      */
-    this._config = ref({});
+    this._readonlyConfig = readonly(this._config);
+
     /**
      * @type {Array<function():void>}
      * @private
@@ -90,24 +102,26 @@ class UiConfig extends Collection {
     this._listeners = [
       this.added.addEventListener((item) => {
         if (typeof item?.name === 'string') {
-          configObject[item.name] = item.value;
-          this._config.value = { ...configObject }; // shallow clone to trip reactivity
+          this._config[item.name] = structuredClone(item.value);
         }
       }),
       this.removed.addEventListener((item) => {
-        if (typeof item?.name === 'string') {
-          delete configObject[item.name];
-          this._config.value = { ...configObject }; // shallow clone to trip reactivity
+        const previousItem = this.getByKey(item?.name);
+        if (typeof previousItem?.name === 'string') {
+          // still in the collection
+          this._config[previousItem.name] = structuredClone(previousItem.value);
+        } else if (typeof item?.name === 'string') {
+          delete this._config[item.name];
         }
       }),
     ];
   }
 
   /**
-   * @type {import("vue").Ref<Object<string, unknown>|UiConfigObject>}
+   * @type {import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Record<string, *> & UiConfigObject>>}
    */
   get config() {
-    return this._config;
+    return this._readonlyConfig;
   }
 
   /**