The heat layer is a data mapping layer in 3D City Builder that displays point data for geographic locations as a heat grid. You can independently configure its style and data using parameters such as grid count, transparency, heat radius, and color ramp. This topic describes the configuration items for the heat layer.
In the layer list on the left of the scene editor, click the Heatmap Layer to open the configuration panel and configure the style and data of the Heatmap Layer.
If the Heatmap Layer is not in the layer list, you must add the Heatmap Layer layer. For more information, see Add a sub-widget.
Style panel
-
Search Configuration: To quickly find a specific configuration item, click on the Configuration panel in the upper right corner and enter the item's name in the Search Configuration field. The system utilizes a fuzzy match to assist in locating items. For more information, see search configuration items.
The following sections describe the parameters on the heat layer configuration panel.
General
Parameter
Description
Depth Write
Specifies whether to write the depth value of the heat layer to the 3D space.
NoteIf depth write is turned on, the layer may block objects behind it.
Bottom Altitude
Set the bottom altitude. The value can range from -1000 to 10000.
Rotation
The rotation angle of the heat layer around the x-axis, y-axis, and z-axis.
Graphics
Parameter
Description
Heat Radius
The radius of the heat factor. The value can range from 0 to 1000.
Extrude Height
Specifies the extrusion height of the heatmap layer.
Heat Blur
The degree of the heat blur factor.
Grid Settings
Set the style of the heat layer grid.
Horizontal Grid Count : The number of grids in the horizontal direction of the heat layer.
Portrait Grid Count : The number of grids in the portrait direction of the heat layer.
Grid Pitch: The distance between grids in the heat layer.
Heat Color
The color for the highest mapped value in the heat layer.
High Value Color: The color for the highest mapped value in the heat layer. To change the color, see Color picker.
Low Value Color: The color for the lowest mapped value in the heat layer. To change the color, see Color picker.
Opacity
Set the opacity of the heat layer.
Initial Opacity: The minimum opacity value of the heat layer.
Overall Opacity: The overall opacity value of the heat layer.
Data panel
Field |
Description |
lng |
The longitude of the heat point. |
lat |
The latitude of the heat point. |
value |
The weight of the heat point. |
Configuration Item |
Description |
Controlled Mode |
Turn on the switch to prevent the widget from requesting data upon initialization. Data is requested only through a callback ID or a method configured in the blueprint editor. Turn off the switch to allow automatic data update requests. The switch is off by default. |
Automatic Update Request |
Select this option to enable dynamic polling and manually set the polling frequency. If you clear this option, data is not updated automatically. You must manually refresh the page or trigger data update requests using the blueprint editor or callback ID events. |
Data Source |
Click Configure Data Source. In the Set Data Source panel, you can modify the data source type and data query code, preview the data source return results, and view the data response. |
Data Result |
Displays the response result of a data request. When the data source changes, click the |
You can also use the layer data API as a block data API to configure more data source types in the data dashboard or to interact with data from common chart widgets. For more information, see One-click generation of block APIs.
If you created your 3D City Builder project in Spatial Data Project mode and the project contains data primitive layer content, you can use the Spatial Build Data Source to obtain spatial map data when you configure the data panel in the scene editor. The steps are as follows:
In the layer configuration panel, select the Data tab. Click the Data Source Type drop-down list at the bottom of the panel and select Spatial Build Data Source.
From the Data Project drop-down list at the bottom of the panel, select an existing data project from the spatial build platform.
After you select a data project, select a matching dataset from the Dataset drop-down list.
NoteIf no configurable data types are available for the Data Project and Dataset configuration items, click Go to Spatial Build Platform to Manage Data in the panel to configure data in the spatial build platform. For more information, see Overview of spatial data management.
Blueprint interaction
On the current scene editor page, click the
icon to the right of Heatmap Layer in the layer list on the left.Click the
icon in the upper-left corner of the page.On the Blueprint Editor configuration page, click Heat Layer in the Import Nodes bar. The configuration parameters for the heat layer in the Blueprint Editor appear on the canvas, as shown in the following figure.

Events
Event
Description
When Heat Layer Data API Request Is Completed
The event that is triggered after the data API request is returned and processed by the filter. The processed data is also returned in JSON format. For a data example, see the Data Response area on the Data tab in the widget configuration panel on the right of the canvas editor.
Actions
Action
Description
Request heatmap layer data
Requests data from the server again. Data from input data processing nodes or layer nodes is passed as a parameter. For example, if the API data source for the heatmap layer is set to
https://api.testand the data passed to the Request heatmap layer data action is{ id: '1'}, the final request URL ishttps://api.test?id=1.Import heatmap layer data
Processes data in the component's drawing format, then imports the data to redraw the component. No new request to the server-side is required. For a specific data example, see the Data Response area on the Data tab in the component configuration panel on the right side of the canvas editor.
Show component
Shows the component. No parameters are required.
Hide component
Hides the component. No parameters are required.
Set bottom elevation
Sets the bottom elevation.