This topic describes the chart styles of the video widget and the meaning of each configuration items.
Chart style
A video is a type of media component. You can customize the URL, playback properties, and appearance properties of a video. You can add a video player to a visual application to play videos in the mp4 format.
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 asset 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.
Video URL: the URL of the mp4 video, for example, xx.test.com/video.mp4. You can also configure the URL on the Data tab. The configuration on the Data tab takes effect in preference to the configuration on the Settings tab.
NoVideo Text: the reminder text to be displayed if no video is specified. The text appears on the top of the video widget.
Autoplay: specifies whether to automatically play the video on the preview or publish page.
ImportantIf the version of your Google Chrome is earlier than v66, you must turn on the switch and perform the following operation to enable autoplay. For more information, see Autoplay Policy Changes.
In the browser address bar, enter chrome://flags/#autoplay-policy and press Enter. Then, set Autoplay policy to No user gesture is required.
If you use Google Chrome v66 or later, the video is automatically played in mute mode by default.
Loop: specifies whether to play the video on a continuous loop on the preview or publish page.
Control Bar: specifies whether to display a control bar on the lower part of the preview or publish page.
Muted Play: specifies whether to play the video in mute mode.
Volume (%): the sound volume to play the video. You can drag the control bar to adjust the volume in the project. This parameter takes effect only when you turn off the Muted Play switch.
Data Panel
url
: the URL of the video. This parameter is optional. It functions the same as the Video URL parameter on the Settings tab. If you configure both parameters, this parameter takes effect in priority.
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
This widget does not support interaction events.
Configure interactions in Blueprint Editor
- In Canvas Editor, right-click a widget in the Layer panel and select Add to Blueprint Editor.
- Click the icon in the upper-left corner of the page.
In Blueprint Editor, click Video in the Added Nodes pane. On the canvas, you can configure the parameters for the video in Blueprint Editor, 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.
When playback starts
When the video starts to play, this event is triggered.
When playback ends
When the video playback stops, this event is triggered.
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 ishttps://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.
Start the playback
This action starts to play the video and does not need parameter input.
Pause the playback
This action pauses the video playback and does not need parameter input.
End playback
This action stops the video playback and does not need parameter input.
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" } };