HIArcdiagram

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HISeries
    - - com.highsoft.highcharts.common.hichartsclasses.HIArcdiagram

```
public class HIArcdiagram
extends HISeries
```
An `arcdiagram` 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 `arcdiagram` series are defined in `plotOptions.arcdiagram`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, arcdiagram: { // shared options for all arcdiagram series } }, series: [{ // specific options for this series instance type: 'arcdiagram' }] }); ```

Constructor Summary

Constructors
Constructor and Description

HIArcdiagram()

Constructors
Constructor and Description
`HIArcdiagram()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIColor`	`getBorderColor()`
`java.lang.Number`	`getBorderWidth()`
`java.lang.Boolean`	`getCenteredLinks()`
`java.lang.Boolean`	`getColorByPoint()`
`java.util.ArrayList<java.lang.String>`	`getColors()`
`java.lang.Boolean`	`getEqualNodes()`
`java.util.ArrayList`	`getLevels()`
`java.lang.String`	`getLinkColorMode()`
`java.lang.Number`	`getLinkOpacity()`
`java.lang.Number`	`getLinkRadius()`
`java.lang.Number`	`getLinkWeight()`
`java.lang.Number`	`getMinLinkWidth()`
`java.lang.Object`	`getNodeDistance()`
`java.util.ArrayList`	`getNodes()`
`java.lang.Object`	`getNodeWidth()`
`java.lang.String`	`getOffset()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Boolean`	`getReversed()`
`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`	`setCenteredLinks(java.lang.Boolean centeredLinks)` The option to center links rather than position them one after another defaults: false
`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`	`setEqualNodes(java.lang.Boolean equalNodes)` Whether nodes with different values should have the same size.
`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`	`setLinkRadius(java.lang.Number linkRadius)` The radius of the link arc.
`void`	`setLinkWeight(java.lang.Number linkWeight)` The global link weight, in pixels.
`void`	`setMinLinkWidth(java.lang.Number minLinkWidth)` The minimal width for a line of a sankey.
`void`	`setNodeDistance(java.lang.Object nodeDistance)` The distance between nodes in a sankey diagram in the longitudinal direction.
`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`	`setOffset(java.lang.String offset)` The offset of an arc diagram nodes column in relation to the `plotArea`.
`void`	`setReversed(java.lang.Boolean reversed)` Whether the series should be placed on the other side of the `plotArea`.

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
  - HIArcdiagram
```
public HIArcdiagram()
```
- Method Detail
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getCenteredLinks
```
public java.lang.Boolean getCenteredLinks()
```
  - getColorByPoint
```
public java.lang.Boolean getColorByPoint()
```
  - getColors
```
public java.util.ArrayList<java.lang.String> getColors()
```
  - getEqualNodes
```
public java.lang.Boolean getEqualNodes()
```
  - getLevels
```
public java.util.ArrayList getLevels()
```
  - getLinkColorMode
```
public java.lang.String getLinkColorMode()
```
  - getLinkOpacity
```
public java.lang.Number getLinkOpacity()
```
  - getLinkRadius
```
public java.lang.Number getLinkRadius()
```
  - getLinkWeight
```
public java.lang.Number getLinkWeight()
```
  - getMinLinkWidth
```
public java.lang.Number getMinLinkWidth()
```
  - getNodeDistance
```
public java.lang.Object getNodeDistance()
```
  - getNodes
```
public java.util.ArrayList getNodes()
```
  - getNodeWidth
```
public java.lang.Object getNodeWidth()
```
  - getOffset
```
public java.lang.String getOffset()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Overrides:
    
    getParams in class HISeries
  - getReversed
```
public java.lang.Boolean getReversed()
```
  - 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/)
  - setCenteredLinks
```
public void setCenteredLinks(java.lang.Boolean centeredLinks)
```
    The option to center links rather than position them one after another
    
    defaults:
    
    false
  - 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.
  - setEqualNodes
```
public void setEqualNodes(java.lang.Boolean equalNodes)
```
    Whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the `nodePadding` and current `plotArea`. It is possible to override it using the `marker.radius` option.
    
    defaults:
    
    false
  - 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
  - setLinkRadius
```
public void setLinkRadius(java.lang.Number linkRadius)
```
    The radius of the link arc. If not set, series renders a semi-circle between the nodes, except when overflowing the edge of the plot area, in which case an arc touching the edge is rendered. If `linkRadius` is set, an arc extending to the given value is rendered.
    
    defaults:
    
    undefined
  - setLinkWeight
```
public void setLinkWeight(java.lang.Number linkWeight)
```
    The global link weight, in pixels. If not set, width is calculated per link, depending on the weight value.
    
    defaults:
    
    undefined
  - 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
  - setNodeDistance
```
public void setNodeDistance(java.lang.Object nodeDistance)
```
    The distance between nodes in a sankey diagram in the longitudinal direction. The longitudinal direction means the direction that the chart flows - in a horizontal chart the distance is horizontal, in an inverted chart (vertical), the distance is vertical. If a number is given, it denotes pixels. If a percentage string is given, the distance is a percentage of the rendered node width. A `nodeDistance` of `100%` will render equal widths for the nodes and the gaps between them. This option applies only when the `nodeWidth` option is `auto`, making the node width respond to the number of columns.
    
    defaults:
    
    30
  - setNodes
```
public void setNodes(java.util.ArrayList nodes)
```
    A collection of options for the individual nodes. The nodes in an arc 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
  - setOffset
```
public void setOffset(java.lang.String offset)
```
    The offset of an arc diagram nodes column in relation to the `plotArea`. The offset equal to 50% places nodes in the center of a chart. By defaults the series is placed so that the biggest node is touching the bottom border of the `plotArea`.
    
    defaults:
    
    '100%'
  - setReversed
```
public void setReversed(java.lang.Boolean reversed)
```
    Whether the series should be placed on the other side of the `plotArea`.
    
    defaults:
    
    false

Class HIArcdiagram

Constructor Summary

Method Summary

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

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIArcdiagram

Method Detail

getBorderColor

getBorderWidth

getCenteredLinks

getColorByPoint

getColors

getEqualNodes

getLevels

getLinkColorMode

getLinkOpacity

getLinkRadius

getLinkWeight

getMinLinkWidth

getNodeDistance

getNodes

getNodeWidth

getOffset

getParams

getReversed

setBorderColor

setBorderWidth

setCenteredLinks

setColorByPoint

setColors

setEqualNodes

setLevels

setLinkColorMode

setLinkOpacity

setLinkRadius

setLinkWeight

setMinLinkWidth

setNodeDistance

setNodes

setNodeWidth

setOffset

setReversed