Class SankeyDataset

    • Constructor Detail

      • SankeyDataset

        public SankeyDataset()
        Creates a data set.
        It uses the global options has default.
      • SankeyDataset

        public SankeyDataset​(IsDefaultOptions defaultValues)
        Creates a data set setting the defaults value.
        Parameters:
        defaultValues - default options
    • Method Detail

      • getFont

        public IsFont getFont()
        Returns the font object.
        Returns:
        the font object.
      • setLabels

        public void setLabels​(Labels labels)
        Sets the map for labeling the sankey elements.
        Parameters:
        labels - the map for labeling the sankey elements
      • getLabels

        public Labels getLabels()
        Returns the map for labeling the sankey elements.
        Returns:
        the map for labeling the sankey elements
      • setPriority

        public void setPriority​(Priority priority)
        Sets the map for assigning a priority to the sankey elements.
        Parameters:
        priority - the map for assigning a priority to the sankey elements
      • getPriority

        public Priority getPriority()
        Returns the map for assigning a priority to the sankey elements.
        Returns:
        the map for assigning a priority to the sankey elements
      • setColumn

        public void setColumn​(Column column)
        Sets the map for assigning the start or ending position to the sankey elements.
        Parameters:
        column - the map for assigning the start or ending position to the sankey elements
      • getColumn

        public Column getColumn()
        Returns the map for assigning the start or ending position to the sankey elements.
        Returns:
        the map for assigning the start or ending position to the sankey elements
      • setDataPoints

        public void setDataPoints​(SankeyDataPoint... datapoints)
        Sets the data property of a data set for a chart is specified as an array of data points.
        Parameters:
        datapoints - an array of data points
      • setDataPoints

        public void setDataPoints​(List<SankeyDataPoint> datapoints)
        Sets the data property of a data set for a chart is specified as an array of data points.
        Parameters:
        datapoints - a list of data points
      • getDataPoints

        public List<SankeyDataPoint> getDataPoints()
        Returns the sankey data property of a dataset for a chart is specified as an array of sankey data points
        Returns:
        a list of sankey data points or an empty list of data points.
      • getDataPoints

        public List<SankeyDataPoint> getDataPoints​(boolean binding)
        Returns the sankey data property of a dataset for a chart is specified as an array of sankey data points
        Parameters:
        binding - if true binds the new array list in the container
        Returns:
        a list of sankey data points or an empty list of data points
      • setSize

        public void setSize​(Size size)
        Sets Size.MIN if flow overlap is preferred.
        Parameters:
        size - Size.MIN if flow overlap is preferred
      • getSize

        public Size getSize()
        Returns Size.MIN if flow overlap is preferred.
        Returns:
        Size.MIN if flow overlap is preferred
      • setColorMode

        public void setColorMode​(ColorMode colorMode)
        Sets the color mode between sankey elements.
        Parameters:
        colorMode - the color mode between sankey elements
      • getColorMode

        public ColorMode getColorMode()
        Returns the color mode between sankey elements.
        Returns:
        the color mode between sankey elements
      • setColorFrom

        public void setColorFrom​(IsColor... colors)
        Sets the starting color of the flow between sankey elements.
        Parameters:
        colors - the starting color of the flow between sankey elements
      • setColorFrom

        public void setColorFrom​(String... colors)
        Sets the starting color of the flow between sankey elements.
        Parameters:
        colors - the starting color of the flow between sankey elements
      • getColorFromAsString

        public List<String> getColorFromAsString()
        Returns the starting color of the flow between sankey elements.
        Returns:
        list of the starting color of the flow between sankey elements
      • getColorFrom

        public List<IsColor> getColorFrom()
        Returns the starting color of the flow between sankey elements.
        Returns:
        list of the starting color of the flow between sankey elements
      • setColorTo

        public void setColorTo​(IsColor... colors)
        Sets the ending color of the flow between sankey elements.
        Parameters:
        colors - the ending color of the flow between sankey elements
      • setColorTo

        public void setColorTo​(String... colors)
        Sets the ending color of the flow between sankey elements.
        Parameters:
        colors - the ending color of the flow between sankey elements
      • getColorToAsString

        public List<String> getColorToAsString()
        Returns the ending color of the flow between sankey elements.
        Returns:
        list of the ending color of the flow between sankey elements
      • getColorTo

        public List<IsColor> getColorTo()
        Returns the ending color of the flow between sankey elements.
        Returns:
        list of the ending color of the flow between sankey elements
      • setHoverColorFrom

        public void setHoverColorFrom​(IsColor... colors)
        Sets the starting color of the flow between sankey elements, when hovered.
        Parameters:
        colors - the starting color of the flow between sankey elements, when hovered
      • setHoverColorFrom

        public void setHoverColorFrom​(String... colors)
        Sets the starting color of the flow between sankey elements, when hovered.
        Parameters:
        colors - the starting color of the flow between sankey elements, when hovered
      • getHoverColorFromAsString

        public List<String> getHoverColorFromAsString()
        Returns the starting color of the flow between sankey elements, when hovered.
        Returns:
        list of the starting color of the flow between sankey elements, when hovered
      • getHoverColorFrom

        public List<IsColor> getHoverColorFrom()
        Returns the starting color of the flow between sankey elements, when hovered.
        Returns:
        list of the starting color of the flow between sankey elements, when hovered
      • setHoverColorTo

        public void setHoverColorTo​(IsColor... colors)
        Sets the ending color of the flow between sankey elements, when hovered.
        Parameters:
        colors - the ending color of the flow between sankey elements, when hovered
      • setHoverColorTo

        public void setHoverColorTo​(String... colors)
        Sets the ending color of the flow between sankey elements, when hovered.
        Parameters:
        colors - the ending color of the flow between sankey elements, when hovered
      • getHoverColorToAsString

        public List<String> getHoverColorToAsString()
        Returns the ending color of the flow between sankey elements, when hovered.
        Returns:
        list of the ending color of the flow between sankey elements, when hovered
      • getHoverColorTo

        public List<IsColor> getHoverColorTo()
        Returns the ending color of the flow between sankey elements, when hovered.
        Returns:
        list of the ending color of the flow between sankey elements, when hovered
      • setBorderColor

        public void setBorderColor​(IsColor borderColor)
        Sets the border color of the sankey elements.
        Parameters:
        borderColor - the border color of the sankey elements
      • setBorderColor

        public void setBorderColor​(String borderColor)
        Sets the border color of the sankey elements.
        Parameters:
        borderColor - the border color of the sankey elements
      • getBorderColorAsString

        public String getBorderColorAsString()
        Returns the border color of the sankey elements.
        Returns:
        the border color of the sankey elements
      • getBorderColor

        public IsColor getBorderColor()
        Returns the border color of the sankey elements.
        Returns:
        list of the border color of the sankey elements
      • setColor

        public void setColor​(IsColor color)
        Sets the font color of the sankey elements.
        Parameters:
        color - the font color of the sankey elements
      • setColor

        public void setColor​(String color)
        Sets the font color of the sankey elements.
        Parameters:
        color - the font color of the sankey elements
      • getColorAsString

        public String getColorAsString()
        Returns the font color of the sankey elements.
        Returns:
        the font color of the sankey elements
      • getColor

        public IsColor getColor()
        Returns the font color of the sankey elements.
        Returns:
        the font color of the sankey elements
      • setBorderWidth

        public void setBorderWidth​(int borderWidth)
        Sets the width of the border in pixels of sankey elements.
        Parameters:
        borderWidth - the width of the border in pixels of sankey elements
      • getBorderWidth

        public int getBorderWidth()
        Returns the width of the border in pixels of sankey elements.
        Returns:
        the width of the border in pixels of sankey elements
      • setNodeWidth

        public void setNodeWidth​(int nodeWidth)
        Sets the width of sankey elements.
        Parameters:
        nodeWidth - the width of sankey elements
      • getNodeWidth

        public int getNodeWidth()
        Returns the width of sankey elements.
        Returns:
        the width of sankey elements
      • setPadding

        public void setPadding​(double padding)
        Sets the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels.
        Parameters:
        padding - the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels
      • getPadding

        public double getPadding()
        Returns the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels.
        Returns:
        the padding between the top of the node and the first label to draw, when multiple lines for labels are set, in pixels.
      • getColorFromCallback

        public ColorCallback<DatasetContext> getColorFromCallback()
        Returns the color "from" callback, if set, otherwise null.
        Returns:
        the color "from" callback, if set, otherwise null.
      • setColorFrom

        public void setColorFrom​(ColorCallback<DatasetContext> colorCallback)
        Sets the color "from" callback.
        Parameters:
        colorCallback - the color "from" callback.
      • setColorFrom

        public void setColorFrom​(NativeCallback colorCallback)
        Sets the color "from" callback.
        Parameters:
        colorCallback - the color "from" callback.
      • getColorToCallback

        public ColorCallback<DatasetContext> getColorToCallback()
        Returns the color "to" callback, if set, otherwise null.
        Returns:
        the color "to" callback, if set, otherwise null.
      • setColorTo

        public void setColorTo​(ColorCallback<DatasetContext> colorCallback)
        Sets the color "to" callback.
        Parameters:
        colorCallback - the color "to" callback.
      • setColorTo

        public void setColorTo​(NativeCallback colorCallback)
        Sets the color "to" callback.
        Parameters:
        colorCallback - the color "to" callback.
      • getHoverColorFromCallback

        public ColorCallback<DatasetContext> getHoverColorFromCallback()
        Returns the color "from" callback when hovered, if set, otherwise null.
        Returns:
        the color "from" callback when hovered, if set, otherwise null.
      • setHoverColorFrom

        public void setHoverColorFrom​(ColorCallback<DatasetContext> colorCallback)
        Sets the color "from" callback when hovered.
        Parameters:
        colorCallback - the color "from" callback when hovered.
      • setHoverColorFrom

        public void setHoverColorFrom​(NativeCallback colorCallback)
        Sets the color "from" callback when hovered.
        Parameters:
        colorCallback - the color "from" callback when hovered.
      • getHoverColorToCallback

        public ColorCallback<DatasetContext> getHoverColorToCallback()
        Returns the color "to" callback when hovered, if set, otherwise null.
        Returns:
        the color "to" callback when hovered, if set, otherwise null.
      • setHoverColorTo

        public void setHoverColorTo​(ColorCallback<DatasetContext> colorCallback)
        Sets the color "to" callback when hovered.
        Parameters:
        colorCallback - the color "to" callback when hovered.
      • setHoverColorTo

        public void setHoverColorTo​(NativeCallback colorCallback)
        Sets the color "to" callback when hovered.
        Parameters:
        colorCallback - the color "to" callback when hovered.
      • getColorModeCallback

        public ColorModeCallback getColorModeCallback()
        Returns the color mode callback, if set, otherwise null.
        Returns:
        the color mode callback, if set, otherwise null.
      • setColorMode

        public void setColorMode​(ColorModeCallback colorModeCallback)
        Sets the color mode callback.
        Parameters:
        colorModeCallback - the color mode callback.
      • setColorMode

        public void setColorMode​(NativeCallback colorModeCallback)
        Sets the color mode callback.
        Parameters:
        colorModeCallback - the color mode callback.
      • getSizeCallback

        public SizeCallback getSizeCallback()
        Returns the size callback, if set, otherwise null.
        Returns:
        the size callback, if set, otherwise null.
      • setSize

        public void setSize​(SizeCallback sizeCallback)
        Sets the size callback.
        Parameters:
        sizeCallback - the size callback.
      • setSize

        public void setSize​(NativeCallback sizeCallback)
        Sets the size callback.
        Parameters:
        sizeCallback - the size callback.
      • getPaddingCallback

        public PaddingCallback getPaddingCallback()
        Returns the padding callback, if set, otherwise null.
        Returns:
        the padding callback, if set, otherwise null.
      • setPadding

        public void setPadding​(PaddingCallback paddingCallback)
        Sets the padding callback.
        Parameters:
        paddingCallback - the padding callback.
      • setPadding

        public void setPadding​(NativeCallback paddingCallback)
        Sets the padding callback.
        Parameters:
        paddingCallback - the padding callback.
      • getFontCallback

        public FontCallback<DatasetContext> getFontCallback()
        Returns the font callback, if set, otherwise null.
        Returns:
        the font callback, if set, otherwise null.
      • setFont

        public void setFont​(FontCallback<DatasetContext> fontCallback)
        Sets the font callback.
        Parameters:
        fontCallback - the font callback.
      • setFont

        public void setFont​(NativeCallback fontCallback)
        Sets the font callback.
        Parameters:
        fontCallback - the font callback.
      • setParsing

        public void setParsing​(boolean parsing)
        Sets how to parse the data set.
        This is ignored because it must alwasy set to true.
        Overrides:
        setParsing in class Dataset
        Parameters:
        parsing - how to parse the data set.
        This is ignored because it must alwasy set to true.
      • setClip

        public void setClip​(boolean clip)
        Sets how to clip relative to the chart area.
        If false allows overflow, otherwise true clips that many pixels inside the chart area.
        Overrides:
        setClip in class Dataset
        Parameters:
        clip - If false allows overflow, otherwise true clips that many pixels inside the chart area.
      • setClip

        public void setClip​(double clip)
        Sets how to clip relative to the chart area.
        This is ignored in order to disable clipping.
        Overrides:
        setClip in class Dataset
        Parameters:
        clip - how to clip relative to the chart area.
        This is ignored in order to disable clipping.
      • setClip

        public void setClip​(Clip clip)
        Sets how to clip relative to the chart area.
        This is ignored in order to disable clipping.
        Overrides:
        setClip in class Dataset
        Parameters:
        clip - how to clip relative to the chart area.
        This is ignored in order to disable clipping.
      • setData

        public void setData​(double... values)
        Throws an exception because not available.
        Overrides:
        setData in class Dataset
        Parameters:
        values - ignored because will throw an exception
      • setData

        public void setData​(List<Double> values)
        Throws an exception because not available.
        Overrides:
        setData in class Dataset
        Parameters:
        values - ignored because will throw an exception
      • getData

        public List<Double> getData​(boolean binding)
        Throws an exception because not available.
        Overrides:
        getData in class Dataset
        Parameters:
        binding - ignored because will throw an exception
        Returns:
        nothing because will throw an exception