All Products
Search
Document Center

DataV:The Word Cloud widget

Last Updated:May 11, 2023

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

Chart Style

A word cloud is a type of text component that can display a large amount of text in a visualization application in the form of a word cloud. The word cloud allows you to customize the content, color, and drawing shape of the text. You can configure multiple series of colors and map the text size based on the weight value.

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 Style image..png

    Parameter

    Description

    Font

    The font family of all text in the widget. Default value: Microsoft Yahei.

    Font weight

    The font weight style selection for all text in the widget.

    Rotate

    The rotation style of the text in the widget. You can select Auto, Horizontal, or Vertical.

    Maximum Font Size

    The maximum font size of the text in the widget, which defines the maximum text size of the value value in the data.

    Minimum Font Size

    The minimum font size of the text in the widget, which defines the size of the text with the smallest value value in the data.

    Draw shapes

    After you click the 开关图标icon to open it, the entries are evenly displayed on the shape displayed in the image.

    Shape Image: Move the pointer over the dashed line box and click Delete to delete the default image. You can also drag an existing image to the dashed line box to add a local image. You can also copy the URL of the image to the dashed box to add the image on the remote server.

    Important

    We recommend that you use a white image.

  • Series: Click the 加号图标or 垃圾桶图标icon to add or remove a series. Click the 横排列图标or 竖排列图标icon to configure the arrangement style of multiple data series. click the 复制图标icon to copy the selected data series configurations and add a data series with the same configurations.

    Series Color: the color of the text in the series.

  • dialog box: the style of the dialog box that appears when you move the pointer over or click a word on the preview or publish page, and click 眼睛图标the icon to control the appearance and concealment of the dialog box.

    Auxiliary Line: If the switch is turned on, the auxiliary line will be displayed at the dialog box; if the switch is turned off, the auxiliary line will not be displayed. 提示框样式

Data Panel

image..png

Configuration field description

Parameter

Description

name

The text content of the word cloud component.

value

The weight value of the word cloud component can affect the font size in the layout.

type

The series to which the text of the Word Cloud component belongs, which matches the series in the configuration panel. The color of the text in different series is controlled.

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 the blueprint editor, click the Word Cloud component in the Added Nodes pane. On the canvas, you can configure the word cloud parameters, 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.

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