@vcmap/ui 5.0.0-rc.10 → 5.0.0-rc.11

package/src/components/tables/VcsTable.vue

@@ -0,0 +1,245 @@
+<template>
+  <v-card>
+    <VcsTreeviewSearchbar
+      v-if="showSearchbar"
+      :placeholder="$t(searchbarPlaceholder)"
+      v-model="search"
+    />
+    <v-data-table
+      dense
+      item-key="key"
+      :headers="translatedHeaders"
+      :items="items"
+      :items-per-page.sync="itemsPerPageRef"
+      :page.sync="page"
+      :search="search"
+      :custom-filter="handleFilter"
+      hide-default-footer
+      class="vcs-table"
+    >
+      <!-- eslint-disable-next-line -->
+      <template #item.key="{ item }">
+        <td class="vcs-table">
+          {{ $t(item.key) }}
+        </td>
+      </template>
+      <!-- eslint-disable-next-line -->
+      <template #item.value="{ item }">
+        <td class="vcs-table">
+          {{ $t(item.value) }}
+        </td>
+      </template>
+      <template #footer>
+        <v-divider />
+        <v-container class="pa-2" v-if="items.length > itemsPerPageRef">
+          <v-row
+            dense
+            no-gutters
+            align="center"
+            justify="center"
+          >
+            <v-menu offset-y dense>
+              <template #activator="{ on, attrs }">
+                <VcsButton
+                  small
+                  color="primary"
+                  v-bind="attrs"
+                  v-on="on"
+                >
+                  {{ itemsPerPageRef }}
+                  <v-icon>mdi-chevron-down</v-icon>
+                </VcsButton>
+              </template>
+              <v-list>
+                <v-list-item
+                  v-for="(number, index) in itemsPerPageArray"
+                  :key="index"
+                  @click="updateItemsPerPage(number)"
+                >
+                  <v-list-item-title>{{ number }}</v-list-item-title>
+                </v-list-item>
+              </v-list>
+            </v-menu>
+            <span class="grey--text mx-2">{{ $t('components.vcsTable.itemsPerPage') }}</span>
+            <span class="grey--text mx-2">{{ itemsFrom }} - {{ itemsTo }} of {{ items.length }}</span>
+            <VcsButton
+              small
+              icon="mdi-chevron-left"
+              @click="formerPage"
+              tooltip="components.vcsTable.formerPage"
+              :disabled="page < 2"
+              class="mx-2"
+            />
+            <VcsButton
+              small
+              icon="mdi-chevron-right"
+              @click="nextPage"
+              tooltip="components.vcsTable.nextPage"
+              :disabled="page > numberOfPages - 1"
+              class="mx-1"
+            />
+          </v-row>
+        </v-container>
+      </template>
+    </v-data-table>
+  </v-card>
+</template>
+<script>
+  import { getCurrentInstance, ref, computed } from 'vue';
+  import VcsTreeviewSearchbar from '../lists/VcsTreeviewSearchbar.vue';
+  import VcsButton from '../buttons/VcsButton.vue';
+
+  /**
+   * @typedef {Object} TableItem
+   * @property {string} key
+   * @property {string} value
+   */
+
+  /**
+   * @param {Object} attributes
+   * @param {Array<TableItem>} [items]
+   * @param {string} [parent]
+   * @returns {Array<TableItem>}
+   */
+  export function attributesToItems(attributes, items = [], parent = undefined) {
+    const nestedKey = (key, nested) => (nested ? `${nested}.${key}` : key);
+    Object.entries(attributes).forEach(([key, value]) => {
+      if (value instanceof Object) {
+        attributesToItems(value, items, nestedKey(key, parent));
+      } else {
+        const item = { key: nestedKey(key, parent), value };
+        if (parent) { item.group = parent; }
+        items.push(item);
+      }
+    });
+    return items;
+  }
+
+  /**
+   * @description A table view for feature attributes using {@link https://vuetifyjs.com/en/api/v-data-table/#props|vuetify v-data-table }
+   * @vue-prop {string} featureId - feature's id
+   * @vue-prop {Object} attributes - feature's attributes
+   * @vue-prop {Array<{text: string, value: string}>} [headers] - optional array defining column names
+   * @vue-prop {boolean} [showSearchbar=true] - whether to show searchbar
+   * @vue-prop {string} [searchbarPlaceholder='Search'] - placeholder for searchbar
+   * @vue-computed {Array<{key:string,value:string}>} items - from attributes derived table items
+   */
+  export default {
+    name: 'VcsTable',
+    components: { VcsButton, VcsTreeviewSearchbar },
+    props: {
+      featureId: {
+        type: String,
+        required: true,
+      },
+      attributes: {
+        type: Object,
+        required: true,
+      },
+      headers: {
+        type: Array,
+        default: () => [
+          { text: 'components.vcsTable.key', value: 'key', width: '160px' },
+          { text: 'components.vcsTable.value', value: 'value', width: '160px' },
+        ],
+      },
+      itemsPerPage: {
+        type: Number,
+        default: 10,
+      },
+      itemsPerPageArray: {
+        type: Array,
+        default: () => [5, 10, 15],
+      },
+      showSearchbar: {
+        type: Boolean,
+        default: true,
+      },
+      searchbarPlaceholder: {
+        type: String,
+        default: 'components.vcsTable.searchbarPlaceholder',
+      },
+    },
+    setup(props) {
+      const vm = getCurrentInstance().proxy;
+
+      const items = computed(() => {
+        return attributesToItems({
+          featureId: props.featureId,
+          ...props.attributes,
+        });
+      });
+
+      const translatedHeaders = computed(() => {
+        return props.headers.map((hd) => {
+          hd.text = vm.$t(hd.text);
+          return hd;
+        });
+      });
+
+      const itemsPerPageRef = ref(props.itemsPerPage);
+      const numberOfPages = computed(() => {
+        return Math.ceil(items.value.length / itemsPerPageRef.value);
+      });
+
+      const page = ref(1);
+      const itemsFrom = computed(() => ((page.value - 1) * itemsPerPageRef.value) + 1);
+      const itemsTo = computed(() => {
+        const last = page.value * itemsPerPageRef.value;
+        return last < items.value.length ? last : items.value.length;
+      });
+
+      /**
+       * @param {any} value
+       * @param {string} search
+       * @param {TableItem} item
+       * @returns {boolean}
+       */
+      // eslint-disable-next-line default-param-last
+      const handleFilter = (value, search = '', item) => {
+        const q = search.toLocaleLowerCase();
+        return [item.key, item.value].some((i) => {
+          const content = i.toString();
+          const translated = vm.$t(content);
+          return translated.toLowerCase().includes(q) || content.toLowerCase().includes(q);
+        });
+      };
+
+      return {
+        search: ref(''),
+        page,
+        items,
+        itemsPerPageRef,
+        itemsFrom,
+        itemsTo,
+        numberOfPages,
+        nextPage() {
+          if (page.value + 1 <= numberOfPages.value) {
+            page.value += 1;
+          }
+        },
+        formerPage() {
+          if (page.value - 1 >= 1) {
+            page.value -= 1;
+          }
+        },
+        updateItemsPerPage(number) {
+          itemsPerPageRef.value = number;
+        },
+        handleFilter,
+        translatedHeaders,
+      };
+    },
+  };
+</script>
+
+<style lang="scss"  scoped>
+.vcs-table {
+  td {
+    max-width: 160px;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+  }
+}
+</style>

package/src/contentTree/LayerTree.vue

@@ -10,7 +10,7 @@
 </template>
 
 <script>
-  import { inject } from '@vue/composition-api';
+  import { inject } from 'vue';
   import VcsTreeview from '../components/lists/VcsTreeview.vue';
 
   /**

package/src/contentTree/contentTreeCollection.js

@@ -1,7 +1,7 @@
 // eslint-disable-next-line max-classes-per-file
 import { IndexedCollection, makeOverrideCollection, getObjectFromClassRegistry } from '@vcmap/core';
 import { v4 as uuid } from 'uuid';
-import { computed, ref } from '@vue/composition-api';
+import { computed, ref } from 'vue';
 import ContentTreeItem from './contentTreeItem.js';
 import { vcsAppSymbol } from '../pluginHelper.js';
 import SubContentTreeItem, { subTreeSymbol } from './subContentTreeItem.js';
@@ -73,7 +73,7 @@ class ContentTreeCollection extends IndexedCollection {
      */
     this._defaultSubtreeItem = new SubContentTreeItem({ name: 'Content', icon: '$vcsLayers', title: 'content.title' }, app);
     /**
-     * @type {import("@vue/composition-api").Ref<Map<string, TreeViewItem>>}
+     * @type {import("vue").Ref<Map<string, TreeViewItem>>}
      * @private
      */
     this._subTreeViewItems = ref(new Map());
@@ -211,7 +211,7 @@ class ContentTreeCollection extends IndexedCollection {
 
   /**
    * @param {string} id
-   * @returns {import("@vue/composition-api").ComputedRef<Array<TreeViewItem>>}
+   * @returns {import("vue").ComputedRef<Array<TreeViewItem>>}
    */
   getComputedVisibleTree(id) {
     return computed(() => {
@@ -253,7 +253,7 @@ class ContentTreeCollection extends IndexedCollection {
 
   /**
    * @param {string} id
-   * @returns {import("@vue/composition-api").Ref<Array<string>>}
+   * @returns {import("vue").Ref<Array<string>>}
    */
   getTreeOpenStateRef(id) {
     const subTree = this._getSubTree(id);

package/src/contentTree/contentTreeItem.js

@@ -1,4 +1,4 @@
-import { ref, reactive, computed } from '@vue/composition-api';
+import { ref, reactive, computed } from 'vue';
 import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseNumber } from '@vcsuite/parsers';
 import { ClassRegistry, VcsEvent } from '@vcmap/core';
@@ -63,7 +63,7 @@ class ContentTreeItem {
     this._app = app;
 
     /**
-     * @type {import("@vue/composition-api").Ref<Array<VcsAction>>}
+     * @type {import("vue").Ref<Array<VcsAction>>}
      * @private
      */
     this._actions = ref([]);
@@ -76,28 +76,28 @@ class ContentTreeItem {
 
     /**
      * Whether to display this item or not.
-     * @type {import("@vue/composition-api").Ref<boolean>}
+     * @type {import("vue").Ref<boolean>}
      * @private
      */
     this._visible = ref(true);
 
     /**
      * Whether this item reacts to click events, e.g. with visual feedback
-     * @type {import("@vue/composition-api").Ref<boolean>}
+     * @type {import("vue").Ref<boolean>}
      * @private
      */
     this._clickable = ref(true);
 
     /**
      * Whether this item should be displayed as disabled.
-     * @type {import("@vue/composition-api").Ref<boolean>}
+     * @type {import("vue").Ref<boolean>}
      * @private
      */
     this._disabled = ref(false);
 
     /**
      * The state of this item. NONE if this item cannot have a state.
-     * @type {import("@vue/composition-api").Ref<StateActionState>}
+     * @type {import("vue").Ref<StateActionState>}
      * @private
      */
     this._state = ref(StateActionState.NONE);
@@ -116,20 +116,20 @@ class ContentTreeItem {
     this.infoUrl = options.infoUrl;
 
     /**
-     * @type {import("@vue/composition-api").Ref<Object<string, string>|string|undefined>}
+     * @type {import("vue").Ref<Object<string, string>|string|undefined>}
      * @private
      */
     this._title = ref(options.title);
 
     /**
      * An optional icon to display with this item. Can be an URL or HTMLElement.
-     * @type {import("@vue/composition-api").Ref<string|HTMLCanvasElement|HTMLImageElement|undefined>}
+     * @type {import("vue").Ref<string|HTMLCanvasElement|HTMLImageElement|undefined>}
      * @private
      */
     this._icon = ref(options.icon);
 
     /**
-     * @type {import("@vue/composition-api").Ref<Array<TreeViewItem>>}
+     * @type {import("vue").Ref<Array<TreeViewItem>>}
      * @protected
      */
     this._children = ref([]);

package/src/contentTree/groupContentTreeItem.js

@@ -1,4 +1,4 @@
-import { watch } from '@vue/composition-api';
+import { watch } from 'vue';
 import ContentTreeItem, { contentTreeClassRegistry } from './contentTreeItem.js';
 import { StateActionState } from '../actions/stateRefAction.js';
 

package/src/contentTree/layerContentTreeItem.js

@@ -1,5 +1,5 @@
 import { ViewPoint } from '@vcmap/core';
-import { reactive } from '@vue/composition-api';
+import { reactive } from 'vue';
 import { StateActionState } from '../actions/stateRefAction.js';
 import { createGoToViewpointAction, createModalAction } from '../actions/actionHelper.js';
 import component from '../actions/styleSelector.vue';
@@ -10,6 +10,7 @@ import { contentTreeClassRegistry } from './contentTreeItem.js';
 /**
  * @typedef {ContentTreeItemOptions} LayerContentTreeItemOptions
  * @property {string} layerName
+ * @property {Array<string>} layerNamesToDeactivate list of LayerNames which should be deactivated if the click activates the layer
  */
 
 /**
@@ -80,6 +81,14 @@ class LayerContentTreeItem extends VcsObjectContentTreeItem {
      */
     this._layerName = options.layerName;
 
+    /**
+     * @type {Array<string>}
+     * @private
+     */
+    this._layerNamesToDeactivate = Array.isArray(options.layerNamesToDeactivate) ?
+      options.layerNamesToDeactivate.slice() :
+      [];
+
     /**
      * @type {Array<Function>}
      * @private
@@ -210,6 +219,10 @@ class LayerContentTreeItem extends VcsObjectContentTreeItem {
     if (this._layer) {
       if (this.state === StateActionState.INACTIVE) {
         await this._layer.activate();
+        this._layerNamesToDeactivate
+          .map(n => this._app.layers.getByKey(n))
+          .filter(l => l)
+          .forEach(l => l.deactivate());
       } else {
         this._layer.deactivate();
       }
@@ -222,6 +235,7 @@ class LayerContentTreeItem extends VcsObjectContentTreeItem {
   toJSON() {
     const config = super.toJSON();
     config.layerName = this._layerName;
+    config.layerNamesToDeactivate = this._layerNamesToDeactivate.slice();
     return config;
   }
 

package/src/contentTree/layerGroupContentTreeItem.js

@@ -4,7 +4,8 @@ import { StateActionState } from '../actions/stateRefAction.js';
 
 /**
  * @typedef {ContentTreeItemOptions} LayerGroupContentTreeItemOptions
- * @property {Array<string>} layerNames
+ * @property {Array<string>} layerNames list of LayerNames which should be activated on click
+ * @property {Array<string>} layerNamesToDeactivate list of LayerNames which should be deactivated on click if the click activates the layer in layerNames
  * @property {string} [defaultViewpoint] - the name of an optional default viewpoint
  */
 
@@ -55,6 +56,14 @@ class LayerGroupContentTreeItem extends ContentTreeItem {
       options.layerNames.slice() :
       [];
 
+    /**
+     * @type {Array<string>}
+     * @private
+     */
+    this._layerNamesToDeactivate = Array.isArray(options.layerNamesToDeactivate) ?
+      options.layerNamesToDeactivate.slice() :
+      [];
+
     /**
      * @type {Array<function():void>}
      * @private
@@ -122,11 +131,18 @@ class LayerGroupContentTreeItem extends ContentTreeItem {
     }));
   }
 
+  /**
+   * @returns {Promise<void>}
+   */
   async clicked() {
     const layers = this._layers;
     const activate = layers.some(l => !(l.active || l.loading));
     if (activate) {
       await Promise.all(layers.map(l => l.activate()));
+      this._layerNamesToDeactivate
+        .map(n => this._app.layers.getByKey(n))
+        .filter(l => l)
+        .forEach(l => l.deactivate());
     } else {
       layers.forEach((l) => { l.deactivate(); });
     }
@@ -138,12 +154,16 @@ class LayerGroupContentTreeItem extends ContentTreeItem {
   toJSON() {
     const config = super.toJSON();
     config.layerNames = this._layerNames.slice();
+    config.layerNamesToDeactivate = this._layerNamesToDeactivate.slice();
     if (this._defaultViewpoint) {
       config.defaultViewpoint = this._defaultViewpoint;
     }
     return config;
   }
 
+  /**
+   * @inheritDoc
+   */
   destroy() {
     this._clearListeners();
     super.destroy();

package/src/contentTree/nodeContentTreeItem.js

@@ -1,4 +1,4 @@
-import { watch } from '@vue/composition-api';
+import { watch } from 'vue';
 import ContentTreeItem, { contentTreeClassRegistry } from './contentTreeItem.js';
 
 /**

package/src/featureInfo/AddressBalloonComponent.vue

@@ -0,0 +1,47 @@
+<template>
+  <BalloonComponent
+    v-bind="{...$attrs}"
+  >
+    <template #default="{ attrs }">
+      <v-list-item two-line v-if="Object.values(attrs.attributes).length > 0">
+        <v-list-item-avatar
+          tile
+          size="40"
+        >
+          <v-icon size="20" color="secondary">
+            $vcsHomePoint
+          </v-icon>
+        </v-list-item-avatar>
+        <v-list-item-content>
+          <v-list-item-title v-if="attrs.attributes.addressName">
+            {{ attrs.attributes.addressName }}
+          </v-list-item-title>
+          <v-list-item-title v-else>
+            {{ attrs.attributes.street }} {{ attrs.attributes.number }}
+          </v-list-item-title>
+          <v-list-item-subtitle v-if="attrs.attributes.name">
+            {{ attrs.attributes.street }} {{ attrs.attributes.number }}
+          </v-list-item-subtitle>
+          <v-list-item-subtitle>{{ attrs.attributes.zip }} {{ attrs.attributes.city }}</v-list-item-subtitle>
+          <v-list-item-subtitle>{{ attrs.attributes.country }}</v-list-item-subtitle>
+        </v-list-item-content>
+      </v-list-item>
+    </template>
+  </BalloonComponent>
+</template>
+<script>
+
+  import BalloonComponent from './BalloonComponent.vue';
+
+  /**
+   * @description A balloon viewing address information
+   */
+  export default {
+    name: 'AddressBalloonComponent',
+    components: { BalloonComponent },
+  };
+</script>
+
+<style>
+
+</style>

package/src/featureInfo/BalloonComponent.vue

@@ -0,0 +1,138 @@
+<template>
+  <v-card
+    class="mx-auto"
+    max-width="400"
+    v-if="position"
+  >
+    <slot name="balloon-header" :attrs="{...$props, ...$attrs}">
+      <v-list-item two-line>
+        <v-list-item-avatar
+          tile
+          size="40"
+        >
+          <v-icon color="primary">
+            $vcsInfo
+          </v-icon>
+        </v-list-item-avatar>
+        <v-list-item-content>
+          <v-list-item-title class="text-h5">
+            {{ title }}
+          </v-list-item-title>
+          <v-list-item-subtitle>{{ subtitle }}</v-list-item-subtitle>
+        </v-list-item-content>
+        <VcsButton
+          @click.stop="close"
+          small
+          icon="mdi-close-thick"
+          class="mb-8"
+        />
+      </v-list-item>
+    </slot>
+
+    <v-divider />
+
+    <v-card class="overflow-y-auto" max-height="250">
+      <slot :attrs="{...$props, ...$attrs}">
+        <v-list v-for="(value, name, index) in attributes" :key="`attribute-${index}`">
+          <v-list-item>
+            <v-list-item-content>
+              <v-list-item-title>
+                {{ name }}
+              </v-list-item-title>
+              <v-list-item-subtitle>{{ value }}</v-list-item-subtitle>
+            </v-list-item-content>
+          </v-list-item>
+        </v-list>
+      </slot>
+    </v-card>
+  </v-card>
+</template>
+<script>
+
+  import { inject, onMounted, onUnmounted, watch } from 'vue';
+  import { setupBalloonPositionListener } from './balloonHelper.js';
+
+  /**
+   * @description A balloon viewing feature attributes. Size dynamic dependent on number of attributes.
+   * Scrollable, if more than 6 attributes are provided.
+   * @vue-prop {string} featureId - feature's id
+   * @vue-prop {string} title - balloon title
+   * @vue-prop {string} subtitle - balloon subtitle
+   * @vue-prop {Object} attributes - feature's attributes
+   * @vue-prop {Array<import("ol/coordinate").Coordinate>} position - clicked position balloon is rendered at
+   * @vue-data {slot} [#balloon-header] - slot to override balloon header, $props and $attrs are passed to `attrs`
+   * @vue-data {slot} [#default] - slot to override balloon content, $props and $attrs are passed to `attrs`
+   */
+  export default {
+    name: 'BalloonComponent',
+    props: {
+      featureId: {
+        type: String,
+        required: true,
+      },
+      title: {
+        type: String,
+        required: true,
+      },
+      subtitle: {
+        type: String,
+        required: true,
+      },
+      attributes: {
+        type: Object,
+        required: true,
+      },
+      position: {
+        type: Array,
+        default: null,
+      },
+    },
+    setup(props, { attrs }) {
+      const app = inject('vcsApp');
+      const windowId = attrs['window-state'].id;
+
+      let balloonPositionListener = null;
+      const destroyListener = () => {
+        if (balloonPositionListener) {
+          balloonPositionListener();
+        }
+      };
+
+      onMounted(async () => {
+        balloonPositionListener = await setupBalloonPositionListener(app, windowId, props.position);
+      });
+
+      watch(() => props.featureId, async () => {
+        destroyListener();
+        balloonPositionListener = await setupBalloonPositionListener(app, windowId, props.position);
+      });
+
+      onUnmounted(() => {
+        destroyListener();
+      });
+
+      const close = () => {
+        app.windowManager.remove(attrs['window-state'].id);
+        destroyListener();
+      };
+
+      return {
+        close,
+      };
+    },
+  };
+</script>
+
+<style>
+.balloon:before {
+  content: "";
+  position: absolute;
+  bottom: -20px;
+  left: 40px;
+  border-width: 20px 20px 0;
+  border-style: solid;
+  border-color: white transparent;
+  display: block;
+  width: 0;
+}
+</style>