PlotOptionsPyramidDataLabels

Instance Constructors

new PlotOptionsPyramidDataLabels()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val backgroundColor: String

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
val borderColor: String

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
val borderRadius: 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
val borderWidth: 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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val color: String

The text color for the data labels.
The text color for the data labels. Defaults to null.
Example:
1. Red data labels
val connectorColor: String

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.
Example:
1. Blue connectors
Since
2.1
val connectorPadding: Double

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

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.
Example:
1. Disable the connector
Since
2.1
val crop: 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
val defer: 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.0
val distance: Double

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.
Example:
1. Data labels on top of the pie
Since
2.1
val enabled: Boolean

Enable or disable the data labels.
Enable or disable the data labels.

Since
2.1
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val format: 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

val formatter: 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.

final def getClass(): Class[_]

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

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val inside: Boolean

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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val overflow: 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
val padding: 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
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val reserveSpace: Boolean

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.
Example:
1. No reserved space, labels inside plot.
Since
4.1.10
val rotation: 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
val shadow: Any

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
val shape: 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
val softConnector: Boolean

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
val style: Object

Styles for the label.
Styles for the label.
Example:
1. Bold labels
Since
4.1.0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val useHTML: Boolean

Whether to use HTML to render the labels.
Whether to use HTML to render the labels.
def valueOf(): Any

Definition Classes
Object
val verticalAlign: 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
2.3.3
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
val x: 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
val y: 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
val zIndex: 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

Related Doc: package config

class PlotOptionsPyramidDataLabels extends Object

Instance Constructors

new PlotOptionsPyramidDataLabels()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val backgroundColor: String

val borderColor: String

val borderRadius: Double

val borderWidth: Double

def clone(): AnyRef

val color: String

val connectorColor: String

val connectorPadding: Double

val connectorWidth: Double

val crop: Boolean

val defer: Boolean

val distance: Double

val enabled: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val format: String

val formatter: Function

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val inside: Boolean

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val overflow: String

val padding: Double

def propertyIsEnumerable(v: String): Boolean

val reserveSpace: Boolean

val rotation: Double

val shadow: Any

val shape: String

val softConnector: Boolean

val style: Object

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

def toLocaleString(): String

def toString(): String

val useHTML: Boolean

def valueOf(): Any

val verticalAlign: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val x: Double

val y: Double

val zIndex: Double

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped