Carousel Label layer (v4.x)

更新时间:
复制 MD 格式

Configure the style, data, and interaction settings of the Carousel Label layer to display rotating label information on geographic locations.

Chart style

The Carousel Label layer is a sub-widget of Basic Flat Map 4.0 that uses rotating icons to display label information at geographic locations. You can configure icon size, shape, and carousel effects independently.2025-01-23_9-52-01

Style panel{2F650D75-3071-42EA-96F7-36F41F665622}

  • Search Configuration: Click the image icon in the upper-right corner of the Style panel to search for configuration items by name. Fuzzy matching is supported. Search for a configuration item.

  • Quick Styles: Provides preset styles for the Carousel Label layer. Select a style that suits your scenario.

  • General: Configure general settings for the Carousel Label layer.

    Parameter

    Description

    Visibility Level

    The visibility level of the Carousel Label layer. The layer is visible only within the specified level range.

    Opacity

    The opacity of the Carousel Label layer, ranging from 0 to 100%. A larger value makes the layer more opaque.

  • Graphic: Configure the icon appearance for the Carousel Label layer.

    Parameter

    Description

    Icon Shape

    The icon shape in the label. Select a built-in icon from the drop-down list, enter an image URL to use a remote image, or click the 上传按键 icon to upload a local image.

    Icon Size

    The width and height of the icon, ranging from 0 to 200 px.

    Icon Offset

    The horizontal and vertical offset of the icon within the label, ranging from -200 to 200 px.

  • Animation: Configure the carousel effect for the Carousel Label layer.

    Parameter

    Description

    Carousel Order

    The carousel playback order: Random or Sequential.

    Carousel Count

    The number of labels displayed per carousel cycle, ranging from 0 to 50.

    Carousel Duration

    The duration of each carousel cycle, including Enter Duration (0 to 5 seconds), Dwell Duration (1 to 500 seconds), and Exit Duration (0 to 5 seconds).

    Carousel Cache

    The number of cached items during carousel playback, ranging from 0 to 100. Click the eye icon icon to the left of Carousel Cache to enable or disable caching.

  • Label: Configure the label style for the Carousel Label layer.

    Parameter

    Description

    Relative Offset

    The horizontal and vertical offset of the label, ranging from -200 to 200 px.

    Content Style

    The content style of the labels.

    • Row Style: Click the image or image icon to add or delete a style. Click the image or image icon to rearrange styles. Click the image icon to duplicate a style.

      • Row Field: The field name for the row content, which must match a field in the data panel.

      • Field Style: The font, size, color, and weight of the row field.

      • Field Prefix: The content, spacing, font, size, color, and weight of the prefix. Click the eye icon icon to the left of Field Prefix to show or hide the Field Prefix style.

      • Field Suffix: The content, spacing, font, size, color, and weight of the suffix. Click the eye icon icon to the left of Field Suffix to show or hide the Field Suffix style.

    • Max Width: The maximum width of a single line in the label, in px. Overflowing text is handled by the Text Overflow setting.

    • Text Overflow: How overflowing text is displayed: Truncate or Wrap.

      • Truncate: Hides text that exceeds the boundary, providing a compact overview in limited space.

      • Wrap: Moves text to the next line when it exceeds the boundary, ensuring full content is displayed.

    • Line Height Ratio: The line height ratio of the label, ranging from 1 to 5.

    • Content Outline: The outline color and thickness for the label content. Click the Eye icon icon to the left of Content Outline to show or hide the Content Outline settings.

    • Content Shadow: The shadow color, blur, and X/Y offset for the label content. Click the Eye icon icon to the left of Content Shadow to control the visibility of Content Shadow.

    Background Style

    Configure the label background style. Click the Eye icon icon to the left of Background Style to show or hide the Background Style options.

    • Background Type: The label background type: Vector or Image.

    • Background Color: The label background color. Available only when Background Type is set to Vector.

    • Border Style: The line type, width, and color of the label border. Available only when Background Type is set to Vector.

    • Border Radius: The corner radius of the label, in px. Available only when Background Type is set to Vector.

    • Image Template: The background image template. Available only when Background Type is set to Image.

    • Opacity: The background image opacity, ranging from 0 to 100. Available only when Background Type is set to Image.

    • Background Shadow: The shadow color, blur, and X/Y offset for the label background.

    • Content Margin: The margin between the content and the top, bottom, left, and right edges of the label.

Data Source panel{60074B95-5C44-4594-9B9A-EB110FAD263A}

Field

Description

lng

The longitude of the label.

lat

The latitude of the label.

Data Item Configuration

Description

Data Source

The component's data source displays the data fields contained within the component using code editing or visual editor. You can also modify the data type to flexibly configure the component's data.

Data Mapping

When you need to customize chart field configurations, you can set different field mappings in the Data Mapping module to map these fields to the corresponding fields of the component. This allows for real-time data matching without altering the data source fields. Additionally, click the image icon to configure field styles individually.

Filter

Open the Filter to select an existing data filter or create a new one, and configure the data filter script to achieve data filtering capabilities. For more information, see manage data filters.

Data Response Result

This feature displays the component's data in real-time. When the component's data source changes, the data response result will display the latest data accordingly. In case of a delayed system response, you can click the image icon on the right to check the current data response result, or click the image icon on the right to obtain the most recent data for the component. You can also click to view examples to see sample response results for the current component.

Disable Loading State

Check the check box to hide the loading content during component updates and data dashboard previews. Unchecking will display the loading content. The default setting is unchecked.

Controlled Mode

Check the check box to prevent data requests upon the component's initialization. Data requests will only be initiated through global variables or methods configured in the blueprint editor. Unchecking allows for automatic update requests. The default setting is unchecked.

Automatic Update Request

Check the check box to manually set the polling frequency for dynamic polling. Clearing this option disables automatic updates, requiring manual page refreshes or data request triggers through the blueprint editor and global variable events for updates.

Advanced panel

{AEBC9CE3-E1A3-4BF4-AE80-A10CB17248FD}

Configure interaction events or associate global variables for filter interactions between widgets. Configure widget interactions.

Blueprint Interaction

  1. Click the image icon in the upper-left corner of the page to go to the Blueprint page.

  2. On the Layer Node tab, add the current widget to the main canvas.

  3. View the Blueprint configuration parameters.image

    Note

    Click the image icon in the anchor point area on the right to view event and action parameter tooltips.

    • Events

      Event

      Description

      When Data Is Updated

      Triggered when the data response changes, returning the updated data.

      When Data Request Status Changes

      Triggered when the data request status changes. The callback parameter is the current status. For a data example, see the Data Response section on the Data Source tab in the widget's configuration panel in the canvas editor.

      Component Loaded

      Triggered after the data API request returns and the data is processed by the filter. The processed data is returned in JSON format. For a data example, see the Data Source tab's Data Response section in the widget's configuration panel in the canvas editor.

      When a Label Is Clicked

      Triggered when a label is clicked, returning the label data.

      When Label Carousel Appears

      Triggered when the label carousel appears, returning the label data.

    • Actions

      Action

      Description

      Import data

      Processes data in the required format and imports it to redraw the component without a new server request. For a data example, see the Data Response area on the Data Source tab in the component's configuration panel in the canvas editor.

      Request data

      Sends a new data request to the server. Data from upstream processing nodes or layer nodes is passed as parameters. For example, if a single-point column chart has its API data source set to https://api.test and the data passed to the Request data action is { id: '1'}, the final request URL is https://api.test?id=1.

      Refresh carousel

      Refreshes the carousel. No parameters are required.

      Toggle visibility

      The Toggle Visibility, Show, and Hide actions do not require parameters by default. You can add animation configurations as needed. See the data example.

      {
        // Animation type. Optional values: appear|fade|slideToUp. The default is fade. If left blank, there is no animation.
        "animationType": "fade",
        // Animation duration. The default is 1000 ms.
        "animationDuration": 1000,
        // Animation curve. Optional values: linear|easeInOutQuad|easeInOutExpo. The default is linear.
        "animationEasing": "linear"
      }

      Show

      Hide

      Update component configuration

      Dynamically updates the component's style configuration. In the Style panel, click Copy configuration to clipboard to get the configuration data. Then, in a data processing node in the Blueprint Editor, modify the field values as needed.