DocsICP FilingConsole
官方文档
首页

The Waterfall Chart widget

更新时间：
复制 MD 格式
产品详情
我的收藏

This topic describes the chart style and configuration panel of a waterfall chart.

Chart Style

A waterfall chart is a type of bar chart. It can intelligently display the difference between the total rise and fall of data in a small visualization application space. It supports custom x-axis and y-axis, multi-category data difference configuration, and waterfall data rise and fall display.

image..png

Settings Panelimage..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.

  • Chart image..png

    • Margins: Click the 开关图标icon to specify the custom margins. The distance between the chart area and the four boundaries of the widget. Default unit: px.

    • Value Label: the style of the value label of each column. You can click the 开关图标icon to display or hide the value label.

      Parameter

      Description

      Text Style

      The font style, text weight, font size, and color of the value label text.

      Offset

      The offset value of the value label in the horizontal and vertical directions.

  • Coordinate Axes: You can specify two axes: X Axis and Y Axis.

    • X Axis image..png

      • Show Axis: If you turn on the switch, the x-axis style in the widget is visible. If you turn off the switch, the x-axis style in the widget is invisible.

      • Axis Label: the style of the column chart x-axis label. You can click the 开关图标icon to display or hide the x-axis label.

        Parameter

        Description

        Text Style

        The font style, weight, font size, and color of the x-axis label text.

        Label Display

        The offset of the x-axis label in the x-axis and y-axis directions. The angle of the x-axis label. Valid values: Horizontal, Incline, and Vertical.

        Quantity

        The number value displayed by the x-axis label. You can click 开关图标the icon to specify the number of x-axis labels.

      • Axis Title: the style of the column chart x-axis title. You can click the 开关图标icon to display or hide the x-axis title.

        Parameter

        Description

        Title

        The text content of the x-axis title.

        Offset

        The offset value of the x-axis title. Unit: px.

        Text Style

        The font style, text weight, font size, and color of the x-axis title text.

      • Axis Line: the style of the column chart x-axis. You can click 开关图标the icon to display the x-axis.

        Color: the color of the x-axis.

      • Grid Lines: the style of the column chart x-axis gridlines. You can click the 开关图标icon to display or hide the x-axis gridlines.

        Color: the color of the x-axis grid lines.

    • Y Axis image..png

      • Show Axis: If you turn on the switch, the y-axis style in the widget is visible. If you turn off the switch, the y-axis style in the widget is invisible.

      • Data Format: the data format that you want to display. You can select Default, 11 (integer), 11.1 (float), 11.11 (float), 11%, 11.1%, or 11.11%. Displays data for integer reference d, floating point reference .1f.

      • Axis Label: the style of the column chart y-axis label. You can click the 开关图标icon to display or hide the y-axis label.

        Parameter

        Description

        Text Style

        The font style, text weight, font size, and color of the y-axis label text.

        Label Display

        The offset of the y-axis label in the x-axis and y-axis directions and the angle at which the labels are arranged. Valid values: Horizontal, Incline, and Vertical.

        Quantity

        The y-axis label displays the quantity value. You can click the 开关图标icon to display or hide a custom number of y-axis labels.

      • Axis Title: the style of the column chart y-axis title. You can click the 开关图标icon to display or hide the y-axis title.

        Parameter

        Description

        Title

        The text content of the y-axis title.

        Offset

        The offset value of the y-axis title. Unit: px.

        Text Style

        The font style, text weight, font size, and color of the title text on the y-axis.

      • Axis Line: the style of the y-axis of the column chart. You can click 开关图标the icon to display the y-axis.

        Color: the color of the y-axis.

      • Grid Lines: the style of the column chart y-axis gridlines. You can click the 开关图标icon to display or hide the y-axis gridlines.

        Color: the color of the grid lines on the y-axis.

  • Series image..png

    • Color: the color of the column that displays the rising, falling, or total timing of the category data.

      Parameter

      Description

      Color for Increase Series

      The color of the column where category data is positive to show an upward trend.

      Color for Decrease Series

      Category data is the color of the column that shows a downward trend for negative numbers.

      Color for Total Series

      The color of the column after the total of all category data.

    • Auxiliary Line: the auxiliary line style of the column chart, including the color, line thickness, and line style of the auxiliary line. Click the 开关图标icon to turn auxiliary lines on or off.

    • Differentical: the style of the difference text for each category in the column chart, including the font style, weight, font size, and color. Click the 开关图标icon to turn the difference text on or off.

    • Total: the name of the total data category. Click the 开关图标icon to turn totals on or off.

  • Other

    • Interaction Enhancement for Huge Amounts of Data: If the column chart contains too much data, you can set the data interaction enhancement style. You can click the 开关图标icon to enable or disable the interaction enhancement effect. image..png

      Parameter

      Description

      Interaction Mode

      The mode of data interaction. Valid values: Slider and Scroll Bar.

      Default Range

      The range of data displayed on the thumbnail axis. The range can be from 0 to 1. This option is available only when the Slider style is enabled.

      Style

      The thumbnail axis foreground and background colors. This option is available only when the Slider style is enabled.

      Direction

      The direction of the scroll bar. Valid values: Horizontal and Vertical. This option is available only when the Scroll Bar style is enabled.

      Width

      The width of the data category column. This option is available only when the Scroll Bar style is enabled.

    • dialog box: The style of the dialog box that appears when you move the pointer over or click the column chart on the preview or publish page. Click 开关图标the icon to turn the dialog box on or off. image..png

      Parameter

      Description

      Text Style

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

      Indicator

      The style of the prompt indicator, including the width, line type, and color of the indicator. Click on 开关图标the icon to turn the indicator on or off.

      Background Box

      The background box style of the dialog box.

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

      • Padding: the inner margin of the dialog box. Unit: pixels.

      • Border

        • Border Width: the border thickness of the dialog box. Unit: pixels.

        • Border Color: The border color of the dialog box.

Data Panel

image..png

Configuration field description

Parameter

Description

x

The category of each column in the column chart, that is, the value of the x-axis.

y

The value of each bar in the column chart, that is, the value of the y-axis.

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 Refresh icon icon next to Data Response Result to view the data response in real time.

Interaction Panelimage..png

On Click of Data Item: Select Enable to enable the widget interaction feature. When you click a column of the waterfall chart, a data request is triggered, a callback value is thrown, and data of different columns is dynamically loaded. By default, the x, y, and s values are returned. For more information, see Configure the callback ID of a ticker board.

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 the Waterfall Chart widget in the Import Nodes pane. You can view the parameters in the canvas, as shown in the following figure. 瀑布图蓝图参数

    • Event

      Event

      Description

      On Completion of Data Interface Request

      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.

      On Failure of Data Interface Request

      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.

      On Click of Data Item

      The event that is raised when a column of the waterfall chart is clicked, and the corresponding data item of the column is also raised.

    • Action

      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 a waterfall chart is configured with the API data source as https://api.test and the data passed to the Request Data Interface action as { id: '1'}, the final request interface is https://api.test?id=1.

      Import Data Interface

      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

      Highlight the element corresponding to the data item. Examples of reference data are as follows. 

      return {
  "data": {},
  "options": {
    "style": {
      "stroke": "#f00",
      "fill": ""
    },
    "selectMode": "single",
    "cancelHighlightFirst": false
  }
}

      Cancel Highlight

      Cancels the highlighting of the element corresponding to the data item. Examples of reference data are as follows. 

      return {
  "data": {},
  "options": {
    "mode": "single"
  }
}

      Clear Widget

      A widget text is cleared without the need to specify parameters.

      Update Widget Configurations

      Style configurations of widgets are dynamically updated. Before this action is executed, you must click the widget in Canvas Editor, click the Settings tab in the right-side panel, and click Copy Configurations to... to obtain widget configurations. After that, change the style field for the data processing node in Blueprint Editor.

      Show

      Displays the widget. The following example shows the reference data. 

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

      Hide

      The following example shows how to hide a widget. 

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

      Hide/Show

      Specifies whether to show or hide a widget. The following example shows the reference data. 

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

      Move

      A widget is moved to a specified location. Examples of reference data are as follows. 

          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"
      }
    }
Previous：Waterfall chart (v5.0 and later)Next：Line column chart