Class Captions


  • public final class Captions
    extends AbstractNode
    The captions can control if and how a caption, to represent the group of the chart, can be shown in the rectangle,
    Author:
    Andrea "Stock" Stocchero
    • Method Detail

      • getFont

        public final IsFont getFont()
        Returns the font object.
        Returns:
        the font object.
      • getHoverFont

        public final IsFont getHoverFont()
        Returns the font object when hovered.
        Returns:
        the font object when hovered
      • setAlign

        public final void setAlign​(Align align)
        Sets the text horizontal alignment used when drawing the label.
        Parameters:
        align - the text horizontal alignment used when drawing the label.
      • getAlign

        public final Align getAlign()
        Returns the text horizontal alignment used when drawing the label.
        Returns:
        the text horizontal alignment used when drawing the label.
      • setColor

        public final void setColor​(IsColor color)
        Sets the color of the text.
        Parameters:
        color - the color of the text
      • setColor

        public final void setColor​(String color)
        Sets the color of the text.
        Parameters:
        color - the color of the text
      • getColorAsString

        public final String getColorAsString()
        Returns the color of the text.
        Returns:
        the color of the text
      • getColor

        public final IsColor getColor()
        Returns the color of the text.
        Returns:
        the color of the text
      • setHoverColor

        public final void setHoverColor​(IsColor hoverColor)
        Sets the hover color of the text.
        Parameters:
        hoverColor - the hover color of the text
      • setHoverColor

        public final void setHoverColor​(String hoverColor)
        Sets the hover color of the text.
        Parameters:
        hoverColor - the hover color of the text
      • getHoverColorAsString

        public final String getHoverColorAsString()
        Returns the hover color of the text.
        Returns:
        the hover color of the text
      • getHoverColor

        public final IsColor getHoverColor()
        Returns the hover color of the text.
        Returns:
        the hover color of the text
      • setPadding

        public final void setPadding​(int padding)
        Sets the padding to apply around labels.
        Parameters:
        padding - padding to apply around labels.
      • getPadding

        public final int getPadding()
        Returns the padding to apply around labels.
        Returns:
        padding to apply around labels.
      • getFormatterCallback

        public final FormatterCallback getFormatterCallback()
        Returns the formatter callback, if set, otherwise null.
        Returns:
        the formatter callback, if set, otherwise null.
      • setFormatter

        public final void setFormatter​(FormatterCallback formatterCallback)
        Sets the formatter callback.
        Parameters:
        formatterCallback - the formatter callback.
      • setFormatter

        public final void setFormatter​(NativeCallback formatterCallback)
        Sets the formatter callback.
        Parameters:
        formatterCallback - the formatter callback.
      • getColorCallback

        public final ColorCallback<DatasetContext> getColorCallback()
        Returns the color callback, if set, otherwise null.
        Returns:
        the color callback, if set, otherwise null.
      • setColor

        public final void setColor​(ColorCallback<DatasetContext> colorCallback)
        Sets the color callback.
        Parameters:
        colorCallback - the color callback.
      • setColor

        public final void setColor​(NativeCallback colorCallback)
        Sets the color callback.
        Parameters:
        colorCallback - the color callback.
      • getHoverColorCallback

        public final ColorCallback<DatasetContext> getHoverColorCallback()
        Returns the hover color callback, if set, otherwise null.
        Returns:
        the hover color callback, if set, otherwise null.
      • setHoverColor

        public final void setHoverColor​(ColorCallback<DatasetContext> hoverColorCallback)
        Sets the hover color callback.
        Parameters:
        hoverColorCallback - the hover color callback.
      • setHoverColor

        public final void setHoverColor​(NativeCallback hoverColorCallback)
        Sets the hover color callback.
        Parameters:
        hoverColorCallback - the color callback.
      • getAlignCallback

        public final AlignCallback getAlignCallback()
        Returns the align callback, if set, otherwise null.
        Returns:
        the align callback, if set, otherwise null.
      • setAlign

        public final void setAlign​(AlignCallback alignCallback)
        Sets the align callback.
        Parameters:
        alignCallback - the align callback.
      • setAlign

        public final void setAlign​(NativeCallback alignCallback)
        Sets the align callback.
        Parameters:
        alignCallback - the align callback.
      • getFontCallback

        public final FontCallback<DatasetContext> getFontCallback()
        Returns the font callback, if set, otherwise null.
        Returns:
        the font callback, if set, otherwise null.
      • setFont

        public final void setFont​(FontCallback<DatasetContext> fontCallback)
        Sets the font callback.
        Parameters:
        fontCallback - the font callback to set
      • setFont

        public final void setFont​(NativeCallback fontCallback)
        Sets the font callback.
        Parameters:
        fontCallback - the font callback to set
      • getHoverFontCallback

        public final FontCallback<DatasetContext> getHoverFontCallback()
        Returns the hover font callback, if set, otherwise null.
        Returns:
        the hover font callback, if set, otherwise null.
      • setHoverFont

        public final void setHoverFont​(FontCallback<DatasetContext> hoverFontCallback)
        Sets the hover font callback.
        Parameters:
        hoverFontCallback - the hover font callback to set
      • setHoverFont

        public final void setHoverFont​(NativeCallback hoverFontCallback)
        Sets the hover font callback.
        Parameters:
        hoverFontCallback - the hover font callback to set
      • setDisplay

        public final void setDisplay​(boolean display)
        Sets true whether the element should be displayed.
        Parameters:
        display - true whether the element should be displayed
      • isDisplay

        public final boolean isDisplay()
        Returns true whether the element should be displayed.
        Returns:
        true whether the element should be displayed