com.vaadin.flow.component.charts.model.PlotOptionsBoxplot Maven / Gradle / Ivy
package com.vaadin.flow.component.charts.model;
/*-
* #%L
* Vaadin Charts for Flow
* %%
* Copyright (C) 2014 - 2018 Vaadin Ltd
* %%
* This program is available under Commercial Vaadin Add-On License 3.0
* (CVALv3).
*
* See the file licensing.txt distributed with this software for more
* information about licensing.
*
* You should have received a copy of the CVALv3 along with this program.
* If not, see .
* #L%
*/
import javax.annotation.Generated;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.time.Instant;
import com.vaadin.flow.component.charts.util.Util;
/**
* 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).
*/
@Generated(value = "This class is generated and shouldn't be modified", comments = "Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class PlotOptionsBoxplot extends AbstractPlotOptions {
private Boolean allowPointSelect;
private Number animationLimit;
private String className;
private Boolean colorByPoint;
private Number colorIndex;
private Boolean crisp;
private Cursor cursor;
private Number depth;
private String description;
private Number edgeWidth;
private Boolean enableMouseTracking;
private Boolean exposeElementToA11y;
private Dimension findNearestPointBy;
private Boolean getExtremesFromAll;
private Number groupPadding;
private Number groupZPadding;
private Boolean grouping;
private ArrayList keys;
private String linkedTo;
private Number maxPointWidth;
private Number medianWidth;
private boolean negativeColor;
private String _fn_pointDescriptionFormatter;
private Number pointInterval;
private IntervalUnit pointIntervalUnit;
private Number pointPadding;
private PointPlacement pointPlacement;
private Number pointRange;
private Number pointStart;
private Number pointWidth;
private Boolean selected;
private Boolean showCheckbox;
private Boolean showInLegend;
private Boolean skipKeyboardNavigation;
private States states;
private Boolean stickyTracking;
private SeriesTooltip tooltip;
private Number turboThreshold;
private Boolean visible;
private String whiskerLength;
private ZoneAxis zoneAxis;
private ArrayList zones;
public PlotOptionsBoxplot() {
}
@Override
public ChartType getChartType() {
return ChartType.BOXPLOT;
}
/**
* @see #setAllowPointSelect(Boolean)
*/
public Boolean getAllowPointSelect() {
return allowPointSelect;
}
/**
* Allow this series' points to be selected by clicking on the markers, bars
* or pie slices.
*
* Defaults to: false
*/
public void setAllowPointSelect(Boolean allowPointSelect) {
this.allowPointSelect = allowPointSelect;
}
/**
* @see #setAnimationLimit(Number)
*/
public Number getAnimationLimit() {
return 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.
*/
public void setAnimationLimit(Number animationLimit) {
this.animationLimit = animationLimit;
}
/**
* @see #setClassName(String)
*/
public String getClassName() {
return className;
}
/**
* A class name to apply to the series' graphical elements.
*/
public void setClassName(String className) {
this.className = className;
}
/**
* @see #setColorByPoint(Boolean)
*/
public Boolean getColorByPoint() {
return 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
*/
public void setColorByPoint(Boolean colorByPoint) {
this.colorByPoint = colorByPoint;
}
/**
* @see #setColorIndex(Number)
*/
public Number getColorIndex() {
return 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}.
*/
public void setColorIndex(Number colorIndex) {
this.colorIndex = colorIndex;
}
/**
* @see #setCrisp(Boolean)
*/
public Boolean getCrisp() {
return 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
*/
public void setCrisp(Boolean crisp) {
this.crisp = crisp;
}
/**
* @see #setCursor(Cursor)
*/
public Cursor getCursor() {
return 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.
*/
public void setCursor(Cursor cursor) {
this.cursor = cursor;
}
/**
* @see #setDepth(Number)
*/
public Number getDepth() {
return depth;
}
/**
* Depth of the columns in a 3D column chart. Requires
* highcharts-3d.js.
*
* Defaults to: 25
*/
public void setDepth(Number depth) {
this.depth = depth;
}
/**
* @see #setDescription(String)
*/
public String getDescription() {
return description;
}
/**
*
* Requires Accessibility module
*
*
* A description of the series to add to the screen reader information about
* the series.
*
*
* Defaults to: undefined
*/
public void setDescription(String description) {
this.description = description;
}
/**
* @see #setEdgeWidth(Number)
*/
public Number getEdgeWidth() {
return edgeWidth;
}
/**
* 3D columns only. The width of the colored edges.
*
* Defaults to: 1
*/
public void setEdgeWidth(Number edgeWidth) {
this.edgeWidth = edgeWidth;
}
/**
* @see #setEnableMouseTracking(Boolean)
*/
public Boolean getEnableMouseTracking() {
return 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
*/
public void setEnableMouseTracking(Boolean enableMouseTracking) {
this.enableMouseTracking = enableMouseTracking;
}
/**
* @see #setExposeElementToA11y(Boolean)
*/
public Boolean getExposeElementToA11y() {
return 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
*/
public void setExposeElementToA11y(Boolean exposeElementToA11y) {
this.exposeElementToA11y = exposeElementToA11y;
}
/**
* @see #setFindNearestPointBy(Dimension)
*/
public Dimension getFindNearestPointBy() {
return 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.
*
*/
public void setFindNearestPointBy(Dimension findNearestPointBy) {
this.findNearestPointBy = findNearestPointBy;
}
/**
* @see #setGetExtremesFromAll(Boolean)
*/
public Boolean getGetExtremesFromAll() {
return 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
*/
public void setGetExtremesFromAll(Boolean getExtremesFromAll) {
this.getExtremesFromAll = getExtremesFromAll;
}
/**
* @see #setGroupPadding(Number)
*/
public Number getGroupPadding() {
return groupPadding;
}
/**
* Padding between each value groups, in x axis units.
*
* Defaults to: 0.2
*/
public void setGroupPadding(Number groupPadding) {
this.groupPadding = groupPadding;
}
/**
* @see #setGroupZPadding(Number)
*/
public Number getGroupZPadding() {
return groupZPadding;
}
/**
* The spacing between columns on the Z Axis in a 3D chart. Requires
* highcharts-3d.js.
*
* Defaults to: 1
*/
public void setGroupZPadding(Number groupZPadding) {
this.groupZPadding = groupZPadding;
}
/**
* @see #setGrouping(Boolean)
*/
public Boolean getGrouping() {
return 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
*/
public void setGrouping(Boolean grouping) {
this.grouping = grouping;
}
/**
* @see #setKeys(String...)
*/
public String[] getKeys() {
if (keys == null) {
return new String[]{};
}
String[] arr = new String[keys.size()];
keys.toArray(arr);
return arr;
}
/**
* 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 void setKeys(String... keys) {
this.keys = new ArrayList(Arrays.asList(keys));
}
/**
* Adds key to the keys array
*
* @param key
* to add
* @see #setKeys(String...)
*/
public void addKey(String key) {
if (this.keys == null) {
this.keys = new ArrayList();
}
this.keys.add(key);
}
/**
* Removes first occurrence of key in keys array
*
* @param key
* to remove
* @see #setKeys(String...)
*/
public void removeKey(String key) {
this.keys.remove(key);
}
/**
* @see #setLinkedTo(String)
*/
public String getLinkedTo() {
return 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.
*/
public void setLinkedTo(String linkedTo) {
this.linkedTo = linkedTo;
}
/**
* @see #setMaxPointWidth(Number)
*/
public Number getMaxPointWidth() {
return 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
*/
public void setMaxPointWidth(Number maxPointWidth) {
this.maxPointWidth = maxPointWidth;
}
/**
* @see #setMedianWidth(Number)
*/
public Number getMedianWidth() {
return medianWidth;
}
/**
* The pixel width of the median line. If null, the lineWidth is used.
*
* Defaults to: 2
*/
public void setMedianWidth(Number medianWidth) {
this.medianWidth = medianWidth;
}
/**
* @see #setNegativeColor(boolean)
*/
public boolean isNegativeColor() {
return negativeColor;
}
/**
* Enable or disable the color for parts of the graph that are bellow
* {@link #getThreshold()}. A negative color is applied by setting this
* option to true combined with the
* .highcharts-negative class name.
*/
public void setNegativeColor(boolean negativeColor) {
this.negativeColor = negativeColor;
}
public String getPointDescriptionFormatter() {
return _fn_pointDescriptionFormatter;
}
public void setPointDescriptionFormatter(
String _fn_pointDescriptionFormatter) {
this._fn_pointDescriptionFormatter = _fn_pointDescriptionFormatter;
}
/**
* @see #setPointInterval(Number)
*/
public Number getPointInterval() {
return 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
*/
public void setPointInterval(Number pointInterval) {
this.pointInterval = pointInterval;
}
/**
* @see #setPointIntervalUnit(IntervalUnit)
*/
public IntervalUnit getPointIntervalUnit() {
return 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.
*/
public void setPointIntervalUnit(IntervalUnit pointIntervalUnit) {
this.pointIntervalUnit = pointIntervalUnit;
}
/**
* @see #setPointPadding(Number)
*/
public Number getPointPadding() {
return pointPadding;
}
/**
* Padding between each column or bar, in x axis units.
*
* Defaults to: 0.1
*/
public void setPointPadding(Number pointPadding) {
this.pointPadding = pointPadding;
}
/**
* @see #setPointPlacement(PointPlacement)
*/
public PointPlacement getPointPlacement() {
return 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.
*/
public void setPointPlacement(PointPlacement pointPlacement) {
this.pointPlacement = pointPlacement;
}
/**
* @see #setPointRange(Number)
*/
public Number getPointRange() {
return 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.
*/
public void setPointRange(Number pointRange) {
this.pointRange = pointRange;
}
/**
* @see #setPointStart(Number)
*/
public Number getPointStart() {
return 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
*/
public void setPointStart(Number pointStart) {
this.pointStart = pointStart;
}
/**
* @see #setPointWidth(Number)
*/
public Number getPointWidth() {
return pointWidth;
}
/**
* A pixel value specifying a fixed width for each column or bar. When
* null, the width is calculated from the
* pointPadding and groupPadding.
*/
public void setPointWidth(Number pointWidth) {
this.pointWidth = pointWidth;
}
/**
* @see #setSelected(Boolean)
*/
public Boolean getSelected() {
return 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
*/
public void setSelected(Boolean selected) {
this.selected = selected;
}
/**
* @see #setShowCheckbox(Boolean)
*/
public Boolean getShowCheckbox() {
return 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
*/
public void setShowCheckbox(Boolean showCheckbox) {
this.showCheckbox = showCheckbox;
}
/**
* @see #setShowInLegend(Boolean)
*/
public Boolean getShowInLegend() {
return 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
*/
public void setShowInLegend(Boolean showInLegend) {
this.showInLegend = showInLegend;
}
/**
* @see #setSkipKeyboardNavigation(Boolean)
*/
public Boolean getSkipKeyboardNavigation() {
return skipKeyboardNavigation;
}
/**
* If set to True, the accessibility module will skip past the
* points in this series for keyboard navigation.
*/
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation) {
this.skipKeyboardNavigation = skipKeyboardNavigation;
}
/**
* @see #setStates(States)
*/
public States getStates() {
if (states == null) {
states = new States();
}
return states;
}
/**
* A wrapper object for all the series options in specific states.
*/
public void setStates(States states) {
this.states = states;
}
/**
* @see #setStickyTracking(Boolean)
*/
public Boolean getStickyTracking() {
return 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
*/
public void setStickyTracking(Boolean stickyTracking) {
this.stickyTracking = stickyTracking;
}
/**
* @see #setTooltip(SeriesTooltip)
*/
public SeriesTooltip getTooltip() {
if (tooltip == null) {
tooltip = new SeriesTooltip();
}
return 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.
*/
public void setTooltip(SeriesTooltip tooltip) {
this.tooltip = tooltip;
}
/**
* @see #setTurboThreshold(Number)
*/
public Number getTurboThreshold() {
return 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
*/
public void setTurboThreshold(Number turboThreshold) {
this.turboThreshold = turboThreshold;
}
/**
* @see #setVisible(Boolean)
*/
public Boolean getVisible() {
return visible;
}
/**
* Set the initial visibility of the series.
*
* Defaults to: true
*/
public void setVisible(Boolean visible) {
this.visible = visible;
}
/**
* @see #setWhiskerLength(String)
*/
public String getWhiskerLength() {
return 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%
*/
public void setWhiskerLength(String whiskerLength) {
this.whiskerLength = whiskerLength;
}
/**
* @see #setZoneAxis(ZoneAxis)
*/
public ZoneAxis getZoneAxis() {
return zoneAxis;
}
/**
* Defines the Axis on which the zones are applied.
*
* Defaults to: y
*/
public void setZoneAxis(ZoneAxis zoneAxis) {
this.zoneAxis = zoneAxis;
}
/**
* @see #setZones(Zones...)
*/
public Zones[] getZones() {
if (zones == null) {
return new Zones[]{};
}
Zones[] arr = new Zones[zones.size()];
zones.toArray(arr);
return arr;
}
/**
*
* 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).
*
*/
public void setZones(Zones... zones) {
this.zones = new ArrayList(Arrays.asList(zones));
}
/**
* Adds zone to the zones array
*
* @param zone
* to add
* @see #setZones(Zones...)
*/
public void addZone(Zones zone) {
if (this.zones == null) {
this.zones = new ArrayList();
}
this.zones.add(zone);
}
/**
* Removes first occurrence of zone in zones array
*
* @param zone
* to remove
* @see #setZones(Zones...)
*/
public void removeZone(Zones zone) {
this.zones.remove(zone);
}
/**
* @deprecated as of 4.0. Use {@link #setPointStart(Instant)}
*/
@Deprecated
public void setPointStart(Date date) {
this.pointStart = Util.toHighchartsTS(date);
}
/**
* @see #setPointStart(Number)
*/
public void setPointStart(Instant instant) {
this.pointStart = Util.toHighchartsTS(instant);
}
}