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

Class PlotOptionsBubble

  • All Implemented Interfaces:
    Serializable
    public class PlotOptionsBubble
extends AbstractPlotOptions
    A bubble series is a three dimensional series type where each point renders an X, Y and Z value. Each points is drawn as a bubble where the position along the X and Y axes mark the X and Y values, and the size of the bubble relates to the Z value. Requires highcharts-more.js.
    See Also:
    Serialized Form

    • Constructor Detail

      • PlotOptionsBubble

        public PlotOptionsBubble()

    • 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

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

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

      • setClassName

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

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

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

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

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

      • setCrisp

        public void setCrisp​(Boolean crisp)
        When true, each point or 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.

      • setCropThreshold

        public void setCropThreshold​(Number cropThreshold)
        When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.

        Defaults to: 300

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

      • setDashStyle

        public void setDashStyle​(DashStyle dashStyle)
        A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
        • Solid
        • ShortDash
        • ShortDot
        • ShortDashDot
        • ShortDashDotDot
        • Dot
        • Dash
        • LongDash
        • DashDot
        • LongDashDot
        • LongDashDotDot

        Defaults to: Solid

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

      • 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

      • setDisplayNegative

        public void setDisplayNegative​(Boolean displayNegative)
        Whether to display negative sized bubbles. The threshold is given by the zThreshold option, and negative bubbles can be visualized by setting negativeColor.

        Defaults to: true

      • 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

      • 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

      • 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:
        setKeys(String...)

      • removeKey

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

      • setLineWidth

        public void setLineWidth​(Number lineWidth)
        The width of the line connecting the data points.

        Defaults to: 0

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

      • setMarker

        public void setMarker​(Marker marker)

        Options for the point markers of line-like series. Properties like fillColor, lineColor and lineWidth define the visual appearance of the markers. Other series types, like column series, don't have markers, but have visual options on the series level instead.

        In styled mode, the markers can be styled with the .highcharts-point, .highcharts-point-hover and .highcharts-point-select class names.

      • setMaxSize

        public void setMaxSize​(String maxSize)
        Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.

        Defaults to: 20%

      • setMinSize

        public void setMinSize​(String minSize)
        Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.

        Defaults to: 8

      • setNegativeColor

        public void setNegativeColor​(Color negativeColor)
        When a point's Z value is below the zThreshold setting, this color is used.

        Defaults to: null

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

      • 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

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

      • 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

      • 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

      • 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

      • 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

      • 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

      • setSizeBy

        public void setSizeBy​(String sizeBy)
        Whether the bubble's value should be represented by the area or the width of the bubble. The default, area, corresponds best to the human perception of the size of each bubble.

        Defaults to: area

      • setSizeByAbsoluteValue

        public void setSizeByAbsoluteValue​(Boolean sizeByAbsoluteValue)
        When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.

        Defaults to: false

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

      • setStates

        public void setStates​(States states)
        A wrapper object for all the series options in specific 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 stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.

        Defaults to: false

      • setThreshold

        public void setThreshold​(Number threshold)
        The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.

        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.

      • setVisible

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

        Defaults to: true

      • setZMax

        public void setZMax​(Number zMax)
        The minimum for the Z value range. Defaults to the highest Z value in the data.

        Defaults to: null

      • setZMin

        public void setZMin​(Number zMin)
        The minimum for the Z value range. Defaults to the lowest Z value in the data.

        Defaults to: null

      • setZThreshold

        public void setZThreshold​(Number zThreshold)
        When displayNegative is false, bubbles with lower Z values are skipped. When displayNegative is true and a negativeColor is given, points with lower Z is colored.

        Defaults to: 0

      • setZoneAxis

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

        Defaults to: y

      • 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:
        setZones(Zones...)

      • removeZone

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