Package com.vaadin.flow.component.charts.model

Class PlotOptionsWaterfall

    • Constructor Detail

      • PlotOptionsWaterfall

        public PlotOptionsWaterfall()

    • Method Detail

      • setAllowPointSelect

        public void setAllowPointSelect​(Boolean allowPointSelect)
        Allow this series' points to be selected by clicking on the markers, bars or pie slices.

        Defaults to: false

        Specified by:
        setAllowPointSelect in class ColumnOptions

      • setAnimation

        public void setAnimation​(Boolean animation)
        Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, see ChartModel.setAnimation(Boolean)
        Specified by:
        setAnimation in class ColumnOptions

      • setAnimationLimit

        public void setAnimationLimit​(Number animationLimit)
        For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.

      • setBorderColor

        public void setBorderColor​(Color borderColor)

        The color of the border of each waterfall column.

        In styled mode, the border stroke can be set with the .highcharts-point class.

        Defaults to: #333333

        Specified by:
        setBorderColor in class ColumnOptions

      • setBorderRadius

        public void setBorderRadius​(Number borderRadius)
        The corner radius of the border surrounding each column or bar.

        Defaults to: 0

        Specified by:
        setBorderRadius in class ColumnOptions

      • setBorderWidth

        public void setBorderWidth​(Number borderWidth)

        The width of the border surrounding each column or bar.

        In styled mode, the stroke width can be set with the .highcharts-point rule.

        Defaults to: 1

        Specified by:
        setBorderWidth in class ColumnOptions

      • setClip

        public void setClip​(Boolean clip)
        Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is set.

        Defaults to true.

        Specified by:
        setClip in class ColumnOptions

      • setClassName

        public void setClassName​(String className)
        A class name to apply to the series' graphical elements.

      • setColor

        public void setColor​(Color color)

        The main color or 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.

      • setColorByPoint

        public void setColorByPoint​(Boolean colorByPoint)
        When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.

        Defaults to: false

        Specified by:
        setColorByPoint in class ColumnOptions

      • setColorKey

        public void setColorKey​(String colorKey)
        Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and amx if some custom point property is used or if approximation for data grouping is set to 'sum'.

        Defaults to y.

        Specified by:
        setColorKey in class ColumnOptions

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

      • setCrisp

        public void setCrisp​(Boolean crisp)
        When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.

        Defaults to: true

        Specified by:
        setCrisp in class ColumnOptions

      • setCursor

        public void setCursor​(Cursor 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.
        Specified by:
        setCursor in class ColumnOptions

      • setDashStyle

        public void setDashStyle​(DashStyle dashStyle)

        A name for the dash style to use for the line connecting the columns of the waterfall series. Possible values:

        • Solid
        • ShortDash
        • ShortDot
        • ShortDashDot
        • ShortDashDotDot
        • Dot
        • Dash
        • LongDash
        • DashDot
        • LongDashDot
        • LongDashDotDot

        In styled mode, the stroke dash-array can be set with the .highcharts-graph class.

        Defaults to: Dot

      • setDataLabels

        public void setDataLabels​(DataLabels dataLabels)

        Options for the series data labels, appearing next to each data point.

        In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).

      • setDepth

        public void setDepth​(Number depth)
        Depth of the columns in a 3D column chart. Requires highcharts-3d.js.

        Defaults to: 25

        Specified by:
        setDepth in class ColumnOptions

      • setDescription

        public void setDescription​(String description)

        Requires Accessibility module

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

        Defaults to: undefined

      • setEdgeColor

        public void setEdgeColor​(Color edgeColor)
        3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
        Specified by:
        setEdgeColor in class ColumnOptions

      • setEdgeWidth

        public void setEdgeWidth​(Number edgeWidth)
        3D columns only. The width of the colored edges.

        Defaults to: 1

        Specified by:
        setEdgeWidth in class ColumnOptions

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

        Defaults to: true

        Specified by:
        setEnableMouseTracking in class ColumnOptions

      • setExposeElementToA11y

        public void setExposeElementToA11y​(Boolean exposeElementToA11y)

        By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.

        Requires the Accessibility module.

        Defaults to: undefined

      • setFindNearestPointBy

        public void setFindNearestPointBy​(Dimension findNearestPointBy)

        Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.

        Applies only to series types using nearest neighbor search (not direct hover) for tooltip.

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

        Defaults to: false

        Specified by:
        setGetExtremesFromAll in class ColumnOptions

      • setGroupPadding

        public void setGroupPadding​(Number groupPadding)
        Padding between each value groups, in x axis units.

        Defaults to: 0.2

        Specified by:
        setGroupPadding in class ColumnOptions

      • setGroupZPadding

        public void setGroupZPadding​(Number groupZPadding)
        The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.

        Defaults to: 1

        Specified by:
        setGroupZPadding in class ColumnOptions

      • setGrouping

        public void setGrouping​(Boolean grouping)
        Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.

        Defaults to: true

        Specified by:
        setGrouping in class ColumnOptions

      • setKeys

        public void setKeys​(String... keys)
        An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
        Specified by:
        setKeys in class ColumnOptions

      • setLineColor

        public void setLineColor​(Color lineColor)

        The color of the line that connects columns in a waterfall series.

        In styled mode, the stroke can be set with the .highcharts-graph class.

        Defaults to: #333333

      • setLineWidth

        public void setLineWidth​(Number lineWidth)
        The width of the line connecting waterfall columns.

        Defaults to: 1

      • 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.
        Specified by:
        setLinkedTo in class ColumnOptions

      • setOpacity

        public void setOpacity​(Number opacity)
        Opacity of a series parts: line, fill (e.g. area) and dataLabels.

        Defaults to 1.

        Specified by:
        setOpacity in class ColumnOptions

      • setMaxPointWidth

        public void setMaxPointWidth​(Number maxPointWidth)
        The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.

        Defaults to: null

        Specified by:
        setMaxPointWidth in class ColumnOptions

      • setMinPointLength

        public void setMinPointLength​(Number minPointLength)
        The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.

        Defaults to: 0

        Specified by:
        setMinPointLength in class ColumnOptions

      • getPointDescriptionFormatter

        public String getPointDescriptionFormatter()

      • setPointDescriptionFormatter

        public void setPointDescriptionFormatter​(String _fn_pointDescriptionFormatter)

      • setPointInterval

        public void setPointInterval​(Number pointInterval)

        If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.

        Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.

        Defaults to: 1

        Specified by:
        setPointInterval in class ColumnOptions

      • setPointIntervalUnit

        public void setPointIntervalUnit​(IntervalUnit pointIntervalUnit)
        On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
        Specified by:
        setPointIntervalUnit in class ColumnOptions

      • setPointPadding

        public void setPointPadding​(Number pointPadding)
        Padding between each column or bar, in x axis units.

        Defaults to: 0.1

        Specified by:
        setPointPadding in class ColumnOptions

      • setPointPlacement

        public void setPointPlacement​(PointPlacement pointPlacement)

        Possible values: null, "on", "between".

        In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.

        Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.

        Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.

        Defaults to null in cartesian charts, "between" in polar charts.

        Specified by:
        setPointPlacement in class ColumnOptions

      • setPointRange

        public void setPointRange​(Number pointRange)
        The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
        Specified by:
        setPointRange in class ColumnOptions

      • setPointStart

        public void setPointStart​(Number pointStart)
        If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.

        Defaults to: 0

        Specified by:
        setPointStart in class ColumnOptions

      • setPointWidth

        public void setPointWidth​(Number pointWidth)
        A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
        Specified by:
        setPointWidth in class ColumnOptions

      • setSelected

        public void setSelected​(Boolean selected)
        Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

        Defaults to: false

        Specified by:
        setSelected in class ColumnOptions

      • setShadow

        public void setShadow​(Boolean shadow)
        Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

        Defaults to: false

        Specified by:
        setShadow in class ColumnOptions

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

        Defaults to: false

        Specified by:
        setShowCheckbox in class ColumnOptions

      • setShowInLegend

        public void setShowInLegend​(Boolean showInLegend)
        Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.

        Defaults to: true

        Specified by:
        setShowInLegend in class ColumnOptions

      • setSkipKeyboardNavigation

        public void setSkipKeyboardNavigation​(Boolean skipKeyboardNavigation)
        If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

      • setSoftThreshold

        public void setSoftThreshold​(Boolean softThreshold)

        When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.

        For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.

        Defaults to: true

      • setStates

        public void setStates​(States states)
        A wrapper object for all the series options in specific states.
        Specified by:
        setStates in class ColumnOptions

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

        Defaults to: true

        Specified by:
        setStickyTracking in class ColumnOptions

      • setThreshold

        public void setThreshold​(Number threshold)
        The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If null, the columns extend from the padding Y axis minimum.

        Defaults to: 0

      • setTooltip

        public void setTooltip​(SeriesTooltip 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.
        Specified by:
        setTooltip in class ColumnOptions

      • setUpColor

        public void setUpColor​(Color upColor)

        The color used specifically for positive point columns. When not specified, the general series color is used.

        In styled mode, the waterfall colors can be set with the .highcharts-point-negative, .highcharts-sum and .highcharts-intermediate-sum classes.

      • setVisible

        public void setVisible​(Boolean visible)
        Set the initial visibility of the series.

        Defaults to: true

        Specified by:
        setVisible in class ColumnOptions

      • setZoneAxis

        public void setZoneAxis​(ZoneAxis zoneAxis)
        Defines the Axis on which the zones are applied.

        Defaults to: y

        Specified by:
        setZoneAxis in class ColumnOptions

      • setZones

        public void setZones​(Zones... zones)

        An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option.

        In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

        Specified by:
        setZones in class ColumnOptions