DataLabels (JSoft Highchart Renderer 2.3.0 API)

java.lang.Object
- com.jongsoft.highchart.common.Styled<DataLabels<T>>
- - com.jongsoft.highchart.series.DataLabels<T>

All Implemented Interfaces:: Extensions, Renderable, Builder<T>

public class DataLabels<T>
extends Styled<DataLabels<T>>
implements Builder<T>

Constructor Summary

Constructors
Constructor and Description

DataLabels(T parent)

Constructors
Constructor and Description
`DataLabels(T parent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`build()`
`protected DataLabels<T>`	`self()`
`DataLabels<T>`	`setAlign(Alignment align)` The alignment of the data label compared to the point.
`DataLabels<T>`	`setAllowOverlap(Boolean allowOverlap)` Whether to allow data labels to overlap.
`DataLabels<T>`	`setColor(String color)` The text color for the data labels.
`DataLabels<T>`	`setCrop(Boolean crop)` Whether to hide data labels that are outside the plot area.
`DataLabels<T>`	`setDefer(Boolean defer)` Whether to defer displaying the data labels until the initial series animation has finished.
`DataLabels<T>`	`setEnabled(Boolean enabled)` Enable or disable the data labels.
`DataLabels<T>`	`setFormat(String format)` A format string for the data label.
`DataLabels<T>`	`setFormatter(Function.Formatter formatter)` Callback JavaScript function to format the data label.
`DataLabels<T>`	`setInside(Boolean inside)` For points with an extent, like columns, whether to align the data label inside the box or to the actual value point.
`DataLabels<T>`	`setOverflow(String overflow)` How to handle data labels that flow outside the plot area.
`DataLabels<T>`	`setPadding(Number padding)` When either the borderWidth or the backgroundColor is set, this is the padding within the box.
`DataLabels<T>`	`setReserveSpace(Boolean reserveSpace)` Whether to reserve space for the labels.
`DataLabels<T>`	`setRotation(Number rotation)` Text rotation in degrees.
`DataLabels<T>`	`setX(Number x)`
`DataLabels<T>`	`setY(Number y)`

Methods inherited from class com.jongsoft.highchart.common.Styled
setBackgroundColor, setBorderColor, setBorderRadius, setBorderWidth, setClassName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jongsoft.Extensions
neededModules

- Constructor Detail
  - DataLabels
```
public DataLabels(T parent)
```
- Method Detail
  - setAlign
```
public DataLabels<T> setAlign(Alignment 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 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".
    Default: center.
  - setAllowOverlap
```
public DataLabels<T> setAllowOverlap(Boolean allowOverlap)
```
    Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the setPadding(Number) can be set to 0.
    Default: false.
  - setColor
```
public DataLabels<T> setColor(String color)
```
    The text color for the data labels.
    Default: null.
  - setCrop
```
public DataLabels<T> setCrop(Boolean 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 setOverflow(String) option.
    Default: true.
    
    Since:
    
    2.3.3
  - setDefer
```
public DataLabels<T> setDefer(Boolean defer)
```
    Whether to defer displaying the data labels until the initial series animation has finished.
    Default: true.
    
    Since:
    
    4.0
  - setEnabled
```
public DataLabels<T> setEnabled(Boolean enabled)
```
    Enable or disable the data labels.
    Default: false.
  - setInside
```
public DataLabels<T> setInside(Boolean inside)
```
    For points with an extent, like columns, whether to align the data label inside the box or to the actual value point.
    Default: false in most cases, true in stacked columns.
    
    Since:
    
    3.0
  - setFormat
```
public DataLabels<T> setFormat(String format)
```
    A format string for the data label. Available variables are the same as for formatter. Default: to {y}.
    
    See Also:
    
    Online documentation format rules
  - setFormatter
```
public DataLabels<T> setFormatter(Function.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.
  - setOverflow
```
public DataLabels<T> setOverflow(String 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 setCrop(Boolean) to false and overflow to "none".
    Default: justify.
    
    Since:
    
    3.0.6
  - setPadding
```
public DataLabels<T> setPadding(Number padding)
```
    When either the borderWidth or the backgroundColor is set, this is the padding within the box.
    Default: 5.
    
    Since:
    
    2.2.1
  - setReserveSpace
```
public DataLabels<T> setReserveSpace(Boolean reserveSpace)
```
    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.
    Default: true
    
    Since:
    
    4.1.10
  - setRotation
```
public DataLabels<T> setRotation(Number 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.
    Default: 0
  - setX
```
public DataLabels<T> setX(Number x)
```
  - setY
```
public DataLabels<T> setY(Number y)
```
  - build
```
public T build()
```
    Specified by:
    
    build in interface Builder<T>
  - self
```
protected DataLabels<T> self()
```
    Specified by:
    
    self in class Styled<DataLabels<T>>

Class DataLabels<T>

Constructor Summary

Method Summary

Methods inherited from class com.jongsoft.highchart.common.Styled

Methods inherited from class java.lang.Object

Methods inherited from interface com.jongsoft.Extensions

Constructor Detail

DataLabels

Method Detail

setAlign

setAllowOverlap

setColor

setCrop

setDefer

setEnabled

setInside

setFormat

setFormatter

setOverflow

setPadding

setReserveSpace

setRotation

setX

setY

build

self