com.vaadin.flow.component.charts.model

Class Labels

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Labels

All Implemented Interfaces:

Serializable

public class Labels
extends AbstractConfigurationObject

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Labels()
Labels(Boolean enabled)

Method Summary

Modifier and Type	Method and Description
HorizontalAlign	getAlign()
Number[]	getAutoRotation()
Number	getAutoRotationLimit()
Number	getDistance()
Boolean	getEnabled()
String	getFormat()
String	getFormatter()
Number	getPadding()
Boolean	getReserveSpace()
String	getRotation()
Number	getStaggerLines()
Number	getStep()
Style	getStyle()
Boolean	getUseHTML()
Number	getX()
Number	getY()
Number	getZIndex()
void	setAlign(HorizontalAlign align) What part of the string the given position is anchored to.
void	setAutoRotation(Number[] autoRotation) For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels.
void	setAutoRotationLimit(Number autoRotationLimit) When each category width is more than this many pixels, we don't apply auto rotation.
void	setDistance(Number distance) Angular gauges and solid gauges only.
void	setEnabled(Boolean enabled) Enable or disable the axis labels.
void	setFormat(String format) A format string for the axis label.
void	setFormatter(String _fn_formatter)
void	setPadding(Number padding) The pixel padding for axis labels, to ensure white space between them.
void	setReserveSpace(Boolean reserveSpace) Whether to reserve space for the labels.
void	setRotation(Number rotation)
void	setRotation(String rotation)
void	setRotationPerpendicular()
void	setStaggerLines(Number staggerLines) Horizontal axes only.
void	setStep(Number step) To show only every n'th label on the axis, set the step to n.
void	setStyle(Style style) CSS styles for the label.
void	setUseHTML(Boolean useHTML) Whether to use HTML to render the labels.
void	setX(Number x) The x position offset of the label relative to the tick position on the axis.
void	setY(Number y) The y position offset of the label relative to the tick position on the axis.
void	setZIndex(Number zIndex) The Z index for the axis labels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Labels

public Labels()

Labels

public Labels(Boolean enabled)

Method Detail

getAlign

public HorizontalAlign getAlign()

See Also:

setAlign(HorizontalAlign)

setAlign

public void setAlign(HorizontalAlign align)

What part of the string the given position is anchored to. Can be one of "left", "center" or "right". The exact position also depends on the labels.x setting. Angular gauges and solid gauges defaults to center.

Defaults to: right

getAutoRotation

public Number[] getAutoRotation()

See Also:

setAutoRotation(Number[])

setAutoRotation

public void setAutoRotation(Number[] autoRotation)

For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels. If there is enough space, labels are not rotated. As the chart gets narrower, it will start rotating the labels -45 degrees, then remove every second label and try again with rotations 0 and -45 etc. Set it to false to disable rotation, which will cause the labels to word-wrap if possible.

Defaults to: [-45]

getAutoRotationLimit

public Number getAutoRotationLimit()

See Also:

setAutoRotationLimit(Number)

setAutoRotationLimit

public void setAutoRotationLimit(Number autoRotationLimit)

When each category width is more than this many pixels, we don't apply auto rotation. Instead, we lay out the axis label with word wrap. A lower limit makes sense when the label contains multiple short words that don't extend the available horizontal space for each label.

Defaults to: 80

getDistance

public Number getDistance()

See Also:

setDistance(Number)

setDistance

public void setDistance(Number distance)

Angular gauges and solid gauges only. The label's pixel distance from the perimeter of the plot area.

Defaults to: -25

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Enable or disable the axis labels.

Defaults to: true

getFormat

public String getFormat()

See Also:

setFormat(String)

setFormat

public void setFormat(String format)

A format string for the axis label.

Defaults to: {value}

getFormatter

public String getFormatter()

setFormatter

public void setFormatter(String _fn_formatter)

getPadding

public Number getPadding()

See Also:

setPadding(Number)

setPadding

public void setPadding(Number padding)

The pixel padding for axis labels, to ensure white space between them.

Defaults to: 5

getReserveSpace

public Boolean getReserveSpace()

See Also:

setReserveSpace(Boolean)

setReserveSpace

public void 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.

Defaults to: true

getStaggerLines

public Number getStaggerLines()

See Also:

setStaggerLines(Number)

setStaggerLines

public void setStaggerLines(Number staggerLines)

Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels.

getStep

public Number getStep()

See Also:

setStep(Number)

setStep

public void setStep(Number step)

To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label.

By default, the step is calculated automatically to avoid overlap. To prevent this, set it to 1. This usually only happens on a category axis, and is often a sign that you have chosen the wrong axis type. Read more at Axis docs => What axis should I use?

getStyle

public Style getStyle()

See Also:

setStyle(Style)

setStyle

public void setStyle(Style style)

CSS styles for the label. Use whiteSpace: 'nowrap' to prevent wrapping of category labels. Use textOverflow: 'none' to prevent ellipsis (dots).

In styled mode, the labels are styled with the .highcharts-axis-labels class.

Defaults to: { "color": "#666666", "cursor": "default", "fontSize": "11px" }

getUseHTML

public Boolean getUseHTML()

See Also:

setUseHTML(Boolean)

setUseHTML

public void setUseHTML(Boolean useHTML)

Whether to use HTML to render the labels.

Defaults to: false

getX

public Number getX()

See Also:

setX(Number)

setX

public void setX(Number x)

The x position offset of the label relative to the tick position on the axis. Defaults to -15 for left axis, 15 for right axis.

getY

public Number getY()

See Also:

setY(Number)

setY

public void setY(Number y)

The y position offset of the label relative to the tick position on the axis.

Defaults to: 3

getZIndex

public Number getZIndex()

See Also:

setZIndex(Number)

setZIndex

public void setZIndex(Number zIndex)

The Z index for the axis labels.

Defaults to: 7

getRotation

public String getRotation()

setRotation

public void setRotation(String rotation)

setRotation

public void setRotation(Number rotation)

setRotationPerpendicular

public void setRotationPerpendicular()