Interface: GeoOptions
Experimental
Options every map function takes: the locations and the geo subplot.
Extends
Extended by
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
animationFrame? | readonly | ColumnRef | Column of frame values: one frame per value (in categoryOrders / first-appearance order), with a Play / Pause update menu and a slider. Axis ranges are fixed across frames. | AnimationFrameOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | AnimationFrameOptions.animationGroup |
basemapVisible? | readonly | boolean | Experimental false hides the base map: coastlines, land, borders and the frame (geo.visible). | - |
categoryOrders? | readonly | Readonly<Record<string, readonly unknown[]>> | Value orders per column: { day: ['Thu', 'Fri', 'Sat', 'Sun'] }. They order the traces and legend (for grouping columns), facets, frames and category axes. Values not listed follow in order of first appearance; listed values without rows still take a color and a facet (as px). | CommonOptions.categoryOrders |
center? | readonly | object | Experimental The point at the middle of the map, in degrees (geo.center). | - |
center.lat? | readonly | number | - | - |
center.lon? | readonly | number | - | - |
color? | readonly | ColumnRef | Column to color by. | DiscreteColorOptions.color |
colorDiscreteMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed colors per value of color ({ Asia: 'red' }); other values continue with the sequence. 'identity': the values are colors themselves (no legend entries for them). | DiscreteColorOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | DiscreteColorOptions.colorDiscreteSequence |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | HoverOptions.customData |
facetCol? | readonly | ColumnRef | Column whose values make the columns of subplots. | FacetOptions.facetCol |
facetColSpacing? | readonly | number | Space between facet columns, as a fraction of the plot width. Default 0.02. | FacetOptions.facetColSpacing |
facetColWrap? | readonly | number | Wrap facetCol after this many columns (row by row from the top). Ignored with facetRow or a marginal. Default 0 (no wrapping). | FacetOptions.facetColWrap |
facetRow? | readonly | ColumnRef | Column whose values make the rows of subplots (first value at the top). | FacetOptions.facetRow |
facetRowSpacing? | readonly | number | Space between facet rows, as a fraction of the plot height. Default 0.03 (0.07 wrapped). | FacetOptions.facetRowSpacing |
featureIdKey? | readonly | string | Experimental Key of the geojson features matched against locations (featureidkey). Default 'id'. | - |
fitBounds? | readonly | false | "locations" | "geojson" | Experimental Fit the view to the data (geo.fitbounds): 'locations', 'geojson' or false. Default: unset, so the map fits its locations (Holochart's default); false with animationFrame, so the view holds still across frames. | - |
geojson? | readonly | string | object | Experimental GeoJSON whose features locations refer to: a FeatureCollection or Feature, or a URL of one. Every trace gets the object itself, not a copy. | - |
height? | readonly | number | Figure height in px (layout.height). | CommonOptions.height |
hoverData? | readonly | | readonly ColumnRef[] | Readonly<Record<string, string | boolean>> | More columns for the hover label, through customdata: a list of columns, or an object that adds columns (true), removes lines (false, e.g. { x: false }) or formats them (':.2f', `' | %Y'`). |
hoverName? | readonly | ColumnRef | Column shown in bold at the top of the hover label (hovertext). | HoverOptions.hoverName |
labels? | readonly | Readonly<Record<string, string>> | Display names of columns: { gdpPercap: 'GDP per capita' }. Used for axis titles, hover lines, the legend title, facet labels, the colorbar title and the animation slider. | CommonOptions.labels |
locationMode? | readonly | "ISO-3" | "USA-states" | "country names" | "geojson-id" | Experimental What locations name (locationmode): 'ISO-3' country codes (the default), 'USA-states', 'country names', or 'geojson-id' (the default with geojson). | - |
locations? | readonly | ColumnRef | Experimental Column of location ids or names (see locationMode): the regions of a choropleth, or the places of markers and lines instead of lat / lon. | - |
projection? | readonly | string | Experimental The map projection (geo.projection.type): 'natural earth', 'orthographic', 'mercator', …, or 'globe3d', a Holochart extra (a 3D globe). Default: the scope's ('equirectangular' for the world). | - |
scope? | readonly | | "world" | "usa" | "europe" | "asia" | "africa" | "north america" | "south america" | "antarctica" | "oceania" | Experimental The part of the world the base map covers (geo.scope): the world, the USA or a continent. Default 'world'. | - |
template? | readonly | string | Template | layout.template: a registered name ('plotly-classic') or a template object. Default: unset, so the chart's default template applies (Holochart's holochart look); its colorway, symbol and dash cycles and sequential colorscale are what the figure's colors are taken from. | CommonOptions.template |
title? | readonly | string | Figure title (layout.title.text). | CommonOptions.title |
width? | readonly | number | Figure width in px (layout.width). | CommonOptions.width |