Skip to content

Commit

Permalink
remove extension ideas (not actually documentation)
Browse files Browse the repository at this point in the history
  • Loading branch information
warm-coolguy committed Mar 25, 2024
1 parent 46e8199 commit 905e636
Show file tree
Hide file tree
Showing 7 changed files with 0 additions and 59 deletions.
4 changes: 0 additions & 4 deletions packages/plugins/Attributions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

This plugin shows attributions (that is, legal information) regarding copyrights and sources of the currently visible layers.

### Extension ideas

- Offer a mode where attributions are always visible. (Not on roadmap.)

## Configuration

### attributions
Expand Down
31 changes: 0 additions & 31 deletions packages/plugins/Gfi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,6 @@ The GFI plugin can be used to fetch and optionally display GFI (GetFeatureInfo)

> ⚠️ The display feature is currently not meant for production. Please use data bindings for display to avoid obstructing the map client.
### Extension ideas

- To ease the currently rather complex WMS GFI parsing, we may send a WMS
GetCapabilities request during initialization to detect supported formats by
services. We may then proceed to choose from the offered formats and have the
parser ready from the get-go. This would also allow for printing error
messages for unspecified formats during start-up time, and for choosing a
better format should the first named (and therefore used by default) format be
unhandy, e.g. be an arbitrary text response.

- Currently, the specification on how to display a GFI is taken from the
mapConfiguration object. The Masterportal does support GFI instructions
specified on the layer definitions within the services.json file itself. That
specification is documented, but a little more complex, and ignored for now,
since we're going for a more configurable client – our users will, in general,
be interested in _one specific layer_, not any layer that might display GFI.

However, we may still support that one day by e.g. a configuration parameter
`useServicesDefinition::boolean`.

- Any entry may be a callback rather than an object/definition

- Display links as `<a ...>Click to open</a>`

- Optionally filter to visible layers

- Reduce features to a single window rather
than showing each feature individually
- By function parameter
- By definition

### Configuration

#### gfi
Expand Down
4 changes: 0 additions & 4 deletions packages/plugins/IconMenu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ It is meant for additional information/functionality (legend, other layers) or p

_Please note that the average user has never seen the client before and just wants to get done with it, not learn a map client._

### Extension ideas

- Content configurability during mapConfiguration (not on roadmap)

## Configuration

> ⚠️ This plugin can't be configured with the `mapConfiguration`, but is configured during client construction. Currently, no way exists to add plugins to it after the build took place.
Expand Down
4 changes: 0 additions & 4 deletions packages/plugins/LoadingIndicator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

A generic loading indicator that may be used by any plugin or outside procedure to indicate loading.

### Extension ideas

- More styles (currently not on roadmap)

## Store

### Mutations
Expand Down
4 changes: 0 additions & 4 deletions packages/plugins/Pins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

The pins plugin handles marking locations. Embedding processes can then use that coordinate for further steps. The plugin may react to other plugins, especially address searches.

### Extension ideas

- Allow multiple pins

## Configuration

The usage of `displayComponent` has no influence on the creation of Pins on the Map if this plugin is being used.
Expand Down
4 changes: 0 additions & 4 deletions packages/plugins/Scale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,3 @@
## Scope

The scale plugin shows the current map resolution as relative scale (1:x) and/or absolute scale (a drawn line has length x units).

## Extension ideas

- offer a selection menu to choose a scale from (done im Masterportal)
8 changes: 0 additions & 8 deletions packages/plugins/Zoom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@

The Zoom plugin offers functionality regarding map zooming.

### Extension ideas

- Support zoom sliders https://openlayers.org/en/latest/examples/zoomslider.html
- Support rectangle zoom (as implemented in POLAR@1 FundstellenDB)
- i.e. there's an activatable button and, while active, user may draw a rectangle; rectangle is then zoomed to

These items are currently not on the roadmap.

## Configuration

The Zoom plugin offers a plus/minus button, and will adjust itself to the map's zoom settings on initialization.
Expand Down

0 comments on commit 905e636

Please sign in to comment.