Packages

object PlotOptionsHeatmapDataLabels

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlotOptionsHeatmapDataLabels
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(align: UndefOr[String] = js.undefined, allowOverlap: UndefOr[Boolean] = js.undefined, backgroundColor: UndefOr[|[String, Object]] = js.undefined, borderColor: UndefOr[|[String, Object]] = js.undefined, borderRadius: UndefOr[Double] = js.undefined, borderWidth: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, crop: UndefOr[Boolean] = js.undefined, enabled: UndefOr[Boolean] = js.undefined, format: UndefOr[String] = js.undefined, formatter: UndefOr[Function] = js.undefined, overflow: UndefOr[String] = js.undefined, padding: UndefOr[Double] = js.undefined, rotation: UndefOr[Double] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, shape: UndefOr[String] = js.undefined, style: UndefOr[Object] = js.undefined, useHTML: UndefOr[Boolean] = js.undefined, verticalAlign: UndefOr[Any] = js.undefined, x: UndefOr[Double] = js.undefined, y: UndefOr[Double] = js.undefined, zIndex: UndefOr[Double] = js.undefined): PlotOptionsHeatmapDataLabels

    align

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

    allowOverlap

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

    backgroundColor

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

    borderColor

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

    borderRadius

    The border radius in pixels for the data label.

    borderWidth

    The border width in pixels for the data label.

    className

    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.

    color

    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.

    crop

    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.

    enabled

    Enable or disable the data labels.

    format

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

    formatter

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

    overflow

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

    padding

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

    rotation

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

    shadow

    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.

    shape

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

    style

    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.

    useHTML

    Whether to use HTML to render the labels.

    verticalAlign

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

    x

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

    y

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

    zIndex

    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.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped