Text Box

Chart Style

The Text Box is a control widget that supports custom background color, text style, border style, and button key style across multiple states. Use it as an input form in visual applications to submit user input to the backend for processing.

Settings Panel

• 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 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 icon.
  • Click the icon to horizontally flip a widget.
  • Click the 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.

• Input Box Style

  • Placeholder: the default text displayed in the text box when no value is entered. You can also configure this parameter on the Data tab.

    Note

    • The placeholder obtained from the Data tab takes precedence.

    • The value of this parameter is displayed only after the value field on the Data tab is cleared.

  • Indent: the indent of texts in a text box.

  • Background Color: the background color of a text box. For more information about how to modify the background color, see the color picker description in Configure item description.

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

    Parameter	Description
    Color	The font color of texts in a text box.
    Font Style	The font style of texts in a text box: Normal, Italic, or Oblique. normal: displays text in the standard upright style. italic: displays text in italic style. oblique: simulates italic by slanting the text for fonts that lack a true italic variant.
    Font weight	The font weight of texts in a text box.
    Font	The font family of texts in a text box. Note Select a font that is already installed on your operating system. If no font is installed, the default font is displayed.
    Font size	The font size of texts in a text box.

  • Border Style

    Parameter	Description
    Border Width	The border width, in pixels.
    Border Color	The border color.
    Border Fillet	The border radius. Valid values: 0 to 360. A value of 0 produces square corners. A value of 360 produces fully rounded corners.
    Line Type	The border line type: Solid Line, Dashed Line, Dotted Line, Double Solid Line, Carved Effect, Embossed Effect, Sunken Effect, or Protrude Effect.

• Key Style: the style of the button on the right side of the text box.

  • Button Text: the text of the button.

  • Button Width: the button width.

    Important

    If the button width is too small, the text cannot be displayed completely.

  • Normal Style

    • Background Color: the background color of the button.

    • Border Style

      Parameter	Description
      Border Width	The width of the button border.
      Border Color	The color of the button border.
      Border Fillet	The border radius of the button. Valid values: 0 to 360. A value of 0 produces square corners. A value of 360 produces fully rounded corners.
      Line Type	The line type: Solid Line, Dashed Line, Dotted Line, Double Solid Line, Carved Effect, Embossed Effect, Sunken Effect, or Protrude Effect.

    • Text Style

      Parameter	Description
      Color	The font color of texts in the button.
      Font Style	The font style of texts in the button.
      Font weight	The font weight of texts in the button.
      Font	The font family of texts in a text box. Note Select a font that is already installed on your operating system. If no font is installed, the default font is displayed.
      Font size	The font size of texts in a text box.

  • Style on Click: the display style of the button when you click it. For more information, see Normal Style.

  • Style on Hover: the display style of the button when you hover the pointer over it. For more information, see Normal Style.

Data Panel

value: the content displayed in the text box. When configured, this value overrides Placeholder in Text Box Style. When empty, the placeholder text is displayed instead.

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

Interaction Panel

Widget interactions are enabled when you select the Enable check box next to On current value change and On button clicked. The text box widget supports interactions that let you change text box content, trigger data requests, and return callback values. These interactions can also be used with other widgets. By default, the value configured on the Data tab is returned. For more information, see Configure the callback ID of a ticker board widget.

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 icon in the upper-left corner of the page.

3. In Blueprint Editor, click the Text Box widget in the Added Nodes pane. You can view the parameters in the input box on the canvas, as shown in the following figure.

   • Event

     Event	Description
     When the data interface request is completed	Triggered after a data interface request is completed and the response is processed by a filter. Returns the processed JSON data. For specific data examples, see the Data Response Result section on the Data tab in the right-side configuration panel.
     When a data interface request fails	Triggered when a data interface request fails due to network issues or interface errors. Returns the processed JSON data after filtering. For specific data examples, see the Data Response Result section on the Data tab in the right-side configuration panel.
     When the current value changes	Triggered when the current value changes. Returns a data item that corresponds to the changed value.
     When the button is clicked	Triggered when the button is clicked. Returns a data item that corresponds to the clicked button.

   • Policy Action

     Policy Action	Description
     Request Data Interface	Re-requests server data, using data from an upstream processing node or layer node as parameters. For example, if the API data source is https://api.test and the data passed to request data interface is { id: '1'}, the final request URL becomes https://api.test?id=1.
     Import data	Imports pre-processed data in the widget's drawing format for redrawing, without re-requesting server data. For specific data examples, see the Data Response Result section on the Data tab in the right-side configuration panel.
     Obtain the value of the current input box	Retrieves the current value in the text box.
     Clear a component to its default value	Restores the widget to its default value.
     Update component configurations	Dynamically updates widget style configurations. Before using this action, click the widget in Canvas Editor, click the Settings tab in the right-side panel, and click Copy Configurations to... to obtain the widget configurations. Then modify the style field for the data processing node in Blueprint Editor.
     Display	Shows the widget. The following example shows the reference data. return { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" };
     Hide	Hides the widget. The following example shows the reference data. return { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" };
     Switch to the implicit state	Toggles the widget between shown and hidden states. The following example shows the reference data. return { "animationIn": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }, "animationOut": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" } };
     Move	Moves the 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" } };