DataV:Echarts Sankey diagram

Chart Style

Configuration Panel

• Search for Configurations: In the right-side panel of Canvas Editor, click the Settings tab, and click Search for Configurations in the upper-right corner. Enter the required configuration item in the search box, and click the search icon to quickly locate the configuration item. Fuzzy match is supported. For more information, see Search for Configurations.
• Size: indicates the size of a widget, including its pixel width and height. You can click the icon to proportionally adjust the width and height of a widget. After you click this icon again, you can adjust the width and height as needed.
• Position: the position of a widget, which is indicated by pixel X and Y coordinates. X-coordinate indicates the pixel distance between the upper-left corner of the widget and the left border of the canvas. Y-coordinate indicates the pixel distance between the upper-left corner of the widget and the upper border of the canvas.
• Rotation Angle: the angle of a rotation that uses the center point of a widget as the rotation point. The unit is degrees (°). You can use one of the following methods to control the rotation angle of a widget:
  • Directly enter the degrees in the Rotation Angle spin box or click the plus sign (+) or minus sign (-) to increase or decrease the value in the Rotation Angle spin box.
  • Drag the black dot in the icon.
  • Click the icon to horizontally flip a widget.
  • Click the icon to vertically flip a widget.
• Opacity: the opacity of a widget. Valid values: 0 and 1. If this parameter is set to 0, the widget is hidden. If this parameter is set to 1, the widget is completely displayed. Default value: 1.

• Render Engine: the rendering engine of the Sankey graph. Including canvas and svg.

• Global Style

  • Custom Margin: the distance between the area of the Sankey diagram and the four boundaries of the widget. Unit: pixels. Default value: pixels.

  • Horizontal Position: Click the drop-down list and select an alignment method for the legend and text.

    • Auto: By default, Auto is determined based on the position and orientation of the widget.

    • Left Align: If the graphic is on the left side of the text, it is left-aligned.

    • Right Align: If the graphic is on the right side of the text, it is right-aligned.

  • Node Width: Click + or-, or enter a value to adjust the width of the node. Unit: pixels.

  • Node Interval: Click + or-, or enter a value to adjust the node interval. Unit: pixels.

  • Layout Iterations: Click the + or-sign or enter a number to adjust the number of layout iterations. This way, you can continue to iterate to optimize the distance between edges and nodes in the Sankey graph and reduce mutual masking.

  • Draggable: If you select this check box, the drag-and-drop feature is enabled. On the Preview or Publish page, you can click and drag the graphics.

  • Interactive Highlight: Select an interactive highlight mode from the drop-down list. You can set this operation to None, Highlight Upstream and Downstream Adjacent Edges, Highlight Upstream Adjacent Edges, and Highlight Downstream Adjacent Edges.

  • Label: Click the Eye icon to display the label style.

    • Location: Set the location of the label equivalent to the Sankey diagram, including but not limited to top, left, and inside.

    • Positioning Distance: the distance between the tag and the border line on the Sankey diagram.

    • Rotate: the angle by which the labels are rotated. If the category labels on the category axis cannot be displayed, you can rotate the labels to prevent them from overlapping. The angle of rotation ranges from -90 degrees to 90 degrees.

    • Color: Modify the color of the label text. For more information, see color picker description.

    • Font Style: the font style of the label text.

    • Font weight: the font weight of the label text.

    • Font: the font family of the label text.

    • Font Size: the font size of the label text.

  • Element Style

    • Border Color: Modify the border color of the element. For more information, see color picker description.

    • Border Size: Click + or-, or enter a value to adjust the border size of the element.

    • Transparency: Click the + or-sign or enter a value to modify the transparency of the intersection. Valid values: 0 to 1.

  • Line Style

    • Color

      • Color Method: the color method of the label line, including Same as source, Same as target, and Custom.

    • Transparency: Click the + or-sign or enter a value to modify the transparency of the line. The value ranges from 0 to 1.

    • Curvarity: Click the + or-sign or enter a value to modify the curvature of the line.

  • dialog box: Click the eye icon on the right to display the dialog box.

    • Background Color: dialog box the background color of the text label.

    • Text Style

      • Color: Modify the color of the dialog box label text. For more information, see color picker description.

      • Font Style: dialog box the font style of the text.

      • Font weight: dialog box the font weight of the label text.

      • Font: dialog box the font family of the label text.

      • Font Size: dialog box the font size of the label text.

• Palette: Click the or icon to add or remove a palette style. Click the or icon to configure the arrangement style of multiple palette styles. Click the icon to copy the selected palette style configuration and add a palette style with the same configuration.

• Animation: Select the check box to enable animation.

• Animation Duration: Click the + or-sign or enter a value to modify the duration of the initial animation. Unit: milliseconds.

• Easing Effect: Select the easing effect of the data update animation from the drop-down list. The default value is cubicOut.

Data tab

Configuration field description

Table 1. Parameters

Parameter	Description
Controlled Mode	If you turn on the switch, data is not requested when a widget is initialized. Data requests are triggered only based on callback IDs or the method configured in Blueprint Editor. If you turn off the switch, data requests are automatically triggered. By default, the switch is turned off.
Auto Data Request	After you select the Auto Data Request check box, you can enable dynamic polling, and manually specify the polling interval. If you do not select this check box, data is not automatically requested. You must manually refresh the page to request data or use Blueprint Editor or callback ID events to trigger data requests.
Data Source	In the right-side panel of Canvas Editor, click the Data tab. Click Set next to Static Data. In the Configure Datasource panel, select a data source from the Data Source Type drop-down list. Enter code for data query in the code editor, click Preview Data Response to preview the response of the data source, and then view the response. For more information, see Configure asset data.
Data Filter	If you select the Data Filter check box, you can convert the data structure, filter data, and perform simple calculations. If you click the plus sign (+) next to Add Filter, you can configure the script for the data filter in the editor that appears. For more information, see Use the data filter.
Data Response Result	The response to a data request. If the data source changes, you can click the icon next to Data Response Result to view the data response in real time.

Interaction tab

Interaction description

Configure interactions in Blueprint Editor

1. In Canvas Editor, right-click a widget and select Export to Blueprint Editor.

2. Click the icon in the upper-left corner.

3. In Blueprint Editor, click the Sankey Diagram component in the Import Nodes pane. The following figure shows the parameters on the canvas.

   • Event

     Event	Description
     When the data interface request is completed	The event is triggered with the processed JSON data after a data interface request is responded and processed by a filter. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.
     When a data interface request fails	The event that is returned when a data interface request fails (the request may be due to network problems or interface errors) and is processed by the filter. The event also throws the processed JSON data. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.
     When a data item is clicked	The event that is raised when a data item of the Sankey diagram is clicked, and the corresponding data item is also raised.
     When a node is clicked	The event that is raised when a node of the Sankey diagram is clicked, and the corresponding data item of the node is also raised.
     When you click Connect	The event that is raised when the line of the Sankey diagram is clicked, and the data item corresponding to the line is also raised.

   • Action

     Policy Action	Description
     Request Data Interface	This action is performed to request the server data again. The data sent by an upstream data processing node or layer node is used as a parameter. For example, if the Sankey diagram is configured with the API data source as https://api.test and the data passed to the request data interface as { id: '1'}, the final request interface is https://api.test?id=1.
     Import data	After data of a widget is processed in accordance with its drawing format, the widget is imported for redrawing. You do not need to request server data again. For more information about specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.
     Highlight	The input data of the action is of the object type. The parameters include seriesName (series name), seriesIndex (series index), dataIndex (data index), and name (data name). Sample data: { "seriesName": "", "seriesIndex": 1, "dataIndex": 1, "name": "" }
     Unhighlight	The input data of the action is of the object type. The parameters include seriesName (series name), seriesIndex (series index), dataIndex (data index), and name (data name). Sample data: { "seriesName": "", "seriesIndex": 1, "dataIndex": 1, "name": "" }
     Display dialog box	The input data of the action is of the object type. The parameters include dataindex (data index), name (data name), x (x-axis position), and y (y-axis position). Sample data: { "dataIndex": 1, "name": "", "x": 1, "y": 1 }
     Hide dialog box	Hide dialog box, no parameters required.
     Update component configurations	Style configurations of widgets are dynamically updated. In the Configuration panel, click Copy Configuration to Clipboard to obtain the configuration data of the component. After that, change the style field for the data processing node in Blueprint Editor.
     Display	The following example shows the widget. return{ "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }
     Hide	The following example shows how to hide a widget: return{ "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }
     Switch to the hidden state	The following example shows the widget. return { "animationIn": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }, "animationOut": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" } }
     Move	Move a widget to a specified location. The following example shows the reference data. return{ // The positioning type. to indicates absolute positioning, whereas by indicates relative positioning. The default value is to. "positionType": "to", // The location, which is indicated by the x and y coordinates. "attr": { "x": 0, "y": 0 }, // The animation type. "animation": { "enable": false, // The duration in which animation is displayed. "animationDuration": 1000, // The animation curve, which can be set to linear|easeInOutQuad|easeInOutExpo. "animationEasing": "linear" } }