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

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

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) Highchart by default puts a credits label
 * in the lower right corner of the chart. This can be changed using these
 * options.
 *
 * @see https://api.highcharts.com/highcharts/credits
 * @see https://api.highcharts.com/highstock/credits
 * @see https://api.highcharts.com/highmaps/credits
 *
 */
public interface CreditsOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Whether to show the credits text.
   *
   * @see https://api.highcharts.com/highcharts/credits.enabled
   * @see https://api.highcharts.com/highstock/credits.enabled
   * @see https://api.highcharts.com/highmaps/credits.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts, Highstock, Highmaps) Whether to show the credits text.
   *
   * @see https://api.highcharts.com/highcharts/credits.enabled
   * @see https://api.highcharts.com/highstock/credits.enabled
   * @see https://api.highcharts.com/highmaps/credits.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) The URL for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.href
   * @see https://api.highcharts.com/highstock/credits.href
   * @see https://api.highcharts.com/highmaps/credits.href
   *
   * @implspec href?: string;
   *
   */
  @JSProperty("href")
  @Nullable
  String getHref();

  /**
   * (Highcharts, Highstock, Highmaps) The URL for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.href
   * @see https://api.highcharts.com/highstock/credits.href
   * @see https://api.highcharts.com/highmaps/credits.href
   *
   * @implspec href?: string;
   *
   */
  @JSProperty("href")
  void setHref(String value);

  /**
   * (Highmaps) Credits for map source to be concatenated with conventional
   * credit text. By default this is a format string that collects copyright
   * information from the map if available.
   *
   * @see https://api.highcharts.com/highmaps/credits.mapText
   *
   * @implspec mapText?: string;
   *
   */
  @JSProperty("mapText")
  @Nullable
  String getMapText();

  /**
   * (Highmaps) Credits for map source to be concatenated with conventional
   * credit text. By default this is a format string that collects copyright
   * information from the map if available.
   *
   * @see https://api.highcharts.com/highmaps/credits.mapText
   *
   * @implspec mapText?: string;
   *
   */
  @JSProperty("mapText")
  void setMapText(String value);

  /**
   * (Highmaps) Detailed credits for map source to be displayed on hover of
   * credits text. By default this is a format string that collects copyright
   * information from the map if available.
   *
   * @see https://api.highcharts.com/highmaps/credits.mapTextFull
   *
   * @implspec mapTextFull?: string;
   *
   */
  @JSProperty("mapTextFull")
  @Nullable
  String getMapTextFull();

  /**
   * (Highmaps) Detailed credits for map source to be displayed on hover of
   * credits text. By default this is a format string that collects copyright
   * information from the map if available.
   *
   * @see https://api.highcharts.com/highmaps/credits.mapTextFull
   *
   * @implspec mapTextFull?: string;
   *
   */
  @JSProperty("mapTextFull")
  void setMapTextFull(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Position configuration for the credits
   * label.
   *
   * @see https://api.highcharts.com/highcharts/credits.position
   * @see https://api.highcharts.com/highstock/credits.position
   * @see https://api.highcharts.com/highmaps/credits.position
   *
   * @implspec position?: CreditsPositionOptions;
   *
   */
  @JSProperty("position")
  @Nullable
  CreditsPositionOptions getPosition();

  /**
   * (Highcharts, Highstock, Highmaps) Position configuration for the credits
   * label.
   *
   * @see https://api.highcharts.com/highcharts/credits.position
   * @see https://api.highcharts.com/highstock/credits.position
   * @see https://api.highcharts.com/highmaps/credits.position
   *
   * @implspec position?: CreditsPositionOptions;
   *
   */
  @JSProperty("position")
  void setPosition(CreditsPositionOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.style
   * @see https://api.highcharts.com/highstock/credits.style
   * @see https://api.highcharts.com/highmaps/credits.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.style
   * @see https://api.highcharts.com/highstock/credits.style
   * @see https://api.highcharts.com/highmaps/credits.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);

  /**
   * (Highcharts, Highstock, Highmaps) The text for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.text
   * @see https://api.highcharts.com/highstock/credits.text
   * @see https://api.highcharts.com/highmaps/credits.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  @Nullable
  String getText();

  /**
   * (Highcharts, Highstock, Highmaps) The text for the credits label.
   *
   * @see https://api.highcharts.com/highcharts/credits.text
   * @see https://api.highcharts.com/highstock/credits.text
   * @see https://api.highcharts.com/highmaps/credits.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  void setText(String value);
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy