class YAxis extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
yAxis
- Alphabetic
- By Inheritance
- YAxis
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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. Ticks are hidden by default on a Highmaps axis, though they are inherited from Highcharts and can be enabled.
-
val
alternateGridColor: UndefOr[|[String, Object]]
When using an alternate grid color, a band is painted across the plot area between every other grid line.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
className: UndefOr[String]
A class name that opens for styling the axis by CSS, especially in Highcharts styled mode.
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.
- Since
5.0.0
Example: -
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.
In styled mode, the crosshairs are styled in the
.highcharts-crosshair
,.highcharts-crosshair-thin
or.highcharts-xaxis-category
classes.- Since
4.1
Example: -
val
description: UndefOr[String]
Requires Accessibility module
Requires Accessibility module
Description of the axis to screen reader users.
- Since
5.0.0
Example: -
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. -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
events: UndefOr[CleanJsObject[YAxisEvents]]
Event handlers for the axis.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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. Highmaps grid lines are hidden by default and can be enabled by setting the gridLineWidth option.
-
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.
-
val
gridLineWidth: UndefOr[Double]
The width of the grid lines extending the ticks across the plot area.
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
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()
. -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
labels: UndefOr[CleanJsObject[YAxisLabels]]
The axis labels show the number or category for each tick.
The axis labels show the number or category for each tick. X and Y axis labels are by default disabled in Highmaps, but the functionality is inherited from Highcharts and used on colorAxis, and can be enabled on X and Y axes too.
For more live examples on label options, see yAxis.labels in the Highcharts API.
-
val
lineColor: UndefOr[|[String, Object]]
The color of the line marking the axis itself.
-
val
lineWidth: UndefOr[Double]
The width of the line marking the axis itself.
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. -
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 theendOnTick
option is true, themax
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.Example: -
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 map shapes to touch the plot border. When the axis'
max
option is set or a max extreme is set usingaxis.setExtremes()
, the maxPadding will be ignored.Example: -
val
min: UndefOr[Double]
The minimum value of the axis in terms of the coordinates of the map shape paths.
The minimum value of the axis in terms of the coordinates of the map shape paths. If
null
the min value is automatically calculated. If thestartOnTick
option is true, themin
value might be rounded down.Example: -
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 map shapes to touch the plot border. When the axis'
min
option is set or a min extreme is set usingaxis.setExtremes()
, the minPadding will be ignored.Example: -
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, in terms of shape path coordinates. Defaults to 5 times the size of the smallest area.
Note that the
minPadding
,maxPadding
,startOnTick
andendOnTick
settings also affect how the extremes of the axis are computed.Example: -
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. In Highmaps, ticks are hidden by default.
-
val
minorGridLineColor: UndefOr[|[String, Object]]
Color of the minor, secondary grid lines.
-
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.
-
val
minorGridLineWidth: UndefOr[Double]
Width of the minor, secondary grid lines.
-
val
minorTickColor: UndefOr[|[String, Object]]
Color for the minor tick marks.
-
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. Ifnull
, 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.
-
val
minorTickLength: UndefOr[Double]
The pixel length of the minor tick marks.
-
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
andoutside
. -
val
minorTickWidth: UndefOr[Double]
The pixel width of the minor tick mark.
-
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. With multiple axes the offset is dynamically adjusted to avoid collision, this can be overridden by setting offset explicitly.
-
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.
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
reversed: UndefOr[Boolean]
Whether to reverse the axis so that the highest number is closest to the origin.
-
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. By default Highmaps X and Y axis don't have visible line and title regardless.
-
val
showFirstLabel: UndefOr[Boolean]
If labels are enabled, whether to show the first tick label.
-
val
showLastLabel: UndefOr[Boolean]
If labels are enabled, whether to show the last tick label.
-
val
softMax: UndefOr[Double]
A soft maximum for the axis.
A soft maximum for the axis. If the series data maximum is greater 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.
- Since
5.0.1
Example: -
val
softMin: UndefOr[Double]
A soft minimum for the axis.
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.
- Since
5.0.1
Example: -
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
minPadding
option to control the axis start. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
tickColor: UndefOr[|[String, Object]]
Color for the main tick marks.
-
val
tickInterval: UndefOr[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. -
val
tickLength: UndefOr[Double]
The pixel length of the main tick marks.
-
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.The tick interval is also influenced by the minTickInterval option, that, by default prevents ticks from being denser than the data points.
Defaults to
72
for the Y axis and100
for the 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
andoutside
. -
val
tickPositioner: UndefOr[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
andtickInterval
. -
val
tickPositions: UndefOr[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
andtickInterval
. -
val
tickWidth: UndefOr[Double]
The pixel width of the major tick marks.
The pixel width of the major tick marks.
In styled mode, the stroke width is given in the
.highcharts-tick
class. -
val
title: UndefOr[CleanJsObject[YAxisTitle]]
The axis title.
The axis title. In Highmaps, the axis is hidden by default, but adding an axis title is still possible. X axis and Y axis titles will appear at the bottom and left by default.
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
valueOf(): Any
- Definition Classes
- Object
-
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( ... )