Single Image

更新时间:
复制 MD 格式

Configure the Single Image media widget to display custom images with hyperlinks in your DataV visualization.

Chart style

Single Image is a media widget that displays custom images with configurable URLs and hyperlinks, adding background visuals to your DataV application.

Configuration 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 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.
  • Image Type: The image type. Valid values: Bitmap and Vector.

  • Background Image: Available when Image Type is Bitmap. Enter an image URL or click Change to upload a new image. Click Preview to enlarge. Use the interface. If images are set on both the Configuration and Data tabs, the Data tab takes precedence.

    Note

    Supports bitmap formats: PNG, JPG, GIF, and JPEG.

  • Vector Image: Available when Image Type is Vector. Enter an image URL or click Change to upload a new image. Click Preview to enlarge. Use the interface. If images are set on both the Configuration and Data tabs, the Data tab takes precedence.

    Note

    Supports only SVG format.

  • Fill Color: Available when Image Type is Vector. Sets the fill color of the image.

  • Image Repeat: The image repeat mode. Valid values: Stretch to Fill, Repeat Horizontally and Vertically, Repeat Horizontally, and Repeat Vertically.

  • Border Radius: The border radius, ranging from 0 (square) to 360 (circle).

  • Hyperlink Configuration: Clicking the image on the preview or published page opens the configured link.

    Parameter

    Description

    Hyperlink

    The redirect URL. Can also be set via the url field on the Data panel. If the Hyperlink is set on both the Configuration and Data panels, the Data panel takes precedence.

    Open in New Window

    When enabled, opens the hyperlink in a new browser tab. When disabled, opens in the current tab.

  • Hand Cursor: When enabled, the pointer changes to a hand cursor on mouseover in the preview or published page.

Data panel (Default mode)

Note

The data panel defaults to Default Mode. To switch, click Analysis Mode in the upper-right corner, then confirm to create an analyzer. The component converts to a BI analysis component.

Field configuration

Field

Description

img

(Optional) The display image. Overrides the Background Image or Vector Image setting. If empty, the Background Image or Vector Image setting applies.

url

(Optional) The click-through URL. Overrides the Hyperlink setting. If empty, the Hyperlink setting applies.

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.

Data panel (Analysis mode)

Important

Enabling BI analysis makes the following changes to the Single Image widget:

  • The Single Image Data Interface data source switches from static data to a DataV dataset.

  • The DataV dataset configuration is updated. Existing field configurations are not affected.

For more information about the data panel in BI analysis mode, see Introduction to the data panel in BI analysis mode.

Field configuration

Field

Description

Image Path

The display image. Overrides the Background Image or Vector Image setting. If empty, the Background Image or Vector Image setting applies.

Hyperlink Address

The click-through URL. Overrides the Hyperlink setting. If empty, the Hyperlink setting applies.

Note

To exit analysis mode, click Default Mode in the upper-right corner of the data panel. Confirm in the dialog box to delete the analyzer and switch back to default mode.

Interaction panel

Interaction event

Description

When the image is clicked

Select Enable to activate. Clicking the image triggers a data request and returns a callback value. By default, img and url values are returned. Configure a widget callback ID.

On mouseover

Select Enable to activate. On mouseover, a data request triggers and returns a callback value. By default, img and url values are returned. Configure a widget callback ID.

On mouseout

Select Enable to activate. On mouseout, a data request triggers and returns a callback value. By default, img and url values are returned. Configure a widget callback ID.

Blueprint Editor interaction configuration

  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. On the Blueprint Editor page, click Single Image in the Imported Nodes bar to display its configuration parameters.Single Image blueprint parameters

    • Events

      Event

      Description

      On Data API Request Completion

      Triggered when a data API request succeeds and the response is processed by a filter. Returns processed data in JSON format. For an example, check the Data Response Result section on the Data tab.

      When the data API request fails

      Triggered when a data API request fails due to network issues or API errors. Returns processed data in JSON format. For an example, check the Data Response Result section on the Data tab.

      When the image is clicked

      Triggered when the image is clicked. Returns the corresponding data item.

      On mouseover

      Triggered on mouseover. Returns the corresponding data item.

      On mouseout

      Triggered on mouseout. Returns the corresponding data item.

    • Actions

      Action

      Description

      Request Data API

      Re-requests server-side data using input from data processing or layer nodes as parameters. For example, if the API source is https://api.test and the data passed to the Request Data API action is { id: '1'}, the final URL becomes https://api.test?id=1.

      Import Data API

      Imports pre-formatted data and redraws the component without a server request. For an example, check the Data Response area on the Data tab in the canvas editor.

      Refresh

      Refreshes the animated image.

      Update Widget Configuration

      Dynamically updates widget styles. On the widget's Configuration panel, click Copy Configuration to Clipboard to get the configuration data, then modify field values in the data processing node on the Blueprint Editor page.

      Show

      Shows the widget. The following code provides a data sample.

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

      Hide

      Hides the widget. The following code provides a data sample.

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

      Toggle Visibility

      Toggles the visibility of the widget. The following code provides a data sample.

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

      Move

      Moves the widget to a specified position. The following code provides a data sample.

      return {
        // Movement type. Absolute positioning: to. Relative positioning: by. Default value: to.
        "positionType": "to",
        // The specified position. x-coordinate, y-coordinate.
        "attr": {
          "x": 0,
          "y": 0
        },
        // Animation method.
        "animation": {
          "enable": false,
          // Animation delay.
          "animationDuration": 1000,
          // Animation curve. Optional values: linear|easeInOutQuad|easeInOutExpo.
          "animationEasing": "linear"
        }
      };