Package org.zkoss.chart.plotOptions

Class OrganizationPlotOptions

    • Constructor Detail

      • OrganizationPlotOptions

        public OrganizationPlotOptions()

    • Method Detail

      • getBorderColor

        public Color getBorderColor()
        Returns the color of the border surrounding each slice.

        Default: #666666

        Overrides:
        getBorderColor in class SankeyPlotOptions
        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(Color borderColor)
        Sets the color of the border surrounding each slice. Default: #666666
        Overrides:
        setBorderColor in class SankeyPlotOptions
        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(String borderColor)
        Sets the color of the border surrounding each slice. Default: #666666
        Overrides:
        setBorderColor in class SankeyPlotOptions
        Since:
        10.2.1.0

      • getBorderWidth

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

        Default: 1 when the columns are so dense that a border would cover the next column.

        Overrides:
        getBorderWidth in class SeriesPlotOptions
        Since:
        10.2.1.0

      • setBorderWidth

        public void setBorderWidth​(Number borderWidth)
        Sets the width of the border surrounding each column or bar.

        Default: 1 when the columns are so dense that a border would cover the next column.

        Overrides:
        setBorderWidth in class SeriesPlotOptions
        Since:
        10.2.1.0

      • getHangingIndent

        public Number getHangingIndent()
        Returns the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.

        Default: 20

      • setHangingIndent

        public void setHangingIndent​(Number hangingIndent)
        Sets the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.

      • getHangingIndentTranslation

        public String getHangingIndentTranslation()
        Defines the indentation of a hanging layout parent's children. (Requires organization)

        Possible options:

        • "inherit" (default): Only the first child adds the indentation, children of a child with indentation inherit the indentation.
        • "cumulative": All children of a child with indentation add its own indent. The option may cause overlapping of nodes. Then use shrink option:
        • "shrink": Nodes shrink by the hangingIndent value until they reach the minNodeLength.

        Defaults to "inherit".

        Since:
        10.2.1.0

      • setHangingIndentTranslation

        public void setHangingIndentTranslation​(String hangingIndentTranslation)
        Defines the indentation of a hanging layout parent's children. (Requires organization)

        Possible options:

        • "inherit" (default): Only the first child adds the indentation, children of a child with indentation inherit the indentation.
        • "cumulative": All children of a child with indentation add its own indent. The option may cause overlapping of nodes. Then use shrink option:
        • "shrink": Nodes shrink by the hangingIndent value until they reach the minNodeLength.

        Defaults to "inherit".

        Since:
        10.2.1.0

      • getHangingSide

        public String getHangingSide()
        Returns whether links connecting hanging nodes should be drawn on the left or right side.

        Default: "left"

        Since:
        11.4.7.0

      • setHangingSide

        public void setHangingSide​(String hangingSide)
        Sets whether links connecting hanging nodes should be drawn on the left or right side. Useful for RTL layouts. Note: Only effects inverted charts (vertical layout).

        Default: "left"

        Since:
        11.4.7.0

      • getLevels

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

        Default: null

        Overrides:
        getLevels in class SankeyPlotOptions

      • setLevels

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

      • getLinkColor

        public Color getLinkColor()
        Returns the color of the links between nodes.

        Default: #666666

      • setLinkColor

        public void setLinkColor​(Color linkColor)
        Sets the color of the links between nodes.

      • setLinkColor

        public void setLinkColor​(String linkColor)
        Sets the color of the links between nodes.

      • getLinkLineWidth

        public Number getLinkLineWidth()
        Returns the line width of the links connecting nodes, in pixels.

        Default: 1

      • setLinkLineWidth

        public void setLinkLineWidth​(Number linkLineWidth)
        Sets the line width of the links connecting nodes, in pixels.

      • getLinkRadius

        public Number getLinkRadius()
        Returns radius for the rounded corners of the links between nodes.

        Default: 10

      • setLinkRadius

        public void setLinkRadius​(Number linkRadius)
        Sets radius for the rounded corners of the links between nodes.

      • getNodeWidth

        public Number getNodeWidth()
        In a horizontal chart, returns the width of the nodes in pixels. Node that most organization charts are vertical, so the name of this option is counterintuitive.

        Default: 50

        Overrides:
        getNodeWidth in class SankeyPlotOptions

      • getMinNodeLength

        public Number getMinNodeLength()
        In a horizontal chart, the minimum width of the hanging nodes only, in pixels. In a vertical chart, the minimum height of the hanging nodes only, in pixels too.

        Note: Used only when getHangingIndentTranslation() is set to {@code "shrink").

        Defaults to {@code 10}.

        Since:
        10.2.1.0

      • setMinNodeLength

        public void setMinNodeLength​(Number minNodeLength)
        In a horizontal chart, the minimum width of the hanging nodes only, in pixels. In a vertical chart, the minimum height of the hanging nodes only, in pixels too.

        Note: Used only when getHangingIndentTranslation() is set to {@code "shrink").

        Defaults to {@code 10}.

        Since:
        10.2.1.0