opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 21:12:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
Tania f0333ac41f Codegen: Render constraints in generated docs (#63196) 
* Add constraints rendering

* Generate docs

* Fix constraint format

* Add type alias

* Compare numbers as strings

* fixup! Compare numbers as strings

* Add missing return
2023-02-10 06:40:50 -05:00

5.9 KiB
Raw Blame History

keywords title
grafana
schema
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 int64 No Default: 0.
layer string No
lon int64 No Default: 0.
maxZoom integer No
minZoom integer No
padding integer No
shared boolean No
zoom int64 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.