com.nchart3d.NChart.NChartSeries Class Referenceabstract

The NChartSeries class provides common methods for the series of the chart. More...

Inheritance diagram for com.nchart3d.NChart.NChartSeries:
com.nchart3d.NChart.NChartObject com.nchart3d.NChart.NChartBubbleSeries com.nchart3d.NChart.NChartSolidSeries com.nchart3d.NChart.NChartTouchAreaSeries com.nchart3d.NChart.NChartAreaSeries com.nchart3d.NChart.NChartColumnSeries com.nchart3d.NChart.NChartFunnelSeries com.nchart3d.NChart.NChartHeatmapSeries com.nchart3d.NChart.NChartLineSeries com.nchart3d.NChart.NChartOHLCSeries com.nchart3d.NChart.NChartPieSeries com.nchart3d.NChart.NChartRibbonSeries com.nchart3d.NChart.NChartSequenceSeries com.nchart3d.NChart.NChartSurfaceSeries

Public Member Functions

NChartPoint[] getPoints ()
 Array of points.
 
Bitmap getImage ()
 Image that is displayed in the legend. More...
 
String getName ()
 Name of the series.
 
float getLegendMarkerSize ()
 Size of default series' marker in legend in pixels. More...
 
void setLegendMarkerSize (float legendMarkerSize)
 For details see getLegendMarkerSize().
 
NChartBrushScale getScale ()
 Brush scale of the series used to color the map.
 
void setScale (NChartBrushScale scale)
 For details see getScale().
 
boolean isVisible ()
 Flag that determines if the series is visible or not. More...
 
void setVisible (boolean visible)
 For details see isVisible().
 
boolean getHostsOnSX ()
 Flag that determines if the series is hosted on the secondary X-axis. More...
 
void setHostsOnSX (boolean hostsOnSX)
 For details see getHostsOnSX().
 
boolean getHostsOnSY ()
 Flag that determines if the series is hosted on the secondary Y-axis. More...
 
void setHostsOnSY (boolean hostsOnSY)
 For details see getHostsOnSY().
 
boolean getHostsOnSZ ()
 Flag that determines if the series is hosted on the secondary Z-axis. More...
 
void setHostsOnSZ (boolean hostsOnSZ)
 For details see getHostsOnSZ().
 
NChartSeriesDataSource getDataSource ()
 Data source for the series. More...
 
void setDataSource (NChartSeriesDataSource dataSource)
 For details see getDataSource().
 
NChartDataSmoother getDataSmoother ()
 Data smoother used. More...
 
void setDataSmoother (NChartDataSmoother dataSmoother)
 For details see getDataSmoother().
 
boolean isForceAbsolute ()
 Flag that determines if the series forces absolute value axis. More...
 
void setForceAbsolute (boolean forceAbsolute)
 For details see isForceAbsolute().
 
boolean isPointSelectionEnabled ()
 Flag determining if the chart points can be selected by tap (true) or not (false). More...
 
void setPointSelectionEnabled (boolean pointSelectionEnabled)
 For details see isPointSelectionEnabled().
 
boolean isNeedsSeparateSums ()
 Flag determining if in the additive value axis mode (when valueAxesType = NChartValueAxesType.Additive) positive and negative values are added separately, so all positives are above zero and all negatives are below zero (true), or all the values are just added together (false). More...
 
void setNeedsSeparateSums (boolean needsSeparateSums)
 For details see isNeedsSeparateSums().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean isVisible ()
 Flag that determines if the object is visible or not. More...
 
void setVisible (boolean visible)
 For details see isVisible().
 
NChart getChart ()
 Chart the object belongs to. More...
 

Public Attributes

int tag
 Tag of the series. More...
 

Detailed Description

The NChartSeries class provides common methods for the series of the chart.

Member Function Documentation

NChartDataSmoother com.nchart3d.NChart.NChartSeries.getDataSmoother ( )
inline

Data smoother used.

The default value is null (no data smoother used).

See also
NChartDataSmoother
NChartSeriesDataSource com.nchart3d.NChart.NChartSeries.getDataSource ( )
inline

Data source for the series.

See also
NChartSeriesDataSource
boolean com.nchart3d.NChart.NChartSeries.getHostsOnSX ( )
inline

Flag that determines if the series is hosted on the secondary X-axis.

If true, it will be drawn according to the secondary X-axis, if false according to the normal X-axis. The secondary axis appears opposite the normal axis and is managed separately: it can have its own min and max; its own color settings and so on.

boolean com.nchart3d.NChart.NChartSeries.getHostsOnSY ( )
inline

Flag that determines if the series is hosted on the secondary Y-axis.

If true, it will be drawn according to the secondary Y-axis, if false according to the normal Y-axis. The secondary axis appears opposite the normal axis and is managed separately: it can have its own min and max; its own color settings and so on.

boolean com.nchart3d.NChart.NChartSeries.getHostsOnSZ ( )
inline

Flag that determines if the series is hosted on the secondary Z-axis.

If true, it will be drawn according to the secondary Z-axis, if false according to the normal Z-axis. The secondary axis appears opposite the normal axis and is managed separately: can have its own min and max; its own color settings and so on.

Bitmap com.nchart3d.NChart.NChartSeries.getImage ( )
inline

Image that is displayed in the legend.

This property returns the image only if it was provided by the data source. If the default image is used, null is returned.

float com.nchart3d.NChart.NChartSeries.getLegendMarkerSize ( )
inline

Size of default series' marker in legend in pixels.

The default value is 20.

boolean com.nchart3d.NChart.NChartSeries.isForceAbsolute ( )
inline

Flag that determines if the series forces absolute value axis.

If true, the series is drawn as if value axes type would be absolute, even if it's not. If false, the series is drawn according to the actual value axes type set in Cartesian system. The default value is false. This property has effect for Cartesian system based series only. Otherwise it's ignored.

boolean com.nchart3d.NChart.NChartSeries.isNeedsSeparateSums ( )
inline

Flag determining if in the additive value axis mode (when valueAxesType = NChartValueAxesType.Additive) positive and negative values are added separately, so all positives are above zero and all negatives are below zero (true), or all the values are just added together (false).

The default value is true. Normally it's reasonable to separate the sums (so keep this flag in its default state), but sometimes you may want to preserve the series order when they are stacked on the additive axis. In this case you may want to toggle this flag to false.

boolean com.nchart3d.NChart.NChartSeries.isPointSelectionEnabled ( )
inline

Flag determining if the chart points can be selected by tap (true) or not (false).

The default value is true. If you do not want to select points by tap, it is better to disable selection, because it will save memory and boost the data updating. This property works in conjuction with pointSelectionEnabled of NChart allowing to fine-tune the point selection for individual series.

boolean com.nchart3d.NChart.NChartSeries.isVisible ( )
inline

Flag that determines if the series is visible or not.

The default value is "true".

Member Data Documentation

int com.nchart3d.NChart.NChartSeries.tag

Tag of the series.

You may use it as you want.