com.github.fluorumlabs.disconnect.highcharts.NavigatorYAxisOptions 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;
/**
* (Highstock) Options for the navigator Y axis. Default series options for the
* navigator yAxis are:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highstock/navigator.yAxis
*
*/
public interface NavigatorYAxisOptions 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/navigator.yAxis.alignTicks
* @see https://api.highcharts.com/highstock/navigator.yAxis.alignTicks
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.alignTicks
* @see https://api.highcharts.com/highstock/navigator.yAxis.alignTicks
* @see https://api.highcharts.com/gantt/navigator.yAxis.alignTicks
*
* @implspec alignTicks?: boolean;
*
*/
@JSProperty("alignTicks")
void setAlignTicks(boolean value);
/**
* (Highstock) 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/highstock/navigator.yAxis.allowDecimals
*
* @implspec allowDecimals?: boolean;
*
*/
@JSProperty("allowDecimals")
boolean getAllowDecimals();
/**
* (Highstock) 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/highstock/navigator.yAxis.allowDecimals
*
* @implspec allowDecimals?: boolean;
*
*/
@JSProperty("allowDecimals")
void setAllowDecimals(boolean value);
/**
* (Highstock) When using an alternate grid color, a band is painted across
* the plot area between every other grid line.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.alternateGridColor
*
* @implspec alternateGridColor?: ColorString;
*
*/
@JSProperty("alternateGridColor")
@Nullable
String getAlternateGridColor();
/**
* (Highstock) When using an alternate grid color, a band is painted across
* the plot area between every other grid line.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.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/navigator.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/navigator.yAxis.breaks
* @see https://api.highcharts.com/highstock/navigator.yAxis.breaks
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.breaks
* @see https://api.highcharts.com/highstock/navigator.yAxis.breaks
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.categories
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.categories
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.ceiling
* @see https://api.highcharts.com/highstock/navigator.yAxis.ceiling
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.ceiling
* @see https://api.highcharts.com/highstock/navigator.yAxis.ceiling
* @see https://api.highcharts.com/gantt/navigator.yAxis.ceiling
*
* @implspec ceiling?: number;
*
*/
@JSProperty("ceiling")
void setCeiling(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highstock) 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/highstock/navigator.yAxis.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.crosshair
*
* @implspec crosshair?: (boolean|NavigatorYAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
@Nullable
Unknown getCrosshair();
/**
* (Highstock) 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/highstock/navigator.yAxis.crosshair
*
* @implspec crosshair?: (boolean|NavigatorYAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
void setCrosshair(boolean value);
/**
* (Highstock) 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/highstock/navigator.yAxis.crosshair
*
* @implspec crosshair?: (boolean|NavigatorYAxisCrosshairOptions);
*
*/
@JSProperty("crosshair")
void setCrosshair(NavigatorYAxisCrosshairOptions 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/navigator.yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/highstock/navigator.yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/gantt/navigator.yAxis.dateTimeLabelFormats
*
* @implspec dateTimeLabelFormats?: NavigatorYAxisDateTimeLabelFormatsOptions;
*
*/
@JSProperty("dateTimeLabelFormats")
@Nullable
NavigatorYAxisDateTimeLabelFormatsOptions 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/navigator.yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/highstock/navigator.yAxis.dateTimeLabelFormats
* @see https://api.highcharts.com/gantt/navigator.yAxis.dateTimeLabelFormats
*
* @implspec dateTimeLabelFormats?: NavigatorYAxisDateTimeLabelFormatsOptions;
*
*/
@JSProperty("dateTimeLabelFormats")
void setDateTimeLabelFormats(NavigatorYAxisDateTimeLabelFormatsOptions value);
/**
* (Highstock) Requires Accessibility module
*
* Description of the axis to screen reader users.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highstock) Requires Accessibility module
*
* Description of the axis to screen reader users.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
void setDescription(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.endOnTick
*
* @implspec endOnTick?: boolean;
*
*/
@JSProperty("endOnTick")
boolean getEndOnTick();
/**
* (Highstock) 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/highstock/navigator.yAxis.endOnTick
*
* @implspec endOnTick?: boolean;
*
*/
@JSProperty("endOnTick")
void setEndOnTick(boolean value);
/**
* (Highstock) Event handlers for the axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.events
*
* @implspec events?: NavigatorYAxisEventsOptions;
*
*/
@JSProperty("events")
@Nullable
NavigatorYAxisEventsOptions getEvents();
/**
* (Highstock) Event handlers for the axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.events
*
* @implspec events?: NavigatorYAxisEventsOptions;
*
*/
@JSProperty("events")
void setEvents(NavigatorYAxisEventsOptions value);
/**
* (Highcharts, Highstock, Gantt) The lowest allowed value for automatically
* computed axis extremes.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.floor
* @see https://api.highcharts.com/highstock/navigator.yAxis.floor
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.floor
* @see https://api.highcharts.com/highstock/navigator.yAxis.floor
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.grid
*
* @implspec grid?: NavigatorYAxisGridOptions;
*
*/
@JSProperty("grid")
@Nullable
NavigatorYAxisGridOptions getGrid();
/**
* (Gantt) Set grid options for the axis labels. Requires Highcharts Gantt.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.grid
*
* @implspec grid?: NavigatorYAxisGridOptions;
*
*/
@JSProperty("grid")
void setGrid(NavigatorYAxisGridOptions value);
/**
* (Highstock) 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/highstock/navigator.yAxis.gridLineColor
*
* @implspec gridLineColor?: ColorString;
*
*/
@JSProperty("gridLineColor")
@Nullable
String getGridLineColor();
/**
* (Highstock) 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/highstock/navigator.yAxis.gridLineColor
*
* @implspec gridLineColor?: ColorString;
*
*/
@JSProperty("gridLineColor")
void setGridLineColor(String value);
/**
* (Highstock) The dash or dot style of the grid lines. For possible values,
* see this demonstration.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.gridLineDashStyle
*
* @implspec gridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("gridLineDashStyle")
@Nullable
GridLineDashStyle getGridLineDashStyle();
/**
* (Highstock) The dash or dot style of the grid lines. For possible values,
* see this demonstration.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.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/navigator.yAxis.gridLineInterpolation
*
* @implspec gridLineInterpolation?: ("circle"|"polygon");
*
*/
@JSProperty("gridLineInterpolation")
void setGridLineInterpolation(GridLineInterpolation value);
/**
* (Highstock) 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/highstock/navigator.yAxis.gridLineWidth
*
* @implspec gridLineWidth?: number;
*
*/
@JSProperty("gridLineWidth")
double getGridLineWidth();
/**
* (Highstock) 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/highstock/navigator.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/navigator.yAxis.gridZIndex
* @see https://api.highcharts.com/highstock/navigator.yAxis.gridZIndex
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.gridZIndex
* @see https://api.highcharts.com/highstock/navigator.yAxis.gridZIndex
* @see https://api.highcharts.com/gantt/navigator.yAxis.gridZIndex
*
* @implspec gridZIndex?: number;
*
*/
@JSProperty("gridZIndex")
void setGridZIndex(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
@Nullable
String getId();
/**
* (Highstock) 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/highstock/navigator.yAxis.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
void setId(String value);
/**
* (Highstock) The axis labels show the number or category for each tick.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels
*
* @implspec labels?: NavigatorYAxisLabelsOptions;
*
*/
@JSProperty("labels")
@Nullable
NavigatorYAxisLabelsOptions getLabels();
/**
* (Highstock) The axis labels show the number or category for each tick.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels
*
* @implspec labels?: NavigatorYAxisLabelsOptions;
*
*/
@JSProperty("labels")
void setLabels(NavigatorYAxisLabelsOptions value);
/**
* (Highstock) 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/highstock/navigator.yAxis.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
@Nullable
String getLineColor();
/**
* (Highstock) 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/highstock/navigator.yAxis.lineColor
*
* @implspec lineColor?: ColorString;
*
*/
@JSProperty("lineColor")
void setLineColor(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
double getLineWidth();
/**
* (Highstock) 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/highstock/navigator.yAxis.lineWidth
*
* @implspec lineWidth?: number;
*
*/
@JSProperty("lineWidth")
void setLineWidth(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.max
*
* @implspec max?: number;
*
*/
@JSProperty("max")
double getMax();
/**
* (Highstock) 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/highstock/navigator.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/navigator.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/navigator.yAxis.maxColor
*
* @implspec maxColor?: ColorString;
*
*/
@JSProperty("maxColor")
void setMaxColor(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/navigator.yAxis.maxPadding
* @see https://api.highcharts.com/highstock/navigator.yAxis.maxPadding
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.maxPadding
* @see https://api.highcharts.com/highstock/navigator.yAxis.maxPadding
* @see https://api.highcharts.com/gantt/navigator.yAxis.maxPadding
*
* @implspec maxPadding?: number;
*
*/
@JSProperty("maxPadding")
void setMaxPadding(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.min
*
* @implspec min?: number;
*
*/
@JSProperty("min")
double getMin();
/**
* (Highstock) 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/highstock/navigator.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/navigator.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/navigator.yAxis.minColor
*
* @implspec minColor?: ColorString;
*
*/
@JSProperty("minColor")
void setMinColor(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minorGridLineColor
*
* @implspec minorGridLineColor?: ColorString;
*
*/
@JSProperty("minorGridLineColor")
@Nullable
String getMinorGridLineColor();
/**
* (Highstock) 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/highstock/navigator.yAxis.minorGridLineColor
*
* @implspec minorGridLineColor?: ColorString;
*
*/
@JSProperty("minorGridLineColor")
void setMinorGridLineColor(String value);
/**
* (Highstock) The dash or dot style of the minor grid lines. For possible
* values, see this demonstration.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorGridLineDashStyle
*
* @implspec minorGridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("minorGridLineDashStyle")
@Nullable
MinorGridLineDashStyle getMinorGridLineDashStyle();
/**
* (Highstock) The dash or dot style of the minor grid lines. For possible
* values, see this demonstration.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorGridLineDashStyle
*
* @implspec minorGridLineDashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
*
*/
@JSProperty("minorGridLineDashStyle")
void setMinorGridLineDashStyle(MinorGridLineDashStyle value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minorGridLineWidth
*
* @implspec minorGridLineWidth?: number;
*
*/
@JSProperty("minorGridLineWidth")
double getMinorGridLineWidth();
/**
* (Highstock) 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/highstock/navigator.yAxis.minorGridLineWidth
*
* @implspec minorGridLineWidth?: number;
*
*/
@JSProperty("minorGridLineWidth")
void setMinorGridLineWidth(double value);
/**
* (Highstock) Color for the minor tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickColor
*
* @implspec minorTickColor?: ColorString;
*
*/
@JSProperty("minorTickColor")
@Nullable
String getMinorTickColor();
/**
* (Highstock) Color for the minor tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickColor
*
* @implspec minorTickColor?: ColorString;
*
*/
@JSProperty("minorTickColor")
void setMinorTickColor(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
@Nullable
Unknown getMinorTickInterval();
/**
* (Highstock) 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/highstock/navigator.yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
void setMinorTickInterval(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minorTickInterval
*
* @implspec minorTickInterval?: (number|string|null);
*
*/
@JSProperty("minorTickInterval")
void setMinorTickInterval(String value);
/**
* (Highstock) The pixel length of the minor tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickLength
*
* @implspec minorTickLength?: number;
*
*/
@JSProperty("minorTickLength")
double getMinorTickLength();
/**
* (Highstock) The pixel length of the minor tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickLength
*
* @implspec minorTickLength?: number;
*
*/
@JSProperty("minorTickLength")
void setMinorTickLength(double value);
/**
* (Highstock) The position of the minor tick marks relative to the axis
* line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickPosition
*
* @implspec minorTickPosition?: ("inside"|"outside");
*
*/
@JSProperty("minorTickPosition")
@Nullable
MinorTickPosition getMinorTickPosition();
/**
* (Highstock) The position of the minor tick marks relative to the axis
* line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickPosition
*
* @implspec minorTickPosition?: ("inside"|"outside");
*
*/
@JSProperty("minorTickPosition")
void setMinorTickPosition(MinorTickPosition value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minorTicks
*
* @implspec minorTicks?: boolean;
*
*/
@JSProperty("minorTicks")
boolean getMinorTicks();
/**
* (Highstock) 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/highstock/navigator.yAxis.minorTicks
*
* @implspec minorTicks?: boolean;
*
*/
@JSProperty("minorTicks")
void setMinorTicks(boolean value);
/**
* (Highstock) The pixel width of the minor tick mark.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.minorTickWidth
*
* @implspec minorTickWidth?: number;
*
*/
@JSProperty("minorTickWidth")
double getMinorTickWidth();
/**
* (Highstock) The pixel width of the minor tick mark.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.yAxis.minPadding
* @see https://api.highcharts.com/highstock/navigator.yAxis.minPadding
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.minPadding
* @see https://api.highcharts.com/highstock/navigator.yAxis.minPadding
* @see https://api.highcharts.com/gantt/navigator.yAxis.minPadding
*
* @implspec minPadding?: number;
*
*/
@JSProperty("minPadding")
void setMinPadding(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.minTickInterval
*
* @implspec minTickInterval?: number;
*
*/
@JSProperty("minTickInterval")
double getMinTickInterval();
/**
* (Highstock) 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/highstock/navigator.yAxis.minTickInterval
*
* @implspec minTickInterval?: number;
*
*/
@JSProperty("minTickInterval")
void setMinTickInterval(double value);
/**
* (Highstock) 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/highstock/navigator.yAxis.offset
*
* @implspec offset?: number;
*
*/
@JSProperty("offset")
double getOffset();
/**
* (Highstock) 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/highstock/navigator.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/navigator.yAxis.opposite
* @see https://api.highcharts.com/highcharts/navigator.yAxis.opposite
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.opposite
* @see https://api.highcharts.com/highcharts/navigator.yAxis.opposite
* @see https://api.highcharts.com/gantt/navigator.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/navigator.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/navigator.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/navigator.yAxis.plotBands
* @see https://api.highcharts.com/highstock/navigator.yAxis.plotBands
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.plotBands
* @see https://api.highcharts.com/highstock/navigator.yAxis.plotBands
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.plotLines
* @see https://api.highcharts.com/highstock/navigator.yAxis.plotLines
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.plotLines
* @see https://api.highcharts.com/highstock/navigator.yAxis.plotLines
* @see https://api.highcharts.com/gantt/navigator.yAxis.plotLines
*
* @implspec plotLines?: Array;
*
*/
@JSProperty("plotLines")
void setPlotLines(Array value);
/**
* (Highstock) Whether to reverse the axis so that the highest number is
* closest to the origin.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.reversed
*
* @implspec reversed?: boolean;
*
*/
@JSProperty("reversed")
boolean getReversed();
/**
* (Highstock) Whether to reverse the axis so that the highest number is
* closest to the origin.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.yAxis.reversedStacks
* @see https://api.highcharts.com/highstock/navigator.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/navigator.yAxis.reversedStacks
* @see https://api.highcharts.com/highstock/navigator.yAxis.reversedStacks
*
* @implspec reversedStacks?: boolean;
*
*/
@JSProperty("reversedStacks")
void setReversedStacks(boolean value);
/**
* (Highstock) Whether to show the first tick label.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.showFirstLabel
*
* @implspec showFirstLabel?: boolean;
*
*/
@JSProperty("showFirstLabel")
boolean getShowFirstLabel();
/**
* (Highstock) Whether to show the first tick label.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.yAxis.showLastLabel
* @see https://api.highcharts.com/highstock/navigator.yAxis.showLastLabel
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.showLastLabel
* @see https://api.highcharts.com/highstock/navigator.yAxis.showLastLabel
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.softMax
* @see https://api.highcharts.com/highstock/navigator.yAxis.softMax
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.softMax
* @see https://api.highcharts.com/highstock/navigator.yAxis.softMax
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.softMin
* @see https://api.highcharts.com/highstock/navigator.yAxis.softMin
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.softMin
* @see https://api.highcharts.com/highstock/navigator.yAxis.softMin
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.stackLabels
*
* @implspec stackLabels?: NavigatorYAxisStackLabelsOptions;
*
*/
@JSProperty("stackLabels")
@Nullable
NavigatorYAxisStackLabelsOptions 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/navigator.yAxis.stackLabels
*
* @implspec stackLabels?: NavigatorYAxisStackLabelsOptions;
*
*/
@JSProperty("stackLabels")
void setStackLabels(NavigatorYAxisStackLabelsOptions 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/navigator.yAxis.startOfWeek
* @see https://api.highcharts.com/highstock/navigator.yAxis.startOfWeek
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.startOfWeek
* @see https://api.highcharts.com/highstock/navigator.yAxis.startOfWeek
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.startOnTick
* @see https://api.highcharts.com/highstock/navigator.yAxis.startOnTick
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.startOnTick
* @see https://api.highcharts.com/highstock/navigator.yAxis.startOnTick
* @see https://api.highcharts.com/gantt/navigator.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/navigator.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/navigator.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/navigator.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/navigator.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/navigator.yAxis.tickAmount
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickAmount
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.tickAmount
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickAmount
* @see https://api.highcharts.com/gantt/navigator.yAxis.tickAmount
*
* @implspec tickAmount?: number;
*
*/
@JSProperty("tickAmount")
void setTickAmount(double value);
/**
* (Highstock) Color for the main tick marks.
*
* In styled mode, the stroke is given in the .highcharts-tick class.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickColor
*
* @implspec tickColor?: ColorString;
*
*/
@JSProperty("tickColor")
@Nullable
String getTickColor();
/**
* (Highstock) Color for the main tick marks.
*
* In styled mode, the stroke is given in the .highcharts-tick class.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickColor
*
* @implspec tickColor?: ColorString;
*
*/
@JSProperty("tickColor")
void setTickColor(String value);
/**
* (Highstock) 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/highstock/navigator.yAxis.tickInterval
*
* @implspec tickInterval?: number;
*
*/
@JSProperty("tickInterval")
double getTickInterval();
/**
* (Highstock) 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/highstock/navigator.yAxis.tickInterval
*
* @implspec tickInterval?: number;
*
*/
@JSProperty("tickInterval")
void setTickInterval(double value);
/**
* (Highstock) The pixel length of the main tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickLength
*
* @implspec tickLength?: number;
*
*/
@JSProperty("tickLength")
double getTickLength();
/**
* (Highstock) The pixel length of the main tick marks.
*
* @see https://api.highcharts.com/highstock/navigator.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/navigator.yAxis.tickmarkPlacement
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.tickmarkPlacement
* @see https://api.highcharts.com/gantt/navigator.yAxis.tickmarkPlacement
*
* @implspec tickmarkPlacement?: ("between"|"on"|undefined);
*
*/
@JSProperty("tickmarkPlacement")
void setTickmarkPlacement(TickmarkPlacement value);
/**
* (Highstock) 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/highstock/navigator.yAxis.tickPixelInterval
*
* @implspec tickPixelInterval?: number;
*
*/
@JSProperty("tickPixelInterval")
double getTickPixelInterval();
/**
* (Highstock) 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/highstock/navigator.yAxis.tickPixelInterval
*
* @implspec tickPixelInterval?: number;
*
*/
@JSProperty("tickPixelInterval")
void setTickPixelInterval(double value);
/**
* (Highstock) The position of the major tick marks relative to the axis
* line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickPosition
*
* @implspec tickPosition?: ("inside"|"outside");
*
*/
@JSProperty("tickPosition")
@Nullable
TickPosition getTickPosition();
/**
* (Highstock) The position of the major tick marks relative to the axis
* line. Can be one of inside and outside.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickPosition
*
* @implspec tickPosition?: ("inside"|"outside");
*
*/
@JSProperty("tickPosition")
void setTickPosition(TickPosition value);
/**
* (Highstock) 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/highstock/navigator.yAxis.tickPositioner
*
* @implspec tickPositioner?: () => void;
*
*/
@JSProperty("tickPositioner")
@Nullable
TickPositioner getTickPositioner();
/**
* (Highstock) 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/highstock/navigator.yAxis.tickPositioner
*
* @implspec tickPositioner?: () => void;
*
*/
@JSProperty("tickPositioner")
void setTickPositioner(TickPositioner value);
/**
* (Highstock) 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/highstock/navigator.yAxis.tickPositions
*
* @implspec tickPositions?: Array;
*
*/
@JSProperty("tickPositions")
@Nullable
double[] getTickPositions();
/**
* (Highstock) 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/highstock/navigator.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/navigator.yAxis.tickWidth
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickWidth
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.tickWidth
* @see https://api.highcharts.com/highstock/navigator.yAxis.tickWidth
* @see https://api.highcharts.com/gantt/navigator.yAxis.tickWidth
*
* @implspec tickWidth?: number;
*
*/
@JSProperty("tickWidth")
void setTickWidth(double value);
/**
* (Highstock) The axis title, showing next to the axis line.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.title
*
* @implspec title?: NavigatorYAxisTitleOptions;
*
*/
@JSProperty("title")
@Nullable
NavigatorYAxisTitleOptions getTitle();
/**
* (Highstock) The axis title, showing next to the axis line.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.title
*
* @implspec title?: NavigatorYAxisTitleOptions;
*
*/
@JSProperty("title")
void setTitle(NavigatorYAxisTitleOptions 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/navigator.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/navigator.yAxis.tooltipValueFormat
*
* @implspec tooltipValueFormat?: string;
*
*/
@JSProperty("tooltipValueFormat")
void setTooltipValueFormat(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/navigator.yAxis.type
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.type
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.uniqueNames
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.uniqueNames
* @see https://api.highcharts.com/gantt/navigator.yAxis.uniqueNames
*
* @implspec uniqueNames?: boolean;
*
*/
@JSProperty("uniqueNames")
void setUniqueNames(boolean value);
/**
* (Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
* ticks and labels, should be visible.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.visible
* @see https://api.highcharts.com/highstock/navigator.yAxis.visible
* @see https://api.highcharts.com/gantt/navigator.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/navigator.yAxis.visible
* @see https://api.highcharts.com/highstock/navigator.yAxis.visible
* @see https://api.highcharts.com/gantt/navigator.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");
}
}