A geo chart visualizes data on a map using one or more layers. You can compose pushpin layers (point data) and area layers (region data) into a single visualization.
Array of layer definitions rendered in order. The first layer is the primary layer and drives legend and drilling behavior
type
false
GeoLayerType
Visualization type reported through pushData callbacks. Defaults to the primary layer type
config
false
IGeoChartConfig
Unified geo chart configuration
filters
false
NullableFiltersOrPlaceholders
Global filters applied to every layer execution
backend
false
IAnalyticalBackend
Backend used for data execution
workspace
false
string
Workspace identifier
locale
false
string
Locale used for UI localization. Defaults to en-US
drillableItems
false
ExplicitDrill[]
Drill configuration for points and attribute values
ErrorComponent
false
ComponentType
Component rendered when the visualization is in an error state
LoadingComponent
false
ComponentType
Component rendered while the visualization is loading
onError
false
OnError
Callback fired when loading or rendering fails
onExportReady
false
OnExportReady
Callback fired when export functions become available
onLoadingChanged
false
OnLoadingChanged
Callback fired when the loading state changes
onDrill
false
OnFiredDrillEvent
Callback fired when drilling is triggered
onCenterPositionChanged
false
CenterPositionChangedCallback
Callback fired when the map center changes
onZoomChanged
false
ZoomChangedCallback
Callback fired when the map zoom level changes
onBoundsChanged
false
BoundsChangedCallback
Callback fired when the visible map bounds change
onViewportInteractionEnd
false
ViewportInteractionEndCallback
Callback fired when a user-triggered viewport interaction finishes
Layers
Layers are typically created using createPushpinLayer(layer, id?) and createAreaLayer(layer, id?). Each layer runs its own independent data execution. The optional second argument lets you set a custom layer id. If you do not use the factory helpers, each layer object must include a unique id and a type.
Common layer properties
These properties are shared by both pushpin and area layer definitions:
Name
Required?
Type
Description
name
false
string
Human-readable layer name
color
false
IAttributeOrMeasure
Measure-based gradient or attribute-based categorical color encoding
segmentBy
false
IAttribute
Attribute for categorical grouping with distinct colors
config
false
IGeoLayerConfig
Per-layer color configuration: { colorPalette?: IColorPalette, colorMapping?: IColorMapping[] }
filters
false
INullableFilter[]
Filters specific to this layer’s data execution
sortBy
false
ISortItem[]
Sorting for this layer’s data execution
tooltipText
false
IAttribute
Attribute whose values are shown in tooltips
Pushpin Layer
Created with createPushpinLayer(). Renders point data as markers on the map.
Name
Required?
Type
Description
latitude
true
IAttribute
Attribute containing latitude values (decimal degrees, -90 to 90)
longitude
true
IAttribute
Attribute containing longitude values (decimal degrees, -180 to 180)
size
false
IAttributeOrMeasure
Measure or attribute used for marker size scaling
measures
false
IAttributeOrMeasure[]
Additional measures shown in tooltips only
geoIcon
false
IAttribute
Attribute whose display form type is GDC.geo.icon. Used with config.points.shapeType: "iconByValue"
Area Layer
Created with createAreaLayer(). Renders geographic regions as filled polygons (choropleth map).
Name
Required?
Type
Description
area
true
IAttribute
Attribute whose values represent geographic regions (countries, states, provinces, and similar regions)
Layer filter semantics
Layer-specific filters are applied before global component-level filters. When both are provided, the global filters take precedence for filter types with “last wins” merge rules (e.g. date filters for the same dataset).