• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• Series.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fluorumlabs.disconnect.highcharts.Series Maven / Gradle / Ivy

package com.github.fluorumlabs.disconnect.highcharts;

import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSBody;
import org.teavm.jso.JSProperty;

/**
 * This is the base series prototype that all other series types inherit from. A
 * new series is initialized either through the series option structure, or
 * after the chart is initialized, through Highcharts.Chart#addSeries.
 *
 * The object can be accessed in a number of ways. All series and point event
 * handlers give a reference to the series object. The chart object has a
 * series property that is a collection of all the chart's series. The point
 * objects and axis objects also have the same reference.
 *
 * Another way to reference the series programmatically is by id. Add an id in
 * the series configuration options, and get the series object by
 * Highcharts.Chart#get.
 *
 * Configuration options for the series are given in three levels. Options for
 * all series in a chart are given in the plotOptions.series object. Then
 * options for all series of a specific type are given in the plotOptions of
 * that type, for example plotOptions.line. Next, options for one single
 * series are given in the series array, or as arguments to chart.addSeries.
 *
 * The data in the series is stored in various arrays.
 *
 * 

 * 

 * First, series.options.data contains all the original config options for
 * each point whether added by options or methods like series.addPoint.
 *
 * 
 * 

 * Next, series.data contains those values converted to points, but in case
 * the series data length exceeds the cropThreshold, or if the data is
 * grouped, series.data doesn't contain all the points. It only contains the
 * points that have been created on demand.
 *
 * 
 * 

 * Then there's series.points that contains all currently visible point
 * objects. In case of cropping, the cropped-away points are not part of this
 * array. The series.points array starts at series.cropStart compared to
 * series.data and series.options.data. If however the series data is
 * grouped, these can't be correlated one to one.
 *
 * 
 * 

 * series.xData and series.processedXData contain clean x values,
 * equivalent to series.data and series.points.
 *
 * 
 * 

 * series.yData and series.processedYData contain clean y values,
 * equivalent to series.data and series.points.
 *
 * 
 * 
 */
public interface Series extends Any {
  /**
   * This is the base series prototype that all other series types inherit
   * from. A new series is initialized either through the series option
   * structure, or after the chart is initialized, through
   * Highcharts.Chart#addSeries.
   *
   * The object can be accessed in a number of ways. All series and point
   * event handlers give a reference to the series object. The chart object
   * has a series property that is a collection of all the chart's series. The
   * point objects and axis objects also have the same reference.
   *
   * Another way to reference the series programmatically is by id. Add an
   * id in the series configuration options, and get the series object by
   * Highcharts.Chart#get.
   *
   * Configuration options for the series are given in three levels. Options
   * for all series in a chart are given in the plotOptions.series object.
   * Then options for all series of a specific type are given in the
   * plotOptions of that type, for example plotOptions.line. Next, options
   * for one single series are given in the series array, or as arguments to
   * chart.addSeries.
   *
   * The data in the series is stored in various arrays.
   *
   * 

   * 

   * First, series.options.data contains all the original config options
   * for each point whether added by options or methods like
   * series.addPoint.
   *
   * 
   * 

   * Next, series.data contains those values converted to points, but in
   * case the series data length exceeds the cropThreshold, or if the data
   * is grouped, series.data doesn't contain all the points. It only
   * contains the points that have been created on demand.
   *
   * 
   * 

   * Then there's series.points that contains all currently visible point
   * objects. In case of cropping, the cropped-away points are not part of
   * this array. The series.points array starts at series.cropStart
   * compared to series.data and series.options.data. If however the
   * series data is grouped, these can't be correlated one to one.
   *
   * 
   * 

   * series.xData and series.processedXData contain clean x values,
   * equivalent to series.data and series.points.
   *
   * 
   * 

   * series.yData and series.processedYData contain clean y values,
   * equivalent to series.data and series.points.
   *
   * 
   * 
   * @param chart
   * The chart instance.
   *
   * @param options
   * The series options.
   *
   * @see https://api.highcharts.com/class-reference/Highcharts.Series#constructor
   *
   * @implspec constructor(chart: Chart, options: PlotSeriesOptions);
   *
   */
  @JSBody(
      params = {"chart", "options"},
      script = "return new Series(chart, options)"
  )
  static Series create(Chart chart, PlotSeriesOptions options) {
    throw new UnsupportedOperationException("Available only in JavaScript");
  }

  /**
   * Read only. The chart that the series belongs to.
   *
   * @implspec chart: Chart;
   *
   */
  @JSProperty("chart")
  Chart getChart();

  /**
   * Read only. The chart that the series belongs to.
   *
   * @implspec chart: Chart;
   *
   */
  @JSProperty("chart")
  void setChart(Chart value);

  /**
   * Read only. An array containing those values converted to points. In case
   * the series data length exceeds the cropThreshold, or if the data is
   * grouped, series.data doesn't contain all the points. Also, in case a
   * series is hidden, the data array may be empty. To access raw values,
   * series.options.data will always be up to date. Series.data only
   * contains the points that have been created on demand. To modify the data,
   * use Highcharts.Series#setData or Highcharts.Point#update.
   *
   * @implspec data: Array;
   *
   */
  @JSProperty("data")
  Array getData();

  /**
   * Read only. An array containing those values converted to points. In case
   * the series data length exceeds the cropThreshold, or if the data is
   * grouped, series.data doesn't contain all the points. Also, in case a
   * series is hidden, the data array may be empty. To access raw values,
   * series.options.data will always be up to date. Series.data only
   * contains the points that have been created on demand. To modify the data,
   * use Highcharts.Series#setData or Highcharts.Point#update.
   *
   * @implspec data: Array;
   *
   */
  @JSProperty("data")
  void setData(Array value);

  /**
   * The series name as given in the options. Defaults to "Series {n}".
   *
   * @implspec name: string;
   *
   */
  @JSProperty("name")
  String getName();

  /**
   * The series name as given in the options. Defaults to "Series {n}".
   *
   * @implspec name: string;
   *
   */
  @JSProperty("name")
  void setName(String value);

  /**
   * Read only. The series' current options. To update, use Series#update.
   *
   * @implspec options: PlotSeriesOptions;
   *
   */
  @JSProperty("options")
  PlotSeriesOptions getOptions();

  /**
   * Read only. The series' current options. To update, use Series#update.
   *
   * @implspec options: PlotSeriesOptions;
   *
   */
  @JSProperty("options")
  void setOptions(PlotSeriesOptions value);

  /**
   * An array containing all currently visible point objects. In case of
   * cropping, the cropped-away points are not part of this array. The
   * series.points array starts at series.cropStart compared to
   * series.data and series.options.data. If however the series data is
   * grouped, these can't be correlated one to one. To modify the data, use
   * Highcharts.Series#setData or Highcharts.Point#update.
   *
   * @implspec points: Array;
   *
   */
  @JSProperty("points")
  Array getPoints();

  /**
   * An array containing all currently visible point objects. In case of
   * cropping, the cropped-away points are not part of this array. The
   * series.points array starts at series.cropStart compared to
   * series.data and series.options.data. If however the series data is
   * grouped, these can't be correlated one to one. To modify the data, use
   * Highcharts.Series#setData or Highcharts.Point#update.
   *
   * @implspec points: Array;
   *
   */
  @JSProperty("points")
  void setPoints(Array value);

  /**
   * Read only. The series' selected state as set by Highcharts.Series#select.
   *
   * @implspec selected: boolean;
   *
   */
  @JSProperty("selected")
  boolean getSelected();

  /**
   * Read only. The series' selected state as set by Highcharts.Series#select.
   *
   * @implspec selected: boolean;
   *
   */
  @JSProperty("selected")
  void setSelected(boolean value);

  /**
   * Read only. The series' type, like "line", "area", "column" etc. The type
   * in the series options anc can be altered using Series#update.
   *
   * @implspec type: string;
   *
   */
  @JSProperty("type")
  String getType();

  /**
   * Read only. The series' type, like "line", "area", "column" etc. The type
   * in the series options anc can be altered using Series#update.
   *
   * @implspec type: string;
   *
   */
  @JSProperty("type")
  void setType(String value);

  /**
   * Read only. The series' visibility state as set by Series#show,
   * Series#hide, or in the initial configuration.
   *
   * @implspec visible: boolean;
   *
   */
  @JSProperty("visible")
  boolean getVisible();

  /**
   * Read only. The series' visibility state as set by Series#show,
   * Series#hide, or in the initial configuration.
   *
   * @implspec visible: boolean;
   *
   */
  @JSProperty("visible")
  void setVisible(boolean value);

  /**
   * Read only. The unique xAxis object associated with the series.
   *
   * @implspec xAxis: Axis;
   *
   */
  @JSProperty("xAxis")
  Axis getXAxis();

  /**
   * Read only. The unique xAxis object associated with the series.
   *
   * @implspec xAxis: Axis;
   *
   */
  @JSProperty("xAxis")
  void setXAxis(Axis value);

  /**
   * Read only. The unique yAxis object associated with the series.
   *
   * @implspec yAxis: Axis;
   *
   */
  @JSProperty("yAxis")
  Axis getYAxis();

  /**
   * Read only. The unique yAxis object associated with the series.
   *
   * @implspec yAxis: Axis;
   *
   */
  @JSProperty("yAxis")
  void setYAxis(Axis value);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(double options, boolean redraw, boolean shift);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Any options, boolean redraw, boolean shift);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Array options, boolean redraw, boolean shift);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Any options, boolean redraw);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Any options, boolean redraw, boolean shift, boolean animation);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(double options, boolean redraw, boolean shift, boolean animation);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(double options, boolean redraw, boolean shift, AnimationOptionsObject animation);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Any options);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Array options, boolean redraw, boolean shift, boolean animation);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Any options, boolean redraw, boolean shift, AnimationOptionsObject animation);

  /**
   * Add a point to the series after render time. The point can be added at
   * the end, or by giving it an X value, to the start or in the middle of the
   * series.
   *
   * @param options
   * The point options. If options is a single number, a point with
   * that y value is appended to the series. If it is an array, it will
   * be interpreted as x and y values respectively. If it is an object,
   * advanced options as outlined under series.data are applied.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When adding
   * more than one point, it is highly recommended that the redraw
   * option be set to false, and instead Chart#redraw is explicitly
   * called after the adding of points is finished. Otherwise, the
   * chart will redraw after adding each point.
   *
   * @param shift
   * If true, a point is shifted off the start of the series as one is
   * appended to the end.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @implspec addPoint(options: (number|object|Array<(number|string)>|null), redraw?: boolean, shift?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void addPoint(Array options, boolean redraw, boolean shift,
      AnimationOptionsObject animation);

  /**
   * Animate in the series. Called internally twice. First with the init
   * parameter set to true, which sets up the initial state of the animation.
   * Then when ready, it is called with the init parameter undefined, in
   * order to perform the actual animation. After the second run, the function
   * is removed.
   *
   * @param init
   * Initialize the animation.
   *
   * @implspec animate(init: boolean): void;
   *
   */
  void animate(boolean init);

  /**
   * Draw the graph. Called internally when rendering line-like series types.
   * The first time it generates the series.graph item and optionally other
   * series-wide items like series.area for area charts. On subsequent calls
   * these items are updated with new positions and attributes.
   *
   * @implspec drawGraph(): void;
   *
   */
  void drawGraph();

  /**
   * Draw the markers for line-like series types, and columns or other
   * graphical representation for Point objects for other series types. The
   * resulting element is typically stored as Point.graphic, and is created on
   * the first call and updated and moved on subsequent calls.
   *
   * @implspec drawPoints(): void;
   *
   */
  void drawPoints();

  /**
   * Get the series' color based on either the options or pulled from global
   * options.
   *
   * @implspec getColor(): void;
   *
   */
  void getColor();

  /**
   * Calculate Y extremes for the visible data. The result is set as dataMin
   * and dataMax on the Series item.
   *
   * @param yData
   * The data to inspect. Defaults to the current data within the
   * visible range.
   *
   * @implspec getExtremes(yData?: Array): void;
   *
   */
  void getExtremes();

  /**
   * Calculate Y extremes for the visible data. The result is set as dataMin
   * and dataMax on the Series item.
   *
   * @param yData
   * The data to inspect. Defaults to the current data within the
   * visible range.
   *
   * @implspec getExtremes(yData?: Array): void;
   *
   */
  void getExtremes(double[] yData);

  /**
   * Get the translation and scale for the plot area of this series.
   *
   * @implspec getPlotBox(): SeriesPlotBoxObject;
   *
   */
  SeriesPlotBoxObject getPlotBox();

  /**
   * Get the series' symbol based on either the options or pulled from global
   * options.
   *
   * @implspec getSymbol(): void;
   *
   */
  void getSymbol();

  /**
   * Return the series points with null points filtered out.
   *
   * @param points
   * The points to inspect, defaults to Series.points.
   *
   * @param insideOnly
   * Whether to inspect only the points that are inside the visible
   * view.
   *
   * @return The valid points.
   *
   * @implspec getValidPoints(points?: Array, insideOnly?: boolean): Array;
   *
   */
  Array getValidPoints();

  /**
   * Return the series points with null points filtered out.
   *
   * @param points
   * The points to inspect, defaults to Series.points.
   *
   * @param insideOnly
   * Whether to inspect only the points that are inside the visible
   * view.
   *
   * @return The valid points.
   *
   * @implspec getValidPoints(points?: Array, insideOnly?: boolean): Array;
   *
   */
  Array getValidPoints(Array points, boolean insideOnly);

  /**
   * Return the series points with null points filtered out.
   *
   * @param points
   * The points to inspect, defaults to Series.points.
   *
   * @param insideOnly
   * Whether to inspect only the points that are inside the visible
   * view.
   *
   * @return The valid points.
   *
   * @implspec getValidPoints(points?: Array, insideOnly?: boolean): Array;
   *
   */
  Array getValidPoints(Array points);

  /**
   * Hide the series if visible. If the chart.ignoreHiddenSeries option is
   * true, the chart is redrawn without this series.
   *
   * @fires Highcharts.Series#hide
   *
   * @see https://api.highcharts.com/class-reference/Highcharts.Series#hide
   *
   * @implspec hide(): void;
   *
   */
  void hide();

  /**
   * Get non-presentational attributes for a point. Used internally for both
   * styled mode and classic. Can be overridden for different series types.
   *
   * @param point
   * The Point to inspect.
   *
   * @param state
   * The state, can be either hover, select or undefined.
   *
   * @return A hash containing those attributes that are not settable from
   * CSS.
   *
   * @implspec markerAttribs(point: Point, state?: string): SVGAttributes;
   *
   */
  SVGAttributes markerAttribs(Point point, String state);

  /**
   * Get non-presentational attributes for a point. Used internally for both
   * styled mode and classic. Can be overridden for different series types.
   *
   * @param point
   * The Point to inspect.
   *
   * @param state
   * The state, can be either hover, select or undefined.
   *
   * @return A hash containing those attributes that are not settable from
   * CSS.
   *
   * @implspec markerAttribs(point: Point, state?: string): SVGAttributes;
   *
   */
  SVGAttributes markerAttribs(Point point);

  /**
   * Runs on mouse out of the series graphical items.
   *
   * @fires Highcharts.Series#mouseOut
   *
   * @implspec onMouseOut(): void;
   *
   */
  void onMouseOut();

  /**
   * Runs on mouse over the series graphical items.
   *
   * @fires Highcharts.Series#mouseOver
   *
   * @implspec onMouseOver(): void;
   *
   */
  void onMouseOver();

  /**
   * Remove a series and optionally redraw the chart.
   *
   * @param redraw
   * Whether to redraw the chart or wait for an explicit call to
   * Highcharts.Chart#redraw.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @param withEvent
   * Used internally, whether to fire the series remove event.
   *
   * @fires Highcharts.Series#remove
   *
   * @implspec remove(redraw?: boolean, animation?: (boolean|AnimationOptionsObject), withEvent?: boolean): void;
   *
   */
  void remove();

  /**
   * Remove a series and optionally redraw the chart.
   *
   * @param redraw
   * Whether to redraw the chart or wait for an explicit call to
   * Highcharts.Chart#redraw.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @param withEvent
   * Used internally, whether to fire the series remove event.
   *
   * @fires Highcharts.Series#remove
   *
   * @implspec remove(redraw?: boolean, animation?: (boolean|AnimationOptionsObject), withEvent?: boolean): void;
   *
   */
  void remove(boolean redraw, boolean animation);

  /**
   * Remove a series and optionally redraw the chart.
   *
   * @param redraw
   * Whether to redraw the chart or wait for an explicit call to
   * Highcharts.Chart#redraw.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @param withEvent
   * Used internally, whether to fire the series remove event.
   *
   * @fires Highcharts.Series#remove
   *
   * @implspec remove(redraw?: boolean, animation?: (boolean|AnimationOptionsObject), withEvent?: boolean): void;
   *
   */
  void remove(boolean redraw);

  /**
   * Remove a series and optionally redraw the chart.
   *
   * @param redraw
   * Whether to redraw the chart or wait for an explicit call to
   * Highcharts.Chart#redraw.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @param withEvent
   * Used internally, whether to fire the series remove event.
   *
   * @fires Highcharts.Series#remove
   *
   * @implspec remove(redraw?: boolean, animation?: (boolean|AnimationOptionsObject), withEvent?: boolean): void;
   *
   */
  void remove(boolean redraw, boolean animation, boolean withEvent);

  /**
   * Remove a series and optionally redraw the chart.
   *
   * @param redraw
   * Whether to redraw the chart or wait for an explicit call to
   * Highcharts.Chart#redraw.
   *
   * @param animation
   * Whether to apply animation, and optionally animation
   * configuration.
   *
   * @param withEvent
   * Used internally, whether to fire the series remove event.
   *
   * @fires Highcharts.Series#remove
   *
   * @implspec remove(redraw?: boolean, animation?: (boolean|AnimationOptionsObject), withEvent?: boolean): void;
   *
   */
  void remove(boolean redraw, AnimationOptionsObject animation, boolean withEvent);

  /**
   * Remove a point from the series. Unlike the Highcharts.Point#remove
   * method, this can also be done on a point that is not instanciated because
   * it is outside the view or subject to Highstock data grouping.
   *
   * @param i
   * The index of the point in the data array.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When
   * removing more than one point, it is highly recommended that the
   * redraw option be set to false, and instead
   * Highcharts.Chart#redraw is explicitly called after the adding of
   * points is finished.
   *
   * @param animation
   * Whether and optionally how the series should be animated.
   *
   * @fires Highcharts.Point#remove
   *
   * @implspec removePoint(i: number, redraw?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void removePoint(double i);

  /**
   * Remove a point from the series. Unlike the Highcharts.Point#remove
   * method, this can also be done on a point that is not instanciated because
   * it is outside the view or subject to Highstock data grouping.
   *
   * @param i
   * The index of the point in the data array.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When
   * removing more than one point, it is highly recommended that the
   * redraw option be set to false, and instead
   * Highcharts.Chart#redraw is explicitly called after the adding of
   * points is finished.
   *
   * @param animation
   * Whether and optionally how the series should be animated.
   *
   * @fires Highcharts.Point#remove
   *
   * @implspec removePoint(i: number, redraw?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void removePoint(double i, boolean redraw);

  /**
   * Remove a point from the series. Unlike the Highcharts.Point#remove
   * method, this can also be done on a point that is not instanciated because
   * it is outside the view or subject to Highstock data grouping.
   *
   * @param i
   * The index of the point in the data array.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When
   * removing more than one point, it is highly recommended that the
   * redraw option be set to false, and instead
   * Highcharts.Chart#redraw is explicitly called after the adding of
   * points is finished.
   *
   * @param animation
   * Whether and optionally how the series should be animated.
   *
   * @fires Highcharts.Point#remove
   *
   * @implspec removePoint(i: number, redraw?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void removePoint(double i, boolean redraw, AnimationOptionsObject animation);

  /**
   * Remove a point from the series. Unlike the Highcharts.Point#remove
   * method, this can also be done on a point that is not instanciated because
   * it is outside the view or subject to Highstock data grouping.
   *
   * @param i
   * The index of the point in the data array.
   *
   * @param redraw
   * Whether to redraw the chart after the point is added. When
   * removing more than one point, it is highly recommended that the
   * redraw option be set to false, and instead
   * Highcharts.Chart#redraw is explicitly called after the adding of
   * points is finished.
   *
   * @param animation
   * Whether and optionally how the series should be animated.
   *
   * @fires Highcharts.Point#remove
   *
   * @implspec removePoint(i: number, redraw?: boolean, animation?: (boolean|AnimationOptionsObject)): void;
   *
   */
  void removePoint(double i, boolean redraw, boolean animation);

  /**
   * Render the graph and markers. Called internally when first rendering and
   * later when redrawing the chart. This function can be extended in plugins,
   * but normally shouldn't be called directly.
   *
   * @implspec render(): void;
   *
   */
  void render();

  /**
   * Select or unselect the series. This means its selected property is set,
   * the checkbox in the legend is toggled and when selected, the series is
   * returned by the Highcharts.Chart#getSelectedSeries function.
   *
   * @param selected
   * True to select the series, false to unselect. If undefined, the
   * selection state is toggled.
   *
   * @fires Highcharts.Series#select
   * @fires Highcharts.Series#unselect
   *
   * @implspec select(selected?: boolean): void;
   *
   */
  void select();

  /**
   * Select or unselect the series. This means its selected property is set,
   * the checkbox in the legend is toggled and when selected, the series is
   * returned by the Highcharts.Chart#getSelectedSeries function.
   *
   * @param selected
   * True to select the series, false to unselect. If undefined, the
   * selection state is toggled.
   *
   * @fires Highcharts.Series#select
   * @fires Highcharts.Series#unselect
   *
   * @implspec select(selected?: boolean): void;
   *
   */
  void select(boolean selected);

  /**
   * Apply a new set of data to the series and optionally redraw it. The new
   * data array is passed by reference (except in case of updatePoints), and
   * may later be mutated when updating the chart data.
   *
   * Note the difference in behaviour when setting the same amount of points,
   * or a different amount of points, as handled by the updatePoints
   * parameter.
   *
   * @param data
   * Takes an array of data in the same format as described under
   * series.{type}.data for the given series type, for example a line
   * series would take data in the form described under
   * series.line.data.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call Chart#redraw after.
   *
   * @param animation
   * When the updated data is the same length as the existing data,
   * points will be updated by default, and animation visualizes how
   * the points are changed. Set false to disable animation, or a
   * configuration object to set duration or easing.
   *
   * @param updatePoints
   * When the updated data is the same length as the existing data, or
   * points can be matched by X values, points will be updated instead
   * of replaced. This allows updating with animation and performs
   * better. In this case, the original array is not passed by
   * reference. Set false to prevent.
   *
   * @see https://api.highcharts.com/class-reference/Highcharts.Series#setData
   *
   * @implspec setData(data: Array, redraw?: boolean, animation?: AnimationOptionsObject, updatePoints?: boolean): void;
   *
   */
  void setData(Array data, boolean redraw, AnimationOptionsObject animation);

  /**
   * Apply a new set of data to the series and optionally redraw it. The new
   * data array is passed by reference (except in case of updatePoints), and
   * may later be mutated when updating the chart data.
   *
   * Note the difference in behaviour when setting the same amount of points,
   * or a different amount of points, as handled by the updatePoints
   * parameter.
   *
   * @param data
   * Takes an array of data in the same format as described under
   * series.{type}.data for the given series type, for example a line
   * series would take data in the form described under
   * series.line.data.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call Chart#redraw after.
   *
   * @param animation
   * When the updated data is the same length as the existing data,
   * points will be updated by default, and animation visualizes how
   * the points are changed. Set false to disable animation, or a
   * configuration object to set duration or easing.
   *
   * @param updatePoints
   * When the updated data is the same length as the existing data, or
   * points can be matched by X values, points will be updated instead
   * of replaced. This allows updating with animation and performs
   * better. In this case, the original array is not passed by
   * reference. Set false to prevent.
   *
   * @see https://api.highcharts.com/class-reference/Highcharts.Series#setData
   *
   * @implspec setData(data: Array, redraw?: boolean, animation?: AnimationOptionsObject, updatePoints?: boolean): void;
   *
   */
  void setData(Array data, boolean redraw, AnimationOptionsObject animation,
      boolean updatePoints);

  /**
   * Apply a new set of data to the series and optionally redraw it. The new
   * data array is passed by reference (except in case of updatePoints), and
   * may later be mutated when updating the chart data.
   *
   * Note the difference in behaviour when setting the same amount of points,
   * or a different amount of points, as handled by the updatePoints
   * parameter.
   *
   * @param data
   * Takes an array of data in the same format as described under
   * series.{type}.data for the given series type, for example a line
   * series would take data in the form described under
   * series.line.data.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call Chart#redraw after.
   *
   * @param animation
   * When the updated data is the same length as the existing data,
   * points will be updated by default, and animation visualizes how
   * the points are changed. Set false to disable animation, or a
   * configuration object to set duration or easing.
   *
   * @param updatePoints
   * When the updated data is the same length as the existing data, or
   * points can be matched by X values, points will be updated instead
   * of replaced. This allows updating with animation and performs
   * better. In this case, the original array is not passed by
   * reference. Set false to prevent.
   *
   * @see https://api.highcharts.com/class-reference/Highcharts.Series#setData
   *
   * @implspec setData(data: Array, redraw?: boolean, animation?: AnimationOptionsObject, updatePoints?: boolean): void;
   *
   */
  void setData(Array data, boolean redraw);

  /**
   * Set the state of the series. Called internally on mouse interaction
   * operations, but it can also be called directly to visually highlight a
   * series.
   *
   * @param state
   * Can be either hover or undefined to set to normal state.
   *
   * @implspec setState(state?: string): void;
   *
   */
  void setState();

  /**
   * Set the state of the series. Called internally on mouse interaction
   * operations, but it can also be called directly to visually highlight a
   * series.
   *
   * @param state
   * Can be either hover or undefined to set to normal state.
   *
   * @implspec setState(state?: string): void;
   *
   */
  void setState(String state);

  /**
   * Show or hide the series.
   *
   * @param visible
   * True to show the series, false to hide. If undefined, the
   * visibility is toggled.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call chart.redraw() after.
   *
   * @fires Highcharts.Series#hide
   * @fires Highcharts.Series#show
   *
   * @implspec setVisible(visible?: boolean, redraw?: boolean): void;
   *
   */
  void setVisible();

  /**
   * Show or hide the series.
   *
   * @param visible
   * True to show the series, false to hide. If undefined, the
   * visibility is toggled.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call chart.redraw() after.
   *
   * @fires Highcharts.Series#hide
   * @fires Highcharts.Series#show
   *
   * @implspec setVisible(visible?: boolean, redraw?: boolean): void;
   *
   */
  void setVisible(boolean visible, boolean redraw);

  /**
   * Show the series if hidden.
   *
   * @fires Highcharts.Series#show
   *
   * @implspec show(): void;
   *
   */
  void show();

  /**
   * Translate data points from raw data values to chart specific positioning
   * data needed later in the drawPoints and drawGraph functions. This
   * function can be overridden in plugins and custom series type
   * implementations.
   *
   * @implspec translate(): void;
   *
   */
  void translate();

  /**
   * Update the series with a new set of options. For a clean and precise
   * handling of new options, all methods and elements from the series are
   * removed, and it is initiated from scratch. Therefore, this method is more
   * performance expensive than some other utility methods like Series#setData
   * or Series#setVisible.
   *
   * @param options
   * New options that will be merged with the series' existing options.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call Chart#redraw after.
   *
   * @fires Highcharts.Series#afterUpdate
   *
   * @implspec update(options: SeriesOptions, redraw?: boolean): void;
   *
   */
  void update(SeriesOptions options, boolean redraw);

  /**
   * Update the series with a new set of options. For a clean and precise
   * handling of new options, all methods and elements from the series are
   * removed, and it is initiated from scratch. Therefore, this method is more
   * performance expensive than some other utility methods like Series#setData
   * or Series#setVisible.
   *
   * @param options
   * New options that will be merged with the series' existing options.
   *
   * @param redraw
   * Whether to redraw the chart after the series is altered. If doing
   * more operations on the chart, it is a good idea to set redraw to
   * false and call Chart#redraw after.
   *
   * @fires Highcharts.Series#afterUpdate
   *
   * @implspec update(options: SeriesOptions, redraw?: boolean): void;
   *
   */
  void update(SeriesOptions options);
}