Package org.zkoss.chart.plotOptions

Class TreegraphPlotOptions

    • Constructor Detail

      • TreegraphPlotOptions

        public TreegraphPlotOptions()

    • Method Detail

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

      • setAllowTraversingTree

        public void setAllowTraversingTree​(boolean allowTraversingTree)
        Parameters:
        allowTraversingTree -
        See Also:
        isAllowTraversingTree()

      • getAnimationLimit

        public Number getAnimationLimit()
        For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.

        Default: 250

        Overrides:
        getAnimationLimit in class SeriesPlotOptions
        Since:
        11.2.0.0

      • setAnimationLimit

        public void setAnimationLimit​(Number animationLimit)
        For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.

        Default: 250

        Overrides:
        setAnimationLimit in class SeriesPlotOptions
        Since:
        11.2.0.0

      • getCollapseButton

        public CollapseButton getCollapseButton()
        Returns the options applied to collapse Button.

      • setCollapseButton

        public void setCollapseButton​(CollapseButton collapseButton)
        Sets the options applied to collapse Button.

      • setColors

        public void setColors​(String... colors)
        Sets the series specific or series type specific color set to apply instead of the global colors when SeriesPlotOptions.isColorByPoint() is true.

      • setColors

        public void setColors​(Color... colors)
        Sets the series specific or series type specific color set to apply instead of the global colors when SeriesPlotOptions.isColorByPoint() is true.

      • isFillSpace

        public boolean isFillSpace()
        Returns whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.

        Defaults: false

        Since:
        11.2.0.0

      • setFillSpace

        public void setFillSpace​(boolean fillSpace)
        Sets whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.

        Since:
        11.2.0.0

      • getFindNearestPointBy

        public String getFindNearestPointBy()
        Returns whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points. Applies only to series types using nearest neighbor search (not direct hover) for tooltip.

        Default: "xy"

        Overrides:
        getFindNearestPointBy in class SeriesPlotOptions
        Since:
        11.2.0.0

      • setFindNearestPointBy

        public void setFindNearestPointBy​(String findNearestPointBy)
        Sets whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points. Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
        Overrides:
        setFindNearestPointBy in class SeriesPlotOptions
        Since:
        11.2.0.0

      • getLevels

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

        Default: null

      • setLevels

        public void setLevels​(List<Level> levels)
        Parameters:
        levels -
        See Also:
        getLevels()

      • setLevels

        public void setLevels​(Level... levels)
        Set options on specific levels. Takes precedence over series options, but not point options.

      • getLink

        public TreeGraphLink getLink()
        Returns the link style options, if any. Otherwise, create a new one.

      • setLink

        public void setLink​(TreeGraphLink link)
        Sets the link style options.

      • getOpacity

        public Number getOpacity()
        Returns opacity of a series parts: line, fill (e.g. area) and dataLabels.

        Default: 0.15

        Overrides:
        getOpacity in class SeriesPlotOptions
        Since:
        11.2.0.0

      • setOpacity

        public void setOpacity​(Number opacity)
        Sets opacity of a series parts: line, fill (e.g. area) and dataLabels.
        Overrides:
        setOpacity in class SeriesPlotOptions
        Since:
        11.2.0.0

      • isReversed

        public boolean isReversed()
        Returns whether the series should be placed on the other side of the plotArea.

        Default: false.

        Since:
        11.2.0.0

      • setReversed

        public void setReversed​(boolean reversed)
        Sets whether the series should be placed on the other side of the plotArea.
        Since:
        11.2.0.0

      • isShowInLegend

        public boolean isShowInLegend()
        Returns whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series. Default: false.
        Overrides:
        isShowInLegend in class SeriesPlotOptions
        Since:
        11.2.0.0

      • setShowInLegend

        public void setShowInLegend​(boolean showInLegend)
        Sets whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
        Overrides:
        setShowInLegend in class SeriesPlotOptions
        Since:
        11.2.0.0

      • isStickyTracking

        public boolean isStickyTracking()
        Returns sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and Tooltip.isShared() is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc. Default: false.
        Overrides:
        isStickyTracking in class SeriesPlotOptions
        Since:
        11.2.0.0

      • setStickyTracking

        public void setStickyTracking​(boolean stickyTracking)
        Sets sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and Tooltip.isShared() is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
        Overrides:
        setStickyTracking in class SeriesPlotOptions
        Since:
        11.2.0.0

      • getTraverseUpButton

        public TraverseUpButton getTraverseUpButton()
        Returns options for the button appearing when traversing down in a treegraph, if any. Otherwise, create a new one.

      • setTraverseUpButton

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