PlotOptionsOrganization (Vaadin Platform (vaadin-platform-javadoc) 22.0.26 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.AbstractPlotOptions
  - - com.vaadin.flow.component.charts.model.PlotOptionsOrganization

All Implemented Interfaces:

Serializable
```
public class PlotOptionsOrganization
extends AbstractPlotOptions
```
Plot options for ChartType.ORGANIZATION charts.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PlotOptionsOrganization()

Constructors
Constructor and Description
`PlotOptionsOrganization()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColor(Color color)` Adds color to the colors array
`void`	`addLevel(Level level)` Adds level to the levels array
`String`	`getBoostBlending()`
`Color`	`getBorderColor()`
`Number`	`getBorderRadius()`
`Number`	`getBorderWidth()`
`Boolean`	`getCenterInCategory()`
`ChartType`	`getChartType()`
`String`	`getClassName()`
`Boolean`	`getClip()`
`Color`	`getColor()`
`Boolean`	`getColorByPoint()`
`Number`	`getColorIndex()`
`Color[]`	`getColors()`
`String`	`getCursor()`
`DashStyle`	`getDashStyle()`
`DataLabels`	`getDataLabels()`
`String`	`getDescription()`
`Boolean`	`getEnableMouseTracking()`
`Boolean`	`getGetExtremesFromAll()`
`Number`	`getHangingIndent()`
`Label`	`getLabel()`
`Level[]`	`getLevels()`
`Color`	`getLinkColor()`
`String`	`getLinkedTo()`
`Number`	`getLinkLineWidth()`
`Number`	`getLinkOpacity()`
`Number`	`getLinkRadius()`
`Number`	`getMinLinkWidth()`
`Number`	`getNodePadding()`
`Number`	`getNodeWidth()`
`Number`	`getOpacity()`
`Boolean`	`getSelected()`
`Boolean`	`getShowCheckbox()`
`Boolean`	`getShowInLegend()`
`Boolean`	`getSkipKeyboardNavigation()`
`States`	`getStates()`
`Boolean`	`getStickyTracking()`
`Tooltip`	`getTooltip()`
`Number`	`getTurboThreshold()`
`Boolean`	`getVisible()`
`void`	`removeColor(Color color)` Removes first occurrence of color in colors array
`void`	`removeLevel(Level level)` Removes first occurrence of level in levels array
`void`	`setBoostBlending(String boostBlending)` Sets the color blending in the boost module.
`void`	`setBorderColor(Color borderColor)` The border color of the node cards.
`void`	`setBorderRadius(Number borderRadius)` The border radius of the node cards.
`void`	`setBorderWidth(Number borderWidth)` The width of the border surrounding each column or bar.
`void`	`setCenterInCategory(Boolean centerInCategory)` When `true`, the columns will center in the category, ignoring null or missing points.
`void`	`setClassName(String className)` An additional class name to apply to the series' graphical elements.
`void`	`setClip(Boolean clip)` Disable this option to allow series rendering in the whole plotting area.
`void`	`setColor(Color color)` The main color of the series.
`void`	`setColorByPoint(Boolean colorByPoint)`
`void`	`setColorIndex(Number colorIndex)` Styled mode only.
`void`	`setColors(Color... colors)` A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
`void`	`setCursor(String cursor)` You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`void`	`setDashStyle(DashStyle dashStyle)` Name of the dash style to use for the graph, or for some series types the outline of each shape.
`void`	`setDataLabels(DataLabels dataLabels)` Options for the data labels appearing on top of the nodes and links.
`void`	`setDescription(String description)` A description of the series to add to the screen reader information about the series.
`void`	`setEnableMouseTracking(Boolean enableMouseTracking)` Enable or disable the mouse tracking for a specific series.
`void`	`setGetExtremesFromAll(Boolean getExtremesFromAll)` Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.
`void`	`setHangingIndent(Number hangingIndent)` The indentation in pixels of hanging nodes, nodes which parent has layout set to `hanging`.
`void`	`setLabel(Label label)` Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series.
`void`	`setLevels(Level... levels)` Set options on specific levels.
`void`	`setLinkColor(Color linkColor)` The color of the links between nodes.
`void`	`setLinkedTo(String linkedTo)` The id of another series to link to.
`void`	`setLinkLineWidth(Number linkLineWidth)` The line width of the links connecting nodes, in pixels.
`void`	`setLinkOpacity(Number linkOpacity)` Opacity for the links between nodes in the sankey diagram.
`void`	`setLinkRadius(Number linkRadius)` Radius for the rounded corners of the links between nodes.
`void`	`setMinLinkWidth(Number minLinkWidth)` The minimal width for a line of a sankey.
`void`	`setNodePadding(Number nodePadding)` The padding between nodes in a sankey diagram or dependency wheel, in pixels.
`void`	`setNodeWidth(Number nodeWidth)` In a horizontal chart, the width of the nodes in pixels.
`void`	`setOpacity(Number opacity)` Opacity of a series parts: line, fill (e.g.
`void`	`setSelected(Boolean selected)` Whether to select the series initially.
`void`	`setShowCheckbox(Boolean showCheckbox)` If true, a checkbox is displayed next to the legend item to allow selecting the series.
`void`	`setShowInLegend(Boolean showInLegend)` Whether to display this particular series or series type in the legend.
`void`	`setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)` If set to `true`, the accessibility module will skip past the points in this series for keyboard navigation.
`void`	`setStates(States states)`
`void`	`setStickyTracking(Boolean stickyTracking)` Sticky tracking of mouse events.
`void`	`setTooltip(Tooltip tooltip)` A configuration object for the tooltip rendering of each single series.
`void`	`setTurboThreshold(Number turboThreshold)` When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
`void`	`setVisible(Boolean visible)` Set the initial visibility of the series.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PlotOptionsOrganization
```
public PlotOptionsOrganization()
```
- Method Detail
  - getBoostBlending
```
public String getBoostBlending()
```
    See Also:
    
    setBoostBlending(String)
  - setBoostBlending
```
public void setBoostBlending(String boostBlending)
```
    Sets the color blending in the boost module.
  - getBorderRadius
```
public Number getBorderRadius()
```
    See Also:
    
    setBorderRadius(Number)
  - setBorderRadius
```
public void setBorderRadius(Number borderRadius)
```
    The border radius of the node cards.
  - getBorderWidth
```
public Number getBorderWidth()
```
    See Also:
    
    setBorderWidth(Number)
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    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.
  - getCenterInCategory
```
public Boolean getCenterInCategory()
```
    See Also:
    
    setCenterInCategory(Boolean)
  - setCenterInCategory
```
public void setCenterInCategory(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.
  - getClassName
```
public String getClassName()
```
    See Also:
    
    setClassName(String)
  - setClassName
```
public void setClassName(String className)
```
    An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.
  - getClip
```
public Boolean getClip()
```
    See Also:
    
    setClip(Boolean)
  - setClip
```
public void setClip(Boolean clip)
```
    Disable this option to allow series rendering in the whole plotting area.
    
    Note: Clipping should be always enabled when chart.zoomType is set
  - getColorIndex
```
public Number getColorIndex()
```
    See Also:
    
    setColorIndex(Number)
  - setColorIndex
```
public void setColorIndex(Number colorIndex)
```
    Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
  - getColors
```
public Color[] getColors()
```
    See Also:
    
    setColors(Color...)
  - setColors
```
public void setColors(Color... colors)
```
    A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
  - addColor
```
public void addColor(Color color)
```
    Adds color to the colors array
    
    Parameters:
    
    color - to add
    
    See Also:
    
    setColors(Color...)
  - removeColor
```
public void removeColor(Color color)
```
    Removes first occurrence of color in colors array
    
    Parameters:
    
    color - to remove
    
    See Also:
    
    setColors(Color...)
  - getCursor
```
public String getCursor()
```
    See Also:
    
    setCursor(String)
  - setCursor
```
public void setCursor(String cursor)
```
    You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
    
    In styled mode, the series cursor can be set with the same classes * as listed under series.color.
  - getDashStyle
```
public DashStyle getDashStyle()
```
    See Also:
    
    setDashStyle(DashStyle)
  - setDashStyle
```
public void setDashStyle(DashStyle dashStyle)
```
    Name of the dash style to use for the graph, or for some series types the outline of each shape.
    
    In styled mode, the stroke dash-array can be set with the same classes as listed under series.color.
  - getDescription
```
public String getDescription()
```
    See Also:
    
    setDescription(String)
  - setDescription
```
public void setDescription(String description)
```
    A description of the series to add to the screen reader information about the series.
  - getEnableMouseTracking
```
public Boolean getEnableMouseTracking()
```
    See Also:
    
    setEnableMouseTracking(Boolean)
  - setEnableMouseTracking
```
public void setEnableMouseTracking(Boolean enableMouseTracking)
```
    Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
  - getGetExtremesFromAll
```
public Boolean getGetExtremesFromAll()
```
    See Also:
    
    setGetExtremesFromAll(Boolean)
  - setGetExtremesFromAll
```
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
```
    Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
  - getHangingIndent
```
public Number getHangingIndent()
```
    See Also:
    
    setHangingIndent(Number)
  - setHangingIndent
```
public void setHangingIndent(Number hangingIndent)
```
    The indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.
  - getLabel
```
public Label getLabel()
```
    See Also:
    
    setLabel(Label)
  - setLabel
```
public void setLabel(Label label)
```
    Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
    
    The series labels currently work with series types having a graph or an area.
  - getLevels
```
public Level[] getLevels()
```
    See Also:
    
    setLevels(Level...)
  - setLevels
```
public void setLevels(Level... levels)
```
    Set options on specific levels. Takes precedence over series options, but not point options.
  - addLevel
```
public void addLevel(Level level)
```
    Adds level to the levels array
    
    Parameters:
    
    level - to add
    
    See Also:
    
    setLevels(Level...)
  - removeLevel
```
public void removeLevel(Level level)
```
    Removes first occurrence of level in levels array
    
    Parameters:
    
    level - to remove
    
    See Also:
    
    setLevels(Level...)
  - getLinkColor
```
public Color getLinkColor()
```
    See Also:
    
    setLinkColor(Color)
  - setLinkColor
```
public void setLinkColor(Color linkColor)
```
    The color of the links between nodes.
  - getLinkedTo
```
public String getLinkedTo()
```
    See Also:
    
    setLinkedTo(String)
  - setLinkedTo
```
public void setLinkedTo(String linkedTo)
```
    The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
    
    If master series uses data sorting and linked series does not have its own sorting definition, the linked series will be sorted in the same order as the master one.
  - getLinkLineWidth
```
public Number getLinkLineWidth()
```
    See Also:
    
    setLinkLineWidth(Number)
  - setLinkLineWidth
```
public void setLinkLineWidth(Number linkLineWidth)
```
    The line width of the links connecting nodes, in pixels.
  - getLinkOpacity
```
public Number getLinkOpacity()
```
    See Also:
    
    setLinkOpacity(Number)
  - setLinkOpacity
```
public void setLinkOpacity(Number linkOpacity)
```
    Opacity for the links between nodes in the sankey diagram.
  - getLinkRadius
```
public Number getLinkRadius()
```
    See Also:
    
    setLinkRadius(Number)
  - setLinkRadius
```
public void setLinkRadius(Number linkRadius)
```
    Radius for the rounded corners of the links between nodes.
  - getMinLinkWidth
```
public Number getMinLinkWidth()
```
    See Also:
    
    setMinLinkWidth(Number)
  - setMinLinkWidth
```
public void setMinLinkWidth(Number minLinkWidth)
```
    The minimal width for a line of a sankey. By default, 0 values are not shown.
  - getNodePadding
```
public Number getNodePadding()
```
    See Also:
    
    setNodePadding(Number)
  - setNodePadding
```
public void setNodePadding(Number nodePadding)
```
    The padding between nodes in a sankey diagram or dependency wheel, in pixels.
    
    If the number of nodes is so great that it is possible 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.
  - getOpacity
```
public Number getOpacity()
```
    See Also:
    
    setOpacity(Number)
  - setOpacity
```
public void setOpacity(Number opacity)
```
    Opacity of a series parts: line, fill (e.g. area) and dataLabels.
  - getSelected
```
public Boolean getSelected()
```
    See Also:
    
    setSelected(Boolean)
  - setSelected
```
public void setSelected(Boolean selected)
```
    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
  - getShowCheckbox
```
public Boolean getShowCheckbox()
```
    See Also:
    
    setShowCheckbox(Boolean)
  - setShowCheckbox
```
public void setShowCheckbox(Boolean showCheckbox)
```
    If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
  - getShowInLegend
```
public Boolean getShowInLegend()
```
    See Also:
    
    setShowInLegend(Boolean)
  - setShowInLegend
```
public void setShowInLegend(Boolean showInLegend)
```
    Whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. Since v7.2.0 it is possible to show series that use colorAxis by setting this option to true.
  - getSkipKeyboardNavigation
```
public Boolean getSkipKeyboardNavigation()
```
    See Also:
    
    setSkipKeyboardNavigation(Boolean)
  - setSkipKeyboardNavigation
```
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
```
    If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
  - getStates
```
public States getStates()
```
    See Also:
    
    setStates(States)
  - setStates
```
public void setStates(States states)
```
    See Also:
    
    States
  - getStickyTracking
```
public Boolean getStickyTracking()
```
    See Also:
    
    setStickyTracking(Boolean)
  - setStickyTracking
```
public void setStickyTracking(Boolean stickyTracking)
```
    Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip when not shared. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
    
    Note: The boost module will force this option because of technical limitations.
  - getTooltip
```
public Tooltip getTooltip()
```
    See Also:
    
    setTooltip(Tooltip)
  - setTooltip
```
public void setTooltip(Tooltip tooltip)
```
    A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
  - getTurboThreshold
```
public Number getTurboThreshold()
```
    See Also:
    
    setTurboThreshold(Number)
  - setTurboThreshold
```
public void setTurboThreshold(Number turboThreshold)
```
    When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.
    
    Note: In boost mode turbo threshold is forced. Only array of numbers or two dimensional arrays are allowed.
  - getVisible
```
public Boolean getVisible()
```
    See Also:
    
    setVisible(Boolean)
  - setVisible
```
public void setVisible(Boolean visible)
```
    Set the initial visibility of the series.
  - getColorByPoint
```
public Boolean getColorByPoint()
```
    See Also:
    
    setColorByPoint(Boolean)
  - setColorByPoint
```
public void setColorByPoint(Boolean colorByPoint)
```
  - getColor
```
public Color getColor()
```
    See Also:
    
    setColor(Color)
  - setColor
```
public void setColor(Color color)
```
    The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
    
    In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.
  - getDataLabels
```
public DataLabels getDataLabels()
```
    See Also:
    
    setDataLabels(DataLabels)
  - setDataLabels
```
public void setDataLabels(DataLabels dataLabels)
```
    Options for the data labels appearing on top of the nodes and links. For sankey charts, data labels are visible for the nodes by default, but hidden for links. This is controlled by modifying the nodeFormat, and the format that applies to links and is an empty string by default.
  - getBorderColor
```
public Color getBorderColor()
```
    See Also:
    
    setBorderColor(Color)
  - setBorderColor
```
public void setBorderColor(Color borderColor)
```
    The border color of the node cards. Defaults to #666666.
  - getNodeWidth
```
public Number getNodeWidth()
```
    See Also:
    
    setNodeWidth(Number)
  - setNodeWidth
```
public void setNodeWidth(Number nodeWidth)
```
    In a horizontal chart, the width of the nodes in pixels. Node that most organization charts are vertical, so the name of this option is counterintuitive. Defaults to 50.
  - getChartType
```
public ChartType getChartType()
```
    Overrides:
    
    getChartType in class AbstractPlotOptions

Class PlotOptionsOrganization

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlotOptionsOrganization

Method Detail

getBoostBlending

setBoostBlending

getBorderRadius

setBorderRadius

getBorderWidth

setBorderWidth

getCenterInCategory

setCenterInCategory

getClassName

setClassName

getClip

setClip

getColorIndex

setColorIndex

getColors

setColors

addColor

removeColor

getCursor

setCursor

getDashStyle

setDashStyle

getDescription

setDescription

getEnableMouseTracking

setEnableMouseTracking

getGetExtremesFromAll

setGetExtremesFromAll

getHangingIndent

setHangingIndent

getLabel

setLabel

getLevels

setLevels

addLevel

removeLevel

getLinkColor

setLinkColor

getLinkedTo

setLinkedTo

getLinkLineWidth

setLinkLineWidth

getLinkOpacity

setLinkOpacity

getLinkRadius

setLinkRadius

getMinLinkWidth

setMinLinkWidth

getNodePadding

setNodePadding

getOpacity

setOpacity

getSelected

setSelected

getShowCheckbox

setShowCheckbox

getShowInLegend

setShowInLegend

getSkipKeyboardNavigation

setSkipKeyboardNavigation

getStates

setStates

getStickyTracking

setStickyTracking

getTooltip

setTooltip

getTurboThreshold

setTurboThreshold

getVisible

setVisible

getColorByPoint

setColorByPoint

getColor