DataLabelsRange (Vaadin Platform (vaadin-platform-javadoc) 14.12.5 API)

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

All Implemented Interfaces:

Serializable
```
public class DataLabelsRange
extends AbstractDataLabels
```
Extended data labels for range series types. Range series data labels have no x and y options. Instead, they have xLow, xHigh, yLow and yHigh options to allow the higher and lower data label sets individually.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.vaadin.flow.component.charts.model.AbstractDataLabels
  OVERFLOW_JUSTIFY, OVERFLOW_NONE

Constructor Summary

Constructors
Constructor and Description

DataLabelsRange()

DataLabelsRange(Boolean enabled)

Constructors
Constructor and Description
`DataLabelsRange()`
`DataLabelsRange(Boolean enabled)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HorizontalAlign`	`getAlign()`
`Boolean`	`getAllowOverlap()`
`String`	`getClassName()`
`Boolean`	`getCrop()`
`Boolean`	`getDefer()`
`Boolean`	`getEnabled()`
`String`	`getFormat()`
`String`	`getFormatter()`
`Boolean`	`getInside()`
`String`	`getOverflow()`
`Number`	`getPadding()`
`Number`	`getRotation()`
`Boolean`	`getShadow()`
`Shape`	`getShape()`
`Boolean`	`getUseHTML()`
`VerticalAlign`	`getVerticalAlign()`
`Number`	`getXHigh()`
`Number`	`getXLow()`
`Number`	`getYHigh()`
`Number`	`getYLow()`
`Number`	`getZIndex()`
`void`	`setAlign(HorizontalAlign align)` The alignment of the data label compared to the point.
`void`	`setAllowOverlap(Boolean allowOverlap)` Whether to allow data labels to overlap.
`void`	`setClassName(String className)` A class name for the data label.
`void`	`setCrop(Boolean crop)` Whether to hide data labels that are outside the plot area.
`void`	`setDefer(Boolean defer)` Whether to defer displaying the data labels until the initial series animation has finished.
`void`	`setEnabled(Boolean enabled)` Enable or disable the data labels.
`void`	`setFormat(String format)` A format string for the data label.
`void`	`setFormatter(String _fn_formatter)` Callback JavaScript function to format the data label.
`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.
`void`	`setOverflow(String overflow)` How to handle data labels that flow outside the plot area.
`void`	`setPadding(Number padding)` When either the `borderWidth` or the `backgroundColor` is set, this is the padding within the box.
`void`	`setRotation(Number rotation)` Text rotation in degrees.
`void`	`setShadow(Boolean shadow)` The shadow of the box.
`void`	`setShape(Shape shape)` The name of a symbol to use for the border around the label.
`void`	`setUseHTML(Boolean useHTML)` Whether to use HTML to render the labels.
`void`	`setVerticalAlign(VerticalAlign verticalAlign)` The vertical alignment of a data label.
`void`	`setXHigh(Number xHigh)` X offset of the higher data labels relative to the point value.
`void`	`setXLow(Number xLow)` X offset of the lower data labels relative to the point value.
`void`	`setYHigh(Number yHigh)` Y offset of the higher data labels relative to the point value.
`void`	`setYLow(Number yLow)` Y offset of the lower data labels relative to the point value.
`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

- Constructor Detail
  - DataLabelsRange
```
public DataLabelsRange()
```
  - DataLabelsRange
```
public DataLabelsRange(Boolean enabled)
```
- Method Detail
  - getAlign
```
public HorizontalAlign getAlign()
```
    See Also:
    
    setAlign(HorizontalAlign)
  - setAlign
```
public void setAlign(HorizontalAlign 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".
    Defaults to: center
  - getAllowOverlap
```
public Boolean getAllowOverlap()
```
    See Also:
    
    setAllowOverlap(Boolean)
  - setAllowOverlap
```
public void setAllowOverlap(Boolean allowOverlap)
```
    Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.
    Defaults to: false
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in class AbstractDataLabels
    
    See Also:
    
    setClassName(String)
  - setClassName
```
public void setClassName(String className)
```
    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.
    
    Specified by:
    
    setClassName in class AbstractDataLabels
  - getCrop
```
public Boolean getCrop()
```
    Specified by:
    
    getCrop in class AbstractDataLabels
    
    See Also:
    
    setCrop(Boolean)
  - setCrop
```
public 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.
    Defaults to: true
    
    Specified by:
    
    setCrop in class AbstractDataLabels
  - getDefer
```
public Boolean getDefer()
```
    Specified by:
    
    getDefer in class AbstractDataLabels
    
    See Also:
    
    setDefer(Boolean)
  - setDefer
```
public void setDefer(Boolean defer)
```
    Whether to defer displaying the data labels until the initial series animation has finished.
    Defaults to: true
    
    Specified by:
    
    setDefer in class AbstractDataLabels
  - getEnabled
```
public Boolean getEnabled()
```
    Specified by:
    
    getEnabled in class AbstractDataLabels
    
    See Also:
    
    setEnabled(Boolean)
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Enable or disable the data labels.
    Defaults to: false
    
    Specified by:
    
    setEnabled in class AbstractDataLabels
  - getFormat
```
public String getFormat()
```
    Specified by:
    
    getFormat in class AbstractDataLabels
    
    See Also:
    
    setFormat(String)
  - setFormat
```
public void setFormat(String format)
```
    A format string for the data label. Available variables are the same as for formatter.
    Defaults to: {y}
    
    Specified by:
    
    setFormat in class AbstractDataLabels
  - getFormatter
```
public String getFormatter()
```
    Specified by:
    
    getFormatter in class AbstractDataLabels
    
    See Also:
    
    AbstractDataLabels.setFormatter(String)
  - setFormatter
```
public void setFormatter(String _fn_formatter)
```
    Description copied from class: AbstractDataLabels
    
    Callback JavaScript function to format the data label. Note that if a format is defined, the format takes precedence and the formatter is ignored.
    
    Specified by:
    
    setFormatter in class AbstractDataLabels
  - getInside
```
public Boolean getInside()
```
    Specified by:
    
    getInside in class AbstractDataLabels
    
    See Also:
    
    setInside(Boolean)
  - setInside
```
public 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. Defaults to false in most cases, true in stacked columns.
    
    Specified by:
    
    setInside in class AbstractDataLabels
  - getOverflow
```
public String getOverflow()
```
    Specified by:
    
    getOverflow in class AbstractDataLabels
    
    See Also:
    
    setOverflow(String)
  - setOverflow
```
public 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".
    Defaults to: justify
    
    Specified by:
    
    setOverflow in class AbstractDataLabels
  - getPadding
```
public Number getPadding()
```
    Specified by:
    
    getPadding in class AbstractDataLabels
    
    See Also:
    
    setPadding(Number)
  - setPadding
```
public void setPadding(Number padding)
```
    When either the borderWidth or the backgroundColor is set, this is the padding within the box.
    Defaults to: 5
    
    Specified by:
    
    setPadding in class AbstractDataLabels
  - getRotation
```
public Number getRotation()
```
    Specified by:
    
    getRotation in class AbstractDataLabels
    
    See Also:
    
    setRotation(Number)
  - setRotation
```
public 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.
    Defaults to: 0
    
    Specified by:
    
    setRotation in class AbstractDataLabels
  - getShadow
```
public Boolean getShadow()
```
    Specified by:
    
    getShadow in class AbstractDataLabels
    
    See Also:
    
    setShadow(Boolean)
  - setShadow
```
public void setShadow(Boolean shadow)
```
    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.
    Defaults to: false
    
    Specified by:
    
    setShadow in class AbstractDataLabels
  - getShape
```
public Shape getShape()
```
    Specified by:
    
    getShape in class AbstractDataLabels
    
    See Also:
    
    setShape(Shape)
  - setShape
```
public 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.
    Defaults to: square
    
    Specified by:
    
    setShape in class AbstractDataLabels
  - getUseHTML
```
public Boolean getUseHTML()
```
    Specified by:
    
    getUseHTML in class AbstractDataLabels
    
    See Also:
    
    setUseHTML(Boolean)
  - setUseHTML
```
public void setUseHTML(Boolean useHTML)
```
    Whether to use HTML to render the labels.
    Defaults to: false
    
    Specified by:
    
    setUseHTML in class AbstractDataLabels
  - getVerticalAlign
```
public VerticalAlign getVerticalAlign()
```
    Specified by:
    
    getVerticalAlign in class AbstractDataLabels
    
    See Also:
    
    setVerticalAlign(VerticalAlign)
  - setVerticalAlign
```
public void setVerticalAlign(VerticalAlign verticalAlign)
```
    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.
    
    Specified by:
    
    setVerticalAlign in class AbstractDataLabels
  - getXHigh
```
public Number getXHigh()
```
    See Also:
    
    setXHigh(Number)
  - setXHigh
```
public void setXHigh(Number xHigh)
```
    X offset of the higher data labels relative to the point value.
    Defaults to: 0
  - getXLow
```
public Number getXLow()
```
    See Also:
    
    setXLow(Number)
  - setXLow
```
public void setXLow(Number xLow)
```
    X offset of the lower data labels relative to the point value.
    Defaults to: 0
  - getYHigh
```
public Number getYHigh()
```
    See Also:
    
    setYHigh(Number)
  - setYHigh
```
public void setYHigh(Number yHigh)
```
    Y offset of the higher data labels relative to the point value.
    Defaults to: -6
  - getYLow
```
public Number getYLow()
```
    See Also:
    
    setYLow(Number)
  - setYLow
```
public void setYLow(Number yLow)
```
    Y offset of the lower data labels relative to the point value.
    Defaults to: 16
  - getZIndex
```
public Number getZIndex()
```
    Specified by:
    
    getZIndex in class AbstractDataLabels
    
    See Also:
    
    setZIndex(Number)
  - setZIndex
```
public 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.
    Defaults to: 6
    
    Specified by:
    
    setZIndex in class AbstractDataLabels

Class DataLabelsRange

Field Summary

Fields inherited from class com.vaadin.flow.component.charts.model.AbstractDataLabels

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataLabelsRange

DataLabelsRange

Method Detail

getAlign

setAlign

getAllowOverlap

setAllowOverlap

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

getXHigh

setXHigh

getXLow

setXLow

getYHigh

setYHigh

getYLow

setYLow

getZIndex

setZIndex