decoration-bar

更新时间:
复制 MD 格式

Learn about the configuration items of the decoration bar widget.

Chart style

The decoration bar is a media widget that adds a customizable decorative element to a data dashboard or a dashboard module. image.png

Style Panel image.png

  • Search Configuration: Click the imageicon in the upper-right corner of the Style panel to search for a configuration item by name. Fuzzy match is supported. For more information, see Search configuration items.

    • Size: the width and height of the widget. Unit: pixels.

    • Positioning: the x-axis and y-axis coordinates of the widget, in pixels. X-coordinate is the pixel distance from the upper-left corner of the widget to the left border of the canvas. Y-coordinate is the pixel distance from the upper-left corner of the widget to the upper border of the canvas.

    • Rotate: rotates the widget around its center. Unit: degrees.

      • Enter the rotation angle directly in the spin box, or click the plus sign (+) or minus sign (-) to adjust the value.

      • Click the imageicon to flip the widget style.

      • Click the imageicon to flip the widget style.

    • Opacity: valid values: 0 to 1. A value of 0 hides the widget. A value of 1 fully displays the widget. Default value: 1.

  • Decorative Strip: Select the style of the decorative strip.

  • Fill Color: the fill color of the decorative strip.

Data Sources panel image.png

Field

Notes

img

The padding image of the decoration bar. This field can be empty. If empty, the image configured in the Style panel is used.

url

The hyperlink URL.

Configure data items

Notes

DataSource

Use the code editor or visual editor to view the data fields of the widget. You can also change the Data Type parameter to configure the data source.

Data Mapping

To customize field configurations, set field mappings in the Data Mapping module to map data fields to the corresponding widget fields. This allows you to match data without modifying the data source. You can also click the imageicon to configure the field style.

Configure a filter

Turn on Filter, select an existing data filter or create a data filter, and configure a data filter script to filter data. For more information, see Manage data filters.

Data Response Result

Displays widget data in real time. When the data source changes, this section shows the latest data. Click the imageicon to view the data response result, or click the imageicon to refresh the data. You can also click View Example to view a sample response.

Forbid Loading

If you select this check box, the widget does not display loaded content during initialization when you preview the dashboard. If you clear this check box, loaded content is displayed. This check box is cleared by default.

Controlled Mode

If you select this check box, the widget does not request data during initialization and only requests data through global variables or methods configured in Blueprint Editor. If you clear this check box, automatic data updates are enabled. This check box is cleared by default.

Auto Data Request

Select this check box and specify a polling interval to enable dynamic polling. If you clear this check box, the data is not automatically updated. You must manually refresh the page or use Blueprint Editor and global variable events to trigger a data update.

Advanced Panel

This widget does not support interaction events.

Blueprint Interaction

  1. Click the imageicon in the upper-left corner to go to the Blueprint page.

  2. On the Layer Nodes tab, add the widget to the main canvas.

  3. View blueprint configuration parameters. image.png

    • Event

      Event

      Notes

      When the data interface request is completed

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

    • Action

      Action

      Notes

      Import data

      Imports pre-processed data into the widget for redrawing without re-requesting data from the server. For specific data examples, see the Data Response Result section of the Data Source tab in the right-side configuration panel of the canvas editor.

      Request Data Interface

      Re-requests data from the server. Data sent by an upstream data processing node or layer node is used as a parameter. 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.

      Move

      Moves the widget to a specified location. See the following data example:

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

      Switch Display /Display

      Toggles whether the widget is displayed or hidden. No parameters are required.

      Display

      Displays the widget. See the following data example:

      {
        "animationType": "",// The animation method. Valid value: fade. If you do not set this parameter, no animation is available. 
        "animationDuration": 1000,// The animation delay. Unit: ms. 
        "animationEasing": ""// animation curve
      }

      Hide

      Hides the widget. See the following data example:

      {
        "animationType": "",// The animation method. Valid value: fade. If you do not set this parameter, no animation is available. 
        "animationDuration": 1000,// The animation delay. Unit: ms. 
        "animationEasing": ""// animation curve
      }

      Update component configurations

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