com.github.fluorumlabs.disconnect.highcharts.XAxisCrosshairLabelOptions 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 js.lang.Unknown;
import org.teavm.jso.JSProperty;

/**
 * (Highstock) A label on the axis next to the crosshair.
 *
 * In styled mode, the label is styled with the .highcharts-crosshair-label
 * class.
 *
 * @see https://api.highcharts.com/highstock/xAxis.crosshair.label
 *
 */
public interface XAxisCrosshairLabelOptions extends Any {
  /**
   * (Highstock) Alignment of the label compared to the axis. Defaults to
   * left for right-side axes, right for left-side axes and center for
   * horizontal axes.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.align
   *
   * @implspec align?: string;
   *
   */
  @JSProperty("align")
  @Nullable
  String getAlign();

  /**
   * (Highstock) Alignment of the label compared to the axis. Defaults to
   * left for right-side axes, right for left-side axes and center for
   * horizontal axes.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.align
   *
   * @implspec align?: string;
   *
   */
  @JSProperty("align")
  void setAlign(String value);

  /**
   * (Highstock) The background color for the label. Defaults to the related
   * series color, or #666666 if that is not available.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.backgroundColor
   *
   * @implspec backgroundColor?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("backgroundColor")
  @Nullable
  Unknown getBackgroundColor();

  /**
   * (Highstock) The background color for the label. Defaults to the related
   * series color, or #666666 if that is not available.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.backgroundColor
   *
   * @implspec backgroundColor?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("backgroundColor")
  void setBackgroundColor(GradientColorObject value);

  /**
   * (Highstock) The background color for the label. Defaults to the related
   * series color, or #666666 if that is not available.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.backgroundColor
   *
   * @implspec backgroundColor?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("backgroundColor")
  void setBackgroundColor(String value);

  /**
   * (Highstock) The background color for the label. Defaults to the related
   * series color, or #666666 if that is not available.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.backgroundColor
   *
   * @implspec backgroundColor?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("backgroundColor")
  void setBackgroundColor(Any value);

  /**
   * (Highstock) The border color for the crosshair label
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  @Nullable
  String getBorderColor();

  /**
   * (Highstock) The border color for the crosshair label
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  void setBorderColor(String value);

  /**
   * (Highstock) The border corner radius of the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderRadius
   *
   * @implspec borderRadius?: number;
   *
   */
  @JSProperty("borderRadius")
  double getBorderRadius();

  /**
   * (Highstock) The border corner radius of the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderRadius
   *
   * @implspec borderRadius?: number;
   *
   */
  @JSProperty("borderRadius")
  void setBorderRadius(double value);

  /**
   * (Highstock) The border width for the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  double getBorderWidth();

  /**
   * (Highstock) The border width for the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  void setBorderWidth(double value);

  /**
   * (Highstock) A format string for the crosshair label. Defaults to
   * {value} for numeric axes and {value:%b %d, %Y} for datetime axes.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.format
   *
   * @implspec format?: string;
   *
   */
  @JSProperty("format")
  @Nullable
  String getFormat();

  /**
   * (Highstock) A format string for the crosshair label. Defaults to
   * {value} for numeric axes and {value:%b %d, %Y} for datetime axes.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.format
   *
   * @implspec format?: string;
   *
   */
  @JSProperty("format")
  void setFormat(String value);

  /**
   * (Highstock) Formatter function for the label text.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.formatter
   *
   * @implspec formatter?: FormatterCallbackFunction;
   *
   */
  @JSProperty("formatter")
  @Nullable
  FormatterCallbackFunction getFormatter();

  /**
   * (Highstock) Formatter function for the label text.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.formatter
   *
   * @implspec formatter?: FormatterCallbackFunction;
   *
   */
  @JSProperty("formatter")
  void setFormatter(FormatterCallbackFunction value);

  /**
   * (Highstock) Padding inside the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.padding
   *
   * @implspec padding?: number;
   *
   */
  @JSProperty("padding")
  double getPadding();

  /**
   * (Highstock) Padding inside the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.padding
   *
   * @implspec padding?: number;
   *
   */
  @JSProperty("padding")
  void setPadding(double value);

  /**
   * (Highstock) The shape to use for the label box.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.shape
   *
   * @implspec shape?: string;
   *
   */
  @JSProperty("shape")
  @Nullable
  String getShape();

  /**
   * (Highstock) The shape to use for the label box.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.shape
   *
   * @implspec shape?: string;
   *
   */
  @JSProperty("shape")
  void setShape(String value);

  /**
   * (Highstock) Text styles for the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highstock) Text styles for the crosshair label.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);
}