Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@matthiasstein
matthiasstein committed Jan 30, 2024
1 parent 3e22952 commit f0e07bc
Showing 1 changed file with 52 additions and 45 deletions.
97 changes: 52 additions & 45 deletions src/main/js/bundles/dn_selectionactions/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,46 @@ Configure the available selection methods in the selection-ui bundle. The ones a
```

## Configuration Reference

### AreaSelectSpatialInputWidgetModel:

```json
"AreaSelectSpatialInputWidgetModel": {
"buffer": 0,
"stepSize": 1000,
"unit": "meters"
}
```
| Property | Type | Possible Values | Default | Description |
|--------------------------------|---------|--------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------|
| buffer | Number | | ```0``` |Buffer | |
| stepSize | Number | | ```1000``` | Step size |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | |

| Property | Type | Possible Values | Default | Description |
| -------- | ------ | ------------------------------------------------------ | ------------ | ----------- |
| buffer | Number | | ```0``` | Buffer | |
| stepSize | Number | | ```1000``` | Step size |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | |

Use _selection-actions-area_ useIn-property to show stores in the area selection widget.
Use the priority property to define an order of the stores (Stores with a higher priority are placed at the top of the store selection list).

```json
{
"id": "bundeslaender",
"url": "https://services.conterra.de/arcgis/rest/services/common/grenzen/FeatureServer/2",
"title": "Bundesländer",
"description": "Bundesländer",
"fetchIdProperty": true,
"filterOptions": {
"suggestContains": true
},
"priority": 2,
"useIn": [
"selection",
"selection-actions-area"
]
}
```

### CircleSpatialInputWidgetModel:

```json
"CircleSpatialInputWidgetModel": {
"enableDonut": true,
Expand All @@ -60,19 +86,21 @@ Configure the available selection methods in the selection-ui bundle. The ones a
"unit": "meters"
}
```
| Property | Type | Possible Values | Default | Description |
|--------------------------------|---------|--------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------|
| enableDonut | Boolean | ```true``` | ```false``` | ```true``` | Enable inner and outer radius. If disabled only outer radius will be used. |
| minRadius | Number | | ```0``` | Minimal radius |
| maxRadius | Number | | ```500000``` | Maximum radius |
| innerRadius | Number | | ```50000``` | Initial inner radius |
| outerRadius | Number | | ```100000``` | Initial outer radius |
| stepSize | Number | | ```1000``` | Step size |
| adjustStepSize | Boolean | ```true``` | ```false``` | ```false``` | Enables or disables scale based stepSize adjustments |
| stepSizeRanges | Array | | ```see sample``` | Array containing objects with disjunct scale ranges desired stepSize for these ranges |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | Circle radius unit (https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) |

| Property | Type | Possible Values | Default | Description |
| -------------- | ------- | ------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------- |
| enableDonut | Boolean | ```true``` | ```false``` | ```true``` | Enable inner and outer radius. If disabled only outer radius will be used. |
| minRadius | Number | | ```0``` | Minimal radius |
| maxRadius | Number | | ```500000``` | Maximum radius |
| innerRadius | Number | | ```50000``` | Initial inner radius |
| outerRadius | Number | | ```100000``` | Initial outer radius |
| stepSize | Number | | ```1000``` | Step size |
| adjustStepSize | Boolean | ```true``` | ```false``` | ```false``` | Enables or disables scale based stepSize adjustments |
| stepSizeRanges | Array | | ```see sample``` | Array containing objects with disjunct scale ranges desired stepSize for these ranges |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | Circle radius unit (https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Circle.html#radiusUnit) |

### GraphicSpatialInputWidgetModel:

```json
"GraphicSpatialInputWidgetModel": {
"buffer":0,
Expand All @@ -83,38 +111,17 @@ Configure the available selection methods in the selection-ui bundle. The ones a
}
```

| Property | Type | Possible Values | Default | Description |
|--------------------------------|---------|--------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------|
| buffer | Number | | ```0``` | Buffer |
| minBuffer | Number | | ```0``` | Minimal buffer |
| maxBuffer | Number | | ```500000``` | Maximum buffer |
| stepSize | Number | | ```1000``` | Step size |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | |

### AreaSelectSpatialInputWidgetModel:
Use _selection-actions-area_ useIn-property to show stores in the area selection widget.
Use the priority property to define an order of the stores (Stores with a higher priority are placed at the top of the store selection list).

```json
{
"id": "bundeslaender",
"url": "https://services.conterra.de/arcgis/rest/services/common/grenzen/FeatureServer/2",
"title": "Bundesländer",
"description": "Bundesländer",
"fetchIdProperty": true,
"filterOptions": {
"suggestContains": true
},
"priority": 2,
"useIn": [
"selection",
"selection-actions-area"
]
}
```
| Property | Type | Possible Values | Default | Description |
| --------- | ------ | ------------------------------------------------------ | ------------ | -------------- |
| buffer | Number | | ```0``` | Buffer |
| minBuffer | Number | | ```0``` | Minimal buffer |
| maxBuffer | Number | | ```500000``` | Maximum buffer |
| stepSize | Number | | ```1000``` | Step size |
| unit | String | ```meters``` | ```kilometers``` | ```feet``` | ```meters``` | |

### MultiPointSpatialInputAction
The MultiPointSpatialInputAction allows for the configuration of buffering around the clicked location. The default value and necessary configuration are depicted below.

````json
"dn_selectionactions": {
"MultiPointSpatialInputAction": {
Expand Down

0 comments on commit f0e07bc

Please sign in to comment.