com.github.fluorumlabs.disconnect.highcharts.PlotParetoOptions 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 org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;
/**
* (Highcharts) A pareto diagram is a type of chart that contains both bars and
* a line graph, where individual values are represented in descending order by
* bars, and the cumulative total is represented by the line.
*
* 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
pareto series are defined in plotOptions.pareto.
*
*
* -
* Options for one single series are given in the series instance array.
*
*
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto
*
*/
public interface PlotParetoOptions extends Any {
/**
* (Highcharts) 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.pareto.allowPointSelect
*
* @implspec allowPointSelect?: boolean;
*
*/
@JSProperty("allowPointSelect")
boolean getAllowPointSelect();
/**
* (Highcharts) 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.pareto.allowPointSelect
*
* @implspec allowPointSelect?: boolean;
*
*/
@JSProperty("allowPointSelect")
void setAllowPointSelect(boolean value);
/**
* (Highcharts) 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.pareto.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotParetoAnimationOptions);
*
*/
@JSProperty("animation")
@Nullable
Unknown getAnimation();
/**
* (Highcharts) 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.pareto.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotParetoAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(PlotParetoAnimationOptions value);
/**
* (Highcharts) 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.pareto.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotParetoAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(boolean value);
/**
* (Highcharts) 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.pareto.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotParetoAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(AnimationOptionsObject value);
/**
* (Highcharts) 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.pareto.animationLimit
*
* @implspec animationLimit?: number;
*
*/
@JSProperty("animationLimit")
double getAnimationLimit();
/**
* (Highcharts) 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.pareto.animationLimit
*
* @implspec animationLimit?: number;
*
*/
@JSProperty("animationLimit")
void setAnimationLimit(double value);
/**
* (Highcharts) 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.pareto.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts) 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.pareto.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts) 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.pareto.clip
*
* @implspec clip?: boolean;
*
*/
@JSProperty("clip")
boolean getClip();
/**
* (Highcharts) 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.pareto.clip
*
* @implspec clip?: boolean;
*
*/
@JSProperty("clip")
void setClip(boolean value);
/**
* (Highcharts) 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.pareto.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
@Nullable
Unknown getColor();
/**
* (Highcharts) 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.pareto.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(GradientColorObject value);
/**
* (Highcharts) 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.pareto.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(String value);
/**
* (Highcharts) 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.pareto.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(Any value);
/**
* (Highcharts) 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.pareto.colorIndex
*
* @implspec colorIndex?: number;
*
*/
@JSProperty("colorIndex")
double getColorIndex();
/**
* (Highcharts) 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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.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.pareto.connectNulls
* @see https://api.highcharts.com/highstock/plotOptions.pareto.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.pareto.connectNulls
* @see https://api.highcharts.com/highstock/plotOptions.pareto.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.pareto.connectors
*
* @implspec connectors?: PlotParetoConnectorsOptions;
*
*/
@JSProperty("connectors")
@Nullable
PlotParetoConnectorsOptions getConnectors();
/**
* (Gantt) Override Pathfinder connector options for a series. Requires
* Highcharts Gantt to be loaded.
*
* @see https://api.highcharts.com/gantt/plotOptions.pareto.connectors
*
* @implspec connectors?: PlotParetoConnectorsOptions;
*
*/
@JSProperty("connectors")
void setConnectors(PlotParetoConnectorsOptions 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.pareto.cropThreshold
* @see https://api.highcharts.com/highstock/plotOptions.pareto.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.pareto.cropThreshold
* @see https://api.highcharts.com/highstock/plotOptions.pareto.cropThreshold
*
* @implspec cropThreshold?: number;
*
*/
@JSProperty("cropThreshold")
void setCropThreshold(double value);
/**
* (Highcharts) 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.pareto.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
@Nullable
Unknown getCursor();
/**
* (Highcharts) 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.pareto.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
void setCursor(CursorType value);
/**
* (Highcharts) 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.pareto.cursor
*
* @implspec cursor?: (string|CursorType);
*
*/
@JSProperty("cursor")
void setCursor(String value);
/**
* (Highcharts) 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.pareto.dashStyle
*
* @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("dashStyle")
@Nullable
DashStyle getDashStyle();
/**
* (Highcharts) 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.pareto.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.pareto.dataGrouping
*
* @implspec dataGrouping?: PlotParetoDataGroupingOptions;
*
*/
@JSProperty("dataGrouping")
@Nullable
PlotParetoDataGroupingOptions 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.pareto.dataGrouping
*
* @implspec dataGrouping?: PlotParetoDataGroupingOptions;
*
*/
@JSProperty("dataGrouping")
void setDataGrouping(PlotParetoDataGroupingOptions value);
/**
* (Highcharts) Options for the series data labels, appearing next to each
* data point.
*
* Since v6.2.0, multiple data labels can be applied to each single point by
* defining them as an array of configs.
*
* In styled mode, the data labels can be styled with the
* .highcharts-data-label-box and .highcharts-data-label class names
* (see example).
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.dataLabels
*
* @implspec dataLabels?: PlotParetoDataLabelsOptions;
*
*/
@JSProperty("dataLabels")
@Nullable
PlotParetoDataLabelsOptions getDataLabels();
/**
* (Highcharts) Options for the series data labels, appearing next to each
* data point.
*
* Since v6.2.0, multiple data labels can be applied to each single point by
* defining them as an array of configs.
*
* In styled mode, the data labels can be styled with the
* .highcharts-data-label-box and .highcharts-data-label class names
* (see example).
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.dataLabels
*
* @implspec dataLabels?: PlotParetoDataLabelsOptions;
*
*/
@JSProperty("dataLabels")
void setDataLabels(PlotParetoDataLabelsOptions value);
/**
* (Highcharts) 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.pareto.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highcharts) 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.pareto.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
void setDescription(String value);
/**
* (Highcharts) 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.pareto.dragDrop
*
* @implspec dragDrop?: PlotParetoDragDropOptions;
*
*/
@JSProperty("dragDrop")
@Nullable
PlotParetoDragDropOptions getDragDrop();
/**
* (Highcharts) 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.pareto.dragDrop
*
* @implspec dragDrop?: PlotParetoDragDropOptions;
*
*/
@JSProperty("dragDrop")
void setDragDrop(PlotParetoDragDropOptions value);
/**
* (Highcharts) 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.pareto.enableMouseTracking
*
* @implspec enableMouseTracking?: boolean;
*
*/
@JSProperty("enableMouseTracking")
boolean getEnableMouseTracking();
/**
* (Highcharts) 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.pareto.enableMouseTracking
*
* @implspec enableMouseTracking?: boolean;
*
*/
@JSProperty("enableMouseTracking")
void setEnableMouseTracking(boolean value);
/**
* (Highcharts) 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.pareto.events
*
* @implspec events?: PlotParetoEventsOptions;
*
*/
@JSProperty("events")
@Nullable
PlotParetoEventsOptions getEvents();
/**
* (Highcharts) 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.pareto.events
*
* @implspec events?: PlotParetoEventsOptions;
*
*/
@JSProperty("events")
void setEvents(PlotParetoEventsOptions value);
/**
* (Highcharts) 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.pareto.exposeElementToA11y
*
* @implspec exposeElementToA11y?: boolean;
*
*/
@JSProperty("exposeElementToA11y")
boolean getExposeElementToA11y();
/**
* (Highcharts) 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.pareto.exposeElementToA11y
*
* @implspec exposeElementToA11y?: boolean;
*
*/
@JSProperty("exposeElementToA11y")
void setExposeElementToA11y(boolean 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.pareto.getExtremesFromAll
* @see https://api.highcharts.com/highstock/plotOptions.pareto.getExtremesFromAll
* @see https://api.highcharts.com/gantt/plotOptions.pareto.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.pareto.getExtremesFromAll
* @see https://api.highcharts.com/highstock/plotOptions.pareto.getExtremesFromAll
* @see https://api.highcharts.com/gantt/plotOptions.pareto.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.pareto.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.pareto.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.pareto.joinBy
*
* @implspec joinBy?: (string|Array);
*
*/
@JSProperty("joinBy")
void setJoinBy(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.pareto.label
* @see https://api.highcharts.com/highstock/plotOptions.pareto.label
* @see https://api.highcharts.com/gantt/plotOptions.pareto.label
*
* @implspec label?: PlotParetoLabelOptions;
*
*/
@JSProperty("label")
@Nullable
PlotParetoLabelOptions 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.pareto.label
* @see https://api.highcharts.com/highstock/plotOptions.pareto.label
* @see https://api.highcharts.com/gantt/plotOptions.pareto.label
*
* @implspec label?: PlotParetoLabelOptions;
*
*/
@JSProperty("label")
void setLabel(PlotParetoLabelOptions 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.pareto.linecap
* @see https://api.highcharts.com/highstock/plotOptions.pareto.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.pareto.linecap
* @see https://api.highcharts.com/highstock/plotOptions.pareto.linecap
*
* @implspec linecap?: ("butt"|"round"|"square");
*
*/
@JSProperty("linecap")
void setLinecap(Linecap value);
/**
* (Highcharts, Highstock) Pixel width of the graph line.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.lineWidth
* @see https://api.highcharts.com/highstock/plotOptions.pareto.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
double getLineWidth();
/**
* (Highcharts, Highstock) Pixel width of the graph line.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.lineWidth
* @see https://api.highcharts.com/highstock/plotOptions.pareto.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.pareto.linkedTo
* @see https://api.highcharts.com/highstock/plotOptions.pareto.linkedTo
* @see https://api.highcharts.com/gantt/plotOptions.pareto.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.pareto.linkedTo
* @see https://api.highcharts.com/highstock/plotOptions.pareto.linkedTo
* @see https://api.highcharts.com/gantt/plotOptions.pareto.linkedTo
*
* @implspec linkedTo?: string;
*
*/
@JSProperty("linkedTo")
void setLinkedTo(String value);
/**
* (Highcharts) 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.pareto.marker
*
* @implspec marker?: PlotParetoMarkerOptions;
*
*/
@JSProperty("marker")
@Nullable
PlotParetoMarkerOptions getMarker();
/**
* (Highcharts) 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.pareto.marker
*
* @implspec marker?: PlotParetoMarkerOptions;
*
*/
@JSProperty("marker")
void setMarker(PlotParetoMarkerOptions 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.pareto.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.pareto.navigatorOptions
*
* @implspec navigatorOptions?: PlotSeriesOptions;
*
*/
@JSProperty("navigatorOptions")
void setNavigatorOptions(PlotSeriesOptions value);
/**
* (Highcharts) Properties for each single point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.point
*
* @implspec point?: PlotParetoPointOptions;
*
*/
@JSProperty("point")
@Nullable
PlotParetoPointOptions getPoint();
/**
* (Highcharts) Properties for each single point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.point
*
* @implspec point?: PlotParetoPointOptions;
*
*/
@JSProperty("point")
void setPoint(PlotParetoPointOptions value);
/**
* (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
* individual series. Overrides the chart wide configuration.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.pointDescriptionFormatter
*
* @implspec pointDescriptionFormatter?: () => void;
*
*/
@JSProperty("pointDescriptionFormatter")
@Nullable
PointDescriptionFormatter getPointDescriptionFormatter();
/**
* (Highcharts) Same as accessibility.pointDescriptionFormatter, but for an
* individual series. Overrides the chart wide configuration.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.pointDescriptionFormatter
*
* @implspec pointDescriptionFormatter?: () => void;
*
*/
@JSProperty("pointDescriptionFormatter")
void setPointDescriptionFormatter(PointDescriptionFormatter value);
/**
* (Highcharts) 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.pareto.selected
*
* @implspec selected?: boolean;
*
*/
@JSProperty("selected")
boolean getSelected();
/**
* (Highcharts) 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.pareto.selected
*
* @implspec selected?: boolean;
*
*/
@JSProperty("selected")
void setSelected(boolean value);
/**
* (Highcharts) 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.pareto.showCheckbox
*
* @implspec showCheckbox?: boolean;
*
*/
@JSProperty("showCheckbox")
boolean getShowCheckbox();
/**
* (Highcharts) 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.pareto.showCheckbox
*
* @implspec showCheckbox?: boolean;
*
*/
@JSProperty("showCheckbox")
void setShowCheckbox(boolean value);
/**
* (Highcharts) 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.pareto.showInLegend
*
* @implspec showInLegend?: boolean;
*
*/
@JSProperty("showInLegend")
boolean getShowInLegend();
/**
* (Highcharts) 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.pareto.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.pareto.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.pareto.showInNavigator
*
* @implspec showInNavigator?: boolean;
*
*/
@JSProperty("showInNavigator")
void setShowInNavigator(boolean value);
/**
* (Highcharts) 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.pareto.skipKeyboardNavigation
*
* @implspec skipKeyboardNavigation?: boolean;
*
*/
@JSProperty("skipKeyboardNavigation")
boolean getSkipKeyboardNavigation();
/**
* (Highcharts) 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.pareto.skipKeyboardNavigation
*
* @implspec skipKeyboardNavigation?: boolean;
*
*/
@JSProperty("skipKeyboardNavigation")
void setSkipKeyboardNavigation(boolean value);
/**
* (Highcharts) A wrapper object for all the series options in specific
* states.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.states
*
* @implspec states?: PlotParetoStatesOptions;
*
*/
@JSProperty("states")
@Nullable
PlotParetoStatesOptions getStates();
/**
* (Highcharts) A wrapper object for all the series options in specific
* states.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.states
*
* @implspec states?: PlotParetoStatesOptions;
*
*/
@JSProperty("states")
void setStates(PlotParetoStatesOptions value);
/**
* (Highcharts) 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.pareto.stickyTracking
*
* @implspec stickyTracking?: boolean;
*
*/
@JSProperty("stickyTracking")
boolean getStickyTracking();
/**
* (Highcharts) 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.pareto.stickyTracking
*
* @implspec stickyTracking?: boolean;
*
*/
@JSProperty("stickyTracking")
void setStickyTracking(boolean value);
/**
* (Highcharts) 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.pareto.tooltip
*
* @implspec tooltip?: PlotParetoTooltipOptions;
*
*/
@JSProperty("tooltip")
@Nullable
PlotParetoTooltipOptions getTooltip();
/**
* (Highcharts) 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.pareto.tooltip
*
* @implspec tooltip?: PlotParetoTooltipOptions;
*
*/
@JSProperty("tooltip")
void setTooltip(PlotParetoTooltipOptions 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.pareto.turboThreshold
* @see https://api.highcharts.com/highstock/plotOptions.pareto.turboThreshold
* @see https://api.highcharts.com/gantt/plotOptions.pareto.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.pareto.turboThreshold
* @see https://api.highcharts.com/highstock/plotOptions.pareto.turboThreshold
* @see https://api.highcharts.com/gantt/plotOptions.pareto.turboThreshold
*
* @implspec turboThreshold?: number;
*
*/
@JSProperty("turboThreshold")
void setTurboThreshold(double value);
/**
* (Highcharts) Set the initial visibility of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
boolean getVisible();
/**
* (Highcharts) Set the initial visibility of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.pareto.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
void setVisible(boolean value);
/**
* (Highmaps) Higher zIndex than column series to draw line above shapes.
*
* @see https://api.highcharts.com/highmaps/plotOptions.pareto.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
double getZIndex();
/**
* (Highmaps) Higher zIndex than column series to draw line above shapes.
*
* @see https://api.highcharts.com/highmaps/plotOptions.pareto.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
void setZIndex(double 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 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();
}
}