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

Class PlotOptionsSolidgauge

  • All Implemented Interfaces:

    Serializable


    public class PlotOptionsSolidgauge
extends GaugeOptions

    A gauge showing values using a filled arc with colors indicating the value. The solid gauge plots values against the yAxis, which is extended with some color options, minColor, maxColor and stops, to control the color of the gauge itself.

    See Also:

    Serialized Form

    • Constructor Detail

      • PlotOptionsSolidgauge

        public PlotOptionsSolidgauge()

    • Method Detail

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

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

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

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

      • setDataLabels

        public void setDataLabels(DataLabels dataLabels)

        Data labels for the gauge. For gauges, the data labels are enabled by default and shown in a bordered box below the point.

        Specified by:

        setDataLabels in class GaugeOptions

      • 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

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

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

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

      • setLinecap

        public void setLinecap(String linecap)

        Whether the strokes of the solid gauge should be round or square.

        Defaults to: round

      • setOvershoot

        public void setOvershoot(Number overshoot)

        Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis.

        Defaults to: 0

        Specified by:

        setOvershoot in class GaugeOptions

      • getPointDescriptionFormatter

        public String getPointDescriptionFormatter()

      • setPointDescriptionFormatter

        public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

      • setRounded

        public void setRounded(Boolean rounded)

        Wether to draw rounded edges on the gauge.

        Defaults to: false

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

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

      • setShowInLegend

        public void setShowInLegend(Boolean showInLegend)

        Whether to display this particular series or series type in the legend. Defaults to false for gauge series.

        Specified by:

        setShowInLegend in class GaugeOptions

      • setSkipKeyboardNavigation

        public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)

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

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

      • setThreshold

        public void setThreshold(Number threshold)

        The threshold or base level for the gauge.

        Defaults to: null

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

      • setVisible

        public void setVisible(Boolean visible)

        Set the initial visibility of the series.

        Defaults to: true

        Specified by:

        setVisible in class GaugeOptions

      • setWrap

        public void setWrap(Boolean wrap)

        When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.

        Defaults to: true

        Specified by:

        setWrap in class GaugeOptions