YAxis

Instance Constructors

new YAxis()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowDecimals: UndefOr[Boolean]

Whether to allow decimals in this axis' ticks.
Whether to allow decimals in this axis' ticks. When counting integers, like persons or hits on a web page, decimals must be avoided in the axis tick labels.
Example:
1. True by default (unwanted for this type of data), false
Since
2.0
val alternateGridColor: UndefOr[|[String, Object]]

When using an alternate grid color, a band is painted across the plot area between every other grid line.
When using an alternate grid color, a band is painted across the plot area between every other grid line.
Example:
1. Alternate grid color on the Y axis
final def asInstanceOf[T0]: T0

Definition Classes
Any
val breaks: UndefOr[Array[CleanJsObject[YAxisBreaks]]]

An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.
An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other. Requires that the broken-axis.js module is loaded.
Example:
1. Break on nights and weekends; broken Y axis
Since
2.1.0
val ceiling: UndefOr[Double]

The highest allowed value for automatically computed axis extremes.
The highest allowed value for automatically computed axis extremes.
Example:
1. Floor and ceiling
Since
4.0
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val crosshair: UndefOr[|[Boolean, CleanJsObject[YAxisCrosshair]]]

Configure a crosshair that follows either the mouse pointer or the hovered point.
Configure a crosshair that follows either the mouse pointer or the hovered point. By default, the crosshair is enabled on the X axis and disabled on Y axis.
Example:
1. Crosshair on both axes
Since
2.1
val dateTimeLabelFormats: UndefOr[Object]

For a datetime axis, the scale will automatically adjust to the appropriate unit.
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 an overview of the replacement codes, see dateFormat. Defaults to:
```
{
	millisecond: '%H:%M:%S.%L',
	second: '%H:%M:%S',
	minute: '%H:%M',
	hour: '%H:%M',
	day: '%e. %b',
	week: '%e. %b',
	month: '%b \'%y',
	year: '%Y'
}
```
Example:
1. More information in x axis labels
val endOnTick: UndefOr[Boolean]

Whether to force the axis to end on a tick.
Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
Example:
1. True by default and false for Y axis
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[YAxisEvents]]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val floor: UndefOr[Double]

The lowest allowed value for automatically computed axis extremes.
The lowest allowed value for automatically computed axis extremes.
Example:
1. Prevent negative stock price on Y axis
Since
4.0
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val gridLineColor: UndefOr[|[String, Object]]

Color of the grid lines extending the ticks across the plot area.
Color of the grid lines extending the ticks across the plot area.
Example:
1. Green lines
val gridLineDashStyle: UndefOr[String]

The dash or dot style of the grid lines.
The dash or dot style of the grid lines. For possible values, see this demonstration.
Example:
1. Long dashes
val gridLineWidth: UndefOr[Double]

The width of the grid lines extending the ticks across the plot area.
The width of the grid lines extending the ticks across the plot area.
Example:
1. 2px lines
val gridZIndex: UndefOr[Double]

The Z index of the grid lines.
The Z index of the grid lines.
Example:
1. A Z index of 4 renders the grid above the graph
Since
1.1
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val height: UndefOr[|[Double, String]]

The height of the Y axis.
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.
Example:
1. Percentage height panes
val id: UndefOr[String]

An id for the axis.
An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
Example:
1. Get the object
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val labels: UndefOr[CleanJsObject[YAxisLabels]]
val lineColor: UndefOr[|[String, Object]]

The color of the line marking the axis itself.
The color of the line marking the axis itself.
Example:
1. A red line on X axis
val lineWidth: UndefOr[Double]

The width of the line marking the axis itself.
The width of the line marking the axis itself.
Example:
1. A 2px line on X axis
val linkedTo: UndefOr[Double]

Index of another axis that this axis is linked to.
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.
val max: UndefOr[Double]

The maximum value of the axis.
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. The actual maximum value is also influenced by chart.alignTicks.
Example:
1. Fixed min and max
val maxPadding: UndefOr[Double]

Padding of the max value relative to the length of the axis.
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.
Example:
1. Greater min- and maxPadding
val maxZoom: UndefOr[Double]

Deprecated.
Deprecated. Use minRange instead.
val min: UndefOr[Double]

The minimum value of the axis.
The minimum value of the axis. If null the min value is automatically calculated.
If the startOnTick option is true, the min value might be rounded down.
The automatically calculated minimum value is also affected by floor, minPadding, minRange as well as series.threshold and series.softThreshold.
Example:
1. Y axis min of -50 with startOnTick to false, -50 with startOnTick true by default
val minPadding: UndefOr[Double]

Padding of the min value relative to the length of the axis.
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 min extreme is set using axis.setExtremes(), the minPadding will be ignored.
Example:
1. Greater min- and maxPadding
val minRange: UndefOr[Double]

The minimum range to display on this axis.
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.
Example:
1. Max zoom of 6 months overrides user selections
val minTickInterval: UndefOr[Double]

The minimum tick interval allowed in axis values.
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.

Since
1.2.0
val minorGridLineColor: UndefOr[|[String, Object]]

Color of the minor, secondary grid lines.
Color of the minor, secondary grid lines.
Example:
1. Bright grey lines from Y axis
val minorGridLineDashStyle: UndefOr[String]

The dash or dot style of the minor grid lines.
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
Example:
1. Long dashes on minor grid lines
val minorGridLineWidth: UndefOr[Double]

Width of the minor, secondary grid lines.
Width of the minor, secondary grid lines.
Example:
1. 2px lines from Y axis
val minorTickColor: UndefOr[|[String, Object]]

Color for the minor tick marks.
Color for the minor tick marks.
Example:
1. Black tick marks on Y axis
val minorTickInterval: UndefOr[|[String, Double]]

Tick interval in scale units for the minor ticks.
Tick interval in scale 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, 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. A minorTickInterval of "auto" on a log axis results in a best guess, attempting to enter approximately 5 minor ticks between each major tick.
If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent performance problems.
Example:
1. Null by default, "auto"
val minorTickLength: UndefOr[Double]

The pixel length of the minor tick marks.
The pixel length of the minor tick marks.
Example:
1. 10px on Y axis
val minorTickPosition: UndefOr[String]

The position of the minor tick marks relative to the axis line.
The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
Example:
1. Inside
val minorTickWidth: UndefOr[Double]

The pixel width of the minor tick mark.
The pixel width of the minor tick mark.
Example:
1. 1px width
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val offset: UndefOr[Double]

The distance in pixels from the plot area to the axis line.
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.
Example:
1. Y axis offset by 70 px
val opposite: UndefOr[Boolean]

Whether to display the axis on the opposite side of the normal.
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. In Highstock 1.x, the Y axis was placed on the left side by default.
Example:
1. Y axis on left side
val ordinal: UndefOr[Boolean]

In an ordinal axis, the points are equally spaced in the chart regardless of the actual time or x distance between them.
In an ordinal axis, the points are equally spaced in the chart regardless of the actual time or x distance between them. This means that missing data for nights or weekends will not take up space in the chart.
Example:
1. True by default, false
Since
1.1
val plotBands: UndefOr[Array[CleanJsObject[YAxisPlotBands]]]

An array of objects defining plot bands on the Y axis.
val plotLines: UndefOr[Array[CleanJsObject[YAxisPlotLines]]]

An array of lines stretching across the plot area, marking a specific value on one of the axes.
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val range: UndefOr[Double]

The zoomed range to display when only defining one or none of min or max.
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.
Example:
1. Setting a zoomed range when the rangeSelector is disabled
val reversed: UndefOr[Boolean]

Whether to reverse the axis so that the highest number is closest to the origin.
Whether to reverse the axis so that the highest number is closest to the origin.
Example:
1. Reversed Y axis
val reversedStacks: UndefOr[Boolean]

If true, the first series in a stack will be drawn on top in a positive, non-reversed Y axis.
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.
Example:
1. Non-reversed stacks.
Since
1.3.10
val showEmpty: UndefOr[Boolean]

Whether to show the axis line and title when the axis has no data.
Whether to show the axis line and title when the axis has no data.
Example:
1. When clicking the legend to hide series, one axis preserves line and title, the other doesn't
Since
1.1
val showFirstLabel: UndefOr[Boolean]

Whether to show the first tick label.
Whether to show the first tick label.
Example:
1. Labels below plot lines on Y axis
val showLastLabel: UndefOr[Boolean]

Whether to show the last tick label.
Whether to show the last tick label.
Example:
1. Labels below plot lines on Y axis
val startOfWeek: UndefOr[Double]

For datetime axes, this decides where to put the tick between weeks.
For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
Example:
1. Monday by default, Sunday
val startOnTick: UndefOr[Boolean]

Whether to force the axis to start on a tick.
Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start.
Example:
1. False for Y axis
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tickAmount: UndefOr[Double]

The amount of ticks to draw on the axis.
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.
Example:
1. 8 ticks on Y axis
Since
2.1.0
val tickColor: UndefOr[|[String, Object]]

Color for the main tick marks.
Color for the main tick marks.
Example:
1. Formatted ticks on X axis
val tickInterval: Any

The interval of the tick marks in axis units.
The interval of the tick marks in axis units. When null, the tick interval is computed to approximately follow the tickPixelInterval on linear and datetime axes. On categorized axes, a null 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.
If the tickInterval is too dense for labels to be drawn, Highcharts may remove ticks.
Example:
1. Tick interval of 0.01 on Y axis
val tickLength: UndefOr[Double]

The pixel length of the main tick marks.
The pixel length of the main tick marks.
Example:
1. Formatted ticks on X axis
val tickPixelInterval: UndefOr[Double]

If tickInterval is null this option sets the approximate pixel interval of the tick marks.
If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to categorized axis. Defaults to 72 for the Y axis and 100 for the X axis.
Example:
1. 200 px on X axis
val tickPosition: UndefOr[String]

The position of the major tick marks relative to the axis line.
The position of the major tick marks relative to the axis line. Can be one of inside and outside.
Example:
1. Formatted ticks on X axis
val tickPositioner: UndefOr[Function]

A callback function to compute on what values the ticks should be placed.
A callback function to compute on what values the ticks should be placed. Returns an array of numbers. The min and max of the axis are passed in as the first and second parameter. Options like tickInterval can be accessed by this.options.tickInterval. The automatic tick positions are accessible through this.tickPositions and can be modified by the callback.Note that in stock charts, the last label is hidden by default by the showLastLabel option.
Example:
1. Demo of tickPositions and tickPositioner
Since
1.1
val tickPositions: UndefOr[Array[Double]]

A collection of hard coded tick value positions.
A collection of hard coded tick value positions. This overrides the auto computed positions based on tickInterval and tickPixelInterval. See also tickPositioner.
Example:
1. Demo of tickPositions and tickPositioner
Since
1.1
val tickWidth: UndefOr[Double]

The pixel width of the major tick marks.
The pixel width of the major tick marks.
Example:
1. Formatted ticks on X axis
val title: UndefOr[CleanJsObject[YAxisTitle]]
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val top: UndefOr[|[Double, String]]

The top position of the Y axis.
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.
Example:
1. Percentage height panes

val units: UndefOr[Array[Any]]

Datetime axis only.

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:

units: [[
	'millisecond', // unit name
	[1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples
], [
	'second',
	[1, 2, 5, 10, 15, 30]
], [
	'minute',
	[1, 2, 5, 10, 15, 30]
], [
	'hour',
	[1, 2, 3, 4, 6, 8, 12]
], [
	'day',
	[1]
], [
	'week',
	[1]
], [
	'month',
	[1, 3, 6]
], [
	'year',
	null
]]

def valueOf(): Any

Definition Classes
Object
val visible: UndefOr[Boolean]

Whether axis, including axis title, line, ticks and labels, should be visible.
Whether axis, including axis title, line, ticks and labels, should be visible.
Example:
1. Toggle axis visibility.
Since
2.1.9
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object YAxis | package config

class YAxis extends Object

Instance Constructors

new YAxis()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowDecimals: UndefOr[Boolean]

val alternateGridColor: UndefOr[|[String, Object]]

final def asInstanceOf[T0]: T0

val breaks: UndefOr[Array[CleanJsObject[YAxisBreaks]]]

val ceiling: UndefOr[Double]

def clone(): AnyRef

val crosshair: UndefOr[|[Boolean, CleanJsObject[YAxisCrosshair]]]

val dateTimeLabelFormats: UndefOr[Object]

val endOnTick: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[YAxisEvents]]

def finalize(): Unit

val floor: UndefOr[Double]

final def getClass(): Class[_]

val gridLineColor: UndefOr[|[String, Object]]

val gridLineDashStyle: UndefOr[String]

val gridLineWidth: UndefOr[Double]

val gridZIndex: UndefOr[Double]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val height: UndefOr[|[Double, String]]

val id: UndefOr[String]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val labels: UndefOr[CleanJsObject[YAxisLabels]]

val lineColor: UndefOr[|[String, Object]]

val lineWidth: UndefOr[Double]

val linkedTo: UndefOr[Double]

val max: UndefOr[Double]

val maxPadding: UndefOr[Double]

val maxZoom: UndefOr[Double]

val min: UndefOr[Double]

val minPadding: UndefOr[Double]

val minRange: UndefOr[Double]

val minTickInterval: UndefOr[Double]

val minorGridLineColor: UndefOr[|[String, Object]]

val minorGridLineDashStyle: UndefOr[String]

val minorGridLineWidth: UndefOr[Double]

val minorTickColor: UndefOr[|[String, Object]]

val minorTickInterval: UndefOr[|[String, Double]]

val minorTickLength: UndefOr[Double]

val minorTickPosition: UndefOr[String]

val minorTickWidth: UndefOr[Double]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val offset: UndefOr[Double]

val opposite: UndefOr[Boolean]

val ordinal: UndefOr[Boolean]

val plotBands: UndefOr[Array[CleanJsObject[YAxisPlotBands]]]

val plotLines: UndefOr[Array[CleanJsObject[YAxisPlotLines]]]

def propertyIsEnumerable(v: String): Boolean

val range: UndefOr[Double]

val reversed: UndefOr[Boolean]

val reversedStacks: UndefOr[Boolean]

val showEmpty: UndefOr[Boolean]

val showFirstLabel: UndefOr[Boolean]

val showLastLabel: UndefOr[Boolean]

val startOfWeek: UndefOr[Double]

val startOnTick: UndefOr[Boolean]

final def synchronized[T0](arg0: ⇒ T0): T0

val tickAmount: UndefOr[Double]

val tickColor: UndefOr[|[String, Object]]

val tickInterval: Any

val tickLength: UndefOr[Double]

val tickPixelInterval: UndefOr[Double]

val tickPosition: UndefOr[String]

val tickPositioner: UndefOr[Function]

val tickPositions: UndefOr[Array[Double]]

val tickWidth: UndefOr[Double]