Package org.zkoss.chart.plotOptions

Class SankeyPlotOptions

    • Constructor Detail

      • SankeyPlotOptions

        public SankeyPlotOptions()

    • Method Detail

      • setColors

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

      • 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.
        Since:
        10.2.1.0

      • 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.
        Since:
        10.2.1.0

      • isCenterInCategory

        public boolean isCenterInCategory()
        When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.

        Default: false.

        Overrides:
        isCenterInCategory in class SeriesPlotOptions
        Since:
        10.2.1.0

      • setCenterInCategory

        public void setCenterInCategory​(boolean centerInCategory)
        When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
        Overrides:
        setCenterInCategory in class SeriesPlotOptions
        Since:
        10.2.1.0

      • getBorderColor

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

        Default: #FFFFFF

        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(Color borderColor)
        Sets the color of the border surrounding each slice. Default: #FFFFFF
        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(String borderColor)
        Sets the color of the border surrounding each slice. Default: #FFFFFF
        Since:
        10.2.1.0

      • getCurveFactor

        public Number getCurveFactor()
        Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved. A curveFactor of 0 makes the lines straight.

        Default: 0.33

      • setCurveFactor

        public void setCurveFactor​(Number curveFactor)
        Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved. A curveFactor of 0 makes the lines straight.

      • 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 node and link options.
        Since:
        10.2.1.0

      • getLinkColorMode

        public String getLinkColorMode()
        Returns color mode for sankey links. (Can be "from", "gradient", "to")

        Available options:

        • from color of the sankey link will be the same as the 'from node'
        • gradient color of the sankey link will be set to gradient between colors of 'from node' and 'to node'
        • to color of the sankey link will be same as the 'to node'.
        Default: "from"
        Since:
        11.2.0.0

      • setLinkColorMode

        public void setLinkColorMode​(String linkColorMode)
        Sets color mode for sankey links. (Can be "from", "gradient", "to")

        Available options:

        • from color of the sankey link will be the same as the 'from node'
        • gradient color of the sankey link will be set to gradient between colors of 'from node' and 'to node'
        • to color of the sankey link will be same as the 'to node'.
        Since:
        11.2.0.0

      • getLinkOpacity

        public Number getLinkOpacity()
        Returns opacity for the links between nodes in the sankey diagram.

        Default: 0.5

      • setLinkOpacity

        public void setLinkOpacity​(Number linkOpacity)
        Sets opacity for the links between nodes in the sankey diagram.

      • getMinLinkWidth

        public Number getMinLinkWidth()
        Returns the minimal width for a line of a sankey. By default, 0 values are not shown.

        Default: 0

      • setMinLinkWidth

        public void setMinLinkWidth​(Number minLinkWidth)
        Sets the minimal width for a line of a sankey. By default, 0 values are not shown.

      • getNodeAlignment

        public String getNodeAlignment()
        Returns which side of the chart the nodes are to be aligned to. (Can be "top", "center", "bottom")

        When the chart is inverted, top aligns to the left and bottom to the right.

        Default: null

        Since:
        11.2.0.0

      • setNodeAlignment

        public void setNodeAlignment​(String nodeAlignment)
        Sets which side of the chart the nodes are to be aligned to. (Can be "top", "center", "bottom")

        When the chart is inverted, top aligns to the left and bottom to the right.

        Since:
        11.2.0.0

      • getNodeDistance

        public Number getNodeDistance()
        Returns the distance between nodes in a sankey diagram in the longitudinal direction.

        Default: 30

        Since:
        11.4.7.0

      • setNodeDistance

        public void setNodeDistance​(Number nodeDistance)

        Sets the distance between nodes in a sankey diagram in the longitudinal direction.

        The longitudinal direction means the direction that the chart flows - in a horizontal chart the distance is horizontal, in an inverted chart (vertical), the distance is vertical. If a number is given, it denotes pixels. If a percentage string is given, the distance is a percentage of the rendered node width. A nodeDistance of 100% will render equal widths for the nodes and the gaps between them.

        This option applies only when the nodeWidth option is auto, making the node width respond to the number of columns.

        Default: 30

        Since:
        11.4.7.0

      • getNodePadding

        public Number getNodePadding()
        Returns the padding between nodes in a sankey diagram or dependency wheel, in pixels.

        Default: 10

      • setNodePadding

        public void setNodePadding​(Number nodePadding)
        Sets the padding between nodes in a sankey diagram or dependency wheel, in pixels.

      • getNodeWidth

        public Object getNodeWidth()
        Returns the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.

        Default: 20

        Since:
        10.2.1.0

      • setNodeWidth

        public void setNodeWidth​(String nodeWidth)
        Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted. (Requires arcdiagram or sankey)
        Since:
        10.2.1.0

      • setNodeWidth

        public void setNodeWidth​(Number nodeWidth)
        Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.
        Since:
        10.2.1.0