Skip to content

Panel options

Every option the panel exposes, in the order the editor groups them. Path is the key in the panel JSON, which is what you need for dashboards-as-code.

Field mapping

OptionPathDefaultNotes
Field mappingfieldMappingsautodetectionPer query, keyed by refId. Detected values appear as placeholders; set one to override, or None to switch the role off. See Field roles.

Map

OptionPathDefaultNotes
Show side panelshowSidePaneltruekepler's layer and filter panel. Worth hiding on small tiles.
Follow dashboard themefollowGrafanaThemetrueRestyles kepler's chrome from the Grafana theme, and drives Match theme on the base map. See Theme.
Time range synctimeSynctoMaptoMap, bidirectional, variables, off. See Time range sync.
Time window variablestimeVariablesOnly shown when timeSync is variables. The two variables the slider's window is published to, as UTC ISO 8601. See Time window variables.
Update variables while playingpublishWhilePlayingfalseOnly shown when timeSync is variables. Writes the window during playback rather than only when it stops. Costs the animation frames.
Sync time with other mapspeerTimeSyncfalseShares the time filter and trip playhead with the other maps on the dashboard that have this on, in the browser. See Peer time sync.
Trip layertripLayerModetabletable keeps one row per point and every column with it; geojson folds each trip into one row and keeps only the path. See Trajectories.
Flow line styleflowRenderModestraightstraight, curved, animated-straight. See Origin–destination flows.
Base mapbasemapautoauto, dark-matter, positron, voyager, grafana-satellite, grafana-satellite-terrain, grafana-topographic-terrain, custom. See Base maps and relief.
Style URLcustomBasemapUrlOnly shown when basemap is custom. A MapLibre style.json served from your own network.
Raster tile serverrasterServerUrlhttps://titiler.xyzTiTiler-compatible server that turns a COG into tiles, for queries returning a raster_url column. It reads the imagery on the map's behalf, so it has to be able to reach it — the public default cannot see anything private, and is handed the URL you point it at. A .pmtiles URL needs no server and ignores this. See Rasters.
Raster colour ramprasterColormapColour ramp for rasters a query produces: blues, greens, reds, viridis, magma, greys, rdylbu, spectral. Empty leaves kepler's own cfastie, which is built for drone NDVI and is not monotonic — on a continuous field it reads as confetti. Applies to single-band rasters; a true-colour scene is drawn from its bands. See Rasters.
Let the tile server paintrasterPaintedfalseAsk the server for finished pictures (.png) instead of raw values. Needed for a classified raster — land cover, soils — whose colours are a fact of the data: the ramp above cannot express nine named classes, and the browser rescales the class numbers over the whole data-type range, landing every class on one colour. The server reads the palette the file carries instead. The layer then offers only opacity, as PMTiles does. Leave off for imagery. See Rasters.
Zarr value rangezarrRescaleRange a Zarr variable is stretched over, as min,max in the store's own units — 0,30 for mm/day of rain, 270,305 for kelvin. Empty stretches each tile over its own extremes, so neighbouring tiles disagree about what a colour means and the map reads as patchwork. The ramp above is shared. See Zarr stores.

Velocity fields are configured on the layer

There is no wind option here. A flow field's density, trail, cycle and smoothing live in its own panel inside the map, beside its colour — see Velocity fields.

Cross-filtering

OptionPathDefaultNotes
Cross-filteringvariableMappingsA list. Each row binds a column or a click to a dashboard variable. See Cross-filtering.
Publish drawn areaareaVariableWrites the drawn polygon or rectangle to a variable as WKT in EPSG:4326. One way. See Publishing.
Publish viewport (for other panels)viewportVariablesFour variables for the bounding box edges. See Publishing.

The shape of a variableMappings entry

KeyMeaning
fieldthe column the mapping is about; meaningless for coordinate and center
variablethe variable that receives the value — or the latitude for a coordinate pair
variableTothe upper bound of a numeric range — or the longitude for a coordinate pair
sourcefilter (default), click, coordinate, center
zoomfor center only: the zoom to jump to. Absent, the map keeps its zoom

A mapping with both variable and variableTo and no source is a range mapping: the numeric filter on field publishes its min and max as a pair.

Map configuration

OptionPathDefaultNotes
Map configurationsaveRequestThe Save current map button. It is a counter, not a boolean, so repeated saves register.
Import configurationmapConfigThe stored configuration itself, and the textarea for pasting one in. See Map configuration.

Why the save button is a counter

Grafana gives panel option editors no channel to the panel component, and the map state lives in the panel's own Redux store. So the editor bumps a counter and the panel — which can see its store — does the capture.

Options this panel ignores

Grafana's standard field options — unit, decimals, colour scheme, thresholds, value mappings, data links — do not affect the map. Colour comes from kepler's layer configuration; see Colour palettes and scales.

Data links are worth a specific note: a data link on another panel pointing at this one's variables is the basis of the Center mapping, and that works well. Data links configured on this panel do nothing.

Apache-2.0. Bundles kepler.gl (MIT) and flowmap.gl (Apache-2.0).