PlotOptionsMapDataLabels

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 map areas, 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".

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

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

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

   

   The border color for the data label.

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

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

10. val borderWidth: UndefOr[Double]

    

    The border width in pixels for the data label.

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. val color: UndefOr[|[String, Object]]

    

    The text color for the data labels.

    The text color for the data labels. Defaults to null. Note that data labels in Highmaps by default have a style.HcTextStroke in order to make the text readable against any background. When the color is changed, it is also recommended to change this.

    Example:

    1. White data labels

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

14. val enabled: UndefOr[Boolean]

    

    Enable or disable the data labels.

    Enable or disable the data labels.

    Example:

    1. Data labels enabled

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

    

    Definition Classes

    AnyRef

16. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18. 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. Formatted value in the data label

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

    Example:

    1. Formatted value

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

    

    Definition Classes

    AnyRef → Any

21. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

22. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

23. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

24. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

    

    Definition Classes

    AnyRef

26. final def notify(): Unit

    

    Definition Classes

    AnyRef

27. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

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

30. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

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

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

    

    The shadow of the box.

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

33. 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 (Highcharts demo)

    Since

    1.1.2

34. val style: UndefOr[Object]

    

    Styles for the label.

    Styles for the label. Note that changes in the text color should be accompanied with changes in HcTextStroke in order for the text to stand out against the background.

    Example:

    1. Bold labels

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

    

    Definition Classes

    AnyRef

36. def toLocaleString(): String

    

    Definition Classes

    Object

37. def toString(): String

    

    Definition Classes

    AnyRef → Any

38. val useHTML: UndefOr[Boolean]

    

    Whether to use HTML to render the labels.

    Whether to use HTML to render the labels.

39. def valueOf(): Any

    

    Definition Classes

    Object

40. val verticalAlign: Any

    

    The vertical alignment of a data label.

    The vertical alignment of a data label. Can be one of top, middle or bottom.

41. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

43. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

44. val x: UndefOr[Double]

    

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

45. val y: UndefOr[Double]

    

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

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