Documentation

IMapLineSeriesDataItem

Type interface

Inheritance

IMapLineSeriesDataItem extends IMapSeriesDataItem.

IMapLineSeriesDataItem is extended by IGraticuleSeriesDataItem.

Properties

customValue
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChange
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePrevious
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePreviousPercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangeSelection
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangeSelectionPercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueWorking
#

Type undefined | number

Inherited from ISeriesDataItem
geometry
#

Type LineString | MultiLineString

GeoJSON geometry of the line.
geometryType
#

Type GeoJSON.GeoJsonGeometryTypes

Inherited from IMapSeriesDataItem
id
#

Type undefined | string

Inherited from ISeriesDataItem
lineType
#

Type "curved" | "straight"

Default "curved"

How the line runs between its points, instead of the series' lineType:

  • "curved" - along the shortest path on the globe, which the projection may bend.
  • "straight" - in straight lines on screen, never across the 180th meridian.

@since 5.2.32

mapLine
#

Type MapLine

The line that shows the data item.
pointIds
#

Type Array

Ids of the points for the line to connect, looked up in pointSeries.

The line follows the points, and a config holds just the ids.

The line isn't drawn until every id matches a point, so it is never drawn short. Fixed points can't be used. Ignored if pointsToConnect is set.

@since 5.20.3

pointsToConnect
#

Type Array

Data items of a MapPointSeries for the line to connect, in order. The line follows them when they move. Fixed points can't be used.
url
#

Type undefined | string

Inherited from ISeriesDataItem

A URL to open when the data item's element is clicked.

@since 5.20.7

value
#

Type undefined | number

Inherited from IMapSeriesDataItem
valueChange
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePercent
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePrevious
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePreviousPercent
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangeSelection
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangeSelectionPercent
#

Type undefined | number

Inherited from ISeriesDataItem
valueWorking
#

Type undefined | number

Inherited from ISeriesDataItem
valueWorkingClose
#

Type undefined | number

Inherited from ISeriesDataItem
valueWorkingOpen
#

Type undefined | number

Inherited from ISeriesDataItem
visible
#

Type undefined | false | true

Inherited from IComponentDataItem
There are 22 inherited items currently hidden from this list.