AbstractDataLabels (Vaadin Platform (vaadin-platform-javadoc) 14.9.5 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.AbstractDataLabels

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DataLabels, DataLabelsFunnel, DataLabelsRange
```
public abstract class AbstractDataLabels
extends AbstractConfigurationObject
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String OVERFLOW_JUSTIFY

static String OVERFLOW_NONE

Fields
Modifier and Type	Field and Description
`static String`	`OVERFLOW_JUSTIFY`
`static String`	`OVERFLOW_NONE`

Constructor Summary

Constructors
Constructor and Description

AbstractDataLabels()

Constructors
Constructor and Description
`AbstractDataLabels()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract String`	`getClassName()`
`abstract Boolean`	`getCrop()`
`abstract Boolean`	`getDefer()`
`abstract Boolean`	`getEnabled()`
`abstract String`	`getFormat()`
`abstract String`	`getFormatter()`
`abstract Boolean`	`getInside()`
`abstract String`	`getOverflow()`
`abstract Number`	`getPadding()`
`abstract Number`	`getRotation()`
`abstract Boolean`	`getShadow()`
`abstract Shape`	`getShape()`
`abstract Boolean`	`getUseHTML()`
`abstract VerticalAlign`	`getVerticalAlign()`
`abstract Number`	`getZIndex()`
`abstract void`	`setClassName(String className)` A class name for the data label.
`abstract void`	`setCrop(Boolean crop)` Whether to hide data labels that are outside the plot area.
`abstract void`	`setDefer(Boolean defer)` Whether to defer displaying the data labels until the initial series animation has finished.
`abstract void`	`setEnabled(Boolean enabled)` Enable or disable the data labels.
`abstract void`	`setFormat(String format)` A format string for the data label.
`abstract void`	`setFormatter(String _fn_formatter)` Callback JavaScript function to format the data label.
`abstract void`	`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.
`abstract void`	`setOverflow(String overflow)` How to handle data labels that flow outside the plot area.
`abstract void`	`setPadding(Number padding)` When either the `borderWidth` or the `backgroundColor` is set, this is the padding within the box.
`abstract void`	`setRotation(Number rotation)` Text rotation in degrees.
`abstract void`	`setShadow(Boolean shadow)` The shadow of the box.
`abstract void`	`setShape(Shape shape)` The name of a symbol to use for the border around the label.
`abstract void`	`setUseHTML(Boolean useHTML)` Whether to use HTML to render the labels.
`abstract void`	`setVerticalAlign(VerticalAlign verticalAlign)` The vertical alignment of a data label.
`abstract void`	`setZIndex(Number zIndex)` The Z index of the data labels.

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

- Field Detail
  - OVERFLOW_JUSTIFY
```
public static final String OVERFLOW_JUSTIFY
```
    See Also:
    
    Constant Field Values
  - OVERFLOW_NONE
```
public static final String OVERFLOW_NONE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractDataLabels
```
public AbstractDataLabels()
```
- Method Detail
  - getClassName
```
public abstract String getClassName()
```
    See Also:
    
    setClassName(String)
  - setClassName
```
public abstract void setClassName(String className)
```
    A class name for the data label.
  - getCrop
```
public abstract Boolean getCrop()
```
    See Also:
    
    setCrop(Boolean)
  - setCrop
```
public abstract void 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 overflow option.
  - getDefer
```
public abstract Boolean getDefer()
```
    See Also:
    
    setDefer(Boolean)
  - setDefer
```
public abstract void setDefer(Boolean defer)
```
    Whether to defer displaying the data labels until the initial series animation has finished.
  - getEnabled
```
public abstract Boolean getEnabled()
```
    See Also:
    
    setEnabled(Boolean)
  - setEnabled
```
public abstract void setEnabled(Boolean enabled)
```
    Enable or disable the data labels.
  - getFormat
```
public abstract String getFormat()
```
    See Also:
    
    setFormat(String)
  - setFormat
```
public abstract void setFormat(String format)
```
    A format string for the data label. Available variables are the same as for formatter.
  - getFormatter
```
public abstract String getFormatter()
```
    See Also:
    
    setFormatter(String)
  - setFormatter
```
public abstract void setFormatter(String _fn_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.
  - getInside
```
public abstract Boolean getInside()
```
    See Also:
    
    setInside(Boolean)
  - setInside
```
public abstract void 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.
  - getOverflow
```
public abstract String getOverflow()
```
    See Also:
    
    setOverflow(String)
  - setOverflow
```
public abstract void 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 crop to false and overflow to "none".
  - getPadding
```
public abstract Number getPadding()
```
    See Also:
    
    setPadding(Number)
  - setPadding
```
public abstract void setPadding(Number padding)
```
    When either the borderWidth or the backgroundColor is set, this is the padding within the box.
  - getRotation
```
public abstract Number getRotation()
```
    See Also:
    
    setRotation(Number)
  - setRotation
```
public abstract void 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.
  - getShadow
```
public abstract Boolean getShadow()
```
    See Also:
    
    setShadow(Boolean)
  - setShadow
```
public abstract void setShadow(Boolean shadow)
```
    The shadow of the box.
  - getShape
```
public abstract Shape getShape()
```
    See Also:
    
    setShape(Shape)
  - setShape
```
public abstract void setShape(Shape shape)
```
    The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
  - getUseHTML
```
public abstract Boolean getUseHTML()
```
    See Also:
    
    setUseHTML(Boolean)
  - setUseHTML
```
public abstract void setUseHTML(Boolean useHTML)
```
    Whether to use HTML to render the labels.
  - getVerticalAlign
```
public abstract VerticalAlign getVerticalAlign()
```
    See Also:
    
    setVerticalAlign(VerticalAlign)
  - setVerticalAlign
```
public abstract void setVerticalAlign(VerticalAlign verticalAlign)
```
    The vertical alignment of a data label.
  - getZIndex
```
public abstract Number getZIndex()
```
    See Also:
    
    setZIndex(Number)
  - setZIndex
```
public abstract void setZIndex(Number 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.

Class AbstractDataLabels

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OVERFLOW_JUSTIFY

OVERFLOW_NONE

Constructor Detail

AbstractDataLabels

Method Detail

getClassName

setClassName

getCrop

setCrop

getDefer

setDefer

getEnabled

setEnabled

getFormat

setFormat

getFormatter

setFormatter

getInside

setInside

getOverflow

setOverflow

getPadding

setPadding

getRotation

setRotation

getShadow

setShadow

getShape

setShape

getUseHTML

setUseHTML

getVerticalAlign

setVerticalAlign

getZIndex

setZIndex