com.highsoft.highcharts.common.hichartsclasses

Class HIPoint

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPoint

public class HIPoint
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPoint()

Method Summary

Modifier and Type	Method and Description
void	cancelSonify() Cancel sonification of a point.
void	cancelSonify(boolean fadeOut) Cancel sonification of a point.
java.lang.String	getCategory()
HIColor	getColor()
java.lang.Number	getColorIndex()
java.lang.String	getDateFormat()
HIFunction	getDateFormatter()
java.lang.Boolean	getDescribeNull()
java.lang.String	getDescriptionFormat()
HIFunction	getDescriptionFormatter()
HIEvents	getEvents()
java.lang.String	getName()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Number	getPercentage()
java.lang.Number	getPlotX()
java.lang.Number	getPlotY()
java.lang.Boolean	getSelected()
java.lang.Boolean	getSliced()
java.lang.Number	getTotal()
java.lang.Number	getValueDecimals()
java.lang.String	getValueDescriptionFormat()
java.lang.String	getValuePrefix()
java.lang.String	getValueSuffix()
java.lang.Boolean	getVisible()
java.lang.Number	getX()
java.lang.Number	getY()
void	onMouseOut() Runs on mouse out from the point.
void	remove(boolean redraw) Remove a point and optionally redraw the series and if necessary the axes
void	remove(boolean redraw, HIAnimationOptionsObject animation) Remove a point and optionally redraw the series and if necessary the axes
void	select() Toggle the selection status of a point.
void	select(boolean selected) Toggle the selection status of a point.
void	select(boolean selected, boolean accumulate) Toggle the selection status of a point.
void	setCategory(java.lang.String category) For categorized axes this property holds the category name for the point.
void	setColor(HIColor color) The point's current color.
void	setColorIndex(java.lang.Number colorIndex) The point's current color index, used in styled mode instead of `color`.
void	setDateFormat(java.lang.String dateFormat) Date format to use for points on datetime axes when describing them to screen reader users.
void	setDateFormatter(HIFunction dateFormatter) Formatter function to determine the date/time format used with points on datetime axes when describing them to screen reader users.
void	setDescribeNull(java.lang.Boolean describeNull) Whether or not to describe points with the value `null` to assistive technology, such as screen readers.
void	setDescriptionFormat(java.lang.String descriptionFormat) A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) to use instead of the defaults for point descriptions.
void	setDescriptionFormatter(HIFunction descriptionFormatter) /** * description: Formatter function to use instead of the defaults for point descriptions.
void	setEvents(HIEvents events)
void	setName(java.lang.String name) The name of the point.
void	setNestedProperty(java.lang.Object object, java.lang.Object value, java.lang.String key) Set a value in an object, on the property defined by key.
void	setPercentage(java.lang.Number percentage) The percentage for points in a stacked series or pies.
void	setPlotX(java.lang.Number plotX) The translated X value for the point in terms of pixels.
void	setPlotY(java.lang.Number plotY) The translated Y value for the point in terms of pixels.
void	setSelected(java.lang.Boolean selected) Whether the point is selected or not.
void	setSliced(java.lang.Boolean sliced) Pie series only.
void	setState() Set the point's state.
void	setState(java.lang.Object object, boolean move) Set the point's state.
void	setState(java.lang.String state) Set the point's state.
void	setTotal(java.lang.Number total) The total of values in either a stack for stacked series, or a pie in a pie series.
void	setValueDecimals(java.lang.Number valueDecimals) Decimals to use for the values in the point descriptions.
void	setValueDescriptionFormat(java.lang.String valueDescriptionFormat) Format to use for describing the values of data points to assistive technology - including screen readers.
void	setValuePrefix(java.lang.String valuePrefix) Prefix to add to the values in the point descriptions.
void	setValueSuffix(java.lang.String valueSuffix) Suffix to add to the values in the point descriptions.
void	setVisible(java.lang.Boolean visible) For certain series types, like pie charts, where individual points can be shown or hidden.
void	setX(java.lang.Number x) The x value of the point.
void	setY(java.lang.Number y) The y value of the point.
void	sonify(java.util.Map options) Sonify a single point.
void	tooltipFormatter(java.lang.String pointFormat) Extendable method for formatting each point's tooltip line.
void	update(HIPoint options) Update point with new options (typically x/y data) and optionally redraw the series.
void	update(HIPoint options, boolean redraw) Update point with new options (typically x/y data) and optionally redraw the series.
void	update(HIPoint options, boolean redraw, HIAnimationOptionsObject animation) Update point with new options (typically x/y data) and optionally redraw the series.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIPoint

public HIPoint()

Method Detail

cancelSonify

public void cancelSonify()

Cancel sonification of a point. Calls onEnd functions.

cancelSonify

public void cancelSonify(boolean fadeOut)

Cancel sonification of a point. Calls onEnd functions.

Parameters:

fadeOut - Whether or not to fade out as we stop. If false, the points are cancelled synchronously.

getCategory

public java.lang.String getCategory()

getColor

public HIColor getColor()

getColorIndex

public java.lang.Number getColorIndex()

getDateFormat

public java.lang.String getDateFormat()

getDateFormatter

public HIFunction getDateFormatter()

getDescribeNull

public java.lang.Boolean getDescribeNull()

getDescriptionFormat

public java.lang.String getDescriptionFormat()

getDescriptionFormatter

public HIFunction getDescriptionFormatter()

getEvents

public HIEvents getEvents()

getName

public java.lang.String getName()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getPercentage

public java.lang.Number getPercentage()

getPlotX

public java.lang.Number getPlotX()

getPlotY

public java.lang.Number getPlotY()

getSelected

public java.lang.Boolean getSelected()

getSliced

public java.lang.Boolean getSliced()

getTotal

public java.lang.Number getTotal()

getValueDecimals

public java.lang.Number getValueDecimals()

getValueDescriptionFormat

public java.lang.String getValueDescriptionFormat()

getValuePrefix

public java.lang.String getValuePrefix()

getValueSuffix

public java.lang.String getValueSuffix()

getVisible

public java.lang.Boolean getVisible()

getX

public java.lang.Number getX()

getY

public java.lang.Number getY()

onMouseOut

public void onMouseOut()

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

remove

public void remove(boolean redraw)

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

Parameters:

redraw - 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 HIChartView redraw() after.

remove

public void remove(boolean redraw,
                   HIAnimationOptionsObject animation)

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

Parameters:

redraw - 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 HIChartView redraw() after.

animation - Whether to apply animation, and optionally animation configuration.

select

public void select()

Toggle the selection status of a point.

select

public void select(boolean selected)

Toggle the selection status of a point.

Parameters:

selected - When true, the point is selected. When false, the point is unselected. When null or undefined, the selection state is toggled.

select

public void select(boolean selected,
                   boolean accumulate)

Toggle the selection status of a point.

Parameters:

selected - When true, the point is selected. When false, the point is unselected. When null or undefined, the selection state is toggled.

accumulate - 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.

setCategory

public void setCategory(java.lang.String category)

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

setColor

public void setColor(HIColor color)

The point's current color.

setColorIndex

public void setColorIndex(java.lang.Number colorIndex)

The point's current color index, used in styled mode instead of `color`. The color index is inserted in class names used for styling.

setDateFormat

public void setDateFormat(java.lang.String dateFormat)

Date format to use for points on datetime axes when describing them to screen reader users. Defaults to the same format as in tooltip. For an overview of the replacement codes, see `dateFormat`.

setDateFormatter

public void setDateFormatter(HIFunction dateFormatter)

Formatter function to determine the date/time format used with points on datetime axes when describing them to screen reader users. Receives one argument, `point`, referring to the point to describe. Should return a date format string compatible with `dateFormat`.

setDescribeNull

public void setDescribeNull(java.lang.Boolean describeNull)

Whether or not to describe points with the value `null` to assistive technology, such as screen readers.

defaults:

 True

setDescriptionFormat

public void setDescriptionFormat(java.lang.String descriptionFormat)

A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) to use instead of the defaults for point descriptions. The context of the format string is the point instance. As opposed to `accessibility.point.valueDescriptionFormat`, this option replaces the whole description.

setDescriptionFormatter

public void setDescriptionFormatter(HIFunction descriptionFormatter)

/** * description: Formatter function to use instead of the defaults for point descriptions. Same as `accessibility.point.descriptionFormatter`, but applies to a series instead of the whole chart. Note: Prefer using `accessibility.point.valueDescriptionFormat` instead if possible, as defaults functionality such as describing annotations will be preserved.

setEvents

public void setEvents(HIEvents events)

setName

public void setName(java.lang.String name)

The name of the point. The name can be given as the first position of the point configuration array, or as a `name` property in the configuration:

setNestedProperty

public void setNestedProperty(java.lang.Object object,
                              java.lang.Object value,
                              java.lang.String 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:

object - The object to set the value on.

value - The value to set.

key - Key to the property to set.

setPercentage

public void setPercentage(java.lang.Number percentage)

The percentage for points in a stacked series or pies.

setPlotX

public void setPlotX(java.lang.Number plotX)

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.

setPlotY

public void setPlotY(java.lang.Number plotY)

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.

setSelected

public void setSelected(java.lang.Boolean selected)

Whether the point is selected or not.

setSliced

public void setSliced(java.lang.Boolean sliced)

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

setState

public void setState()

Set the point's state.

setState

public void setState(java.lang.Object object,
                     boolean move)

Set the point's state.

Parameters:

object - The new state, can be one of '' (an empty string), hover or select.

move - State for animation.

setState

public void setState(java.lang.String state)

Set the point's state.

Parameters:

state - The new state, can be one of '' (an empty string), hover or select

setTotal

public void setTotal(java.lang.Number total)

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

setValueDecimals

public void setValueDecimals(java.lang.Number valueDecimals)

Decimals to use for the values in the point descriptions. Uses `tooltip.valueDecimals` if not defined.

setValueDescriptionFormat

public void setValueDescriptionFormat(java.lang.String valueDescriptionFormat)

Format to use for describing the values of data points to assistive technology - including screen readers. The point context is available as `{point}`. Other available context variables include `{index}`, `{value}`, and `{xDescription}`. Additionally, the series name, annotation info, and description added in `point.accessibility.description` is added by defaults if relevant. To override this, use the `accessibility.point.descriptionFormatter` option.

defaults:

 {xDescription}{separator}{value}.

setValuePrefix

public void setValuePrefix(java.lang.String valuePrefix)

Prefix to add to the values in the point descriptions. Uses `tooltip.valuePrefix` if not defined.

setValueSuffix

public void setValueSuffix(java.lang.String valueSuffix)

Suffix to add to the values in the point descriptions. Uses `tooltip.valueSuffix` if not defined.

setVisible

public void setVisible(java.lang.Boolean visible)

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

setX

public void setX(java.lang.Number x)

The x value of the point.

setY

public void setY(java.lang.Number y)

The y value of the point.

sonify

public void sonify(java.util.Map options)

Sonify a single point.

Parameters:

options - Options for the sonification of the point.

tooltipFormatter

public void tooltipFormatter(java.lang.String pointFormat)

Extendable method for formatting each point's tooltip line.

Parameters:

pointFormat - The point format.

update

public void update(HIPoint options)

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

Parameters:

options - 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.

update

public void update(HIPoint options,
                   boolean redraw)

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

Parameters:

options - 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 - 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.

update

public void update(HIPoint options,
                   boolean redraw,
                   HIAnimationOptionsObject animation)

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

Parameters:

options - 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 - 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 - Whether to apply animation, and optionally animation configuration.