Alex Khomenko
d660e3acb9
* Geomap: Update to panelcfg * Generate geomappanelcfg docs --------- Co-authored-by: Tania B <yalyna.ts@gmail.com>
5.9 KiB
5.9 KiB
keywords, title
| keywords | title | ||
|---|---|---|---|
|
GeomapPanelCfg kind |
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
GeomapPanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Description |
|---|---|---|---|
ControlsOptions |
object | Yes | |
MapCenterID |
string | Yes | Possible values are: zero, coords, fit. |
MapViewConfig |
object | Yes | |
PanelOptions |
object | Yes | |
TooltipMode |
string | Yes | Possible values are: none, details. |
TooltipOptions |
object | Yes |
ControlsOptions
| Property | Type | Required | Description |
|---|---|---|---|
mouseWheelZoom |
boolean | No | let the mouse wheel zoom |
showAttribution |
boolean | No | Lower right |
showDebug |
boolean | No | Show debug |
showMeasure |
boolean | No | Show measure |
showScale |
boolean | No | Scale options |
showZoom |
boolean | No | Zoom (upper left) |
MapViewConfig
| Property | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | Default: zero. |
allLayers |
boolean | No | Default: true. |
lastOnly |
boolean | No | |
lat |
integer | No | Default: 0. |
layer |
string | No | |
lon |
integer | No | Default: 0. |
maxZoom |
integer | No | |
minZoom |
integer | No | |
padding |
integer | No | |
shared |
boolean | No | |
zoom |
integer | No | Default: 1. |
PanelOptions
| Property | Type | Required | Description |
|---|---|---|---|
basemap |
MapLayerOptions | Yes | |
controls |
ControlsOptions | Yes | |
layers |
MapLayerOptions[] | Yes | |
tooltip |
TooltipOptions | Yes | |
view |
MapViewConfig | Yes |
MapLayerOptions
| Property | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | configured unique display name |
type |
string | Yes | |
config |
No | Custom options depending on the type | |
filterData |
No | Defines a frame MatcherConfig that may filter data for the given layer | |
location |
FrameGeometrySource | No | |
opacity |
integer | No | Common properties: https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html Layer opacity (0-1) |
tooltip |
boolean | No | Check tooltip (defaults to true) |
FrameGeometrySource
| Property | Type | Required | Description |
|---|---|---|---|
mode |
string | Yes | Possible values are: auto, geohash, coords, lookup. |
gazetteer |
string | No | Path to Gazetteer |
geohash |
string | No | Field mappings |
latitude |
string | No | |
longitude |
string | No | |
lookup |
string | No | |
wkt |
string | No |
TooltipOptions
| Property | Type | Required | Description |
|---|---|---|---|
mode |
string | Yes | Possible values are: none, details. |