MapView

The MapView is a component that renders a map with various geospatial data layers.

OverviewProperties

MapView

MapViewProps

Signature:

export declare type MapViewProps = & ( | );

MapViewBaseProps

extends, , ,

Name	Type	Default	Description
mapStyle?			Styles of maplibre to be overridden
onViewStateChange?	(viewState: ) =>		Callback to listen for the changes in the ViewState
loading?		false	Set whether map is loading
height?	|	400px	The height of the chart. If a number is passed, it will be treated as px
truncationMode?		'middle'	The truncation mode to be used as start, middle or end in the long legend labels
formatter?	| <, >		Map View formatter options
onContextLostError?	() =>		Callback fired when the map context is lost. Browsers have a limit of active WebGL canvas contexts. The map will automatically show an error state, but this callback allows consumers to perform additional actions (e.g., analytics, custom UI).

MapViewControlledProps

extends

MapViewUncontrolledProps

extends<>

Name	Type	Default	Description
initialViewState?			The initial state of the Map.

ViewState

Name	Type	Default	Description
longitude?			Longitude at map center
latitude?			Latitude at map center
zoom?			Map zoom level

MapView Ref

MapViewRef

Name	Type	Default	Description
element	|		The map component root element
downloadData	() =>		Downloads map raw data .
zoomIn	() =>		Performs zoom in action on the domain
zoomOut	() =>		Performs zoom out action on the domain
zoomToFit	() =>		Performs zoom to fit action on the domain
reset	() =>		Reset the domain to the default

Sequential legend

SequentialLegendProps

extends

Name	Type	Default	Description
min?			The min boundary
max?			The max boundary
colorPalette?	[] |		The color palette to apply to the legend

BaseLegendProps

Signature:

export declare type Base = <, >;

LegendPosition

Signature:

export declare type LegendPosition = (typeof )[];

ColorPalette

Signature:

export declare type ColorPalette = (typeof )[];

Threshold legend

ThresholdLegendProps

extends

Name	Type	Default	Description
ranges	[]		Ranges of the threshold legend

BaseLegendProps

Signature:

export declare type Base = <, >;

LegendPosition

Signature:

export declare type LegendPosition = (typeof )[];

ColorPalette

Signature:

export declare type ColorPalette = (typeof )[];

ColoredRange

Name	Type	Default	Description
from			Range starting point
to			Range ending point
color?			The color to use in this range

Categorical legend

CategoricalLegendProps

extends

Name	Type	Default	Description
colorPalette	[] | | { [key: ]: ; }		The color palette to apply to the legend

BaseLegendProps

Signature:

export declare type Base = <, >;

LegendPosition

Signature:

export declare type LegendPosition = (typeof )[];

ColorPalette

Signature:

export declare type ColorPalette = (typeof )[];

Legend shared props

BaseLegendProps

Signature:

export declare type Base = <, >;

Interactions

ChartInteractionsProps

Name	Type	Default	Description
onZoomChange?			Callback called when any zoom event has been performed affecting the data timeframe

ZoomChangeHandler

Signature:

export declare type ZoomChangeHandler = (newStart: | , newEnd: | , type: ) => ;

Toolbar

ChartToolbarProps

Name	Type	Default	Description
placement?		'top-right'	Initial placement for the toolbar

ToolbarPlacement

Signature:

export declare type ToolbarPlacement = | | | ;