The Flowchart widget

Updated at:

A flowchart displays process relationships as nodes and lines, with customizable styles and layout options.

Chart Style

A flowchart represents relationships between elements as nodes and lines. You can customize node and line styles to display complex process flows in visual applications.

image..png

Settings Panel image..png

  • 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 Proportional resizing 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 Rotation control icon icon.
    • Click the Horizontal flip icon to horizontally flip a widget.
    • Click the Vertical flip 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.
  • Node image..png

    • Node Size: the width and height of a flow node. Unit: px.

    • Node Spacing: the spacing between process nodes. Default value: px.

    • Click Auto Highlight: when enabled, clicking a node during preview or after publishing highlights all related nodes and dims unrelated ones. When disabled, all node styles remain unchanged.

    • Non-Highlight Style: the style of non-highlighted nodes during preview or after publishing. Available only when Auto Highlight is enabled.

      Parameter

      Description

      Title

      The background color and font color of the title in a non-highlighted node.

      Text

      The background color and font color of the text in a non-highlighted node.

      Link line color (non-highlighted)

      The color of non-highlighted connectors.

    • Title Style: the title style of a process node.

      Parameter

      Description

      Text

      The style of the title text, including the text font, text weight, font size, and color.

      Row Height

      The row height of the title. Unit: px.

      Alignment

      The alignment of the title. Valid values: Left, Center, and Right.

      Title Background

      Click the 加号图标or 垃圾桶图标icon to add or remove a title background. Click the 横排列图标or 竖排列图标icon to configure the arrangement style of multiple title backgrounds. Click the 复制图标icon to copy the selected title background configuration and add a title background with the same settings.

      • Status Name: the status name for the series title background. This value corresponds to the status field in the data panel.

      • Background Color: the background color of the title.

    • Text Style: the text style in the text box of a flow node.

      Parameter

      Description

      Text

      The style of the text in the text box, including the text font, text weight, font size, and color.

      Row Height

      The line height of the text in the text box. Unit: px.

      Background Color

      The background color of the text box.

      Type Text

      The style of the type text, including the font, weight, font size, and color.

      Note

      When the content is displayed in two columns, this module sets the left type text.

  • Connection line

    Parameter

    Description

    Connection Line Type

    The connector type. Valid values: Bezier Curve, Line, and Right Angle.

    Connection line color

    The color of the connection line in the flowchart.

Data Panel

image..png

Configuration field description

Parameter

Description

nodes

Node description. Contains the following fields:

  • id: the ID of the node.

  • title: the title of the node.

  • status: the status of the node. This value corresponds to the status name in the title background of the configuration panel.

  • content: the content of the node.

edges

Connection line description. Contains the following fields:

  • from: the start node of the connection line.

  • to: the target node of the connection line.

Table 1. Parameters
ParameterDescription
Controlled ModeIf 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 RequestAfter 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 SourceIn 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 FilterIf 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 ResultThe response to a data request. If the data source changes, you can click the Refresh icon icon next to Data Response Result to view the data response in real time.

Interaction Panel image..png

Interaction Event

Description

When a node is clicked

Select Enable to enable the widget interaction feature. When a node on the flowchart is clicked, a data request is triggered, a callback value is thrown, and different data is dynamically loaded. By default, the id, width, height, title, content, and status values in the data are returned. For more information, see How to configure the callback ID of a sign board widget.

When you double-click a node

Select Enable to enable the widget interaction feature. When you double-click a flowchart node, a data request is triggered, a callback value is thrown, and different data is dynamically loaded. By default, the id, width, height, title, content, and status values in the data are returned. For more information, see How to configure the callback ID of a sign board widget.

When a blank area is clicked

Select Enable to enable the widget interaction feature. When you double-click a flowchart node, a data request is triggered, a callback value is thrown, and different data is dynamically loaded. By default, the id and width values in the data are returned. For more information, see Configure the callback ID of a ticker board component.

Configure interactions in Blueprint Editor

  1. In Canvas Editor, right-click a widget in the Layer panel and select Add to Blueprint Editor.
  2. Click the Blueprint Editor icon icon in the upper-left corner of the page.
  3. In Blueprint Editor, click Flowchart in the Import Nodes pane. On the canvas, you can view the parameters that are described in the following figure. 流程图蓝图参数

    • Event

      Event

      Description

      When the interface description request is completed

      Triggered after a data interface request is responded to and processed by a filter. Returns the processed JSON data. For specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.

      When the interface description request fails

      Triggered when a data interface request fails, which may be caused by network issues or interface errors. Returns the processed JSON data after filter processing. For 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 node is clicked

      Returns the data of the clicked node.

      When you double-click a node

      Returns the data of the double-clicked node.

      When a blank area is clicked

      Returns the current node data when a blank area of the flowchart is clicked.

    • Action

      Policy Action

      Description

      Request API Description

      Requests server data again, using data from an upstream data processing node or layer node as parameters. For example, if the API data source is https://api.test and the data passed to the request data interface is { id: '1'}, the final request interface is https://api.test?id=1.

      Import Interface Description

      Imports data that has been processed in accordance with a widget's drawing format for redrawing, without requesting server data again. For specific data examples, see the Data Response Result section of the Data tab in the right-side configuration panel of the canvas editor.

      Update component configurations

      Dynamically updates widget style configurations. In the Configuration panel, click Copy Configuration to Clipboard to obtain the configuration data. Then modify the style field for the data processing node in Blueprint Editor.

      Display

      Shows the widget. Example:

      return{
        "animationType": "",
        "animationDuration": 1000,
        "animationEasing": "linear"
      }

      Hide

      Hides the widget. Example:

      return{
        "animationType": "",
        "animationDuration": 1000,
        "animationEasing": "linear"
      }

      Switch to the implicit state

      Toggles widget visibility. Example:

      return {
        "animationIn": {
          "animationType": "",
          "animationDuration": 1000,
          "animationEasing": "linear"
        },
        "animationOut": {
          "animationType": "",
          "animationDuration": 1000,
          "animationEasing": "linear"
        }
      }

      Move

      Moves a widget to a specified location. Example:

          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"
            }
          }