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

Class PlotOptionsBoxplot

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.AbstractPlotOptions
com.vaadin.flow.component.charts.model.PlotOptionsBoxplot
All Implemented Interfaces:
Serializable
public class PlotOptionsBoxplot extends AbstractPlotOptions
A box plot is a convenient way of depicting groups of data through their five-number summaries: the smallest observation (sample minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and largest observation (sample maximum).
See Also:

  • Constructor Details

    • PlotOptionsBoxplot

      public PlotOptionsBoxplot()

  • Method Details

    • getChartType

      public ChartType getChartType()
      Overrides:
      getChartType in class AbstractPlotOptions

    • getAllowPointSelect

      public Boolean getAllowPointSelect()
      See Also:

    • 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

    • getAnimationLimit

      public Number getAnimationLimit()
      See Also:

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

    • getClassName

      public String getClassName()
      See Also:

    • setClassName

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

    • getClip

      public Boolean getClip()
      See Also:

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

    • getColor

      public Color getColor()
      See Also:

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

    • getColorByPoint

      public Boolean getColorByPoint()
      See Also:

    • 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

    • getColorIndex

      public Number getColorIndex()
      See Also:

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

    • getColorKey

      public String getColorKey()
      See Also:

    • 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 max if some custom point property is used or if approximation for data grouping is set to 'sum'.

      Defaults to high.

    • getColors

      public Color[] getColors()
      See Also:

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

    • removeColor

      public void removeColor(Color color)
      Removes first occurrence of color in colors array
      Parameters:
      color - to remove
      See Also:

    • getCrisp

      public Boolean getCrisp()
      See Also:

    • 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

    • getCursor

      public Cursor getCursor()
      See Also:

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

    • getDepth

      public Number getDepth()
      See Also:

    • setDepth

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

      Defaults to: 25

    • getDescription

      public String getDescription()
      See Also:

    • 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

    • getEdgeColor

      public Color getEdgeColor()
      See Also:

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

    • getEdgeWidth

      public Number getEdgeWidth()
      See Also:

    • setEdgeWidth

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

      Defaults to: 1

    • getEnableMouseTracking

      public Boolean getEnableMouseTracking()
      See Also:

    • 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

    • getExposeElementToA11y

      public Boolean getExposeElementToA11y()
      See Also:

    • 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

    • getFillColor

      public Color getFillColor()
      See Also:

    • setFillColor

      public void setFillColor(Color fillColor)
      The fill color of the box.

      Defaults to: #ffffff

    • getFindNearestPointBy

      public Dimension getFindNearestPointBy()
      See Also:

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

    • getGetExtremesFromAll

      public Boolean getGetExtremesFromAll()
      See Also:

    • 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

    • getGroupPadding

      public Number getGroupPadding()
      See Also:

    • setGroupPadding

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

      Defaults to: 0.2

    • getGroupZPadding

      public Number getGroupZPadding()
      See Also:

    • 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

    • getGrouping

      public Boolean getGrouping()
      See Also:

    • 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

    • getKeys

      public String[] getKeys()
      See Also:

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

    • addKey

      public void addKey(String key)
      Adds key to the keys array
      Parameters:
      key - to add
      See Also:

    • removeKey

      public void removeKey(String key)
      Removes first occurrence of key in keys array
      Parameters:
      key - to remove
      See Also:

    • getLineWidth

      public Number getLineWidth()
      See Also:

    • setLineWidth

      public void setLineWidth(Number lineWidth)
      The width of the line surrounding the box. If any of stemWidth, medianWidth or whiskerWidth are null, the lineWidth also applies to these lines.

      Defaults to: 1

    • getLinkedTo

      public String getLinkedTo()
      See Also:

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

    • getMaxPointWidth

      public Number getMaxPointWidth()
      See Also:

    • 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

    • getMedianColor

      public Color getMedianColor()
      See Also:

    • setMedianColor

      public void setMedianColor(Color medianColor)
      The color of the median line. If null, the general series color applies.

      Defaults to: null

    • getMedianWidth

      public Number getMedianWidth()
      See Also:

    • setMedianWidth

      public void setMedianWidth(Number medianWidth)
      The pixel width of the median line. If null, the lineWidth is used.

      Defaults to: 2

    • getNegativeColor

      public Color getNegativeColor()
      See Also:

    • setNegativeColor

      public void setNegativeColor(Color negativeColor)
      The color for the parts of the graph or points that are below the threshold.

      Defaults to: null

    • getOpacity

      public Number getOpacity()
      See Also:

    • setOpacity

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

      Defaults to 1.

    • getPointDescriptionFormatter

      public String getPointDescriptionFormatter()

    • setPointDescriptionFormatter

      public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

    • getPointInterval

      public Number getPointInterval()
      See Also:

    • 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

    • getPointIntervalUnit

      public IntervalUnit getPointIntervalUnit()
      See Also:

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

    • getPointPadding

      public Number getPointPadding()
      See Also:

    • setPointPadding

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

      Defaults to: 0.1

    • getPointPlacement

      public PointPlacement getPointPlacement()
      See Also:

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

    • getPointRange

      public Number getPointRange()
      See Also:

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

    • getPointStart

      public Number getPointStart()
      See Also:

    • 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

    • getPointWidth

      public Number getPointWidth()
      See Also:

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

    • getSelected

      public Boolean getSelected()
      See Also:

    • 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

    • getShowCheckbox

      public Boolean getShowCheckbox()
      See Also:

    • 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

    • getShowInLegend

      public Boolean getShowInLegend()
      See Also:

    • 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

    • getSkipKeyboardNavigation

      public Boolean getSkipKeyboardNavigation()
      See Also:

    • 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

      public void setStates(States states)
      A wrapper object for all the series options in specific states.

    • getStemColor

      public Color getStemColor()
      See Also:

    • setStemColor

      public void setStemColor(Color stemColor)
      The color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.

      Defaults to: null

    • getStemDashStyle

      public DashStyle getStemDashStyle()
      See Also:

    • setStemDashStyle

      public void setStemDashStyle(DashStyle stemDashStyle)
      The dash style of the stem, the vertical line extending from the box to the whiskers.

      Defaults to: Solid

    • getStemWidth

      public Number getStemWidth()
      See Also:

    • setStemWidth

      public void setStemWidth(Number stemWidth)
      The width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the lineWidth option.

      Defaults to: null

    • getStickyTracking

      public Boolean getStickyTracking()
      See Also:

    • 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

    • getTooltip

      public SeriesTooltip getTooltip()
      See Also:

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

    • getTurboThreshold

      public Number getTurboThreshold()
      See Also:

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

      Defaults to: 1000

    • getVisible

      public Boolean getVisible()
      See Also:

    • setVisible

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

      Defaults to: true

    • getWhiskerColor

      public Color getWhiskerColor()
      See Also:

    • setWhiskerColor

      public void setWhiskerColor(Color whiskerColor)
      The color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.

      Defaults to: null

    • getWhiskerLength

      public String getWhiskerLength()
      See Also:

    • setWhiskerLength

      public void setWhiskerLength(String whiskerLength)
      The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.

      Defaults to: 50%

    • getWhiskerWidth

      public Number getWhiskerWidth()
      See Also:

    • setWhiskerWidth

      public void setWhiskerWidth(Number whiskerWidth)
      The line width of the whiskers, the horizontal lines marking low and high values. When null, the general lineWidth applies.

      Defaults to: 2

    • getZoneAxis

      public ZoneAxis getZoneAxis()
      See Also:

    • setZoneAxis

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

      Defaults to: y

    • getZones

      public Zones[] getZones()
      See Also:

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

    • addZone

      public void addZone(Zones zone)
      Adds zone to the zones array
      Parameters:
      zone - to add
      See Also:

    • removeZone

      public void removeZone(Zones zone)
      Removes first occurrence of zone in zones array
      Parameters:
      zone - to remove
      See Also:

    • setPointStart

      public void setPointStart(Instant instant)
      See Also: