Packages

class PlotOptionsTreemapDataLabels extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: plotOptions-treemap-dataLabels

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

Instance Constructors

  1. new PlotOptionsTreemapDataLabels()

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]

    The alignment of the data label compared to the point.

    The alignment of the data label compared to the point. If right, the right side of the label should be touching the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box, as given with the inside option. Can be one of "left", "center" or "right".

    Example:

    1. Left aligned. Understand alignment to boxes, lines and points.

  5. val allowOverlap: UndefOr[Boolean]

    Whether to allow data labels to overlap.

    Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.

    Example:

    1. Don't allow overlap

    Since

    4.1.0

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val backgroundColor: UndefOr[|[String, Object]]

    The background color or gradient for the data label.

    The background color or gradient for the data label. Defaults to undefined.

    Example:

    1. Data labels box options

    Since

    2.2.1

  8. val borderColor: UndefOr[|[String, Object]]

    The border color for the data label.

    The border color for the data label. Defaults to undefined.

    Example:

    1. Data labels box options

    Since

    2.2.1

  9. val borderRadius: UndefOr[Double]

    The border radius in pixels for the data label.

    The border radius in pixels for the data label.

    Example:

    1. Data labels box options

    Since

    2.2.1

  10. val borderWidth: UndefOr[Double]

    The border width in pixels for the data label.

    The border width in pixels for the data label.

    Example:

    1. Data labels box options

    Since

    2.2.1

  11. val className: UndefOr[String]

    A class name for the data label.

    A class name for the data label. Particularly in styled mode, this can be used to give each series' or point's data label unique styling. In addition to this option, a default color class name is added so that we can give the labels a contrast text shadow.

    Example:

    1. Styling by CSS.

    Since

    5.0.0

  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val color: UndefOr[|[String, Object]]

    The text color for the data labels.

    The text color for the data labels. Defaults to null.

    Example:

    1. Red data labels

  14. val crop: UndefOr[Boolean]

    Whether to hide data labels that are outside the plot area.

    Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot area according to the overflow option.

    Since

    2.3.3

  15. val defer: UndefOr[Boolean]

    Whether to defer displaying the data labels until the initial series animation has finished.

    Whether to defer displaying the data labels until the initial series animation has finished.

    Since

    4.1.0

  16. val enabled: UndefOr[Boolean]

    Enable or disable the data labels.

    Enable or disable the data labels.

    Example:

    1. Data labels enabled

    Since

    4.1.0

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

    A format string for the data label.

    A format string for the data label. Available variables are the same as for formatter.

    Example:

    1. Add a unit

    Since

    3.0

  21. val formatter: UndefOr[Function]

    Callback JavaScript function to format the data label.

    Callback JavaScript function to format the data label. Note that if a format is defined, the format takes precedence and the formatter is ignored. Available data are:

    this.percentage Stacked series and pies only. The point's percentage of the total.
    this.point The point object. The point name, if defined, is available through this.point.name.
    this.series: The series object. The series name is available through this.series.name.
    this.total Stacked series only. The total value at this point's x value.
    this.x: The x value.
    this.y: The y value.

  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  23. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  25. val inside: UndefOr[Boolean]

    Whether to align the data label inside the box or to the actual value point.

    Whether to align the data label inside the box or to the actual value point.

    Since

    4.1.0

  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  31. val overflow: UndefOr[String]

    How to handle data labels that flow outside the plot area.

    How to handle data labels that flow outside the plot area. The default is justify, which aligns them inside the plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the plot area, set crop to false and overflow to "none".

    Since

    3.0.6

  32. val padding: UndefOr[Double]

    When either the borderWidth or the backgroundColor is set, this is the padding within the box.

    When either the borderWidth or the backgroundColor is set, this is the padding within the box.

    Example:

    1. Data labels box options

    Since

    2.2.1

  33. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  34. val rotation: UndefOr[Double]

    Text rotation in degrees.

    Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label.

    Example:

    1. Vertical labels

  35. val shadow: UndefOr[|[Boolean, Object]]

    The shadow of the box.

    The shadow of the box. Works best with borderWidth or backgroundColor. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    Example:

    1. Data labels box options

    Since

    2.2.1

  36. val shape: UndefOr[String]

    The name of a symbol to use for the border around the label.

    The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.

    Example:

    1. A callout for annotations

    Since

    4.1.2

  37. val style: UndefOr[Object]

    Styles for the label.

    Styles for the label.

    Example:

    1. Bold labels

    Since

    4.1.0

  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toLocaleString(): String
    Definition Classes
    Object
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. val useHTML: UndefOr[Boolean]

    Whether to use HTML to render the labels.

    Whether to use HTML to render the labels.

  42. def valueOf(): Any
    Definition Classes
    Object
  43. val verticalAlign: UndefOr[String]

    The vertical alignment of a data label.

    The vertical alignment of a data label. Can be one of top, middle or bottom. The default value depends on the data, for instance in a column chart, the label is above positive values and below negative values.

    Since

    4.1.0

  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. val x: UndefOr[Double]

    The x position offset of the label relative to the point.

    The x position offset of the label relative to the point.

    Example:

    1. Vertical and positioned

  48. val y: UndefOr[Double]

    The y position offset of the label relative to the point.

    The y position offset of the label relative to the point.

    Example:

    1. Vertical and positioned

  49. val zIndex: UndefOr[Double]

    The Z index of the data labels.

    The Z index of the data labels. The default Z index puts it above the series. Use a Z index of 2 to display it behind the series.

    Since

    2.3.5

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped