com.github.fluorumlabs.disconnect.highcharts.LangAccessibilitySeriesOptions 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
Highcharts API bindings for Disconnect Zero
There is a newer version: 0.1.0-alpha2
Show newest version
package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) Lang configuration for different series
 * types. For more dynamic control over the series element descriptions, see
 * accessibility.seriesDescriptionFormatter.
 *
 * @see https://api.highcharts.com/highcharts/lang.accessibility.series
 * @see https://api.highcharts.com/highstock/lang.accessibility.series
 * @see https://api.highcharts.com/highmaps/lang.accessibility.series
 *
 */
public interface LangAccessibilitySeriesOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) User supplied description text. This is
   * added after the main summary if present.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.description
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.description
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.description
   *
   * @implspec description?: string;
   *
   */
  @JSProperty("description")
  @Nullable
  String getDescription();

  /**
   * (Highcharts, Highstock, Highmaps) User supplied description text. This is
   * added after the main summary if present.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.description
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.description
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.description
   *
   * @implspec description?: string;
   *
   */
  @JSProperty("description")
  void setDescription(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Lang configuration for the series main
   * summary. Each series type has two modes:
   *
   * 
   * 
   * This series type is the only series type used in the chart
   *
   * 
   * 
   * This is a combination chart with multiple series types
   *
   * 
   * 
   * If a definition does not exist for the specific series type and mode, the
   * 'default' lang definitions are used.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.summary
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.summary
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.summary
   *
   * @implspec summary?: LangAccessibilitySeriesSummaryOptions;
   *
   */
  @JSProperty("summary")
  @Nullable
  LangAccessibilitySeriesSummaryOptions getSummary();

  /**
   * (Highcharts, Highstock, Highmaps) Lang configuration for the series main
   * summary. Each series type has two modes:
   *
   * 
   * 
   * This series type is the only series type used in the chart
   *
   * 
   * 
   * This is a combination chart with multiple series types
   *
   * 
   * 
   * If a definition does not exist for the specific series type and mode, the
   * 'default' lang definitions are used.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.summary
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.summary
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.summary
   *
   * @implspec summary?: LangAccessibilitySeriesSummaryOptions;
   *
   */
  @JSProperty("summary")
  void setSummary(LangAccessibilitySeriesSummaryOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) xAxis description for series if there
   * are multiple xAxes in the chart.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.xAxisDescription
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.xAxisDescription
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.xAxisDescription
   *
   * @implspec xAxisDescription?: string;
   *
   */
  @JSProperty("xAxisDescription")
  @Nullable
  String getXAxisDescription();

  /**
   * (Highcharts, Highstock, Highmaps) xAxis description for series if there
   * are multiple xAxes in the chart.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.xAxisDescription
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.xAxisDescription
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.xAxisDescription
   *
   * @implspec xAxisDescription?: string;
   *
   */
  @JSProperty("xAxisDescription")
  void setXAxisDescription(String value);

  /**
   * (Highcharts, Highstock, Highmaps) yAxis description for series if there
   * are multiple yAxes in the chart.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.yAxisDescription
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.yAxisDescription
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.yAxisDescription
   *
   * @implspec yAxisDescription?: string;
   *
   */
  @JSProperty("yAxisDescription")
  @Nullable
  String getYAxisDescription();

  /**
   * (Highcharts, Highstock, Highmaps) yAxis description for series if there
   * are multiple yAxes in the chart.
   *
   * @see https://api.highcharts.com/highcharts/lang.accessibility.series.yAxisDescription
   * @see https://api.highcharts.com/highstock/lang.accessibility.series.yAxisDescription
   * @see https://api.highcharts.com/highmaps/lang.accessibility.series.yAxisDescription
   *
   * @implspec yAxisDescription?: string;
   *
   */
  @JSProperty("yAxisDescription")
  void setYAxisDescription(String value);
}