series[type=' map-line']
- type required
'map-line' - Configuration for the Map Line 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.
- sizeKey
DatumKey - The key to use to retrieve size values from the data, used to control the width of the stroke.
- 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 stroke.
- labelKey
DatumKey - The key to use to retrieve values from the data to use as labels on top of lines.
- 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.
- 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.
- minStrokeWidth
PixelSize - Determines the smallest width a stroke can be in pixels when `sizeKey` is present. Defaults to `strokeWidth` when not set.
- maxStrokeWidth
PixelSize - Determines the largest width a stroke can be in pixels when `sizeKey` is present.
- sizeDomain
AgNumericValue[] - Explicitly specifies the extent of the domain of `sizeKey` values to map onto the `[minStrokeWidth, maxStrokeWidth]` range. Reverse the bounds (e.g. `[100, 0]`) to invert the mapping so that larger values produce thinner strokes.
- label
AgMapLineSeriesLabel - Configuration for the labels shown on top of the line.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular Map line based on the input parameters.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- highlight
AgMultiSeriesHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- 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-line']
- type required
'map-line' - Configuration for the Map Line 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.
- sizeKey
DatumKey - The key to use to retrieve size values from the data, used to control the width of the stroke.
- 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 stroke.
- labelKey
DatumKey - The key to use to retrieve values from the data to use as labels on top of lines.
- 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.
- 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.
- minStrokeWidth
PixelSize - Determines the smallest width a stroke can be in pixels when `sizeKey` is present. Defaults to `strokeWidth` when not set.
- maxStrokeWidth
PixelSize - Determines the largest width a stroke can be in pixels when `sizeKey` is present.
- sizeDomain
AgNumericValue[] - Explicitly specifies the extent of the domain of `sizeKey` values to map onto the `[minStrokeWidth, maxStrokeWidth]` range. Reverse the bounds (e.g. `[100, 0]`) to invert the mapping so that larger values produce thinner strokes.
- label
AgMapLineSeriesLabel - Configuration for the labels shown on top of the line.
- tooltip
AgSeriesTooltip - Series-specific tooltip configuration.
- itemStyler
Styler - A callback function for adjusting the styles of a particular Map line based on the input parameters.
- colorScale
AgColorScale - Configuration for colour scale with fills, domain, and mode.
- highlight
AgMultiSeriesHighlightOptions - Configuration for highlighting when a series or legend item is hovered over.
- 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.