series[type=' map-marker']
- type required
'map-marker' - Configuration for the Map Marker Series.
- topology
GeoJSON - GeoJSON data.
- topologyIdKey
stringdefault: name - The property to reference in the topology to match up with data.
- title
string - The title to use for the series.
- legendItemName
string - The text to display in the legend for this series. If multiple series share this value, they will be merged for the legend toggle behaviour.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- context
ContextDefault - Context object to use in callbacks.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- visible
boolean - Whether to display the series.
- cursor
string - The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
- selection
AgSelectionOptions - Configuration for data selection.
- nodeClickRange
InteractionRange - Range from a node that a click triggers the listener.
- showInLegend
boolean - Whether to include the series in the legend.
- listeners
AgSeriesListeners - A map of event names to event listeners.
- idKey
DatumKey - The name of the node key containing the id value.
- latitudeKey
DatumKey - The key to use to retrieve latitude values from the data, used to control the position of the markers.
- longitudeKey
DatumKey - The key to use to retrieve longitude values from the data, used to control the position of the markers.
- sizeKey
DatumKey - The key to use to retrieve size values from the data, used to control the size of the markers.
- colorKey
DatumKey - The name of the node key containing the colour value. This value (along with `colorScale` config) will be used to determine the colour of the markers.
- labelKey
DatumKey - The key to use to retrieve values from the data to use as labels for the markers.
- idName
string - A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- latitudeName
string - A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- longitudeName
string - A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- sizeName
string - A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- colorName
string - A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- labelName
string - A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- minSize
PixelSize - Determines the smallest size a marker can be in pixels when `sizeKey` is present. Defaults to `size` when not set.
- maxSize
PixelSize - Determines the largest size a marker can be in pixels when `sizeKey` is present.
- sizeDomain
[AgNumericValue, AgNumericValue] - Explicitly specifies the extent of the domain of `sizeKey` values to map onto the `[minSize, maxSize]` range. Reverse the bounds (e.g. `[100, 0]`) to invert the mapping so that larger values produce smaller markers.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- label
AgMapMarkerSeriesLabel - Configuration for the labels shown on top of data points.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular Map marker based on the input parameters.
- highlight
AgMultiSeriesHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- shape
AgMarkerShape - The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function.
- size
PixelSize - The size in pixels of the markers. Used as the fixed marker size only when `sizeKey` is absent; when `sizeKey` is present the scale lower bound is controlled by `minSize` instead.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- strokeOpacity
Opacity - The opacity of the stroke colour.
- lineDash
PixelSize[] - An array specifying the length in pixels of alternating dashes and gaps.
- lineDashOffset
PixelSize - The initial offset of the dashed line in pixels.
series[type=' map-marker']
- type required
'map-marker' - Configuration for the Map Marker Series.
- topology
GeoJSON - GeoJSON data.
- topologyIdKey
stringdefault: name - The property to reference in the topology to match up with data.
- title
string - The title to use for the series.
- legendItemName
string - The text to display in the legend for this series. If multiple series share this value, they will be merged for the legend toggle behaviour.
- id
stringdefault: auto-generated value - Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value.
- context
ContextDefault - Context object to use in callbacks.
- data
DatumDefault[] - The data to use when rendering the series. If this is not supplied, data must be set on the chart instead.
- visible
boolean - Whether to display the series.
- cursor
string - The cursor to use for hovered markers. This config is identical to the CSS `cursor` property.
- selection
AgSelectionOptions - Configuration for data selection.
- nodeClickRange
InteractionRange - Range from a node that a click triggers the listener.
- showInLegend
boolean - Whether to include the series in the legend.
- listeners
AgSeriesListeners - A map of event names to event listeners.
- idKey
DatumKey - The name of the node key containing the id value.
- latitudeKey
DatumKey - The key to use to retrieve latitude values from the data, used to control the position of the markers.
- longitudeKey
DatumKey - The key to use to retrieve longitude values from the data, used to control the position of the markers.
- sizeKey
DatumKey - The key to use to retrieve size values from the data, used to control the size of the markers.
- colorKey
DatumKey - The name of the node key containing the colour value. This value (along with `colorScale` config) will be used to determine the colour of the markers.
- labelKey
DatumKey - The key to use to retrieve values from the data to use as labels for the markers.
- idName
string - A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- latitudeName
string - A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- longitudeName
string - A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- sizeName
string - A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- colorName
string - A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- labelName
string - A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters.
- minSize
PixelSize - Determines the smallest size a marker can be in pixels when `sizeKey` is present. Defaults to `size` when not set.
- maxSize
PixelSize - Determines the largest size a marker can be in pixels when `sizeKey` is present.
- sizeDomain
[AgNumericValue, AgNumericValue] - Explicitly specifies the extent of the domain of `sizeKey` values to map onto the `[minSize, maxSize]` range. Reverse the bounds (e.g. `[100, 0]`) to invert the mapping so that larger values produce smaller markers.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- label
AgMapMarkerSeriesLabel - Configuration for the labels shown on top of data points.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular Map marker based on the input parameters.
- highlight
AgMultiSeriesHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- shape
AgMarkerShape - The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function.
- size
PixelSize - The size in pixels of the markers. Used as the fixed marker size only when `sizeKey` is absent; when `sizeKey` is present the scale lower bound is controlled by `minSize` instead.
- fill
AgColorType - The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill.
- fillOpacity
Opacity - The opacity of the fill colour.
- stroke
AgCssColorOrRef - The colour for the stroke.
- strokeWidth
PixelSize - The width of the stroke in pixels.
- strokeOpacity
Opacity - The opacity of the stroke colour.
- lineDash
PixelSize[] - An array specifying the length in pixels of alternating dashes and gaps.
- lineDashOffset
PixelSize - The initial offset of the dashed line in pixels.