Contact us
Create app
You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.
com.vaadin.flow.component.charts.model.

Class PlotOptionsOrganization

    • Constructor Detail

      • PlotOptionsOrganization

        public PlotOptionsOrganization()

    • Method Detail

      • setBoostBlending

        public void setBoostBlending​(String boostBlending)

        Sets the color blending in the boost module.

      • setBorderRadius

        public void setBorderRadius​(Number borderRadius)

        The border radius of the node cards.

      • 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.

      • 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.

      • 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.

      • 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

      • 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}.

      • 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...)

      • 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.

      • 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.

      • setDescription

        public void setDescription​(String description)

        A description of the series to add to the screen reader information about the series.

      • 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.

      • 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.

      • setHangingIndent

        public void setHangingIndent​(Number hangingIndent)

        The indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.

      • 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.

      • 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...)

      • setLinkColor

        public void setLinkColor​(Color linkColor)

        The color of the links between nodes.

      • 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.

      • setLinkLineWidth

        public void setLinkLineWidth​(Number linkLineWidth)

        The line width of the links connecting nodes, in pixels.

      • setLinkOpacity

        public void setLinkOpacity​(Number linkOpacity)

        Opacity for the links between nodes in the sankey diagram.

      • setLinkRadius

        public void setLinkRadius​(Number linkRadius)

        Radius for the rounded corners of the links between nodes.

      • setMinLinkWidth

        public void setMinLinkWidth​(Number minLinkWidth)

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

      • 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.

      • setOpacity

        public void setOpacity​(Number opacity)

        Opacity of a series parts: line, fill (e.g. area) and dataLabels.

      • 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.

      • 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.

      • 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.

      • setSkipKeyboardNavigation

        public void setSkipKeyboardNavigation​(Boolean skipKeyboardNavigation)

        If set to true, the accessibility module will skip past the points in this series for keyboard navigation.

      • setStates

        public void setStates​(States states)

        See Also:

        States

      • 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.

      • 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.

      • 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.

      • setVisible

        public void setVisible​(Boolean visible)

        Set the initial visibility of the series.

      • setColorByPoint

        public void setColorByPoint​(Boolean colorByPoint)

      • 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.

      • 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.

      • setBorderColor

        public void setBorderColor​(Color borderColor)

        The border color of the node cards. Defaults to #666666.

      • 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.