Class

com.highcharts.config

XAxisLabels

Related Doc: package config

Permalink

class XAxisLabels extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: xAxis-labels

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

Instance Constructors

  1. new XAxisLabels()

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

    Permalink

    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". Defaults to an intelligent guess based on which side of the chart the axis is on and the rotation of the label.

    Example:
    1. "left", "right" on X axis

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val autoRotation: Array[Double]

    Permalink

    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.

    Since

    4.1.0

  7. val autoRotationLimit: Double

    Permalink

    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

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

    Permalink

    Polar charts only.

    Polar charts only. The label's pixel distance from the perimeter of the plot area.

  10. val enabled: Boolean

    Permalink

    Enable or disable the axis labels.

    Enable or disable the axis labels.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val format: String

    Permalink

    A format string for the axis label.

    A format string for the axis label.

    Since

    3.0

  15. val formatter: Function

    Permalink

    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. Defaults to:

    function() {
    	return this.value;
    }
    

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hasOwnProperty(v: String): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Object
  21. val maxStaggerLines: Double

    Permalink

    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

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

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

    Permalink
    Definition Classes
    AnyRef
  25. val overflow: String

    Permalink

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

    Permalink

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

  27. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  28. val reserveSpace: Boolean

    Permalink

    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.

    Since

    4.1.10

  29. val rotation: Double

    Permalink

    Rotation of the labels in degrees.

    Rotation of the labels in degrees.

  30. val staggerLines: Double

    Permalink

    Horizontal axes only.

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

    Since

    2.1

  31. val step: Double

    Permalink

    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?

    Since

    2.1

  32. val style: Object

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  34. def toLocaleString(): String

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

    Permalink
    Definition Classes
    AnyRef → Any
  36. val useHTML: Boolean

    Permalink

    Whether to use HTML to render the labels.

    Whether to use HTML to render the labels.

  37. def valueOf(): Any

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. val x: Double

    Permalink

    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.

  42. val y: Double

    Permalink

    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. The default makes it adapt to the font size on bottom axis.

  43. val zIndex: Double

    Permalink

    The Z index for the axis labels.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped