com.github.fluorumlabs.disconnect.highcharts.PlotArearangeOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import java.lang.FunctionalInterface;
import java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock) The area range series is a carteseian series with
* higher and lower values for each point along an X axis, where the area
* between the values is shaded. Requires highcharts-more.js.
*
* Configuration options for the series are given in three levels:
*
*
* -
* Options for all series in a chart are defined in the plotOptions.series
* object.
*
*
* -
* Options for all
arearange series are defined in plotOptions.arearange.
*
*
* -
* Options for one single series are given in the series instance array.
*
*
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange
* @see https://api.highcharts.com/highstock/plotOptions.arearange
*
*/
public interface PlotArearangeOptions extends Any {
/**
* (Highmaps) Whether all areas of the map defined in mapData should be
* rendered. If true, areas which don't correspond to a data point, are
* rendered as null points. If false, those areas are skipped.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.allAreas
*
* @implspec allAreas?: boolean;
*
*/
@JSProperty("allAreas")
boolean getAllAreas();
/**
* (Highmaps) Whether all areas of the map defined in mapData should be
* rendered. If true, areas which don't correspond to a data point, are
* rendered as null points. If false, those areas are skipped.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.allAreas
*
* @implspec allAreas?: boolean;
*
*/
@JSProperty("allAreas")
void setAllAreas(boolean value);
/**
* (Highcharts, Highstock) Allow this series' points to be selected by
* clicking on the graphic (columns, point markers, pie slices, map areas
* etc).
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.allowPointSelect
* @see https://api.highcharts.com/highstock/plotOptions.arearange.allowPointSelect
*
* @implspec allowPointSelect?: boolean;
*
*/
@JSProperty("allowPointSelect")
boolean getAllowPointSelect();
/**
* (Highcharts, Highstock) Allow this series' points to be selected by
* clicking on the graphic (columns, point markers, pie slices, map areas
* etc).
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.allowPointSelect
* @see https://api.highcharts.com/highstock/plotOptions.arearange.allowPointSelect
*
* @implspec allowPointSelect?: boolean;
*
*/
@JSProperty("allowPointSelect")
void setAllowPointSelect(boolean value);
/**
* (Highcharts, Highstock) 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. For other animations, see chart.animation
* and the animation parameter under the API methods. The following
* properties are supported:
*
* (see online documentation for example)
*
* Due to poor performance, animation is disabled in old IE browsers for
* several chart types.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotArearangeAnimationOptions);
*
*/
@JSProperty("animation")
@Nullable
Unknown getAnimation();
/**
* (Highcharts, Highstock) 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. For other animations, see chart.animation
* and the animation parameter under the API methods. The following
* properties are supported:
*
* (see online documentation for example)
*
* Due to poor performance, animation is disabled in old IE browsers for
* several chart types.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotArearangeAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(boolean value);
/**
* (Highcharts, Highstock) 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. For other animations, see chart.animation
* and the animation parameter under the API methods. The following
* properties are supported:
*
* (see online documentation for example)
*
* Due to poor performance, animation is disabled in old IE browsers for
* several chart types.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotArearangeAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(PlotArearangeAnimationOptions value);
/**
* (Highcharts, Highstock) 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. For other animations, see chart.animation
* and the animation parameter under the API methods. The following
* properties are supported:
*
* (see online documentation for example)
*
* Due to poor performance, animation is disabled in old IE browsers for
* several chart types.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotArearangeAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(AnimationOptionsObject value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animationLimit
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animationLimit
*
* @implspec animationLimit?: number;
*
*/
@JSProperty("animationLimit")
double getAnimationLimit();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.animationLimit
* @see https://api.highcharts.com/highstock/plotOptions.arearange.animationLimit
*
* @implspec animationLimit?: number;
*
*/
@JSProperty("animationLimit")
void setAnimationLimit(double value);
/**
* (Highcharts, Highstock) Set the point threshold for when a series should
* enter boost mode.
*
* Setting it to e.g. 2000 will cause the series to enter boost mode when
* there are 2000 or more points in the series.
*
* To disable boosting on the series, set the boostThreshold to 0. Setting
* it to 1 will force boosting.
*
* Note that the cropThreshold also affects this setting. When zooming in on
* a series that has fewer points than the cropThreshold, all points are
* rendered although outside the visible plot area, and the boostThreshold
* won't take effect.
*
* Requires modules/boost.js.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.boostThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.boostThreshold
*
* @implspec boostThreshold?: number;
*
*/
@JSProperty("boostThreshold")
double getBoostThreshold();
/**
* (Highcharts, Highstock) Set the point threshold for when a series should
* enter boost mode.
*
* Setting it to e.g. 2000 will cause the series to enter boost mode when
* there are 2000 or more points in the series.
*
* To disable boosting on the series, set the boostThreshold to 0. Setting
* it to 1 will force boosting.
*
* Note that the cropThreshold also affects this setting. When zooming in on
* a series that has fewer points than the cropThreshold, all points are
* rendered although outside the visible plot area, and the boostThreshold
* won't take effect.
*
* Requires modules/boost.js.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.boostThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.boostThreshold
*
* @implspec boostThreshold?: number;
*
*/
@JSProperty("boostThreshold")
void setBoostThreshold(double value);
/**
* (Highmaps, Highcharts) The border color of the map areas.
*
* In styled mode, the border stroke is given in the .highcharts-point
* class.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.borderColor
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highmaps, Highcharts) The border color of the map areas.
*
* In styled mode, the border stroke is given in the .highcharts-point
* class.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.borderColor
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highmaps, Highcharts) The border width of each map area.
*
* In styled mode, the border stroke width is given in the
* .highcharts-point class.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.borderWidth
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highmaps, Highcharts) The border width of each map area.
*
* In styled mode, the border stroke width is given in the
* .highcharts-point class.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.borderWidth
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock) An additional class name to apply to the series'
* graphical elements. This option does not replace default class names of
* the graphical element.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.className
* @see https://api.highcharts.com/highstock/plotOptions.arearange.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts, Highstock) An additional class name to apply to the series'
* graphical elements. This option does not replace default class names of
* the graphical element.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.className
* @see https://api.highcharts.com/highstock/plotOptions.arearange.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts, Highstock) Disable this option to allow series rendering in
* the whole plotting area.
*
* Note: Clipping should be always enabled when chart.zoomType is set
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.clip
* @see https://api.highcharts.com/highstock/plotOptions.arearange.clip
*
* @implspec clip?: boolean;
*
*/
@JSProperty("clip")
boolean getClip();
/**
* (Highcharts, Highstock) Disable this option to allow series rendering in
* the whole plotting area.
*
* Note: Clipping should be always enabled when chart.zoomType is set
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.clip
* @see https://api.highcharts.com/highstock/plotOptions.arearange.clip
*
* @implspec clip?: boolean;
*
*/
@JSProperty("clip")
void setClip(boolean value);
/**
* (Highcharts, Highstock) The main color of 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.color
* @see https://api.highcharts.com/highstock/plotOptions.arearange.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
@Nullable
Unknown getColor();
/**
* (Highcharts, Highstock) The main color of 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.color
* @see https://api.highcharts.com/highstock/plotOptions.arearange.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(GradientColorObject value);
/**
* (Highcharts, Highstock) The main color of 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.color
* @see https://api.highcharts.com/highstock/plotOptions.arearange.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(String value);
/**
* (Highcharts, Highstock) The main color of 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.color
* @see https://api.highcharts.com/highstock/plotOptions.arearange.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(Any value);
/**
* (Highmaps) Set this option to false to prevent a series from connecting
* to the global color axis. This will cause the series to have its own
* legend item.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.colorAxis
*
* @implspec colorAxis?: boolean;
*
*/
@JSProperty("colorAxis")
boolean getColorAxis();
/**
* (Highmaps) Set this option to false to prevent a series from connecting
* to the global color axis. This will cause the series to have its own
* legend item.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.colorAxis
*
* @implspec colorAxis?: boolean;
*
*/
@JSProperty("colorAxis")
void setColorAxis(boolean value);
/**
* (Highcharts, Highstock) Styled mode only. A specific color index to use
* for the series, so its graphic representations are given the class name
* highcharts-color-{n}.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.colorIndex
* @see https://api.highcharts.com/highstock/plotOptions.arearange.colorIndex
*
* @implspec colorIndex?: number;
*
*/
@JSProperty("colorIndex")
double getColorIndex();
/**
* (Highcharts, Highstock) Styled mode only. A specific color index to use
* for the series, so its graphic representations are given the class name
* highcharts-color-{n}.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.colorIndex
* @see https://api.highcharts.com/highstock/plotOptions.arearange.colorIndex
*
* @implspec colorIndex?: number;
*
*/
@JSProperty("colorIndex")
void setColorIndex(double value);
/**
* (Highstock) Compare the values of the series against the first non-null,
* non- zero value in the visible range. The y axis will show percentage or
* absolute change depending on whether compare is set to "percent" or
* "value". When this is applied to multiple series, it allows comparing
* the development of the series against each other. Adds a change field
* to every point object.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compare
*
* @implspec compare?: string;
*
*/
@JSProperty("compare")
@Nullable
String getCompare();
/**
* (Highstock) Compare the values of the series against the first non-null,
* non- zero value in the visible range. The y axis will show percentage or
* absolute change depending on whether compare is set to "percent" or
* "value". When this is applied to multiple series, it allows comparing
* the development of the series against each other. Adds a change field
* to every point object.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compare
*
* @implspec compare?: string;
*
*/
@JSProperty("compare")
void setCompare(String value);
/**
* (Highstock) When compare is percent, this option dictates whether to
* use 0 or 100 as the base of comparison.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compareBase
*
* @implspec compareBase?: (0|100);
*
*/
@JSProperty("compareBase")
@Nullable
CompareBase getCompareBase();
/**
* (Highstock) When compare is percent, this option dictates whether to
* use 0 or 100 as the base of comparison.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compareBase
*
* @implspec compareBase?: (0|100);
*
*/
@JSProperty("compareBase")
void setCompareBase(CompareBase value);
/**
* (Highstock) Defines if comparison should start from the first point
* within the visible range or should start from the first point (see online
* documentation for example) the range. In other words, this flag
* determines if first point within the visible range will have 0%
* (compareStart=true) or should have been already calculated according to
* the previous point (compareStart=false).
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compareStart
*
* @implspec compareStart?: boolean;
*
*/
@JSProperty("compareStart")
boolean getCompareStart();
/**
* (Highstock) Defines if comparison should start from the first point
* within the visible range or should start from the first point (see online
* documentation for example) the range. In other words, this flag
* determines if first point within the visible range will have 0%
* (compareStart=true) or should have been already calculated according to
* the previous point (compareStart=false).
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.compareStart
*
* @implspec compareStart?: boolean;
*
*/
@JSProperty("compareStart")
void setCompareStart(boolean value);
/**
* (Highcharts) Polar charts only. Whether to connect the ends of a line
* series plot across the extremes.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.connectEnds
*
* @implspec connectEnds?: boolean;
*
*/
@JSProperty("connectEnds")
boolean getConnectEnds();
/**
* (Highcharts) Polar charts only. Whether to connect the ends of a line
* series plot across the extremes.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.connectEnds
*
* @implspec connectEnds?: boolean;
*
*/
@JSProperty("connectEnds")
void setConnectEnds(boolean value);
/**
* (Highcharts, Highstock) Whether to connect a graph line across null
* points, or render a gap between the two points on either side of the
* null.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.connectNulls
* @see https://api.highcharts.com/highstock/plotOptions.arearange.connectNulls
*
* @implspec connectNulls?: boolean;
*
*/
@JSProperty("connectNulls")
boolean getConnectNulls();
/**
* (Highcharts, Highstock) Whether to connect a graph line across null
* points, or render a gap between the two points on either side of the
* null.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.connectNulls
* @see https://api.highcharts.com/highstock/plotOptions.arearange.connectNulls
*
* @implspec connectNulls?: boolean;
*
*/
@JSProperty("connectNulls")
void setConnectNulls(boolean value);
/**
* (Gantt) Override Pathfinder connector options for a series. Requires
* Highcharts Gantt to be loaded.
*
* @see https://api.highcharts.com/gantt/plotOptions.arearange.connectors
*
* @implspec connectors?: PlotArearangeConnectorsOptions;
*
*/
@JSProperty("connectors")
@Nullable
PlotArearangeConnectorsOptions getConnectors();
/**
* (Gantt) Override Pathfinder connector options for a series. Requires
* Highcharts Gantt to be loaded.
*
* @see https://api.highcharts.com/gantt/plotOptions.arearange.connectors
*
* @implspec connectors?: PlotArearangeConnectorsOptions;
*
*/
@JSProperty("connectors")
void setConnectors(PlotArearangeConnectorsOptions value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.cropThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.cropThreshold
*
* @implspec cropThreshold?: number;
*
*/
@JSProperty("cropThreshold")
double getCropThreshold();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.cropThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.cropThreshold
*
* @implspec cropThreshold?: number;
*
*/
@JSProperty("cropThreshold")
void setCropThreshold(double value);
/**
* (Highcharts, Highstock) 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.
*
* In styled mode, the series cursor can be set with the same classes as
* listed under series.color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.cursor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
@Nullable
Unknown getCursor();
/**
* (Highcharts, Highstock) 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.
*
* In styled mode, the series cursor can be set with the same classes as
* listed under series.color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.cursor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
void setCursor(CursorType value);
/**
* (Highcharts, Highstock) 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.
*
* In styled mode, the series cursor can be set with the same classes as
* listed under series.color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.cursor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
void setCursor(String value);
/**
* (Highcharts, Highstock) A name for the dash style to use for the graph,
* or for some series types the outline of each shape.
*
* In styled mode, the stroke dash-array can be set with the same classes as
* listed under series.color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dashStyle
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dashStyle
*
* @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("dashStyle")
@Nullable
DashStyle getDashStyle();
/**
* (Highcharts, Highstock) A name for the dash style to use for the graph,
* or for some series types the outline of each shape.
*
* In styled mode, the stroke dash-array can be set with the same classes as
* listed under series.color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dashStyle
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dashStyle
*
* @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("dashStyle")
void setDashStyle(DashStyle value);
/**
* (Highstock) Data grouping is the concept of sampling the data values into
* larger blocks in order to ease readability and increase performance of
* the JavaScript charts. Highstock by default applies data grouping when
* the points become closer than a certain pixel value, determined by the
* groupPixelWidth option.
*
* If data grouping is applied, the grouping information of grouped points
* can be read from the Point.dataGroup. If point options other than the
* data itself are set, for example name or color or custom properties,
* the grouping logic doesn't know how to group it. In this case the options
* of the first point instance are copied over to the group point. This can
* be altered through a custom approximation callback function.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dataGrouping
*
* @implspec dataGrouping?: PlotArearangeDataGroupingOptions;
*
*/
@JSProperty("dataGrouping")
@Nullable
PlotArearangeDataGroupingOptions getDataGrouping();
/**
* (Highstock) Data grouping is the concept of sampling the data values into
* larger blocks in order to ease readability and increase performance of
* the JavaScript charts. Highstock by default applies data grouping when
* the points become closer than a certain pixel value, determined by the
* groupPixelWidth option.
*
* If data grouping is applied, the grouping information of grouped points
* can be read from the Point.dataGroup. If point options other than the
* data itself are set, for example name or color or custom properties,
* the grouping logic doesn't know how to group it. In this case the options
* of the first point instance are copied over to the group point. This can
* be altered through a custom approximation callback function.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dataGrouping
*
* @implspec dataGrouping?: PlotArearangeDataGroupingOptions;
*
*/
@JSProperty("dataGrouping")
void setDataGrouping(PlotArearangeDataGroupingOptions value);
/**
* (Highcharts, Highstock) Extended data labels for range series types.
* Range series data labels have no x and y options. Instead, they have
* xLow, xHigh, yLow and yHigh options to allow the higher and lower
* data label sets individually.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels
*
* @implspec dataLabels?: PlotArearangeDataLabelsOptions;
*
*/
@JSProperty("dataLabels")
@Nullable
PlotArearangeDataLabelsOptions getDataLabels();
/**
* (Highcharts, Highstock) Extended data labels for range series types.
* Range series data labels have no x and y options. Instead, they have
* xLow, xHigh, yLow and yHigh options to allow the higher and lower
* data label sets individually.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels
*
* @implspec dataLabels?: PlotArearangeDataLabelsOptions;
*
*/
@JSProperty("dataLabels")
void setDataLabels(PlotArearangeDataLabelsOptions value);
/**
* (Highcharts, Highstock) Requires the Accessibility module.
*
* A description of the series to add to the screen reader information about
* the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.description
* @see https://api.highcharts.com/highstock/plotOptions.arearange.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highcharts, Highstock) Requires the Accessibility module.
*
* A description of the series to add to the screen reader information about
* the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.description
* @see https://api.highcharts.com/highstock/plotOptions.arearange.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
void setDescription(String value);
/**
* (Highcharts, Highstock) The draggable-points module allows points to be
* moved around or modified in the chart. In addition to the options
* mentioned under the dragDrop API structure, the module fires three
* events, point.dragStart, point.drag and point.drop.
*
* It requires the modules/draggable-points.js file to be loaded.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dragDrop
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dragDrop
*
* @implspec dragDrop?: PlotArearangeDragDropOptions;
*
*/
@JSProperty("dragDrop")
@Nullable
PlotArearangeDragDropOptions getDragDrop();
/**
* (Highcharts, Highstock) The draggable-points module allows points to be
* moved around or modified in the chart. In addition to the options
* mentioned under the dragDrop API structure, the module fires three
* events, point.dragStart, point.drag and point.drop.
*
* It requires the modules/draggable-points.js file to be loaded.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.dragDrop
* @see https://api.highcharts.com/highstock/plotOptions.arearange.dragDrop
*
* @implspec dragDrop?: PlotArearangeDragDropOptions;
*
*/
@JSProperty("dragDrop")
void setDragDrop(PlotArearangeDragDropOptions value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.enableMouseTracking
* @see https://api.highcharts.com/highstock/plotOptions.arearange.enableMouseTracking
*
* @implspec enableMouseTracking?: boolean;
*
*/
@JSProperty("enableMouseTracking")
boolean getEnableMouseTracking();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.enableMouseTracking
* @see https://api.highcharts.com/highstock/plotOptions.arearange.enableMouseTracking
*
* @implspec enableMouseTracking?: boolean;
*
*/
@JSProperty("enableMouseTracking")
void setEnableMouseTracking(boolean value);
/**
* (Highcharts, Highstock) General event handlers for the series items.
* These event hooks can also be attached to the series at run time using
* the Highcharts.addEvent function.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.events
* @see https://api.highcharts.com/highstock/plotOptions.arearange.events
*
* @implspec events?: PlotArearangeEventsOptions;
*
*/
@JSProperty("events")
@Nullable
PlotArearangeEventsOptions getEvents();
/**
* (Highcharts, Highstock) General event handlers for the series items.
* These event hooks can also be attached to the series at run time using
* the Highcharts.addEvent function.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.events
* @see https://api.highcharts.com/highstock/plotOptions.arearange.events
*
* @implspec events?: PlotArearangeEventsOptions;
*
*/
@JSProperty("events")
void setEvents(PlotArearangeEventsOptions value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.exposeElementToA11y
* @see https://api.highcharts.com/highstock/plotOptions.arearange.exposeElementToA11y
*
* @implspec exposeElementToA11y?: boolean;
*
*/
@JSProperty("exposeElementToA11y")
boolean getExposeElementToA11y();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.exposeElementToA11y
* @see https://api.highcharts.com/highstock/plotOptions.arearange.exposeElementToA11y
*
* @implspec exposeElementToA11y?: boolean;
*
*/
@JSProperty("exposeElementToA11y")
void setExposeElementToA11y(boolean value);
/**
* (Highcharts, Highstock) Fill color or gradient for the area. When null,
* the series' color is used with the series' fillOpacity.
*
* In styled mode, the fill color can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillColor
*
* @implspec fillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("fillColor")
@Nullable
Unknown getFillColor();
/**
* (Highcharts, Highstock) Fill color or gradient for the area. When null,
* the series' color is used with the series' fillOpacity.
*
* In styled mode, the fill color can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillColor
*
* @implspec fillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("fillColor")
void setFillColor(GradientColorObject value);
/**
* (Highcharts, Highstock) Fill color or gradient for the area. When null,
* the series' color is used with the series' fillOpacity.
*
* In styled mode, the fill color can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillColor
*
* @implspec fillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("fillColor")
void setFillColor(String value);
/**
* (Highcharts, Highstock) Fill color or gradient for the area. When null,
* the series' color is used with the series' fillOpacity.
*
* In styled mode, the fill color can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillColor
*
* @implspec fillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("fillColor")
void setFillColor(Any value);
/**
* (Highcharts, Highstock) Fill opacity for the area. When you set an
* explicit fillColor, the fillOpacity is not applied. Instead, you
* should define the opacity in the fillColor with an rgba color
* definition. The fillOpacity setting, also the default setting,
* overrides the alpha component of the color setting.
*
* In styled mode, the fill opacity can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillOpacity
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillOpacity
*
* @implspec fillOpacity?: number;
*
*/
@JSProperty("fillOpacity")
double getFillOpacity();
/**
* (Highcharts, Highstock) Fill opacity for the area. When you set an
* explicit fillColor, the fillOpacity is not applied. Instead, you
* should define the opacity in the fillColor with an rgba color
* definition. The fillOpacity setting, also the default setting,
* overrides the alpha component of the color setting.
*
* In styled mode, the fill opacity can be set with the .highcharts-area
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.fillOpacity
* @see https://api.highcharts.com/highstock/plotOptions.arearange.fillOpacity
*
* @implspec fillOpacity?: number;
*
*/
@JSProperty("fillOpacity")
void setFillOpacity(double value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.findNearestPointBy
* @see https://api.highcharts.com/highstock/plotOptions.arearange.findNearestPointBy
*
* @implspec findNearestPointBy?: ("x"|"xy");
*
*/
@JSProperty("findNearestPointBy")
@Nullable
FindNearestPointBy getFindNearestPointBy();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.findNearestPointBy
* @see https://api.highcharts.com/highstock/plotOptions.arearange.findNearestPointBy
*
* @implspec findNearestPointBy?: ("x"|"xy");
*
*/
@JSProperty("findNearestPointBy")
void setFindNearestPointBy(FindNearestPointBy value);
/**
* (Highstock) Defines when to display a gap in the graph, together with the
* gapUnit option.
*
* In case when dataGrouping is enabled, points can be grouped into a
* larger time span. This can make the grouped points to have a greater
* distance than the absolute value of gapSize property, which will result
* in disappearing graph completely. To prevent this situation the mentioned
* distance between grouped points is used instead of previously defined
* gapSize.
*
* In practice, this option is most often used to visualize gaps in time
* series. In a stock chart, intraday data is available for daytime hours,
* while gaps will appear in nights and weekends.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.gapSize
*
* @implspec gapSize?: number;
*
*/
@JSProperty("gapSize")
double getGapSize();
/**
* (Highstock) Defines when to display a gap in the graph, together with the
* gapUnit option.
*
* In case when dataGrouping is enabled, points can be grouped into a
* larger time span. This can make the grouped points to have a greater
* distance than the absolute value of gapSize property, which will result
* in disappearing graph completely. To prevent this situation the mentioned
* distance between grouped points is used instead of previously defined
* gapSize.
*
* In practice, this option is most often used to visualize gaps in time
* series. In a stock chart, intraday data is available for daytime hours,
* while gaps will appear in nights and weekends.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.gapSize
*
* @implspec gapSize?: number;
*
*/
@JSProperty("gapSize")
void setGapSize(double value);
/**
* (Highstock) Together with gapSize, this option defines where to draw gaps
* in the graph.
*
* When the gapUnit is relative (default), a gap size of 5 means that if
* the distance between two points is greater than five times that of the
* two closest points, the graph will be broken.
*
* When the gapUnit is value, the gap is based on absolute axis values,
* which on a datetime axis is milliseconds. This also applies to the
* navigator series that inherits gap options from the base series.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.gapUnit
*
* @implspec gapUnit?: ("relative"|"value");
*
*/
@JSProperty("gapUnit")
@Nullable
GapUnit getGapUnit();
/**
* (Highstock) Together with gapSize, this option defines where to draw gaps
* in the graph.
*
* When the gapUnit is relative (default), a gap size of 5 means that if
* the distance between two points is greater than five times that of the
* two closest points, the graph will be broken.
*
* When the gapUnit is value, the gap is based on absolute axis values,
* which on a datetime axis is milliseconds. This also applies to the
* navigator series that inherits gap options from the base series.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.gapUnit
*
* @implspec gapUnit?: ("relative"|"value");
*
*/
@JSProperty("gapUnit")
void setGapUnit(GapUnit value);
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.getExtremesFromAll
* @see https://api.highcharts.com/highstock/plotOptions.arearange.getExtremesFromAll
* @see https://api.highcharts.com/gantt/plotOptions.arearange.getExtremesFromAll
*
* @implspec getExtremesFromAll?: boolean;
*
*/
@JSProperty("getExtremesFromAll")
boolean getGetExtremesFromAll();
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.getExtremesFromAll
* @see https://api.highcharts.com/highstock/plotOptions.arearange.getExtremesFromAll
* @see https://api.highcharts.com/gantt/plotOptions.arearange.getExtremesFromAll
*
* @implspec getExtremesFromAll?: boolean;
*
*/
@JSProperty("getExtremesFromAll")
void setGetExtremesFromAll(boolean value);
/**
* (Highmaps) What property to join the mapData to the value data. For
* example, if joinBy is "code", the mapData items with a specific code is
* merged into the data with the same code. For maps loaded from GeoJSON,
* the keys may be held in each point's properties object.
*
* The joinBy option can also be an array of two values, where the first
* points to a key in the mapData, and the second points to another key in
* the data.
*
* When joinBy is null, the map items are joined by their position in the
* array, which performs much better in maps with many data points. This is
* the recommended option if you are printing more than a thousand data
* points and have a backend that can preprocess the data into a parallel
* array of the mapData.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.joinBy
*
* @implspec joinBy?: (string|Array);
*
*/
@JSProperty("joinBy")
@Nullable
Unknown getJoinBy();
/**
* (Highmaps) What property to join the mapData to the value data. For
* example, if joinBy is "code", the mapData items with a specific code is
* merged into the data with the same code. For maps loaded from GeoJSON,
* the keys may be held in each point's properties object.
*
* The joinBy option can also be an array of two values, where the first
* points to a key in the mapData, and the second points to another key in
* the data.
*
* When joinBy is null, the map items are joined by their position in the
* array, which performs much better in maps with many data points. This is
* the recommended option if you are printing more than a thousand data
* points and have a backend that can preprocess the data into a parallel
* array of the mapData.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.joinBy
*
* @implspec joinBy?: (string|Array);
*
*/
@JSProperty("joinBy")
void setJoinBy(String value);
/**
* (Highmaps) What property to join the mapData to the value data. For
* example, if joinBy is "code", the mapData items with a specific code is
* merged into the data with the same code. For maps loaded from GeoJSON,
* the keys may be held in each point's properties object.
*
* The joinBy option can also be an array of two values, where the first
* points to a key in the mapData, and the second points to another key in
* the data.
*
* When joinBy is null, the map items are joined by their position in the
* array, which performs much better in maps with many data points. This is
* the recommended option if you are printing more than a thousand data
* points and have a backend that can preprocess the data into a parallel
* array of the mapData.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.joinBy
*
* @implspec joinBy?: (string|Array);
*
*/
@JSProperty("joinBy")
void setJoinBy(String[] value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.keys
* @see https://api.highcharts.com/highstock/plotOptions.arearange.keys
*
* @implspec keys?: Array;
*
*/
@JSProperty("keys")
@Nullable
String[] getKeys();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.keys
* @see https://api.highcharts.com/highstock/plotOptions.arearange.keys
*
* @implspec keys?: Array;
*
*/
@JSProperty("keys")
void setKeys(String[] value);
/**
* (Highcharts, Highstock, Gantt) Series labels are placed as close to the
* series as possible in a natural way, seeking to avoid other series. The
* goal of this feature is to make the chart more easily readable, like if a
* human designer placed the labels in the optimal position.
*
* The series labels currently work with series types having a graph or an
* area.
*
* Requires the series-label.js module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.label
* @see https://api.highcharts.com/highstock/plotOptions.arearange.label
* @see https://api.highcharts.com/gantt/plotOptions.arearange.label
*
* @implspec label?: PlotArearangeLabelOptions;
*
*/
@JSProperty("label")
@Nullable
PlotArearangeLabelOptions getLabel();
/**
* (Highcharts, Highstock, Gantt) Series labels are placed as close to the
* series as possible in a natural way, seeking to avoid other series. The
* goal of this feature is to make the chart more easily readable, like if a
* human designer placed the labels in the optimal position.
*
* The series labels currently work with series types having a graph or an
* area.
*
* Requires the series-label.js module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.label
* @see https://api.highcharts.com/highstock/plotOptions.arearange.label
* @see https://api.highcharts.com/gantt/plotOptions.arearange.label
*
* @implspec label?: PlotArearangeLabelOptions;
*
*/
@JSProperty("label")
void setLabel(PlotArearangeLabelOptions value);
/**
* (Highcharts, Highstock) The SVG value used for the stroke-linecap and
* stroke-linejoin of a line graph. Round means that lines are rounded in
* the ends and bends.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.linecap
* @see https://api.highcharts.com/highstock/plotOptions.arearange.linecap
*
* @implspec linecap?: ("butt"|"round"|"square");
*
*/
@JSProperty("linecap")
@Nullable
Linecap getLinecap();
/**
* (Highcharts, Highstock) The SVG value used for the stroke-linecap and
* stroke-linejoin of a line graph. Round means that lines are rounded in
* the ends and bends.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.linecap
* @see https://api.highcharts.com/highstock/plotOptions.arearange.linecap
*
* @implspec linecap?: ("butt"|"round"|"square");
*
*/
@JSProperty("linecap")
void setLinecap(Linecap value);
/**
* (Highcharts, Highstock) A separate color for the graph line. By default
* the line takes the color of the series, but the lineColor setting
* allows setting a separate color for the line without altering the
* fillColor.
*
* In styled mode, the line stroke can be set with the .highcharts-graph
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.lineColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
@Nullable
String getLineColor();
/**
* (Highcharts, Highstock) A separate color for the graph line. By default
* the line takes the color of the series, but the lineColor setting
* allows setting a separate color for the line without altering the
* fillColor.
*
* In styled mode, the line stroke can be set with the .highcharts-graph
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.lineColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
void setLineColor(String value);
/**
* (Highcharts, Highstock) Pixel width of the arearange graph line.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.lineWidth
* @see https://api.highcharts.com/highstock/plotOptions.arearange.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
double getLineWidth();
/**
* (Highcharts, Highstock) Pixel width of the arearange graph line.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.lineWidth
* @see https://api.highcharts.com/highstock/plotOptions.arearange.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
void setLineWidth(double value);
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.linkedTo
* @see https://api.highcharts.com/highstock/plotOptions.arearange.linkedTo
* @see https://api.highcharts.com/gantt/plotOptions.arearange.linkedTo
*
* @implspec linkedTo?: string;
*
*/
@JSProperty("linkedTo")
@Nullable
String getLinkedTo();
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.linkedTo
* @see https://api.highcharts.com/highstock/plotOptions.arearange.linkedTo
* @see https://api.highcharts.com/gantt/plotOptions.arearange.linkedTo
*
* @implspec linkedTo?: string;
*
*/
@JSProperty("linkedTo")
void setLinkedTo(String value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.marker
* @see https://api.highcharts.com/highstock/plotOptions.arearange.marker
*
* @implspec marker?: PlotArearangeMarkerOptions;
*
*/
@JSProperty("marker")
@Nullable
PlotArearangeMarkerOptions getMarker();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.marker
* @see https://api.highcharts.com/highstock/plotOptions.arearange.marker
*
* @implspec marker?: PlotArearangeMarkerOptions;
*
*/
@JSProperty("marker")
void setMarker(PlotArearangeMarkerOptions value);
/**
* (Highstock) Options for the corresponding navigator series if
* showInNavigator is true for this series. Available options are the
* same as any series, documented at plotOptions and series.
*
* These options are merged with options in navigator.series, and will take
* precedence if the same option is defined both places.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.navigatorOptions
*
* @implspec navigatorOptions?: PlotSeriesOptions;
*
*/
@JSProperty("navigatorOptions")
@Nullable
PlotSeriesOptions getNavigatorOptions();
/**
* (Highstock) Options for the corresponding navigator series if
* showInNavigator is true for this series. Available options are the
* same as any series, documented at plotOptions and series.
*
* These options are merged with options in navigator.series, and will take
* precedence if the same option is defined both places.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.navigatorOptions
*
* @implspec navigatorOptions?: PlotSeriesOptions;
*
*/
@JSProperty("navigatorOptions")
void setNavigatorOptions(PlotSeriesOptions value);
/**
* (Highcharts, Highstock) The color for the parts of the graph or points
* that are below the threshold.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.negativeColor
*
* @implspec negativeColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativeColor")
@Nullable
Unknown getNegativeColor();
/**
* (Highcharts, Highstock) The color for the parts of the graph or points
* that are below the threshold.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.negativeColor
*
* @implspec negativeColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativeColor")
void setNegativeColor(GradientColorObject value);
/**
* (Highcharts, Highstock) The color for the parts of the graph or points
* that are below the threshold.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.negativeColor
*
* @implspec negativeColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativeColor")
void setNegativeColor(String value);
/**
* (Highcharts, Highstock) The color for the parts of the graph or points
* that are below the threshold.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeColor
* @see https://api.highcharts.com/highstock/plotOptions.arearange.negativeColor
*
* @implspec negativeColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativeColor")
void setNegativeColor(Any value);
/**
* (Highcharts) A separate color for the negative part of the area.
*
* In styled mode, a negative color is set with the .highcharts-negative
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeFillColor
*
* @implspec negativefillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativefillColor")
@Nullable
Unknown getNegativefillColor();
/**
* (Highcharts) A separate color for the negative part of the area.
*
* In styled mode, a negative color is set with the .highcharts-negative
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeFillColor
*
* @implspec negativefillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativefillColor")
void setNegativefillColor(GradientColorObject value);
/**
* (Highcharts) A separate color for the negative part of the area.
*
* In styled mode, a negative color is set with the .highcharts-negative
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeFillColor
*
* @implspec negativefillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativefillColor")
void setNegativefillColor(String value);
/**
* (Highcharts) A separate color for the negative part of the area.
*
* In styled mode, a negative color is set with the .highcharts-negative
* class name.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.negativeFillColor
*
* @implspec negativefillColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("negativefillColor")
void setNegativefillColor(Any value);
/**
* (Highcharts, Highstock) Properties for each single point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.point
* @see https://api.highcharts.com/highstock/plotOptions.arearange.point
*
* @implspec point?: PlotArearangePointOptions;
*
*/
@JSProperty("point")
@Nullable
PlotArearangePointOptions getPoint();
/**
* (Highcharts, Highstock) Properties for each single point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.point
* @see https://api.highcharts.com/highstock/plotOptions.arearange.point
*
* @implspec point?: PlotArearangePointOptions;
*
*/
@JSProperty("point")
void setPoint(PlotArearangePointOptions value);
/**
* (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
* but for an individual series. Overrides the chart wide configuration.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointDescriptionFormatter
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointDescriptionFormatter
*
* @implspec pointDescriptionFormatter?: () => void;
*
*/
@JSProperty("pointDescriptionFormatter")
@Nullable
PointDescriptionFormatter getPointDescriptionFormatter();
/**
* (Highcharts, Highstock) Same as accessibility.pointDescriptionFormatter,
* but for an individual series. Overrides the chart wide configuration.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointDescriptionFormatter
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointDescriptionFormatter
*
* @implspec pointDescriptionFormatter?: () => void;
*
*/
@JSProperty("pointDescriptionFormatter")
void setPointDescriptionFormatter(PointDescriptionFormatter value);
/**
* (Highcharts, Highstock, Gantt) 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. In true datetime axes, the
* pointInterval is set in milliseconds.
*
* It can be also be combined with pointIntervalUnit to draw irregular
* time intervals.
*
* Please note that this options applies to the series data, not the
* interval of the axis ticks, which is independent.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointInterval
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointInterval
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointInterval
*
* @implspec pointInterval?: number;
*
*/
@JSProperty("pointInterval")
double getPointInterval();
/**
* (Highcharts, Highstock, Gantt) 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. In true datetime axes, the
* pointInterval is set in milliseconds.
*
* It can be also be combined with pointIntervalUnit to draw irregular
* time intervals.
*
* Please note that this options applies to the series data, not the
* interval of the axis ticks, which is independent.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointInterval
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointInterval
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointInterval
*
* @implspec pointInterval?: number;
*
*/
@JSProperty("pointInterval")
void setPointInterval(double value);
/**
* (Highcharts, Highstock, Gantt) 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.
*
* Please note that this options applies to the series data, not the
* interval of the axis ticks, which is independent.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointIntervalUnit
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointIntervalUnit
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointIntervalUnit
*
* @implspec pointIntervalUnit?: ("day"|"month"|"year");
*
*/
@JSProperty("pointIntervalUnit")
@Nullable
PointIntervalUnit getPointIntervalUnit();
/**
* (Highcharts, Highstock, Gantt) 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.
*
* Please note that this options applies to the series data, not the
* interval of the axis ticks, which is independent.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointIntervalUnit
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointIntervalUnit
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointIntervalUnit
*
* @implspec pointIntervalUnit?: ("day"|"month"|"year");
*
*/
@JSProperty("pointIntervalUnit")
void setPointIntervalUnit(PointIntervalUnit value);
/**
* (Highcharts, Highstock, Gantt) Possible values: "on", "between",
* number.
*
* 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.
*
* For the xrange series type and gantt charts, if the Y axis is a
* category axis, the pointPlacement applies to the Y axis rather than the
* (typically datetime) X axis.
*
* Defaults to undefined in cartesian charts, "between" in polar charts.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointPlacement
*
* @implspec pointPlacement?: (number|string);
*
*/
@JSProperty("pointPlacement")
@Nullable
Unknown getPointPlacement();
/**
* (Highcharts, Highstock, Gantt) Possible values: "on", "between",
* number.
*
* 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.
*
* For the xrange series type and gantt charts, if the Y axis is a
* category axis, the pointPlacement applies to the Y axis rather than the
* (typically datetime) X axis.
*
* Defaults to undefined in cartesian charts, "between" in polar charts.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointPlacement
*
* @implspec pointPlacement?: (number|string);
*
*/
@JSProperty("pointPlacement")
void setPointPlacement(double value);
/**
* (Highcharts, Highstock, Gantt) Possible values: "on", "between",
* number.
*
* 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.
*
* For the xrange series type and gantt charts, if the Y axis is a
* category axis, the pointPlacement applies to the Y axis rather than the
* (typically datetime) X axis.
*
* Defaults to undefined in cartesian charts, "between" in polar charts.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointPlacement
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointPlacement
*
* @implspec pointPlacement?: (number|string);
*
*/
@JSProperty("pointPlacement")
void setPointPlacement(String value);
/**
* (Highstock) The width of each point on the x axis. For example in a
* column chart with one value each day, the pointRange would be 1 day (= 24
*
*
* -
* 3600
*
*
* -
* 1000 milliseconds). This is normally computed automatically, but this
* option can be used to override the automatic value.
*
*
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointRange
*
* @implspec pointRange?: number;
*
*/
@JSProperty("pointRange")
double getPointRange();
/**
* (Highstock) The width of each point on the x axis. For example in a
* column chart with one value each day, the pointRange would be 1 day (= 24
*
*
* -
* 3600
*
*
* -
* 1000 milliseconds). This is normally computed automatically, but this
* option can be used to override the automatic value.
*
*
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointRange
*
* @implspec pointRange?: number;
*
*/
@JSProperty("pointRange")
void setPointRange(double value);
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointStart
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointStart
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointStart
*
* @implspec pointStart?: number;
*
*/
@JSProperty("pointStart")
double getPointStart();
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.pointStart
* @see https://api.highcharts.com/highstock/plotOptions.arearange.pointStart
* @see https://api.highcharts.com/gantt/plotOptions.arearange.pointStart
*
* @implspec pointStart?: number;
*
*/
@JSProperty("pointStart")
void setPointStart(double value);
/**
* (Highcharts, Highstock) Whether to select the series initially. If
* showCheckbox is true, the checkbox next to the series name in the
* legend will be checked for a selected series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.selected
* @see https://api.highcharts.com/highstock/plotOptions.arearange.selected
*
* @implspec selected?: boolean;
*
*/
@JSProperty("selected")
boolean getSelected();
/**
* (Highcharts, Highstock) Whether to select the series initially. If
* showCheckbox is true, the checkbox next to the series name in the
* legend will be checked for a selected series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.selected
* @see https://api.highcharts.com/highstock/plotOptions.arearange.selected
*
* @implspec selected?: boolean;
*
*/
@JSProperty("selected")
void setSelected(boolean value);
/**
* (Highcharts) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
@Nullable
Unknown getShadow();
/**
* (Highcharts) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(ShadowOptionsObject value);
/**
* (Highcharts) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(boolean value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.showCheckbox
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showCheckbox
*
* @implspec showCheckbox?: boolean;
*
*/
@JSProperty("showCheckbox")
boolean getShowCheckbox();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.showCheckbox
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showCheckbox
*
* @implspec showCheckbox?: boolean;
*
*/
@JSProperty("showCheckbox")
void setShowCheckbox(boolean value);
/**
* (Highcharts, Highstock) Whether to display this particular series or
* series type in the legend. The default value is true for standalone
* series, false for linked series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.showInLegend
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showInLegend
*
* @implspec showInLegend?: boolean;
*
*/
@JSProperty("showInLegend")
boolean getShowInLegend();
/**
* (Highcharts, Highstock) Whether to display this particular series or
* series type in the legend. The default value is true for standalone
* series, false for linked series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.showInLegend
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showInLegend
*
* @implspec showInLegend?: boolean;
*
*/
@JSProperty("showInLegend")
void setShowInLegend(boolean value);
/**
* (Highstock) Whether or not to show the series in the navigator. Takes
* precedence over navigator.baseSeries if defined.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showInNavigator
*
* @implspec showInNavigator?: boolean;
*
*/
@JSProperty("showInNavigator")
boolean getShowInNavigator();
/**
* (Highstock) Whether or not to show the series in the navigator. Takes
* precedence over navigator.baseSeries if defined.
*
* @see https://api.highcharts.com/highstock/plotOptions.arearange.showInNavigator
*
* @implspec showInNavigator?: boolean;
*
*/
@JSProperty("showInNavigator")
void setShowInNavigator(boolean value);
/**
* (Highcharts, Highstock) If set to true, the accessibility module will
* skip past the points in this series for keyboard navigation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.skipKeyboardNavigation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.skipKeyboardNavigation
*
* @implspec skipKeyboardNavigation?: boolean;
*
*/
@JSProperty("skipKeyboardNavigation")
boolean getSkipKeyboardNavigation();
/**
* (Highcharts, Highstock) If set to true, the accessibility module will
* skip past the points in this series for keyboard navigation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.skipKeyboardNavigation
* @see https://api.highcharts.com/highstock/plotOptions.arearange.skipKeyboardNavigation
*
* @implspec skipKeyboardNavigation?: boolean;
*
*/
@JSProperty("skipKeyboardNavigation")
void setSkipKeyboardNavigation(boolean value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.softThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.softThreshold
*
* @implspec softThreshold?: boolean;
*
*/
@JSProperty("softThreshold")
boolean getSoftThreshold();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.softThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.softThreshold
*
* @implspec softThreshold?: boolean;
*
*/
@JSProperty("softThreshold")
void setSoftThreshold(boolean value);
/**
* (Highcharts, Highstock) A wrapper object for all the series options in
* specific states.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.states
* @see https://api.highcharts.com/highstock/plotOptions.arearange.states
*
* @implspec states?: PlotArearangeStatesOptions;
*
*/
@JSProperty("states")
@Nullable
PlotArearangeStatesOptions getStates();
/**
* (Highcharts, Highstock) A wrapper object for all the series options in
* specific states.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.states
* @see https://api.highcharts.com/highstock/plotOptions.arearange.states
*
* @implspec states?: PlotArearangeStatesOptions;
*
*/
@JSProperty("states")
void setStates(PlotArearangeStatesOptions value);
/**
* (Highcharts, Highstock) Whether to apply steps to the line. Possible
* values are left, center and right.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.step
* @see https://api.highcharts.com/highstock/plotOptions.arearange.step
*
* @implspec step?: ("center"|"left"|"right");
*
*/
@JSProperty("step")
@Nullable
Step getStep();
/**
* (Highcharts, Highstock) Whether to apply steps to the line. Possible
* values are left, center and right.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.step
* @see https://api.highcharts.com/highstock/plotOptions.arearange.step
*
* @implspec step?: ("center"|"left"|"right");
*
*/
@JSProperty("step")
void setStep(Step value);
/**
* (Highcharts, Highstock) 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 not shared.
* 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.stickyTracking
* @see https://api.highcharts.com/highstock/plotOptions.arearange.stickyTracking
*
* @implspec stickyTracking?: boolean;
*
*/
@JSProperty("stickyTracking")
boolean getStickyTracking();
/**
* (Highcharts, Highstock) 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 not shared.
* 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.stickyTracking
* @see https://api.highcharts.com/highstock/plotOptions.arearange.stickyTracking
*
* @implspec stickyTracking?: boolean;
*
*/
@JSProperty("stickyTracking")
void setStickyTracking(boolean value);
/**
* (Highcharts, Highstock) The Y axis value to serve as the base for the
* area, for distinguishing between values above and below a threshold. The
* area between the graph and the threshold is filled.
*
*
* -
* If a number is given, the Y axis will scale to the threshold.
*
*
* -
* If
null, the scaling behaves like a line series with fill between the
* graph and the Y axis minimum.
*
*
* -
* If
Infinity or -Infinity, the area between the graph and the
* corresponing Y axis extreme is filled (since v6.1.0).
*
*
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.threshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.threshold
*
* @implspec threshold?: any;
*
*/
@JSProperty("threshold")
@Nullable
Any getThreshold();
/**
* (Highcharts, Highstock) The Y axis value to serve as the base for the
* area, for distinguishing between values above and below a threshold. The
* area between the graph and the threshold is filled.
*
*
* -
* If a number is given, the Y axis will scale to the threshold.
*
*
* -
* If
null, the scaling behaves like a line series with fill between the
* graph and the Y axis minimum.
*
*
* -
* If
Infinity or -Infinity, the area between the graph and the
* corresponing Y axis extreme is filled (since v6.1.0).
*
*
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.threshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.threshold
*
* @implspec threshold?: any;
*
*/
@JSProperty("threshold")
void setThreshold(Any value);
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.tooltip
* @see https://api.highcharts.com/highstock/plotOptions.arearange.tooltip
*
* @implspec tooltip?: PlotArearangeTooltipOptions;
*
*/
@JSProperty("tooltip")
@Nullable
PlotArearangeTooltipOptions getTooltip();
/**
* (Highcharts, Highstock) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.tooltip
* @see https://api.highcharts.com/highstock/plotOptions.arearange.tooltip
*
* @implspec tooltip?: PlotArearangeTooltipOptions;
*
*/
@JSProperty("tooltip")
void setTooltip(PlotArearangeTooltipOptions value);
/**
* (Highcharts, Highstock) Whether the whole area or just the line should
* respond to mouseover tooltips and other mouse or touch events.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.trackByArea
* @see https://api.highcharts.com/highstock/plotOptions.arearange.trackByArea
*
* @implspec trackByArea?: boolean;
*
*/
@JSProperty("trackByArea")
boolean getTrackByArea();
/**
* (Highcharts, Highstock) Whether the whole area or just the line should
* respond to mouseover tooltips and other mouse or touch events.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.trackByArea
* @see https://api.highcharts.com/highstock/plotOptions.arearange.trackByArea
*
* @implspec trackByArea?: boolean;
*
*/
@JSProperty("trackByArea")
void setTrackByArea(boolean value);
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.turboThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.turboThreshold
* @see https://api.highcharts.com/gantt/plotOptions.arearange.turboThreshold
*
* @implspec turboThreshold?: number;
*
*/
@JSProperty("turboThreshold")
double getTurboThreshold();
/**
* (Highcharts, Highstock, Gantt) 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.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.turboThreshold
* @see https://api.highcharts.com/highstock/plotOptions.arearange.turboThreshold
* @see https://api.highcharts.com/gantt/plotOptions.arearange.turboThreshold
*
* @implspec turboThreshold?: number;
*
*/
@JSProperty("turboThreshold")
void setTurboThreshold(double value);
/**
* (Highcharts, Highstock) Set the initial visibility of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.visible
* @see https://api.highcharts.com/highstock/plotOptions.arearange.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
boolean getVisible();
/**
* (Highcharts, Highstock) Set the initial visibility of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.visible
* @see https://api.highcharts.com/highstock/plotOptions.arearange.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
void setVisible(boolean value);
/**
* (Highmaps) Define the z index of the series.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
double getZIndex();
/**
* (Highmaps) Define the z index of the series.
*
* @see https://api.highcharts.com/highmaps/plotOptions.arearange.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
void setZIndex(double value);
/**
* (Highcharts, Highstock) Defines the Axis on which the zones are applied.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.zoneAxis
* @see https://api.highcharts.com/highstock/plotOptions.arearange.zoneAxis
*
* @implspec zoneAxis?: string;
*
*/
@JSProperty("zoneAxis")
@Nullable
String getZoneAxis();
/**
* (Highcharts, Highstock) Defines the Axis on which the zones are applied.
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.zoneAxis
* @see https://api.highcharts.com/highstock/plotOptions.arearange.zoneAxis
*
* @implspec zoneAxis?: string;
*
*/
@JSProperty("zoneAxis")
void setZoneAxis(String value);
/**
* (Highcharts, Highstock) 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. The zone definitions have to be in ascending order
* regarding to the value.
*
* In styled mode, the color zones are styled with the
* .highcharts-zone-{n} class, or custom classed from the className
* option (view live demo).
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.zones
* @see https://api.highcharts.com/highstock/plotOptions.arearange.zones
*
* @implspec zones?: Array;
*
*/
@JSProperty("zones")
@Nullable
Array getZones();
/**
* (Highcharts, Highstock) 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. The zone definitions have to be in ascending order
* regarding to the value.
*
* In styled mode, the color zones are styled with the
* .highcharts-zone-{n} class, or custom classed from the className
* option (view live demo).
*
* @see https://api.highcharts.com/highcharts/plotOptions.arearange.zones
* @see https://api.highcharts.com/highstock/plotOptions.arearange.zones
*
* @implspec zones?: Array;
*
*/
@JSProperty("zones")
void setZones(Array value);
/**
*/
abstract class CompareBase extends JsEnum {
public static final CompareBase VALUE_0 = JsEnum.of(0);
public static final CompareBase VALUE_100 = JsEnum.of(100);
}
/**
*/
abstract class DashStyle extends JsEnum {
public static final DashStyle DASH = JsEnum.of("Dash");
public static final DashStyle DASHDOT = JsEnum.of("DashDot");
public static final DashStyle DOT = JsEnum.of("Dot");
public static final DashStyle LONGDASH = JsEnum.of("LongDash");
public static final DashStyle LONGDASHDOT = JsEnum.of("LongDashDot");
public static final DashStyle LONGDASHDOTDOT = JsEnum.of("LongDashDotDot");
public static final DashStyle SHORTDASH = JsEnum.of("ShortDash");
public static final DashStyle SHORTDASHDOT = JsEnum.of("ShortDashDot");
public static final DashStyle SHORTDASHDOTDOT = JsEnum.of("ShortDashDotDot");
public static final DashStyle SHORTDOT = JsEnum.of("ShortDot");
public static final DashStyle SOLID = JsEnum.of("Solid");
}
/**
*/
abstract class FindNearestPointBy extends JsEnum {
public static final FindNearestPointBy X = JsEnum.of("x");
public static final FindNearestPointBy XY = JsEnum.of("xy");
}
/**
*/
abstract class GapUnit extends JsEnum {
public static final GapUnit RELATIVE = JsEnum.of("relative");
public static final GapUnit VALUE = JsEnum.of("value");
}
/**
*/
abstract class Linecap extends JsEnum {
public static final Linecap BUTT = JsEnum.of("butt");
public static final Linecap ROUND = JsEnum.of("round");
public static final Linecap SQUARE = JsEnum.of("square");
}
/**
*/
@JSFunctor
@FunctionalInterface
interface PointDescriptionFormatter extends Any {
void apply();
}
/**
*/
abstract class PointIntervalUnit extends JsEnum {
public static final PointIntervalUnit DAY = JsEnum.of("day");
public static final PointIntervalUnit MONTH = JsEnum.of("month");
public static final PointIntervalUnit YEAR = JsEnum.of("year");
}
/**
*/
abstract class Step extends JsEnum {
public static final Step CENTER = JsEnum.of("center");
public static final Step LEFT = JsEnum.of("left");
public static final Step RIGHT = JsEnum.of("right");
}
}