com.nchart3d.NChart.NChartLineDash Class Reference

The NChartLineDash class provides methods to set up the dash pattern for lines drawn on the chart. More...

Public Member Functions

 NChartLineDash ()
 Init line dash instance.
 
 NChartLineDash (float[] pattern)
 Init line dash instance. More...
 
 NChartLineDash (float[] pattern, float phase)
 Init line dash instance. More...
 
float[] getPattern ()
 Array representing the line dash as the lengths (in pixels) of the painted and unpainted segments, respectively. More...
 
void setPattern (float[] pattern)
 For details see getPattern().
 
float getPhase ()
 Value specifying how far (in pixels) into the dash pattern the line starts. More...
 
void setPhase (float phase)
 For details see getPhase().
 

Detailed Description

The NChartLineDash class provides methods to set up the dash pattern for lines drawn on the chart.

Constructor & Destructor Documentation

com.nchart3d.NChart.NChartLineDash.NChartLineDash ( float[]  pattern)
inline

Init line dash instance.

Parameters
pattern- pattern of the line dash.
com.nchart3d.NChart.NChartLineDash.NChartLineDash ( float[]  pattern,
float  phase 
)
inline

Init line dash instance.

Parameters
pattern- pattern of the line dash.
phase- phase of the line dash.

Member Function Documentation

float [] com.nchart3d.NChart.NChartLineDash.getPattern ( )
inline

Array representing the line dash as the lengths (in pixels) of the painted and unpainted segments, respectively.

If the values is null or an array has no elements, dash is not applied and the line is drawn continuous. The default values is null.
For example, if the array [10, 15] is set, the line will alternate between 10 pixels drawn segment and 15 pixels gap. If [10, 5, 15, 8] is set, the line will be a looped pattern of 10 pixels drawn segment, followed by 5 pixels gap, followed by 15 pixels drawn segment, followed by 8 pixels gap.

float com.nchart3d.NChart.NChartLineDash.getPhase ( )
inline

Value specifying how far (in pixels) into the dash pattern the line starts.

The default value is 0 which means to start interpreting the pattern from the beginning.
For example, if 10 is set, the line is drawn with the dash pattern starting at 10 pixels from its beginning.