All Products
Search
Document Center

DataV:Switch

Last Updated:May 12, 2023

This topic describes the chart styles of the drop-down selector widget and the meanings of each configuration items.

Chart Style

A switch is a type of control component. It can be used to model a physical switch and allow users to turn on or off an item, and define the content to be displayed or hidden when the switch is turned on or off through interactive configuration.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

    Turn On by Default: If it is turned on, the switch is turned on by default. If it is turned off, the switch is turned off by default.

  • Background Style

    • Border Style

      Parameter

      Description

      Border Width

      The border width.

      Border Color

      The border color. For more information, see Configure item description.

      Border Fillet

      The border radius. The value range is 0–360. If the value is 0, the border is square. If the value is 360, the border is round.

      Line Type

      The border line type, which can be Solid Line, Dashed Line, Dotted Line, Double Solid Line, Carved Effect, Embossed Effect, Sunken Effect or Protrude Effect.

    • Background Color

      Parameter

      Description

      Open Color

      The background color when a switch is turned on.

      Close Color

      The background color when a switch is turned off.

  • Button Style 按钮样式配置图

    • Border Style

      Parameter

      Description

      Border Width

      The border width of a switch.

      Border Color

      The border color of a switch.

      Border Fillet

      The border radius of a switch. The value range is 0–360. If the value is 0, the switch border is square. If the value is 360, the switch border is round.

      Line Type

      The border line type of a switch, which can be Solid Line, Dashed Line, Dotted Line, Double Solid Line, Carved Effect, Embossed Effect, Sunken Effect, or Protrude Effect.

    • Background Color: the background color of a switch.

Data Panel

image..png

Configuration field description

Parameter

Description

onvalue

The data returned when a switch is turned on. The default value is 1.

offvalue

The data returned when a switch is turned off. The default value is 0.

state

The switch status, which must be set to 0 or 1. 0 indicates that a switch is turned off. 1 indicates that a switch is turned on.

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

Widget interactions are enabled when you select the Enable check box on the right of On state change. Switch widgets that have interaction configurations do not allow you to customize other callback variables. You can only turn on or off a switch to trigger a data request, return a callback value, and use the value for other widgets. By default, the value value configured in the data panel is returned. If you turn on the switch, the onvalue value is returned. If you turn off the switch, the offvalue value is returned. For more information, see Configure a callback ID.

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 Switch component in the Import Nodes pane. You can view the parameters in the canvas, as shown in the following figure. image..png

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

      When the state changes

      The event is triggered with a data item when the state changes. The data item corresponds to the changed state.

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

      Obtain the current switch status

      The current switch state is obtained.

      Set the current switch status

      The current switch state is set.

      Clear a component to its default value

      The default value is restored.

      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

      The display widget. For more information, see the following example.

      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. For more information, see the following example.

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

      Move

      Move a widget to a specified location. For more information, see the following data example.

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