com.github.fluorumlabs.disconnect.highcharts.YAxisPlotBandsOptions 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.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock, Gantt) An array of objects defining plot bands on the
* Y axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands
* @see https://api.highcharts.com/highstock/yAxis.plotBands
* @see https://api.highcharts.com/gantt/yAxis.plotBands
*
*/
public interface YAxisPlotBandsOptions extends Any {
/**
* (Highcharts, Highstock, Gantt) Border color for the plot band. Also
* requires borderWidth to be set.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.borderColor
* @see https://api.highcharts.com/highstock/yAxis.plotBands.borderColor
* @see https://api.highcharts.com/gantt/yAxis.plotBands.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts, Highstock, Gantt) Border color for the plot band. Also
* requires borderWidth to be set.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.borderColor
* @see https://api.highcharts.com/highstock/yAxis.plotBands.borderColor
* @see https://api.highcharts.com/gantt/yAxis.plotBands.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highcharts, Highstock, Gantt) Border width for the plot band. Also
* requires borderColor to be set.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.borderWidth
* @see https://api.highcharts.com/highstock/yAxis.plotBands.borderWidth
* @see https://api.highcharts.com/gantt/yAxis.plotBands.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highcharts, Highstock, Gantt) Border width for the plot band. Also
* requires borderColor to be set.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.borderWidth
* @see https://api.highcharts.com/highstock/yAxis.plotBands.borderWidth
* @see https://api.highcharts.com/gantt/yAxis.plotBands.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock, Gantt) A custom class name, in addition to the
* default highcharts-plot-band, to apply to each individual band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.className
* @see https://api.highcharts.com/highstock/yAxis.plotBands.className
* @see https://api.highcharts.com/gantt/yAxis.plotBands.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts, Highstock, Gantt) A custom class name, in addition to the
* default highcharts-plot-band, to apply to each individual band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.className
* @see https://api.highcharts.com/highstock/yAxis.plotBands.className
* @see https://api.highcharts.com/gantt/yAxis.plotBands.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts, Highstock, Gantt) The color of the plot band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.color
* @see https://api.highcharts.com/highstock/yAxis.plotBands.color
* @see https://api.highcharts.com/gantt/yAxis.plotBands.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
@Nullable
Unknown getColor();
/**
* (Highcharts, Highstock, Gantt) The color of the plot band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.color
* @see https://api.highcharts.com/highstock/yAxis.plotBands.color
* @see https://api.highcharts.com/gantt/yAxis.plotBands.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(GradientColorObject value);
/**
* (Highcharts, Highstock, Gantt) The color of the plot band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.color
* @see https://api.highcharts.com/highstock/yAxis.plotBands.color
* @see https://api.highcharts.com/gantt/yAxis.plotBands.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(String value);
/**
* (Highcharts, Highstock, Gantt) The color of the plot band.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.color
* @see https://api.highcharts.com/highstock/yAxis.plotBands.color
* @see https://api.highcharts.com/gantt/yAxis.plotBands.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(Any value);
/**
* (Highcharts, Highstock, Gantt) An object defining mouse events for the
* plot band. Supported properties are click, mouseover, mouseout,
* mousemove.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.events
* @see https://api.highcharts.com/highstock/yAxis.plotBands.events
* @see https://api.highcharts.com/gantt/yAxis.plotBands.events
*
* @implspec events?: object;
*
*/
@JSProperty("events")
@Nullable
Any getEvents();
/**
* (Highcharts, Highstock, Gantt) An object defining mouse events for the
* plot band. Supported properties are click, mouseover, mouseout,
* mousemove.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.events
* @see https://api.highcharts.com/highstock/yAxis.plotBands.events
* @see https://api.highcharts.com/gantt/yAxis.plotBands.events
*
* @implspec events?: object;
*
*/
@JSProperty("events")
void setEvents(Any value);
/**
* (Highcharts, Highstock, Gantt) The start position of the plot band in
* axis units.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.from
* @see https://api.highcharts.com/highstock/yAxis.plotBands.from
* @see https://api.highcharts.com/gantt/yAxis.plotBands.from
*
* @implspec from?: number;
*
*/
@JSProperty("from")
double getFrom();
/**
* (Highcharts, Highstock, Gantt) The start position of the plot band in
* axis units.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.from
* @see https://api.highcharts.com/highstock/yAxis.plotBands.from
* @see https://api.highcharts.com/gantt/yAxis.plotBands.from
*
* @implspec from?: number;
*
*/
@JSProperty("from")
void setFrom(double value);
/**
* (Highcharts, Highstock, Gantt) An id used for identifying the plot band
* in Axis.removePlotBand.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.id
* @see https://api.highcharts.com/highstock/yAxis.plotBands.id
* @see https://api.highcharts.com/gantt/yAxis.plotBands.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
@Nullable
String getId();
/**
* (Highcharts, Highstock, Gantt) An id used for identifying the plot band
* in Axis.removePlotBand.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.id
* @see https://api.highcharts.com/highstock/yAxis.plotBands.id
* @see https://api.highcharts.com/gantt/yAxis.plotBands.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
void setId(String value);
/**
* (Highcharts) In a gauge chart, this option determines the inner radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100. By
* default, the inner radius is controlled by the thickness option.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.innerRadius
*
* @implspec innerRadius?: (number|string);
*
*/
@JSProperty("innerRadius")
@Nullable
Unknown getInnerRadius();
/**
* (Highcharts) In a gauge chart, this option determines the inner radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100. By
* default, the inner radius is controlled by the thickness option.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.innerRadius
*
* @implspec innerRadius?: (number|string);
*
*/
@JSProperty("innerRadius")
void setInnerRadius(double value);
/**
* (Highcharts) In a gauge chart, this option determines the inner radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100. By
* default, the inner radius is controlled by the thickness option.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.innerRadius
*
* @implspec innerRadius?: (number|string);
*
*/
@JSProperty("innerRadius")
void setInnerRadius(String value);
/**
* (Highcharts, Highstock, Gantt) Text labels for the plot bands
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.label
* @see https://api.highcharts.com/highstock/yAxis.plotBands.label
* @see https://api.highcharts.com/gantt/yAxis.plotBands.label
*
* @implspec label?: YAxisPlotBandsLabelOptions;
*
*/
@JSProperty("label")
@Nullable
YAxisPlotBandsLabelOptions getLabel();
/**
* (Highcharts, Highstock, Gantt) Text labels for the plot bands
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.label
* @see https://api.highcharts.com/highstock/yAxis.plotBands.label
* @see https://api.highcharts.com/gantt/yAxis.plotBands.label
*
* @implspec label?: YAxisPlotBandsLabelOptions;
*
*/
@JSProperty("label")
void setLabel(YAxisPlotBandsLabelOptions value);
/**
* (Highcharts) In a gauge chart, this option determines the outer radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.outerRadius
*
* @implspec outerRadius?: (number|string);
*
*/
@JSProperty("outerRadius")
@Nullable
Unknown getOuterRadius();
/**
* (Highcharts) In a gauge chart, this option determines the outer radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.outerRadius
*
* @implspec outerRadius?: (number|string);
*
*/
@JSProperty("outerRadius")
void setOuterRadius(double value);
/**
* (Highcharts) In a gauge chart, this option determines the outer radius of
* the plot band that stretches along the perimeter. It can be given as a
* percentage string, like "100%", or as a pixel number, like 100.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.outerRadius
*
* @implspec outerRadius?: (number|string);
*
*/
@JSProperty("outerRadius")
void setOuterRadius(String value);
/**
* (Highcharts) In a gauge chart, this option sets the width of the plot
* band stretching along the perimeter. It can be given as a percentage
* string, like "10%", or as a pixel number, like 10. The default value
* 10 is the same as the default tickLength, thus making the plot band act
* as a background for the tick markers.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.thickness
*
* @implspec thickness?: (number|string);
*
*/
@JSProperty("thickness")
@Nullable
Unknown getThickness();
/**
* (Highcharts) In a gauge chart, this option sets the width of the plot
* band stretching along the perimeter. It can be given as a percentage
* string, like "10%", or as a pixel number, like 10. The default value
* 10 is the same as the default tickLength, thus making the plot band act
* as a background for the tick markers.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.thickness
*
* @implspec thickness?: (number|string);
*
*/
@JSProperty("thickness")
void setThickness(double value);
/**
* (Highcharts) In a gauge chart, this option sets the width of the plot
* band stretching along the perimeter. It can be given as a percentage
* string, like "10%", or as a pixel number, like 10. The default value
* 10 is the same as the default tickLength, thus making the plot band act
* as a background for the tick markers.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.thickness
*
* @implspec thickness?: (number|string);
*
*/
@JSProperty("thickness")
void setThickness(String value);
/**
* (Highcharts, Highstock, Gantt) The end position of the plot band in axis
* units.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.to
* @see https://api.highcharts.com/highstock/yAxis.plotBands.to
* @see https://api.highcharts.com/gantt/yAxis.plotBands.to
*
* @implspec to?: number;
*
*/
@JSProperty("to")
double getTo();
/**
* (Highcharts, Highstock, Gantt) The end position of the plot band in axis
* units.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.to
* @see https://api.highcharts.com/highstock/yAxis.plotBands.to
* @see https://api.highcharts.com/gantt/yAxis.plotBands.to
*
* @implspec to?: number;
*
*/
@JSProperty("to")
void setTo(double value);
/**
* (Highcharts, Highstock, Gantt) The z index of the plot band within the
* chart, relative to other elements. Using the same z index as another
* element may give unpredictable results, as the last rendered element will
* be on top. Values from 0 to 20 make sense.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.zIndex
* @see https://api.highcharts.com/highstock/yAxis.plotBands.zIndex
* @see https://api.highcharts.com/gantt/yAxis.plotBands.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
double getZIndex();
/**
* (Highcharts, Highstock, Gantt) The z index of the plot band within the
* chart, relative to other elements. Using the same z index as another
* element may give unpredictable results, as the last rendered element will
* be on top. Values from 0 to 20 make sense.
*
* @see https://api.highcharts.com/highcharts/yAxis.plotBands.zIndex
* @see https://api.highcharts.com/highstock/yAxis.plotBands.zIndex
* @see https://api.highcharts.com/gantt/yAxis.plotBands.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
void setZIndex(double value);
}