From 4ee081079544474b513427abe1c71f82965826d4 Mon Sep 17 00:00:00 2001 From: Pascal Roehling Date: Fri, 26 Jul 2024 17:44:59 +0200 Subject: [PATCH 01/15] Remove unnecessary package --- package-lock.json | 32 ++++++-------------------------- package.json | 1 - 2 files changed, 6 insertions(+), 27 deletions(-) diff --git a/package-lock.json b/package-lock.json index b5afce72e..79d5421d6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -39,7 +39,6 @@ "@types/node": "^17.0.8", "@types/ol": "^6.5.3", "@types/proj4": "^2.5.2", - "@types/sass": "^1.43.1", "@typescript-eslint/eslint-plugin": "^5.9.0", "@typescript-eslint/parser": "^5.9.0", "@vitejs/plugin-vue2": "^2.2.0", @@ -6078,16 +6077,6 @@ "integrity": "sha512-lX55lR0iYCgapxD3IrgujpQA1zDxwZI5qMRelKvmKAsSMplFVr7wmMpG7/6+Op2tjrgEex8o3vjg8CRDrRNYxg==", "dev": true }, - "node_modules/@types/sass": { - "version": "1.45.0", - "resolved": "https://registry.npmjs.org/@types/sass/-/sass-1.45.0.tgz", - "integrity": "sha512-jn7qwGFmJHwUSphV8zZneO3GmtlgLsmhs/LQyVvQbIIa+fzGMUiHI4HXJZL3FT8MJmgXWbLGiVVY7ElvHq6vDA==", - "deprecated": "This is a stub types definition. sass provides its own type definitions, so you do not need this installed.", - "dev": true, - "dependencies": { - "sass": "*" - } - }, "node_modules/@types/semver": { "version": "7.5.8", "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.8.tgz", @@ -6399,9 +6388,9 @@ } }, "node_modules/@vue/compiler-sfc/node_modules/postcss": { - "version": "8.4.39", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.39.tgz", - "integrity": "sha512-0vzE+lAiG7hZl1/9I8yzKLx3aR9Xbof3fBHKunvMfOCYAtMhrsnccJY2iTURb9EZd5+pLuiNV9/c/GZJOHsgIw==", + "version": "8.4.40", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.40.tgz", + "integrity": "sha512-YF2kKIUzAofPMpfH6hOi2cGnv/HrUlfucspc7pDyvv7kGdqXrfj8SCl/t8owkEgKEuu8ZcRjSOxFxVLqwChZ2Q==", "funding": [ { "type": "opencollective", @@ -26429,15 +26418,6 @@ "integrity": "sha512-lX55lR0iYCgapxD3IrgujpQA1zDxwZI5qMRelKvmKAsSMplFVr7wmMpG7/6+Op2tjrgEex8o3vjg8CRDrRNYxg==", "dev": true }, - "@types/sass": { - "version": "1.45.0", - "resolved": "https://registry.npmjs.org/@types/sass/-/sass-1.45.0.tgz", - "integrity": "sha512-jn7qwGFmJHwUSphV8zZneO3GmtlgLsmhs/LQyVvQbIIa+fzGMUiHI4HXJZL3FT8MJmgXWbLGiVVY7ElvHq6vDA==", - "dev": true, - "requires": { - "sass": "*" - } - }, "@types/semver": { "version": "7.5.8", "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.8.tgz", @@ -26639,9 +26619,9 @@ }, "dependencies": { "postcss": { - "version": "8.4.39", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.39.tgz", - "integrity": "sha512-0vzE+lAiG7hZl1/9I8yzKLx3aR9Xbof3fBHKunvMfOCYAtMhrsnccJY2iTURb9EZd5+pLuiNV9/c/GZJOHsgIw==", + "version": "8.4.40", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.40.tgz", + "integrity": "sha512-YF2kKIUzAofPMpfH6hOi2cGnv/HrUlfucspc7pDyvv7kGdqXrfj8SCl/t8owkEgKEuu8ZcRjSOxFxVLqwChZ2Q==", "requires": { "nanoid": "^3.3.7", "picocolors": "^1.0.1", diff --git a/package.json b/package.json index a39d3fb90..98df0bf47 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,6 @@ "@types/node": "^17.0.8", "@types/ol": "^6.5.3", "@types/proj4": "^2.5.2", - "@types/sass": "^1.43.1", "@typescript-eslint/eslint-plugin": "^5.9.0", "@typescript-eslint/parser": "^5.9.0", "@vitejs/plugin-vue2": "^2.2.0", From d8a74ae8462e1a2feb98282a5e620fff7f1ed041 Mon Sep 17 00:00:00 2001 From: Pascal Roehling Date: Mon, 29 Jul 2024 18:54:13 +0200 Subject: [PATCH 02/15] Fix search after removal of events The dependency is now placed at its correct place. --- package-lock.json | 14 ++++++++++++++ packages/core/CHANGELOG.md | 1 + packages/core/package.json | 1 + 3 files changed, 16 insertions(+) diff --git a/package-lock.json b/package-lock.json index 79d5421d6..cc315f458 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,6 +13,7 @@ "@repositoryname/vuex-generators": "^1.1.2", "@turf/flatten": "^6.5.0", "@turf/union": "^6.5.0", + "events": "^3.3.0", "focus-trap": "^7.2.0", "hammerjs": "2.0.8", "i18next": "^23.11.5", @@ -10156,6 +10157,14 @@ "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", "dev": true }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "engines": { + "node": ">=0.8.x" + } + }, "node_modules/execa": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", @@ -29377,6 +29386,11 @@ "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", "dev": true }, + "events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==" + }, "execa": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index 7a76b3dd8..ea0de314f 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -5,6 +5,7 @@ - Feature: Add new state parameter `mapHasDimensions` to let plugins have a "hook" to react on when the map is ready. - Feature: Add `deviceIsHorizontal` as a getter to have a more central place to check if the device is in landscape mode. - Fix: Adjust documentation to properly describe optionality of configuration parameters. +- Fix: Add package `events` as a dependency to fix issue with `xml2js`. See https://github.com/Leonidas-from-XIV/node-xml2js/issues/697 for more information. - Chore: Update dependencies to latest versions. ## 1.4.1 diff --git a/packages/core/package.json b/packages/core/package.json index fb7154ddf..4080924f3 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -20,6 +20,7 @@ "@polar/lib-invisible-style": "^1.0.0", "@repositoryname/noop": "^1.0.6", "@repositoryname/vuex-generators": "^1.1.2", + "events": "^3.3.0", "hammerjs": "2.0.8", "i18next": "^23.11.5", "i18next-browser-languagedetector": "^8.0.0", From bef79779933496a3a7b32c190fd0bb2795eb603a Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Tue, 30 Jul 2024 10:11:58 +0200 Subject: [PATCH 03/15] Remove whitespaces from tables within Readme-files --- packages/core/README.md | 12 +-- packages/lib/testMountParameters/README.md | 2 +- packages/plugins/AddressSearch/README.md | 92 ++++++++++----------- packages/plugins/Attributions/README.md | 20 ++--- packages/plugins/Draw/README.md | 18 ++-- packages/plugins/Export/README.md | 10 +-- packages/plugins/Fullscreen/README.md | 4 +- packages/plugins/GeoLocation/README.md | 8 +- packages/plugins/Gfi/README.md | 32 +++---- packages/plugins/LayerChooser/README.md | 28 +++---- packages/plugins/LoadingIndicator/README.md | 2 +- packages/plugins/Pins/README.md | 34 ++++---- packages/plugins/ReverseGeocoder/README.md | 12 +-- packages/plugins/Toast/README.md | 28 +++---- packages/plugins/Zoom/README.md | 14 ++-- 15 files changed, 158 insertions(+), 158 deletions(-) diff --git a/packages/core/README.md b/packages/core/README.md index 9cf7e2094..09b76f26f 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -69,14 +69,14 @@ MapClient.createMap({ The mapConfiguration allows controlling many client instance details. -| fieldName | type | description | +| fieldName | type | description | | --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| layerConf | LayerConf | Layer configuration as required by masterportalAPI. | -| language | enum["de", "en"] | Initial language. | -| <...masterportalAPI.fields> | various | The object is also used to initialize the masterportalAPI. Please refer to their documentation for options. | -| | various? | Many plugins added with `addPlugin` may respect additional configuration. Please see the respective plugin documentations. Global plugin parameters are described below. | +| layerConf | LayerConf | Layer configuration as required by masterportalAPI. | +| language | enum["de", "en"] | Initial language. | +| <...masterportalAPI.fields> | various | The object is also used to initialize the masterportalAPI. Please refer to their documentation for options. | +| | various? | Many plugins added with `addPlugin` may respect additional configuration. Please see the respective plugin documentations. Global plugin parameters are described below. | | locales | LanguageOption[]? | All locales in POLAR's plugins can be overridden to fit your needs.| -| vuetify | object? | You may add vuetify configuration here. | +| vuetify | object? | You may add vuetify configuration here. | | extendedMasterportalapiMarkers | extendedMasterportalapiMarkers? | Optional. If set, all configured visible vector layers' features can be hovered and selected by mouseover and click respectively. They are available as features in the store. Layers with `clusterDistance` will be clustered to a multi-marker that supports the same features. Please mind that this only works properly if you configure nothing but point marker vector layers styled by the masterportalAPI. | | stylePath | string? | If no link tag with `data-polar="true"` is found in the document, this path will be used to create the link node in the client itself. It defaults to `'./style.css'`. Please mind that `data-polar="true"` is deprecated since it potentially led to flashes of misstyled content. stylePath will replace that solution in the next major release. | | renderFaToLightDom | boolean? | POLAR requires FontAwesome in the Light/Root DOM due to an [unfixed bug in many browsers](https://bugs.chromium.org/p/chromium/issues/detail?id=336876). This value defaults to `true`. POLAR will, by default, just add the required CSS by itself. Should you have a version of Fontawesome already included, you can try to set this to `false` to check whether the versions are interoperable. | diff --git a/packages/lib/testMountParameters/README.md b/packages/lib/testMountParameters/README.md index 9e2a69bfc..6c066dda3 100644 --- a/packages/lib/testMountParameters/README.md +++ b/packages/lib/testMountParameters/README.md @@ -1,4 +1,4 @@ # createTestMountParameters -This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module. +This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module. This is mostly done to avoid boilerplate code. For regularly used test contents, feel free to extend the returned contents. diff --git a/packages/plugins/AddressSearch/README.md b/packages/plugins/AddressSearch/README.md index b67b017e0..4dc0ac7fb 100644 --- a/packages/plugins/AddressSearch/README.md +++ b/packages/plugins/AddressSearch/README.md @@ -22,32 +22,32 @@ It is advised to either use one-search-per-group _or_ all services in a singular In `categoryProperties` and `groupProperties`, id strings called `groupId` and `categoryId` are used. These are arbitrary strings you can introduce and reuse to group or categorize elements together. Regarding what groups and categories are, see further below. -| fieldName | type | description | +| fieldName | type | description | | ------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| searchMethods | searchMethodsObject[] | Array of search method descriptions. Only searches configured here can be used. | +| searchMethods | searchMethodsObject[] | Array of search method descriptions. Only searches configured here can be used. | | afterResultComponent | VueConstructor? | If given, this component will be rendered in the last line of every single search result. It will be forwarded its search result feature as prop `feature` of type `GeoJSON.Feature`, and the focus state of the result as prop `focus` of type `boolean`. | | addLoading | string? | Optional loading action name to start loading. | -| categoryProperties | Record? | An object defining properties for a category. The searchMethod's categoryId is used as identifier. A service without categoryId does not have a fallback category. | -| customSearchMethods | Record? | An object with named search functions added to the existing set of configurable search methods. (See `addressSearch.searchMethodsObject.type`) This record's keys are added to that enum. | -| customSelectResult | Record? | An object that maps categoryIds to functions. These functions are then called as vuex store actions instead of the `selectResult` default implementation. This allows overriding selection behaviour with full store access. Use `''` as key for categoryless results. | +| categoryProperties | Record? | An object defining properties for a category. The searchMethod's categoryId is used as identifier. A service without categoryId does not have a fallback category. | +| customSearchMethods | Record? | An object with named search functions added to the existing set of configurable search methods. (See `addressSearch.searchMethodsObject.type`) This record's keys are added to that enum. | +| customSelectResult | Record? | An object that maps categoryIds to functions. These functions are then called as vuex store actions instead of the `selectResult` default implementation. This allows overriding selection behaviour with full store access. Use `''` as key for categoryless results. | | focusAfterSearch | boolean? | Whether the focus should switch to the first result after a successful search. Defaults to `false`. | -| groupProperties | Record? | An object defining properties for a group. The searchMethod's groupId is used as identifier. All services without groupId fall back to the key `"defaultGroup"`. | -| minLength | number? | Minimal input length after which searches are started. Defaults to 0. | +| groupProperties | Record? | An object defining properties for a group. The searchMethod's groupId is used as identifier. All services without groupId fall back to the key `"defaultGroup"`. | +| minLength | number? | Minimal input length after which searches are started. Defaults to 0. | | removeLoading | string? | Optional loading action name to end loading. | -| waitMs | number? | Debounce time in ms for search requests after last user input. Defaults to 0. | +| waitMs | number? | Debounce time in ms for search requests after last user input. Defaults to 0. | #### addressSearch.searchMethodsObject -| fieldName | type | description | +| fieldName | type | description | | --------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | enum["bkg", "gazetteer", "wfs", "mpapi"] | Service type. Enum can be extended by configuration, see `addressSearch.customSearchMethods`. ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. | -| url | string | Search service URL. Should you require a service provider, please contact us for further information. | -| categoryId | string? | Grouped services can optionally be distinguished in the UI with categories. See `addressSearch.categoryProperties` for configuration options. | -| groupId | string? | Default groupId is `"defaultGroup"`. All services with the same id are grouped and used together. See `addressSearch.groupProperties` for configuration options. If multiple groups exist, the UI offers a group switcher. | -| hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. If grouped with other services, the group's hint will be used instead. | -| label | string? | Display label. Can be a locale key. If grouped with other services, the group's label will be used instead. | -| placeholder | string? | Placeholder string to display on input element. Can be a locale key. If grouped with other services, the group's placeholder will be used instead. | -| queryParameters | object? | The object further describes details for the search request. Its contents vary by service type, see documentation below. | +| type | enum["bkg", "gazetteer", "wfs", "mpapi"] | Service type. Enum can be extended by configuration, see `addressSearch.customSearchMethods`. ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. | +| url | string | Search service URL. Should you require a service provider, please contact us for further information. | +| categoryId | string? | Grouped services can optionally be distinguished in the UI with categories. See `addressSearch.categoryProperties` for configuration options. | +| groupId | string? | Default groupId is `"defaultGroup"`. All services with the same id are grouped and used together. See `addressSearch.groupProperties` for configuration options. If multiple groups exist, the UI offers a group switcher. | +| hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. If grouped with other services, the group's hint will be used instead. | +| label | string? | Display label. Can be a locale key. If grouped with other services, the group's label will be used instead. | +| placeholder | string? | Placeholder string to display on input element. Can be a locale key. If grouped with other services, the group's placeholder will be used instead. | +| queryParameters | object? | The object further describes details for the search request. Its contents vary by service type, see documentation below. | #### addressSearch.customSearchMethod @@ -87,38 +87,38 @@ With this, arbitrary click results can be supported. Please mind that undocument #### addressSearch.groupProperties -| fieldName | type | description | +| fieldName | type | description | | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| label | string | Display label. Can be a locale key. | +| label | string | Display label. Can be a locale key. | | resultDisplayMode | enum['mixed', 'categorized'] | Defaults to `'mixed'`. In `'mixed'`, results of all requested services are offered in a list in no specific order. In `'categorized'`, the results are listed by their searchService's categoryId. | -| hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. | -| limitResults | number? | If set, only the first `n` results (per category in `categorized`) are displayed initially. All further results can be opened via UI. | -| placeholder | string? | Placeholder string to display on input element. Can be a locale key. | +| hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. | +| limitResults | number? | If set, only the first `n` results (per category in `categorized`) are displayed initially. All further results can be opened via UI. | +| placeholder | string? | Placeholder string to display on input element. Can be a locale key. | #### addressSearch.categoryProperties -| fieldName | type | description | +| fieldName | type | description | | --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| label | string | Category label to display next to results to identify the source. Can be a locale key. Only relevant if the search's `groupProperties` linked via `groupId` contain a `resultDisplayMode` scenario that uses categories. | +| label | string | Category label to display next to results to identify the source. Can be a locale key. Only relevant if the search's `groupProperties` linked via `groupId` contain a `resultDisplayMode` scenario that uses categories. | ##### addressSearch.searchMethodsObject.queryParameters (type:common) These fields are interpreted by all implemented services. -| fieldName | type | description | +| fieldName | type | description | | ----------- | ------ | --------------------------------------- | | maxFeatures | number? | Maximum amount of features to retrieve. Doesn't limit results if not set. | ##### addressSearch.searchMethodsObject.queryParameters (type:wfs) -| fieldName | type | description | +| fieldName | type | description | | ------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| featurePrefix | string | XML feature prefix for WFS service. | -| typeName | string | Feature type to search for by name. | -| xmlns | string | XML namespace to use in search. | +| featurePrefix | string | XML feature prefix for WFS service. | +| typeName | string | Feature type to search for by name. | +| xmlns | string | XML namespace to use in search. | | fieldName | string? | Name of the type's field to search in. Mutually exclusive to `patterns`. | -| patterns | string[]? | Allows specifying input patterns. In a single-field search, a pattern can be as easy as `{{theWholeThing}}`, where `theWholeThing` is also the feature field name to search in. In more complex scenarios, you may add separators and multiple fields, e.g. `{{gemarkung}} {{flur}} {{flstnrzae}}/{{flstnrnen}}` would fit many parcel search services. Mutually exclusive to `fieldName`. | -| patternKeys | Record? | Maps field names from patterns to regexes. Each field name has to have a definition. Each regex must have one capture group that is used to search. Contents next to it are ignored for the search and just used for matching. E.g. `'([0-9]+)$'` would be a value for a key that fits an arbitrary number string at the input's end. | +| patterns | string[]? | Allows specifying input patterns. In a single-field search, a pattern can be as easy as `{{theWholeThing}}`, where `theWholeThing` is also the feature field name to search in. In more complex scenarios, you may add separators and multiple fields, e.g. `{{gemarkung}} {{flur}} {{flstnrzae}}/{{flstnrnen}}` would fit many parcel search services. Mutually exclusive to `fieldName`. | +| patternKeys | Record? | Maps field names from patterns to regexes. Each field name has to have a definition. Each regex must have one capture group that is used to search. Contents next to it are ignored for the search and just used for matching. E.g. `'([0-9]+)$'` would be a value for a key that fits an arbitrary number string at the input's end. | | srsName | string? | Name of the projection (srs) for the query. | | useRightHandWildcard? | boolean? | By default, if searching for "search", it is sent as "search*". This behaviour can be deactivated by setting this parameter to `false`. | @@ -128,27 +128,27 @@ Since inputs may overlap with multiple patterns, multiple queries are fired and > ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. -| fieldName | type | description | +| fieldName | type | description | | ------------- | -------- | ------------------------------------------------------------------------------------------------------------- | | epsg | `EPSG:${string}` | EPSG code of the projection to use. | -| fieldName | string[] | Field names of service to search in. | -| memberSuffix | string | Elements to interpret are fetched from response XML as `wfs:memberSuffix`; fitting suffix must be configured. | -| namespaces | string \| string[] | Namespaces to add to the request. | -| storedQueryId | string | Name of the WFS-G stored query that is to be used. | +| fieldName | string[] | Field names of service to search in. | +| memberSuffix | string | Elements to interpret are fetched from response XML as `wfs:memberSuffix`; fitting suffix must be configured. | +| namespaces | string \| string[] | Namespaces to add to the request. | +| storedQueryId | string | Name of the WFS-G stored query that is to be used. | | version | '1.1.0' \| '2.0.0'? | WFS version used. Defaults to `'2.0.0'`. | ##### addressSearch.searchMethodsObject.queryParameters (type:mpapi) > **Please mind that this requires a configured backend. A WFS's Stored Query is requested with predefined parameters using the [masterportalApi](https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/). This implementation is meant for e.g. https://geodienste.hamburg.de/HH_WFS_GAGES, but works with other WFS configured in the same manner.** -| fieldName | Type | Description | +| fieldName | Type | Description | | ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| searchAddress | Boolean? | Defines whether address search is active. For backward compatibility, if "searchAddress" is not configured, the "searchAddress" attribute is set to "true" when "searchStreets" and "searchHouseNumbers" are set to "true". | -| searchDistricts | Boolean? | Defines whether district search is active. | -| searchHouseNumbers | Boolean? | Defines whether house numbers should be searched for. Requires `searchStreets` to be set to `true`, too. | -| searchParcels | Boolean? | Defines whether parcels search is active. | -| searchStreetKey | Boolean? | Defines whether streets should be searched for by key. | -| searchStreets | Boolean? | Defines whether street search is active. Precondition to set `searchHouseNumbers` to `true`. | +| searchAddress | Boolean? | Defines whether address search is active. For backward compatibility, if "searchAddress" is not configured, the "searchAddress" attribute is set to "true" when "searchStreets" and "searchHouseNumbers" are set to "true". | +| searchDistricts | Boolean? | Defines whether district search is active. | +| searchHouseNumbers | Boolean? | Defines whether house numbers should be searched for. Requires `searchStreets` to be set to `true`, too. | +| searchParcels | Boolean? | Defines whether parcels search is active. | +| searchStreetKey | Boolean? | Defines whether streets should be searched for by key. | +| searchStreets | Boolean? | Defines whether street search is active. Precondition to set `searchHouseNumbers` to `true`. | While all fields are optional, configuring none of them will yield undefined behaviour. At least one search instruction should be set to `true`. @@ -158,7 +158,7 @@ In _BKG_ mode, queryParameter's key-value pairs are used in the service query. E For more options, please check the [official documentation](https://sg.geodatenzentrum.de/web_public/gdz/dokumentation/deu/geokodierungsdienst.pdf) regarding what query parameters are interpreted. -Additionally, it is possible to configure the parameters `accesstoken` (`Authorization`) or `apiKey` (custom header `X-Api-Key`) to send the described headers to the search service for authentication purposes. +Additionally, it is possible to configure the parameters `accesstoken` (`Authorization`) or `apiKey` (custom header `X-Api-Key`) to send the described headers to the search service for authentication purposes. Note that this changes the request to be non-simple. To be able to use the parameters, the request has to be sent in [`cors` mode](https://developer.mozilla.org/en-US/docs/Web/API/Request/mode) and has to support preflight request `OPTIONS`. ## Store @@ -193,9 +193,9 @@ map.$store.dispatch('plugin/addressSearch/search', { The payload object supports the following fields: -| fieldName | type | description | +| fieldName | type | description | | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| input | string | Search string to be used. | +| input | string | Search string to be used. | | autoselect | enum['first', 'only', 'never'] | By default, 'never' is selected, and results will be presented as if the user searched for them. Setting 'only' will autoselect if a single result was returned; setting 'first' will autoselect the first of an arbitrary amount of results >=1. | ### State diff --git a/packages/plugins/Attributions/README.md b/packages/plugins/Attributions/README.md index e5a028280..ee1d50dde 100644 --- a/packages/plugins/Attributions/README.md +++ b/packages/plugins/Attributions/README.md @@ -10,18 +10,18 @@ This plugin shows attributions (that is, legal information) regarding copyrights All parameters are optional. However, setting neither `layerAttributions` nor `staticAttributions` results in an empty window. -| fieldName | type | description | +| fieldName | type | description | | ------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| initiallyOpen | boolean? | Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this. | -| layerAttributions | layerAttribution[]? | List of attributions that are shown when the matching layer is visible. | -| listenToChanges | string[]? | Store variable paths to listen to for changes. Will update the currently visible layers depending on the current map state on changes to these values. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | -| renderType | 'iconMenu' \| 'independent'? | Whether this plugin ('independent') or the IconMenu should handle opening the information box. Defaults to 'independent'. | -| staticAttributions | string[]? | List of static attributions that are always shown. | -| windowWidth | number? | If `renderType` is set to `independent`, sets the width of the container of the attributions. Defaults to 500. | +| initiallyOpen | boolean? | Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this. | +| layerAttributions | layerAttribution[]? | List of attributions that are shown when the matching layer is visible. | +| listenToChanges | string[]? | Store variable paths to listen to for changes. Will update the currently visible layers depending on the current map state on changes to these values. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | +| renderType | 'iconMenu' \| 'independent'? | Whether this plugin ('independent') or the IconMenu should handle opening the information box. Defaults to 'independent'. | +| staticAttributions | string[]? | List of static attributions that are always shown. | +| windowWidth | number? | If `renderType` is set to `independent`, sets the width of the container of the attributions. Defaults to 500. | #### attributions.layerAttribution -| fieldName | type | description | +| fieldName | type | description | | --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| id | string | ID of service the attribution relates to. The text will only be shown when the layer is visible. | -| title | string | Attribution text or localization key. May contain HTML. The tags `` and `` are translated to the current year or month respectively. | +| id | string | ID of service the attribution relates to. The text will only be shown when the layer is visible. | +| title | string | Attribution text or localization key. May contain HTML. The tags `` and `` are translated to the current year or month respectively. | diff --git a/packages/plugins/Draw/README.md b/packages/plugins/Draw/README.md index 7070b1c5e..10b831a75 100644 --- a/packages/plugins/Draw/README.md +++ b/packages/plugins/Draw/README.md @@ -31,25 +31,25 @@ The styling of the drawn features can be configured to overwrite the default ol- ### draw -| fieldName | type | description | +| fieldName | type | description | | ------------------- | -------- | ---------------------------------------------------------------------------- | | selectableDrawModes | string[]? | List 'Point', 'LineString', 'Circle', 'Text' and/or 'Polygon' as desired. All besides 'Text' are selectable by default. | -| style | style? | Please see example below for styling options. Defaults to standard OpenLayers styling. | -| textStyle | object? | Use this object with properties 'font' and 'textColor' to style text feature. | +| style | style? | Please see example below for styling options. Defaults to standard OpenLayers styling. | +| textStyle | object? | Use this object with properties 'font' and 'textColor' to style text feature. | ##### draw.textStyle -| fieldName | type | description | +| fieldName | type | description | | --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| font | object \| string | Style the font of the text feature with either css font properties or use font as an object with properties 'size' and 'family'. | -| textColor | string? | Define text color in hex or rgb / rgba code. | +| font | object \| string | Style the font of the text feature with either css font properties or use font as an object with properties 'size' and 'family'. | +| textColor | string? | Define text color in hex or rgb / rgba code. | ##### draw.textStyle.font -| fieldName | type | description | +| fieldName | type | description | | --------- | -------- | ----------------------------------------------------------------------------------- | -| family | string? | Font family. | -| size | number[]? | Array with numbers that define the available text sizes that a user can choose from | +| family | string? | Font family. | +| size | number[]? | Array with numbers that define the available text sizes that a user can choose from | #### draw.style (by example) diff --git a/packages/plugins/Export/README.md b/packages/plugins/Export/README.md index 8f8f2c888..d7e378d7f 100644 --- a/packages/plugins/Export/README.md +++ b/packages/plugins/Export/README.md @@ -8,12 +8,12 @@ The Export plugin offers users to download the currently visible map canvas in a ### export -| fieldName | type | description | +| fieldName | type | description | | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| download | boolean? | Whether file is offered for download. By default, no download will happen, and the using service is supposed to register whether a "screenshot" has been taken and react accordingly. | -| showJpg | boolean? | Tools offers current map view as JPG. Defaults to `true`. | -| showPdf | boolean? | Tools offers current map view as PDF. Defaults to `true`. | -| showPng | boolean? | Tools offers current map view as PNG. Defaults to `true`. | +| download | boolean? | Whether file is offered for download. By default, no download will happen, and the using service is supposed to register whether a "screenshot" has been taken and react accordingly. | +| showJpg | boolean? | Tools offers current map view as JPG. Defaults to `true`. | +| showPdf | boolean? | Tools offers current map view as PDF. Defaults to `true`. | +| showPng | boolean? | Tools offers current map view as PNG. Defaults to `true`. | ## Store diff --git a/packages/plugins/Fullscreen/README.md b/packages/plugins/Fullscreen/README.md index c9ee3db42..7db32184c 100644 --- a/packages/plugins/Fullscreen/README.md +++ b/packages/plugins/Fullscreen/README.md @@ -8,9 +8,9 @@ The fullscreen plugin allows viewing the map in fullscreen mode. It relies solel ### fullscreen -| fieldName | type | description | +| fieldName | type | description | |-------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| renderType | 'iconMenu' \| 'independent'? | Whether the fullscreen button is being rendered independently or as part of the IconMenu. Defaults to 'independent'. | +| renderType | 'iconMenu' \| 'independent'? | Whether the fullscreen button is being rendered independently or as part of the IconMenu. Defaults to 'independent'. | | targetContainerId | string? | Specifies the html element on which the fullscreen mode should be applied. If the parameter is omitted, it falls back to the configured global field `containerId`. | ## Store diff --git a/packages/plugins/GeoLocation/README.md b/packages/plugins/GeoLocation/README.md index 290e7257c..688097eb3 100644 --- a/packages/plugins/GeoLocation/README.md +++ b/packages/plugins/GeoLocation/README.md @@ -10,16 +10,16 @@ either `true` or `false`. When a users denies the location tracking, the button #### geoLocation -| fieldName | type | description | +| fieldName | type | description | | ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | +| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | checkLocationInitially | boolean? | If `true` the location gets checked on page load. When `false` this can be triggered with a button. Defaults to `false`. | -| keepCentered | boolean? | If `true`, the map will re-center on the user on any position change. If `false`, only the first position will be centered on. Defaults to `false`. | +| keepCentered | boolean? | If `true`, the map will re-center on the user on any position change. If `false`, only the first position will be centered on. Defaults to `false`. | | renderType | 'iconMenu' \| 'independent'? | If nested in `IconMenu`, select 'iconMenu' to match styling. Defaults to 'independent'. | | showTooltip | boolean? | If set to `true`, a tooltip will be shown when hovering the geoposition marker in the map, indicating that it shows the user's position. Defaults to `false`. | | toastAction | string? | If the user is not locatable within the boundary of the maps extent or the boundary of the layer of `boundaryLayerId`, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | -| zoomLevel | number? | Specifies to which zoom level gets zoomed after a successfull tracking of the location. Defaults to `7`. | +| zoomLevel | number? | Specifies to which zoom level gets zoomed after a successfull tracking of the location. Defaults to `7`. | #### Example configuration diff --git a/packages/plugins/Gfi/README.md b/packages/plugins/Gfi/README.md index aa75b086b..8621f7eff 100644 --- a/packages/plugins/Gfi/README.md +++ b/packages/plugins/Gfi/README.md @@ -10,29 +10,29 @@ The GFI plugin can be used to fetch and optionally display GFI (GetFeatureInfo) #### gfi -| fieldName | type | description | +| fieldName | type | description | | -------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| coordinateSources | string[] | The GFI plugin will react to these coordinate positions in the store. This allows it to react to e.g. the address search of the pins plugin. Please see example configuration for the common use-cases. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | -| layers | Record | Maps a string (must be a layer ID) to a behaviour configuration for that layer. | +| coordinateSources | string[] | The GFI plugin will react to these coordinate positions in the store. This allows it to react to e.g. the address search of the pins plugin. Please see example configuration for the common use-cases. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | +| layers | Record | Maps a string (must be a layer ID) to a behaviour configuration for that layer. | | activeLayerPath | string? | Optional store path to array of active mask layer ids. If used with `LayerChooser`, setting this to `'plugin/layerChooser/activeMaskIds'` will result in an info text in the GFI box, should no layer be active. If used without `LayerChooser`, the active mask layers have to be provided by another plugin or the client. If not set, the GFI plugin may e.g. show an empty list, which may be confusing to some users. | -| afterLoadFunction | function (featuresByLayerId: Record): Record? | This method can be used to extend, filter, or otherwise modify a GFI result. | -| customHighlightStyle | customHighlighStyle? | If required a user can change the stroke and fill of the highlighted feature. The default style as seen in the example will be used for each part that is not customized. An empty object will return the complete default style while e.g. for an object without a configured fill the default fill will be applied. | +| afterLoadFunction | function (featuresByLayerId: Record): Record? | This method can be used to extend, filter, or otherwise modify a GFI result. | +| customHighlightStyle | customHighlighStyle? | If required a user can change the stroke and fill of the highlighted feature. The default style as seen in the example will be used for each part that is not customized. An empty object will return the complete default style while e.g. for an object without a configured fill the default fill will be applied. | | featureList | featureList? | If defined, a list of available vector layer features is visible when no feature is selected. Only usable if `renderType` is set to `iconMenu` and `window` is set to `true` for at least one configured layer. | -| gfiContentComponent | Vue? | Allows overriding the GfiContent.vue component for a custom design. Coding knowledge required to use this feature. | +| gfiContentComponent | Vue? | Allows overriding the GfiContent.vue component for a custom design. Coding knowledge required to use this feature. | | maxFeatures | number? | Limits the viewable GFIs per layer by this number. The first n elements are chosen arbitrarily. Useful if you e.g. just want one result, or to limit an endless stream of returns to e.g. 10. Infinite by default. | -| mode | enum["bboxDot", "intersects"]? | Method of calculating which feature has been chosen by the user. `bboxDot` utilizes the `bbox`-url parameter using the clicked coordinate while `intersects` uses a `Filter` to calculate the intersected features. Layers can have their own `gfiMode` parameter which would override this global mode. To apply this, add the desired value to the parameter in the `mapConfiguration`. Defaults to `'bboxDot'`. | +| mode | enum["bboxDot", "intersects"]? | Method of calculating which feature has been chosen by the user. `bboxDot` utilizes the `bbox`-url parameter using the clicked coordinate while `intersects` uses a `Filter` to calculate the intersected features. Layers can have their own `gfiMode` parameter which would override this global mode. To apply this, add the desired value to the parameter in the `mapConfiguration`. Defaults to `'bboxDot'`. | | renderType | ('iconMenu' \| 'independent')? | Only relevant if `window` is set to `true` for at least one layer. Whether the gfi plugin is rendered independently or as part of the IconMenu. Defaults to 'independent'. | ##### gfi.gfiLayerConfiguration -| fieldName | type | description | +| fieldName | type | description | | -------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| exportProperty | string? | Property of the features of a service having an url usable to trigger a download of features as a document. | -| geometry | boolean? | If true, feature geometry will be highlighted within the map. Defaults to `false`. | -| geometryName | string? | Name of the geometry property if not the default field. | -| properties | Record/string[] | In case `window` is `true`, this will be used to determine which contents to show. In case of an array, keys are used to select properties. In case of an object, keys are used to select properties, but will be titles as their respective values. Displays all properties by default. | +| exportProperty | string? | Property of the features of a service having an url usable to trigger a download of features as a document. | +| geometry | boolean? | If true, feature geometry will be highlighted within the map. Defaults to `false`. | +| geometryName | string? | Name of the geometry property if not the default field. | +| properties | Record/string[] | In case `window` is `true`, this will be used to determine which contents to show. In case of an array, keys are used to select properties. In case of an object, keys are used to select properties, but will be titles as their respective values. Displays all properties by default. | | showTooltip | ((feature: Feature) => [string, string][])? | If given, a tooltip will be shown with the values calculated for the feature. The first string is the HTML tag to render, the second its contents; contants may be locale keys. For more information regarding the strings, see the documentation of the `@polar/lib-tooltip` package. Defaults to `undefined`. Please mind that tooltips will only be shown if a mouse is used or the hovering device could not be detected. Touch and pen interactions do not open tooltips since they will open the GFI window, rendering the gatherable information redundant. | -| window | boolean? | If true, properties will be shown in the map client. Defaults to `false`. | +| window | boolean? | If true, properties will be shown in the map client. Defaults to `false`. | Additionally, if using a WMS service, the following properties can be configured as well. @@ -43,10 +43,10 @@ Additionally, if using a WMS service, the following properties can be configured ##### gfi.customHighlightStyle -| fieldName | type | description | +| fieldName | type | description | | --------- | ------ | ------------------------------------ | -| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Fill-Fill.html) for full options. | -| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Stroke-Stroke.html) for full options. | +| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Fill-Fill.html) for full options. | +| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Stroke-Stroke.html) for full options. | ##### gfi.featureList diff --git a/packages/plugins/LayerChooser/README.md b/packages/plugins/LayerChooser/README.md index cdb47dbed..18699739d 100644 --- a/packages/plugins/LayerChooser/README.md +++ b/packages/plugins/LayerChooser/README.md @@ -14,31 +14,31 @@ The tool does not require any configuration for itself, but is based on the `map Each object in `mapConfiguration.layers` array fits this definition: -| fieldName | type | description | +| fieldName | type | description | | ---------- | -------------------------- | -------------------------------------------------------------------------------------- | -| id | string | Service register id. | -| name | string | Display name in UI. | -| type | enum["background", "mask"] | Layer handling. Backgrounds are mutually exclusive, masks ("overlays") can be stacked. | +| id | string | Service register id. | +| name | string | Display name in UI. | +| type | enum["background", "mask"] | Layer handling. Backgrounds are mutually exclusive, masks ("overlays") can be stacked. | | hideInMenu | boolean? | Can be set for layers of type `'mask'` to hide them in the selection menu. | -| maxZoom | number? | If set, layer only available (and selectable) to this zoom level. | -| minZoom | number? | If set, layer only available (and selectable) from this zoom level on. | -| options | options? | Shows a layer-specific sub-menu; its contents are configurable. | -| visibility | boolean? | Initial visibility. Defaults to `false`. | +| maxZoom | number? | If set, layer only available (and selectable) to this zoom level. | +| minZoom | number? | If set, layer only available (and selectable) from this zoom level on. | +| options | options? | Shows a layer-specific sub-menu; its contents are configurable. | +| visibility | boolean? | Initial visibility. Defaults to `false`. | ### mapConfiguration.layers.options An option wheel will appear in the layer chooser that allows opening a sub-menu with configured configuration options for the end user. -| fieldName | type | description | +| fieldName | type | description | | --------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| layers | options.layers | If configured, all configured _layers of the layer_ can be turned off and on by the user. ⚠️ Only implemented for WMS. Only implemented for top layers; that is, only first level of nesting is considered. | +| layers | options.layers | If configured, all configured _layers of the layer_ can be turned off and on by the user. ⚠️ Only implemented for WMS. Only implemented for top layers; that is, only first level of nesting is considered. | #### mapConfiguration.layers.options.layers This field is named like this to match the OGC specification for their name; that is, layers have layers that may have layers that may have layers, and so on. However, only the first level (a layer's layers) is currently implemented. -| fieldName | type | description | +| fieldName | type | description | | --------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| legend | boolean \| Record? | Legend image to be used for sub-layer. If false, no image is displayed. If true, it is assumed an image exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to a linked image. The `legendUrl` can be any valid reachable image URL. | -| order | string? | Optional. If not given, field `layers` from service description will be used, and defines order of options. If layer defined in service description's `layers` and `order`, it's initially on. If only in `order`, it's initially off. If only in `layers`, it's always-on. If in neither, it's always-off. | -| title | boolean \| Record? | Title to be displayed for sub-layer. If false, layer name itself will be used as given in service description 'layers' field. If true, it is assumed a name exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to an arbitrary display name given by the configuration. The `layerName` can be any string. | +| legend | boolean \| Record? | Legend image to be used for sub-layer. If false, no image is displayed. If true, it is assumed an image exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to a linked image. The `legendUrl` can be any valid reachable image URL. | +| order | string? | Optional. If not given, field `layers` from service description will be used, and defines order of options. If layer defined in service description's `layers` and `order`, it's initially on. If only in `order`, it's initially off. If only in `layers`, it's always-on. If in neither, it's always-off. | +| title | boolean \| Record? | Title to be displayed for sub-layer. If false, layer name itself will be used as given in service description 'layers' field. If true, it is assumed a name exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to an arbitrary display name given by the configuration. The `layerName` can be any string. | diff --git a/packages/plugins/LoadingIndicator/README.md b/packages/plugins/LoadingIndicator/README.md index afcf5a73e..6681f2f5f 100644 --- a/packages/plugins/LoadingIndicator/README.md +++ b/packages/plugins/LoadingIndicator/README.md @@ -25,7 +25,7 @@ As such, **always call `removeLoadingKey` in the `finally` section of your code* You may desire to listen to whether the loader is currently being shown. -| fieldName | type | description | +| fieldName | type | description | | ---------- | ------- | ------------------------------------- | | showLoader | boolean | Whether the layer is currently shown. | diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index 218493a8a..df338bb86 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -10,39 +10,39 @@ The usage of `displayComponent` has no influence on the creation of Pins on the ### pins -| fieldName | type | description | +| fieldName | type | description | | ---------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appearOnClick | appearOnClick?? | Pin restrictions. See object description below. | -| boundaryLayerId | string? | Id of a vector layer to restrict pins to. When pins are moved or created outside of the boundary, an information will be shown and the pin is reset to its previous state. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | +| appearOnClick | appearOnClick?? | Pin restrictions. See object description below. | +| boundaryLayerId | string? | Id of a vector layer to restrict pins to. When pins are moved or created outside of the boundary, an information will be shown and the pin is reset to its previous state. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | -| initial | initial? | Configuration options for setting an initial pin. | -| movable | boolean? \| 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | -| style | style? | Display style configuration. | -| toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | -| toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | +| initial | initial? | Configuration options for setting an initial pin. | +| movable | boolean? \| 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | +| style | style? | Display style configuration. | +| toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | +| toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | #### pins.appearOnClick -| fieldName | type | description | +| fieldName | type | description | |-------------|---------|------------------------------------------| -| show | boolean | Display marker. | +| show | boolean | Display marker. | | atZoomLevel | number? | Minimum zoom level for sensible marking. Defaults to `0`. | #### pins.initial -| fieldName | type | description | +| fieldName | type | description | |-------------|----------|---------------------------------------------------------------------------------------------------------------------------------------| -| coordinates | number[] | Coordinate pair for the pin. | -| centerOn | boolean? | If set to true, center on and zoom to the given coordinates on start. Defaults to false. | -| epsg | string? | Coordinate reference system in which the given coordinates are encoded. Defaults to the `epsg` value defined in the mapConfiguration. | +| coordinates | number[] | Coordinate pair for the pin. | +| centerOn | boolean? | If set to true, center on and zoom to the given coordinates on start. Defaults to false. | +| epsg | string? | Coordinate reference system in which the given coordinates are encoded. Defaults to the `epsg` value defined in the mapConfiguration. | #### pins.style -| fieldName | type | description | +| fieldName | type | description | | --------- | ------- | ------------------------------------------------------------------------- | -| fill | string? | Fill color of the pin. Defaults to blue (`#005CA9`). | -| stroke | string? | Stroke (that is, border) color of the pin. Defaults to white (`#FFFFFF`). | +| fill | string? | Fill color of the pin. Defaults to blue (`#005CA9`). | +| stroke | string? | Stroke (that is, border) color of the pin. Defaults to white (`#FFFFFF`). | ## Store diff --git a/packages/plugins/ReverseGeocoder/README.md b/packages/plugins/ReverseGeocoder/README.md index 1c70ce420..b3ab48347 100644 --- a/packages/plugins/ReverseGeocoder/README.md +++ b/packages/plugins/ReverseGeocoder/README.md @@ -10,14 +10,14 @@ This module has been written for the HH WPS service. The return format is custom ### reverseGeocoder -| fieldName | type | description | +| fieldName | type | description | | ---------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| url | string | URL of the WPS to use for reverse geocoding. | -| addLoading | string? | Points to an action in the store; commited with a loading key as payload on starting reverse geocoding. | -| addressTarget | string? | Points to a path in the store where an address can be put. If given, ReverseGeocoder will update on resolve. If not given, ReverseGeocoder's results can only be retrieved by awaiting its action. | +| url | string | URL of the WPS to use for reverse geocoding. | +| addLoading | string? | Points to an action in the store; commited with a loading key as payload on starting reverse geocoding. | +| addressTarget | string? | Points to a path in the store where an address can be put. If given, ReverseGeocoder will update on resolve. If not given, ReverseGeocoder's results can only be retrieved by awaiting its action. | | coordinateSource | string? | Points to a path in the store where a coordinate may be. If given, ReverseGeocoder will resolve on any updates. If not given, ReverseGeocoder is passive and waits for its action to be called. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | -| removeLoading | string? | Points to an action in the store; commited with a loading key as payload on finishing reverse geocoding. | -| zoomTo | number? | If specified, plugin zooms to given coordinate after successful reverse geocoding; number indicates maximal zoom level. | +| removeLoading | string? | Points to an action in the store; commited with a loading key as payload on finishing reverse geocoding. | +| zoomTo | number? | If specified, plugin zooms to given coordinate after successful reverse geocoding; number indicates maximal zoom level. | ## Store diff --git a/packages/plugins/Toast/README.md b/packages/plugins/Toast/README.md index 24289392e..f24f41e0e 100644 --- a/packages/plugins/Toast/README.md +++ b/packages/plugins/Toast/README.md @@ -10,19 +10,19 @@ Please check the vuetify documentation to override the success, warning, info, o ### toast -| fieldName | type | description | +| fieldName | type | description | | --------- | ---------- | ------------------------------------- | -| error | toastStyle? | Design override for error messages. | -| info | toastStyle? | Design override for info messages. | -| success | toastStyle? | Design override for success messages. | -| warning | toastStyle? | Design override for warning messages. | +| error | toastStyle? | Design override for error messages. | +| info | toastStyle? | Design override for info messages. | +| success | toastStyle? | Design override for success messages. | +| warning | toastStyle? | Design override for warning messages. | #### toast.toastStyle -| fieldName | type | description | +| fieldName | type | description | | --------- | ------- | -------------------------------------------------------------------------------------------------------------------- | -| color | string? | Either a color code like '#FACADE' or a color string [vuetify understands](https://vuetifyjs.com/en/styles/colors/). | -| icon | string? | CSS icon class. | +| color | string? | Either a color code like '#FACADE' or a color string [vuetify understands](https://vuetifyjs.com/en/styles/colors/). | +| icon | string? | CSS icon class. | ## Store @@ -36,13 +36,13 @@ map.$store.dispatch('plugin/toast/addToast', payload) #### Payload structure -| fieldName | type | description | +| fieldName | type | description | | --------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| type | enum['error', 'warning', 'info', 'success'] | Decides the default toast colouring and icon. | -| text | string | Textual user information. This may either be a user-readable string or a translation key. | -| timeout | number | Any positive non-null number will be used as ms until the toast is closed. 0 means no timeout. | -| color | ?string | See {toast.toastStyle}. Overrides setting for this toast only. | -| icon | ?string | See {toast.toastStyle}. Overrides setting for this toast only. | +| type | enum['error', 'warning', 'info', 'success'] | Decides the default toast colouring and icon. | +| text | string | Textual user information. This may either be a user-readable string or a translation key. | +| timeout | number | Any positive non-null number will be used as ms until the toast is closed. 0 means no timeout. | +| color | ?string | See {toast.toastStyle}. Overrides setting for this toast only. | +| icon | ?string | See {toast.toastStyle}. Overrides setting for this toast only. | #### Usage example diff --git a/packages/plugins/Zoom/README.md b/packages/plugins/Zoom/README.md index ec9b4df34..c19a65efc 100644 --- a/packages/plugins/Zoom/README.md +++ b/packages/plugins/Zoom/README.md @@ -6,13 +6,13 @@ The Zoom plugin offers functionality regarding map zooming. ## Configuration -The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization. +The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization. It can be configured as followed. -| fieldName | type | description | +| fieldName | type | description | |------------|------------------------------|-----------------------------------------------------------------------------------------------| | renderType | 'iconMenu' \| 'independent'? | Whether the zoom related buttons are being rendered independently or as part of the IconMenu. Defaults to `'independent'`. | -| showMobile | boolean? | Whether the zoom related buttons should be displayed on smaller devices; defaults to `false`. | +| showMobile | boolean? | Whether the zoom related buttons should be displayed on smaller devices; defaults to `false`. | ## Store @@ -20,11 +20,11 @@ It can be configured as followed. The map's zoom level can be listened to. -| fieldName | type | description | +| fieldName | type | description | | ---------------------- | ------- | --------------------------------------------- | -| zoomLevel | number | Current OpenLayers zoom level. | -| maximumZoomLevel | number | Maximum OpenLayers zoom level. | -| minimumZoomLevel | number | Minimum OpenLayers zoom level. | +| zoomLevel | number | Current OpenLayers zoom level. | +| maximumZoomLevel | number | Maximum OpenLayers zoom level. | +| minimumZoomLevel | number | Minimum OpenLayers zoom level. | ```js map.subscribe('plugin/zoom/zoomLevel', (zoomLevel) => { From f285f385314ac61e068a31525b0da7160bc00be9 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Tue, 30 Jul 2024 14:24:27 +0200 Subject: [PATCH 04/15] Update deprecated boolean of movable parameter to enum value --- packages/clients/afm/CHANGELOG.md | 2 ++ packages/clients/afm/example/polar-example.js | 2 +- packages/clients/dish/CHANGELOG.md | 2 ++ packages/clients/dish/src/mapConfig.ts | 2 +- packages/clients/meldemichel/CHANGELOG.md | 5 +++++ packages/clients/meldemichel/src/mapConfigurations.ts | 2 +- packages/clients/snowbox/src/mapConfiguration.ts | 2 +- packages/plugins/Pins/README.md | 2 +- pages/examples/address.html | 2 +- 9 files changed, 15 insertions(+), 6 deletions(-) diff --git a/packages/clients/afm/CHANGELOG.md b/packages/clients/afm/CHANGELOG.md index c6fb9430d..8fa41f1de 100644 --- a/packages/clients/afm/CHANGELOG.md +++ b/packages/clients/afm/CHANGELOG.md @@ -4,6 +4,8 @@ - Feature: This client now supports the `@polar/core`'s field `stylePath`. The usage is documented in the API.md file. - Feature: Update icon of `layerChooser` in `iconMenu` to `fa-layer-group` to clear-up the content hidden behind the menu button. +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. ## 1.0.1 diff --git a/packages/clients/afm/example/polar-example.js b/packages/clients/afm/example/polar-example.js index a9d64fa8e..3ba7422ec 100644 --- a/packages/clients/afm/example/polar-example.js +++ b/packages/clients/afm/example/polar-example.js @@ -67,7 +67,7 @@ const mapConfiguration = { }, pins: { toZoomLevel: 9, - movable: true, + movable: 'drag', appearOnClick: { show: true, atZoomLevel: 3, diff --git a/packages/clients/dish/CHANGELOG.md b/packages/clients/dish/CHANGELOG.md index 4c3268f4a..e01c4db81 100644 --- a/packages/clients/dish/CHANGELOG.md +++ b/packages/clients/dish/CHANGELOG.md @@ -3,6 +3,8 @@ ## unpublished - Feature: If a user is geolocated outside of the map's extent, the client will inform the user of why geolocation did not take effect via a textbox. +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. ## 1.1.1 diff --git a/packages/clients/dish/src/mapConfig.ts b/packages/clients/dish/src/mapConfig.ts index bd19f59e6..17cf69ebb 100644 --- a/packages/clients/dish/src/mapConfig.ts +++ b/packages/clients/dish/src/mapConfig.ts @@ -208,7 +208,7 @@ export const mapConfiguration = { }, pins: { toZoomLevel: 7, - movable: true, + movable: 'drag', style: { fill: shBlue, }, diff --git a/packages/clients/meldemichel/CHANGELOG.md b/packages/clients/meldemichel/CHANGELOG.md index cea9d999f..bd509e024 100644 --- a/packages/clients/meldemichel/CHANGELOG.md +++ b/packages/clients/meldemichel/CHANGELOG.md @@ -1,5 +1,10 @@ # CHANGELOG +## unpublished + +- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. + - values `true` have been replaced with `drag` instead. + ## 1.1.2 - Chore: Fix bugs via dependency updates. diff --git a/packages/clients/meldemichel/src/mapConfigurations.ts b/packages/clients/meldemichel/src/mapConfigurations.ts index 06a129ebb..0f9e7b626 100644 --- a/packages/clients/meldemichel/src/mapConfigurations.ts +++ b/packages/clients/meldemichel/src/mapConfigurations.ts @@ -104,7 +104,7 @@ const addressSearch: AddressSearchConfiguration = { const commonPins: Partial = { toZoomLevel: 7, - movable: true, + movable: 'drag', style: { fill: hamburgRed, }, diff --git a/packages/clients/snowbox/src/mapConfiguration.ts b/packages/clients/snowbox/src/mapConfiguration.ts index e46eb155b..8e4a1eadd 100644 --- a/packages/clients/snowbox/src/mapConfiguration.ts +++ b/packages/clients/snowbox/src/mapConfiguration.ts @@ -179,7 +179,7 @@ export const mapConfiguration = { pins: { boundaryLayerId: hamburgBorder, toZoomLevel: 9, - movable: true, + movable: 'drag', appearOnClick: { show: true, atZoomLevel: 0, diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index 218493a8a..98ce40056 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -17,7 +17,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | | initial | initial? | Configuration options for setting an initial pin. | -| movable | boolean? \| 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | +| movable | 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | | style | style? | Display style configuration. | | toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | | toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | diff --git a/pages/examples/address.html b/pages/examples/address.html index cd6537975..431b3a589 100644 --- a/pages/examples/address.html +++ b/pages/examples/address.html @@ -63,7 +63,7 @@ pins: { coordinateSource: 'plugin/addressSearch/chosenAddress', toZoomLevel: 7, - movable: true, + movable: 'drag', }, reverseGeocoder: { url: 'https://geodienste.hamburg.de/HH_WPS', From 734d1f5b9ae78508e9fceeec30a55645eaa06b6a Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:56:13 +0200 Subject: [PATCH 05/15] Update packages/clients/afm/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/afm/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/afm/CHANGELOG.md b/packages/clients/afm/CHANGELOG.md index 8fa41f1de..1fd2ee12d 100644 --- a/packages/clients/afm/CHANGELOG.md +++ b/packages/clients/afm/CHANGELOG.md @@ -4,8 +4,7 @@ - Feature: This client now supports the `@polar/core`'s field `stylePath`. The usage is documented in the API.md file. - Feature: Update icon of `layerChooser` in `iconMenu` to `fa-layer-group` to clear-up the content hidden behind the menu button. -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.0.1 From 359f1dcde0a663428fa06ae3191ae496bab48a3c Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:57:45 +0200 Subject: [PATCH 06/15] Update packages/plugins/Pins/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/plugins/Pins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index 98ce40056..1df84598b 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -17,7 +17,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | coordinateSource | string? | The pins plugin may react to changes in other plugins. This specifies the path to such store positions. The position must, when subscribed to, return a GeoJSON feature. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | | initial | initial? | Configuration options for setting an initial pin. | -| movable | 'drag' \| 'click' \| 'none' | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | +| movable | boolean \| 'drag' \| 'click' \| 'none'? | Whether a user may drag and re-click the pin (`drag` or `true`), only re-click it (`click`) or may only be placed programmatically (`none` or `false`). Defaults to 'none'. **Using a boolean for this configuration has been deprecated and will be removed in the next major release.** | | style | style? | Display style configuration. | | toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as action to send a toast information to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. | | toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. | From 3e4879040b69436fa133b5eac87624e95aa950ae Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:58:05 +0200 Subject: [PATCH 07/15] Update packages/clients/meldemichel/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/meldemichel/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/meldemichel/CHANGELOG.md b/packages/clients/meldemichel/CHANGELOG.md index bd509e024..89a97bfba 100644 --- a/packages/clients/meldemichel/CHANGELOG.md +++ b/packages/clients/meldemichel/CHANGELOG.md @@ -2,8 +2,7 @@ ## unpublished -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.1.2 From 6faa5d21dc14a64e66d3e51a5a07adaf59b31f90 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 07:58:15 +0200 Subject: [PATCH 08/15] Update packages/clients/dish/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/clients/dish/CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/clients/dish/CHANGELOG.md b/packages/clients/dish/CHANGELOG.md index e01c4db81..477a7c6d9 100644 --- a/packages/clients/dish/CHANGELOG.md +++ b/packages/clients/dish/CHANGELOG.md @@ -3,8 +3,7 @@ ## unpublished - Feature: If a user is geolocated outside of the map's extent, the client will inform the user of why geolocation did not take effect via a textbox. -- Chore: `Pins` package using `movable` with a `boolean` has been deprecated. - - values `true` have been replaced with `drag` instead. +- Chore: Change value of `pins.movable` configuration to `'drag'` as using a boolean has been deprecated in a future release. ## 1.1.1 From 6e6688c3e797694073fcc3c8da348b0a5ce95d4b Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 10:09:19 +0200 Subject: [PATCH 09/15] Update dashes in tables to single dashes --- packages/core/README.md | 10 +++++----- packages/lib/testMountParameters/README.md | 2 +- packages/plugins/AddressSearch/README.md | 18 +++++++++--------- packages/plugins/Attributions/README.md | 4 ++-- packages/plugins/Draw/README.md | 6 +++--- packages/plugins/Export/README.md | 2 +- packages/plugins/Fullscreen/README.md | 2 +- packages/plugins/GeoLocation/README.md | 2 +- packages/plugins/Gfi/README.md | 10 +++++----- packages/plugins/LayerChooser/README.md | 6 +++--- packages/plugins/LoadingIndicator/README.md | 2 +- packages/plugins/Pins/README.md | 8 ++++---- packages/plugins/ReverseGeocoder/README.md | 2 +- packages/plugins/Toast/README.md | 6 +++--- packages/plugins/Zoom/README.md | 6 +++--- 15 files changed, 43 insertions(+), 43 deletions(-) diff --git a/packages/core/README.md b/packages/core/README.md index 09b76f26f..596906fc6 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -70,7 +70,7 @@ MapClient.createMap({ The mapConfiguration allows controlling many client instance details. | fieldName | type | description | -| --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - | - | - | | layerConf | LayerConf | Layer configuration as required by masterportalAPI. | | language | enum["de", "en"] | Initial language. | | <...masterportalAPI.fields> | various | The object is also used to initialize the masterportalAPI. Please refer to their documentation for options. | @@ -138,7 +138,7 @@ To figure out the name of the locales to override, inspect the matching plugin i A full documentation of the masterportalapiPolygonFillHatch is available at the Masterportal's documentation file [style.json.md](https://bitbucket.org/geowerkstatt-hamburg/masterportal/src/dev/doc/style.json.md), chapter 'Polygon.polygonFillHatch'. The basic usage is quoted below for quick lookup. For more details, visual examples, and expert features, see there. >|Name|Required|Type|Default|Description| ->|----|--------|----|-------|-----------| +>| - | - | - | - | - | >|pattern|no|enum["diagonal", "diagonal-right", "zig-line", "zig-line-horizontal", "circle", "rectangle", "triangle", "diamond"]/Object|`"diagonal"`|Draw pattern. You may either use a pre-defined pattern from the enum or specify one yourself.| >|size|no|Number|`30`|Edge length of a singular repeated pattern element.| >|lineWidth|no|Number|`10`|Line width of drawn pattern. To achieve an even distribution in diagonal and zig-line pattern, choose lineWidth as (1/3 * size). For triangle and diamond, a lineWidth of 1 must be chosen. For rectangle, a lineWidth of at most (1/4 * size) should be chosen. Deviating from these rules is not harmful, but patterns may seem off.| @@ -189,7 +189,7 @@ Since this is the base for many functions, the service ID set in this is used to The `<...masterportalAPI.fields>` means that any masterportalAPI field may also be used here _directly_. The most common fields are the following ones; for more, see masterportalAPI. | fieldName | type | description | -| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | startResolution | number | Initial resolution; must be in options. See below. | | startCenter | number[] | Initial center coordinate. | | extent | number[] | Map movement will be restricted to this rectangle. | @@ -211,8 +211,8 @@ On how to configure a plugin, see the respective plugin. The configuration is gi Most plugins honor this additional field. -| fieldName | type | description | -| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| fieldName | type | description | +| - | - | - | | displayComponent | boolean? | Optional field that allows hiding UI elements from the user. The store will still be initialized, allowing you to add your own UI elements and control the plugin's functionality via the Store. This may or may not make sense, depending on the plugin. Defaults to `false` , meaning the default UI is hidden. | ##### mapConfiguration.vuetify diff --git a/packages/lib/testMountParameters/README.md b/packages/lib/testMountParameters/README.md index 6c066dda3..30af13339 100644 --- a/packages/lib/testMountParameters/README.md +++ b/packages/lib/testMountParameters/README.md @@ -1,4 +1,4 @@ # createTestMountParameters -This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module. +This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module. This is mostly done to avoid boilerplate code. For regularly used test contents, feel free to extend the returned contents. diff --git a/packages/plugins/AddressSearch/README.md b/packages/plugins/AddressSearch/README.md index 4dc0ac7fb..2617ae643 100644 --- a/packages/plugins/AddressSearch/README.md +++ b/packages/plugins/AddressSearch/README.md @@ -23,7 +23,7 @@ It is advised to either use one-search-per-group _or_ all services in a singular In `categoryProperties` and `groupProperties`, id strings called `groupId` and `categoryId` are used. These are arbitrary strings you can introduce and reuse to group or categorize elements together. Regarding what groups and categories are, see further below. | fieldName | type | description | -| ------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | searchMethods | searchMethodsObject[] | Array of search method descriptions. Only searches configured here can be used. | | afterResultComponent | VueConstructor? | If given, this component will be rendered in the last line of every single search result. It will be forwarded its search result feature as prop `feature` of type `GeoJSON.Feature`, and the focus state of the result as prop `focus` of type `boolean`. | | addLoading | string? | Optional loading action name to start loading. | @@ -39,7 +39,7 @@ In `categoryProperties` and `groupProperties`, id strings called `groupId` and ` #### addressSearch.searchMethodsObject | fieldName | type | description | -| --------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | type | enum["bkg", "gazetteer", "wfs", "mpapi"] | Service type. Enum can be extended by configuration, see `addressSearch.customSearchMethods`. ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. | | url | string | Search service URL. Should you require a service provider, please contact us for further information. | | categoryId | string? | Grouped services can optionally be distinguished in the UI with categories. See `addressSearch.categoryProperties` for configuration options. | @@ -88,7 +88,7 @@ With this, arbitrary click results can be supported. Please mind that undocument #### addressSearch.groupProperties | fieldName | type | description | -| ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | label | string | Display label. Can be a locale key. | | resultDisplayMode | enum['mixed', 'categorized'] | Defaults to `'mixed'`. In `'mixed'`, results of all requested services are offered in a list in no specific order. In `'categorized'`, the results are listed by their searchService's categoryId. | | hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. | @@ -98,7 +98,7 @@ With this, arbitrary click results can be supported. Please mind that undocument #### addressSearch.categoryProperties | fieldName | type | description | -| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - | - | - | | label | string | Category label to display next to results to identify the source. Can be a locale key. Only relevant if the search's `groupProperties` linked via `groupId` contain a `resultDisplayMode` scenario that uses categories. | ##### addressSearch.searchMethodsObject.queryParameters (type:common) @@ -106,13 +106,13 @@ With this, arbitrary click results can be supported. Please mind that undocument These fields are interpreted by all implemented services. | fieldName | type | description | -| ----------- | ------ | --------------------------------------- | +| - | - | - | | maxFeatures | number? | Maximum amount of features to retrieve. Doesn't limit results if not set. | ##### addressSearch.searchMethodsObject.queryParameters (type:wfs) | fieldName | type | description | -| ------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | featurePrefix | string | XML feature prefix for WFS service. | | typeName | string | Feature type to search for by name. | | xmlns | string | XML namespace to use in search. | @@ -129,7 +129,7 @@ Since inputs may overlap with multiple patterns, multiple queries are fired and > ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. | fieldName | type | description | -| ------------- | -------- | ------------------------------------------------------------------------------------------------------------- | +| - | - | - | | epsg | `EPSG:${string}` | EPSG code of the projection to use. | | fieldName | string[] | Field names of service to search in. | | memberSuffix | string | Elements to interpret are fetched from response XML as `wfs:memberSuffix`; fitting suffix must be configured. | @@ -142,7 +142,7 @@ Since inputs may overlap with multiple patterns, multiple queries are fired and > **Please mind that this requires a configured backend. A WFS's Stored Query is requested with predefined parameters using the [masterportalApi](https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/). This implementation is meant for e.g. https://geodienste.hamburg.de/HH_WFS_GAGES, but works with other WFS configured in the same manner.** | fieldName | Type | Description | -| ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | searchAddress | Boolean? | Defines whether address search is active. For backward compatibility, if "searchAddress" is not configured, the "searchAddress" attribute is set to "true" when "searchStreets" and "searchHouseNumbers" are set to "true". | | searchDistricts | Boolean? | Defines whether district search is active. | | searchHouseNumbers | Boolean? | Defines whether house numbers should be searched for. Requires `searchStreets` to be set to `true`, too. | @@ -194,7 +194,7 @@ map.$store.dispatch('plugin/addressSearch/search', { The payload object supports the following fields: | fieldName | type | description | -| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | input | string | Search string to be used. | | autoselect | enum['first', 'only', 'never'] | By default, 'never' is selected, and results will be presented as if the user searched for them. Setting 'only' will autoselect if a single result was returned; setting 'first' will autoselect the first of an arbitrary amount of results >=1. | diff --git a/packages/plugins/Attributions/README.md b/packages/plugins/Attributions/README.md index ee1d50dde..fe8ddb057 100644 --- a/packages/plugins/Attributions/README.md +++ b/packages/plugins/Attributions/README.md @@ -11,7 +11,7 @@ This plugin shows attributions (that is, legal information) regarding copyrights All parameters are optional. However, setting neither `layerAttributions` nor `staticAttributions` results in an empty window. | fieldName | type | description | -| ------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | initiallyOpen | boolean? | Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this. | | layerAttributions | layerAttribution[]? | List of attributions that are shown when the matching layer is visible. | | listenToChanges | string[]? | Store variable paths to listen to for changes. Will update the currently visible layers depending on the current map state on changes to these values. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | @@ -22,6 +22,6 @@ All parameters are optional. However, setting neither `layerAttributions` nor `s #### attributions.layerAttribution | fieldName | type | description | -| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | id | string | ID of service the attribution relates to. The text will only be shown when the layer is visible. | | title | string | Attribution text or localization key. May contain HTML. The tags `` and `` are translated to the current year or month respectively. | diff --git a/packages/plugins/Draw/README.md b/packages/plugins/Draw/README.md index 10b831a75..c2171ab40 100644 --- a/packages/plugins/Draw/README.md +++ b/packages/plugins/Draw/README.md @@ -32,7 +32,7 @@ The styling of the drawn features can be configured to overwrite the default ol- ### draw | fieldName | type | description | -| ------------------- | -------- | ---------------------------------------------------------------------------- | +| - | - | - | | selectableDrawModes | string[]? | List 'Point', 'LineString', 'Circle', 'Text' and/or 'Polygon' as desired. All besides 'Text' are selectable by default. | | style | style? | Please see example below for styling options. Defaults to standard OpenLayers styling. | | textStyle | object? | Use this object with properties 'font' and 'textColor' to style text feature. | @@ -40,14 +40,14 @@ The styling of the drawn features can be configured to overwrite the default ol- ##### draw.textStyle | fieldName | type | description | -| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | font | object \| string | Style the font of the text feature with either css font properties or use font as an object with properties 'size' and 'family'. | | textColor | string? | Define text color in hex or rgb / rgba code. | ##### draw.textStyle.font | fieldName | type | description | -| --------- | -------- | ----------------------------------------------------------------------------------- | +| - | - | - | | family | string? | Font family. | | size | number[]? | Array with numbers that define the available text sizes that a user can choose from | diff --git a/packages/plugins/Export/README.md b/packages/plugins/Export/README.md index d7e378d7f..7c11857f0 100644 --- a/packages/plugins/Export/README.md +++ b/packages/plugins/Export/README.md @@ -9,7 +9,7 @@ The Export plugin offers users to download the currently visible map canvas in a ### export | fieldName | type | description | -| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | download | boolean? | Whether file is offered for download. By default, no download will happen, and the using service is supposed to register whether a "screenshot" has been taken and react accordingly. | | showJpg | boolean? | Tools offers current map view as JPG. Defaults to `true`. | | showPdf | boolean? | Tools offers current map view as PDF. Defaults to `true`. | diff --git a/packages/plugins/Fullscreen/README.md b/packages/plugins/Fullscreen/README.md index 7db32184c..2900c73cf 100644 --- a/packages/plugins/Fullscreen/README.md +++ b/packages/plugins/Fullscreen/README.md @@ -9,7 +9,7 @@ The fullscreen plugin allows viewing the map in fullscreen mode. It relies solel ### fullscreen | fieldName | type | description | -|-------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| - | - | - | | renderType | 'iconMenu' \| 'independent'? | Whether the fullscreen button is being rendered independently or as part of the IconMenu. Defaults to 'independent'. | | targetContainerId | string? | Specifies the html element on which the fullscreen mode should be applied. If the parameter is omitted, it falls back to the configured global field `containerId`. | diff --git a/packages/plugins/GeoLocation/README.md b/packages/plugins/GeoLocation/README.md index 688097eb3..5227ec478 100644 --- a/packages/plugins/GeoLocation/README.md +++ b/packages/plugins/GeoLocation/README.md @@ -11,7 +11,7 @@ either `true` or `false`. When a users denies the location tracking, the button #### geoLocation | fieldName | type | description | -| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | | checkLocationInitially | boolean? | If `true` the location gets checked on page load. When `false` this can be triggered with a button. Defaults to `false`. | diff --git a/packages/plugins/Gfi/README.md b/packages/plugins/Gfi/README.md index 8621f7eff..c43f6212c 100644 --- a/packages/plugins/Gfi/README.md +++ b/packages/plugins/Gfi/README.md @@ -11,7 +11,7 @@ The GFI plugin can be used to fetch and optionally display GFI (GetFeatureInfo) #### gfi | fieldName | type | description | -| -------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | coordinateSources | string[] | The GFI plugin will react to these coordinate positions in the store. This allows it to react to e.g. the address search of the pins plugin. Please see example configuration for the common use-cases. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. | | layers | Record | Maps a string (must be a layer ID) to a behaviour configuration for that layer. | | activeLayerPath | string? | Optional store path to array of active mask layer ids. If used with `LayerChooser`, setting this to `'plugin/layerChooser/activeMaskIds'` will result in an info text in the GFI box, should no layer be active. If used without `LayerChooser`, the active mask layers have to be provided by another plugin or the client. If not set, the GFI plugin may e.g. show an empty list, which may be confusing to some users. | @@ -26,7 +26,7 @@ The GFI plugin can be used to fetch and optionally display GFI (GetFeatureInfo) ##### gfi.gfiLayerConfiguration | fieldName | type | description | -| -------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | exportProperty | string? | Property of the features of a service having an url usable to trigger a download of features as a document. | | geometry | boolean? | If true, feature geometry will be highlighted within the map. Defaults to `false`. | | geometryName | string? | Name of the geometry property if not the default field. | @@ -44,9 +44,9 @@ Additionally, if using a WMS service, the following properties can be configured ##### gfi.customHighlightStyle | fieldName | type | description | -| --------- | ------ | ------------------------------------ | -| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Fill-Fill.html) for full options. | -| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Stroke-Stroke.html) for full options. | +| - | - | - | +| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module - ol_style_Fill - Fill.html) for full options. | +| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module - ol_style_Stroke - Stroke.html) for full options. | ##### gfi.featureList diff --git a/packages/plugins/LayerChooser/README.md b/packages/plugins/LayerChooser/README.md index 18699739d..92a125267 100644 --- a/packages/plugins/LayerChooser/README.md +++ b/packages/plugins/LayerChooser/README.md @@ -15,7 +15,7 @@ The tool does not require any configuration for itself, but is based on the `map Each object in `mapConfiguration.layers` array fits this definition: | fieldName | type | description | -| ---------- | -------------------------- | -------------------------------------------------------------------------------------- | +| - | - | - | | id | string | Service register id. | | name | string | Display name in UI. | | type | enum["background", "mask"] | Layer handling. Backgrounds are mutually exclusive, masks ("overlays") can be stacked. | @@ -30,7 +30,7 @@ Each object in `mapConfiguration.layers` array fits this definition: An option wheel will appear in the layer chooser that allows opening a sub-menu with configured configuration options for the end user. | fieldName | type | description | -| --------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | layers | options.layers | If configured, all configured _layers of the layer_ can be turned off and on by the user. ⚠️ Only implemented for WMS. Only implemented for top layers; that is, only first level of nesting is considered. | #### mapConfiguration.layers.options.layers @@ -38,7 +38,7 @@ An option wheel will appear in the layer chooser that allows opening a sub-menu This field is named like this to match the OGC specification for their name; that is, layers have layers that may have layers that may have layers, and so on. However, only the first level (a layer's layers) is currently implemented. | fieldName | type | description | -| --------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | legend | boolean \| Record? | Legend image to be used for sub-layer. If false, no image is displayed. If true, it is assumed an image exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to a linked image. The `legendUrl` can be any valid reachable image URL. | | order | string? | Optional. If not given, field `layers` from service description will be used, and defines order of options. If layer defined in service description's `layers` and `order`, it's initially on. If only in `order`, it's initially off. If only in `layers`, it's always-on. If in neither, it's always-off. | | title | boolean \| Record? | Title to be displayed for sub-layer. If false, layer name itself will be used as given in service description 'layers' field. If true, it is assumed a name exists in the layer's GetCapabilities, and that will be used. If Record, it maps the layer name to an arbitrary display name given by the configuration. The `layerName` can be any string. | diff --git a/packages/plugins/LoadingIndicator/README.md b/packages/plugins/LoadingIndicator/README.md index 6681f2f5f..33e07719f 100644 --- a/packages/plugins/LoadingIndicator/README.md +++ b/packages/plugins/LoadingIndicator/README.md @@ -26,7 +26,7 @@ As such, **always call `removeLoadingKey` in the `finally` section of your code* You may desire to listen to whether the loader is currently being shown. | fieldName | type | description | -| ---------- | ------- | ------------------------------------- | +| - | - | - | | showLoader | boolean | Whether the layer is currently shown. | ```js diff --git a/packages/plugins/Pins/README.md b/packages/plugins/Pins/README.md index df338bb86..78d321fb8 100644 --- a/packages/plugins/Pins/README.md +++ b/packages/plugins/Pins/README.md @@ -11,7 +11,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the ### pins | fieldName | type | description | -| ---------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | appearOnClick | appearOnClick?? | Pin restrictions. See object description below. | | boundaryLayerId | string? | Id of a vector layer to restrict pins to. When pins are moved or created outside of the boundary, an information will be shown and the pin is reset to its previous state. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. | | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the pins feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. | @@ -25,14 +25,14 @@ The usage of `displayComponent` has no influence on the creation of Pins on the #### pins.appearOnClick | fieldName | type | description | -|-------------|---------|------------------------------------------| +| - | - | - | | show | boolean | Display marker. | | atZoomLevel | number? | Minimum zoom level for sensible marking. Defaults to `0`. | #### pins.initial | fieldName | type | description | -|-------------|----------|---------------------------------------------------------------------------------------------------------------------------------------| +| - | - | - | | coordinates | number[] | Coordinate pair for the pin. | | centerOn | boolean? | If set to true, center on and zoom to the given coordinates on start. Defaults to false. | | epsg | string? | Coordinate reference system in which the given coordinates are encoded. Defaults to the `epsg` value defined in the mapConfiguration. | @@ -40,7 +40,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the #### pins.style | fieldName | type | description | -| --------- | ------- | ------------------------------------------------------------------------- | +| - | - | - | | fill | string? | Fill color of the pin. Defaults to blue (`#005CA9`). | | stroke | string? | Stroke (that is, border) color of the pin. Defaults to white (`#FFFFFF`). | diff --git a/packages/plugins/ReverseGeocoder/README.md b/packages/plugins/ReverseGeocoder/README.md index b3ab48347..3edaa8b18 100644 --- a/packages/plugins/ReverseGeocoder/README.md +++ b/packages/plugins/ReverseGeocoder/README.md @@ -11,7 +11,7 @@ This module has been written for the HH WPS service. The return format is custom ### reverseGeocoder | fieldName | type | description | -| ---------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | url | string | URL of the WPS to use for reverse geocoding. | | addLoading | string? | Points to an action in the store; commited with a loading key as payload on starting reverse geocoding. | | addressTarget | string? | Points to a path in the store where an address can be put. If given, ReverseGeocoder will update on resolve. If not given, ReverseGeocoder's results can only be retrieved by awaiting its action. | diff --git a/packages/plugins/Toast/README.md b/packages/plugins/Toast/README.md index f24f41e0e..8a03f7c01 100644 --- a/packages/plugins/Toast/README.md +++ b/packages/plugins/Toast/README.md @@ -11,7 +11,7 @@ Please check the vuetify documentation to override the success, warning, info, o ### toast | fieldName | type | description | -| --------- | ---------- | ------------------------------------- | +| - | - | - | | error | toastStyle? | Design override for error messages. | | info | toastStyle? | Design override for info messages. | | success | toastStyle? | Design override for success messages. | @@ -20,7 +20,7 @@ Please check the vuetify documentation to override the success, warning, info, o #### toast.toastStyle | fieldName | type | description | -| --------- | ------- | -------------------------------------------------------------------------------------------------------------------- | +| - | - | - | | color | string? | Either a color code like '#FACADE' or a color string [vuetify understands](https://vuetifyjs.com/en/styles/colors/). | | icon | string? | CSS icon class. | @@ -37,7 +37,7 @@ map.$store.dispatch('plugin/toast/addToast', payload) #### Payload structure | fieldName | type | description | -| --------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| - | - | - | | type | enum['error', 'warning', 'info', 'success'] | Decides the default toast colouring and icon. | | text | string | Textual user information. This may either be a user-readable string or a translation key. | | timeout | number | Any positive non-null number will be used as ms until the toast is closed. 0 means no timeout. | diff --git a/packages/plugins/Zoom/README.md b/packages/plugins/Zoom/README.md index c19a65efc..bfad5a7db 100644 --- a/packages/plugins/Zoom/README.md +++ b/packages/plugins/Zoom/README.md @@ -6,11 +6,11 @@ The Zoom plugin offers functionality regarding map zooming. ## Configuration -The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization. +The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization. It can be configured as followed. | fieldName | type | description | -|------------|------------------------------|-----------------------------------------------------------------------------------------------| +| - | - | - | | renderType | 'iconMenu' \| 'independent'? | Whether the zoom related buttons are being rendered independently or as part of the IconMenu. Defaults to `'independent'`. | | showMobile | boolean? | Whether the zoom related buttons should be displayed on smaller devices; defaults to `false`. | @@ -21,7 +21,7 @@ It can be configured as followed. The map's zoom level can be listened to. | fieldName | type | description | -| ---------------------- | ------- | --------------------------------------------- | +| - | - | - | | zoomLevel | number | Current OpenLayers zoom level. | | maximumZoomLevel | number | Maximum OpenLayers zoom level. | | minimumZoomLevel | number | Minimum OpenLayers zoom level. | From 22fdf0b2fb4f21fc021665b00efff5a7e44fed9f Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 10:42:10 +0200 Subject: [PATCH 10/15] Remove missed whitespaces in table --- packages/core/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/README.md b/packages/core/README.md index 596906fc6..cc6197b59 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -188,7 +188,7 @@ Since this is the base for many functions, the service ID set in this is used to The `<...masterportalAPI.fields>` means that any masterportalAPI field may also be used here _directly_. The most common fields are the following ones; for more, see masterportalAPI. -| fieldName | type | description | +| fieldName | type | description | | - | - | - | | startResolution | number | Initial resolution; must be in options. See below. | | startCenter | number[] | Initial center coordinate. | From 165c9eb6407197001fad52ec3bdb8d034bc23036 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 10:42:10 +0200 Subject: [PATCH 11/15] Remove missed whitespaces in table --- packages/core/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/packages/core/README.md b/packages/core/README.md index 596906fc6..2fcd20f3d 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -188,14 +188,14 @@ Since this is the base for many functions, the service ID set in this is used to The `<...masterportalAPI.fields>` means that any masterportalAPI field may also be used here _directly_. The most common fields are the following ones; for more, see masterportalAPI. -| fieldName | type | description | +| fieldName | type | description | | - | - | - | -| startResolution | number | Initial resolution; must be in options. See below. | -| startCenter | number[] | Initial center coordinate. | -| extent | number[] | Map movement will be restricted to this rectangle. | -| epsg | string | Leading coordinate system, e.g. `"EPSG:25832"`. | -| options | Array | Defines all available zoomLevels. Entries define `resolution`, `scale`, and `zoomLevel`. See masterportalAPI for details. | -| namedProjections | Array | Array of usable projections by proj4 string. | +| startResolution | number | Initial resolution; must be in options. See below. | +| startCenter | number[] | Initial center coordinate. | +| extent | number[] | Map movement will be restricted to this rectangle. | +| epsg | string | Leading coordinate system, e.g. `"EPSG:25832"`. | +| options | Array | Defines all available zoomLevels. Entries define `resolution`, `scale`, and `zoomLevel`. See masterportalAPI for details. | +| namedProjections | Array | Array of usable projections by proj4 string. | ##### From ab701794db7b580f6bef6b9755eb78e8c1d19aa6 Mon Sep 17 00:00:00 2001 From: Konstantin Holm Date: Wed, 31 Jul 2024 10:58:14 +0200 Subject: [PATCH 12/15] update whitespaces within links --- packages/plugins/Gfi/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/plugins/Gfi/README.md b/packages/plugins/Gfi/README.md index c43f6212c..3f966c613 100644 --- a/packages/plugins/Gfi/README.md +++ b/packages/plugins/Gfi/README.md @@ -45,8 +45,8 @@ Additionally, if using a WMS service, the following properties can be configured | fieldName | type | description | | - | - | - | -| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module - ol_style_Fill - Fill.html) for full options. | -| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module - ol_style_Stroke - Stroke.html) for full options. | +| fill | ol/style/Fill? | Object for defining the fill style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Fill-Fill.html) for full options. | +| stroke | ol/style/Stroke? | Object for defining the stroke style. See [OpenLayers documentation](https://openlayers.org/en/latest/apidoc/module-ol_style_Stroke-Stroke.html) for full options. | ##### gfi.featureList From 81fddfb785771aaa4f502ea890b4197da9758eb1 Mon Sep 17 00:00:00 2001 From: Markus Rullkoetter Date: Wed, 31 Jul 2024 14:35:11 +0200 Subject: [PATCH 13/15] disable map interactions while exporting so potential interaction features won't be exported --- packages/plugins/Export/CHANGELOG.md | 1 + packages/plugins/Export/src/store/actions.ts | 12 ++++++++++++ 2 files changed, 13 insertions(+) diff --git a/packages/plugins/Export/CHANGELOG.md b/packages/plugins/Export/CHANGELOG.md index a2337037e..79d2eff91 100644 --- a/packages/plugins/Export/CHANGELOG.md +++ b/packages/plugins/Export/CHANGELOG.md @@ -4,6 +4,7 @@ - Fix: PDF export with download:false now works correctly. - Fix: Adjust documentation to properly describe optionality of configuration parameters. +- Fix: Map interactions are now disabled during the export process so potential interaction features won't be exported - Chore: Update dependencies to latest versions. ## 1.2.0 diff --git a/packages/plugins/Export/src/store/actions.ts b/packages/plugins/Export/src/store/actions.ts index fd8021a6e..9a7705456 100644 --- a/packages/plugins/Export/src/store/actions.ts +++ b/packages/plugins/Export/src/store/actions.ts @@ -1,5 +1,6 @@ import { jsPDF } from 'jspdf' import { PolarActionTree } from '@polar/lib-custom-types' +import { Interaction } from 'ol/interaction' import { ExportFormat, ExportGetters, ExportState } from '../types' const actions: PolarActionTree = { @@ -25,6 +26,13 @@ const actions: PolarActionTree = { // Screenshot canvas const CANVAS_ID = 'export-canvas' + const disabledInteractions: Array = [] + + map.getInteractions().forEach((interaction) => { + disabledInteractions.push(interaction) + interaction.setActive(false) + }) + map.once('postrender', function () { // Map properties const size = map.getSize() @@ -102,6 +110,10 @@ const actions: PolarActionTree = { } } + disabledInteractions.forEach((interaction) => { + interaction.setActive(true) + }) + commit('setExportedMap', src) }) map.renderSync() From 4113b375d08c2831f5a6da1f5652c3a7052b9c0e Mon Sep 17 00:00:00 2001 From: Markus Rullkoetter Date: Wed, 31 Jul 2024 14:51:53 +0200 Subject: [PATCH 14/15] no need to hold disabled interactions because all are disabled --- packages/plugins/Export/src/store/actions.ts | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/packages/plugins/Export/src/store/actions.ts b/packages/plugins/Export/src/store/actions.ts index 9a7705456..465415657 100644 --- a/packages/plugins/Export/src/store/actions.ts +++ b/packages/plugins/Export/src/store/actions.ts @@ -1,6 +1,5 @@ import { jsPDF } from 'jspdf' import { PolarActionTree } from '@polar/lib-custom-types' -import { Interaction } from 'ol/interaction' import { ExportFormat, ExportGetters, ExportState } from '../types' const actions: PolarActionTree = { @@ -26,10 +25,7 @@ const actions: PolarActionTree = { // Screenshot canvas const CANVAS_ID = 'export-canvas' - const disabledInteractions: Array = [] - map.getInteractions().forEach((interaction) => { - disabledInteractions.push(interaction) interaction.setActive(false) }) @@ -110,7 +106,7 @@ const actions: PolarActionTree = { } } - disabledInteractions.forEach((interaction) => { + map.getInteractions().forEach((interaction) => { interaction.setActive(true) }) From e5349433ca1eac9f56e60fdbad81afc4a18be8e3 Mon Sep 17 00:00:00 2001 From: ludoholic <157684315+ludoholic@users.noreply.github.com> Date: Wed, 31 Jul 2024 15:45:54 +0200 Subject: [PATCH 15/15] Update packages/plugins/Export/CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pascal Röhling <73653210+dopenguin@users.noreply.github.com> --- packages/plugins/Export/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/plugins/Export/CHANGELOG.md b/packages/plugins/Export/CHANGELOG.md index 79d2eff91..f15e833ea 100644 --- a/packages/plugins/Export/CHANGELOG.md +++ b/packages/plugins/Export/CHANGELOG.md @@ -4,7 +4,7 @@ - Fix: PDF export with download:false now works correctly. - Fix: Adjust documentation to properly describe optionality of configuration parameters. -- Fix: Map interactions are now disabled during the export process so potential interaction features won't be exported +- Fix: Disable map interactions during the export process so potential interaction features won't be exported. - Chore: Update dependencies to latest versions. ## 1.2.0