All Products
Search
Document Center

DataV:Label Board

Last Updated:May 12, 2023

This topic describes the chart style of the Label Text widget and the meaning of each configuration items.

Chart Style

A text label is a type of text widget. You can customize the size, position, background color, and text style of a label. You can configure multiple types of label categories to display label information in a visual application in the form of text labels. 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 asset 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.
  • Global 文字标签的全局样式

    Parameter

    Description

    Adapt

    If you turn on the switch, the width of each table is automatically defined according to the length of the label content. If you turn off the switch, the content is arranged out of order. You need to customize the number of rows and the spacing between rows and columns, and arrange the rows in proportion to the width of the chart.

    Note

    The configuration items configuration items Rows, Columns, Label Column Spacing, and Label Row Spacing are displayed only when Auto Layout is turned off.

    Rows

    The number of lines of the text label.

    Number of Columns

    The number of columns for the text label.

    Label Column Spacing

    The horizontal spacing between each column between labels, in px.

    Label Row Spacing

    The vertical spacing between each line of labels. Unit: px.

    Text Style

    Font: the font family of the label text. The default value is Microsoft Black.

  • Default Label Configuration: the default label style, that is, the label style corresponding to the type field or the type field is inconsistent with the specified label category name. 文字标签默认配置

    Parameter

    Description

    Content Margin

    The inner margin between the content and the label block, which takes effect on all labels. Unit: px.

    Fillet Radius

    The radian of the four corners of the label block. This parameter takes effect on all labels. Unit: px.

    Background Color

    The background color of the default label block (no type value is defined in the data). Please refer to the color picker instructions to modify.

    Text Style

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

  • Custom Label Series: Click the 加号图标or 垃圾桶图标icon to add or delete a custom label series. Click the 横排列图标or 竖排列图标icon to configure the arrangement styles of multiple custom label series. Click the 复制图标icon to copy the configurations of the selected custom tag series and add a custom tag series with the same configurations. 自定义文字标签系列

    Parameter

    Description

    Label Category Name

    The name of the tag category, which must match the value of the type field in the data.

    Background Color

    The background color of the label block under this category.

    Text Style

    The style of the label text under this category. Includes text size, color, and font weight.

Data Panel

image..png

Configuration field description

Parameter

Description

content

Specify the specific text content in the text label block.

type

Optional. Set the label category name. If the type value matches the Custom Label Family > Label Category Name configuration items, the widget is rendered using the style defined in the family. If the tag does not match or is empty, the default tag configuration is used for rendering.

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

This widget does not support interaction events.

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 Label Board component in the Import Nodes pane. You can view the parameters of the Text Label component on the canvas, as shown in the following figure. 文字标签蓝图参数

    • 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.

    • Policy 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 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 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.

      Update component 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.

      Display

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

      Switch to the implicit state

      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

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