XAxis

Instance Constructors

new XAxis()

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: 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: String

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: Array[XAxisBreaks]

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. Simple break, advanced with callback
Since
4.1.0
val categories: Array[String]

If categories are present for the xAxis, names are used instead of numbers for that axis.
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:
```
categories: ['Apples', 'Bananas', 'Oranges']
```
Defaults to null
Example:
1. With and without categories
val ceiling: 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: Any

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.
Example:
1. Crosshair on both axes
Since
4.1
val dateTimeLabelFormats: 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. Different day format on X axis
val endOnTick: 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
Since
1.2.0
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val events: XAxisEvents

Event handlers for the axis.
def finalize(): Unit

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

The lowest allowed value for automatically computed axis extremes.
The lowest allowed value for automatically computed axis extremes.
Example:
1. Floor and ceiling
Since
4.0
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val gridLineColor: String

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: 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
Since
1.2
val gridLineWidth: 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: 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
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: 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
Since
1.2.0
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Object
val labels: XAxisLabels

The axis labels show the number or category for each tick.
val lineColor: String

The color of the line marking the axis itself.
The color of the line marking the axis itself.
Example:
1. A red line on Y axis
val lineWidth: Double

The width of the line marking the axis itself.
The width of the line marking the axis itself.
Example:
1. A 1px line on Y axis
val linkedTo: 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.
Example:
1. Different string formats of the same date, Y values on both sides
Since
2.0.2
val max: 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. Y axis max of 200, Y axis max on logarithmic axis
val maxPadding: 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. Max padding of 0.25 on y axis
Since
1.2.0
val maxZoom: Double

Deprecated.
Deprecated. Renamed to minRange as of Highcharts 2.2.
val min: 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.
Example:
1. Y axis min of -50 with startOnTick to false, -50 with startOnTick true by default
val minPadding: 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. Min padding of 0.2
Since
1.2.0
val minRange: 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. Minimum range of 5
val minTickInterval: 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
2.3.0
val minorGridLineColor: String

Color of the minor, secondary grid lines.
Color of the minor, secondary grid lines.
Example:
1. Bright grey lines from Y axis
val minorGridLineDashStyle: 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
Since
1.2
val minorGridLineWidth: Double

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

Color for the minor tick marks.
Color for the minor tick marks.
Example:
1. Black tick marks on Y axis
val minorTickInterval: Any

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. On axes using categories, minor ticks are not supported.
Example:
1. Null by default, "auto" on linear Y axis, 5 units on linear Y axis, "auto" on logarithmic Y axis, 0.1 on logarithmic Y axis.
val minorTickLength: 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: 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. Outside by default, inside
val minorTickWidth: Double

The pixel width of the minor tick mark.
The pixel width of the minor tick mark.
Example:
1. 3px 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: 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 of 70, Axes positioned in the center of the plot
val opposite: 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. This is typically used with dual or multiple axes.
Example:
1. Secondary Y axis opposite
val plotBands: Array[Object]

An array of colored bands stretching across the plot area marking an interval on the axis.
An array of colored bands stretching across the plot area marking an interval on the axis.
In a gauge, a plot band on the Y axis (value axis) will stretch along the perimeter of the gauge.
val plotLines: Array[Object]

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 reversed: 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. If the chart is inverted, the x axis is reversed by default.
Example:
1. Reversed Y axis
val showEmpty: 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: Boolean

Whether to show the first tick label.
Whether to show the first tick label.
Example:
1. Set to false on X axis
val showLastLabel: Boolean

Whether to show the last tick label.
Whether to show the last tick label.
Example:
1. Set to true on X axis
val startOfWeek: 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: 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 minPadding option to control the axis start.
Example:
1. False by default, true on X axis
Since
1.2.0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tickAmount: 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
4.1.0
val tickColor: String

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

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.
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.
Example:
1. Tick interval of 5 on a linear axis
val tickLength: Double

The pixel length of the main tick marks.
The pixel length of the main tick marks.
Example:
1. 20 px tick length on the X axis
val tickPixelInterval: 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. 50 px on X axis
val tickPosition: 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. "outside" by default, "inside" on X axis
val tickPositioner: Function

A callback function returning array defining where the ticks are laid out on the axis.
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.
Example:
1. Demo of tickPositions and tickPositioner
val tickPositions: Array[Double]

An array defining where the ticks are laid out on the axis.
An array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.
Example:
1. Demo of tickPositions and tickPositioner
val tickWidth: Double

The pixel width of the major tick marks.
The pixel width of the major tick marks.
Example:
1. 10 px width
val tickmarkPlacement: String

For categorized axes only.
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.
Example:
1. "between" by default, "on"
val title: XAxisTitle

The axis title, showing next to the axis line.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val type: String

The type of axis.
The type of axis. Can be one of "linear", "logarithmic", "datetime" or "category". 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 axis, the point names of the chart's series are used for categories, if not a categories array is defined.
Example:
1. "linear", "datetime" with regular intervals, "datetime" with irregular intervals, "logarithmic", "logarithmic" with minor grid lines, "logarithmic" on two axes.

val units: 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: 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
4.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 Doc: package config

class XAxis extends Object

Instance Constructors

new XAxis()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowDecimals: Boolean

val alternateGridColor: String

final def asInstanceOf[T0]: T0

val breaks: Array[XAxisBreaks]

val categories: Array[String]

val ceiling: Double

def clone(): AnyRef

val crosshair: Any

val dateTimeLabelFormats: Object

val endOnTick: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: XAxisEvents

def finalize(): Unit

val floor: Double

final def getClass(): Class[_]

val gridLineColor: String

val gridLineDashStyle: String

val gridLineWidth: Double

val gridZIndex: Double

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val id: String

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val labels: XAxisLabels

val lineColor: String

val lineWidth: Double

val linkedTo: Double

val max: Double

val maxPadding: Double

val maxZoom: Double

val min: Double

val minPadding: Double

val minRange: Double

val minTickInterval: Double

val minorGridLineColor: String

val minorGridLineDashStyle: String

val minorGridLineWidth: Double

val minorTickColor: String

val minorTickInterval: Any

val minorTickLength: Double

val minorTickPosition: String

val minorTickWidth: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val offset: Double

val opposite: Boolean

val plotBands: Array[Object]

val plotLines: Array[Object]

def propertyIsEnumerable(v: String): Boolean

val reversed: Boolean

val showEmpty: Boolean

val showFirstLabel: Boolean

val showLastLabel: Boolean

val startOfWeek: Double

val startOnTick: Boolean

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

val tickAmount: Double

val tickColor: String

val tickInterval: Double

val tickLength: Double

val tickPixelInterval: Double

val tickPosition: String

val tickPositioner: Function

val tickPositions: Array[Double]

val tickWidth: Double

val tickmarkPlacement: String

val title: XAxisTitle

def toLocaleString(): String