Packages

class YAxisLabels extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: yAxis-labels

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

Instance Constructors

  1. new YAxisLabels()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val align: UndefOr[String]

    What part of the string the given position is anchored to.

    What part of the string the given position is anchored to. Can be one of "left", "center" or "right". The exact position also depends on the labels.x setting. Angular gauges and solid gauges defaults to center.

    Example:

    1. "left" on Y axis

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val autoRotation: UndefOr[Array[Double]]

    For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels.

    For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels. If there is enough space, labels are not rotated. As the chart gets narrower, it will start rotating the labels -45 degrees, then remove every second label and try again with rotations 0 and -45 etc. Set it to false to disable rotation, which will cause the labels to word-wrap if possible.

    Example:

    1. Default auto rotation of 0 or -45, custom graded auto rotation

    Since

    4.1.0

  7. val autoRotationLimit: UndefOr[Double]

    When each category width is more than this many pixels, we don't apply auto rotation.

    When each category width is more than this many pixels, we don't apply auto rotation. Instead, we lay out the axis label with word wrap. A lower limit makes sense when the label contains multiple short words that don't extend the available horizontal space for each label.

    Example:

    1. Lower limit

    Since

    4.1.5

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val distance: UndefOr[Double]

    Angular gauges and solid gauges only.

    Angular gauges and solid gauges only. The label's pixel distance from the perimeter of the plot area.

  10. val enabled: UndefOr[Boolean]

    Enable or disable the axis labels.

    Enable or disable the axis labels.

    Example:

    1. X axis labels disabled

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val format: UndefOr[String]

    A format string for the axis label.

    A format string for the axis label.

    Example:

    1. Add units to Y axis label

    Since

    3.0

  15. val formatter: UndefOr[Function]

    Callback JavaScript function to format the label.

    Callback JavaScript function to format the label. The value is given by this.value. Additional properties for this are axis, chart, isFirst and isLast. The value of the default label formatter can be retrieved by calling this.axis.defaultLabelFormatter.call(this) within the function.

    Defaults to: 

    function() {
	return this.value;
}

    Example:

    1. Linked category names. Modified numeric labels.

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  21. val maxStaggerLines: UndefOr[Double]

    Horizontal axis only.

    Horizontal axis only. When staggerLines is not set, maxStaggerLines defines how many lines the axis is allowed to add to automatically avoid overlapping X labels. Set to 1 to disable overlap detection.

    Since

    3.0.3

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. val overflow: UndefOr[String]

    How to handle overflowing labels on horizontal axis.

    How to handle overflowing labels on horizontal axis. Can be undefined, false or "justify". By default it aligns inside the chart area. If "justify", labels will not render outside the plot area. If false, it will not be aligned at all. If there is room to move it, it will be aligned to the edge, else it will be removed.

    Since

    2.2.5

  26. val padding: UndefOr[Double]

    The pixel padding for axis labels, to ensure white space between them.

  27. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  28. val reserveSpace: UndefOr[Boolean]

    Whether to reserve space for the labels.

    Whether to reserve space for the labels. This can be turned off when for example the labels are rendered inside the plot area instead of outside.

    Example:

    1. No reserved space, labels inside plot.

    Since

    4.1.10

  29. val rotation: UndefOr[Double]

    Rotation of the labels in degrees.

    Rotation of the labels in degrees.

    Example:

    1. X axis labels rotated 90°

  30. val staggerLines: UndefOr[Double]

    Horizontal axes only.

    Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels. .

    Example:

    1. Show labels over two lines

    Since

    2.1

  31. val step: UndefOr[Double]

    To show only every n'th label on the axis, set the step to n.

    To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label.

    By default, the step is calculated automatically to avoid overlap. To prevent this, set it to 1. This usually only happens on a category axis, and is often a sign that you have chosen the wrong axis type. Read more at Axis docs => What axis should I use?

    Example:

    1. Showing only every other axis label on a categorized x axis. Auto steps on a category axis.

    Since

    2.1

  32. val style: UndefOr[Object]

    CSS styles for the label.

    CSS styles for the label. Use whiteSpace: 'nowrap' to prevent wrapping of category labels. Use textOverflow: 'none' to prevent ellipsis (dots).

    In styled mode, the labels are styled with the .highcharts-axis-labels class.

    Example:

    1. Red X axis labels

  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toLocaleString(): String
    Definition Classes
    Object
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. val useHTML: UndefOr[Boolean]

    Whether to use HTML to render the labels.

    Whether to use HTML to render the labels.

  37. def valueOf(): Any
    Definition Classes
    Object
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. val x: UndefOr[Double]

    The x position offset of the label relative to the tick position on the axis.

    The x position offset of the label relative to the tick position on the axis. Defaults to -15 for left axis, 15 for right axis.

    Example:

    1. Y axis labels placed on grid lines

  42. val y: UndefOr[Double]

    The y position offset of the label relative to the tick position on the axis.

    The y position offset of the label relative to the tick position on the axis.

    Example:

    1. Y axis labels placed on grid lines

  43. val zIndex: UndefOr[Double]

    The Z index for the axis labels.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped