Class/Object

com.highmaps.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. Ticks are hidden by default on a Highmaps axis, though they are inherited from Highcharts and can be enabled.

  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.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. 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

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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

  10. val description: UndefOr[String]

    Permalink

    Requires Accessibility module

    Requires Accessibility module

    Description of the axis to screen reader users.

    Since

    5.0.0

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

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

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

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

    Permalink

    Event handlers for the axis.

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. 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. Highmaps grid lines are hidden by default and can be enabled by setting the gridLineWidth option.

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

  19. val gridLineWidth: UndefOr[Double]

    Permalink

    The width of the grid lines extending the ticks across the plot area.

  20. def hasOwnProperty(v: String): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. 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().

  23. final def isInstanceOf[T0]: Boolean

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

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

    Permalink

    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.

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

    Permalink

    The color of the line marking the axis itself.

  27. val lineWidth: UndefOr[Double]

    Permalink

    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.

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

  29. 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 map shapes to touch the plot border. When the axis' max option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored.

  30. val min: UndefOr[Double]

    Permalink

    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 the startOnTick option is true, the min value might be rounded down.

  31. 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 map shapes to touch the plot border. When the axis' min option is set or a min extreme is set using axis.setExtremes(), the minPadding will be ignored.

  32. 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, in terms of shape path coordinates. Defaults to 5 times the size of the smallest area.

    Note that the minPadding, maxPadding, startOnTick and endOnTick settings also affect how the extremes of the axis are computed.

  33. 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. In Highmaps, ticks are hidden by default.

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

    Permalink

    Color of the minor, secondary grid lines.

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

  36. val minorGridLineWidth: UndefOr[Double]

    Permalink

    Width of the minor, secondary grid lines.

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

    Permalink

    Color for the minor tick marks.

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

  39. val minorTickLength: UndefOr[Double]

    Permalink

    The pixel length of the minor tick marks.

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

  41. val minorTickWidth: UndefOr[Double]

    Permalink

    The pixel width of the minor tick mark.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  45. 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.

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

  47. def propertyIsEnumerable(v: String): Boolean

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

    Permalink

    Whether to reverse the axis so that the highest number is closest to the origin.

  49. 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. By default Highmaps X and Y axis don't have visible line and title regardless.

  50. val showFirstLabel: UndefOr[Boolean]

    Permalink

    If labels are enabled, whether to show the first tick label.

  51. val showLastLabel: UndefOr[Boolean]

    Permalink

    If labels are enabled, whether to show the last tick label.

  52. val softMax: UndefOr[Double]

    Permalink

    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

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

  54. 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 minPadding option to control the axis start.

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

    Permalink
    Definition Classes
    AnyRef
  56. val tickColor: UndefOr[|[String, Object]]

    Permalink

    Color for the main tick marks.

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

  58. val tickLength: UndefOr[Double]

    Permalink

    The pixel length of the main tick marks.

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

    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.

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

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

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

  63. val tickWidth: UndefOr[Double]

    Permalink

    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.

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

    Permalink

    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.

  65. def toLocaleString(): String

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

    Permalink
    Definition Classes
    AnyRef → Any
  67. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  68. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. 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