Skip to content

Commit

Permalink
deploy: 98f96ac
Browse files Browse the repository at this point in the history
  • Loading branch information
@dopenguin
dopenguin committed Jun 27, 2024
1 parent b59ea05 commit f31aba3
Show file tree
Hide file tree
Showing 189 changed files with 6,495 additions and 5,620 deletions.
12 changes: 6 additions & 6 deletions docs/afm/core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h4>mapConfiguration</h4>
<tr>
<td>language</td>
<td>enum[&quot;de&quot;, &quot;en&quot;]</td>
<td>Initial language. Live changes not yet implemented, waiting for requirement.</td>
<td>Initial language.</td>
</tr>
<tr>
<td>&lt;...masterportalAPI.fields&gt;</td>
Expand All @@ -94,17 +94,17 @@ <h4>mapConfiguration</h4>
</tr>
<tr>
<td>&lt;plugin.fields&gt;</td>
<td>various</td>
<td>various?</td>
<td>Many plugins added with <code>addPlugin</code> may respect additional configuration. Please see the respective plugin documentations. Global plugin parameters are described below.</td>
</tr>
<tr>
<td>locales</td>
<td>LanguageOption[]</td>
<td>LanguageOption[]?</td>
<td>All locales in POLAR's plugins can be overridden to fit your needs.</td>
</tr>
<tr>
<td>vuetify</td>
<td>object</td>
<td>object?</td>
<td>You may add vuetify configuration here.</td>
</tr>
<tr>
Expand Down Expand Up @@ -376,8 +376,8 @@ <h5>&lt;plugin.fields&gt;</h5>
<tbody>
<tr>
<td>displayComponent</td>
<td>boolean</td>
<td>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.</td>
<td>boolean?</td>
<td>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 <code>false</code> , meaning the default UI is hidden.</td>
</tr>
</tbody>
</table>
Expand Down
149 changes: 92 additions & 57 deletions docs/afm/plugin-address-search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ <h3>addressSearch</h3>
</thead>
<tbody>
<tr>
<td>minLength</td>
<td>number</td>
<td>Minimal input length after which searches are started.</td>
<td>searchMethods</td>
<td>searchMethodsObject[]</td>
<td>Array of search method descriptions. Only searches configured here can be used.</td>
</tr>
<tr>
<td>waitMs</td>
<td>number</td>
<td>Debounce time in ms for search requests after last user input.</td>
<td>addLoading</td>
<td>string?</td>
<td>Optional loading action name to start loading.</td>
</tr>
<tr>
<td>searchMethods</td>
<td>searchMethodsObject[]</td>
<td>Array of search method descriptions. Only searches configured here can be used.</td>
<td>categoryProperties</td>
<td>Record&lt;string, categoryProperties&gt;?</td>
<td>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.</td>
</tr>
<tr>
<td>customSearchMethods</td>
Expand All @@ -72,11 +72,6 @@ <h3>addressSearch</h3>
<td>An object that maps categoryIds to functions. These functions are then called as vuex store actions instead of the <code>selectResult</code> default implementation. This allows overriding selection behaviour with full store access. Use <code>''</code> as key for categoryless results.</td>
</tr>
<tr>
<td>categoryProperties</td>
<td>Record&lt;string, categoryProperties&gt;?</td>
<td>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.</td>
</tr>
<tr>
<td>focusAfterSearch</td>
<td>boolean?</td>
<td>Whether the focus should switch to the first result after a successful search. Defaults to <code>false</code>.</td>
Expand All @@ -86,6 +81,21 @@ <h3>addressSearch</h3>
<td>Record&lt;string, groupProperties&gt;?</td>
<td>An object defining properties for a group. The searchMethod's groupId is used as identifier. All services without groupId fall back to the key <code>&quot;defaultGroup&quot;</code>.</td>
</tr>
<tr>
<td>minLength</td>
<td>number?</td>
<td>Minimal input length after which searches are started. Defaults to 0.</td>
</tr>
<tr>
<td>removeLoading</td>
<td>string?</td>
<td>Optional loading action name to end loading.</td>
</tr>
<tr>
<td>waitMs</td>
<td>number?</td>
<td>Debounce time in ms for search requests after last user input. Defaults to 0.</td>
</tr>
</tbody>
</table>
<h4>addressSearch.searchMethodsObject</h4>
Expand All @@ -99,44 +109,44 @@ <h4>addressSearch.searchMethodsObject</h4>
</thead>
<tbody>
<tr>
<td>queryParameters</td>
<td>object</td>
<td>The object further describes details for the search request. Its contents vary by service type, see documentation below.</td>
<td>type</td>
<td>enum[&quot;bkg&quot;, &quot;gazetteer&quot;, &quot;wfs&quot;, &quot;mpapi&quot;]</td>
<td>Service type. Enum can be extended by configuration, see <code>addressSearch.customSearchMethods</code>. ⚠️ &quot;gazetteer&quot; is deprecated. Please use &quot;mpapi&quot; instead.</td>
</tr>
<tr>
<td>label</td>
<td>url</td>
<td>string</td>
<td>Search service URL. Should you require a service provider, please contact us for further information.</td>
</tr>
<tr>
<td>categoryId</td>
<td>string?</td>
<td>Display label. Can be a locale key. If grouped with other services, the group's label will be used instead.</td>
<td>Grouped services can optionally be distinguished in the UI with categories. See <code>addressSearch.categoryProperties</code> for configuration options.</td>
</tr>
<tr>
<td>placeholder</td>
<td>groupId</td>
<td>string?</td>
<td>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.</td>
<td>Default groupId is <code>&quot;defaultGroup&quot;</code>. All services with the same id are grouped and used together. See <code>addressSearch.groupProperties</code> for configuration options. If multiple groups exist, the UI offers a group switcher.</td>
</tr>
<tr>
<td>hint</td>
<td>string?</td>
<td>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.</td>
</tr>
<tr>
<td>type</td>
<td>enum[&quot;bkg&quot;, &quot;gazetteer&quot;, &quot;wfs&quot;, &quot;mpapi&quot;]</td>
<td>Service type. Enum can be extended by configuration, see <code>addressSearch.customSearchMethods</code>. ⚠️ &quot;gazetteer&quot; is deprecated. Please use &quot;mpapi&quot; instead.</td>
</tr>
<tr>
<td>url</td>
<td>string</td>
<td>Search service URL. Should you require a service provider, please contact us for further information.</td>
<td>label</td>
<td>string?</td>
<td>Display label. Can be a locale key. If grouped with other services, the group's label will be used instead.</td>
</tr>
<tr>
<td>groupId</td>
<td>placeholder</td>
<td>string?</td>
<td>Default groupId is <code>&quot;defaultGroup&quot;</code>. All services with the same id are grouped and used together. See <code>addressSearch.groupProperties</code> for configuration options. If multiple groups exist, the UI offers a group switcher.</td>
<td>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.</td>
</tr>
<tr>
<td>categoryId</td>
<td>string?</td>
<td>Grouped services can optionally be distinguished in the UI with categories. See <code>addressSearch.categoryProperties</code> for configuration options.</td>
<td>queryParameters</td>
<td>object?</td>
<td>The object further describes details for the search request. Its contents vary by service type, see documentation below.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -182,25 +192,25 @@ <h4>addressSearch.groupProperties</h4>
<td>Display label. Can be a locale key.</td>
</tr>
<tr>
<td>placeholder</td>
<td>string?</td>
<td>Placeholder string to display on input element. Can be a locale key.</td>
<td>resultDisplayMode</td>
<td>enum['mixed', 'categorized']</td>
<td>Defaults to <code>'mixed'</code>. In <code>'mixed'</code>, results of all requested services are offered in a list in no specific order. In <code>'categorized'</code>, the results are listed by their searchService's categoryId.</td>
</tr>
<tr>
<td>hint</td>
<td>string?</td>
<td>Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key.</td>
</tr>
<tr>
<td>resultDisplayMode</td>
<td>enum['mixed', 'categorized']</td>
<td>Defaults to <code>'mixed'</code>. In <code>'mixed'</code>, results of all requested services are offered in a list in no specific order. In <code>'categorized'</code>, the results are listed by their searchService's categoryId.</td>
</tr>
<tr>
<td>limitResults</td>
<td>number?</td>
<td>If set, only the first <code>n</code> results (per category in <code>categorized</code>) are displayed initially. All further results can be opened via UI.</td>
</tr>
<tr>
<td>placeholder</td>
<td>string?</td>
<td>Placeholder string to display on input element. Can be a locale key.</td>
</tr>
</tbody>
</table>
<h4>addressSearch.categoryProperties</h4>
Expand Down Expand Up @@ -233,8 +243,8 @@ <h5>addressSearch.searchMethodsObject.queryParameters (type:common)</h5>
<tbody>
<tr>
<td>maxFeatures</td>
<td>number</td>
<td>Maximum amount of features to retrieve.</td>
<td>number?</td>
<td>Maximum amount of features to retrieve. Doesn't limit results if not set.</td>
</tr>
</tbody>
</table>
Expand All @@ -249,30 +259,45 @@ <h5>addressSearch.searchMethodsObject.queryParameters (type:wfs)</h5>
</thead>
<tbody>
<tr>
<td>typeName</td>
<td>featurePrefix</td>
<td>string</td>
<td>Feature type to search for by name.</td>
<td>XML feature prefix for WFS service.</td>
</tr>
<tr>
<td>featurePrefix</td>
<td>typeName</td>
<td>string</td>
<td>XML feature prefix for WFS service.</td>
<td>Feature type to search for by name.</td>
</tr>
<tr>
<td>xmlns</td>
<td>string</td>
<td>XML namespace to use in search.</td>
</tr>
<tr>
<td>fieldName</td>
<td>string?</td>
<td>Name of the type's field to search in. Mutually exclusive to <code>patterns</code>.</td>
</tr>
<tr>
<td>patterns</td>
<td>string[]</td>
<td>Allows specifying input patterns. In a single-field search, a pattern can be as easy as <code>{{theWholeThing}}</code>, where <code>theWholeThing</code> is also the feature field name to search in. In more complex scenarios, you may add separators and multiple fields, e.g. <code>{{gemarkung}} {{flur}} {{flstnrzae}}/{{flstnrnen}}</code> would fit many parcel search services.</td>
<td>string[]?</td>
<td>Allows specifying input patterns. In a single-field search, a pattern can be as easy as <code>{{theWholeThing}}</code>, where <code>theWholeThing</code> is also the feature field name to search in. In more complex scenarios, you may add separators and multiple fields, e.g. <code>{{gemarkung}} {{flur}} {{flstnrzae}}/{{flstnrnen}}</code> would fit many parcel search services. Mutually exclusive to <code>fieldName</code>.</td>
</tr>
<tr>
<td>patternKeys</td>
<td>Record&lt;string, string&gt;</td>
<td>Record&lt;string, string&gt;?</td>
<td>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. <code>'([0-9]+)$'</code> would be a value for a key that fits an arbitrary number string at the input's end.</td>
</tr>
<tr>
<td>srsName</td>
<td>string?</td>
<td>Name of the projection (srs) for the query.</td>
</tr>
<tr>
<td>useRightHandWildcard?</td>
<td>boolean?</td>
<td>By default, if searching for &quot;search&quot;, it is sent as &quot;search*&quot;. This behaviour can be deactivated by setting this parameter to <code>false</code>.</td>
</tr>
</tbody>
</table>
<p>Since inputs may overlap with multiple patterns, multiple queries are fired and executed on the WFS until the <code>maxFeatures</code> requirement is met, beginning with the pattern that 'looks like the user input the most'. The best-fitting pattern on the returned features will be used to generate a display string. When two patterns fit best, the first one is used.</p>
Expand All @@ -290,25 +315,35 @@ <h5>addressSearch.searchMethodsObject.queryParameters (type:gazetteer)</h5>
</thead>
<tbody>
<tr>
<td>epsg</td>
<td><code>EPSG:${string}</code></td>
<td>EPSG code of the projection to use.</td>
</tr>
<tr>
<td>fieldName</td>
<td>string[]</td>
<td>Field names of service to search in.</td>
</tr>
<tr>
<td>memberSuffix</td>
<td>string</td>
<td>Elements to interpret are fetched from response XML as <code>wfs:memberSuffix</code>; fitting suffix must be configured.</td>
</tr>
<tr>
<td>namespaces</td>
<td>string[]</td>
<td>string | string[]</td>
<td>Namespaces to add to the request.</td>
</tr>
<tr>
<td>fieldName</td>
<td>string[]</td>
<td>Field names of service to search in.</td>
</tr>
<tr>
<td>storedQueryId</td>
<td>string</td>
<td>Name of the WFS-G stored query that is to be used.</td>
</tr>
<tr>
<td>version</td>
<td>'1.1.0' | '2.0.0'?</td>
<td>WFS version used. Defaults to <code>'2.0.0'</code>.</td>
</tr>
</tbody>
</table>
<h5>addressSearch.searchMethodsObject.queryParameters (type:mpapi)</h5>
Expand Down
18 changes: 9 additions & 9 deletions docs/afm/plugin-attributions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,29 +38,29 @@ <h3>attributions</h3>
</thead>
<tbody>
<tr>
<td>initiallyOpen</td>
<td>boolean?</td>
<td>Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this.</td>
</tr>
<tr>
<td>layerAttributions</td>
<td>layerAttribution[]?</td>
<td>List of attributions that are shown when the matching layer is visible.</td>
</tr>
<tr>
<td>staticAttributions</td>
<td>listenToChanges</td>
<td>string[]?</td>
<td>List of static attributions that are always shown.</td>
<td>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 <code>addPlugins</code> before this one.</td>
</tr>
<tr>
<td>renderType</td>
<td>'iconMenu' | 'independent'?</td>
<td>Whether this plugin ('independent') or the IconMenu should handle opening the information box. Defaults to 'independent'.</td>
</tr>
<tr>
<td>listenToChanges</td>
<td>staticAttributions</td>
<td>string[]?</td>
<td>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 <code>addPlugins</code> before this one.</td>
</tr>
<tr>
<td>initiallyOpen</td>
<td>boolean?</td>
<td>Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this.</td>
<td>List of static attributions that are always shown.</td>
</tr>
<tr>
<td>windowWidth</td>
Expand Down
Loading

0 comments on commit f31aba3

Please sign in to comment.