IGeoChartConfig
Unified configuration shared by GeoChart() and its wrappers.
export interface IGeoChartConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Area-specific options (opacity, border styling, …). | |||
(ALPHA) (Optional) Selected basemap style identifier (e.g. | |||
(Optional) Bounding box for custom viewport. Takes priority over center/zoom and adapts to container dimensions. | |||
(Optional) Initial map center. Defaults to auto-centering based on data. | |||
(Optional) Explicit color-mapping overrides. | |||
(Optional) Structured color palette compatible with color mapping GUIDs. | |||
string[] | (Optional) Simple palette expressed as color strings. | ||
boolean | (Optional) Requires Ctrl/Cmd + scroll to zoom (helps inside scroll containers). | ||
(ALPHA) (Optional) Custom tooltip configuration with Markdown content and metric/attribute references. | |||
boolean | (Optional) Cancels running executions when props change. | ||
boolean | (Optional) Enables export mode (disables gestures, preserves drawing buffer). | ||
(Optional) Legend configuration. | |||
number | (Optional) Maximum number of rendered data points. | ||
string | StyleSpecification | (Optional) MapLibre style URL or inline style specification. | ||
number | null | (Optional) Maximum zoom level allowed on the map. | ||
(Optional) Pushpin-specific options (size range, clustering, …). | |||
boolean | (Optional) Keeps the requested legend position even when responsive heuristics disagree. | ||
string[] | (Optional) Segment values that should stay visible when using legend-driven filtering. | ||
(Optional) Custom number separators used for formatting. | |||
boolean | (Optional) Displays data labels on the map when supported by the layer. | ||
(Optional) Viewport preset or explicit bounds. | |||
number | (Optional) Initial zoom level (0-22). Defaults to auto-fit. |
Property details
IGeoChartConfig.areasproperty
Area-specific options (opacity, border styling, …).
areas?: IGeoAreasConfig;
IGeoChartConfig.basemappropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Selected basemap style identifier (e.g. "standard-light", "satellite").
basemap?: GeoBasemap;
Remarks
undefined uses the backend default basemap.
IGeoChartConfig.boundsproperty
Bounding box for custom viewport. Takes priority over center/zoom and adapts to container dimensions.
bounds?: IGeoLngLatBounds;
IGeoChartConfig.centerproperty
Initial map center. Defaults to auto-centering based on data.
center?: IGeoLngLat;
IGeoChartConfig.colorMappingproperty
Explicit color-mapping overrides.
colorMapping?: IColorMapping[];
IGeoChartConfig.colorPaletteproperty
Structured color palette compatible with color mapping GUIDs.
colorPalette?: IColorPalette;
IGeoChartConfig.colorsproperty
Simple palette expressed as color strings.
colors?: string[];
IGeoChartConfig.cooperativeGesturesproperty
Requires Ctrl/Cmd + scroll to zoom (helps inside scroll containers).
cooperativeGestures?: boolean;
IGeoChartConfig.customTooltippropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Custom tooltip configuration with Markdown content and metric/attribute references.
customTooltip?: ICustomTooltipConfig;
IGeoChartConfig.enableExecutionCancellingproperty
Cancels running executions when props change.
enableExecutionCancelling?: boolean;
IGeoChartConfig.isExportModeproperty
Enables export mode (disables gestures, preserves drawing buffer).
isExportMode?: boolean;
IGeoChartConfig.legendproperty
Legend configuration.
legend?: IGeoChartLegendConfig;
IGeoChartConfig.limitproperty
Maximum number of rendered data points.
limit?: number;
IGeoChartConfig.mapStyleproperty
MapLibre style URL or inline style specification.
mapStyle?: string | StyleSpecification;
IGeoChartConfig.maxZoomLevelproperty
Maximum zoom level allowed on the map.
maxZoomLevel?: number | null;
Remarks
undefinedkeeps default max zoom level -nullswitches to unrestricted zoom level
IGeoChartConfig.pointsproperty
Pushpin-specific options (size range, clustering, …).
points?: IGeoChartPointsConfig;
IGeoChartConfig.respectLegendPositionproperty
Keeps the requested legend position even when responsive heuristics disagree.
respectLegendPosition?: boolean;
IGeoChartConfig.selectedSegmentItemsproperty
Segment values that should stay visible when using legend-driven filtering.
selectedSegmentItems?: string[];
IGeoChartConfig.separatorsproperty
Custom number separators used for formatting.
separators?: ISeparators;
IGeoChartConfig.showLabelsproperty
Displays data labels on the map when supported by the layer.
showLabels?: boolean;
IGeoChartConfig.viewportproperty
Viewport preset or explicit bounds.
viewport?: IGeoChartViewport;
IGeoChartConfig.zoomproperty
Initial zoom level (0-22). Defaults to auto-fit.
zoom?: number;