@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 CrosshairLabel extends AbstractConfigurationObject
A label on the axis next to the crosshair.
In styled mode, the label is styled with the
.highcharts-crosshair-label
class.
Constructor and Description |
---|
CrosshairLabel() |
CrosshairLabel(Boolean enabled) |
Modifier and Type | Method and Description |
---|---|
HorizontalAlign |
getAlign() |
Number |
getBorderRadius() |
Boolean |
getEnabled() |
String |
getFormat() |
String |
getFormatter() |
Number |
getPadding() |
Shape |
getShape() |
void |
setAlign(HorizontalAlign align)
Alignment of the label compared to the axis.
|
void |
setBorderRadius(Number borderRadius)
The border corner radius of the crosshair label.
|
void |
setEnabled(Boolean enabled) |
void |
setFormat(String format)
A format string for the crosshair label.
|
void |
setFormatter(String _fn_formatter) |
void |
setPadding(Number padding)
Padding inside the crosshair label.
|
void |
setShape(Shape shape)
The shape to use for the label box.
|
public CrosshairLabel()
public CrosshairLabel(Boolean enabled)
public HorizontalAlign getAlign()
setAlign(HorizontalAlign)
public void setAlign(HorizontalAlign align)
left
for right-side axes, right
for left-side
axes and center
for horizontal axes.public Number getBorderRadius()
setBorderRadius(Number)
public void setBorderRadius(Number borderRadius)
Defaults to: 3
public String getFormat()
setFormat(String)
public void setFormat(String format)
{value}
for numeric axes and {value:%b %d, %Y}
for datetime axes.public String getFormatter()
public void setFormatter(String _fn_formatter)
public Number getPadding()
setPadding(Number)
public void setPadding(Number padding)
Defaults to: 8
public Shape getShape()
setShape(Shape)
public void setShape(Shape shape)
Defaults to: callout
public Boolean getEnabled()
setEnabled(Boolean)
public void setEnabled(Boolean enabled)
Copyright © 2019. All rights reserved.