The NChartPointState class provides methods to store state of a point. More...

Public Member Functions
NChartBrush	getBrush ()
	Brush that fills the point. More...

void	setBrush (NChartBrush brush)
	For details see getBrush().

NChartBrush	getBorderBrush ()
	Brush of the point's border. More...

void	setBorderBrush (NChartBrush borderBrush)
	For details see getBorderBrush().

NChartMarker	getMarker ()
	Marker of the point. More...

void	setMarker (NChartMarker marker)
	For details see getMarker().

int	getIntX ()
	Integer X value of a point state.

void	setIntX (int intX)
	For details see getIntX().

double	getDoubleX ()
	Double X value of a point state.

void	setDoubleX (double doubleX)
	For details see getDoubleX().

Date	getDateX ()
	Date X value of a point state.

void	setDateX (Date date)
	For details see getDoubleX().

int	getIntY ()
	Integer Y value of a point state.

void	setIntY (int intY)
	For details see getIntY().

double	getDoubleY ()
	Double Y value of a point state.

void	setDoubleY (double doubleY)
	For details see getDoubleY().

Date	getDateY ()
	Date Y value of a point state.

void	setDateY (Date date)
	For details see getDoubleX().

int	getIntZ ()
	Integer Z value of a point state.

void	setIntZ (int intZ)
	For details see getIntZ().

double	getDoubleZ ()
	Double Z value of a point state.

void	setDoubleZ (double doubleZ)
	For details see getDoubleZ().

Date	getDateZ ()
	Date Z value of a point state.

void	setDateZ (Date date)
	For details see getDoubleZ().

int	getCircle ()
	Circle of a point state. More...

void	setCircle (int circle)
	For details see getCircle().

double	getValue ()
	Value of a point state. More...

void	setValue (double value)
	For details see getValue().

double	getHeight ()
	Height of a point state. More...

void	setHeight (double height)
	For details see getHeight().

double	getLow ()
	Low value of a point state. More...

void	setLow (double low)
	For details see getLow().

double	getClose ()
	Close value of a point state. More...

void	setClose (double close)
	For details see getClose().

double	getOpen ()
	Open value of a point state. More...

void	setOpen (double open)
	For details see getOpen().

double	getHigh ()
	High value of a point state. More...

void	setHigh (double high)
	For details see getHigh().

Static Public Member Functions
static NChartPointState	PointStateAlignedToXWithXY (int x, double y)
	Create a point state representing the point that is aligned to the X grid. More...

static NChartPointState	PointStateAlignedToXWithXY (Date x, double y)
	Create a point state representing the point that is aligned to the X date grid. More...

static NChartPointState	PointStateAlignedToXZWithXYZ (int x, double y, int z)
	Create a point state representing the point that is aligned to the XZ grid. More...

static NChartPointState	PointStateAlignedToXZWithXYZ (Date x, double y, Date z)
	Create a point state representing the point that is aligned to the XZ date grid. More...

static NChartPointState	PointStateAlignedToXZWithXYZ (Date x, double y, int z)
	Create a point state representing the point that is aligned to the X date grid and Z grid. More...

static NChartPointState	PointStateAlignedToXZWithXYZ (int x, double y, Date z)
	Create a point state representing the point that is aligned to the X grid and Z date grid. More...

static NChartPointState	PointStateAlignedToYWithXY (double x, int y)
	Create a point state representing the point that is aligned to the Y grid. More...

static NChartPointState	PointStateAlignedToYWithXY (double x, Date y)
	Create a point state representing the point that is aligned to the Y grid. More...

static NChartPointState	PointStateAlignedToYZWithXYZ (double x, int y, int z)
	Create a point state representing the point that is aligned to the YZ grid. More...

static NChartPointState	PointStateAlignedToYZWithXYZ (double x, Date y, Date z)
	Create a point state representing the point that is aligned to the YZ grid. More...

static NChartPointState	PointStateAlignedToYZWithXYZ (double x, Date y, int z)
	Create a point state representing the point that is aligned to the YZ grid. More...

static NChartPointState	PointStateAlignedToYZWithXYZ (double x, int y, Date z)
	Create a point state representing the point that is aligned to the YZ grid. More...

static NChartPointState	PointStateWithCircleValue (int circle, double value)
	Create a point state representing the point that is aligned to the concentric circles. More...

static NChartPointState	PointStateWithCircleValueHeight (int circle, double value, double height)
	Create a point state representing the point that is aligned to the concentric circles and has the height. More...

static NChartPointState	PointStateWithXYZ (double x, double y, double z)
	Create free (not aligned) 3D-space point. More...

static NChartPointState	PointStateAlignedToXWithXLowOpenCloseHigh (int x, double low, double open, double close, double high)
	Create a point state that is aligned to the X grid and has low, open, close and high values. More...

static NChartPointState	PointStateAlignedToXWithXLowOpenCloseHigh (Date x, double low, double open, double close, double high)
	Create a point state that is aligned to the X grid and has low, open, close and high values. More...

static NChartPointState	PointStateAlignedToYWithYOpenClose (int y, double open, double close)
	Create a point state that is aligned to the Y grid and has open and close values. More...

static NChartPointState	PointStateAlignedToYWithYOpenClose (Date y, double open, double close)
	Create a point state that is aligned to the Y grid and has open and close values. More...

static NChartPointState	PointStateAlignedToXWithXLowHigh (int x, double low, double high)
	Create a point state that is aligned to the X grid and has low and high values. More...

static NChartPointState	PointStateAlignedToXWithXLowHigh (Date x, double low, double high)
	Create a point state that is aligned to the X grid and has low and high values. More...

static NChartPointState	PointStateAlignedToXZWithXZLowOpenCloseHigh (int x, int z, double low, double open, double close, double high)
	Create a point state that is aligned to the XZ grid and has low, open, close and high values. More...

static NChartPointState	PointStateAlignedToXZWithXZLowOpenCloseHigh (Date x, Date z, double low, double open, double close, double high)
	Create a point state that is aligned to the XZ grid and has low, open, close and high values. More...

static NChartPointState	PointStateAlignedToXZWithXZLowOpenCloseHigh (Date x, int z, double low, double open, double close, double high)
	Create a point state that is aligned to the XZ grid and has low, open, close and high values. More...

static NChartPointState	PointStateAlignedToXZWithXZLowOpenCloseHigh (int x, Date z, double low, double open, double close, double high)
	Create a point state that is aligned to the XZ grid and has low, open, close and high values. More...

static NChartPointState	PointStateWithXYValue (double x, double y, double value)
	Create free (not aligned) 2D-space point state with value. More...

static NChartPointState	PointStateWithXYZValue (double x, double y, double z, double value)
	Create free (not aligned) 3D-space point state with value. More...

Detailed Description

The NChartPointState class provides methods to store state of a point.

The state of a point is a complex of parameters such as position, brush used etc. for a particular period for a particular point. Each chart point should have at least one state representing the data from the data source for this point, but it can have multiple states. This allows the animation of a chart through time, while each NChartPointState represents the state of the point in a particular time tick. The transition from one state to another is animated automatically by linear interpolation of parameters stored in the states.

Member Function Documentation

NChartBrush com.nchart3d.NChart.NChartPointState.getBorderBrush ( )

inline

Brush of the point's border.

See also: NChartBrush

NChartBrush com.nchart3d.NChart.NChartPointState.getBrush ( )

inline

Brush that fills the point.

See also: NChartBrush

int com.nchart3d.NChart.NChartPointState.getCircle ( )

inline

Circle of a point state.

See also: PointStateWithCircleValue(int, double); PointStateWithCircleValueHeight(int, double, double)

double com.nchart3d.NChart.NChartPointState.getClose ( )

inline

Close value of a point state.

See also: PointStateAlignedToXWithXLowOpenCloseHigh(int, double, double, double, double); PointStateAlignedToXZWithXZLowOpenCloseHigh(int, int, double, double, double, double)

double com.nchart3d.NChart.NChartPointState.getHeight ( )

inline

Height of a point state.

See also: PointStateWithCircleValue(int, double); PointStateWithCircleValueHeight(int, double, double)

double com.nchart3d.NChart.NChartPointState.getHigh ( )

inline

High value of a point state.

See also: PointStateAlignedToXWithXLowOpenCloseHigh(int, double, double, double, double); PointStateAlignedToXZWithXZLowOpenCloseHigh(int, int, double, double, double, double)

double com.nchart3d.NChart.NChartPointState.getLow ( )

inline

Low value of a point state.

See also: PointStateAlignedToXWithXLowOpenCloseHigh(int, double, double, double, double); PointStateAlignedToXZWithXZLowOpenCloseHigh(int, int, double, double, double, double)

NChartMarker com.nchart3d.NChart.NChartPointState.getMarker ( )

inline

Marker of the point.

See also: NChartMarker

double com.nchart3d.NChart.NChartPointState.getOpen ( )

inline

Open value of a point state.

See also: PointStateAlignedToXWithXLowOpenCloseHigh(int, double, double, double, double); PointStateAlignedToXZWithXZLowOpenCloseHigh(int, int, double, double, double, double)

double com.nchart3d.NChart.NChartPointState.getValue ( )

inline

Value of a point state.

See also: PointStateWithCircleValue(int, double); PointStateWithCircleValueHeight(int, double, double)

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXLowHigh	(	int	x,
		double	low,
		double	high
	)

inlinestatic

Create a point state that is aligned to the X grid and has low and high values.

This is the a typical state for a band series drawn in 2D.

Parameters

x	- integer value on the X axis that represents the category.
low	- double value on the Y axis that represents the "low" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXLowHigh	(	Date	x,
		double	low,
		double	high
	)

inlinestatic

Create a point state that is aligned to the X grid and has low and high values.

This is the a typical state for a band series drawn in 2D.

Parameters

x	- date value on the X axis that represents the category.
low	- double value on the Y axis that represents the "low" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXLowOpenCloseHigh	(	int	x,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the X grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 2D.

Parameters

x	- integer value on the X axis that represents the category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXLowOpenCloseHigh	(	Date	x,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the X grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 2D.

Parameters

x	- date value on the X axis that represents the category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXY	(	int	x,
		double	y
	)

inlinestatic

Create a point state representing the point that is aligned to the X grid.

This is a typical state for column, area, line and ribbon series if drawn in 2D.

Parameters

x	- integer value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXWithXY	(	Date	x,
		double	y
	)

inlinestatic

Create a point state representing the point that is aligned to the X date grid.

This is a typical state for column, area, line and ribbon series if drawn in 2D.

Parameters

x	- date value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.

Returns: a new instance of the point state.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXYZ	(	int	x,
		double	y,
		int	z
	)

inlinestatic

Create a point state representing the point that is aligned to the XZ grid.

This is a typical state for column, area, line and ribbon series if drawn in 3D. This can also be used for a surface.

Parameters

x	- integer value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.
z	- integer value on the Z axis that represents the second category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXYZ	(	Date	x,
		double	y,
		Date	z
	)

inlinestatic

Create a point state representing the point that is aligned to the XZ date grid.

This is a typical state for column, area, line and ribbon series if drawn in 3D. This can also be used for a surface.

Parameters

x	- date value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.
z	- date value on the Z axis that represents the second category.

Returns: a new instance of the point state.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXYZ	(	Date	x,
		double	y,
		int	z
	)

inlinestatic

Create a point state representing the point that is aligned to the X date grid and Z grid.

This is a typical state for column, area, line and ribbon series if drawn in 3D. This can also be used for a surface.

Parameters

x	- date value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.
z	- integer value on the Z axis that represents the second category.

Returns: a new instance of the point state.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXYZ	(	int	x,
		double	y,
		Date	z
	)

inlinestatic

Create a point state representing the point that is aligned to the X grid and Z date grid.

This is a typical state for column, area, line and ribbon series if drawn in 3D. This can also be used for a surface.

Parameters

x	- integer value on the X axis that represents the first category.
y	- double value on the Y axis that represents the height value.
z	- date value on the Z axis that represents the second category.

Returns: a new instance of the point state.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXZLowOpenCloseHigh	(	int	x,
		int	z,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the XZ grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 3D.

Parameters

x	- integer value on the X axis that represents the first category.
z	- integer value on the Z axis that represents the second category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXZLowOpenCloseHigh	(	Date	x,
		Date	z,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the XZ grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 3D.

Parameters

x	- date value on the X axis that represents the first category.
z	- date value on the Z axis that represents the second category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXZLowOpenCloseHigh	(	Date	x,
		int	z,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the XZ grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 3D.

Parameters

x	- date value on the X axis that represents the first category.
z	- integer value on the Z axis that represents the second category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToXZWithXZLowOpenCloseHigh	(	int	x,
		Date	z,
		double	low,
		double	open,
		double	close,
		double	high
	)

inlinestatic

Create a point state that is aligned to the XZ grid and has low, open, close and high values.

This is a typical state for candlestick series drawn in 3D.

Parameters

x	- integer value on the X axis that represents the first category.
z	- date value on the Z axis that represents the second category.
low	- double value on the Y axis that represents the "low" value.
open	- double value on the Y axis that represents the "open" value.
close	- double value on the Y axis that represents the "close" value.
high	- double value on the Y axis that represents the "high" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYWithXY	(	double	x,
		int	y
	)

inlinestatic

Create a point state representing the point that is aligned to the Y grid.

This is a typical state for bar series if drawn in 2D.

Parameters

x	- double value on X axis that represents the height value.
y	- integer value on Y axis that represents the first category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYWithXY	(	double	x,
		Date	y
	)

inlinestatic

Create a point state representing the point that is aligned to the Y grid.

This is a typical state for bar series if drawn in 2D.

Parameters

x	- double value on X axis that represents the height value.
y	- date value on Y axis that represents the first category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYWithYOpenClose	(	int	y,
		double	open,
		double	close
	)

inlinestatic

Create a point state that is aligned to the Y grid and has open and close values.

This is the a typical state for a sequence series drawn in 2D.

Parameters

y	- integer value on the Y axis that represents the category.
open	- double value on the X axis that represents the "open" value.
close	- double value on the X axis that represents the "close" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYWithYOpenClose	(	Date	y,
		double	open,
		double	close
	)

inlinestatic

Create a point state that is aligned to the Y grid and has open and close values.

This is the a typical state for a sequence series drawn in 2D.

Parameters

y	- date value on the Y axis that represents the category.
open	- double value on the X axis that represents the "open" value.
close	- double value on the X axis that represents the "close" value.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYZWithXYZ	(	double	x,
		int	y,
		int	z
	)

inlinestatic

Create a point state representing the point that is aligned to the YZ grid.

This is a typical state for bar series if drawn in 3D.

Parameters

x	- double value on X axis that represents the height value.
y	- integer value on Y axis that represents the first category.
z	- integer value on Z axis that represents the second category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYZWithXYZ	(	double	x,
		Date	y,
		Date	z
	)

inlinestatic

Create a point state representing the point that is aligned to the YZ grid.

This is a typical state for bar series if drawn in 3D.

Parameters

x	- double value on X axis that represents the height value.
y	- date value on Y axis that represents the first category.
z	- date value on Z axis that represents the second category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYZWithXYZ	(	double	x,
		Date	y,
		int	z
	)

inlinestatic

Create a point state representing the point that is aligned to the YZ grid.

This is a typical state for bar series if drawn in 3D.

Parameters

x	- double value on X axis that represents the height value.
y	- date value on Y axis that represents the first category.
z	- integer value on Z axis that represents the second category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateAlignedToYZWithXYZ	(	double	x,
		int	y,
		Date	z
	)

inlinestatic

Create a point state representing the point that is aligned to the YZ grid.

This is a typical state for bar series if drawn in 3D.

Parameters

x	- double value on X axis that represents the height value.
y	- integer value on Y axis that represents the first category.
z	- date value on Z axis that represents the second category.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateWithCircleValue	(	int	circle,
		double	value
	)

inlinestatic

Create a point state representing the point that is aligned to the concentric circles.

This is a typical state for pie series if drawn in 2D.

Parameters

circle	- number of circle among concentric circles that represents the category.
value	- value of the state that affects the angle of the sector. The angle will represent the percent of the value among all values in the circle this state belongs to.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateWithCircleValueHeight	(	int	circle,
		double	value,
		double	height
	)

inlinestatic

Create a point state representing the point that is aligned to the concentric circles and has the height.

This is a typical state for pie series if drawn in 3D.

Parameters

circle	- number of circle among concentric circles that represents the category.
value	- value of the state that affects the angle of the sector. The angle will represent the percent of the value among all values in the circle this state belongs to.
height	- height of sector. The height should be in interval 0..1. It is not connected to any axis, so the value is not mapped. You may use it to visually group sectors or to stress some of them.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateWithXYValue	(	double	x,
		double	y,
		double	value
	)

inlinestatic

Create free (not aligned) 2D-space point state with value.

This is a typical state for heatmap series.

Parameters

x	- double value on the X axis that represents the abscissa of a position.
y	- double value on the Y axis that represents the ordinate of a position.
value	- value of the state that represents the amount of entity displayed by series.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateWithXYZ	(	double	x,
		double	y,
		double	z
	)

inlinestatic

Create free (not aligned) 3D-space point.

This is a typical state for bubble or surface series. But you may use this for other series types too.

Parameters

x	- double value on the X axis that represents the abscissa of a position.
y	- double value on the Y axis that represents the ordinate of a position.
z	- double value on the Z axis that represents the applicate of a position.

static NChartPointState com.nchart3d.NChart.NChartPointState.PointStateWithXYZValue	(	double	x,
		double	y,
		double	z,
		double	value
	)

inlinestatic

Create free (not aligned) 3D-space point state with value.

This is a typical state for surface series colored not by height, but by fourth component value.

Parameters

x	- double value on the X axis that represents the abscissa of a position.
y	- double value on the Y axis that represents the ordinate of a position.
z	- double value on the Z axis that represents the ordinate of a position.
value	- value of the state that represents the amount of entity displayed by series.

Returns: a new instance of the point state.

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation