Class/Object

com.highcharts.config

YAxis

Related Docs: object YAxis | package config

Permalink

class YAxis extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: yAxis

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. YAxis
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new YAxis()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink

    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 should be avoided in the labels.

    Example:
    1. True by default (unwanted for this type of data), false

    Since

    2.0

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

    Permalink

    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.

  6. val angle: UndefOr[Double]

    Permalink

    In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right.

    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.

    Since

    4.2.7

  7. final def asInstanceOf[T0]: T0

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

    Permalink

    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.

    Since

    4.1.0

  9. val categories: UndefOr[Array[String]]

    Permalink

    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

  10. val ceiling: UndefOr[Double]

    Permalink

    The highest allowed value for automatically computed axis extremes.

    The highest allowed value for automatically computed axis extremes.

    Since

    4.0

  11. val className: UndefOr[String]

    Permalink

    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

  12. def clone(): AnyRef

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

    Permalink

    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

  14. val dateTimeLabelFormats: UndefOr[Object]

    Permalink

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

    {
    	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'
    }
    

  15. val description: UndefOr[String]

    Permalink

    Requires Accessibility module

    Requires Accessibility module

    Description of the axis to screen reader users.

    Since

    5.0.0

  16. val endOnTick: UndefOr[Boolean]

    Permalink

    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, false for logarithmic Y axis

    Since

    1.2.0

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. val events: UndefOr[CleanJsObject[YAxisEvents]]

    Permalink
  20. def finalize(): Unit

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

    Permalink

    The lowest allowed value for automatically computed axis extremes.

    The lowest allowed value for automatically computed axis extremes.

    Since

    4.0

  22. final def getClass(): Class[_]

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

    Permalink

    Color of the grid lines extending the ticks across the plot area.

    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.

  24. val gridLineDashStyle: UndefOr[String]

    Permalink

    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

  25. val gridLineInterpolation: UndefOr[String]

    Permalink

    Polar charts only.

    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.

  26. val gridLineWidth: UndefOr[Double]

    Permalink

    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

  27. val gridZIndex: UndefOr[Double]

    Permalink

    The Z index of the grid lines.

    The Z index of the grid lines.

  28. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. val id: UndefOr[String]

    Permalink

    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

  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  32. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  33. val labels: UndefOr[CleanJsObject[YAxisLabels]]

    Permalink
  34. val lineColor: UndefOr[|[String, Object]]

    Permalink

    The color of the line marking the axis itself.

    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.

  35. val lineWidth: UndefOr[Double]

    Permalink

    The width of the line marking the axis itself.

    The width of the line marking the axis itself.

  36. val linkedTo: UndefOr[Double]

    Permalink

    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.

    Since

    2.0.2

  37. val max: UndefOr[Double]

    Permalink

    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.

    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.

  38. val maxColor: UndefOr[|[String, Object]]

    Permalink

    Solid gauge only.

    Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.

    Since

    4.0

  39. val maxPadding: UndefOr[Double]

    Permalink

    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.

    Since

    1.2.0

  40. val maxZoom: UndefOr[Double]

    Permalink

    Deprecated.

    Deprecated. Renamed to minRange as of Highcharts 2.2.

  41. val min: UndefOr[Double]

    Permalink

    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 (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.

  42. val minColor: UndefOr[|[String, Object]]

    Permalink

    Solid gauge only.

    Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.

    Since

    4.0

  43. val minPadding: UndefOr[Double]

    Permalink

    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.

    Since

    1.2.0

  44. val minRange: UndefOr[Double]

    Permalink

    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.

  45. val minTickInterval: UndefOr[Double]

    Permalink

    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

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

    Permalink

    Color of the minor, secondary grid lines.

    Color of the minor, secondary grid lines.

    In styled mode, the stroke width is given in the .highcharts-minor-grid-line class.

  47. val minorGridLineDashStyle: UndefOr[String]

    Permalink

    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.

    Since

    1.2

  48. val minorGridLineWidth: UndefOr[Double]

    Permalink

    Width of the minor, secondary grid lines.

    Width of the minor, secondary grid lines.

    In styled mode, the stroke width is given in the .highcharts-grid-line class.

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

    Permalink

    Color for the minor tick marks.

    Color for the minor tick marks.

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

    Permalink

    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.

  51. val minorTickLength: UndefOr[Double]

    Permalink

    The pixel length of the minor tick marks.

    The pixel length of the minor tick marks.

    Example:
    1. 10px on Y axis

  52. val minorTickPosition: UndefOr[String]

    Permalink

    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.

  53. val minorTickWidth: UndefOr[Double]

    Permalink

    The pixel width of the minor tick mark.

    The pixel width of the minor tick mark.

    Example:
    1. 3px width

  54. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  55. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  57. val offset: UndefOr[Double]

    Permalink

    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.

  58. val opposite: UndefOr[Boolean]

    Permalink

    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.

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

    Permalink

    An array of objects defining plot bands on the Y axis.

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

    Permalink

    An array of objects representing plot lines on the X axis

  61. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  62. val reversed: UndefOr[Boolean]

    Permalink

    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

  63. val reversedStacks: UndefOr[Boolean]

    Permalink

    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.

    Since

    3.0.10

  64. val showEmpty: UndefOr[Boolean]

    Permalink

    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.

    Since

    1.1

  65. val showFirstLabel: UndefOr[Boolean]

    Permalink

    Whether to show the first tick label.

    Whether to show the first tick label.

  66. val showLastLabel: UndefOr[Boolean]

    Permalink

    Whether to show the last tick label.

    Whether to show the last tick label. Defaults to true on cartesian charts, and false on polar charts.

  67. val softMax: UndefOr[Double]

    Permalink

    A soft maximum for the axis.

    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.

    Since

    5.0.1

  68. val softMin: UndefOr[Double]

    Permalink

    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

  69. val stackLabels: UndefOr[CleanJsObject[YAxisStackLabels]]

    Permalink

    The stack labels show the total value for each bar in a stacked column or bar chart.

    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.

  70. val startOfWeek: UndefOr[Double]

    Permalink

    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.

  71. val startOnTick: UndefOr[Boolean]

    Permalink

    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 by default, true on X axis

    Since

    1.2.0

  72. val stops: UndefOr[Array[Array[Any]]]

    Permalink

    Solid gauge series only.

    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.

    Example:
    1. True by default

    Since

    4.0

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

    Permalink
    Definition Classes
    AnyRef
  74. val tickAmount: UndefOr[Double]

    Permalink

    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.

    Since

    4.1.0

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

    Permalink

    Color for the main tick marks.

    Color for the main tick marks.

    In styled mode, the stroke is given in the .highcharts-tick class.

  76. val tickInterval: UndefOr[Double]

    Permalink

    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.

    If the chart has multiple axes, the alignTicks option may interfere with the tickInterval setting.

  77. val tickLength: UndefOr[Double]

    Permalink

    The pixel length of the main tick marks.

    The pixel length of the main tick marks.

  78. val tickPixelInterval: UndefOr[Double]

    Permalink

    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.

    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 and 100 for the X axis.

    Example:
    1. 50 px on X axis

  79. val tickPosition: UndefOr[String]

    Permalink

    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

  80. val tickPositioner: UndefOr[Function]

    Permalink

    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.

  81. val tickPositions: UndefOr[Array[Double]]

    Permalink

    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.

  82. val tickWidth: UndefOr[Double]

    Permalink

    The pixel width of the major tick marks.

    The pixel width of the major tick marks.

    Example:
    1. 10 px width

  83. val tickmarkPlacement: UndefOr[String]

    Permalink

    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.

  84. val title: UndefOr[CleanJsObject[YAxisTitle]]

    Permalink
  85. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  86. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  87. val type: UndefOr[String]

    Permalink

    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.

  88. val uniqueNames: UndefOr[Boolean]

    Permalink

    Applies only when the axis type is category.

    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.

    Since

    4.2.7

  89. val units: UndefOr[Array[Any]]

    Permalink

    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
    ]]
    

  90. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  91. val visible: UndefOr[Boolean]

    Permalink

    Whether axis, including axis title, line, ticks and labels, should be visible.

    Whether axis, including axis title, line, ticks and labels, should be visible.

    Since

    4.1.9

  92. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped