IGeoPushpinChartConfig
Configuration for MapLibre-based pushpin rendering.
export interface IGeoPushpinChartConfig
Remarks
This config type is used by the MapLibre-based geo engine when rendering pushpin layers.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(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) | |||
(Optional) | |||
(Optional) | |||
string[] | (Optional) | ||
boolean | (Optional) | ||
(ALPHA) (Optional) Custom tooltip configuration with Markdown content and metric/attribute references. | |||
boolean | (Optional) | ||
boolean | (Optional) | ||
(Optional) | |||
number | (Optional) | ||
string | (Optional) Mapbox access token. | ||
string | StyleSpecification | (Optional) Custom MapLibre style URL or inline specification. | ||
number | null | (Optional) Maximum zoom level allowed on the map. | ||
(Optional) | |||
boolean | (Optional) | ||
string[] | (Optional) | ||
(Optional) | |||
boolean | (Optional) | ||
(Optional) Location tooltip label attribute. | |||
(Optional) | |||
number | (Optional) |
Property details
IGeoPushpinChartConfig.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.
IGeoPushpinChartConfig.boundsproperty
Bounding box for custom viewport. Takes priority over center/zoom and adapts to container dimensions.
bounds?: IGeoLngLatBounds;
IGeoPushpinChartConfig.centerproperty
center?: IGeoLngLat;
IGeoPushpinChartConfig.colorMappingproperty
colorMapping?: IColorMapping[];
IGeoPushpinChartConfig.colorPaletteproperty
colorPalette?: IColorPalette;
IGeoPushpinChartConfig.colorsproperty
colors?: string[];
IGeoPushpinChartConfig.cooperativeGesturesproperty
cooperativeGestures?: boolean;
IGeoPushpinChartConfig.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;
IGeoPushpinChartConfig.enableExecutionCancellingproperty
enableExecutionCancelling?: boolean;
IGeoPushpinChartConfig.isExportModeproperty
isExportMode?: boolean;
IGeoPushpinChartConfig.legendproperty
legend?: IGeoChartLegendConfig;
IGeoPushpinChartConfig.limitproperty
limit?: number;
IGeoPushpinChartConfig.mapboxTokenpropertyDeprecated
Warning: This API is now obsolete.
Kept only for backward compatibility. Not used by MapLibre-based geo charts.
Mapbox access token.
mapboxToken?: string;
Remarks
Kept only for backward compatibility with the legacy Mapbox-based implementation. MapLibre-based geo charts ignore this value.
IGeoPushpinChartConfig.mapStyleproperty
Custom MapLibre style URL or inline specification.
mapStyle?: string | StyleSpecification;
IGeoPushpinChartConfig.maxZoomLevelproperty
Maximum zoom level allowed on the map.
maxZoomLevel?: number | null;
Remarks
undefinedkeeps default max zoom level -nullswitches to unrestricted zoom level
IGeoPushpinChartConfig.pointsproperty
points?: IGeoChartPointsConfig;
IGeoPushpinChartConfig.respectLegendPositionproperty
respectLegendPosition?: boolean;
IGeoPushpinChartConfig.selectedSegmentItemsproperty
selectedSegmentItems?: string[];
IGeoPushpinChartConfig.separatorsproperty
separators?: ISeparators;
IGeoPushpinChartConfig.showLabelsproperty
showLabels?: boolean;
IGeoPushpinChartConfig.tooltipTextproperty
Location tooltip label attribute.
tooltipText?: IAttribute;
Remarks
Kept for backward compatibility with the legacy GeoPushpinChart API where this lived under config. Prefer tooltipText on pushpin layers when using GeoChart().
IGeoPushpinChartConfig.viewportproperty
viewport?: IGeoChartViewport;
IGeoPushpinChartConfig.zoomproperty
zoom?: number;