IMapSankeySeriesDataItem

Type interface

Sources

IMapSankeySeriesDataItem is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IMapSankeySeriesDataItem extends IMapPolygonSeriesDataItem.

IMapSankeySeriesDataItem is not extended by any other symbol.

Properties

#controlPointDistance

Type undefined | number

controlPointDistance for this link, instead of the series'.

#controlPointDistanceSource

Type undefined | number

controlPointDistanceSource for this link, instead of the series'.

#controlPointDistanceTarget

Type undefined | number

controlPointDistanceTarget for this link, instead of the series'.

#sourceId

Type undefined | string

Id of the polygon in polygonSeries the link starts from, at its geographic centroid. Also the id of the source node.

#sourceLatitude

Type undefined | number

Latitude the link starts at, when sourceId names no polygon.

#sourceLongitude

Type undefined | number

Longitude the link starts at, when sourceId names no polygon.

#sourceNode

Type DataItem

The node the link starts from.

#targetId

Type undefined | string

Id of the polygon in polygonSeries the link ends at, at its geographic centroid. Also the id of the target node.

#targetLatitude

Type undefined | number

Latitude the link ends at, when targetId names no polygon.

#targetLongitude

Type undefined | number

Longitude the link ends at, when targetId names no polygon.

#targetNode

Type DataItem

The node the link ends at.

#value

Type undefined | number

The link's value: its band is as wide as its share of the largest value.

#waypoints

Type Array

Points the band passes through on its way, in order.

23 inherited items

#customValue

Type undefined | numberInherited from ISeriesDataItem

#customValueChange

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueWorking

Type undefined | numberInherited from ISeriesDataItem

#geometry

Type Polygon | MultiPolygonInherited from IMapPolygonSeriesDataItem

GeoJSON geometry of the polygon.

#geometryType

Type GeoJSON.GeoJsonGeometryTypesInherited from IMapSeriesDataItem

#id

Type undefined | stringInherited from ISeriesDataItem

#mapPolygon

Type MapPolygonInherited from IMapPolygonSeriesDataItem

The polygon that shows the data item.

#url

Type undefined | stringInherited from ISeriesDataItemSince 5.20.7

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

#valueChange

Type undefined | numberInherited from ISeriesDataItem

#valueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#valueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#valueWorking

Type undefined | numberInherited from ISeriesDataItem

#valueWorkingClose

Type undefined | numberInherited from ISeriesDataItem

#valueWorkingOpen

Type undefined | numberInherited from ISeriesDataItem

#visible

Type undefined | false | trueInherited from IComponentDataItem