The NChartPoint class provides methods to manage chart's points. More...

Inheritance diagram for com.nchart3d.NChart.NChartPoint:

Public Member Functions
	NChartPoint (NChartPointState[] states, NChartSeries series)
	Create point with an array of states. More...

	NChartPoint (NChartPointState state, NChartSeries series)
	Create point with a single state. More...

NChartSeries	getSeries ()

NChartPointState[]	getStates ()
	If a point was created with a single state, the array of states is not allocated and this property returns null. More...

int	getCurrentStateIndex ()
	If a point was created with a single state, this property always returns 0. More...

NChartPointState	getCurrentState ()
	Direct access to current state. More...

NChartTooltip	getTooltip ()
	The tooltip is just a label, it does not change its content automatically. More...

void	setTooltip (NChartTooltip tooltip)
	For details see getTooltip(). More...

NChartTooltip	getLabel ()
	It is null by default. More...

void	setLabel (NChartTooltip label)
	For details see getLabel(). More...

int	getHighlightColor ()
	Highlight color. More...

void	setHighlightColor (int highlightColor)
	For details see getHighlightColor().

float	getHighlightShift ()
	Highlight shift. More...

void	setHighlightShift (float highlightShift)
	For details see getHighlightShift().

void	highlight (int mask, float duration, float delay)
	Highlight point using the highlight settings done by `highlightColor` and `highlightShift` properties. More...

NChartAccessibilityElement	accessibilityElement ()
	Accessibility element tied to the point. More...

void	setAccessibilityElement (NChartAccessibilityElement accessibilityElement)
	For details see accessibilityElement(). More...

Public Attributes
int	tag
	Tag of the point. More...

Detailed Description

The NChartPoint class provides methods to manage chart's points.

Constructor & Destructor Documentation

com.nchart3d.NChart.NChartPoint.NChartPoint	(	NChartPointState[]	states,
		NChartSeries	series
	)

inline

Create point with an array of states.

Parameters

states	- the array of point states. See NChartPointState for details.
series	- the series the point belongs to.

See also: NChartSeries

com.nchart3d.NChart.NChartPoint.NChartPoint	(	NChartPointState	state,
		NChartSeries	series
	)

inline

Create point with a single state.

Parameters

state	- the state if point. See NChartPointState for details.
series	- the series the point belongs to.

See also: NChartSeries

Member Function Documentation

NChartAccessibilityElement com.nchart3d.NChart.NChartPoint.accessibilityElement ( )

inline

Accessibility element tied to the point.

The default value is null, which means, you need to create that element yourself

Returns: accessibility element

See also: NChartAccessibilityElement

NChartPointState com.nchart3d.NChart.NChartPoint.getCurrentState ( )

inline

Direct access to current state.

This is a bit faster and more convenient than a query element of the states' array by getCurrentStateIndex(). If a point was created with a single state, this property is the only way to access it.

Returns: current state.

See also: NChartPointState

int com.nchart3d.NChart.NChartPoint.getCurrentStateIndex ( )

inline

If a point was created with a single state, this property always returns 0.

Returns: index of current state.

int com.nchart3d.NChart.NChartPoint.getHighlightColor ( )

inline

Highlight color.

Some points can be highlighted by color, for example in column, pie or bubble (where the points are individual objects). In series like line and area the color highlight can be applied to the markers, so for these series this property has effect only if the marker is set.

float com.nchart3d.NChart.NChartPoint.getHighlightShift ( )

inline

Highlight shift.

Some points can be highlighted by shift, for example in pie. The shift is set in scene units. For example, the radius of pie is 1 scene unit, so you can use this value as a reference.

NChartTooltip com.nchart3d.NChart.NChartPoint.getLabel ( )

inline

It is null by default.

The label does not change its content automatically. By altering its text, you can display any information you want, but you should do it yourself. Label is similar to tooltip, but it is placed in the top of the point by default. You can have tooltip and label simultaneously displaying different information.

Returns: label that is shown near the point.

See also: NChartTooltip; setTooltip(NChartTooltip)

NChartSeries com.nchart3d.NChart.NChartPoint.getSeries ( )

inline

Returns: Series the point belongs to.

See also: NChartSeries

NChartPointState [] com.nchart3d.NChart.NChartPoint.getStates ( )

inline

If a point was created with a single state, the array of states is not allocated and this property returns null.

Returns: array of states.

See also: NChartPointState

NChartTooltip com.nchart3d.NChart.NChartPoint.getTooltip ( )

inline

The tooltip is just a label, it does not change its content automatically.

By altering its text, you can display any information you want, but you should do it yourself.
Tooltip is similar to label, but it is placed in the center of the point by default. You can have tooltip and label simultaneously displaying different information.

Returns: tooltip that is shown on the point. It is null by default.

See also: NChartTooltip; setLabel(NChartTooltip)

void com.nchart3d.NChart.NChartPoint.highlight	(	int	mask,
		float	duration,
		float	delay
	)

inline

Highlight point using the highlight settings done by highlightColor and highlightShift properties.

Parameters

mask	- mask of highlighting. See NChartHighlightType enum for details. You may use multiple constants concatenated with bitwise OR.
duration	- duration of highlighting animation in seconds.
delay	- delay to start of highlighting animation in seconds.