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

Class GaugeOptions

    • Constructor Detail

      • GaugeOptions

        public GaugeOptions()

    • Method Detail

      • setAnimation

        public abstract void setAnimation​(Boolean animation)

        Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself.

        Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

      • setClip

        public abstract 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

      • setCrisp

        public abstract 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.

      • setCursor

        public abstract 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.

      • setDataLabels

        public abstract 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.

      • setEnableMouseTracking

        public abstract 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 abstract 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.

      • setKeys

        public abstract 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 abstract void addKey​(String key)
        Adds key to the keys array
        Parameters:
        key - to add
        See Also:
        setKeys(String...)

      • removeKey

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

      • setOpacity

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

      • setOvershoot

        public abstract 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.

      • setSelected

        public abstract 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.

      • setShowCheckbox

        public abstract 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 abstract void setShowInLegend​(Boolean showInLegend)
        Whether to display this particular series or series type in the legend.

      • setStickyTracking

        public abstract 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.

      • setTooltip

        public abstract void setTooltip​(SeriesTooltip tooltip)
        A configuration object for the tooltip rendering of each single series.

      • setVisible

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

      • setWrap

        public abstract 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.