All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 0.1.0-alpha2
Show newest version
package com.github.fluorumlabs.disconnect.highcharts;

import com.github.fluorumlabs.disconnect.types.IntRecord;
import js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import js.web.dom.HTMLElement;
import org.teavm.jso.JSProperty;

import javax.annotation.Nullable;

/**
 * (Highcharts, Highstock, Highmaps) The Data module provides a simplified
 * interface for adding data to a chart from sources like CVS, HTML tables or
 * grid views. See also the tutorial article on the Data module.
 *
 * It requires the modules/data.js file to be loaded.
 *
 * Please note that the default way of adding data in Highcharts, without the
 * need of a module, is through the series.data option.
 *
 * @see https://api.highcharts.com/highcharts/data
 * @see https://api.highcharts.com/highstock/data
 * @see https://api.highcharts.com/highmaps/data
 *
 */
public interface DataOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) A callback function to modify the CSV
   * before parsing it. Return the modified string.
   *
   * @see https://api.highcharts.com/highcharts/data.beforeParse
   * @see https://api.highcharts.com/highstock/data.beforeParse
   * @see https://api.highcharts.com/highmaps/data.beforeParse
   *
   * @implspec beforeParse?: DataBeforeParseCallbackFunction;
   *
   */
  @JSProperty("beforeParse")
  @Nullable
  DataBeforeParseCallbackFunction getBeforeParse();

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to modify the CSV
   * before parsing it. Return the modified string.
   *
   * @see https://api.highcharts.com/highcharts/data.beforeParse
   * @see https://api.highcharts.com/highstock/data.beforeParse
   * @see https://api.highcharts.com/highmaps/data.beforeParse
   *
   * @implspec beforeParse?: DataBeforeParseCallbackFunction;
   *
   */
  @JSProperty("beforeParse")
  void setBeforeParse(DataBeforeParseCallbackFunction value);

  /**
   * (Highcharts, Highstock, Highmaps) A two-dimensional array representing
   * the input data on tabular form. This input can be used when the data is
   * already parsed, for example from a grid view component. Each cell can be
   * a string or number. If not switchRowsAndColumns is set, the columns are
   * interpreted as series.
   *
   * @see https://api.highcharts.com/highcharts/data.columns
   * @see https://api.highcharts.com/highstock/data.columns
   * @see https://api.highcharts.com/highmaps/data.columns
   *
   * @implspec columns?: Array<Array>;
   *
   */
  @JSProperty("columns")
  @Nullable
  Array> getColumns();

  /**
   * (Highcharts, Highstock, Highmaps) A two-dimensional array representing
   * the input data on tabular form. This input can be used when the data is
   * already parsed, for example from a grid view component. Each cell can be
   * a string or number. If not switchRowsAndColumns is set, the columns are
   * interpreted as series.
   *
   * @see https://api.highcharts.com/highcharts/data.columns
   * @see https://api.highcharts.com/highstock/data.columns
   * @see https://api.highcharts.com/highmaps/data.columns
   *
   * @implspec columns?: Array<Array>;
   *
   */
  @JSProperty("columns")
  void setColumns(Array> value);

  /**
   * (Highcharts, Highstock, Highmaps) A URL to a remote JSON dataset,
   * structured as a column array. Will be fetched when the chart is created
   * using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.columnsURL
   * @see https://api.highcharts.com/highstock/data.columnsURL
   * @see https://api.highcharts.com/highmaps/data.columnsURL
   *
   * @implspec columnsURL?: string;
   *
   */
  @JSProperty("columnsURL")
  @Nullable
  String getColumnsURL();

  /**
   * (Highcharts, Highstock, Highmaps) A URL to a remote JSON dataset,
   * structured as a column array. Will be fetched when the chart is created
   * using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.columnsURL
   * @see https://api.highcharts.com/highstock/data.columnsURL
   * @see https://api.highcharts.com/highmaps/data.columnsURL
   *
   * @implspec columnsURL?: string;
   *
   */
  @JSProperty("columnsURL")
  void setColumnsURL(String value);

  /**
   * (Highcharts, Highstock, Highmaps) The callback that is evaluated when the
   * data is finished loading, optionally from an external source, and parsed.
   * The first argument passed is a finished chart options object, containing
   * the series. These options can be extended with additional options and
   * passed directly to the chart constructor.
   *
   * @see https://api.highcharts.com/highcharts/data.complete
   * @see https://api.highcharts.com/highstock/data.complete
   * @see https://api.highcharts.com/highmaps/data.complete
   *
   * @implspec complete?: DataCompleteCallbackFunction;
   *
   */
  @JSProperty("complete")
  @Nullable
  DataCompleteCallbackFunction getComplete();

  /**
   * (Highcharts, Highstock, Highmaps) The callback that is evaluated when the
   * data is finished loading, optionally from an external source, and parsed.
   * The first argument passed is a finished chart options object, containing
   * the series. These options can be extended with additional options and
   * passed directly to the chart constructor.
   *
   * @see https://api.highcharts.com/highcharts/data.complete
   * @see https://api.highcharts.com/highstock/data.complete
   * @see https://api.highcharts.com/highmaps/data.complete
   *
   * @implspec complete?: DataCompleteCallbackFunction;
   *
   */
  @JSProperty("complete")
  void setComplete(DataCompleteCallbackFunction value);

  /**
   * (Highcharts, Highstock, Highmaps) A comma delimited string to be parsed.
   * Related options are startRow, endRow, startColumn and endColumn to
   * delimit what part of the table is used. The lineDelimiter and
   * itemDelimiter options define the CSV delimiter formats.
   *
   * The built-in CSV parser doesn't support all flavours of CSV, so in some
   * cases it may be necessary to use an external CSV parser. See this example
   * of parsing CSV through the MIT licensed Papa Parse library.
   *
   * @see https://api.highcharts.com/highcharts/data.csv
   * @see https://api.highcharts.com/highstock/data.csv
   * @see https://api.highcharts.com/highmaps/data.csv
   *
   * @implspec csv?: string;
   *
   */
  @JSProperty("csv")
  @Nullable
  String getCsv();

  /**
   * (Highcharts, Highstock, Highmaps) A comma delimited string to be parsed.
   * Related options are startRow, endRow, startColumn and endColumn to
   * delimit what part of the table is used. The lineDelimiter and
   * itemDelimiter options define the CSV delimiter formats.
   *
   * The built-in CSV parser doesn't support all flavours of CSV, so in some
   * cases it may be necessary to use an external CSV parser. See this example
   * of parsing CSV through the MIT licensed Papa Parse library.
   *
   * @see https://api.highcharts.com/highcharts/data.csv
   * @see https://api.highcharts.com/highstock/data.csv
   * @see https://api.highcharts.com/highmaps/data.csv
   *
   * @implspec csv?: string;
   *
   */
  @JSProperty("csv")
  void setCsv(String value);

  /**
   * (Highcharts, Highstock, Highmaps) An URL to a remote CSV dataset. Will be
   * fetched when the chart is created using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.csvURL
   * @see https://api.highcharts.com/highstock/data.csvURL
   * @see https://api.highcharts.com/highmaps/data.csvURL
   *
   * @implspec csvURL?: string;
   *
   */
  @JSProperty("csvURL")
  @Nullable
  String getCsvURL();

  /**
   * (Highcharts, Highstock, Highmaps) An URL to a remote CSV dataset. Will be
   * fetched when the chart is created using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.csvURL
   * @see https://api.highcharts.com/highstock/data.csvURL
   * @see https://api.highcharts.com/highmaps/data.csvURL
   *
   * @implspec csvURL?: string;
   *
   */
  @JSProperty("csvURL")
  void setCsvURL(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Sets the refresh rate for data polling
   * when importing remote dataset by setting data.csvURL, data.rowsURL,
   * data.columnsURL, or data.googleSpreadsheetKey.
   *
   * Note that polling must be enabled by setting data.enablePolling to true.
   *
   * The value is the number of seconds between pollings. It cannot be set to
   * less than 1 second.
   *
   * @see https://api.highcharts.com/highcharts/data.dataRefreshRate
   * @see https://api.highcharts.com/highstock/data.dataRefreshRate
   * @see https://api.highcharts.com/highmaps/data.dataRefreshRate
   *
   * @implspec dataRefreshRate?: number;
   *
   */
  @JSProperty("dataRefreshRate")
  double getDataRefreshRate();

  /**
   * (Highcharts, Highstock, Highmaps) Sets the refresh rate for data polling
   * when importing remote dataset by setting data.csvURL, data.rowsURL,
   * data.columnsURL, or data.googleSpreadsheetKey.
   *
   * Note that polling must be enabled by setting data.enablePolling to true.
   *
   * The value is the number of seconds between pollings. It cannot be set to
   * less than 1 second.
   *
   * @see https://api.highcharts.com/highcharts/data.dataRefreshRate
   * @see https://api.highcharts.com/highstock/data.dataRefreshRate
   * @see https://api.highcharts.com/highmaps/data.dataRefreshRate
   *
   * @implspec dataRefreshRate?: number;
   *
   */
  @JSProperty("dataRefreshRate")
  void setDataRefreshRate(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Which of the predefined date formats in
   * Date.prototype.dateFormats to use to parse date values. Defaults to a
   * best guess based on what format gives valid and ordered dates. Valid
   * options include: YYYY/mm/dd, dd/mm/YYYY, mm/dd/YYYY, dd/mm/YY,
   * mm/dd/YY.
   *
   * @see https://api.highcharts.com/highcharts/data.dateFormat
   * @see https://api.highcharts.com/highstock/data.dateFormat
   * @see https://api.highcharts.com/highmaps/data.dateFormat
   *
   * @implspec dateFormat?: ("dd/mm/YY"|"dd/mm/YYYY"|"dd/mm/YYYY"|"mm/dd/YY"|"mm/dd/YYYY"|"YYYY/mm/dd");
   *
   */
  @JSProperty("dateFormat")
  @Nullable
  DateFormat getDateFormat();

  /**
   * (Highcharts, Highstock, Highmaps) Which of the predefined date formats in
   * Date.prototype.dateFormats to use to parse date values. Defaults to a
   * best guess based on what format gives valid and ordered dates. Valid
   * options include: YYYY/mm/dd, dd/mm/YYYY, mm/dd/YYYY, dd/mm/YY,
   * mm/dd/YY.
   *
   * @see https://api.highcharts.com/highcharts/data.dateFormat
   * @see https://api.highcharts.com/highstock/data.dateFormat
   * @see https://api.highcharts.com/highmaps/data.dateFormat
   *
   * @implspec dateFormat?: ("dd/mm/YY"|"dd/mm/YYYY"|"dd/mm/YYYY"|"mm/dd/YY"|"mm/dd/YYYY"|"YYYY/mm/dd");
   *
   */
  @JSProperty("dateFormat")
  void setDateFormat(DateFormat value);

  /**
   * (Highcharts, Highstock, Highmaps) The decimal point used for parsing
   * numbers in the CSV.
   *
   * If both this and data.delimiter is set to undefined, the parser will
   * attempt to deduce the decimal point automatically.
   *
   * @see https://api.highcharts.com/highcharts/data.decimalPoint
   * @see https://api.highcharts.com/highstock/data.decimalPoint
   * @see https://api.highcharts.com/highmaps/data.decimalPoint
   *
   * @implspec decimalPoint?: string;
   *
   */
  @JSProperty("decimalPoint")
  @Nullable
  String getDecimalPoint();

  /**
   * (Highcharts, Highstock, Highmaps) The decimal point used for parsing
   * numbers in the CSV.
   *
   * If both this and data.delimiter is set to undefined, the parser will
   * attempt to deduce the decimal point automatically.
   *
   * @see https://api.highcharts.com/highcharts/data.decimalPoint
   * @see https://api.highcharts.com/highstock/data.decimalPoint
   * @see https://api.highcharts.com/highmaps/data.decimalPoint
   *
   * @implspec decimalPoint?: string;
   *
   */
  @JSProperty("decimalPoint")
  void setDecimalPoint(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Enables automatic refetching of remote
   * datasets every n seconds (defined by setting data.dataRefreshRate).
   *
   * Only works when either data.csvURL, data.rowsURL, data.columnsURL, or
   * data.googleSpreadsheetKey.
   *
   * @see https://api.highcharts.com/highcharts/data.enablePolling
   * @see https://api.highcharts.com/highstock/data.enablePolling
   * @see https://api.highcharts.com/highmaps/data.enablePolling
   *
   * @implspec enablePolling?: boolean;
   *
   */
  @JSProperty("enablePolling")
  boolean getEnablePolling();

  /**
   * (Highcharts, Highstock, Highmaps) Enables automatic refetching of remote
   * datasets every n seconds (defined by setting data.dataRefreshRate).
   *
   * Only works when either data.csvURL, data.rowsURL, data.columnsURL, or
   * data.googleSpreadsheetKey.
   *
   * @see https://api.highcharts.com/highcharts/data.enablePolling
   * @see https://api.highcharts.com/highstock/data.enablePolling
   * @see https://api.highcharts.com/highmaps/data.enablePolling
   *
   * @implspec enablePolling?: boolean;
   *
   */
  @JSProperty("enablePolling")
  void setEnablePolling(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the last column
   * (indexed by 0) to use. Defaults to the last column containing data.
   *
   * @see https://api.highcharts.com/highcharts/data.endColumn
   * @see https://api.highcharts.com/highstock/data.endColumn
   * @see https://api.highcharts.com/highmaps/data.endColumn
   *
   * @implspec endColumn?: number;
   *
   */
  @JSProperty("endColumn")
  double getEndColumn();

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the last column
   * (indexed by 0) to use. Defaults to the last column containing data.
   *
   * @see https://api.highcharts.com/highcharts/data.endColumn
   * @see https://api.highcharts.com/highstock/data.endColumn
   * @see https://api.highcharts.com/highmaps/data.endColumn
   *
   * @implspec endColumn?: number;
   *
   */
  @JSProperty("endColumn")
  void setEndColumn(double value);

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the last row
   * (indexed by 0) to use. Defaults to the last row containing data.
   *
   * @see https://api.highcharts.com/highcharts/data.endRow
   * @see https://api.highcharts.com/highstock/data.endRow
   * @see https://api.highcharts.com/highmaps/data.endRow
   *
   * @implspec endRow?: number;
   *
   */
  @JSProperty("endRow")
  double getEndRow();

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the last row
   * (indexed by 0) to use. Defaults to the last row containing data.
   *
   * @see https://api.highcharts.com/highcharts/data.endRow
   * @see https://api.highcharts.com/highstock/data.endRow
   * @see https://api.highcharts.com/highmaps/data.endRow
   *
   * @implspec endRow?: number;
   *
   */
  @JSProperty("endRow")
  void setEndRow(double value);

  /**
   * (Highcharts, Highstock, Gantt) Whether to use the first row in the data
   * set as series names.
   *
   * @see https://api.highcharts.com/highcharts/data.firstRowAsNames
   * @see https://api.highcharts.com/highstock/data.firstRowAsNames
   * @see https://api.highcharts.com/gantt/data.firstRowAsNames
   *
   * @implspec firstRowAsNames?: boolean;
   *
   */
  @JSProperty("firstRowAsNames")
  boolean getFirstRowAsNames();

  /**
   * (Highcharts, Highstock, Gantt) Whether to use the first row in the data
   * set as series names.
   *
   * @see https://api.highcharts.com/highcharts/data.firstRowAsNames
   * @see https://api.highcharts.com/highstock/data.firstRowAsNames
   * @see https://api.highcharts.com/gantt/data.firstRowAsNames
   *
   * @implspec firstRowAsNames?: boolean;
   *
   */
  @JSProperty("firstRowAsNames")
  void setFirstRowAsNames(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) The key for a Google Spreadsheet to
   * load. See general information on GS.
   *
   * @see https://api.highcharts.com/highcharts/data.googleSpreadsheetKey
   * @see https://api.highcharts.com/highstock/data.googleSpreadsheetKey
   * @see https://api.highcharts.com/highmaps/data.googleSpreadsheetKey
   *
   * @implspec googleSpreadsheetKey?: string;
   *
   */
  @JSProperty("googleSpreadsheetKey")
  @Nullable
  String getGoogleSpreadsheetKey();

  /**
   * (Highcharts, Highstock, Highmaps) The key for a Google Spreadsheet to
   * load. See general information on GS.
   *
   * @see https://api.highcharts.com/highcharts/data.googleSpreadsheetKey
   * @see https://api.highcharts.com/highstock/data.googleSpreadsheetKey
   * @see https://api.highcharts.com/highmaps/data.googleSpreadsheetKey
   *
   * @implspec googleSpreadsheetKey?: string;
   *
   */
  @JSProperty("googleSpreadsheetKey")
  void setGoogleSpreadsheetKey(String value);

  /**
   * (Highcharts, Highstock, Highmaps) The Google Spreadsheet worksheet to use
   * in combination with googleSpreadsheetKey. The available id's from your
   * sheet can be read from
   * https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic.
   *
   * @see https://api.highcharts.com/highcharts/data.googleSpreadsheetWorksheet
   * @see https://api.highcharts.com/highstock/data.googleSpreadsheetWorksheet
   * @see https://api.highcharts.com/highmaps/data.googleSpreadsheetWorksheet
   *
   * @implspec googleSpreadsheetWorksheet?: string;
   *
   */
  @JSProperty("googleSpreadsheetWorksheet")
  @Nullable
  String getGoogleSpreadsheetWorksheet();

  /**
   * (Highcharts, Highstock, Highmaps) The Google Spreadsheet worksheet to use
   * in combination with googleSpreadsheetKey. The available id's from your
   * sheet can be read from
   * https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic.
   *
   * @see https://api.highcharts.com/highcharts/data.googleSpreadsheetWorksheet
   * @see https://api.highcharts.com/highstock/data.googleSpreadsheetWorksheet
   * @see https://api.highcharts.com/highmaps/data.googleSpreadsheetWorksheet
   *
   * @implspec googleSpreadsheetWorksheet?: string;
   *
   */
  @JSProperty("googleSpreadsheetWorksheet")
  void setGoogleSpreadsheetWorksheet(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Item or cell delimiter for parsing CSV.
   * Defaults to the tab character \t if a tab character is found in the CSV
   * string, if not it defaults to ,.
   *
   * If this is set to false or undefined, the parser will attempt to deduce
   * the delimiter automatically.
   *
   * @see https://api.highcharts.com/highcharts/data.itemDelimiter
   * @see https://api.highcharts.com/highstock/data.itemDelimiter
   * @see https://api.highcharts.com/highmaps/data.itemDelimiter
   *
   * @implspec itemDelimiter?: string;
   *
   */
  @JSProperty("itemDelimiter")
  @Nullable
  String getItemDelimiter();

  /**
   * (Highcharts, Highstock, Highmaps) Item or cell delimiter for parsing CSV.
   * Defaults to the tab character \t if a tab character is found in the CSV
   * string, if not it defaults to ,.
   *
   * If this is set to false or undefined, the parser will attempt to deduce
   * the delimiter automatically.
   *
   * @see https://api.highcharts.com/highcharts/data.itemDelimiter
   * @see https://api.highcharts.com/highstock/data.itemDelimiter
   * @see https://api.highcharts.com/highmaps/data.itemDelimiter
   *
   * @implspec itemDelimiter?: string;
   *
   */
  @JSProperty("itemDelimiter")
  void setItemDelimiter(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Line delimiter for parsing CSV.
   *
   * @see https://api.highcharts.com/highcharts/data.lineDelimiter
   * @see https://api.highcharts.com/highstock/data.lineDelimiter
   * @see https://api.highcharts.com/highmaps/data.lineDelimiter
   *
   * @implspec lineDelimiter?: string;
   *
   */
  @JSProperty("lineDelimiter")
  @Nullable
  String getLineDelimiter();

  /**
   * (Highcharts, Highstock, Highmaps) Line delimiter for parsing CSV.
   *
   * @see https://api.highcharts.com/highcharts/data.lineDelimiter
   * @see https://api.highcharts.com/highstock/data.lineDelimiter
   * @see https://api.highcharts.com/highmaps/data.lineDelimiter
   *
   * @implspec lineDelimiter?: string;
   *
   */
  @JSProperty("lineDelimiter")
  void setLineDelimiter(String value);

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to access the
   * parsed columns, the two-dimentional input data array directly, before
   * they are interpreted into series data and categories. Return false to
   * stop completion, or call this.complete() to continue async.
   *
   * @see https://api.highcharts.com/highcharts/data.parsed
   * @see https://api.highcharts.com/highstock/data.parsed
   * @see https://api.highcharts.com/highmaps/data.parsed
   *
   * @implspec parsed?: DataParsedCallbackFunction;
   *
   */
  @JSProperty("parsed")
  @Nullable
  DataParsedCallbackFunction getParsed();

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to access the
   * parsed columns, the two-dimentional input data array directly, before
   * they are interpreted into series data and categories. Return false to
   * stop completion, or call this.complete() to continue async.
   *
   * @see https://api.highcharts.com/highcharts/data.parsed
   * @see https://api.highcharts.com/highstock/data.parsed
   * @see https://api.highcharts.com/highmaps/data.parsed
   *
   * @implspec parsed?: DataParsedCallbackFunction;
   *
   */
  @JSProperty("parsed")
  void setParsed(DataParsedCallbackFunction value);

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to parse string
   * representations of dates into JavaScript timestamps. Should return an
   * integer timestamp on success.
   *
   * @see https://api.highcharts.com/highcharts/data.parseDate
   * @see https://api.highcharts.com/highstock/data.parseDate
   * @see https://api.highcharts.com/highmaps/data.parseDate
   *
   * @implspec parseDate?: DataParseDateCallbackFunction;
   *
   */
  @JSProperty("parseDate")
  @Nullable
  DataParseDateCallbackFunction getParseDate();

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to parse string
   * representations of dates into JavaScript timestamps. Should return an
   * integer timestamp on success.
   *
   * @see https://api.highcharts.com/highcharts/data.parseDate
   * @see https://api.highcharts.com/highstock/data.parseDate
   * @see https://api.highcharts.com/highmaps/data.parseDate
   *
   * @implspec parseDate?: DataParseDateCallbackFunction;
   *
   */
  @JSProperty("parseDate")
  void setParseDate(DataParseDateCallbackFunction value);

  /**
   * (Highcharts, Highstock, Highmaps) The same as the columns input option,
   * but defining rows intead of columns.
   *
   * @see https://api.highcharts.com/highcharts/data.rows
   * @see https://api.highcharts.com/highstock/data.rows
   * @see https://api.highcharts.com/highmaps/data.rows
   *
   * @implspec rows?: Array<Array>;
   *
   */
  @JSProperty("rows")
  @Nullable
  Array> getRows();

  /**
   * (Highcharts, Highstock, Highmaps) The same as the columns input option,
   * but defining rows intead of columns.
   *
   * @see https://api.highcharts.com/highcharts/data.rows
   * @see https://api.highcharts.com/highstock/data.rows
   * @see https://api.highcharts.com/highmaps/data.rows
   *
   * @implspec rows?: Array<Array>;
   *
   */
  @JSProperty("rows")
  void setRows(Array> value);

  /**
   * (Highcharts, Highstock, Highmaps) A URL to a remote JSON dataset,
   * structured as a row array. Will be fetched when the chart is created
   * using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.rowsURL
   * @see https://api.highcharts.com/highstock/data.rowsURL
   * @see https://api.highcharts.com/highmaps/data.rowsURL
   *
   * @implspec rowsURL?: string;
   *
   */
  @JSProperty("rowsURL")
  @Nullable
  String getRowsURL();

  /**
   * (Highcharts, Highstock, Highmaps) A URL to a remote JSON dataset,
   * structured as a row array. Will be fetched when the chart is created
   * using Ajax.
   *
   * @see https://api.highcharts.com/highcharts/data.rowsURL
   * @see https://api.highcharts.com/highstock/data.rowsURL
   * @see https://api.highcharts.com/highmaps/data.rowsURL
   *
   * @implspec rowsURL?: string;
   *
   */
  @JSProperty("rowsURL")
  void setRowsURL(String value);

  /**
   * (Highcharts, Highstock, Highmaps) An array containing dictionaries for
   * each series. A dictionary exists of Point property names as the key and
   * the CSV column index as the value.
   *
   * @see https://api.highcharts.com/highcharts/data.seriesMapping
   * @see https://api.highcharts.com/highstock/data.seriesMapping
   * @see https://api.highcharts.com/highmaps/data.seriesMapping
   *
   * @implspec seriesMapping?: Array<Dictionary>;
   *
   */
  @JSProperty("seriesMapping")
  @Nullable
  Array getSeriesMapping();

  /**
   * (Highcharts, Highstock, Highmaps) An array containing dictionaries for
   * each series. A dictionary exists of Point property names as the key and
   * the CSV column index as the value.
   *
   * @see https://api.highcharts.com/highcharts/data.seriesMapping
   * @see https://api.highcharts.com/highstock/data.seriesMapping
   * @see https://api.highcharts.com/highmaps/data.seriesMapping
   *
   * @implspec seriesMapping?: Array<Dictionary>;
   *
   */
  @JSProperty("seriesMapping")
  void setSeriesMapping(Array value);

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the first column
   * (indexed by 0) to use.
   *
   * @see https://api.highcharts.com/highcharts/data.startColumn
   * @see https://api.highcharts.com/highstock/data.startColumn
   * @see https://api.highcharts.com/highmaps/data.startColumn
   *
   * @implspec startColumn?: number;
   *
   */
  @JSProperty("startColumn")
  double getStartColumn();

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the first column
   * (indexed by 0) to use.
   *
   * @see https://api.highcharts.com/highcharts/data.startColumn
   * @see https://api.highcharts.com/highstock/data.startColumn
   * @see https://api.highcharts.com/highmaps/data.startColumn
   *
   * @implspec startColumn?: number;
   *
   */
  @JSProperty("startColumn")
  void setStartColumn(double value);

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the first row
   * (indexed by 0) to use.
   *
   * @see https://api.highcharts.com/highcharts/data.startRow
   * @see https://api.highcharts.com/highstock/data.startRow
   * @see https://api.highcharts.com/highmaps/data.startRow
   *
   * @implspec startRow?: number;
   *
   */
  @JSProperty("startRow")
  double getStartRow();

  /**
   * (Highcharts, Highstock, Highmaps) In tabular input data, the first row
   * (indexed by 0) to use.
   *
   * @see https://api.highcharts.com/highcharts/data.startRow
   * @see https://api.highcharts.com/highstock/data.startRow
   * @see https://api.highcharts.com/highmaps/data.startRow
   *
   * @implspec startRow?: number;
   *
   */
  @JSProperty("startRow")
  void setStartRow(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Switch rows and columns of the input
   * data, so that this.columns effectively becomes the rows of the data
   * set, and the rows are interpreted as series.
   *
   * @see https://api.highcharts.com/highcharts/data.switchRowsAndColumns
   * @see https://api.highcharts.com/highstock/data.switchRowsAndColumns
   * @see https://api.highcharts.com/highmaps/data.switchRowsAndColumns
   *
   * @implspec switchRowsAndColumns?: boolean;
   *
   */
  @JSProperty("switchRowsAndColumns")
  boolean getSwitchRowsAndColumns();

  /**
   * (Highcharts, Highstock, Highmaps) Switch rows and columns of the input
   * data, so that this.columns effectively becomes the rows of the data
   * set, and the rows are interpreted as series.
   *
   * @see https://api.highcharts.com/highcharts/data.switchRowsAndColumns
   * @see https://api.highcharts.com/highstock/data.switchRowsAndColumns
   * @see https://api.highcharts.com/highmaps/data.switchRowsAndColumns
   *
   * @implspec switchRowsAndColumns?: boolean;
   *
   */
  @JSProperty("switchRowsAndColumns")
  void setSwitchRowsAndColumns(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) An HTML table or the id of such to be
   * parsed as input data. Related options are startRow, endRow,
   * startColumn and endColumn to delimit what part of the table is used.
   *
   * @see https://api.highcharts.com/highcharts/data.table
   * @see https://api.highcharts.com/highstock/data.table
   * @see https://api.highcharts.com/highmaps/data.table
   *
   * @implspec table?: (string|HTMLElement);
   *
   */
  @JSProperty("table")
  @Nullable
  Unknown getTable();

  /**
   * (Highcharts, Highstock, Highmaps) An HTML table or the id of such to be
   * parsed as input data. Related options are startRow, endRow,
   * startColumn and endColumn to delimit what part of the table is used.
   *
   * @see https://api.highcharts.com/highcharts/data.table
   * @see https://api.highcharts.com/highstock/data.table
   * @see https://api.highcharts.com/highmaps/data.table
   *
   * @implspec table?: (string|HTMLElement);
   *
   */
  @JSProperty("table")
  void setTable(HTMLElement value);

  /**
   * (Highcharts, Highstock, Highmaps) An HTML table or the id of such to be
   * parsed as input data. Related options are startRow, endRow,
   * startColumn and endColumn to delimit what part of the table is used.
   *
   * @see https://api.highcharts.com/highcharts/data.table
   * @see https://api.highcharts.com/highstock/data.table
   * @see https://api.highcharts.com/highmaps/data.table
   *
   * @implspec table?: (string|HTMLElement);
   *
   */
  @JSProperty("table")
  void setTable(String value);

  /**
   */
  abstract class DateFormat extends JsEnum {
    public static final DateFormat DD_MM_YY = JsEnum.of("dd/mm/YY");

    public static final DateFormat DD_MM_YYYY = JsEnum.of("dd/mm/YYYY");

    public static final DateFormat MM_DD_YY = JsEnum.of("mm/dd/YY");

    public static final DateFormat MM_DD_YYYY = JsEnum.of("mm/dd/YYYY");

    public static final DateFormat YYYY_MM_DD = JsEnum.of("YYYY/mm/dd");
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy