com.vaadin.flow.component.charts.model.
Class AxisTitle
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.AxisTitle
-
All Implemented Interfaces:
public class AxisTitle extends AbstractConfigurationObject
The axis title, showing next to the axis line.
See Also:
-
-
Method Summary
All Methods Modifier and Type Method and Description VerticalAlign
getAlign()
Number
getMargin()
Number
getOffset()
Boolean
getReserveSpace()
Number
getRotation()
String
getText()
Number
getX()
Number
getY()
void
setAlign(VerticalAlign align)
Alignment of the title relative to the axis values.
void
setMargin(Number margin)
The pixel distance between the axis labels and the title.
void
setOffset(Number offset)
The distance of the axis title from the axis line.
void
setReserveSpace(Boolean reserveSpace)
Whether to reserve space for the title when laying out the axis.
void
setRotation(Number rotation)
The rotation of the text in degrees.
void
setText(String text)
The actual text of the axis title.
void
setX(Number x)
Horizontal pixel offset of the title position.
void
setY(Number y)
Vertical pixel offset of the title position.
-
-
-
Constructor Detail
-
AxisTitle
public AxisTitle()
-
AxisTitle
public AxisTitle(String text)
-
-
Method Detail
-
getAlign
public VerticalAlign getAlign()
See Also:
-
setAlign
public void setAlign(VerticalAlign align)
Alignment of the title relative to the axis values. Possible values are "low", "middle" or "high".
Defaults to: middle
-
getMargin
public Number getMargin()
See Also:
-
setMargin
public void setMargin(Number margin)
The pixel distance between the axis labels and the title. Positive values are outside the axis line, negative are inside.
Defaults to: 40
-
getOffset
public Number getOffset()
See Also:
-
setOffset
public void setOffset(Number offset)
The distance of the axis title from the axis line. By default, this distance is computed from the offset width of the labels, the labels' distance from the axis and the title's margin. However when the offset option is set, it overrides all this.
-
getReserveSpace
public Boolean getReserveSpace()
See Also:
-
setReserveSpace
public void setReserveSpace(Boolean reserveSpace)
Whether to reserve space for the title when laying out the axis.
Defaults to: true
-
getRotation
public Number getRotation()
See Also:
-
setRotation
public void setRotation(Number rotation)
The rotation of the text in degrees. 0 is horizontal, 270 is vertical reading from bottom to top.
Defaults to: 270
-
getText
public String getText()
See Also:
-
setText
public void setText(String text)
The actual text of the axis title. Horizontal texts can contain HTML, but rotated texts are painted using vector techniques and must be clean text. The Y axis title is disabled by setting the
text
option tonull
.Defaults to: Values
-
getX
public Number getX()
See Also:
-
setX
public void setX(Number x)
Horizontal pixel offset of the title position.
Defaults to: 0
-
getY
public Number getY()
See Also:
-
setY
public void setY(Number y)
Vertical pixel offset of the title position.
-
-