Class TreemapPlotOptions

    • Constructor Detail

      • TreemapPlotOptions

        public TreemapPlotOptions()
    • Method Detail

      • getBreadcrumbs

        public Breadcrumbs getBreadcrumbs()
        Returns the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.

        Default: an instance of Breadcrumbs

        Since:
        10.2.1.0
      • setBreadcrumbs

        public void setBreadcrumbs​(Breadcrumbs breadcrumbs)
        Sets the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.

        Default: an instance of Breadcrumbs

        Since:
        10.2.1.0
      • isAllowTraversingTree

        public boolean isAllowTraversingTree()
        When enabled the user can click on a point which is a parent and zoom in on its children.

        Defaults to false.

        Since:
        7.2.1.0
      • setAllowTraversingTree

        public void setAllowTraversingTree​(boolean allowTraversingTree)
        Parameters:
        allowTraversingTree -
        Since:
        7.2.1.0
        See Also:
        isAllowTraversingTree()
      • getAllowDrillToNode

        @Deprecated
        public boolean getAllowDrillToNode()
        Deprecated.
        Deprecated and replaced by allowTraversingTree since 7.2.1.0.
        When enabled the user can click on a point which is a parent and zoom in on its children.

        Defaults to false.

        Since:
        2.1.0
      • setAllowDrillToNode

        @Deprecated
        public void setAllowDrillToNode​(boolean allowDrillToNode)
        Deprecated.
        since 7.2.1.0.
        Parameters:
        allowDrillToNode -
        Since:
        2.1.0
        See Also:
        getAllowDrillToNode()
      • getAlternateStartingDirection

        public boolean getAlternateStartingDirection()
        Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The next levels starting direction will always be the opposite of the previous.

        Defaults to false.

        Since:
        2.1.0
      • setAlternateStartingDirection

        public void setAlternateStartingDirection​(boolean alternateStartingDirection)
        Parameters:
        alternateStartingDirection -
        Since:
        2.1.0
        See Also:
        getAlternateStartingDirection()
      • getBorderColor

        public Color getBorderColor()
        The color of the border surrounding each tree map item.

        Defaults to #E0E0E0.

        Since:
        2.1.0
      • setBorderColor

        public void setBorderColor​(Color color)
        Sets the color of the border surrounding each column or bar.
        Since:
        2.1.0
        See Also:
        getBorderColor(), Color
      • setBorderColor

        public void setBorderColor​(String color)
        Sets the color of the border surrounding each column or bar.
        Since:
        2.1.0
        See Also:
        getBorderColor()
      • getBorderWidth

        public Number getBorderWidth()
        Returns the width of the border surrounding each column or bar.

        Default: 1.

        Overrides:
        getBorderWidth in class SeriesPlotOptions
        Returns:
        width of the border surrounding each column or bar.
        Since:
        2.1.0
      • setBorderWidth

        public void setBorderWidth​(Number borderWidth)
        Sets the width of the border surrounding each column or bar.
        Overrides:
        setBorderWidth in class SeriesPlotOptions
        Since:
        2.1.0
      • isIgnoreHiddenPoint

        public boolean isIgnoreHiddenPoint()
        Returns whether ignore the hidden point.

        Equivalent to Chart.isIgnoreHiddenSeries(), this option tells whether the series shall be redrawn as if the hidden point were null.

        The default value true.

        Since:
        10.2.1.0
      • setIgnoreHiddenPoint

        public void setIgnoreHiddenPoint​(boolean ignoreHiddenPoint)
        Sets whether ignore the hidden point.

        Equivalent to Chart.isIgnoreHiddenSeries(), this option tells whether the series shall be redrawn as if the hidden point were null.

        The default value true.

        Since:
        10.2.1.0
      • getInteractByLeaf

        public boolean getInteractByLeaf()
        This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is undefined, it will be true by default. However when allowTraversingTree is true, then it will be false by default.
        Since:
        2.1.0
      • setInteractByLeaf

        public void setInteractByLeaf​(boolean interactByLeaf)
        Parameters:
        interactByLeaf -
        Since:
        2.1.0
        See Also:
        getInteractByLeaf()
      • getLayoutAlgorithm

        public String getLayoutAlgorithm()
        Get the option that decides which algorithm is used for setting position and dimensions of the points.

        Default: "sliceAndDice"

        Returns:
        either "sliceAndDice", "stripes", "squarified", or "strip"
        Since:
        2.1.0
      • setLayoutAlgorithm

        public void setLayoutAlgorithm​(String layoutAlgorithm)
        Set the option decides which algorithm is used for setting position and dimensions of the points.

        Parameters:
        layoutAlgorithm -
        Since:
        2.1.0
      • getLayoutStartingDirection

        public String getLayoutStartingDirection()
        Defines which direction the layout algorithm will start drawing.

        Default: "vertical"

        Returns:
        either "vertical" or "horizontal
        Since:
        2.1.0
      • setLayoutStartingDirection

        public void setLayoutStartingDirection​(String layoutStartingDirection)
        Set which direction the layout algorithm will start drawing.

        Possible values are "vertical" and "horizontal".

        Parameters:
        layoutStartingDirection -
        Since:
        2.1.0
        See Also:
        getLayoutStartingDirection()
      • getLevelIsConstant

        public boolean getLevelIsConstant()
        Deprecated.
        since 10.2.1.0, using isLevelIsConstant() instead.
        Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure.

        Defaults to true.

        Since:
        2.1.0
      • isLevelIsConstant

        public boolean isLevelIsConstant()
        Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure.

        Defaults to true.

        Since:
        10.2.1.0
      • setLevelIsConstant

        public void setLevelIsConstant​(boolean levelIsConstant)
        Parameters:
        levelIsConstant -
        Since:
        2.1.0
        See Also:
        isLevelIsConstant()
      • getLevels

        public List<Level> getLevels()
        Returns options on specific levels. Takes precedence over series options, but not point options.

        Default: null

        Since:
        2.1.0
      • setLevels

        public void setLevels​(List<Level> levels)
        Set options on specific levels. Takes precedence over series options, but not point options.
        Parameters:
        levels -
        Since:
        2.1.0
        See Also:
        getLevels()
      • setLevels

        public void setLevels​(Level... levels)
        Set options on specific levels. Takes precedence over series options, but not node and link options.
        Since:
        10.2.1.0
      • getTraverseUpButton

        public TraverseUpButton getTraverseUpButton()
        Returns options for the button appearing when traversing down in a treemap, if any. Otherwise, create a new one.
        Since:
        7.2.1.0
      • setTraverseUpButton

        public void setTraverseUpButton​(TraverseUpButton traverseUpButton)
        Sets options for the button appearing when traversing down in a treemap.
        Since:
        7.2.1.0
      • getSortIndex

        public Number getSortIndex()
        Returns the sort index of the point inside the treemap level.

        Default: null

        Since:
        10.2.1.0
      • setSortIndex

        public void setSortIndex​(Number sortIndex)
        Sets the sort index of the point inside the treemap level.

        Default: null

        Since:
        10.2.1.0
      • isTraverseToLeaf

        public boolean isTraverseToLeaf()
        Returns this option enables automatic traversing to the last child level upon node interaction. This feature simplifies navigation by immediately focusing on the deepest layer of the data structure without intermediate steps.

        Defaults to false.

        Since:
        11.4.7.0
      • setTraverseToLeaf

        public void setTraverseToLeaf​(boolean traverseToLeaf)
        Sets this option enables automatic traversing to the last child level upon node interaction. This feature simplifies navigation by immediately focusing on the deepest layer of the data structure without intermediate steps.

        Defaults to false.

        Since:
        11.4.7.0