> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# @gooddata/sdk-ui-geo

This package provides the components that you can use to visualize location-based data.

## Remarks

This package provides: - GeoPushpinChart (single-layer pushpin chart) - GeoAreaChart (single-layer area chart) - GeoChart (multi-layer geo visualization)

## Functions

| Function | Description |
| --- | --- |
| [createAreaLayer(layer, id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.createarealayer/index.md) | Creates an area layer configuration object. |
| [createPushpinLayer(layer, id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.createpushpinlayer/index.md) | Creates a pushpin layer configuration object. |
| [enrichMapboxToken(config, mapboxToken)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.enrichmapboxtoken/index.md) |  |
| [GeoAreaChart(props)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geoareachart/index.md) | GeoAreaChart wraps [GeoChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochart/index.md) for the single area-layer scenario. |
| [GeoChart(props)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochart/index.md) | GeoChart renders a MapLibre-based geo visualization composed of one or more data layers. |
| [GeoPushpinChart(props)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geopushpinchart/index.md) | MapLibre-based GeoPushpinChart implementation. |
| [isGeoLayerArea(layer)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.isgeolayerarea/index.md) | Type guard for area layer. |
| [isGeoLayerPushpin(layer)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.isgeolayerpushpin/index.md) | Type guard for pushpin layer. |
| [isValidPushpinSizeOption(value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.isvalidpushpinsizeoption/index.md) | Type guard verifying allowed size option values. |
| [isValidViewportArea(value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.isvalidviewportarea/index.md) | Type guard verifying supported viewport presets. |
| [LegacyGeoPushpinChart(props)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.legacygeopushpinchart/index.md) | Legacy GeoPushpinChart implementation (Mapbox-based). |
| [MapboxTokenProvider({ token, children }, input)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.mapboxtokenprovider/index.md) |  |
| [useMapboxToken(mapboxToken)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.usemapboxtoken/index.md) |  |
| [useMapboxTokenStrict(mapboxToken)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.usemapboxtokenstrict/index.md) |  |
| [withMapboxToken(InnerComponent)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.withmapboxtoken/index.md) |  |

## Interfaces

| Interface | Description |
| --- | --- |
| [IGeoAreaChartBaseProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoareachartbaseprops/index.md) | Shared props for [GeoAreaChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geoareachart/index.md) before the required area attribute is applied. |
| [IGeoAreaChartConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoareachartconfig/index.md) | Configuration for GeoAreaChart component |
| [IGeoAreaChartProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoareachartprops/index.md) | Props for [GeoAreaChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geoareachart/index.md). The `area` attribute is required. |
| [IGeoAreasConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoareasconfig/index.md) | Configuration for area styling in area maps |
| [IGeoAttributeItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoattributeitem/index.md) |  |
| [IGeoChartConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartconfig/index.md) | Unified configuration shared by [GeoChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochart/index.md) and its wrappers. |
| [IGeoChartLegendConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartlegendconfig/index.md) | Legend configuration shared by GeoChart components. |
| [IGeoChartPointsConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartpointsconfig/index.md) | Pushpin-specific configuration. |
| [IGeoChartProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartprops/index.md) | Props for [GeoChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochart/index.md). |
| [IGeoChartViewport](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartviewport/index.md) | Viewport configuration shared by GeoChart components. |
| [IGeoChartViewportNavigation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartviewportnavigation/index.md) | Navigation interaction settings for geo viewport. |
| [IGeoCommonExecutionProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeocommonexecutionprops/index.md) | Common execution/host wiring props shared by all GeoChart-family components. |
| [IGeoConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoconfig/index.md) |  |
| [IGeoConfigViewport](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoconfigviewport/index.md) |  |
| [IGeoData](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeodata/index.md) |  |
| [IGeoDataItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeodataitem/index.md) |  |
| [IGeoLayerArea](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolayerarea/index.md) | Area layer configuration. |
| [IGeoLayerBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolayerbase/index.md) | Base interface for all geo layer configurations. |
| [IGeoLayerConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolayerconfig/index.md) | Per-layer configuration for GeoChart layers. |
| [IGeoLayerPushpin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolayerpushpin/index.md) | Pushpin layer configuration. |
| [IGeoLegendConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolegendconfig/index.md) |  |
| [IGeoLngLat](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolnglat/index.md) | Represents geographic coordinates in latitude/longitude format. |
| [IGeoLngLatBounds](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolnglatbounds/index.md) | Represents geographic bounds defined by north-east and south-west coordinates. |
| [IGeoLocationItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolocationitem/index.md) |  |
| [IGeoMeasureItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeomeasureitem/index.md) |  |
| [IGeoPointsConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopointsconfig/index.md) |  |
| [IGeoPushpinChartBaseProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopushpinchartbaseprops/index.md) | Shared props for [GeoPushpinChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geopushpinchart/index.md) before the location is specified. |
| [IGeoPushpinChartConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopushpinchartconfig/index.md) | Configuration for MapLibre-based pushpin rendering. |
| [IGeoPushpinChartLatitudeLongitudeProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopushpinchartlatitudelongitudeprops/index.md) | Props for [GeoPushpinChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geopushpinchart/index.md) in the latitude/longitude mode. |
| [IGeoPushpinChartLocationProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopushpinchartlocationprops/index.md) | Props for [GeoPushpinChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geopushpinchart/index.md) in the (legacy) single-attribute mode. |
| [IGeoSegmentItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeosegmentitem/index.md) |  |
| [IGeoSingleLayerWrapperProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeosinglelayerwrapperprops/index.md) | Shared props for wrappers that internally construct a primary layer and allow extra layers. |
| [ILegacyGeoPushpinChartBaseProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.ilegacygeopushpinchartbaseprops/index.md) | Legacy GeoPushpinChart base props (Mapbox-based implementation). |
| [ILegacyGeoPushpinChartLatitudeLongitudeProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.ilegacygeopushpinchartlatitudelongitudeprops/index.md) | Legacy GeoPushpinChart props for the latitude/longitude mode. |
| [ILegacyGeoPushpinChartProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.ilegacygeopushpinchartprops/index.md) | Legacy GeoPushpinChart props for the (legacy) single-attribute mode. |

## Type Aliases

| Type Alias | Description |
| --- | --- |
| [BoundsChangedCallback](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.boundschangedcallback/index.md) | Callback fired when the map visible bounds change. |
| [CenterPositionChangedCallback](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.centerpositionchangedcallback/index.md) | Callback fired when the map center changes. |
| [GeoBasemap](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geobasemap/index.md) | **_(ALPHA)_** Basemap style identifier passed to the location style endpoint. |
| [GeoChartPushpinSizeOption](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochartpushpinsizeoption/index.md) | Supported pushpin marker size multipliers. |
| [GeoChartShapeType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geochartshapetype/index.md) | Pushpin marker shape types. - `"circle"` – default circle markers - `"iconByValue"` – icon resolved from a `GDC.geo.icon` label - `"oneIcon"` – a single static icon chosen from the sprite sheet |
| [GeoLayerType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geolayertype/index.md) | Layer types supported by GeoChart. |
| [GeoLegendCornerPosition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geolegendcornerposition/index.md) | Corner positions accepted by the new geo legend implementation. |
| [GeoLegendPosition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geolegendposition/index.md) | Position values accepted by the new geo legend implementation. |
| [IGeoChartViewportArea](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeochartviewportarea/index.md) | Viewport presets for GeoChart. |
| [IGeoConfigViewportArea](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoconfigviewportarea/index.md) |  |
| [IGeoLayer](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeolayer/index.md) | Union type for all layer configurations. |
| [IGeoPushpinChartProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeopushpinchartprops/index.md) | Props for [GeoPushpinChart()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.geopushpinchart/index.md). |
| [LegacyGeoLegendPosition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.legacygeolegendposition/index.md) | Legacy edge-based legend positions still accepted for read-time normalization. |
| [PushpinSizeOption](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.pushpinsizeoption/index.md) |  |
| [StyleSpecification](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.stylespecification/index.md) | MapLibre style specification. |
| [ViewportInteractionEndCallback](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.viewportinteractionendcallback/index.md) | Callback fired when a viewport change triggered by a real user interaction finishes. |
| [ZoomChangedCallback](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.zoomchangedcallback/index.md) | Callback fired when map zoom changes. |