com.vaadin.flow.component.charts.model.
Class Label
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.Label
-
All Implemented Interfaces:
@Generated(value="This class is generated and shouldn\'t be modified", comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new") public class Label extends AbstractConfigurationObject
Text labels for the plot bands
See Also:
-
-
Method Summary
All Methods Modifier and Type Method and Description HorizontalAlign
getAlign()
Number
getRotation()
String
getText()
TextAlign
getTextAlign()
Boolean
getUseHTML()
VerticalAlign
getVerticalAlign()
Number
getX()
Number
getY()
void
setAlign(HorizontalAlign align)
Horizontal alignment of the label.
void
setRotation(Number rotation)
Rotation of the text label in degrees.
void
setText(String text)
The text itself.
void
setTextAlign(TextAlign textAlign)
The text alignment for the label.
void
setUseHTML(Boolean useHTML)
Whether to use HTML to render the labels.
void
setVerticalAlign(VerticalAlign verticalAlign)
Vertical alignment of the label relative to the plot band.
void
setX(Number x)
Horizontal position relative the alignment.
void
setY(Number y)
Vertical position of the text baseline relative to the alignment.
-
-
-
Constructor Detail
-
Label
public Label()
-
Label
public Label(String text)
-
-
Method Detail
-
getAlign
public HorizontalAlign getAlign()
See Also:
-
setAlign
public void setAlign(HorizontalAlign align)
Horizontal alignment of the label. Can be one of "left", "center" or "right".
Defaults to: left
-
getRotation
public Number getRotation()
See Also:
-
setRotation
public void setRotation(Number rotation)
Rotation of the text label in degrees. Defaults to 0 for horizontal plot lines and 90 for vertical lines.
-
getText
public String getText()
See Also:
-
setText
public void setText(String text)
The text itself. A subset of HTML is supported.
-
getTextAlign
public TextAlign getTextAlign()
See Also:
-
setTextAlign
public void setTextAlign(TextAlign textAlign)
The text alignment for the label. While
align
determines where the texts anchor point is placed within the plot band,textAlign
determines how the text is aligned against its anchor point. Possible values are "left", "center" and "right". Defaults to the same as thealign
option.
-
getUseHTML
public Boolean getUseHTML()
See Also:
-
setUseHTML
public void setUseHTML(Boolean useHTML)
Whether to use HTML to render the labels.
Defaults to: false
-
getVerticalAlign
public VerticalAlign getVerticalAlign()
See Also:
-
setVerticalAlign
public void setVerticalAlign(VerticalAlign verticalAlign)
Vertical alignment of the label relative to the plot band. Can be one of "top", "middle" or "bottom".
Defaults to: top
-
getX
public Number getX()
See Also:
-
setX
public void setX(Number x)
Horizontal position relative the alignment. Default varies by orientation.
-
getY
public Number getY()
See Also:
-
setY
public void setY(Number y)
Vertical position of the text baseline relative to the alignment. Default varies by orientation.
-
-