Icon scatter layer (v2.x)

Updated at:

The icon scatter layer is a sub-component of the basic flat map that visualizes point-based geospatial data as icons on the map. This layer supports independent configuration for styles, data, and interactions, including icon settings, series settings, tooltip styles, and interactive behaviors. This topic describes the configuration options for the icon scatter layer.

See Map container (v2.x) to add and configure an icon scatter layer sub-component.

Configuration

image

  • 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.
  • Visible levels: Sets the zoom levels at which the icon scatter layer is visible.

  • Icon settings: Configures the image path, image size, relative position, and offset for the icons.

    Parameter

    Description

    Image path

    In the Image path area

    • To remove an image, hover over it and click Delete. To add a new scatter icon, click the image area or drag a local image file into it.

    • Hover over the image and click Change to upload a new local image.

    • You can also enter an image URL to use an image from a remote server as the scatter icon.

    Image size

    Sets the width and height of the icon.

    Relative position

    Sets the icon's position relative to the data point. Options include Bottom and Center.

    Offset

    Sets the horizontal and vertical offset of the icon.

  • Series settings: Click the 加号图标 or 垃圾桶图标 icon to add or remove a series. Click the 横排列图标 or 竖排列图标 icon to arrange the series. Click the 复制图标 icon to duplicate the selected series configuration.

    Type Filter Value: Corresponds to the type field in the data source. Use this value to configure the style of scatter points based on their type value.

    Configure the icon style for each series type. For more information, see the Icon Configuration parameter in Configuration.

  • Label: A text annotation for a data point. Click the 开关图标 icon to the left of Label to show or hide the label.

    Parameter

    Description

    Display field

    This setting is used with a data source from the data panel and must match a field name in the geographic data. For example, if set to name, the scatter plot labels on the visualization application display the values from the name field.

    Text style

    Sets the font family, weight, size, color, and shadow color for the label text. To modify the text color, see Color Picker Guide.

    Relative position

    The position of the label text relative to the data point. Options include Center, Top, Bottom, Left, and Right.

    Offset

    Sets the horizontal and vertical offset of the text label, in pixels (px).

  • Tooltip: Configures the style of the tooltip that appears when you click an icon during preview or after publishing. Click the 开关图标 icon on the left to show or hide the tooltip.

    Note

    To enable the pop-up feature, you must first set the info field.

    • info field: If enabled, the info field, which supports HTML tags, is used as the pop-up content. If disabled, the system falls back to using the content of the name and value fields.

    • Event type: Choose whether the tooltip is triggered by a Click or Mouse Enter event.

    • Configuration options: Choose between Parent container default and Custom configuration for the tooltip style.

      • Parent container default: The system's default style.

      • Custom configuration: Customize the tooltip's text style, line height ratio, border radius, and other parameters.

        Parameter

        Description

        Text style

        Sets the font family, weight, size, and color of the text inside the tooltip. To modify the color, see Color Picker Guide.

        Line height ratio

        Sets the line height ratio for the tooltip content.

        Border radius

        Sets the border radius of the tooltip. A larger value creates more rounded corners.

        Margin

        Sets the margin between the text and the four edges of the tooltip.

        Background color

        Sets the background color of the tooltip.

        Close button

        Sets the color and size of the close button, as well as its distance from the top and right edges.

  • Interaction settings

    Hover style: Sets the scaling factor of an icon relative to its original size when a user hovers over it. Click the 开关图标 icon to enable or disable the hover interaction.

Data

图标散点层数据面板v2.x

Table 1. Fields

Field

Description

type

(Optional) Used for multi-series configuration. Works with the series settings in the configuration panel to set the icon type for data points.

Note

Data points that are not configured with a series value or do not match any series value are rendered using the main icon settings.

name

(Optional) The label for the data point. Corresponds to the Display field under Label in the configuration panel to set the label style for a specific point.

lng

The longitude of the data point.

lat

The latitude of the data point.

value

(Optional) A value used for data mapping when data mapping is enabled in the configuration options. If this field is missing, the point is rendered based on the no-data configuration.

info

(Optional) The content for the tooltip that appears when a user clicks the data point.

iconUrl

(Optional) The URL path for a custom icon.

Table 2. Parameters

Parameter

Description

Controlled mode

If enabled, the component does not request data on initialization. Instead, data is fetched only when triggered by a callback ID or a method in the Blueprint Editor. When disabled, you can use the auto-update request feature. This option is disabled by default.

Auto update request

If selected, you can set a polling frequency for automatic updates. If not selected, data does not update automatically; you must refresh the page or trigger an update using the Blueprint Editor or a callback ID.

Data source

Click Configure Data Source to modify the data source type and data query code in the Set data source panel. You can also preview the data response. For more information, see Configure component data.

Data filter

Use a data filter to transform, filter, or perform simple calculations on your data. Click Add Filter to configure a data filter script in the Set data source panel. For more information, see Use filters.

Data response

Displays the response from the data request. When the data source changes, you can click the 刷新图标 icon on the right to view the latest data response in real time.

Interaction

图标散点层交互面板V2.X

Table 3. Interactions

Interaction

Description

When point is clicked

Select Enable to enable component interactions. The icon scatter layer sub-component has interaction settings. When you click a scatter point, a callback value is emitted. By default, it emits the lng and lat fields from the data. For more information, see Component Callback ID Configuration.

When mouse enters

Select Enable to turn on the interactive features of the component. The Icon scatter layer sub-component has interaction settings. When you move the pointer over a scatter point, a callback value is returned. By default, this value contains the lng and lat fields from the data. For specific configurations, see Component Callback ID Configuration.

Blueprint Editor interaction configuration

  1. On the Canvas Editor page, in the sub-component management list for the basic flat map, click the 导出到蓝图编辑器 icon to the right of the icon scatter layer.

  2. Click the 蓝图图标 icon in the upper-left corner of the page.

  3. In the Blueprint Editor, click the icon scatter layer component in the imported nodes panel. The configuration parameters for the icon scatter layer appear on the canvas, as shown in the following figure.图标散点层蓝图参数V2.x

    • Events

      Event

      Description

      When data request is successful

      Triggered after a successful data request, once the data has been processed by any data filters. The event data is the processed JSON-formatted data. For a data example, see the data response section on the Data tab of the component's configuration panel in the Canvas Editor.

      When data request fails

      Triggered when a data request fails, for example, due to a network issue or an API error. The event data contains the error information. For a data example, see the data response section on the Data tab of the component's configuration panel in the Canvas Editor.

      When point is clicked

      Triggered when a user clicks a point in the icon scatter layer. The event data includes the longitude and latitude of that point.

      When mouse enters

      Triggered when the mouse pointer enters a point in the icon scatter layer. The event data includes the longitude and latitude of that point.

    • Actions

      Action

      Description

      Request data API

      Re-requests server-side data, using the data output from an upstream data processing node or layer node as parameters. For example, if an icon scatter layer is configured with an API data source of http://api.test and the data passed to the Request Data API action is { id: '1'}, the final request URL is http://api.test?id=1.

      Import data

      Imports data directly into the component to redraw the layer, bypassing a new server request. The data must be in the component's expected format. For a data example, see the data response section on the Data tab of the component's configuration panel in the Canvas Editor.

      Show

      Shows the component. No parameters are required.

      Hide

      Hides the component. No parameters are required.