com.nchart3d.NChart.NChartTreeSeries Class Reference

The NChartTreeSeries class provides methods to display tree series. More...

Inheritance diagram for com.nchart3d.NChart.NChartTreeSeries:
com.nchart3d.NChart.NChartSolidSeries com.nchart3d.NChart.NChartSeries com.nchart3d.NChart.NChartObject com.nchart3d.NChart.NChartTreeMapSeries

Public Member Functions

void addSubSeries (NChartTreeSeries series)
 Add subseries. More...
 
void removeSubSeries (NChartTreeSeries series)
 Remove subseries. More...
 
NChartTreeSeries[] getSubSeries ()
 Array of subseries.
 
NChartTooltip getLabel ()
 Label that will be displayed in the corresponding box of the tree.
 
void setLabel (NChartTooltip label)
 For details see getLabel().
 
NChartTooltip getTooltip ()
 Tooltip that will be displayed above the corresponding box of the tree.
 
void setTooltip (NChartTooltip tooltip)
 For details see getTooltip().
 
int getConnectionLineColor ()
 Color of connection lines. More...
 
void setConnectionLineColor (int connectionLineColor)
 For details see getConnectionLineColor().
 
float getConnectionLineThickness ()
 Thickness of connection lines (in pixels). More...
 
void setConnectionLineThickness (float connectionLineThickness)
 For details see getConnectionLineThickness().
 
NChartRim getRim ()
 Rim marker to control inset/outset.
 
void setRim (NChartRim rim)
 For details see getRim().
 
void zoomToSubtreeWithDuration (float duration, float delay)
 Zoom the chart to subtree of this series. More...
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartSolidSeries
float getBorderThickness ()
 Thickness (in pixels) of the border that surrounds the series.
 
void setBorderThickness (float borderThickness)
 For details see getBorderThickness().
 
NChartBrush getBrush ()
 Brush that fills the series. More...
 
void setBrush (NChartBrush brush)
 For details see getBrush().
 
NChartBrush getBorderBrush ()
 Brush of the border that surrounds the series. More...
 
void setBorderBrush (NChartBrush borderBrush)
 For details see getBorderBrush().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartSeries
NChartPoint[] getPoints ()
 Array of points.
 
Bitmap getImage ()
 Image that is displayed in the legend. More...
 
Bitmap getDisabledImage ()
 Image that is displayed in the legend when the series is hidden (aka disabled). More...
 
String getName ()
 Name of the series.
 
int getNameColor ()
 Get color of the series name displayed in the legend. More...
 
void setNameColor (int color)
 For details see getNameColor().
 
int getDisabledNameColor ()
 Get color of the series name displayed in the legend when the series is hidden (aka disabled). More...
 
void setDisabledNameColor (int color)
 For details see getDisabledNameColor().
 
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().
 
int getTag ()
 Tag of the series. More...
 
void setTag (int tag)
 For details see getTag().
 
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().
 
boolean isUpdateAllowed ()
 Flag providing a hint that the series has no modifications and should not be updated by the next NChart#rebuildSeries() or NChart#updateSeries() call (false) or it should be updated as normal (true). More...
 
void setUpdateAllowed (boolean updateAllowed)
 For details see isUpdateAllowed().
 
- 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...
 

Detailed Description

The NChartTreeSeries class provides methods to display tree series.

This type of series is a bit different from the others, because it supports series' hierarchy. You can append points to this series (via the NChartSeriesDataSource, just like to any other series), and these points will be shown as leafs of the tree. But also you can append other NChartTreeSeries building the hierarchy. These "sub"-series will be displayed as tree branches. Each instance of NChartTreeSeries can have other instances of NChartTreeSeries and points simultaneously, which allows you to build arbitrary tree structures.

Member Function Documentation

void com.nchart3d.NChart.NChartTreeSeries.addSubSeries ( NChartTreeSeries  series)
inline

Add subseries.

Use this to create subcategories in the tree.

Parameters
series- NChartTreeSeries instance that will be interpreted as a subcategory.
int com.nchart3d.NChart.NChartTreeSeries.getConnectionLineColor ( )
inline

Color of connection lines.

The default value is black color.

float com.nchart3d.NChart.NChartTreeSeries.getConnectionLineThickness ( )
inline

Thickness of connection lines (in pixels).

The default value is 1.0.

void com.nchart3d.NChart.NChartTreeSeries.removeSubSeries ( NChartTreeSeries  series)
inline

Remove subseries.

Parameters
series- NChartTreeSeries instance to remove.
void com.nchart3d.NChart.NChartTreeSeries.zoomToSubtreeWithDuration ( float  duration,
float  delay 
)
inline

Zoom the chart to subtree of this series.

Parameters
duration- duration of zoom animation (in seconds).
delay- delay of the animation start (in seconds).