MapView
The MapView
is a component that renders a map with various geospatial data
layers.
MapView
MapViewProps
Signature:
export declare type MapViewProps = & ( | );
MapViewBaseProps
Name | Type | Default | Description |
---|---|---|---|
style? | - | CSS styles to override the inline styles of main container of the component | |
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 |
className? | - | CSS class to append to the class list of the main container of the component |
MapViewControlledProps
MapViewUncontrolledProps
<>
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 . |
Sequential legend
SequentialLegendProps
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
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
Name | Type | Default | Description |
---|---|---|---|
categories | [] | - | Available categories to be shown in the legend |
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 )[];
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 = | | | ;