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

Class CrosshairLabel

  • All Implemented Interfaces:

    Serializable


    @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.

    See Also:

    Serialized Form

    • Constructor Detail

      • CrosshairLabel

        public CrosshairLabel()

      • CrosshairLabel

        public CrosshairLabel(Boolean enabled)

    • Method Detail

      • setAlign

        public void setAlign(HorizontalAlign align)

        Alignment of the label compared to the axis. Defaults to left for right-side axes, right for left-side axes and center for horizontal axes.

      • setBackgroundColor

        public void setBackgroundColor(Color backgroundColor)

        The background color for the label. Defaults to the related series color, or #666666 if that is not available.

      • setBorderColor

        public void setBorderColor(Color borderColor)

        The border color for the crosshair label

      • setBorderRadius

        public void setBorderRadius(Number borderRadius)

        The border corner radius of the crosshair label.

        Defaults to: 3

      • setBorderWidth

        public void setBorderWidth(Number borderWidth)

        The border width for the crosshair label.

        Defaults to: 0

      • setFormat

        public void setFormat(String format)

        A format string for the crosshair label. Defaults to {value} for numeric axes and {value:%b %d, %Y} for datetime axes.

      • getFormatter

        public String getFormatter()

      • setFormatter

        public void setFormatter(String _fn_formatter)

      • setPadding

        public void setPadding(Number padding)

        Padding inside the crosshair label.

        Defaults to: 8

      • setShape

        public void setShape(Shape shape)

        The shape to use for the label box.

        Defaults to: callout

      • setEnabled

        public void setEnabled(Boolean enabled)