opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 05:12:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md
sam boyer 09895c26b6 Chore: Hacky first pass on generating composable kinds within grafana/schema (#64723) 
* Super hacky first pass on gen types

* First sketchy pass at generated compo kinds in TS, grok-style

* Merge fix

* Create jenny for MajorsOrX for plugins

* Re-generate files with imports

* Delete invalid generated file

* Fix cue

* Update go.mod

* Update schemas

* Fix go-imports

* Regenerate cue files

---------

Co-authored-by: spinillos <selenepinillos@gmail.com>
2023-05-30 05:56:18 -07:00

6.4 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 Default Description
ControlsOptions object Yes
MapCenterID string Yes Possible values are: zero, coords, fit.
MapViewConfig object Yes
Options object Yes
TooltipMode string Yes Possible values are: none, details.
TooltipOptions object Yes

ControlsOptions

Property Type Required Default 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 Default Description
id string Yes zero
allLayers boolean No true
lastOnly boolean No
lat int64 No 0
layer string No
lon int64 No 0
maxZoom integer No
minZoom integer No
padding integer No
shared boolean No
zoom int64 No 1

Options

Property Type Required Default Description
basemap MapLayerOptions Yes
controls ControlsOptions Yes
layers MapLayerOptions[] Yes
tooltip TooltipOptions Yes
view MapViewConfig Yes

MapLayerOptions

Property Type Required Default 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 Default 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 Default Description
mode string Yes Possible values are: none, details.