Class TreeMapElementOptions


  • public final class TreeMapElementOptions
    extends CommonElementOptions
    Maps the out-of-the-box CHART.JS element options used to represents boxes for treemap on the charts.
    Author:
    Andrea "Stock" Stocchero
    • Method Detail

      • getDividers

        public Dividers getDividers()
        Returns the dividers object.
        Returns:
        the dividers object.
      • getCaptions

        public Captions getCaptions()
        Returns the captions object.
        Returns:
        the captions object.
      • getLabels

        public Labels getLabels()
        Returns the labels object.
        Returns:
        the labels object.
      • getDefaultBorderWidth

        protected int getDefaultBorderWidth()
        Description copied from class: CommonElementOptions
        This method must be overrided by all element where the border width is stored in different object.
        Overrides:
        getDefaultBorderWidth in class CommonElementOptions
        Returns:
        an undefined integer
      • getBorderWidth

        public int getBorderWidth()
        Returns the border width of the dataset item in pixels.
        Overrides:
        getBorderWidth in class CommonElementOptions
        Returns:
        the border width of the dataset item in pixels.
      • isBorderWidthAsObject

        public boolean isBorderWidthAsObject()
        Returns true if the border width is defined as BarBorderWidth.
        Returns:
        true if the border width is defined as BarBorderWidth
      • getBorderWidthAsObject

        public BarBorderWidth getBorderWidthAsObject()
        Returns the border width of the dataset item in pixels as BarBorderWidth.
        Returns:
        the border width of the dataset item in pixels as BarBorderWidth.
      • setBorderWidth

        public void setBorderWidth​(BarBorderWidth borderWidth)
        Sets the border width (in pixels).
        Parameters:
        borderWidth - the border width (in pixels).
      • setRtl

        public void setRtl​(boolean rtl)
        Sets true for rendering the rectangles from right to left.
        Parameters:
        rtl - true for rendering the rectangles from right to left
      • isRtl

        public boolean isRtl()
        Returns true for rendering the rectangles from right to left.
        Returns:
        true for rendering the rectangles from right to left.
      • setSpacing

        public void setSpacing​(double spacing)
        Sets the fixed spacing among rectangles.
        Parameters:
        spacing - the fixed spacing among rectangles
      • getSpacing

        public double getSpacing()
        Returns the fixed spacing among rectangles.
        Returns:
        the fixed spacing among rectangles