Skip to content

Commit 030c479

Browse files
Apply suggestions from code review
Co-authored-by: Dennis Sen <108349707+warm-coolguy@users.noreply.github.com>
1 parent 065d21e commit 030c479

File tree

4 files changed

+11
-17
lines changed

4 files changed

+11
-17
lines changed

packages/core/README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,11 @@ const Plugin = (options: PluginOptions) => (instance: Vue) =>
4646
})
4747
```
4848

49-
Please note that the order of certain plugins is relevant when other plugins are referenced, e.g. `@polar/plugin-gfi` `coordinateSources`.
49+
Please note that the order of certain plugins is relevant when other plugins are referenced, e.g. `@polar/plugin-gfi`'s `coordinateSources` requires the sources to have previously been set up.
5050

51-
However, please note that the values are overwritten by the `mapConfiguration`.
52-
These values can be defined in both places.
51+
Please note that all configuration added via plugin constructors can be overridden in the `createMap`'s parameter `mapConfiguration`. You may use either object (or a mix of them) to create the configuration, e.g. use the constructors for a base configuration and the `mapConfiguration` object to override it for various use cases.
52+
53+
How exactly you do this is up to you and influences the minimum API call requirements your client has.
5354

5455
If the storeModule features a `setupModule` action, it will be executed automatically after initialization.
5556

@@ -522,14 +523,7 @@ You may desire to listen to whether the loader is currently being shown.
522523

523524
| fieldName | type | description |
524525
| - | - | - |
525-
| components | Array | Returns the components object. |
526-
| deviceIsHorizontal | boolean | Returns true if the device is horizontal based on small height and window size. |
527-
| hasSmallHeight | boolean | Returns true if the client height is less than or equal to the small display height. |
528-
| hasSmallWidth | boolean | Returns true if the client width is less than or equal to the small display width. |
529-
| hasWindowSize | boolean | Returns true if the window size matches the client size. |
530-
| hovered | Feature \| null | Returns the hovered object. |
531-
| map | Map \| null | Returns the map object. |
532-
| moveHandle | MoveHandleProperties \| null | Returns the move handle object. |
533-
| moveHandleActionButton | MoveHandleActionButton \| null | Returns the move handle action button object. |
534-
| selected | Feature \| null | Returns the selected object. |
535-
| selectedCoordinates | Array \| null | Returns the coordinates of the selected object if it is a Point geometry or null if no object is selected. |
526+
| map | Map \| null | Returns the openlayers map object. |
527+
| hovered | Feature \| null | If `useExtendedMasterportalApiMarkers` is active, this will return the currently hovered marker. Please mind that it may be a clustered feature. |
528+
| selected | Feature \| null | If `useExtendedMasterportalApiMarkers` is active, this will return the currently selected marker. Please mind that it may be a clustered feature. |
529+
| selectedCoordinates | Array \| null | If `useExtendedMasterportalApiMarkers` is active, this will return the coordinates of the currently selected marker. |

packages/plugins/Gfi/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ customHighlightStyle: {
161161

162162
| fieldName | type | description |
163163
| - | - | - |
164-
| mode | 'visible' \| 'loaded' | Whether to show only features currently visible in the map view's bounding box or to display all loaded features. In the latter case, if you desire to display all features of a layer (seen or not), set its loading strategy to `'all'`. The loading strategy is a value in the WFS configuration. |
164+
| mode | 'visible' \| 'loaded' | Whether to show only features currently visible in the map view's bounding box or to display all loaded features. In the latter case, if you desire to display all features of a layer (seen or not), set its loading strategy to `'all'`. The loading strategy is a value in the OpenLayers vector source configuration; see [ol/loadingStrategy](https://openlayers.org/en/latest/apidoc/module-ol_loadingstrategy.html) for further details. |
165165
| bindWithCoreHoverSelect | boolean? | If `true`, the hover/select fields in the core's state will be listened to and interacted with. This will result in a bilateral hovering and selecting of features with the core. Defaults to `false`. |
166166
| pageLength | number? | A number >0 that sets the limit to the feature list's length. If the length is surpassed, additional features can be reached by using the pagination that is generated in such a case. If not defined, the list can be of arbitrary length. |
167167
| text | (function \| string)[]? | Array of one to three entries that will produce title, subtitle, and an additional subtitle for the list view. If string, the text item will simply be that feature's value for the denoted property. If function, it's assumed to match the function signature `(feature: OpenLayersFeature): string`, and the returned string will be used for the text item. |

packages/plugins/Legend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Legend
22

3-
The Legend module offers legend images as supplied by OGC services via GetLegendGraphic and GetLegendURL-Calls.
3+
The Legend module offers legend images as supplied by OGC services via `GetLegendGraphic` and `GetLegendURL` calls.
44

55
## Configuration
66

packages/plugins/Pins/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The usage of `displayComponent` has no influence on the creation of Pins on the
1919
| initial | initial? | Configuration options for setting an initial pin. |
2020
| movable | enum["drag", "click", "none"]? | Whether a user may drag and re-click the pin (`drag`), only re-click it (`click`) or may only be placed programmatically (`none`). Defaults to 'none'. |
2121
| style | style? | Display style configuration. |
22-
| toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as the path to an action within the store to send a toast notification to the user. If no toast information is desired, leave this field undefined; for testing purposes, you can still find information in the console. |
22+
| toastAction | string? | If `boundaryLayerId` is set, and the pin is moved or created outside the boundary, this string will be used as the path to an action within the store to send a toast notification to the user. If no toast notification is desired, leave this field undefined; for testing purposes, you can still find information in the console. |
2323
| toZoomLevel | number? | Zoom level to use on outside input by e.g. address search. Defaults to `0`. |
2424

2525

0 commit comments

Comments
 (0)