Package com.oorian.echarts.options

Class EChartsSankeySeries

java.lang.Object
com.oorian.echarts.options.EChartsSeries
com.oorian.echarts.options.EChartsSankeySeries
All Implemented Interfaces:
com.oorian.json.Jsonable
public class EChartsSankeySeries extends EChartsSeries
Represents a Sankey diagram series configuration for ECharts. Extends EChartsSeries to provide Sankey-specific options for displaying flow relationships.

Sankey diagrams are useful for displaying:

  • Energy flow diagrams
  • Budget allocation flows
  • User journey/funnel flows
  • Material flow analysis
Author:
Oorian

  • Constructor Details

    • EChartsSankeySeries

      public EChartsSankeySeries()
      Constructs a new EChartsSankeySeries with type set to "sankey".

  • Method Details

    • addNode

      public void addNode(String name)
      Adds a node to the Sankey diagram.
      Parameters:
      name - the name/identifier for the node

    • addNode

      public void addNode(String name, Number value)
      Adds a node with a specific value to the Sankey diagram.
      Parameters:
      name - the name/identifier for the node
      value - the value for the node

    • addLink

      public void addLink(String source, String target, Number value)
      Adds a link between two nodes in the Sankey diagram.
      Parameters:
      source - the source node name
      target - the target node name
      value - the flow value between nodes

    • setOrient

      public void setOrient(String orient)
      Sets the orientation of the Sankey diagram.
      Parameters:
      orient - the orientation ('horizontal' or 'vertical')

    • setNodeWidth

      public void setNodeWidth(Number nodeWidth)
      Sets the width of each node.
      Parameters:
      nodeWidth - the node width in pixels

    • setNodeGap

      public void setNodeGap(Number nodeGap)
      Sets the gap between nodes in the same column.
      Parameters:
      nodeGap - the gap in pixels

    • setNodeAlign

      public void setNodeAlign(String nodeAlign)
      Sets the alignment of nodes.
      Parameters:
      nodeAlign - the alignment ('justify', 'left', 'right')

    • setLayoutIterations

      public void setLayoutIterations(String layoutIterations)
      Sets the number of layout iterations.
      Parameters:
      layoutIterations - the number of iterations

    • setLeft

      public void setLeft(String left)
      Sets the left position of the diagram.
      Parameters:
      left - the left position

    • setRight

      public void setRight(String right)
      Sets the right position of the diagram.
      Parameters:
      right - the right position

    • setTop

      public void setTop(String top)
      Sets the top position of the diagram.
      Parameters:
      top - the top position

    • setBottom

      public void setBottom(String bottom)
      Sets the bottom position of the diagram.
      Parameters:
      bottom - the bottom position

    • setWidth

      public void setWidth(String width)
      Sets the width of the diagram.
      Parameters:
      width - the width

    • setHeight

      public void setHeight(String height)
      Sets the height of the diagram.
      Parameters:
      height - the height

    • setDraggable

      public void setDraggable(Boolean draggable)
      Sets whether nodes are draggable.
      Parameters:
      draggable - true to make nodes draggable

    • setItemStyle

      public void setItemStyle(EChartsItemStyle itemStyle)
      Sets the item style configuration for nodes.
      Parameters:
      itemStyle - the item style configuration

    • setLineStyle

      public void setLineStyle(EChartsLineStyle lineStyle)
      Sets the line style configuration for links.
      Parameters:
      lineStyle - the line style configuration

    • setLabel

      public void setLabel(EChartsLabel label)
      Sets the label configuration.
      Parameters:
      label - the label configuration

    • setEmphasis

      public void setEmphasis(EChartsEmphasis emphasis)
      Sets the emphasis configuration.
      Parameters:
      emphasis - the emphasis configuration

    • getNodes

      public List<EChartsSankeySeries.SankeyNode> getNodes()

    • getLinks

      public List<EChartsSankeySeries.SankeyLink> getLinks()

    • getOrient

      public String getOrient()

    • getNodeWidth

      public Number getNodeWidth()

    • getNodeGap

      public Number getNodeGap()

    • getNodeAlign

      public String getNodeAlign()

    • getLayoutIterations

      public String getLayoutIterations()

    • getLeft

      public String getLeft()

    • getRight

      public String getRight()

    • getTop

      public String getTop()

    • getBottom

      public String getBottom()

    • getWidth

      public String getWidth()

    • getHeight

      public String getHeight()

    • getDraggable

      public Boolean getDraggable()

    • getItemStyle

      public EChartsItemStyle getItemStyle()

    • getLineStyle

      public EChartsLineStyle getLineStyle()

    • getLabel

      public EChartsLabel getLabel()

    • getEmphasis

      public EChartsEmphasis getEmphasis()

    • initSpecificFromJson

      protected void initSpecificFromJson(com.oorian.json.JsonObject obj)
      Description copied from class: EChartsSeries
      Initializes series-specific properties from a JSON object.

      Subclasses must implement this method to handle their specific properties.

      Specified by:
      initSpecificFromJson in class EChartsSeries
      Parameters:
      obj - the JSON object containing series properties

    • addSpecificToJson

      protected void addSpecificToJson(com.oorian.json.JsonObject obj)
      Description copied from class: EChartsSeries
      Adds series-specific properties to a JSON object.

      Subclasses must implement this method to serialize their specific properties.

      Specified by:
      addSpecificToJson in class EChartsSeries
      Parameters:
      obj - the JSON object to add properties to