DTS二次开发文档

Class: HeatMap3D

HeatMap3D

HeatMap3D三维热力图相关的操作，三维热力图有以下几种构建方式：

1、根据16张空间图片构建 addByImages()
2、根据空间离散点和对应的热力值构建 addByHeatPoints()
3、根据三维体素的热力值构建 addByVoxels()
4、根据稀疏体素构建 addBySparseVoxels()

一般通过api.heatmap3d调用其方法。 HeatMap3D效果图如下：

<protected> new HeatMap3D()

See:

Extends

Methods

addByHeatPoints(data, fn)

根据空间离散点和对应热力值构建三维热力图

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • updateTime (number) 更新动画的插值时间，单位：秒，注意：参数仅更新方法update()执行时生效

  • displayMode (number) 显示模式，取值：[0,1,2,3] ，0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • indices (array) 离散热力点坐标的索引；数组元素类型：(number)；取值示例：[2, 0, 3, 0, 2, 1]，注意：仅在voxelShape=2四面体模式下生效

  • voxels (array) 离散热力点的坐标数组，包含热力点坐标、热力值影响半径(或盒子范围)、热力值和不透明度四个属性，结构示例：[{"coordinate": [0,0,0],"radius": 5,"heatValue": 0.5,"alpha": 1}]

    coordinate (array) 离散热力点的坐标位置，示例：[x,y,z]

    heatValue (array) 热力点对应的热力值，用于匹配colors参数的colorStops数组内颜色

    radius (number) 可选，二选一，热力点的半径，当voxelShape=0球体时生效

    extent (array) 可选，二选一，热力点的盒子范围，即长方体的长宽高：[xSize,ySize,zSize]，voxelShape=1盒子时生效

    alpha (number) 热力点不透明度

  • voxelAlphaMode (number) 三维体素块透明模式，取值：[0,1]，0 : 使用色带colors的透明度值（默认值） 1 : 使用点的热力值在heatValueRange范围内按[0~1]线性插值生成alpha，注意：仅离散点构建时生效

  • voxelShape (number) 三维体素块形状，取值：[0,1,2]，0 : Sphere球（注意体素设置为球时构建非常耗时） 1 : Box盒子（默认值） 2 : 四面体，注意：仅离散点构建时生效

  • voxelSize (number) 三维体素块尺寸，支持仅传入Voxels和VoxelSize参数，则自动计算Bounds和TextureSize

  • voxelGridSize (array) 三维体素块网格尺寸，默认使用纹理尺寸，取值示例： [1,1,256]

  • textureSize (number) 纹理尺寸，取值范围：[128~512]，默认：128

  • denoise (number) 降噪级别，取值范围：[0,1,2,3,4,5]，默认值：0 不做降噪；1~5 五级，注意：值越大添加越耗时

  • bbox (array) 三维热力图的包围盒范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]

  • boundsColor (array) 三维热力图的包围盒1px边框的颜色，默认不显示，取值示例如白色线框：[1,1,1,1]

  • volumeBoxLocation (array) 三维热力图坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxRotation (array) 三维热力图坐标旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxSize (array) 三维热力图盒子范围：[长,宽,高]，数组元素类型：[任意浮点数]， 单位：米

  • heatValueMode (number) 热力值模式，取值：[0,1,2,3,4,5,6] ，0 : Interp插值（默认值） 1 : Nearest最近 2 : Addition叠加 3 : Minimum最小 4 : Maximum最大 5 : Overwrite覆盖 6 : DoOnce独占

  • heatValueRange (array) 热力值的范围：[min,max]，数组元素类型：[任意浮点数]

  • blendMode (number) 三维热力图颜色混合模式，取值范围：[0,1]，0：X光效果 1：半透明效果

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addByImages(data, fn)

根据16张空间图片构建三维热力图

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • updateTime (number) 更新动画的插值时间，单位：秒，注意：参数仅更新方法update()执行时生效

  • imagesArray (array) 二选一，16张1024*1024的空间热力图图片的路径，空间位置从低到高，参考示例代码，注意：仅空间图片构建时生效

  • imageFiles (array) 二选一，构成空间热力图图片对象数组，每一个图片对象包含以下属性：

    size (array) 图片尺寸

    images (array) 图片对象数组，每一个对象包含一下属性：


    filePath (string) 图片文件路径

    minValue (number) 最小值

    maxValue (number) 最大值

  • volumeBoxLocation (array) 三维热力图坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxRotation (array) 三维热力图坐标旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • bbox (array) 三维热力图的包围盒范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]

  • boundsColor (array) 三维热力图的包围盒1px边框的颜色，默认不显示，取值示例如白色线框：[1,1,1,1]

  • volumeBoxSize (array) 三维热力图盒子范围：[长,宽,高]，数组元素类型：[任意浮点数]， 单位：米

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • displayMode (number) 显示模式，取值范围：[0,1,2,3] ，支持四类效果：0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • blendMode (number) 三维热力图颜色混合模式，取值范围：[0,1]，0：X光效果 1：半透明效果

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addBySparseVoxels(data, fn)

根据稀疏体素构建三维热力图

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • updateTime (number) 更新动画的插值时间，单位：秒，注意：参数仅更新方法update()执行时生效

  • sparseVoxels (object)) 稀疏类型体素构建三维热力对象

    voxels (array) 稀疏体素数组


    voxel (array) 稀疏体素纹理坐标索引，取值类型：[i,j,k]，i、j、k均需要小于体素尺寸size

    value (number) 纹理坐标对应的值

    data (string) 用户自定义数据


    size (array) 稀疏体素的纹理坐标[i,j,k]的最大值，取值示例：[256,256,256]，即i、j、k的最大值为256

  • displayMode (number) 显示模式，取值：[0,1,2,3] ，0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • bbox (array) 三维热力图的包围盒范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]

  • boundsColor (array) 三维热力图的包围盒1px边框的颜色，默认不显示，取值示例如白色线框：[1,1,1,1]

  • volumeBoxLocation (array) 三维热力图坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxRotation (array) 三维热力图坐标旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxSize (array) 三维热力图盒子范围：[长,宽,高]，数组元素类型：[任意浮点数]， 单位：米

  • voxelAlphaMode (number) 三维体素块透明模式，取值：[0,1]，0 : 使用色带colors的透明度值（默认值） 1 : 使用点的热力值在heatValueRange范围内按[0~1]线性插值生成alpha，注意：仅离散点构建时生效

  • voxelShape (number) 三维体素块形状，取值：[0,1,2]，0 : Sphere球（注意体素设置为球时构建非常耗时） 1 : Box盒子（默认值） 2 : 四面体，注意：仅离散点构建时生效

  • blendMode (number) 三维热力图颜色混合模式，取值范围：[0,1]，0：X光效果 1：半透明效果

  • heatValueMode (number) 热力值模式，取值：[0,1,2,3,4,5,6] ，0 : Interp插值（默认值） 1 : Nearest最近 2 : Addition叠加 3 : Minimum最小 4 : Maximum最大 5 : Overwrite覆盖 6 : DoOnce独占

  • heatValueRange (array) 热力值的范围：[min,max]，数组元素类型：[任意浮点数]

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addByTif(data, fn)

根据tif文件构建三维热力图

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • updateTime (number) 更新动画的插值时间，单位：秒，注意：参数仅更新方法update()执行时生效

  • tifFiles (object) 生成三维热力图的tif文件对象属性如下：

    files (array) 二进制文件路径数组，示例：["D:\\xxx1.tif","D:\\xxx2.tif","D:\\xxx3.tif"...]

    size (array) 可选，纹理分辨率，注意：纹理尺寸不能超过2048，最大值示例：[2048,2048]

    needProject (boolean) 是否需要重投影

    minHeight (number) 可选，最小高度

    maxHeight (number) 可选，最大高度

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • displayMode (number) 显示模式，取值：[0,1,2,3] ，0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • clipBox (array) 三维热力图盒子剖切的bbox范围，取值格式示例：[minX,minY,minZ,maxX,maxY,maxZ]，元素取值范围：[0~volumeBoxSize]

  • clipVoxel (boolean) 三维热力图执行盒子剖切时是否裁切体素(displayMode:1)，默认值：true

  • volumeBoxLocation (array) 三维热力图坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxRotation (array) 三维热力图坐标旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxSize (array) 三维热力图盒子范围：[长,宽,高]，数组元素类型：[任意浮点数]， 单位：米

  • voxelGridSize (array) 三维体素块网格尺寸，默认使用纹理尺寸，取值示例： [1,1,256]

  • voxelAlphaMode (number) 三维体素块透明模式，取值：[0,1]，0 : 使用色带colors的透明度值（默认值） 1 : 使用点的热力值在heatValueRange范围内按[0~1]线性插值生成alpha，注意：仅离散点构建时生效

  • voxelShape (number) 三维体素块形状，取值：[0,1,2]，0 : Sphere球（注意体素设置为球时构建非常耗时） 1 : Box盒子（默认值） 2 : 四面体，注意：仅离散点构建时生效

  • boundsColor (array) 三维热力图的包围盒1px边框的颜色，默认不显示，取值示例如白色线框：[1,1,1,1]

  • heatValueMode (number) 热力值模式，取值：[0,1,2,3,4,5,6] ，0 : Interp插值（默认值） 1 : Nearest最近 2 : Addition叠加 3 : Minimum最小 4 : Maximum最大 5 : Overwrite覆盖 6 : DoOnce独占

  • heatValueRange (array) 热力值的范围：[min,max]，数组元素类型：[任意浮点数]

  • textureSize (number) 纹理尺寸，取值范围：[128~512]，默认：128

  • blendMode (number) 三维热力图颜色混合模式，取值范围：[0,1]，0：X光效果 1：半透明效果

  • opacityMaskClip (number) 三维热力图clipbox剖切支持的透明度阈值，色带colors参数内配置的颜色透明度值如果大于此值则进行剖切

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值

  • billboards (object) 三维热力图对象始终朝向相机（广告牌效果），仅体素模式下displayMode=1生效，包含参数如下：

    scale (number) 可选，面向屏幕的缩放值

    size (array) 可选，XYZ方向分层的数量，默认值：[128,128,32]

    crop (boolean) 可选，是否对填充范围进行缩放后的溢出部分进行裁切，默认值：true

fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addByVoxels(data, fn)

根据纯热力值构建三维热力图

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • updateTime (number) 更新动画的插值时间，单位：秒，注意：参数仅更新方法update()执行时生效

  • displayMode (number) 显示模式，取值：[0,1,2,3] ，0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • bbox (array) 三维热力图的包围盒范围，格式：[minX,minY,minZ,maxX,maxY,maxZ]，数组元素类型：[任意浮点数]

  • boundsColor (array) 三维热力图的包围盒1px边框的颜色，默认不显示，取值示例如白色线框：[1,1,1,1]

  • volumeBoxLocation (array) 三维热力图坐标位置：[X,Y,Z]，取值示例，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxRotation (array) 三维热力图坐标旋转：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：[任意数值]

  • volumeBoxSize (array) 三维热力图盒子范围：[长,宽,高]，数组元素类型：[任意浮点数]， 单位：米

  • heatValueMode (number) 热力值模式，取值：[0,1,2,3,4,5,6] ，0 : Interp插值（默认值） 1 : Nearest最近 2 : Addition叠加 3 : Minimum最小 4 : Maximum最大 5 : Overwrite覆盖 6 : DoOnce独占

  • heatValueRange (array) 热力值的范围：[min,max]，数组元素类型：[任意浮点数]

  • blendMode (number) 三维热力图颜色混合模式，取值范围：[0,1]，0：X光效果 1：半透明效果

  • heatValues (object) 构建三维热力图的热力值对象，注意：此参数需要根据纯热力值构建

    size (array) 体素尺寸，取值示例：[x, y, z]，x*y*z就是包含的热力值数量，即values数组的长度等于x*y*z

    values (array) 体素的热力值，数组长度需要等于x*y*z。注意：如果某个体素的值不在heatValueRange范围内则属于无效体素不做渲染。

    alphas (array) 可选参数，透明度数组，不传则默认使用colors的透明度

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

addHeatPoints(data, fn)

动态往HeatMap3D对象内添加离散热力点，注意：仅支持空间离散点构造方法addByHeatPoints()

Parameters:
Name Type Description
data object | array

Voxel对象或对象数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • voxels (array) 离散热力点信息坐标数组，包含热力点坐标、热力值影响半径（或盒子范围）、热力值和不透明度等属性，结构示例：[{"coordinate": [0,0,0],"radius": 5,"heatValue": 0.5,"alpha": 1}]

    coordinate (array) 热力点的坐标位置，示例：[x,y,z]

    heatValue (array) 热力点对应的热力值

    radius (number) 可选，热力点的半径，当voxelShape=0球体时生效

    extent (array) 可选，热力点的盒子范围，即长方体的长宽高：[xSize,ySize,zSize]，voxelShape=1盒子时生效

    alpha (number) 热力点不透明度

fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
参数结构示例
[
            {
                "id": "heatmap3d_v1",
                "voxels": [
                    {
                        "coordinate": [
                            -1121,
                            89,
                            75
                        ],
                        "radius": 50,
                        //"extent": [2,2,2],
                        "heatValue": 0.0234818,
                        "alpha": 1
                    },
                    {
                        "coordinate": [
                            -1121,
                            89,
                            75
                        ],
                        "radius": 50,
                        //"extent": [2,2,2],
                        "heatValue": 0.0234818,
                        "alpha": 1
                    }
                ]
            },
            {
                "id": "heatmap3d_v2",
                "voxels": [
                    {
                        "coordinate": [
                            -1121,
                            89,
                            75
                        ],
                        "radius": 50,
                        //"extent": [2,2,2],
                        "heatValue": 0.0234818,
                        "alpha": 1
                    },
                    {
                        "coordinate": [
                            -1121,
                            89,
                            75
                        ],
                        "radius": 50,
                        //"extent": [2,2,2],
                        "heatValue": 0.0234818,
                        "alpha": 1
                    }
                ]
            }
        ]

clear(fn)

清空场景中所有的HeatMap3D

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

delete(ids, fn)

删除一个或多个HeatMap3D对象

Parameters:
Name Type Description
ids string | array

要删除的HeatMap3D对象的ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

HeatMap3D对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

get(ids, fn)

根据ID获取HeatMap3D的详细信息

Parameters:
Name Type Description
ids string | array

要获取的HeatMap3D对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
HeatMap3D的详细信息
[{
            "id":   "heatmap3d",
            "groupId":  "",
            "userData": "",
            "imagesArray":  [
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY0.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY1.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY2.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY3.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY4.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY5.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY6.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY7.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY8.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY9.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY10.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY11.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY12.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY13.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY14.png", 
                "D:\\Aircity_workspace\\dev\\SDK\\JS/media/heatmap3d/LAY15.png"
            ],
            "volumeBoxLocation":    [1057.934937, 2643.727539, 5.702500],
            "volumeBoxRotation":    [0.000000, 0.000000, 0.000000],
            "volumeBoxSize":    [100.000000, 100.000000, 100.000000],
            "displayMode":  0
        }]

hide(ids, fn)

隐藏HeatMap3D

Parameters:
Name Type Description
ids string | array

HeatMap3D对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

load(data, fn)

预加载的三维热力图动画，包含多个Tif文件，加载后可以使用play()方法播放三维热力图动画。

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，对于每个对象，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • tifAnimation (object) 生成三维热力图的tif文件对象属性如下：

    minHeight (number) 最小高度

    maxHeight (number) 最大高度

    totalSeconds (number) 动画播放默认的总时长，单位：秒

    time (number) 从第几秒开始播放，默认值：0

    files (array) tif文件路径二维数组，结构示例：[["D:\\Time0_1.tif","D:\\Time0_2.tif"],["D:\\Time1_1.tif","D:\\Time1_2.tif"]...] ，注意：tif文件纹理尺寸不能超过8192，最大值示例：[8192,8192]

  • brightness (number) 亮度，取值范围：[0~100] ，值等于0则完全透明，值越大越不透明

  • displayMode (number) 显示模式，取值：[0,1,2,3] ，0是体积雾效果, 1是体素效果 , 2是盒子效果，3是贴花效果，注意：0|1是跟全局剖切方法联动的，只有2不跟全局剖切联动需要自己传参clipBox

  • heatValueMode (number) 热力值模式，取值：[0,1,2,3,4,5,6] ，0 : Interp插值（默认值） 1 : Nearest最近 2 : Addition叠加 3 : Minimum最小 4 : Maximum最大 5 : Overwrite覆盖 6 : DoOnce独占

  • heatValueRange (array) 热力值的范围：[min,max]，数组元素类型：[任意浮点数]

  • voxelAlphaMode (number) 三维体素块透明模式，取值：[0,1]，0 : 使用色带colors的透明度值（默认值） 1 : 使用点的热力值在heatValueRange范围内按[0~1]线性插值生成alpha，注意：仅离散点构建时生效

  • voxelGridSize (array) 三维体素块网格尺寸，默认使用纹理尺寸，取值示例： [1,1,256]

  • textureSize (number) 纹理尺寸，取值范围：[128~512]，默认：128

  • blendMode (number) 各图层之间的混合模式，取值范围：[0,1]

  • colors (object) 三维热力图对象的自定义调色板对象，包含颜色渐变控制、无效像素颜色和调色板区间数组

    gradient (boolean) 是否渐变

    invalidColor (Color) 无效像素点的默认颜色，默认白色

    colorStops (array) 调色板对象数组，每一个对象包含热力值和对应颜色值，结构示例：[{"value":0, "color":[0,0,1,1]}]，每一个调色板对象支持以下属性：


    color (Color) 热力值对应的调色板颜色

    value (number) 热力值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

pause(id, fn)

暂停播放三维热力图动画

Parameters:
Name Type Description
id string

HeatMap3D对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

play(id, fn)

播放预加载的三维热力图动画

Parameters:
Name Type Description
id string

HeatMap3D对象的ID
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

queryVoxel(id, coordinate, fn)

根据ID和坐标位置获取对应HeatMap3D对象包含体素块的详细信息

Parameters:
Name Type Description
id string

HeatMap3D对象ID
coordinate array

坐标位置
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDisplayMode(id, displayMode, fn)

设置三维热力图的显示模式

Parameters:
Name Type Description
id any

HeatMap3D的ID
displayMode array

显示模式，取值范围：0是VolumeFog,1是InstanceMesh,2是Box
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setTime(id, startTime, fn)

从第几秒开始播放三维热力图动画

Parameters:
Name Type Description
id string

HeatMap3D对象的ID
startTime number

可选，从第几秒开始播放，默认值：0秒
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setViewportVisible(id, vp, fn)

设置HeatMap3D对象在进入多视口状态下视口可见性

Parameters:
Name Type Description
id string

HeatMap3D对象ID
vp Viewport

视口掩码（Viewport位运算）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

show(ids, fn)

显示HeatMap3D

Parameters:
Name Type Description
ids string | array

HeatMap3D对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

update(data, fn)

修改HeatMap3D

Parameters:
Name Type Description
data object | array

HeatMap3D对象或数组，参考add方法
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
fdapi.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     fdapi.xxx.setColor(i, Color.Yellow);
} 
fdapi.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides: