Class/Object

com.highcharts.config

SeriesFunnelDataLabels

Related Docs: object SeriesFunnelDataLabels | package config

Permalink

class SeriesFunnelDataLabels extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series<funnel>-dataLabels

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

Instance Constructors

  1. new SeriesFunnelDataLabels()

    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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val backgroundColor: UndefOr[|[String, Object]]

    Permalink

    The background color or gradient for the data label.

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

    Since

    2.2.1

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

    Permalink

    The border color for the data label.

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

    Since

    2.2.1

  7. val borderRadius: UndefOr[Double]

    Permalink

    The border radius in pixels for the data label.

    The border radius in pixels for the data label.

    Since

    2.2.1

  8. val borderWidth: UndefOr[Double]

    Permalink

    The border width in pixels for the data label.

    The border width in pixels for the data label.

    Since

    2.2.1

  9. val className: UndefOr[String]

    Permalink

    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

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val color: UndefOr[|[String, Object]]

    Permalink

    The text color for the data labels.

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

    Example:
    1. Red data labels

  12. val connectorColor: UndefOr[String]

    Permalink

    The color of the line connecting the data label to the pie slice.

    The color of the line connecting the data label to the pie slice. The default color is the same as the point's color.

    In styled mode, the connector stroke is given in the .highcharts-data-label-connector class.

    Since

    2.1

  13. val connectorPadding: UndefOr[Double]

    Permalink

    The distance from the data label to the connector.

    The distance from the data label to the connector.

    Example:
    1. No padding

    Since

    2.1

  14. val connectorWidth: UndefOr[Double]

    Permalink

    The width of the line connecting the data label to the pie slice.

    The width of the line connecting the data label to the pie slice.

    In styled mode, the connector stroke width is given in the .highcharts-data-label-connector class.

    Since

    2.1

  15. val crop: UndefOr[Boolean]

    Permalink

    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

  16. val defer: UndefOr[Boolean]

    Permalink

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

  17. val distance: UndefOr[Double]

    Permalink

    The distance of the data label from the pie's edge.

    The distance of the data label from the pie's edge. Negative numbers put the data label on top of the pie slices. Connectors are only shown for data labels outside the pie.

    Since

    2.1

  18. val enabled: UndefOr[Boolean]

    Permalink

    Enable or disable the data labels.

    Enable or disable the data labels.

    Since

    2.1

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

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

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

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

    Permalink

    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

  23. val formatter: UndefOr[Function]

    Permalink

    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.

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. val inside: UndefOr[Boolean]

    Permalink

    For points with an extent, like columns, whether to align the data label inside the box or to the actual value point.

    For points with an extent, like columns, whether to align the data label inside the box or to the actual value point. Defaults to false in most cases, true in stacked columns.

    Since

    3.0

  28. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Object
  30. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  33. val overflow: UndefOr[String]

    Permalink

    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

  34. val padding: UndefOr[Double]

    Permalink

    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.

    Since

    2.2.1

  35. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  36. val rotation: UndefOr[Double]

    Permalink

    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

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

    Permalink

    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.

    Since

    2.2.1

  38. val shape: UndefOr[String]

    Permalink

    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.

    Since

    4.1.2

  39. val softConnector: UndefOr[Boolean]

    Permalink

    Whether to render the connector as a soft arc or a line with sharp break.

    Whether to render the connector as a soft arc or a line with sharp break.

    Example:
    1. Soft, non soft connectors.

    Since

    2.1.7

  40. val style: UndefOr[Object]

    Permalink

    Styles for the label.

    Styles for the label. The default color setting is "contrast", which is a pseudo color that Highcharts picks up and applies the maximum contrast to the underlying point item, for example the bar in a bar chart. The textOutline is a pseudo property that applies an outline of the given width with the given color, which by default is the maximum contrast to the text. So a bright text color will result in a black text outline for maximum readability on a mixed background. In some cases, especially with grayscale text, the text outline doesn't work well, in which cases it can be disabled by setting it to "none".

    Example:
    1. Bold labels

    Since

    4.1.0

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  44. val useHTML: UndefOr[Boolean]

    Permalink

    Whether to use HTML to render the labels.

    Whether to use HTML to render the labels.

  45. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  46. val verticalAlign: UndefOr[String]

    Permalink

    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

    2.3.3

  47. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. val x: UndefOr[Double]

    Permalink

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

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

  51. val y: UndefOr[Double]

    Permalink

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

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

  52. val zIndex: UndefOr[Double]

    Permalink

    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