com.nchart3d.NChart.NChartSankeySeries Class Reference
The NChartSankeySeries class provides methods to display sankey series. More...
Inheritance diagram for com.nchart3d.NChart.NChartSankeySeries:
Public Member Functions | |
| NChartTooltip | getLabel () |
| Label that will be displayed in the corresponding Sankey node. | |
| void | setLabel (NChartTooltip label) |
| For details see getLabel(). | |
| void | addSubSeries (NChartSankeySeries series) |
| Add subseries. More... | |
| void | removeSubSeries (NChartSankeySeries series) |
| Remove subseries. More... | |
| NChartSankeySeries[] | getSubSeries () |
| Array of subseries. | |
 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 NChartSankeySeries class provides methods to display sankey series.
This type of series is a bit different from the others, because it supports series' hierarchy. Sankey diagram consists of nodes and weighted edges. Nodes are represented by series, edges are represented as links to other series (so-called subseries) and weights are represented by points. For example, to build a graph like A-10->B, where A and B are nodes linked with the edge with the weight 10, you have to create two series, A and B, then add B as subseries to A, and create a point for A with value 10.
Member Function Documentation
|
inline |
Add subseries.
Use this to create Sankey chart connections.
- Parameters
-
series - NChartSankeySeries instance that will be linked to the current one.
|
inline |
Remove subseries.
- Parameters
-
series - NChartSankeySeries instance to remove.
