com.github.fluorumlabs.disconnect.highcharts.YAxisStackLabelsOptions 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
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import org.teavm.jso.JSProperty;
/**
* (Highcharts) The stack labels show the total value for each bar in a stacked
* column or bar chart. The label will be placed on top of positive columns and
* below negative columns. In case of an inverted column chart or a bar chart
* the label is placed to the right of positive bars and to the left of negative
* bars.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels
*
*/
public interface YAxisStackLabelsOptions extends Any {
/**
* (Highcharts) Defines the horizontal alignment of the stack total label.
* Can be one of "left", "center" or "right". The default value is
* calculated at runtime and depends on orientation and whether the stack is
* positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts) Defines the horizontal alignment of the stack total label.
* Can be one of "left", "center" or "right". The default value is
* calculated at runtime and depends on orientation and whether the stack is
* positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts) Allow the stack labels to overlap.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
boolean getAllowOverlap();
/**
* (Highcharts) Allow the stack labels to overlap.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
void setAllowOverlap(boolean value);
/**
* (Highcharts) Enable or disable the stack total labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highcharts) Enable or disable the stack total labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highcharts, Highstock) A format string for the data label. Available
* variables are the same as for formatter.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.format
* @see https://api.highcharts.com/highstock/yAxis.stackLabels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
@Nullable
String getFormat();
/**
* (Highcharts, Highstock) A format string for the data label. Available
* variables are the same as for formatter.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.format
* @see https://api.highcharts.com/highstock/yAxis.stackLabels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
void setFormat(String value);
/**
* (Highcharts) Callback JavaScript function to format the label. The value
* is given by this.total.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
@Nullable
FormatterCallbackFunction getFormatter();
/**
* (Highcharts) Callback JavaScript function to format the label. The value
* is given by this.total.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
void setFormatter(FormatterCallbackFunction value);
/**
* (Highcharts) Rotation of the labels in degrees.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
double getRotation();
/**
* (Highcharts) Rotation of the labels in degrees.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
void setRotation(double value);
/**
* (Highcharts) CSS styles for the label.
*
* In styled mode, the styles are set in the .highcharts-stack-label
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts) CSS styles for the label.
*
* In styled mode, the styles are set in the .highcharts-stack-label
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts) The text alignment for the label. While align determines
* where the texts anchor point is placed with regards to the stack,
* textAlign determines how the text is aligned against its anchor point.
* Possible values are "left", "center" and "right". The default value
* is calculated at runtime and depends on orientation and whether the stack
* is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.textAlign
*
* @implspec textAlign?: ("center"|"left"|"right");
*
*/
@JSProperty("textAlign")
@Nullable
TextAlign getTextAlign();
/**
* (Highcharts) The text alignment for the label. While align determines
* where the texts anchor point is placed with regards to the stack,
* textAlign determines how the text is aligned against its anchor point.
* Possible values are "left", "center" and "right". The default value
* is calculated at runtime and depends on orientation and whether the stack
* is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.textAlign
*
* @implspec textAlign?: ("center"|"left"|"right");
*
*/
@JSProperty("textAlign")
void setTextAlign(TextAlign value);
/**
* (Highcharts, Highstock) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.useHTML
* @see https://api.highcharts.com/highstock/yAxis.stackLabels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts, Highstock) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.useHTML
* @see https://api.highcharts.com/highstock/yAxis.stackLabels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts) Defines the vertical alignment of the stack total label. Can
* be one of "top", "middle" or "bottom". The default value is
* calculated at runtime and depends on orientation and whether the stack is
* positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
@Nullable
VerticalAlign getVerticalAlign();
/**
* (Highcharts) Defines the vertical alignment of the stack total label. Can
* be one of "top", "middle" or "bottom". The default value is
* calculated at runtime and depends on orientation and whether the stack is
* positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
void setVerticalAlign(VerticalAlign value);
/**
* (Highcharts) The x position offset of the label relative to the left of
* the stacked bar. The default value is calculated at runtime and depends
* on orientation and whether the stack is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts) The x position offset of the label relative to the left of
* the stacked bar. The default value is calculated at runtime and depends
* on orientation and whether the stack is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts) The y position offset of the label relative to the tick
* position on the axis. The default value is calculated at runtime and
* depends on orientation and whether the stack is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts) The y position offset of the label relative to the tick
* position on the axis. The default value is calculated at runtime and
* depends on orientation and whether the stack is positive or negative.
*
* @see https://api.highcharts.com/highcharts/yAxis.stackLabels.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
/**
*/
abstract class Align extends JsEnum {
public static final Align CENTER = JsEnum.of("center");
public static final Align LEFT = JsEnum.of("left");
public static final Align RIGHT = JsEnum.of("right");
}
/**
*/
abstract class TextAlign extends JsEnum {
public static final TextAlign CENTER = JsEnum.of("center");
public static final TextAlign LEFT = JsEnum.of("left");
public static final TextAlign RIGHT = JsEnum.of("right");
}
/**
*/
abstract class VerticalAlign extends JsEnum {
public static final VerticalAlign BOTTOM = JsEnum.of("bottom");
public static final VerticalAlign MIDDLE = JsEnum.of("middle");
public static final VerticalAlign TOP = JsEnum.of("top");
}
}