com.vaadin.flow.component.charts.model.GaugeOptions Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.charts.model;
public abstract class GaugeOptions extends AbstractPlotOptions {
/**
* @see #setAnimation(Boolean)
*/
public abstract Boolean getAnimation();
/**
*
* 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.
*
*/
public abstract void setAnimation(Boolean animation);
/**
* @see #setClip(Boolean)
*/
public abstract Boolean getClip();
/**
* Disable this option to allow series rendering in the whole plotting area.
* Note that clipping should be always enabled when chart.zoomType is set
*/
public abstract void setClip(Boolean clip);
/**
* @see #setCrisp(Boolean)
*/
public abstract Boolean getCrisp();
/**
* 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.
*/
public abstract void setCrisp(Boolean crisp);
/**
* @see #setCursor(Cursor)
*/
public abstract Cursor getCursor();
/**
* 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.
*/
public abstract void setCursor(Cursor cursor);
/**
* @see #setDataLabels(DataLabels)
*/
public abstract DataLabels getDataLabels();
/**
* Data labels for the gauge. For gauges, the data labels are enabled by
* default and shown in a bordered box below the point.
*/
public abstract void setDataLabels(DataLabels dataLabels);
/**
* @see #setEnableMouseTracking(Boolean)
*/
public abstract Boolean getEnableMouseTracking();
/**
* 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.
*/
public abstract void setEnableMouseTracking(Boolean enableMouseTracking);
/**
* @see #setGetExtremesFromAll(Boolean)
*/
public abstract Boolean getGetExtremesFromAll();
/**
* 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.
*/
public abstract void setGetExtremesFromAll(Boolean getExtremesFromAll);
/**
* @see #setKeys(String...)
*/
public abstract String[] getKeys();
/**
* 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.
*/
public abstract void setKeys(String... keys);
/**
* Adds key to the keys array
*
* @param key
* to add
* @see #setKeys(String...)
*/
public abstract void addKey(String key);
/**
* Removes first occurrence of key in keys array
*
* @param key
* to remove
* @see #setKeys(String...)
*/
public abstract void removeKey(String key);
/**
* @see #setOpacity(Number)
*/
public abstract Number getOpacity();
/**
* Opacity of a series parts: line, fill (e.g. area) and dataLabels.
*/
public abstract void setOpacity(Number opacity);
/**
* @see #setOvershoot(Number)
*/
public abstract Number getOvershoot();
/**
* 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.
*/
public abstract void setOvershoot(Number overshoot);
/**
* @see #setSelected(Boolean)
*/
public abstract Boolean getSelected();
/**
* Whether to select the series initially. If showCheckbox is
* true, the checkbox next to the series name will be checked for a selected
* series.
*/
public abstract void setSelected(Boolean selected);
/**
* @see #setShowCheckbox(Boolean)
*/
public abstract Boolean getShowCheckbox();
/**
* 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.
*/
public abstract void setShowCheckbox(Boolean showCheckbox);
/**
* @see #setShowInLegend(Boolean)
*/
public abstract Boolean getShowInLegend();
/**
* Whether to display this particular series or series type in the legend.
*/
public abstract void setShowInLegend(Boolean showInLegend);
/**
* @see #setStickyTracking(Boolean)
*/
public abstract Boolean getStickyTracking();
/**
* 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.
*/
public abstract void setStickyTracking(Boolean stickyTracking);
/**
* @see #setTooltip(SeriesTooltip)
*/
public abstract SeriesTooltip getTooltip();
/**
* A configuration object for the tooltip rendering of each single series.
*/
public abstract void setTooltip(SeriesTooltip tooltip);
/**
* @see #setVisible(Boolean)
*/
public abstract Boolean getVisible();
/**
* Set the initial visibility of the series.
*/
public abstract void setVisible(Boolean visible);
/**
* @see #setWrap(Boolean)
*/
public abstract Boolean getWrap();
/**
* 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.
*/
public abstract void setWrap(Boolean wrap);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy