Interface: SankeyNodeObject

Highcharts. SankeyNodeObject

A node in a sankey diagram.

Extends

Members

category :number|string

For categorized axes this property holds the category name for the point. For other axes it holds the X value.

Type:
  • number | string
Inherited From:

color :Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject

The color of the auto generated node.

Type:
Overrides:

colorIndex :number

The color index of the auto generated node, especially for use in styled mode.

Type:
  • number
Overrides:

column :number

An optional column index of where to place the node. The default behaviour is to place it next to the preceding node.

Type:
  • number
Since:
  • 6.0.5
See also:

dataGroup :Highcharts.DataGroupingInfoObject|undefined

Highcharts Stock only. If a point object is created by data grouping, it doesn't reflect actual points in the raw data. In this case, the dataGroup property holds information that points back to the raw data.

  • dataGroup.start is the index of the first raw data point in the group.

  • dataGroup.length is the amount of points in the group.

Type:
Inherited From:
Try it

graphic :Highcharts.SVGElement|undefined

SVG graphic representing the point in the chart. In some cases it may be a hidden graphic to improve accessibility.

Typically this is a simple shape, like a rect for column charts or path for line markers, but for some complex series types like boxplot or 3D charts, the graphic may be a g element containing other shapes. The graphic is generated the first time Highcharts.Series#drawPoints runs, and updated and moved on subsequent runs.

Type:
Inherited From:
See also:

graphics :Array.<Highcharts.SVGElement>|undefined

Array for multiple SVG graphics representing the point in the chart. Only used in cases where the point can not be represented by a single graphic.

Type:
Inherited From:
See also:

high :number|undefined

Range series only. The high or maximum value for each data point.

Type:
  • number | undefined
Inherited From:

id :string

The id of the auto-generated node, refering to the from or to setting of the link.

Type:
  • string

<readonly> index :number

Contains the point's index in the Series.points array.

Type:
  • number
Inherited From:

key :number|string

The point's name if it is defined, or its category in case of a category, otherwise the x value. Convenient for tooltip and data label formatting.

Type:
  • number | string
Inherited From:

low :number|undefined

Range series only. The low or minimum value for each data point.

Type:
  • number | undefined
Inherited From:

name :string

The name to display for the node in data labels and tooltips. Use this when the name is different from the id. Where the id must be unique for each node, this is not necessary for the name.

Type:
  • string
Overrides:
See also:

offset :number|string

This option is deprecated, use Highcharts.SankeyNodeObject#offsetHorizontal and Highcharts.SankeyNodeObject#offsetVertical instead.

The vertical offset of a node in terms of weight. Positive values shift the node downwards, negative shift it upwards.

If a percentage string is given, the node is offset by the percentage of the node size plus nodePadding.

Type:
  • number | string
Since:
  • 6.0.5
Deprecated:
  • Yes
Default Value:
  • 0
See also:

offsetHorizontal :number|string

The horizontal offset of a node. Positive values shift the node right, negative shift it left.

If a percentage string is given, the node is offset by the percentage of the node size.

Type:
  • number | string
Since:
  • 9.3.0
See also:

offsetVertical :number|string

The vertical offset of a node. Positive values shift the node down, negative shift it up.

If a percentage string is given, the node is offset by the percentage of the node size.

Type:
  • number | string
Since:
  • 9.3.0
See also:

options :Highcharts.PointOptionsObject

The point's options as applied in the initial configuration, or extended through Point.update.

In TypeScript you have to extend PointOptionsObject via an additional interface to allow custom data options:

declare interface PointOptionsObject {
    customProperty: string;
}
Type:
Inherited From:

percentage :number|undefined

The percentage for points in a stacked series, pies or gauges.

Type:
  • number | undefined
Inherited From:

plotX :number|undefined

The translated X value for the point in terms of pixels. Relative to the X axis position if the series has one, otherwise relative to the plot area. Depending on the series type this value might not be defined.

In an inverted chart the x-axis is going from the bottom to the top so the plotX value is the number of pixels from the bottom of the axis.

Type:
  • number | undefined
Inherited From:
See also:

plotY :number|undefined

The translated Y value for the point in terms of pixels. Relative to the Y axis position if the series has one, otherwise relative to the plot area. Depending on the series type this value might not be defined.

In an inverted chart the y-axis is going from right to left so the plotY value is the number of pixels from the right of the yAxis.

Type:
  • number | undefined
Inherited From:
See also:

points :Array.<Highcharts.Point>|undefined

Array of all hovered points when using shared tooltips.

Type:
Inherited From:

properties :*

In Highcharts Maps, when data is loaded from GeoJSON, the GeoJSON item's properies are copied over here.

Type:
  • *
Inherited From:

selected :boolean

Whether the point is selected or not.

Type:
  • boolean
Inherited From:
See also:

series :Highcharts.Series

The series object associated with the point.

Type:
Inherited From:

<readonly> shapeArgs :Readonly.<Highcharts.SVGAttributes>|undefined

The attributes of the rendered SVG shape like in column or pie series.

Type:
Inherited From:

sliced :boolean|undefined

Pie series only. Whether to display a slice offset from the center.

Type:
  • boolean | undefined
Inherited From:

<readonly> tooltipPos :Readonly.<Array.<number>>|undefined

Defines the tooltip's position for a data point in a chart. It is an array of numbers representing the coordinates for the tooltip's placement, allowing for precise control over its location.

Type:
  • Readonly.<Array.<number>> | undefined
Inherited From:

total :number|undefined

The total of values in either a stack for stacked series, or a pie in a pie series.

Type:
  • number | undefined
Inherited From:

visible :boolean

For certain series types, like pie charts, where individual points can be shown or hidden.

Type:
  • boolean
Inherited From:
Default Value:
  • true

x :number

The x value of the point.

Type:
  • number
Inherited From:

y :number|undefined

The y value of the point.

Type:
  • number | undefined
Inherited From:

Methods

doDrilldown()

Perform drilldown on a point instance. The drilldown property must be set on the point options.

To drill down multiple points in the same category, use Axis.drilldownCategory instead.

Inherited From:
Requires:
  • module:modules/drilldown
Try it

getClassName()

Get the CSS class names for individual points. Used internally where the returned value is set on every point.

Inherited From:
Returns:
string .

The class names.

getZone()

In a series with zones, return the zone that the point belongs to.

Inherited From:
Returns:
Highcharts.SeriesZonesOptionsObject .

The zone item.

haloPath(size)

Get the path definition for the halo, which is usually a shadow-like circle around the currently hovered point.

Parameters:
Name Type Description
size number

The radius of the circular halo.
Inherited From:
Returns:
Highcharts.SVGPathArray .

The path definition.

onMouseOut()

Runs on mouse out from the point. Called internally from mouse and touch events.

Inherited From:
Fires:
  • Highcharts.Point#event:mouseOut

onMouseOver( [e])

Runs on mouse over the point. Called internally from mouse and touch events.

Parameters:
Name Type Argument Description
e Highcharts.PointerEventObject <optional>

The event arguments.
Inherited From:

optionsToObject(options)

Transform number or array configs into objects. Also called for object configs. Used internally to unify the different configuration formats for points. For example, a simple number 10 in a line series will be transformed to { y: 10 }, and an array config like [1, 10] in a scatter series will be transformed to { x: 1, y: 10 }.

Parameters:
Name Type Description
options Highcharts.PointOptionsType

Series data options.
Inherited From:
Returns:
Highcharts.Dictionary.<*> .

Transformed point options.

pos(chartCoordinates, plotY)

Get the pixel position of the point relative to the plot area.

Parameters:
Name Type Description
chartCoordinates boolean

If true, the returned position is relative to the full chart area. If false, it is relative to the plot area determined by the axes.
plotY number | undefined

A custom plot y position to be computed. Used internally for some series types that have multiple y positions, like area range (low and high values).
Inherited From:
Returns:
Array.<number> | undefined .

Coordinates of the point if the point exists.

Try it

remove( [redraw] [, animation])

Remove a point and optionally redraw the series and if necessary the axes

Parameters:
Name Type Argument Default Description
redraw boolean <optional>
 true

Whether to redraw the chart or wait for an explicit call. When doing more operations on the chart, for example running point.remove() in a loop, it is best practice to set redraw to false and call chart.redraw() after.
animation boolean | Partial.<Highcharts.AnimationOptionsObject> <optional>
 false

Whether to apply animation, and optionally animation configuration.
Inherited From:
Try it

select( [selected] [, accumulate])

Toggle the selection status of a point.

Parameters:
Name Type Argument Default Description
selected boolean <optional>

When true, the point is selected. When false, the point is unselected. When null or undefined, the selection state is toggled.
accumulate boolean <optional>
 false

When true, the selection is added to other selected points. When false, other selected points are deselected. Internally in Highcharts, when allowPointSelect is true, selected points are accumulated on Control, Shift or Cmd clicking the point.
Inherited From:
See also:
Fires:
  • Highcharts.Point#event:select
  • Highcharts.Point#event:unselect
Try it

setNestedProperty(object, value, key)

Set a value in an object, on the property defined by key. The key supports nested properties using dot notation. The function modifies the input object and does not make a copy.

Parameters:
Name Type Description
object T

The object to set the value on.
value *

The value to set.
key string

Key to the property to set.
Inherited From:
  • Highcharts.Point#setNestedProperty.<T>
Returns:
T .

The modified object.

setState( [state] [, move])

Set the point's state.

Parameters:
Name Type Argument Description
state Highcharts.PointStateValue | "" <optional>

The new state, can be one of 'hover', 'select', 'inactive', or '' (an empty string), 'normal' or undefined to set to normal state.
move boolean <optional>

State for animation.
Inherited From:
Fires:
  • Highcharts.Point#event:afterSetState

setVisible( [vis] [, redraw])

Toggle the visibility of a pie slice or other data point. Note that this method is available only for some series, like pie, treemap and sunburst.

Parameters:
Name Type Argument Description
vis boolean <optional>

True to show the pie slice or other data point, false to hide. If undefined, the visibility is toggled.
redraw boolean <optional>

Whether to redraw the chart after the point is altered. If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
Inherited From:

sonify( [onEnd])

Play a sonification of a point.

Parameters:
Name Type Argument Description
onEnd Highcharts.SonificationChartEventCallback <optional>

Callback to call after play completed
Inherited From:
Requires:
  • module:modules/sonification

tooltipFormatter(pointFormat)

Extendable method for formatting each point's tooltip line.

Parameters:
Name Type Description
pointFormat string

The point format.
Inherited From:
Returns:
string .

A string to be concatenated in to the common tooltip text.

update(options [, redraw] [, animation])

Update point with new options (typically x/y data) and optionally redraw the series.

Parameters:
Name Type Argument Default Description
options Highcharts.PointOptionsType

The point options. Point options are handled as described under the series.type.data item for each series type. For example for a line series, if options is a single number, the point will be given that number as the marin y value. If it is an array, it will be interpreted as x and y values respectively. If it is an object, advanced options are applied.
redraw boolean <optional>
 true

Whether to redraw the chart after the point is updated. If doing more operations on the chart, it is best practice to set redraw to false and call chart.redraw() after.
animation boolean | Partial.<Highcharts.AnimationOptionsObject> <optional>
 true

Whether to apply animation, and optionally animation configuration.
Inherited From:
Fires:
  • Highcharts.Point#event:update
Try it