Class CrosshairLabel
java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.CrosshairLabel
- All Implemented Interfaces:
Serializable
A label on the axis next to the crosshair.
In
styled mode, the label is styled with the
.highcharts-crosshair-label
class.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetAlign()
getShape()
void
setAlign
(HorizontalAlign align) Alignment of the label compared to the axis.void
setBackgroundColor
(Color backgroundColor) The background color for the label.void
setBorderColor
(Color borderColor) The border color for the crosshair labelvoid
setBorderRadius
(Number borderRadius) The border corner radius of the crosshair label.void
setBorderWidth
(Number borderWidth) The border width for the crosshair label.void
setEnabled
(Boolean enabled) void
A format string for the crosshair label.void
setFormatter
(String _fn_formatter) void
setPadding
(Number padding) Padding inside the crosshair label.void
The shape to use for the label box.
-
Constructor Details
-
CrosshairLabel
public CrosshairLabel() -
CrosshairLabel
-
-
Method Details
-
getAlign
- See Also:
-
setAlign
Alignment of the label compared to the axis. Defaults toleft
for right-side axes,right
for left-side axes andcenter
for horizontal axes. -
getBackgroundColor
- See Also:
-
setBackgroundColor
The background color for the label. Defaults to the related series color, or#666666
if that is not available. -
getBorderColor
- See Also:
-
setBorderColor
The border color for the crosshair label -
getBorderRadius
- See Also:
-
setBorderRadius
The border corner radius of the crosshair label.Defaults to: 3
-
getBorderWidth
- See Also:
-
setBorderWidth
The border width for the crosshair label.Defaults to: 0
-
getFormat
- See Also:
-
setFormat
A format string for the crosshair label. Defaults to{value}
for numeric axes and{value:%b %d, %Y}
for datetime axes. -
getFormatter
-
setFormatter
-
getPadding
- See Also:
-
setPadding
Padding inside the crosshair label.Defaults to: 8
-
getShape
- See Also:
-
setShape
The shape to use for the label box.Defaults to: callout
-
getEnabled
- See Also:
-
setEnabled
-