com.github.fluorumlabs.disconnect.highcharts.YAxisOptions 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 js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import com.github.fluorumlabs.disconnect.types.DoubleKeyStringValue;
import org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;
import javax.annotation.Nullable;
/**
* (Highcharts, Highstock, Highmaps) The Y axis or value axis. Normally this is
* the vertical axis, though if the chart is inverted this is the horizontal
* axis. In case of multiple axes, the yAxis node is an array of configuration
* objects.
*
* See the Axis object for programmatic access to the axis.
*
* @see https://api.highcharts.com/highcharts/yAxis
* @see https://api.highcharts.com/highstock/yAxis
* @see https://api.highcharts.com/highmaps/yAxis
*
*/
public interface YAxisOptions extends Any {
/**
* (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
* or more opposite axes will automatically be aligned by adding ticks to
* the axis or axes with the least ticks, as if tickAmount were specified.
*
* This can be prevented by setting alignTicks to false. If the grid lines
* look messy, it's a good idea to hide them for the secondary axis by
* setting gridLineWidth to 0.
*
* If startOnTick or endOnTick in an Axis options are set to false, then
* the alignTicks will be disabled for the Axis.
*
* Disabled for logarithmic axes.
*
* @see https://api.highcharts.com/highcharts/yAxis.alignTicks
* @see https://api.highcharts.com/highstock/yAxis.alignTicks
* @see https://api.highcharts.com/gantt/yAxis.alignTicks
*
* @implspec alignTicks?: boolean;
*
*/
@JSProperty("alignTicks")
boolean getAlignTicks();
/**
* (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
* or more opposite axes will automatically be aligned by adding ticks to
* the axis or axes with the least ticks, as if tickAmount were specified.
*
* This can be prevented by setting alignTicks to false. If the grid lines
* look messy, it's a good idea to hide them for the secondary axis by
* setting gridLineWidth to 0.
*
* If startOnTick or endOnTick in an Axis options are set to false, then
* the alignTicks will be disabled for the Axis.
*
* Disabled for logarithmic axes.
*
* @see https://api.highcharts.com/highcharts/yAxis.alignTicks
* @see https://api.highcharts.com/highstock/yAxis.alignTicks
* @see https://api.highcharts.com/gantt/yAxis.alignTicks
*
* @implspec alignTicks?: boolean;
*
*/
@JSProperty("alignTicks")
void setAlignTicks(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to allow decimals in this axis'
* ticks. When counting integers, like persons or hits on a web page,
* decimals should be avoided in the labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.allowDecimals
* @see https://api.highcharts.com/highstock/yAxis.allowDecimals
* @see https://api.highcharts.com/highmaps/yAxis.allowDecimals
*
* @implspec allowDecimals?: boolean;
*
*/
@JSProperty("allowDecimals")
boolean getAllowDecimals();
/**
* (Highcharts, Highstock, Highmaps) Whether to allow decimals in this axis'
* ticks. When counting integers, like persons or hits on a web page,
* decimals should be avoided in the labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.allowDecimals
* @see https://api.highcharts.com/highstock/yAxis.allowDecimals
* @see https://api.highcharts.com/highmaps/yAxis.allowDecimals
*
* @implspec allowDecimals?: boolean;
*
*/
@JSProperty("allowDecimals")
void setAllowDecimals(boolean value);
/**
* (Highcharts, Highstock, Highmaps) When using an alternate grid color, a
* band is painted across the plot area between every other grid line.
*
* @see https://api.highcharts.com/highcharts/yAxis.alternateGridColor
* @see https://api.highcharts.com/highstock/yAxis.alternateGridColor
* @see https://api.highcharts.com/highmaps/yAxis.alternateGridColor
*
* @implspec alternateGridColor?: ColorString;
*
*/
@JSProperty("alternateGridColor")
@Nullable
String getAlternateGridColor();
/**
* (Highcharts, Highstock, Highmaps) When using an alternate grid color, a
* band is painted across the plot area between every other grid line.
*
* @see https://api.highcharts.com/highcharts/yAxis.alternateGridColor
* @see https://api.highcharts.com/highstock/yAxis.alternateGridColor
* @see https://api.highcharts.com/highmaps/yAxis.alternateGridColor
*
* @implspec alternateGridColor?: ColorString;
*
*/
@JSProperty("alternateGridColor")
void setAlternateGridColor(String value);
/**
* (Highcharts) In a polar chart, this is the angle of the Y axis in
* degrees, where 0 is up and 90 is right. The angle determines the position
* of the axis line and the labels, though the coordinate system is
* unaffected.
*
* @see https://api.highcharts.com/highcharts/yAxis.angle
*
* @implspec angle?: number;
*
*/
@JSProperty("angle")
double getAngle();
/**
* (Highcharts) In a polar chart, this is the angle of the Y axis in
* degrees, where 0 is up and 90 is right. The angle determines the position
* of the axis line and the labels, though the coordinate system is
* unaffected.
*
* @see https://api.highcharts.com/highcharts/yAxis.angle
*
* @implspec angle?: number;
*
*/
@JSProperty("angle")
void setAngle(double value);
/**
* (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
* sections defined will be left out and all the points shifted closer to
* each other.
*
* @see https://api.highcharts.com/highcharts/yAxis.breaks
* @see https://api.highcharts.com/highstock/yAxis.breaks
* @see https://api.highcharts.com/gantt/yAxis.breaks
*
* @implspec breaks?: Array;
*
*/
@JSProperty("breaks")
@Nullable
Array getBreaks();
/**
* (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
* sections defined will be left out and all the points shifted closer to
* each other.
*
* @see https://api.highcharts.com/highcharts/yAxis.breaks
* @see https://api.highcharts.com/highstock/yAxis.breaks
* @see https://api.highcharts.com/gantt/yAxis.breaks
*
* @implspec breaks?: Array;
*
*/
@JSProperty("breaks")
void setBreaks(Array value);
/**
* (Highcharts, Gantt) If categories are present for the xAxis, names are
* used instead of numbers for that axis. Since Highcharts 3.0, categories
* can also be extracted by giving each point a name and setting axis type
* to category. However, if you have multiple series, best practice
* remains defining the categories array.
*
* Example:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.categories
* @see https://api.highcharts.com/gantt/yAxis.categories
*
* @implspec categories?: Array;
*
*/
@JSProperty("categories")
@Nullable
String[] getCategories();
/**
* (Highcharts, Gantt) If categories are present for the xAxis, names are
* used instead of numbers for that axis. Since Highcharts 3.0, categories
* can also be extracted by giving each point a name and setting axis type
* to category. However, if you have multiple series, best practice
* remains defining the categories array.
*
* Example:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.categories
* @see https://api.highcharts.com/gantt/yAxis.categories
*
* @implspec categories?: Array;
*
*/
@JSProperty("categories")
void setCategories(String[] value);
/**
* (Highcharts, Highstock, Gantt) The highest allowed value for
* automatically computed axis extremes.
*
* @see https://api.highcharts.com/highcharts/yAxis.ceiling
* @see https://api.highcharts.com/highstock/yAxis.ceiling
* @see https://api.highcharts.com/gantt/yAxis.ceiling
*
* @implspec ceiling?: number;
*
*/
@JSProperty("ceiling")
double getCeiling();
/**
* (Highcharts, Highstock, Gantt) The highest allowed value for
* automatically computed axis extremes.
*
* @see https://api.highcharts.com/highcharts/yAxis.ceiling
* @see https://api.highcharts.com/highstock/yAxis.ceiling
* @see https://api.highcharts.com/gantt/yAxis.ceiling
*
* @implspec ceiling?: number;
*
*/
@JSProperty("ceiling")
void setCeiling(double value);
/**
* (Highcharts, Highstock, Highmaps) A class name that opens for styling the
* axis by CSS, especially in Highcharts styled mode. The class name is
* applied to group elements for the grid, axis elements and labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.className
* @see https://api.highcharts.com/highstock/yAxis.className
* @see https://api.highcharts.com/highmaps/yAxis.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts, Highstock, Highmaps) A class name that opens for styling the
* axis by CSS, especially in Highcharts styled mode. The class name is
* applied to group elements for the grid, axis elements and labels.
*
* @see https://api.highcharts.com/highcharts/yAxis.className
* @see https://api.highcharts.com/highstock/yAxis.className
* @see https://api.highcharts.com/highmaps/yAxis.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts, Highstock, Highmaps) Configure a crosshair that follows
* either the mouse pointer or the hovered point.
*
* In styled mode, the crosshairs are styled in the .highcharts-crosshair,
* .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
*
* @see https://api.highcharts.com/highcharts/yAxis.crosshair
* @see https://api.highcharts.com/highstock/yAxis.crosshair
* @see https://api.highcharts.com/highmaps/yAxis.crosshair
*
* @implspec crosshair?: (boolean|YAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
@Nullable
Unknown getCrosshair();
/**
* (Highcharts, Highstock, Highmaps) Configure a crosshair that follows
* either the mouse pointer or the hovered point.
*
* In styled mode, the crosshairs are styled in the .highcharts-crosshair,
* .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
*
* @see https://api.highcharts.com/highcharts/yAxis.crosshair
* @see https://api.highcharts.com/highstock/yAxis.crosshair
* @see https://api.highcharts.com/highmaps/yAxis.crosshair
*
* @implspec crosshair?: (boolean|YAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
void setCrosshair(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Configure a crosshair that follows
* either the mouse pointer or the hovered point.
*
* In styled mode, the crosshairs are styled in the .highcharts-crosshair,
* .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
*
* @see https://api.highcharts.com/highcharts/yAxis.crosshair
* @see https://api.highcharts.com/highstock/yAxis.crosshair
* @see https://api.highcharts.com/highmaps/yAxis.crosshair
*
* @implspec crosshair?: (boolean|YAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
void setCrosshair(YAxisCrosshairOptions value);
/**
* (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
* automatically adjust to the appropriate unit. This member gives the
* default string representations used for each unit. For intermediate
* values, different units may be used, for example the day unit can be
* used on midnight and hour unit be used for intermediate values on the
* same axis. For an overview of the replacement codes, see dateFormat.
* Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/highstock/yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/gantt/yAxis.dateTimeLabelFormats
*
* @implspec dateTimeLabelFormats?: YAxisDateTimeLabelFormatsOptions;
*
*/
@JSProperty("dateTimeLabelFormats")
@Nullable
YAxisDateTimeLabelFormatsOptions getDateTimeLabelFormats();
/**
* (Highcharts, Highstock, Gantt) For a datetime axis, the scale will
* automatically adjust to the appropriate unit. This member gives the
* default string representations used for each unit. For intermediate
* values, different units may be used, for example the day unit can be
* used on midnight and hour unit be used for intermediate values on the
* same axis. For an overview of the replacement codes, see dateFormat.
* Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/highstock/yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/gantt/yAxis.dateTimeLabelFormats
*
* @implspec dateTimeLabelFormats?: YAxisDateTimeLabelFormatsOptions;
*
*/
@JSProperty("dateTimeLabelFormats")
void setDateTimeLabelFormats(YAxisDateTimeLabelFormatsOptions value);
/**
* (Highcharts, Highstock, Highmaps) Requires Accessibility module
*
* Description of the axis to screen reader users.
*
* @see https://api.highcharts.com/highcharts/yAxis.description
* @see https://api.highcharts.com/highstock/yAxis.description
* @see https://api.highcharts.com/highmaps/yAxis.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highcharts, Highstock, Highmaps) Requires Accessibility module
*
* Description of the axis to screen reader users.
*
* @see https://api.highcharts.com/highcharts/yAxis.description
* @see https://api.highcharts.com/highstock/yAxis.description
* @see https://api.highcharts.com/highmaps/yAxis.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
void setDescription(String value);
/**
* (Highcharts, Highstock, Highmaps) Whether to force the axis to end on a
* tick. Use this option with the maxPadding option to control the axis
* end.
*
* @see https://api.highcharts.com/highcharts/yAxis.endOnTick
* @see https://api.highcharts.com/highstock/yAxis.endOnTick
* @see https://api.highcharts.com/highmaps/yAxis.endOnTick
*
* @implspec endOnTick?: boolean;
*
*/
@JSProperty("endOnTick")
boolean getEndOnTick();
/**
* (Highcharts, Highstock, Highmaps) Whether to force the axis to end on a
* tick. Use this option with the maxPadding option to control the axis
* end.
*
* @see https://api.highcharts.com/highcharts/yAxis.endOnTick
* @see https://api.highcharts.com/highstock/yAxis.endOnTick
* @see https://api.highcharts.com/highmaps/yAxis.endOnTick
*
* @implspec endOnTick?: boolean;
*
*/
@JSProperty("endOnTick")
void setEndOnTick(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Event handlers for the axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.events
* @see https://api.highcharts.com/highstock/yAxis.events
* @see https://api.highcharts.com/highmaps/yAxis.events
*
* @implspec events?: YAxisEventsOptions;
*
*/
@JSProperty("events")
@Nullable
YAxisEventsOptions getEvents();
/**
* (Highcharts, Highstock, Highmaps) Event handlers for the axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.events
* @see https://api.highcharts.com/highstock/yAxis.events
* @see https://api.highcharts.com/highmaps/yAxis.events
*
* @implspec events?: YAxisEventsOptions;
*
*/
@JSProperty("events")
void setEvents(YAxisEventsOptions value);
/**
* (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
* computed axis extremes.
*
* @see https://api.highcharts.com/highcharts/yAxis.floor
* @see https://api.highcharts.com/highstock/yAxis.floor
* @see https://api.highcharts.com/gantt/yAxis.floor
*
* @implspec floor?: number;
*
*/
@JSProperty("floor")
double getFloor();
/**
* (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
* computed axis extremes.
*
* @see https://api.highcharts.com/highcharts/yAxis.floor
* @see https://api.highcharts.com/highstock/yAxis.floor
* @see https://api.highcharts.com/gantt/yAxis.floor
*
* @implspec floor?: number;
*
*/
@JSProperty("floor")
void setFloor(double value);
/**
* (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
*
* @see https://api.highcharts.com/gantt/yAxis.grid
*
* @implspec grid?: YAxisGridOptions;
*
*/
@JSProperty("grid")
@Nullable
YAxisGridOptions getGrid();
/**
* (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
*
* @see https://api.highcharts.com/gantt/yAxis.grid
*
* @implspec grid?: YAxisGridOptions;
*
*/
@JSProperty("grid")
void setGrid(YAxisGridOptions value);
/**
* (Highcharts, Highstock, Highmaps) Color of the grid lines extending the
* ticks across the plot area.
*
* In styled mode, the stroke is given in the .highcharts-grid-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineColor
* @see https://api.highcharts.com/highstock/yAxis.gridLineColor
* @see https://api.highcharts.com/highmaps/yAxis.gridLineColor
*
* @implspec gridLineColor?: ColorString;
*
*/
@JSProperty("gridLineColor")
@Nullable
String getGridLineColor();
/**
* (Highcharts, Highstock, Highmaps) Color of the grid lines extending the
* ticks across the plot area.
*
* In styled mode, the stroke is given in the .highcharts-grid-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineColor
* @see https://api.highcharts.com/highstock/yAxis.gridLineColor
* @see https://api.highcharts.com/highmaps/yAxis.gridLineColor
*
* @implspec gridLineColor?: ColorString;
*
*/
@JSProperty("gridLineColor")
void setGridLineColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The dash or dot style of the grid
* lines. For possible values, see this demonstration.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineDashStyle
* @see https://api.highcharts.com/highstock/yAxis.gridLineDashStyle
* @see https://api.highcharts.com/highmaps/yAxis.gridLineDashStyle
*
* @implspec gridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("gridLineDashStyle")
@Nullable
GridLineDashStyle getGridLineDashStyle();
/**
* (Highcharts, Highstock, Highmaps) The dash or dot style of the grid
* lines. For possible values, see this demonstration.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineDashStyle
* @see https://api.highcharts.com/highstock/yAxis.gridLineDashStyle
* @see https://api.highcharts.com/highmaps/yAxis.gridLineDashStyle
*
* @implspec gridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("gridLineDashStyle")
void setGridLineDashStyle(GridLineDashStyle value);
/**
* (Highcharts) Polar charts only. Whether the grid lines should draw as a
* polygon with straight lines between categories, or as circles. Can be
* either circle or polygon.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineInterpolation
*
* @implspec gridLineInterpolation?: ("circle"|"polygon");
*
*/
@JSProperty("gridLineInterpolation")
@Nullable
GridLineInterpolation getGridLineInterpolation();
/**
* (Highcharts) Polar charts only. Whether the grid lines should draw as a
* polygon with straight lines between categories, or as circles. Can be
* either circle or polygon.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineInterpolation
*
* @implspec gridLineInterpolation?: ("circle"|"polygon");
*
*/
@JSProperty("gridLineInterpolation")
void setGridLineInterpolation(GridLineInterpolation value);
/**
* (Highcharts, Highstock, Highmaps) The width of the grid lines extending
* the ticks across the plot area.
*
* In styled mode, the stroke width is given in the .highcharts-grid-line
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineWidth
* @see https://api.highcharts.com/highstock/yAxis.gridLineWidth
* @see https://api.highcharts.com/highmaps/yAxis.gridLineWidth
*
* @implspec gridLineWidth?: number;
*
*/
@JSProperty("gridLineWidth")
double getGridLineWidth();
/**
* (Highcharts, Highstock, Highmaps) The width of the grid lines extending
* the ticks across the plot area.
*
* In styled mode, the stroke width is given in the .highcharts-grid-line
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridLineWidth
* @see https://api.highcharts.com/highstock/yAxis.gridLineWidth
* @see https://api.highcharts.com/highmaps/yAxis.gridLineWidth
*
* @implspec gridLineWidth?: number;
*
*/
@JSProperty("gridLineWidth")
void setGridLineWidth(double value);
/**
* (Highcharts, Highstock, Gantt) The Z index of the grid lines.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridZIndex
* @see https://api.highcharts.com/highstock/yAxis.gridZIndex
* @see https://api.highcharts.com/gantt/yAxis.gridZIndex
*
* @implspec gridZIndex?: number;
*
*/
@JSProperty("gridZIndex")
double getGridZIndex();
/**
* (Highcharts, Highstock, Gantt) The Z index of the grid lines.
*
* @see https://api.highcharts.com/highcharts/yAxis.gridZIndex
* @see https://api.highcharts.com/highstock/yAxis.gridZIndex
* @see https://api.highcharts.com/gantt/yAxis.gridZIndex
*
* @implspec gridZIndex?: number;
*
*/
@JSProperty("gridZIndex")
void setGridZIndex(double value);
/**
* (Highstock) The height of the Y axis. If it's a number, it is interpreted
* as pixels.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the total plot height.
*
* @see https://api.highcharts.com/highstock/yAxis.height
*
* @implspec height?: (number|string);
*
*/
@JSProperty("height")
@Nullable
Unknown getHeight();
/**
* (Highstock) The height of the Y axis. If it's a number, it is interpreted
* as pixels.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the total plot height.
*
* @see https://api.highcharts.com/highstock/yAxis.height
*
* @implspec height?: (number|string);
*
*/
@JSProperty("height")
void setHeight(double value);
/**
* (Highstock) The height of the Y axis. If it's a number, it is interpreted
* as pixels.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the total plot height.
*
* @see https://api.highcharts.com/highstock/yAxis.height
*
* @implspec height?: (number|string);
*
*/
@JSProperty("height")
void setHeight(String value);
/**
* (Highcharts, Highstock, Highmaps) An id for the axis. This can be used
* after render time to get a pointer to the axis object through
* chart.get().
*
* @see https://api.highcharts.com/highcharts/yAxis.id
* @see https://api.highcharts.com/highstock/yAxis.id
* @see https://api.highcharts.com/highmaps/yAxis.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
@Nullable
String getId();
/**
* (Highcharts, Highstock, Highmaps) An id for the axis. This can be used
* after render time to get a pointer to the axis object through
* chart.get().
*
* @see https://api.highcharts.com/highcharts/yAxis.id
* @see https://api.highcharts.com/highstock/yAxis.id
* @see https://api.highcharts.com/highmaps/yAxis.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
void setId(String value);
/**
* (Highcharts, Highstock, Highmaps) The axis labels show the number or
* category for each tick.
*
* @see https://api.highcharts.com/highcharts/yAxis.labels
* @see https://api.highcharts.com/highstock/yAxis.labels
* @see https://api.highcharts.com/highmaps/yAxis.labels
*
* @implspec labels?: YAxisLabelsOptions;
*
*/
@JSProperty("labels")
@Nullable
YAxisLabelsOptions getLabels();
/**
* (Highcharts, Highstock, Highmaps) The axis labels show the number or
* category for each tick.
*
* @see https://api.highcharts.com/highcharts/yAxis.labels
* @see https://api.highcharts.com/highstock/yAxis.labels
* @see https://api.highcharts.com/highmaps/yAxis.labels
*
* @implspec labels?: YAxisLabelsOptions;
*
*/
@JSProperty("labels")
void setLabels(YAxisLabelsOptions value);
/**
* (Highcharts, Highstock, Highmaps) The color of the line marking the axis
* itself.
*
* In styled mode, the line stroke is given in the .highcharts-axis-line
* or .highcharts-xaxis-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.lineColor
* @see https://api.highcharts.com/highstock/yAxis.lineColor
* @see https://api.highcharts.com/highmaps/yAxis.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
@Nullable
String getLineColor();
/**
* (Highcharts, Highstock, Highmaps) The color of the line marking the axis
* itself.
*
* In styled mode, the line stroke is given in the .highcharts-axis-line
* or .highcharts-xaxis-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.lineColor
* @see https://api.highcharts.com/highstock/yAxis.lineColor
* @see https://api.highcharts.com/highmaps/yAxis.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
void setLineColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The width of the line marking the axis
* itself.
*
* In styled mode, the stroke width is given in the .highcharts-axis-line
* or .highcharts-xaxis-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.lineWidth
* @see https://api.highcharts.com/highstock/yAxis.lineWidth
* @see https://api.highcharts.com/highmaps/yAxis.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
double getLineWidth();
/**
* (Highcharts, Highstock, Highmaps) The width of the line marking the axis
* itself.
*
* In styled mode, the stroke width is given in the .highcharts-axis-line
* or .highcharts-xaxis-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.lineWidth
* @see https://api.highcharts.com/highstock/yAxis.lineWidth
* @see https://api.highcharts.com/highmaps/yAxis.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
void setLineWidth(double value);
/**
* (Highcharts, Highstock, Gantt) Index of another axis that this axis is
* linked to. When an axis is linked to a master axis, it will take the same
* extremes as the master, but as assigned by min or max or by setExtremes.
* It can be used to show additional info, or to ease reading the chart by
* duplicating the scales.
*
* @see https://api.highcharts.com/highcharts/yAxis.linkedTo
* @see https://api.highcharts.com/highstock/yAxis.linkedTo
* @see https://api.highcharts.com/gantt/yAxis.linkedTo
*
* @implspec linkedTo?: number;
*
*/
@JSProperty("linkedTo")
double getLinkedTo();
/**
* (Highcharts, Highstock, Gantt) Index of another axis that this axis is
* linked to. When an axis is linked to a master axis, it will take the same
* extremes as the master, but as assigned by min or max or by setExtremes.
* It can be used to show additional info, or to ease reading the chart by
* duplicating the scales.
*
* @see https://api.highcharts.com/highcharts/yAxis.linkedTo
* @see https://api.highcharts.com/highstock/yAxis.linkedTo
* @see https://api.highcharts.com/gantt/yAxis.linkedTo
*
* @implspec linkedTo?: number;
*
*/
@JSProperty("linkedTo")
void setLinkedTo(double value);
/**
* (Highcharts, Highstock, Highmaps) The maximum value of the axis. If
* null, the max value is automatically calculated.
*
* If the endOnTick option is true, the max value might be rounded up.
*
* If a tickAmount is set, the axis may be extended beyond the set max in
* order to reach the given number of ticks. The same may happen in a chart
* with multiple axes, determined by chart. alignTicks, where a tickAmount
* is applied internally.
*
* @see https://api.highcharts.com/highcharts/yAxis.max
* @see https://api.highcharts.com/highstock/yAxis.max
* @see https://api.highcharts.com/highmaps/yAxis.max
*
* @implspec max?: number;
*
*/
@JSProperty("max")
double getMax();
/**
* (Highcharts, Highstock, Highmaps) The maximum value of the axis. If
* null, the max value is automatically calculated.
*
* If the endOnTick option is true, the max value might be rounded up.
*
* If a tickAmount is set, the axis may be extended beyond the set max in
* order to reach the given number of ticks. The same may happen in a chart
* with multiple axes, determined by chart. alignTicks, where a tickAmount
* is applied internally.
*
* @see https://api.highcharts.com/highcharts/yAxis.max
* @see https://api.highcharts.com/highstock/yAxis.max
* @see https://api.highcharts.com/highmaps/yAxis.max
*
* @implspec max?: number;
*
*/
@JSProperty("max")
void setMax(double value);
/**
* (Highcharts) Solid gauge only. Unless stops are set, the color to
* represent the maximum value of the Y axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxColor
*
* @implspec maxColor?: ColorString;
*
*/
@JSProperty("maxColor")
@Nullable
String getMaxColor();
/**
* (Highcharts) Solid gauge only. Unless stops are set, the color to
* represent the maximum value of the Y axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxColor
*
* @implspec maxColor?: ColorString;
*
*/
@JSProperty("maxColor")
void setMaxColor(String value);
/**
* (Highstock) Maximal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.maxLength
*
* @implspec maxLength?: (number|string);
*
*/
@JSProperty("maxLength")
@Nullable
Unknown getMaxLength();
/**
* (Highstock) Maximal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.maxLength
*
* @implspec maxLength?: (number|string);
*
*/
@JSProperty("maxLength")
void setMaxLength(double value);
/**
* (Highstock) Maximal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.maxLength
*
* @implspec maxLength?: (number|string);
*
*/
@JSProperty("maxLength")
void setMaxLength(String value);
/**
* (Highcharts, Highstock, Gantt) Padding of the max value relative to the
* length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
* This is useful when you don't want the highest data value to appear on
* the edge of the plot area. When the axis' max option is set or a max
* extreme is set using axis.setExtremes(), the maxPadding will be
* ignored.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxPadding
* @see https://api.highcharts.com/highstock/yAxis.maxPadding
* @see https://api.highcharts.com/gantt/yAxis.maxPadding
*
* @implspec maxPadding?: number;
*
*/
@JSProperty("maxPadding")
double getMaxPadding();
/**
* (Highcharts, Highstock, Gantt) Padding of the max value relative to the
* length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
* This is useful when you don't want the highest data value to appear on
* the edge of the plot area. When the axis' max option is set or a max
* extreme is set using axis.setExtremes(), the maxPadding will be
* ignored.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxPadding
* @see https://api.highcharts.com/highstock/yAxis.maxPadding
* @see https://api.highcharts.com/gantt/yAxis.maxPadding
*
* @implspec maxPadding?: number;
*
*/
@JSProperty("maxPadding")
void setMaxPadding(double value);
/**
* (Highstock) Maximum range which can be set using the navigator's handles.
* Opposite of xAxis.minRange.
*
* @see https://api.highcharts.com/highstock/yAxis.maxRange
*
* @implspec maxRange?: number;
*
*/
@JSProperty("maxRange")
double getMaxRange();
/**
* (Highstock) Maximum range which can be set using the navigator's handles.
* Opposite of xAxis.minRange.
*
* @see https://api.highcharts.com/highstock/yAxis.maxRange
*
* @implspec maxRange?: number;
*
*/
@JSProperty("maxRange")
void setMaxRange(double value);
/**
* (Highcharts, Highstock) Deprecated. Use minRange instead.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxZoom
* @see https://api.highcharts.com/highstock/yAxis.maxZoom
*
* @implspec maxZoom?: number;
*
*/
@JSProperty("maxZoom")
double getMaxZoom();
/**
* (Highcharts, Highstock) Deprecated. Use minRange instead.
*
* @see https://api.highcharts.com/highcharts/yAxis.maxZoom
* @see https://api.highcharts.com/highstock/yAxis.maxZoom
*
* @implspec maxZoom?: number;
*
*/
@JSProperty("maxZoom")
void setMaxZoom(double value);
/**
* (Highcharts, Highstock, Highmaps) The minimum value of the axis. If
* null the min value is automatically calculated.
*
* If the startOnTick option is true (default), the min value might be
* rounded down.
*
* The automatically calculated minimum value is also affected by floor,
* softMin, minPadding, minRange as well as series.threshold and
* series.softThreshold.
*
* @see https://api.highcharts.com/highcharts/yAxis.min
* @see https://api.highcharts.com/highstock/yAxis.min
* @see https://api.highcharts.com/highmaps/yAxis.min
*
* @implspec min?: number;
*
*/
@JSProperty("min")
double getMin();
/**
* (Highcharts, Highstock, Highmaps) The minimum value of the axis. If
* null the min value is automatically calculated.
*
* If the startOnTick option is true (default), the min value might be
* rounded down.
*
* The automatically calculated minimum value is also affected by floor,
* softMin, minPadding, minRange as well as series.threshold and
* series.softThreshold.
*
* @see https://api.highcharts.com/highcharts/yAxis.min
* @see https://api.highcharts.com/highstock/yAxis.min
* @see https://api.highcharts.com/highmaps/yAxis.min
*
* @implspec min?: number;
*
*/
@JSProperty("min")
void setMin(double value);
/**
* (Highcharts) Solid gauge only. Unless stops are set, the color to
* represent the minimum value of the Y axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.minColor
*
* @implspec minColor?: ColorString;
*
*/
@JSProperty("minColor")
@Nullable
String getMinColor();
/**
* (Highcharts) Solid gauge only. Unless stops are set, the color to
* represent the minimum value of the Y axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.minColor
*
* @implspec minColor?: ColorString;
*
*/
@JSProperty("minColor")
void setMinColor(String value);
/**
* (Highstock) Minimal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.minLength
*
* @implspec minLength?: (number|string);
*
*/
@JSProperty("minLength")
@Nullable
Unknown getMinLength();
/**
* (Highstock) Minimal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.minLength
*
* @implspec minLength?: (number|string);
*
*/
@JSProperty("minLength")
void setMinLength(double value);
/**
* (Highstock) Minimal size of a resizable axis. Could be set as a percent
* of plot area or pixel size.
*
* This feature requires the drag-panes.js module.
*
* @see https://api.highcharts.com/highstock/yAxis.minLength
*
* @implspec minLength?: (number|string);
*
*/
@JSProperty("minLength")
void setMinLength(String value);
/**
* (Highcharts, Highstock, Highmaps) Color of the minor, secondary grid
* lines.
*
* In styled mode, the stroke width is given in the
* .highcharts-minor-grid-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineColor
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineColor
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineColor
*
* @implspec minorGridLineColor?: ColorString;
*
*/
@JSProperty("minorGridLineColor")
@Nullable
String getMinorGridLineColor();
/**
* (Highcharts, Highstock, Highmaps) Color of the minor, secondary grid
* lines.
*
* In styled mode, the stroke width is given in the
* .highcharts-minor-grid-line class.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineColor
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineColor
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineColor
*
* @implspec minorGridLineColor?: ColorString;
*
*/
@JSProperty("minorGridLineColor")
void setMinorGridLineColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The dash or dot style of the minor grid
* lines. For possible values, see this demonstration.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineDashStyle
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineDashStyle
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineDashStyle
*
* @implspec minorGridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("minorGridLineDashStyle")
@Nullable
MinorGridLineDashStyle getMinorGridLineDashStyle();
/**
* (Highcharts, Highstock, Highmaps) The dash or dot style of the minor grid
* lines. For possible values, see this demonstration.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineDashStyle
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineDashStyle
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineDashStyle
*
* @implspec minorGridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("minorGridLineDashStyle")
void setMinorGridLineDashStyle(MinorGridLineDashStyle value);
/**
* (Highcharts, Highstock, Highmaps) Width of the minor, secondary grid
* lines.
*
* In styled mode, the stroke width is given in the .highcharts-grid-line
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineWidth
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineWidth
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineWidth
*
* @implspec minorGridLineWidth?: number;
*
*/
@JSProperty("minorGridLineWidth")
double getMinorGridLineWidth();
/**
* (Highcharts, Highstock, Highmaps) Width of the minor, secondary grid
* lines.
*
* In styled mode, the stroke width is given in the .highcharts-grid-line
* class.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorGridLineWidth
* @see https://api.highcharts.com/highstock/yAxis.minorGridLineWidth
* @see https://api.highcharts.com/highmaps/yAxis.minorGridLineWidth
*
* @implspec minorGridLineWidth?: number;
*
*/
@JSProperty("minorGridLineWidth")
void setMinorGridLineWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) Color for the minor tick marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickColor
* @see https://api.highcharts.com/highstock/yAxis.minorTickColor
* @see https://api.highcharts.com/highmaps/yAxis.minorTickColor
*
* @implspec minorTickColor?: ColorString;
*
*/
@JSProperty("minorTickColor")
@Nullable
String getMinorTickColor();
/**
* (Highcharts, Highstock, Highmaps) Color for the minor tick marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickColor
* @see https://api.highcharts.com/highstock/yAxis.minorTickColor
* @see https://api.highcharts.com/highmaps/yAxis.minorTickColor
*
* @implspec minorTickColor?: ColorString;
*
*/
@JSProperty("minorTickColor")
void setMinorTickColor(String value);
/**
* (Highcharts, Highstock, Highmaps) Specific tick interval in axis units
* for the minor ticks. On a linear axis, if "auto", the minor tick
* interval is calculated as a fifth of the tickInterval. If null or
* undefined, minor ticks are not shown.
*
* On logarithmic axes, the unit is the power of the value. For example,
* setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
* 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
* and 10, 10 and 100 etc.
*
* If user settings dictate minor ticks to become too dense, they don't make
* sense, and will be ignored to prevent performance problems.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickInterval
* @see https://api.highcharts.com/highstock/yAxis.minorTickInterval
* @see https://api.highcharts.com/highmaps/yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
@Nullable
Unknown getMinorTickInterval();
/**
* (Highcharts, Highstock, Highmaps) Specific tick interval in axis units
* for the minor ticks. On a linear axis, if "auto", the minor tick
* interval is calculated as a fifth of the tickInterval. If null or
* undefined, minor ticks are not shown.
*
* On logarithmic axes, the unit is the power of the value. For example,
* setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
* 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
* and 10, 10 and 100 etc.
*
* If user settings dictate minor ticks to become too dense, they don't make
* sense, and will be ignored to prevent performance problems.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickInterval
* @see https://api.highcharts.com/highstock/yAxis.minorTickInterval
* @see https://api.highcharts.com/highmaps/yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
void setMinorTickInterval(double value);
/**
* (Highcharts, Highstock, Highmaps) Specific tick interval in axis units
* for the minor ticks. On a linear axis, if "auto", the minor tick
* interval is calculated as a fifth of the tickInterval. If null or
* undefined, minor ticks are not shown.
*
* On logarithmic axes, the unit is the power of the value. For example,
* setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10,
* 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1
* and 10, 10 and 100 etc.
*
* If user settings dictate minor ticks to become too dense, they don't make
* sense, and will be ignored to prevent performance problems.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickInterval
* @see https://api.highcharts.com/highstock/yAxis.minorTickInterval
* @see https://api.highcharts.com/highmaps/yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
void setMinorTickInterval(String value);
/**
* (Highcharts, Highstock, Highmaps) The pixel length of the minor tick
* marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickLength
* @see https://api.highcharts.com/highstock/yAxis.minorTickLength
* @see https://api.highcharts.com/highmaps/yAxis.minorTickLength
*
* @implspec minorTickLength?: number;
*
*/
@JSProperty("minorTickLength")
double getMinorTickLength();
/**
* (Highcharts, Highstock, Highmaps) The pixel length of the minor tick
* marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickLength
* @see https://api.highcharts.com/highstock/yAxis.minorTickLength
* @see https://api.highcharts.com/highmaps/yAxis.minorTickLength
*
* @implspec minorTickLength?: number;
*
*/
@JSProperty("minorTickLength")
void setMinorTickLength(double value);
/**
* (Highcharts, Highstock, Highmaps) The position of the minor tick marks
* relative to the axis line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickPosition
* @see https://api.highcharts.com/highstock/yAxis.minorTickPosition
* @see https://api.highcharts.com/highmaps/yAxis.minorTickPosition
*
* @implspec minorTickPosition?: ("inside"|"outside");
*
*/
@JSProperty("minorTickPosition")
@Nullable
MinorTickPosition getMinorTickPosition();
/**
* (Highcharts, Highstock, Highmaps) The position of the minor tick marks
* relative to the axis line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickPosition
* @see https://api.highcharts.com/highstock/yAxis.minorTickPosition
* @see https://api.highcharts.com/highmaps/yAxis.minorTickPosition
*
* @implspec minorTickPosition?: ("inside"|"outside");
*
*/
@JSProperty("minorTickPosition")
void setMinorTickPosition(MinorTickPosition value);
/**
* (Highcharts, Highstock, Highmaps) Enable or disable minor ticks. Unless
* minorTickInterval is set, the tick interval is calculated as a fifth of
* the tickInterval.
*
* On a logarithmic axis, minor ticks are laid out based on a best guess,
* attempting to enter approximately 5 minor ticks between each major tick.
*
* Prior to v6.0.0, ticks were unabled in auto layout by setting
* minorTickInterval to "auto".
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTicks
* @see https://api.highcharts.com/highstock/yAxis.minorTicks
* @see https://api.highcharts.com/highmaps/yAxis.minorTicks
*
* @implspec minorTicks?: boolean;
*
*/
@JSProperty("minorTicks")
boolean getMinorTicks();
/**
* (Highcharts, Highstock, Highmaps) Enable or disable minor ticks. Unless
* minorTickInterval is set, the tick interval is calculated as a fifth of
* the tickInterval.
*
* On a logarithmic axis, minor ticks are laid out based on a best guess,
* attempting to enter approximately 5 minor ticks between each major tick.
*
* Prior to v6.0.0, ticks were unabled in auto layout by setting
* minorTickInterval to "auto".
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTicks
* @see https://api.highcharts.com/highstock/yAxis.minorTicks
* @see https://api.highcharts.com/highmaps/yAxis.minorTicks
*
* @implspec minorTicks?: boolean;
*
*/
@JSProperty("minorTicks")
void setMinorTicks(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the minor tick mark.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickWidth
* @see https://api.highcharts.com/highstock/yAxis.minorTickWidth
* @see https://api.highcharts.com/highmaps/yAxis.minorTickWidth
*
* @implspec minorTickWidth?: number;
*
*/
@JSProperty("minorTickWidth")
double getMinorTickWidth();
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the minor tick mark.
*
* @see https://api.highcharts.com/highcharts/yAxis.minorTickWidth
* @see https://api.highcharts.com/highstock/yAxis.minorTickWidth
* @see https://api.highcharts.com/highmaps/yAxis.minorTickWidth
*
* @implspec minorTickWidth?: number;
*
*/
@JSProperty("minorTickWidth")
void setMinorTickWidth(double value);
/**
* (Highcharts, Highstock, Gantt) Padding of the min value relative to the
* length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
* This is useful when you don't want the lowest data value to appear on the
* edge of the plot area. When the axis' min option is set or a max
* extreme is set using axis.setExtremes(), the maxPadding will be
* ignored.
*
* @see https://api.highcharts.com/highcharts/yAxis.minPadding
* @see https://api.highcharts.com/highstock/yAxis.minPadding
* @see https://api.highcharts.com/gantt/yAxis.minPadding
*
* @implspec minPadding?: number;
*
*/
@JSProperty("minPadding")
double getMinPadding();
/**
* (Highcharts, Highstock, Gantt) Padding of the min value relative to the
* length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
* This is useful when you don't want the lowest data value to appear on the
* edge of the plot area. When the axis' min option is set or a max
* extreme is set using axis.setExtremes(), the maxPadding will be
* ignored.
*
* @see https://api.highcharts.com/highcharts/yAxis.minPadding
* @see https://api.highcharts.com/highstock/yAxis.minPadding
* @see https://api.highcharts.com/gantt/yAxis.minPadding
*
* @implspec minPadding?: number;
*
*/
@JSProperty("minPadding")
void setMinPadding(double value);
/**
* (Highcharts, Highstock, Highmaps) The minimum range to display on this
* axis. The entire axis will not be allowed to span over a smaller interval
* than this. For example, for a datetime axis the main unit is
* milliseconds. If minRange is set to 3600000, you can't zoom in more than
* to one hour.
*
* The default minRange for the x axis is five times the smallest interval
* between any of the data points.
*
* On a logarithmic axis, the unit for the minimum range is the power. So a
* minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
* 1000-10000 etc.
*
* Note that the minPadding, maxPadding, startOnTick and endOnTick
* settings also affect how the extremes of the axis are computed.
*
* @see https://api.highcharts.com/highcharts/yAxis.minRange
* @see https://api.highcharts.com/highstock/yAxis.minRange
* @see https://api.highcharts.com/highmaps/yAxis.minRange
*
* @implspec minRange?: number;
*
*/
@JSProperty("minRange")
double getMinRange();
/**
* (Highcharts, Highstock, Highmaps) The minimum range to display on this
* axis. The entire axis will not be allowed to span over a smaller interval
* than this. For example, for a datetime axis the main unit is
* milliseconds. If minRange is set to 3600000, you can't zoom in more than
* to one hour.
*
* The default minRange for the x axis is five times the smallest interval
* between any of the data points.
*
* On a logarithmic axis, the unit for the minimum range is the power. So a
* minRange of 1 means that the axis can be zoomed to 10-100, 100-1000,
* 1000-10000 etc.
*
* Note that the minPadding, maxPadding, startOnTick and endOnTick
* settings also affect how the extremes of the axis are computed.
*
* @see https://api.highcharts.com/highcharts/yAxis.minRange
* @see https://api.highcharts.com/highstock/yAxis.minRange
* @see https://api.highcharts.com/highmaps/yAxis.minRange
*
* @implspec minRange?: number;
*
*/
@JSProperty("minRange")
void setMinRange(double value);
/**
* (Highcharts, Highstock, Highmaps) The minimum tick interval allowed in
* axis values. For example on zooming in on an axis with daily data, this
* can be used to prevent the axis from showing hours. Defaults to the
* closest distance between two points on the axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.minTickInterval
* @see https://api.highcharts.com/highstock/yAxis.minTickInterval
* @see https://api.highcharts.com/highmaps/yAxis.minTickInterval
*
* @implspec minTickInterval?: number;
*
*/
@JSProperty("minTickInterval")
double getMinTickInterval();
/**
* (Highcharts, Highstock, Highmaps) The minimum tick interval allowed in
* axis values. For example on zooming in on an axis with daily data, this
* can be used to prevent the axis from showing hours. Defaults to the
* closest distance between two points on the axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.minTickInterval
* @see https://api.highcharts.com/highstock/yAxis.minTickInterval
* @see https://api.highcharts.com/highmaps/yAxis.minTickInterval
*
* @implspec minTickInterval?: number;
*
*/
@JSProperty("minTickInterval")
void setMinTickInterval(double value);
/**
* (Highcharts, Highstock, Highmaps) The distance in pixels from the plot
* area to the axis line. A positive offset moves the axis with it's line,
* labels and ticks away from the plot area. This is typically used when two
* or more axes are displayed on the same side of the plot. With multiple
* axes the offset is dynamically adjusted to avoid collision, this can be
* overridden by setting offset explicitly.
*
* @see https://api.highcharts.com/highcharts/yAxis.offset
* @see https://api.highcharts.com/highstock/yAxis.offset
* @see https://api.highcharts.com/highmaps/yAxis.offset
*
* @implspec offset?: number;
*
*/
@JSProperty("offset")
double getOffset();
/**
* (Highcharts, Highstock, Highmaps) The distance in pixels from the plot
* area to the axis line. A positive offset moves the axis with it's line,
* labels and ticks away from the plot area. This is typically used when two
* or more axes are displayed on the same side of the plot. With multiple
* axes the offset is dynamically adjusted to avoid collision, this can be
* overridden by setting offset explicitly.
*
* @see https://api.highcharts.com/highcharts/yAxis.offset
* @see https://api.highcharts.com/highstock/yAxis.offset
* @see https://api.highcharts.com/highmaps/yAxis.offset
*
* @implspec offset?: number;
*
*/
@JSProperty("offset")
void setOffset(double value);
/**
* (Highstock, Highcharts, Gantt) Whether to display the axis on the
* opposite side of the normal. The normal is on the left side for vertical
* axes and bottom for horizontal, so the opposite sides will be right and
* top respectively. This is typically used with dual or multiple axes.
*
* @see https://api.highcharts.com/highstock/yAxis.opposite
* @see https://api.highcharts.com/highcharts/yAxis.opposite
* @see https://api.highcharts.com/gantt/yAxis.opposite
*
* @implspec opposite?: boolean;
*
*/
@JSProperty("opposite")
boolean getOpposite();
/**
* (Highstock, Highcharts, Gantt) Whether to display the axis on the
* opposite side of the normal. The normal is on the left side for vertical
* axes and bottom for horizontal, so the opposite sides will be right and
* top respectively. This is typically used with dual or multiple axes.
*
* @see https://api.highcharts.com/highstock/yAxis.opposite
* @see https://api.highcharts.com/highcharts/yAxis.opposite
* @see https://api.highcharts.com/gantt/yAxis.opposite
*
* @implspec opposite?: boolean;
*
*/
@JSProperty("opposite")
void setOpposite(boolean value);
/**
* (Highcharts) Refers to the index in the panes array. Used for circular
* gauges and polar charts. When the option is not set then first pane will
* be used.
*
* @see https://api.highcharts.com/highcharts/yAxis.pane
*
* @implspec pane?: number;
*
*/
@JSProperty("pane")
double getPane();
/**
* (Highcharts) Refers to the index in the panes array. Used for circular
* gauges and polar charts. When the option is not set then first pane will
* be used.
*
* @see https://api.highcharts.com/highcharts/yAxis.pane
*
* @implspec pane?: number;
*
*/
@JSProperty("pane")
void setPane(double value);
/**
* (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
*
* @implspec plotBands?: Array;
*
*/
@JSProperty("plotBands")
@Nullable
Array getPlotBands();
/**
* (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
*
* @implspec plotBands?: Array;
*
*/
@JSProperty("plotBands")
void setPlotBands(Array value);
/**
* (Highcharts, Highstock, Gantt) An array of objects representing plot
* lines on the X axis
*
* @see https://api.highcharts.com/highcharts/yAxis.plotLines
* @see https://api.highcharts.com/highstock/yAxis.plotLines
* @see https://api.highcharts.com/gantt/yAxis.plotLines
*
* @implspec plotLines?: Array;
*
*/
@JSProperty("plotLines")
@Nullable
Array getPlotLines();
/**
* (Highcharts, Highstock, Gantt) An array of objects representing plot
* lines on the X axis
*
* @see https://api.highcharts.com/highcharts/yAxis.plotLines
* @see https://api.highcharts.com/highstock/yAxis.plotLines
* @see https://api.highcharts.com/gantt/yAxis.plotLines
*
* @implspec plotLines?: Array;
*
*/
@JSProperty("plotLines")
void setPlotLines(Array value);
/**
* (Highstock) The zoomed range to display when only defining one or none of
* min or max. For example, to show the latest month, a range of one
* month can be set.
*
* @see https://api.highcharts.com/highstock/yAxis.range
*
* @implspec range?: number;
*
*/
@JSProperty("range")
double getRange();
/**
* (Highstock) The zoomed range to display when only defining one or none of
* min or max. For example, to show the latest month, a range of one
* month can be set.
*
* @see https://api.highcharts.com/highstock/yAxis.range
*
* @implspec range?: number;
*
*/
@JSProperty("range")
void setRange(double value);
/**
* (Highstock) Options for axis resizing. This feature requires the
* drag-panes.js - classic or styled mode - module.
*
* @see https://api.highcharts.com/highstock/yAxis.resize
*
* @implspec resize?: YAxisResizeOptions;
*
*/
@JSProperty("resize")
@Nullable
YAxisResizeOptions getResize();
/**
* (Highstock) Options for axis resizing. This feature requires the
* drag-panes.js - classic or styled mode - module.
*
* @see https://api.highcharts.com/highstock/yAxis.resize
*
* @implspec resize?: YAxisResizeOptions;
*
*/
@JSProperty("resize")
void setResize(YAxisResizeOptions value);
/**
* (Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
* highest number is closest to the origin.
*
* @see https://api.highcharts.com/highcharts/yAxis.reversed
* @see https://api.highcharts.com/highstock/yAxis.reversed
* @see https://api.highcharts.com/highmaps/yAxis.reversed
*
* @implspec reversed?: boolean;
*
*/
@JSProperty("reversed")
boolean getReversed();
/**
* (Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
* highest number is closest to the origin.
*
* @see https://api.highcharts.com/highcharts/yAxis.reversed
* @see https://api.highcharts.com/highstock/yAxis.reversed
* @see https://api.highcharts.com/highmaps/yAxis.reversed
*
* @implspec reversed?: boolean;
*
*/
@JSProperty("reversed")
void setReversed(boolean value);
/**
* (Highcharts, Highstock) If true, the first series in a stack will be
* drawn on top in a positive, non-reversed Y axis. If false, the first
* series is in the base of the stack.
*
* @see https://api.highcharts.com/highcharts/yAxis.reversedStacks
* @see https://api.highcharts.com/highstock/yAxis.reversedStacks
*
* @implspec reversedStacks?: boolean;
*
*/
@JSProperty("reversedStacks")
boolean getReversedStacks();
/**
* (Highcharts, Highstock) If true, the first series in a stack will be
* drawn on top in a positive, non-reversed Y axis. If false, the first
* series is in the base of the stack.
*
* @see https://api.highcharts.com/highcharts/yAxis.reversedStacks
* @see https://api.highcharts.com/highstock/yAxis.reversedStacks
*
* @implspec reversedStacks?: boolean;
*
*/
@JSProperty("reversedStacks")
void setReversedStacks(boolean value);
/**
* (Highstock) An optional scrollbar to display on the Y axis in response to
* limiting the minimum an maximum of the axis values.
*
* In styled mode, all the presentational options for the scrollbar are
* replaced by the classes .highcharts-scrollbar-thumb,
* .highcharts-scrollbar-arrow, .highcharts-scrollbar-button,
* .highcharts-scrollbar-rifles and .highcharts-scrollbar-track.
*
* @see https://api.highcharts.com/highstock/yAxis.scrollbar
*
* @implspec scrollbar?: YAxisScrollbarOptions;
*
*/
@JSProperty("scrollbar")
@Nullable
YAxisScrollbarOptions getScrollbar();
/**
* (Highstock) An optional scrollbar to display on the Y axis in response to
* limiting the minimum an maximum of the axis values.
*
* In styled mode, all the presentational options for the scrollbar are
* replaced by the classes .highcharts-scrollbar-thumb,
* .highcharts-scrollbar-arrow, .highcharts-scrollbar-button,
* .highcharts-scrollbar-rifles and .highcharts-scrollbar-track.
*
* @see https://api.highcharts.com/highstock/yAxis.scrollbar
*
* @implspec scrollbar?: YAxisScrollbarOptions;
*
*/
@JSProperty("scrollbar")
void setScrollbar(YAxisScrollbarOptions value);
/**
* (Highcharts, Highstock, Highmaps) Whether to show the axis line and title
* when the axis has no data.
*
* @see https://api.highcharts.com/highcharts/yAxis.showEmpty
* @see https://api.highcharts.com/highstock/yAxis.showEmpty
* @see https://api.highcharts.com/highmaps/yAxis.showEmpty
*
* @implspec showEmpty?: boolean;
*
*/
@JSProperty("showEmpty")
boolean getShowEmpty();
/**
* (Highcharts, Highstock, Highmaps) Whether to show the axis line and title
* when the axis has no data.
*
* @see https://api.highcharts.com/highcharts/yAxis.showEmpty
* @see https://api.highcharts.com/highstock/yAxis.showEmpty
* @see https://api.highcharts.com/highmaps/yAxis.showEmpty
*
* @implspec showEmpty?: boolean;
*
*/
@JSProperty("showEmpty")
void setShowEmpty(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to show the first tick label.
*
* @see https://api.highcharts.com/highcharts/yAxis.showFirstLabel
* @see https://api.highcharts.com/highstock/yAxis.showFirstLabel
* @see https://api.highcharts.com/highmaps/yAxis.showFirstLabel
*
* @implspec showFirstLabel?: boolean;
*
*/
@JSProperty("showFirstLabel")
boolean getShowFirstLabel();
/**
* (Highcharts, Highstock, Highmaps) Whether to show the first tick label.
*
* @see https://api.highcharts.com/highcharts/yAxis.showFirstLabel
* @see https://api.highcharts.com/highstock/yAxis.showFirstLabel
* @see https://api.highcharts.com/highmaps/yAxis.showFirstLabel
*
* @implspec showFirstLabel?: boolean;
*
*/
@JSProperty("showFirstLabel")
void setShowFirstLabel(boolean value);
/**
* (Highcharts, Highstock, Gantt) Whether to show the last tick label.
* Defaults to true on cartesian charts, and false on polar charts.
*
* @see https://api.highcharts.com/highcharts/yAxis.showLastLabel
* @see https://api.highcharts.com/highstock/yAxis.showLastLabel
* @see https://api.highcharts.com/gantt/yAxis.showLastLabel
*
* @implspec showLastLabel?: boolean;
*
*/
@JSProperty("showLastLabel")
boolean getShowLastLabel();
/**
* (Highcharts, Highstock, Gantt) Whether to show the last tick label.
* Defaults to true on cartesian charts, and false on polar charts.
*
* @see https://api.highcharts.com/highcharts/yAxis.showLastLabel
* @see https://api.highcharts.com/highstock/yAxis.showLastLabel
* @see https://api.highcharts.com/gantt/yAxis.showLastLabel
*
* @implspec showLastLabel?: boolean;
*
*/
@JSProperty("showLastLabel")
void setShowLastLabel(boolean value);
/**
* (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
* data maximum is less than this, the axis will stay at this maximum, but
* if the series data maximum is higher, the axis will flex to show all
* data.
*
* Note: The series.softThreshold option takes precedence over this
* option.
*
* @see https://api.highcharts.com/highcharts/yAxis.softMax
* @see https://api.highcharts.com/highstock/yAxis.softMax
* @see https://api.highcharts.com/gantt/yAxis.softMax
*
* @implspec softMax?: number;
*
*/
@JSProperty("softMax")
double getSoftMax();
/**
* (Highcharts, Highstock, Gantt) A soft maximum for the axis. If the series
* data maximum is less than this, the axis will stay at this maximum, but
* if the series data maximum is higher, the axis will flex to show all
* data.
*
* Note: The series.softThreshold option takes precedence over this
* option.
*
* @see https://api.highcharts.com/highcharts/yAxis.softMax
* @see https://api.highcharts.com/highstock/yAxis.softMax
* @see https://api.highcharts.com/gantt/yAxis.softMax
*
* @implspec softMax?: number;
*
*/
@JSProperty("softMax")
void setSoftMax(double value);
/**
* (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
* data minimum is greater than this, the axis will stay at this minimum,
* but if the series data minimum is lower, the axis will flex to show all
* data.
*
* Note: The series.softThreshold option takes precedence over this
* option.
*
* @see https://api.highcharts.com/highcharts/yAxis.softMin
* @see https://api.highcharts.com/highstock/yAxis.softMin
* @see https://api.highcharts.com/gantt/yAxis.softMin
*
* @implspec softMin?: number;
*
*/
@JSProperty("softMin")
double getSoftMin();
/**
* (Highcharts, Highstock, Gantt) A soft minimum for the axis. If the series
* data minimum is greater than this, the axis will stay at this minimum,
* but if the series data minimum is lower, the axis will flex to show all
* data.
*
* Note: The series.softThreshold option takes precedence over this
* option.
*
* @see https://api.highcharts.com/highcharts/yAxis.softMin
* @see https://api.highcharts.com/highstock/yAxis.softMin
* @see https://api.highcharts.com/gantt/yAxis.softMin
*
* @implspec softMin?: number;
*
*/
@JSProperty("softMin")
void setSoftMin(double value);
/**
* (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
*
* @implspec stackLabels?: YAxisStackLabelsOptions;
*
*/
@JSProperty("stackLabels")
@Nullable
YAxisStackLabelsOptions getStackLabels();
/**
* (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
*
* @implspec stackLabels?: YAxisStackLabelsOptions;
*
*/
@JSProperty("stackLabels")
void setStackLabels(YAxisStackLabelsOptions value);
/**
* (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
* put the tick between weeks. 0 = Sunday, 1 = Monday.
*
* @see https://api.highcharts.com/highcharts/yAxis.startOfWeek
* @see https://api.highcharts.com/highstock/yAxis.startOfWeek
* @see https://api.highcharts.com/gantt/yAxis.startOfWeek
*
* @implspec startOfWeek?: number;
*
*/
@JSProperty("startOfWeek")
double getStartOfWeek();
/**
* (Highcharts, Highstock, Gantt) For datetime axes, this decides where to
* put the tick between weeks. 0 = Sunday, 1 = Monday.
*
* @see https://api.highcharts.com/highcharts/yAxis.startOfWeek
* @see https://api.highcharts.com/highstock/yAxis.startOfWeek
* @see https://api.highcharts.com/gantt/yAxis.startOfWeek
*
* @implspec startOfWeek?: number;
*
*/
@JSProperty("startOfWeek")
void setStartOfWeek(double value);
/**
* (Highcharts, Highstock, Gantt) Whether to force the axis to start on a
* tick. Use this option with the maxPadding option to control the axis
* start.
*
* @see https://api.highcharts.com/highcharts/yAxis.startOnTick
* @see https://api.highcharts.com/highstock/yAxis.startOnTick
* @see https://api.highcharts.com/gantt/yAxis.startOnTick
*
* @implspec startOnTick?: boolean;
*
*/
@JSProperty("startOnTick")
boolean getStartOnTick();
/**
* (Highcharts, Highstock, Gantt) Whether to force the axis to start on a
* tick. Use this option with the maxPadding option to control the axis
* start.
*
* @see https://api.highcharts.com/highcharts/yAxis.startOnTick
* @see https://api.highcharts.com/highstock/yAxis.startOnTick
* @see https://api.highcharts.com/gantt/yAxis.startOnTick
*
* @implspec startOnTick?: boolean;
*
*/
@JSProperty("startOnTick")
void setStartOnTick(boolean value);
/**
* (Gantt) For vertical axes only. Setting the static scale ensures that
* each tick unit is translated into a fixed pixel height. For example,
* setting the static scale to 24 results in each Y axis category taking up
* 24 pixels, and the height of the chart adjusts. Adding or removing items
* will make the chart resize.
*
* @see https://api.highcharts.com/gantt/yAxis.staticScale
*
* @implspec staticScale?: number;
*
*/
@JSProperty("staticScale")
double getStaticScale();
/**
* (Gantt) For vertical axes only. Setting the static scale ensures that
* each tick unit is translated into a fixed pixel height. For example,
* setting the static scale to 24 results in each Y axis category taking up
* 24 pixels, and the height of the chart adjusts. Adding or removing items
* will make the chart resize.
*
* @see https://api.highcharts.com/gantt/yAxis.staticScale
*
* @implspec staticScale?: number;
*
*/
@JSProperty("staticScale")
void setStaticScale(double value);
/**
* (Highcharts) Solid gauge series only. Color stops for the solid gauge.
* Use this in cases where a linear gradient between a minColor and
* maxColor is not sufficient. The stops is an array of tuples, where the
* first item is a float between 0 and 1 assigning the relative position in
* the gradient, and the second item is the color.
*
* For solid gauges, the Y axis also inherits the concept of data classes
* from the Highmaps color axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.stops
*
* @implspec stops?: Array<[number, ColorString]>;
*
*/
@JSProperty("stops")
@Nullable
Array getStops();
/**
* (Highcharts) Solid gauge series only. Color stops for the solid gauge.
* Use this in cases where a linear gradient between a minColor and
* maxColor is not sufficient. The stops is an array of tuples, where the
* first item is a float between 0 and 1 assigning the relative position in
* the gradient, and the second item is the color.
*
* For solid gauges, the Y axis also inherits the concept of data classes
* from the Highmaps color axis.
*
* @see https://api.highcharts.com/highcharts/yAxis.stops
*
* @implspec stops?: Array<[number, ColorString]>;
*
*/
@JSProperty("stops")
void setStops(Array value);
/**
* (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
* This opens up for aligning the ticks of multiple charts or panes within a
* chart. This option overrides the tickPixelInterval option.
*
* This option only has an effect on linear axes. Datetime, logarithmic or
* category axes are not affected.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickAmount
* @see https://api.highcharts.com/highstock/yAxis.tickAmount
* @see https://api.highcharts.com/gantt/yAxis.tickAmount
*
* @implspec tickAmount?: number;
*
*/
@JSProperty("tickAmount")
double getTickAmount();
/**
* (Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
* This opens up for aligning the ticks of multiple charts or panes within a
* chart. This option overrides the tickPixelInterval option.
*
* This option only has an effect on linear axes. Datetime, logarithmic or
* category axes are not affected.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickAmount
* @see https://api.highcharts.com/highstock/yAxis.tickAmount
* @see https://api.highcharts.com/gantt/yAxis.tickAmount
*
* @implspec tickAmount?: number;
*
*/
@JSProperty("tickAmount")
void setTickAmount(double value);
/**
* (Highcharts, Highstock, Highmaps) Color for the main tick marks.
*
* In styled mode, the stroke is given in the .highcharts-tick class.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickColor
* @see https://api.highcharts.com/highstock/yAxis.tickColor
* @see https://api.highcharts.com/highmaps/yAxis.tickColor
*
* @implspec tickColor?: ColorString;
*
*/
@JSProperty("tickColor")
@Nullable
String getTickColor();
/**
* (Highcharts, Highstock, Highmaps) Color for the main tick marks.
*
* In styled mode, the stroke is given in the .highcharts-tick class.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickColor
* @see https://api.highcharts.com/highstock/yAxis.tickColor
* @see https://api.highcharts.com/highmaps/yAxis.tickColor
*
* @implspec tickColor?: ColorString;
*
*/
@JSProperty("tickColor")
void setTickColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The interval of the tick marks in axis
* units. When undefined, the tick interval is computed to approximately
* follow the tickPixelInterval on linear and datetime axes. On categorized
* axes, a undefined tickInterval will default to 1, one category. Note
* that datetime axes are based on milliseconds, so for example an interval
* of one day is expressed as 24 * 3600 * 1000.
*
* On logarithmic axes, the tickInterval is based on powers, so a
* tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
* tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
* 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
* etc.
*
* If the tickInterval is too dense for labels to be drawn, Highcharts may
* remove ticks.
*
* If the chart has multiple axes, the alignTicks option may interfere with
* the tickInterval setting.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickInterval
* @see https://api.highcharts.com/highstock/yAxis.tickInterval
* @see https://api.highcharts.com/highmaps/yAxis.tickInterval
*
* @implspec tickInterval?: number;
*
*/
@JSProperty("tickInterval")
double getTickInterval();
/**
* (Highcharts, Highstock, Highmaps) The interval of the tick marks in axis
* units. When undefined, the tick interval is computed to approximately
* follow the tickPixelInterval on linear and datetime axes. On categorized
* axes, a undefined tickInterval will default to 1, one category. Note
* that datetime axes are based on milliseconds, so for example an interval
* of one day is expressed as 24 * 3600 * 1000.
*
* On logarithmic axes, the tickInterval is based on powers, so a
* tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A
* tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of
* 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40
* etc.
*
* If the tickInterval is too dense for labels to be drawn, Highcharts may
* remove ticks.
*
* If the chart has multiple axes, the alignTicks option may interfere with
* the tickInterval setting.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickInterval
* @see https://api.highcharts.com/highstock/yAxis.tickInterval
* @see https://api.highcharts.com/highmaps/yAxis.tickInterval
*
* @implspec tickInterval?: number;
*
*/
@JSProperty("tickInterval")
void setTickInterval(double value);
/**
* (Highcharts, Highstock, Highmaps) The pixel length of the main tick
* marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickLength
* @see https://api.highcharts.com/highstock/yAxis.tickLength
* @see https://api.highcharts.com/highmaps/yAxis.tickLength
*
* @implspec tickLength?: number;
*
*/
@JSProperty("tickLength")
double getTickLength();
/**
* (Highcharts, Highstock, Highmaps) The pixel length of the main tick
* marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickLength
* @see https://api.highcharts.com/highstock/yAxis.tickLength
* @see https://api.highcharts.com/highmaps/yAxis.tickLength
*
* @implspec tickLength?: number;
*
*/
@JSProperty("tickLength")
void setTickLength(double value);
/**
* (Highcharts, Gantt) For categorized axes only. If on the tick mark is
* placed in the center of the category, if between the tick mark is
* placed between categories. The default is between if the tickInterval
* is 1, else on.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickmarkPlacement
* @see https://api.highcharts.com/gantt/yAxis.tickmarkPlacement
*
* @implspec tickmarkPlacement?: ("between"|"on"|undefined);
*
*/
@JSProperty("tickmarkPlacement")
@Nullable
TickmarkPlacement getTickmarkPlacement();
/**
* (Highcharts, Gantt) For categorized axes only. If on the tick mark is
* placed in the center of the category, if between the tick mark is
* placed between categories. The default is between if the tickInterval
* is 1, else on.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickmarkPlacement
* @see https://api.highcharts.com/gantt/yAxis.tickmarkPlacement
*
* @implspec tickmarkPlacement?: ("between"|"on"|undefined);
*
*/
@JSProperty("tickmarkPlacement")
void setTickmarkPlacement(TickmarkPlacement value);
/**
* (Highcharts, Highstock, Highmaps) If tickInterval is null this option
* sets the approximate pixel interval of the tick marks. Not applicable to
* categorized axis.
*
* The tick interval is also influenced by the minTickInterval option, that,
* by default prevents ticks from being denser than the data points.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPixelInterval
* @see https://api.highcharts.com/highstock/yAxis.tickPixelInterval
* @see https://api.highcharts.com/highmaps/yAxis.tickPixelInterval
*
* @implspec tickPixelInterval?: number;
*
*/
@JSProperty("tickPixelInterval")
double getTickPixelInterval();
/**
* (Highcharts, Highstock, Highmaps) If tickInterval is null this option
* sets the approximate pixel interval of the tick marks. Not applicable to
* categorized axis.
*
* The tick interval is also influenced by the minTickInterval option, that,
* by default prevents ticks from being denser than the data points.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPixelInterval
* @see https://api.highcharts.com/highstock/yAxis.tickPixelInterval
* @see https://api.highcharts.com/highmaps/yAxis.tickPixelInterval
*
* @implspec tickPixelInterval?: number;
*
*/
@JSProperty("tickPixelInterval")
void setTickPixelInterval(double value);
/**
* (Highcharts, Highstock, Highmaps) The position of the major tick marks
* relative to the axis line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPosition
* @see https://api.highcharts.com/highstock/yAxis.tickPosition
* @see https://api.highcharts.com/highmaps/yAxis.tickPosition
*
* @implspec tickPosition?: ("inside"|"outside");
*
*/
@JSProperty("tickPosition")
@Nullable
TickPosition getTickPosition();
/**
* (Highcharts, Highstock, Highmaps) The position of the major tick marks
* relative to the axis line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPosition
* @see https://api.highcharts.com/highstock/yAxis.tickPosition
* @see https://api.highcharts.com/highmaps/yAxis.tickPosition
*
* @implspec tickPosition?: ("inside"|"outside");
*
*/
@JSProperty("tickPosition")
void setTickPosition(TickPosition value);
/**
* (Highcharts, Highstock, Highmaps) A callback function returning array
* defining where the ticks are laid out on the axis. This overrides the
* default behaviour of tickPixelInterval and tickInterval. The automatic
* tick positions are accessible through this.tickPositions and can be
* modified by the callback.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPositioner
* @see https://api.highcharts.com/highstock/yAxis.tickPositioner
* @see https://api.highcharts.com/highmaps/yAxis.tickPositioner
*
* @implspec tickPositioner?: () => void;
*
*/
@JSProperty("tickPositioner")
@Nullable
TickPositioner getTickPositioner();
/**
* (Highcharts, Highstock, Highmaps) A callback function returning array
* defining where the ticks are laid out on the axis. This overrides the
* default behaviour of tickPixelInterval and tickInterval. The automatic
* tick positions are accessible through this.tickPositions and can be
* modified by the callback.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPositioner
* @see https://api.highcharts.com/highstock/yAxis.tickPositioner
* @see https://api.highcharts.com/highmaps/yAxis.tickPositioner
*
* @implspec tickPositioner?: () => void;
*
*/
@JSProperty("tickPositioner")
void setTickPositioner(TickPositioner value);
/**
* (Highcharts, Highstock, Highmaps) An array defining where the ticks are
* laid out on the axis. This overrides the default behaviour of
* tickPixelInterval and tickInterval.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPositions
* @see https://api.highcharts.com/highstock/yAxis.tickPositions
* @see https://api.highcharts.com/highmaps/yAxis.tickPositions
*
* @implspec tickPositions?: Array;
*
*/
@JSProperty("tickPositions")
@Nullable
double[] getTickPositions();
/**
* (Highcharts, Highstock, Highmaps) An array defining where the ticks are
* laid out on the axis. This overrides the default behaviour of
* tickPixelInterval and tickInterval.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickPositions
* @see https://api.highcharts.com/highstock/yAxis.tickPositions
* @see https://api.highcharts.com/highmaps/yAxis.tickPositions
*
* @implspec tickPositions?: Array;
*
*/
@JSProperty("tickPositions")
void setTickPositions(double[] value);
/**
* (Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickWidth
* @see https://api.highcharts.com/highstock/yAxis.tickWidth
* @see https://api.highcharts.com/gantt/yAxis.tickWidth
*
* @implspec tickWidth?: number;
*
*/
@JSProperty("tickWidth")
double getTickWidth();
/**
* (Highcharts, Highstock, Gantt) The pixel width of the major tick marks.
*
* @see https://api.highcharts.com/highcharts/yAxis.tickWidth
* @see https://api.highcharts.com/highstock/yAxis.tickWidth
* @see https://api.highcharts.com/gantt/yAxis.tickWidth
*
* @implspec tickWidth?: number;
*
*/
@JSProperty("tickWidth")
void setTickWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) The axis title, showing next to the
* axis line.
*
* @see https://api.highcharts.com/highcharts/yAxis.title
* @see https://api.highcharts.com/highstock/yAxis.title
* @see https://api.highcharts.com/highmaps/yAxis.title
*
* @implspec title?: YAxisTitleOptions;
*
*/
@JSProperty("title")
@Nullable
YAxisTitleOptions getTitle();
/**
* (Highcharts, Highstock, Highmaps) The axis title, showing next to the
* axis line.
*
* @see https://api.highcharts.com/highcharts/yAxis.title
* @see https://api.highcharts.com/highstock/yAxis.title
* @see https://api.highcharts.com/highmaps/yAxis.title
*
* @implspec title?: YAxisTitleOptions;
*
*/
@JSProperty("title")
void setTitle(YAxisTitleOptions value);
/**
* (Highcharts) Parallel coordinates only. Format that will be used for
* point.y and available in tooltip.pointFormat as {point.formattedValue}.
* If not set, {point.formattedValue} will use other options, in this
* order:
*
*
* -
* yAxis.labels.format will be used if set
*
*
* -
* If yAxis is a category, then category name will be displayed
*
*
* -
* If yAxis is a datetime, then value will use the same format as yAxis
* labels
*
*
* -
* If yAxis is linear/logarithmic type, then simple value will be used
*
*
*
* @see https://api.highcharts.com/highcharts/yAxis.tooltipValueFormat
*
* @implspec tooltipValueFormat?: string;
*
*/
@JSProperty("tooltipValueFormat")
@Nullable
String getTooltipValueFormat();
/**
* (Highcharts) Parallel coordinates only. Format that will be used for
* point.y and available in tooltip.pointFormat as {point.formattedValue}.
* If not set, {point.formattedValue} will use other options, in this
* order:
*
*
* -
* yAxis.labels.format will be used if set
*
*
* -
* If yAxis is a category, then category name will be displayed
*
*
* -
* If yAxis is a datetime, then value will use the same format as yAxis
* labels
*
*
* -
* If yAxis is linear/logarithmic type, then simple value will be used
*
*
*
* @see https://api.highcharts.com/highcharts/yAxis.tooltipValueFormat
*
* @implspec tooltipValueFormat?: string;
*
*/
@JSProperty("tooltipValueFormat")
void setTooltipValueFormat(String value);
/**
* (Highstock) The top position of the Y axis. If it's a number, it is
* interpreted as pixel position relative to the chart.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the plot height, offset from plot area top.
*
* @see https://api.highcharts.com/highstock/yAxis.top
*
* @implspec top?: (number|string);
*
*/
@JSProperty("top")
@Nullable
Unknown getTop();
/**
* (Highstock) The top position of the Y axis. If it's a number, it is
* interpreted as pixel position relative to the chart.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the plot height, offset from plot area top.
*
* @see https://api.highcharts.com/highstock/yAxis.top
*
* @implspec top?: (number|string);
*
*/
@JSProperty("top")
void setTop(double value);
/**
* (Highstock) The top position of the Y axis. If it's a number, it is
* interpreted as pixel position relative to the chart.
*
* Since Highstock 2: If it's a percentage string, it is interpreted as
* percentages of the plot height, offset from plot area top.
*
* @see https://api.highcharts.com/highstock/yAxis.top
*
* @implspec top?: (number|string);
*
*/
@JSProperty("top")
void setTop(String value);
/**
* (Highcharts, Gantt) The type of axis. Can be one of linear,
* logarithmic, datetime, category or treegrid. Defaults to
* treegrid for Gantt charts, linear for other chart types.
*
* In a datetime axis, the numbers are given in milliseconds, and tick marks
* are placed on appropriate values, like full hours or days. In a category
* or treegrid axis, the point names of the chart's series are used for
* categories, if a categories array is not defined.
*
* @see https://api.highcharts.com/highcharts/yAxis.type
* @see https://api.highcharts.com/gantt/yAxis.type
*
* @implspec type?: ("category"|"datetime"|"linear"|"logarithmic"|"treegrid");
*
*/
@JSProperty("type")
@Nullable
Type getType();
/**
* (Highcharts, Gantt) The type of axis. Can be one of linear,
* logarithmic, datetime, category or treegrid. Defaults to
* treegrid for Gantt charts, linear for other chart types.
*
* In a datetime axis, the numbers are given in milliseconds, and tick marks
* are placed on appropriate values, like full hours or days. In a category
* or treegrid axis, the point names of the chart's series are used for
* categories, if a categories array is not defined.
*
* @see https://api.highcharts.com/highcharts/yAxis.type
* @see https://api.highcharts.com/gantt/yAxis.type
*
* @implspec type?: ("category"|"datetime"|"linear"|"logarithmic"|"treegrid");
*
*/
@JSProperty("type")
void setType(Type value);
/**
* (Highcharts, Gantt) Applies only when the axis type is category. When
* uniqueNames is true, points are placed on the X axis according to their
* names. If the same point name is repeated in the same or another series,
* the point is placed on the same X position as other points of the same
* name. When uniqueNames is false, the points are laid out in increasing
* X positions regardless of their names, and the X axis category will take
* the name of the last point in each position.
*
* @see https://api.highcharts.com/highcharts/yAxis.uniqueNames
* @see https://api.highcharts.com/gantt/yAxis.uniqueNames
*
* @implspec uniqueNames?: boolean;
*
*/
@JSProperty("uniqueNames")
boolean getUniqueNames();
/**
* (Highcharts, Gantt) Applies only when the axis type is category. When
* uniqueNames is true, points are placed on the X axis according to their
* names. If the same point name is repeated in the same or another series,
* the point is placed on the same X position as other points of the same
* name. When uniqueNames is false, the points are laid out in increasing
* X positions regardless of their names, and the X axis category will take
* the name of the last point in each position.
*
* @see https://api.highcharts.com/highcharts/yAxis.uniqueNames
* @see https://api.highcharts.com/gantt/yAxis.uniqueNames
*
* @implspec uniqueNames?: boolean;
*
*/
@JSProperty("uniqueNames")
void setUniqueNames(boolean value);
/**
* (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
* what time intervals the ticks are allowed to fall on. Each array item is
* an array where the first value is the time unit and the second value
* another array of allowed multiples. Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.units
* @see https://api.highcharts.com/highstock/yAxis.units
* @see https://api.highcharts.com/gantt/yAxis.units
*
* @implspec units?: Array<Array<(string|Array)>>;
*
*/
@JSProperty("units")
@Nullable
Array> getUnits();
/**
* (Highcharts, Highstock, Gantt) Datetime axis only. An array determining
* what time intervals the ticks are allowed to fall on. Each array item is
* an array where the first value is the time unit and the second value
* another array of allowed multiples. Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/yAxis.units
* @see https://api.highcharts.com/highstock/yAxis.units
* @see https://api.highcharts.com/gantt/yAxis.units
*
* @implspec units?: Array<Array<(string|Array)>>;
*
*/
@JSProperty("units")
void setUnits(Array> value);
/**
* (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
* ticks and labels, should be visible.
*
* @see https://api.highcharts.com/highcharts/yAxis.visible
* @see https://api.highcharts.com/highstock/yAxis.visible
* @see https://api.highcharts.com/gantt/yAxis.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
boolean getVisible();
/**
* (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
* ticks and labels, should be visible.
*
* @see https://api.highcharts.com/highcharts/yAxis.visible
* @see https://api.highcharts.com/highstock/yAxis.visible
* @see https://api.highcharts.com/gantt/yAxis.visible
*
* @implspec visible?: boolean;
*
*/
@JSProperty("visible")
void setVisible(boolean value);
/**
*/
abstract class GridLineDashStyle extends JsEnum {
public static final GridLineDashStyle DASH = JsEnum.of("Dash");
public static final GridLineDashStyle DASHDOT = JsEnum.of("DashDot");
public static final GridLineDashStyle DOT = JsEnum.of("Dot");
public static final GridLineDashStyle LONGDASH = JsEnum.of("LongDash");
public static final GridLineDashStyle LONGDASHDOT = JsEnum.of("LongDashDot");
public static final GridLineDashStyle LONGDASHDOTDOT = JsEnum.of("LongDashDotDot");
public static final GridLineDashStyle SHORTDASH = JsEnum.of("ShortDash");
public static final GridLineDashStyle SHORTDASHDOT = JsEnum.of("ShortDashDot");
public static final GridLineDashStyle SHORTDASHDOTDOT = JsEnum.of("ShortDashDotDot");
public static final GridLineDashStyle SHORTDOT = JsEnum.of("ShortDot");
public static final GridLineDashStyle SOLID = JsEnum.of("Solid");
}
/**
*/
abstract class GridLineInterpolation extends JsEnum {
public static final GridLineInterpolation CIRCLE = JsEnum.of("circle");
public static final GridLineInterpolation POLYGON = JsEnum.of("polygon");
}
/**
*/
abstract class MinorGridLineDashStyle extends JsEnum {
public static final MinorGridLineDashStyle DASH = JsEnum.of("Dash");
public static final MinorGridLineDashStyle DASHDOT = JsEnum.of("DashDot");
public static final MinorGridLineDashStyle DOT = JsEnum.of("Dot");
public static final MinorGridLineDashStyle LONGDASH = JsEnum.of("LongDash");
public static final MinorGridLineDashStyle LONGDASHDOT = JsEnum.of("LongDashDot");
public static final MinorGridLineDashStyle LONGDASHDOTDOT = JsEnum.of("LongDashDotDot");
public static final MinorGridLineDashStyle SHORTDASH = JsEnum.of("ShortDash");
public static final MinorGridLineDashStyle SHORTDASHDOT = JsEnum.of("ShortDashDot");
public static final MinorGridLineDashStyle SHORTDASHDOTDOT = JsEnum.of("ShortDashDotDot");
public static final MinorGridLineDashStyle SHORTDOT = JsEnum.of("ShortDot");
public static final MinorGridLineDashStyle SOLID = JsEnum.of("Solid");
}
/**
*/
abstract class MinorTickPosition extends JsEnum {
public static final MinorTickPosition INSIDE = JsEnum.of("inside");
public static final MinorTickPosition OUTSIDE = JsEnum.of("outside");
}
/**
*/
abstract class TickmarkPlacement extends JsEnum {
public static final TickmarkPlacement BETWEEN = JsEnum.of("between");
public static final TickmarkPlacement ON = JsEnum.of("on");
}
/**
*/
abstract class TickPosition extends JsEnum {
public static final TickPosition INSIDE = JsEnum.of("inside");
public static final TickPosition OUTSIDE = JsEnum.of("outside");
}
/**
*/
@JSFunctor
@FunctionalInterface
interface TickPositioner extends Any {
void apply();
}
/**
*/
abstract class Type extends JsEnum {
public static final Type CATEGORY = JsEnum.of("category");
public static final Type DATETIME = JsEnum.of("datetime");
public static final Type LINEAR = JsEnum.of("linear");
public static final Type LOGARITHMIC = JsEnum.of("logarithmic");
public static final Type TREEGRID = JsEnum.of("treegrid");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy