Skip to content

Commit

Permalink
#9396 Review annotations UI and system (#9397)
Browse files Browse the repository at this point in the history
Co-authored-by: Lorenzo Natali <[email protected]>
  • Loading branch information
allyoucanmap and offtherailz authored Sep 13, 2023
1 parent e79919e commit 37f6c60
Show file tree
Hide file tree
Showing 127 changed files with 7,630 additions and 10,148 deletions.
2 changes: 1 addition & 1 deletion build/docma-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@
"plugins": [
"web/client/plugins/index.jsdoc",
"web/client/plugins/AddGroup.jsx",
"web/client/plugins/Annotations.jsx",
"web/client/plugins/Annotations/index.js",
"web/client/plugins/AutoMapUpdate.jsx",
"web/client/plugins/BackgroundSelector.jsx",
"web/client/plugins/BurgerMenu.jsx",
Expand Down
29 changes: 0 additions & 29 deletions docs/developer-guide/local-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,35 +241,6 @@ CSW service

<br>

#### Annotations Editor configuration

Annotations editor can be configured by setting it's defaultState. It looks like this:

```javascript
"defaultState": {
...
"annotations": {
"config": {
"geometryEditorOptions": {
"measureOptions": {
"displayUom": "nm"
}
},
"multiGeometry": true,
"validationErrors": {},
"defaultPointType": "symbol"
},
"format": "aeronautical",
"defaultTextAnnotation": "New"
},
```
- **format** - decimal or aeronautical degree for coordinates
- **defaultTextAnnotation** - default text value for text annotations
- **config.geometryEditorOptions** - properties to be passed to CoordinatesEditor of GeometryEditor. For more information refer to the documentation of CoordinatesEditor component
- **config.multiGeometry** - if set to true allows to add more then one geometry to annotations
- **config.defaultPointType** - default point type of marker geometry type. Can be 'marker' or 'symbol'
### projectionDefs configuration

Custom CRS can be configured here, at root level of localConfig.json file. For example:
Expand Down
15 changes: 15 additions & 0 deletions docs/developer-guide/mapstore-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,21 @@ This is a list of things to check if you want to update from a previous version
- Optionally check also accessory files like `.eslinrc`, if you want to keep aligned with lint standards.
- Follow the instructions below, in order, from your version to the one you want to update to.

## Migration from 2023.02.xx to 2024.01.00

### Annotations plugin refactor

The Annotation plugin has been updated to be supported also in 3D maps. This update introduced some changes:

- All the configurations related to the "Annotations" plugin has been removed from `localConfig.json` `defaultState` entry and moved to the `cfg` property of the plugin
- The annotations reducers is not needed anymore inside the default reducers of the app

Please update by:

- Removing `annotations` entry from your `localConfig.json` `defaultState`
- If you customized the app, you can remove the `annotations` reducer from default reducers.
- If some customizations were applied to the Annotations plugin in `defaultState`, apply these changes to the plugin configuration, following the documentation of the plugin.

## Migration from 2023.01.xx to 2023.02.00

### About plugin cfg changes
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
"@mapbox/togeojson": "0.16.0",
"@mapstore/patcher": "https://github.com/geosolutions-it/Patcher/tarball/master",
"@turf/along": "6.5.0",
"@turf/area": "6.5.0",
"@turf/bbox": "4.1.0",
"@turf/bbox-polygon": "5.1.5",
"@turf/boolean-clockwise": "6.5.0",
Expand Down
Loading

0 comments on commit 37f6c60

Please sign in to comment.