PlotOptionsColumnrangeDataLabels

Instance Constructors

new PlotOptionsColumnrangeDataLabels()

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
var align: 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
var allowOverlap: 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
var backgroundColor: UndefOr[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
var borderColor: UndefOr[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
var 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
var 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( ... )
var color: UndefOr[String]

The text color for the data labels.
The text color for the data labels. Defaults to null.
Example:
1. Red data labels
var 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
var 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
var enabled: Boolean

Enable or disable the data labels.
Enable or disable the data labels.
Example:
1. Data labels enabled
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] )
var 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

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

final def getClass(): Class[_]

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

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var inside: UndefOr[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
var 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
var 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
var 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
var 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
var 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
var 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
var 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
var useHTML: Boolean

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

Definition Classes
Object
var 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
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( ... )
var xHigh: Double

X offset of the higher data labels relative to the point value.
X offset of the higher data labels relative to the point value.
Example:
1. Data labels on range series
Since
2.3.0
var xLow: Double

X offset of the lower data labels relative to the point value.
X offset of the lower data labels relative to the point value.
Example:
1. Data labels on range series
Since
2.3.0
var yHigh: Double

Y offset of the higher data labels relative to the point value.
Y offset of the higher data labels relative to the point value.
Example:
1. Data labels on range series
Since
2.3.0
var yLow: Double

Y offset of the lower data labels relative to the point value.
Y offset of the lower data labels relative to the point value.
Example:
1. Data labels on range series
Since
2.3.0
var 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 PlotOptionsColumnrangeDataLabels extends Object

Instance Constructors

new PlotOptionsColumnrangeDataLabels()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var align: String

var allowOverlap: Boolean

final def asInstanceOf[T0]: T0

var backgroundColor: UndefOr[String]

var borderColor: UndefOr[String]

var borderRadius: Double

var borderWidth: Double

def clone(): AnyRef

var color: UndefOr[String]

var crop: Boolean

var defer: Boolean

var enabled: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

var format: String

var formatter: UndefOr[Function]

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var inside: UndefOr[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

var overflow: String

var padding: Double

def propertyIsEnumerable(v: String): Boolean

var reserveSpace: Boolean

var rotation: Double

var shadow: Any

var shape: String

var style: Object

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

def toLocaleString(): String

def toString(): String

var useHTML: Boolean

def valueOf(): Any

var verticalAlign: UndefOr[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

var xHigh: Double

var xLow: Double

var yHigh: Double

var yLow: Double

var zIndex: Double

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped