Overview of sdk-ui-geo

Home > @gooddata/sdk-ui-geo

sdk-ui-geo package

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)	Creates an area layer configuration object.
createPushpinLayer(layer, id)	Creates a pushpin layer configuration object.
enrichMapboxToken(config, mapboxToken)
GeoAreaChart(props)	GeoAreaChart wraps GeoChart() for the single area-layer scenario.
GeoChart(props)	GeoChart renders a MapLibre-based geo visualization composed of one or more data layers.
GeoPushpinChart(props)	MapLibre-based GeoPushpinChart implementation.
isGeoLayerArea(layer)	Type guard for area layer.
isGeoLayerPushpin(layer)	Type guard for pushpin layer.
isValidPushpinSizeOption(value)	Type guard verifying allowed size option values.
isValidViewportArea(value)	Type guard verifying supported viewport presets.
LegacyGeoPushpinChart(props)	Legacy GeoPushpinChart implementation (Mapbox-based).
MapboxTokenProvider({ token, children })
useMapboxToken(mapboxToken)
useMapboxTokenStrict(mapboxToken)
withMapboxToken(InnerComponent)

Interfaces

Interface	Description
IGeoAreaChartBaseProps	Shared props for GeoAreaChart() before the required area attribute is applied.
IGeoAreaChartConfig	Configuration for GeoAreaChart component
IGeoAreaChartProps	Props for GeoAreaChart(). The area attribute is required.
IGeoAreasConfig	Configuration for area styling in area maps
IGeoAttributeItem
IGeoChartConfig	Unified configuration shared by GeoChart() and its wrappers.
IGeoChartLegendConfig	Legend configuration shared by GeoChart components.
IGeoChartPointsConfig	Pushpin-specific configuration.
IGeoChartProps	Props for GeoChart().
IGeoChartViewport	Viewport configuration shared by GeoChart components.
IGeoCommonExecutionProps	Common execution/host wiring props shared by all GeoChart-family components.
IGeoConfig
IGeoConfigViewport
IGeoData
IGeoDataItem
IGeoLayerArea	Area layer configuration.
IGeoLayerBase	Base interface for all geo layer configurations.
IGeoLayerPushpin	Pushpin layer configuration.
IGeoLegendConfig
IGeoLngLat	Represents geographic coordinates in latitude/longitude format.
IGeoLngLatBounds	Represents geographic bounds defined by north-east and south-west coordinates.
IGeoLocationItem
IGeoMeasureItem
IGeoPointsConfig
IGeoPushpinChartBaseProps	Shared props for GeoPushpinChart() before the location is specified.
IGeoPushpinChartConfig	Configuration for MapLibre-based pushpin rendering.
IGeoPushpinChartLatitudeLongitudeProps	Props for GeoPushpinChart() in the latitude/longitude mode.
IGeoPushpinChartLocationProps	Props for GeoPushpinChart() in the (legacy) single-attribute mode.
IGeoSegmentItem
IGeoSingleLayerWrapperProps	Shared props for wrappers that internally construct a primary layer and allow extra layers.
ILegacyGeoPushpinChartBaseProps	Legacy GeoPushpinChart base props (Mapbox-based implementation).
ILegacyGeoPushpinChartLatitudeLongitudeProps	Legacy GeoPushpinChart props for the latitude/longitude mode.
ILegacyGeoPushpinChartProps	Legacy GeoPushpinChart props for the (legacy) single-attribute mode.

Type Aliases

Type Alias	Description
CenterPositionChangedCallback	Callback fired when the map center changes.
GeoChartPushpinSizeOption	Supported pushpin marker size multipliers.
GeoLayerType	Layer types supported by GeoChart.
GeoTileset	(ALPHA) Supported basemap tileset identifiers.
IGeoChartViewportArea	Viewport presets for GeoChart.
IGeoConfigViewportArea
IGeoLayer	Union type for all layer configurations.
IGeoPushpinChartProps	Props for GeoPushpinChart().
PushpinSizeOption
StyleSpecification	MapLibre style specification.
ZoomChangedCallback	Callback fired when map zoom changes.