com.highsoft.highcharts.common.hichartsclasses

Class HIDependencywheel

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HIDependencywheel

public class HIDependencywheel
extends HISeries

A `dependencywheel` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `dependencywheel` series are defined in `plotOptions.dependencywheel`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, dependencywheel: { // shared options for all dependencywheel series } }, series: [{ // specific options for this series instance type: 'dependencywheel' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HIDependencywheel()

Method Summary

Modifier and Type	Method and Description
HIColor	getBorderColor()
java.lang.Number	getBorderWidth()
java.util.ArrayList	getCenter()
java.lang.Boolean	getCenterInCategory()
java.lang.Boolean	getColorByPoint()
java.util.ArrayList<java.lang.String>	getColors()
java.lang.Number	getCurveFactor()
java.util.ArrayList	getLevels()
java.lang.String	getLinkColorMode()
java.lang.Number	getLinkOpacity()
java.lang.Number	getMinLinkWidth()
java.lang.Number	getNodePadding()
java.util.ArrayList	getNodes()
java.lang.Object	getNodeWidth()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Object	getSize()
java.lang.Number	getStartAngle()
void	setBorderColor(HIColor borderColor) The color of the border surrounding each column or bar.
void	setBorderWidth(java.lang.Number borderWidth) /** * description: The width of the border surrounding each column or bar.
void	setCenter(java.util.ArrayList center) The center of the wheel relative to the plot area.
void	setCenterInCategory(java.lang.Boolean centerInCategory) When `true`, the columns will center in the category, ignoring null or missing points.
void	setColorByPoint(java.lang.Boolean colorByPoint) /** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point.
void	setColors(java.util.ArrayList<java.lang.String> colors) A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
void	setCurveFactor(java.lang.Number curveFactor) /** * description: Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved.
void	setLevels(java.util.ArrayList levels) Set options on specific levels.
void	setLinkColorMode(java.lang.String linkColorMode) Determines color mode for sankey links.
void	setLinkOpacity(java.lang.Number linkOpacity) Opacity for the links between nodes in the sankey diagram.
void	setMinLinkWidth(java.lang.Number minLinkWidth) The minimal width for a line of a sankey.
void	setNodePadding(java.lang.Number nodePadding) The padding between nodes in a sankey diagram or dependency wheel, in pixels.
void	setNodes(java.util.ArrayList nodes) A collection of options for the individual nodes.
void	setNodeWidth(java.lang.Object nodeWidth) The pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.
void	setSize(java.lang.Object size) Size of the wheel in pixel or percent relative to the canvas space.
void	setStartAngle(java.lang.Number startAngle) The start angle of the dependency wheel, in degrees where 0 is up.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIDependencywheel

public HIDependencywheel()

Method Detail

getBorderColor

public HIColor getBorderColor()

getBorderWidth

public java.lang.Number getBorderWidth()

getCenter

public java.util.ArrayList getCenter()

getCenterInCategory

public java.lang.Boolean getCenterInCategory()

getColorByPoint

public java.lang.Boolean getColorByPoint()

getColors

public java.util.ArrayList<java.lang.String> getColors()

getCurveFactor

public java.lang.Number getCurveFactor()

getLevels

public java.util.ArrayList getLevels()

getLinkColorMode

public java.lang.String getLinkColorMode()

getLinkOpacity

public java.lang.Number getLinkOpacity()

getMinLinkWidth

public java.lang.Number getMinLinkWidth()

getNodePadding

public java.lang.Number getNodePadding()

getNodes

public java.util.ArrayList getNodes()

getNodeWidth

public java.lang.Object getNodeWidth()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Overrides:

getParams in class HISeries

getSize

public java.lang.Object getSize()

getStartAngle

public java.lang.Number getStartAngle()

setBorderColor

public void setBorderColor(HIColor borderColor)

The color of the border surrounding each column or bar. In styled mode, the border stroke can be set with the `.highcharts-point` rule.

defaults:

 #ffffff

setBorderWidth

public void setBorderWidth(java.lang.Number borderWidth)

/** * description: The width of the border surrounding each column or bar. Defaults to `1` when there is room for a border, but to `0` when the columns are so dense that a border would cover the next column. In styled mode, the stroke width can be set with the `.highcharts-point` rule. * demo: * [2px black border](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-borderwidth/)

setCenter

public void setCenter(java.util.ArrayList center)

The center of the wheel relative to the plot area. Can be percentages or pixel values. The defaults behaviour is to center the wheel inside the plot area.

defaults:

 [null, null]

setCenterInCategory

public void setCenterInCategory(java.lang.Boolean centerInCategory)

When `true`, the columns will center in the category, ignoring null or missing points. When `false`, space will be reserved for null or missing points.

setColorByPoint

public void setColorByPoint(java.lang.Boolean colorByPoint)

/** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point. In styled mode, the `colors` or `series.colors` arrays are not supported, and instead this option gives the points individual color class names on the form `highcharts-color-{n}`. * demo: * [False by defaults](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-false/) * [True](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-true/) defaults: True

setColors

public void setColors(java.util.ArrayList<java.lang.String> colors)

A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.

setCurveFactor

public void setCurveFactor(java.lang.Number curveFactor)

/** * description: Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved. A `curveFactor` of 0 makes the lines straight. defaults: 0.6

setLevels

public void setLevels(java.util.ArrayList levels)

Set options on specific levels. Takes precedence over series options, but not node and link options.

setLinkColorMode

public void setLinkColorMode(java.lang.String linkColorMode)

Determines color mode for sankey links. Available options: - `from` color of the sankey link will be the same as the 'from node' - `gradient` color of the sankey link will be set to gradient between colors of 'from node' and 'to node' - `to` color of the sankey link will be same as the 'to node'.

defaults:

 from

setLinkOpacity

public void setLinkOpacity(java.lang.Number linkOpacity)

Opacity for the links between nodes in the sankey diagram.

defaults:

 0.5

setMinLinkWidth

public void setMinLinkWidth(java.lang.Number minLinkWidth)

The minimal width for a line of a sankey. By defaults, 0 values are not shown.

defaults:

 0

setNodePadding

public void setNodePadding(java.lang.Number nodePadding)

The padding between nodes in a sankey diagram or dependency wheel, in pixels. For sankey charts, this applies to the nodes of the same column, so vertical distance by defaults, or horizontal distance in an inverted (vertical) sankey. If the number of nodes is so great that it is impossible to lay them out within the plot area with the given `nodePadding`, they will be rendered with a smaller padding as a strategy to avoid overflow.

defaults:

 10

setNodes

public void setNodes(java.util.ArrayList nodes)

A collection of options for the individual nodes. The nodes in a dependency diagram are auto-generated instances of `Highcharts.Point`, but options can be applied here and linked by the `id`.

setNodeWidth

public void setNodeWidth(java.lang.Object nodeWidth)

The pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted. Can be a number or a percentage string. Sankey series also support setting it to `auto`. With this setting, the nodes are sized to fill up the plot area in the longitudinal direction, regardless of the number of levels.

defaults:

 20

setSize

public void setSize(java.lang.Object size)

Size of the wheel in pixel or percent relative to the canvas space.

defaults:

 100%

setStartAngle

public void setStartAngle(java.lang.Number startAngle)

The start angle of the dependency wheel, in degrees where 0 is up.