Skip to content

Commit

Permalink
Merge branch 'main' into update/masterportalapi
Browse files Browse the repository at this point in the history
  • Loading branch information
@dopenguin
dopenguin authored Jul 31, 2024
2 parents adce71e + 1a3ddbc commit 6c92de4
Show file tree
Hide file tree
Showing 14 changed files with 202 additions and 202 deletions.
36 changes: 18 additions & 18 deletions packages/core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ 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. |
| <plugin.fields> | various? | Many plugins added with `addPlugin` may respect additional configuration. Please see the respective plugin documentations. Global plugin parameters are described below. |
| 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. |
| <plugin.fields> | 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. |
Expand Down Expand Up @@ -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.|
Expand Down Expand Up @@ -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 |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| 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. |

##### <plugin.fields>

Expand All @@ -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
Expand Down
Loading

0 comments on commit 6c92de4

Please sign in to comment.