idt-content-streaming

v1.0.14

Published

9 months ago

```bash $ npm i idt-content-streaming ```

Downloads

0High
0Medium
0Low

yeeby

1.使用 npm 安装

$ npm i idt-content-streaming

2.CDN

<script src="http://idt.ccwork.com:53125/js/idt-content-streaming-1.0.0-min.js"></script>
<script src="http://idt.ccwork.com:53125/js/idt-webrtc-player-1.0.0-min.js"></script>

3.初始化在项目中引入下方代码建立像素流通信

const pixelStreaming = new IdtPixelStreaming({
  username: '',
  password: '',
  clientId: '',
  clientSecret: '',
  sceneId: '',
  wsUrl: '',
  urlPrefix: '', 
  authURL: '', 
});
// @ts-ignore
pixelStreaming.initPixelStream();
// @ts-ignore
await pixelStreaming.startPixelStream()

4.特效使用方法(简要介绍)

1.添加3D文字

方法：TextCustomCloudRenderAPI#Add3Dtext

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | ------- | ---- | --------------------------------- | ------------------------------------------------------------ | | id | string | 是 | | | | coord_type | int | 否 | | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord | string | 是 | | 坐标 lng,lat | | coord_z | int | 是 | | 高度(单位:米) | | coord_z_type | init | 否 | 0, 1, 2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效)；默认值为“0” | | pitch | string | 否 | [-90~90] | 俯仰角(-90~90)；默认值为“0” | | yaw | string | 否 | [0~360] | 偏航角(0正北, 0~360)；默认值为“0” | | text | string | 是 | | 文字内容 | | type | string | 否 | Verdana; Blackbody; RegularScript | 样式 | | color | string | 是 | | SRGB 颜色 | | size | int | 是 | | 字体大小(单位:米) | | thickness | int | 否 | | 厚度(单位:米)；默认值为“10” | | outline | int | 否 | [0~5] | 轮廓取值范围[0~5]；默认值为“0” | | space | number | 否 | | 间距(单位:米)；默认值为“0.2” | | flash | int | 否 | | 闪烁动效(单位:秒)；默认值为“5” | | bounce | int | 否 | | 反弹动效(单位:米/秒)；默认值为“1” | | portrait | boolean | 否 | true,false | 纵向；默认值为“false” | | face_to_camera | boolean | 否 | true,false | 文字是否跟踪朝向摄像机(注true生效、false失效) |

出参：

//成功
{
    "command": "event",
    "func_name": "OnAdd3DtextSuccess",
    "args": {
        "id": "3dtext_id",
        "cost_time": "0.0"
    }
}
//失败
{
    "command": "event",
    "func_name": "OnAdd3DtextFailed",
    "args": {
        "id": "3dtext_id"
    }
}

2.更新3D文字样式

方法：TextCustomCloudRenderAPI#update3DTextStyle

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | ------- | ---- | --------------------------------- | ------------------------------------------- | | id | string | 是 | | | | pitch | string | 否 | [-90~90] | 俯仰角(-90~90) | | yaw | string | 否 | [0~360] | 偏航角(0正北, 0~360) | | text | string | 是 | | 文字内容 | | type | string | 否 | Verdana; Blackbody; RegularScript | 样式 | | color | string | 否 | | 颜色(HEX颜色值) | | size | int | 否 | | 字体大小(单位:米) | | thickness | int | 否 | | 厚度(单位:米) | | outline | int | 否 | [0~5] | 轮廓取值范围[0~5] | | space | number | 是 | | 间距(单位:米) | | flash | int | 否 | | 闪烁动效(单位:秒) | | bounce | int | 否 | | 反弹动效(单位:米/秒) | | portrait | boolean | 否 | true,false | 纵向 | | face_to_camera | boolean | 否 | true,false | 文字是否跟踪朝向摄像机(true生效、false失效) |

出参：

//失败//成功
{
    "command": "event",
    "func_name": "OnUpdate3DtextStyleSuccess",
    "args": {
        "id": "3dtext_id",
        "cost_time": "0.0"
    }
}
//失败
{
    "command": "event",
    "func_name": "OnUpdate3DtextStyleFailed",
    "args": {
        "id": "3dtext_id"
    }
}

3.更新3D文字数据点

方法：TextCustomCloudRenderAPI#update3DTextCoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | ------ | ---- | -------- | ------------------------------------------------------------ | | id | string | 是 | | id | | coord_type | int | 是 | | 坐标类型(0:经纬度坐标, 1:cad坐标) | | coord | string | 是 | | 坐标 lng,lat | | coord_z | int | 是 | | 高度(单位:米) | | coord_z_type | init | 否 | 0, 1, 2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效) |

出参：

//成功
{
    "command": "event",
    "func_name": "OnUpdate3DtextCoordSuccess",
    "args": {
        "id": "3dtext_id",
        "cost_time": "0.0"
    }
}
//失败
{
    "command": "event",
    "func_name": "OnUpdate3DtextCoordFailed",
    "args": {
        "id": "3dtext_id"
    }
}

4.添加场景镜头

方法：CameraCustomCloudRenderAPI#AddCamera

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | ------------------ | -------- | -------- | ------ | ---------------------------------- | | camera_id | string | 是 | | 添加镜头的id id不能为0 | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | position_x | float | 是 | | 坐标点X(单位:m) | | position_y | float | 是 | | 坐标点Y(单位:m) | | position_z | float | 是 | | 坐标点Z(单位:m) | | pitch | float | 是 | | 镜头俯仰角(-90~90) | | pitch_limit | string | 是 | | 镜头俯仰角范围(-90~90) | | yaw | float | 是 | | 镜头偏航角(0正北, 0~359) | | yaw_limit | string | 是 | | 镜头偏航角范围(0正北, 0~359) | | arm_distance | float | 是 | | 镜头距坐标点距离(单位:m) | | arm_distance_limit | string | 是 | | 镜头距坐标点距离范围(单位:m) |

出参：

{
    "command":"Event",
    "module_name":"模块名", 
    "api_args":{
        "func_name":"方法名",
        "success":"添加是否成功状态",
        "args":{
            camera_id:"添加镜头的ID",
            }
        }
}

5.获取场景镜头信息

方法：CameraCustomCloudRenderAPI#GetCameraInfo

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | ---------- | -------- | -------- | ------ | -------------------------------------------------- | | camera_id | string | 是 | | 场景镜头id(由AddCamera添加); 为0时获取镜头当前信息 | | coord_type | int | 是 | | 坐标类型(0:经纬度坐标, 1:世界坐标) |

出参

{
    "command":"Event",
    "module_name":"模块名", 
    "api_args":{
        "func_name":"方法名",
        "success":"添加是否成功状态",
        "args":{
            成功时返回 -镜头的所有数据
            }
        }
}

6.切换场景镜头

方法：CameraCustomCloudRenderAPI#SetCameraActive

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | --------- | -------- | -------- | ---------- | -------------------------------------------------- | | camera_id | string | 否 | | 场景镜头id(由AddCamera添加); 为0时获取镜头当前信息 | | fly | boolean | 是 | true,false | true: 飞行动画; false: 立刻跳转过去(瞬移) |

出参:

{
    "command":"Event",
    "module_name":"模块名", 
    "api_args":{
        "func_name":"方法名",
        "success":"添加是否成功状态",
        "args":{
            //成功时返回前往相机的ID - 
            camera_id:""
            }
        }
}

7.设置场景镜头移动

方法：CameraCustomCloudRenderAPI#SetCameraStepMove

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | -------- | -------- | -------- | ------ | ----------------------------------------------------- | | state | string | 是 | | 视口移动方向(front: 前; back: 后; left: 左; right:右) | | step | int | 是 | | 步长设定单位cm |

出参:

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"error":"错误信息",
	"args":{
		成功时返回state类型 - state：""
		}
	}
}

8.设置镜头绕中心点旋转

方法：CameraCustomCloudRenderAPI#SetCameraRotate

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | --------- | -------- | -------- | ------------- | ----------------------------------- | | time | number | 是 | number | 相机旋转一周所需要的时间, (单位:秒) | | direction | string | 是 | clockwise | 顺时针 | | | | | anticlockwise | 逆时针 | | | | | stop | 停止旋转 |

出参：

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"args":{
		//成功时返回direction 类型 
		direction：""
		}
	}
}

9.场景镜头视界行为

方法：CameraCustomCloudRenderAPI#SetCameraInfo

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | ----------- | -------- | -------- | ---------- | ------------------------------------------------------------ | | fly | boolean | 否 | true/false | true: 飞行动画(有一个短暂飞行动画,并按照arm_distance,pitch,yaw设置镜头);false: 立刻跳转过去(瞬移)默认值为“true” | | camera_info | object | 是 | | 镜头信息对象 |

camera_info：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | -------- | -------- | ------------ | ---------------------------------- | | camera_id | string | 是 | 0 | 代表Player相机，只能为0 | | coord_type | int | 否 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | position_x | float | 是 | | 坐标点X(单位:m) | | position_x | float | 是 | | 坐标点Y(单位:m) | | position_x | float | 是 | | 坐标点Z(单位:m) | | arm_distance | int | 是 | 任意正整数 | 镜头距中心点距离(单位:m) | | pitch | number | 是 | [5,89] | 镜头俯仰角 | | yaw | number | 是 | [0,359] | 镜头偏航角，0为正北 |

出参：

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"error":"错误信息",
	"args":{
		Json回调类型对象待确认
		}
	}
}

10.重置场景镜头视界

方法：CameraCustomCloudRenderAPI#ResetCameraInfo

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | -------- | -------- | -------- | ------- | ----------------------------------------------------------- | | state | string | 是 | default | 场景初始状态 | | | | | last | 场景镜头返回至最后一次执行"SetCameraInfo"时刻的窗口视界状态 |

出参：

command:"Event",
module_name:"Camera",
api_args:{
	func_name:"ResetCameraInfo",
	args:{
		"state":"default"  
	}
}

11.锁定场景镜头视界

方法：CameraCustomCloudRenderAPI#LockCameraSpace

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------ | -------- | -------- | ------------ | ---------------------------------------------- | | pitch_limit | int | 是 | | 当前pitch(俯仰角)的正负10范围 | | yaw_limit | int | 是 | | 当前yaw(偏航角)的正负20范围 | | arm_distance_limit | int | 是 | | 鼠标滚轮时, 当前视距的正负100范围(单位:m) | | center_point_limit | int | 是 | | 鼠标拖动时, 当前场景中心点前后左右范围(单位:m) |

出参：

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"error":"错误信息",
	"args":{
		Json回调类型对象待确认
		}
	}
}

12.解除场景镜头视界限制(解除场景镜头锁定)

方法：CameraCustomCloudRenderAPI#ResetCameraSpace

入参：

| 参数 | 类型 | 必填 | 值 | 备注 | | -------- | -------- | -------- | ------- | ---------------- | | state | string | 是 | default | 场景初始状态 | | | | | free | 开放场景边界限制 |

出参：

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"error":"错误信息",
	"args":{
		Json回调类型对象待确认
		}
	}
}

13.重置场景初始镜头

方法：CameraCustomCloudRenderAPI#ResetCamera

入参：

出参：

{
"command":"Event",
"module_name":"模块名", 
"api_args":{
	"func_name":"方法名",
	"success":"添加是否成功状态",
	"error":"错误信息",
	"args":{
		Json回调类型对象待确认
		}
	}
}

14.添加POI点

方法：POICustomCloudRenderAPI#AddPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | -------- | -------- | --------------------- | ------------------------------------------------------------ | | coord_type | int | 是 | 0, 1 | 位置的坐标类型(0:经纬度坐标, 1:世界坐标) | | line_type | string | 是 | | 此POI所使用的UI模板类型(default: 带线的默认POI UI样式, default_noline:不带线的POI UI样式, 项目中约定) | | animation_type | string | 是 | bounce, stretch, wipe | 动画类型(bounce:弹出式; stretch:伸缩式; wipe:展开式)； | | duration_time | float | 是 | | 规定完成动画所花费的时间(单位:秒)； | | poi_type | string | 是 | | POI类型支持3类 standard standard2 NMGStandard | | poi_style | object | 是 | | 自定义颜色对象信息 | | subs | Array | 是 | | 坐标信息(批量添加POI) |

poi_style ：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------- | -------- | -------- | ------------ | -------------------------------------------------- | | enable_custom_color | bool | 是 | | 开启自定义颜色，如果为false那么已默认POI点颜色为准 | | linear_color | string | 是 | | 自定义颜色参数 |

subs:

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | --------------------------------- | | id | string | 是 | | POI ID | | position_x | flont | 是 | | 世界坐标X(单位:m) 或者经度坐标lng | | position_y | flont | 是 | | 世界坐标Y(单位:m) 或者纬度坐标lat | | position_z | flont | 是 | | 世界坐标Z(单位:m) | | label | string | 是 | | POI label显示文本内容 |

module_name:"POI"
let jsondata = {
	"coord_type":0,                          
	"line_type":"default",                  
	"animation_type":"bounce",               
	"duration_time":0.7,                    
	"poi_type":"standard2",                  
	"poi_style":{                             
		enable_custom_color:true,	 
		linear_color:"79FF6A00"          
	},
	"subs":[                                 
		{
			"id":"12",                       
			"position_x": 0,                 
			"position_y": 0,                
			"position_z": 0,                
			"label":"POIName",               
		}
	 ]
}

出参：

{
"command": "event",
"func_name": "OnAddPOISuccess/OnAddPOIFailed",
"args": {
"id": "poi_id_8",
"cost_time": "0.0"
    }
}

15.更新POI数据点

方法：POICustomCloudRenderAPI#UpdatePOICoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | --------- | -------- | -------- | ------------ | --------------- | | poi_type | string | 是 | | POI类型 | | poi_coord | Object | 是 | | 修改poi坐标对象 |

poi_coord:

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | ------------------------------------ | | id | string | 是 | | POI id | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | position_x | float | 是 | | POI点的坐标 lng, 或世界坐标x(单位:m) | | position_y | float | 是 | | POI点的坐标 lat 或世界坐标y(单位:m) | | position_z | float | 是 | | POI点高度值 (单位:m) |

出参：

{
"command": "event",
"func_name": "OnUpdatePOICoordSuccess/OnUpdatePOICoordFailed",
"args": {
"id": "poi_id_4",
"cost_time": "0.0"
    }
}

16.更新POI点样式

方法：POICustomCloudRenderAPI#UpdatePOIStyle

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------- | -------- | -------- | ------------ | --------------- | | poi_type | stirng | 是 | | POI类型 | | poi_styleArgs | object | 是 | | 修改poi样式对象 |

poi_styleArgs:

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | -------- | -------- | ---------------------- | ------------------------------------------------------------ | | id | string | 是 | | | | label | string | 是 | | POI title文本 | | line_type | string | 是 | default/default_noline | 此POI所使用的UI模板类型(default: 带线的默认POI UI样式, default_noline:不带线的POI UI样式, 项目中约定) | | animation_type | string | 否 | bounce, stretch, wipe | 动画类型(bounce:弹出式; stretch:伸缩式; wipe:展开式) | | duration_time | number | 否 | | 规定完成动画所花费的时间(单位:秒) |

出参：

{
"command": "event",
"func_name": "OnUpdatePOIStyleSuccess/OnUpdatePOIStyleFailed",
"args": {
"id": "poi_id_4",
"cost_time": "0.0"
    }
}

17.设置POI点状态 - 同时会触发POI的点击事件

方法：POICustomCloudRenderAPI#SetPOISelect

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | --------------- | | id | string | 是 | | | | select | boolean | 是 | | POI点是否被选中 | | poi_type | string | 是 | | POI类型 |

出参：

{
"command": "event",
"func_name": "SetPOISelectSuccess/SetPOISelectFailed",
"args": {
"id": "poi_id_4",
"cost_time": "0.0"
    }
}

18.隐藏POI

方法：POICustomCloudRenderAPI#HidePOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | POI的ID | | poi_type | string | 是 | | POI类型 |

出参：

{
"command": "event",
"func_name": "HidePOISuccess/HidePOIFailed",
"args": {
"id": "poi_id_4"
    }
}

19.显示POI

方法：POICustomCloudRenderAPI#ShowPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | POI的ID | | poi_type | string | 是 | | POI类型 |

出参：

{
"command": "event",
"func_name": "ShowPOISuccess/ShowPOIFailed",
"args": {
"id": "poi_id_4"
    }
}

20.聚焦POI

方法：POICustomCloudRenderAPI#POIFocus

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------------------------ | -------------------------------------------------------- | | id | string | 是 | | POI的ID | | distance | float | 是 | | 臂长 | | fly | bool | 是 | | true为启用聚焦速率， false直接聚焦到目标 focus_rate失效 | | pitch | float | 是 | -85,85 | 调整聚焦时的pitch （上下旋转） | | yaw | float | 是 | | 调整聚焦时的yaw （左右旋转） | | focus_rate | float | 是 | （0.2，5） | 聚焦速率 | | poi_type | string | 是 | standard，standard2 nmg_style1 | POI类型 |

出参：


{
    "command":"event",
    "func_name":"POIFocus",
    "args":{}
}

21.删除POI

方法：POICustomCloudRenderAPI#DeletePOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | POI的ID | | poi_type | string | 是 | | POI类型 |

出参：

{
"command": "event",
"func_name": "DeletePOISuccess/DeletePOIFailed",
"args": {
"id": "poi_id_4"
    }
}

22.修改POI颜色

方法：POICustomCloudRenderAPI#UpdatePOIStyleColor

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | ----------------- | | id | string | 是 | | POI的ID | | poi_type | string | 是 | | POI类型 | | color | object | 是 | | poi自定义颜色对象 |

color：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------- | -------- | -------- | ------------ | -------------------------------------------------- | | enable_custom_color | boolean | 是 | | 开启自定义颜色，如果为false那么已默认POI点颜色为准 | | linear_color | string | 是 | | 自定义颜色十六进制sRGB |

出参:

{
"command": "event",
"func_name": "UpdatePOIStyleColorSuccess/UpdatePOIStyleColorFailed",
"args": {
"id": "poi_id_4"
    }
}

22.添加自定义POI点

方法： CustomPOICustomCloudRenderAPI#AddCustomPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | -------- | -------- | --------------------- | ------------------------------------------------------------ | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | animation_type | string | 是 | bounce, stretch, wipe | 动画类型(bounce:弹出式; stretch:伸缩式; wipe:展开式)；默认值为true (wipe 暂时无用) | | duration_time | number | 是 | 0.2 - 5 | 规定完成动画所花费的时间(单位:秒)；| | subs | Array | | |批量添加自定义POI - 暂时不支持|

subs：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | ---------------------------------- | | id | string | 是 | | POI ID | | position_x | flont | 是 | | 三维x坐标(单位：m) 或者经度坐标lng | | position_y | flont | 是 | | 三维y坐标 (单位：m)或者纬度坐标lat | | position_z | flont | 是 | | 三维z坐标(单位：m) 或者海拔高度 | | marker | object | | | 自定义POI Marker图片 |

marker：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | -------- | -------- | ------------ | ----------------------------------------------- | | size | string | 是 | | marker大小(宽,高单位:像素) | | define_state | string | 否 | | marker图片组展示无用 | | normal_url | string | 是 | | normal 图片url地址 Marker默认状态图片 | | activate_url | string | 是 | | activate_url 图片url地址 Marker点击时展示的图片 | | label | Objent | | | 自定义POI 文本内容 | | spline | Object | | | Marker下方线条 | | window | Object | | | |

window：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | ------------------------------------------------------------ | | url | string | 是 | | window HTML地址 | | size | string | 是 | | window大小(宽,高单位:像素) | | offset | string | 是 | | //window左上角相对于marker的中心点(coord坐标中心点)的偏移(x,y 单位:像素), 注: x为正向右, y为正向上 |

label：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | -------- | -------- | ------------ | -------------------------- | | bg_image_url | string | 是 | | label 背景图片地址 | | bg_size | string | 是 | | label 背景大小 | | bg_offset | string | 是 | | 基于Marker点进行偏移 | | content | Array | | | label文本内容（label子集） |

spline：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | --------------------------- | | url: | string | 是 | | spline 图片url地址 | | size: | string | 是 | | spline大小(宽,高单位:像素) |

content：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------- | --------- | -------- | -------------------------------- | ------------------------------------------------------------ | | text_offset | string | 是 | | 文本框左上角相对于label中bg_offset左上角的margin偏移(x,y 单位:像素), 注: x为正向右, y为正向下 | | text_boxwidth | string | 是 | | 文本框宽度(类型:Integer; 注: 文本滚动速度"scroll_speed": 0 时显示全文本, 此时文本不受文本框宽度限制) | | text | string [] | 是 | ["文本内容A", "ff0000ff", "30"], | [文本内容, HEXA颜色, 文本大小] | | text_centered | bool | 是 | (true:居中; false:不居中) | 文本居中 | | scroll_speed | int | 否 | | 文本滚动速度(0:不滚动; 类型:number) ----------------------改字段未用上 |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

23.更新POI数据点

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOICoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | ------------------------------------ | | id | string | 是 | | 添加自定义POI时的 id | | coord_type | int | 是 | | 坐标类型(0:经纬度坐标, 1:UE世界坐标) | | position_x | float | 是 | | 三维x坐标(单位：m) 或者经度坐标lng | | position_y | float | 是 | | 三维y坐标 (单位：m)或者纬度坐标lat | | position_z | float | 是 | | 三维z坐标(单位：m) 或者海拔高度 |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

24.更新自定义POI点的样式

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOIStyle

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ----------------- | -------- | -------- | ------------ | ------------------------------------------------------------ | | id | string | 是 | | 添加自定义POI时的 id | | always_show_label | boolean | 是 | | 暂未用上字段 - 是否永远显示title, true:显示title(默认), false:不显示title | | show_label_range | string | 是 | | 暂未用上字段 POI点显示label的范围(单位:米, 范围最小、最大距离; 在此范围内显示, 超出范围隐藏; 注意:always_show_label属性优先于此属性) | | sort_order | boolean | 是 | | 暂未用上字段 - 是否开启遮挡排序(根据POI点真实3D位置开启遮挡排序, 注1: 只与其他开启排序的POI之间进行排序; 注2: 开启此排序会消耗性能(最多60个POI点同时开启排序)) | | state | string | 是 | | 暂未用上字段 - -与marker之中images中的define_state对应 | | animation_type | string | 是 | | 动画类型(bounce:弹出式; stretch:伸缩式; wipe:展开式) | | duration_time | number | 是 | | 规定完成动画所花费的时间(单位:秒) |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

25.更新自定义POI点Marker

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOIMarker

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------------------- | | id | string | 是 | | 添加自定义POI时的 id | | marker | Object | 是 | | 自定义POI Marker图片 |

marker :

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

26.更新自定义POI点Label

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOILabel

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------------------- | | id | string | 是 | | 添加自定义POI时的 id | | label | Object | | | 自定义POI 文本内容 |

label

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | -------- | -------- | ------------ | --------------------- | | bg_image_url | string | 是 | | label 背景图片地址 | | bg_size | string | 是 | | label 背景大小 | | bg_offset | string | 是 | | 基于Marker点进行偏移 | | content | Array | | | label文本内容 |

content：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------- | --------- | -------- | -------------------------------- | ------------------------------------------------------------ | | text | string [] | 是 | ["文本内容A", "ff0000ff", "30"], | [文本内容, HEXA颜色, 文本大小] | | text_offset | string | 是 | | 文本框左上角相对于label中bg_offset左上角的margin偏移(x,y 单位:像素), 注: x为正向右, y为正向下 | | text_boxwidth | string | 是 | | 文本框宽度(类型:Integer; 注: 文本滚动速度"scroll_speed": 0 时显示全文本, 此时文本不受文本框宽度限制) |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

27.更新自定义POI点Window

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOIWindow

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------------------- | | id | string | 是 | | 添加自定义POI时的 id | | window | object | | | |

window:

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

28.更新自定义POI点 Spline

方法： CustomPOICustomCloudRenderAPI#UpdateCustomPOISpline

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------------------- | | id | string | 是 | | 添加自定义POI时的 id | | Spline | Object | 是 | | 更新Spline信息 |

Spline：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | ---------------------------- | | url | string | 是 | | Spline 图片地址 | | size | string | 是 | | Spline 大小(宽,高单位:像素) |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

29.隐藏自定义POI

方法： CustomPOICustomCloudRenderAPI#HideCustomPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

30.显示自定义POI

方法： CustomPOICustomCloudRenderAPI#ShowCustomPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

31.删除自定义POI

方法： CustomPOICustomCloudRenderAPI#DeleteCustomPOI

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | -------- | | id | string | 是 | | |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

32.添加window自定义POI点

方法： CustomPOICustomCloudRenderAPI#AddPOIByWindow

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | ---------------------------------- | | id | string | 是 | | windowPOI id | | coord_type | int | 是 | 默认0 | 0-Gis坐标 1-UE坐标 | | position_x | float | 是 | | 三维x坐标(单位：m) 或者经度坐标lng | | position_y | float | 是 | | 三维y坐标 (单位：m)或者纬度坐标lat | | position_z | float | 是 | | 三维z坐标(单位：m) 或者海拔高度 | | window | Object | 是 | | |

window：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | -------- | ------------ | ---------------------------------- | | | url: | string | 是 | | window HTML地址 | | size: | string[] | 是 | | window大小(宽,高单位:像素) | | offset: | string[] | 是 | | |

出参：

command:"Event",
module_name:"模块名", 
api_args:{
	func_name:"方法名",
	success:"添加是否成功状态",
	error:"错误信息",
	args:{
		Json回调类型对象待确认
	}
}

33.显示或隐藏覆盖物

方法： CoverCustomCloudRenderAPI#ShowHideCovering

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | -------- | ---------------- | ------------ | --------------------------------------- | | id | string | 是 | | 覆盖物关联id | | 覆盖物类型 | string | 是 | range | 区域轮廓 | | string | 是 | columnar_heatmap | 柱状热力图 | | | string | 是 | migration_map | 迁徙图 | | | string | 是 | circular_range | 圆形区域轮廓 | | | string | 是 | path | 路径 | | | string | 是 | heatmap | 区域热力图 | | | string | 是 | road_heatmap | 路径热力图 | | | string | 是 | highlight_area | 高亮区域 | | | string | 是 | 3d_text | 3D文字 | | | bshow | bool | 是 | | 显示或隐藏覆盖物 true为显示 false为隐藏 |

出参：

{
  "command": "Event",
    "module_name": "Cover",
    "api_args": {
    "func_name": "ShowHideCovering21",
      "success": true,
        "args": "\"id\":“Rotundity1707031513801\",\r\n\"covering_type\": \"circular_range\""
  }
}

34.删除覆盖物

方法： CoverCustomCloudRenderAPI#RemoveCovering

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------- | -------- | ---------------- | -------------- | ------------ | | id | string | 是 | | 覆盖物关联id | | covering_type | string | 是 | range | 区域轮廓 | | string | 是 | columnar_heatmap | 柱状热力图 | | | string | 是 | migration_map | 迁徙图 | | | string | 是 | circular_range | 圆形区域轮廓 | | | string | 是 | path | 路径 | | | string | 是 | heatmap | 区域热力图 | | | | string | 是 | road_heatmap | 路径热力图 | | | string | 是 | highlight_area | 高亮区域 | | | string | 是 | 3d_text | 3D文字 |

出参：

{
  "command": "Event",
    "module_name": "Cover",
    "api_args": {
    "func_name": "RemoveCovering",
      "success": true,
        "args": "\"id\":“Rotundity1707031513801\",\r\n\"covering_type\": \"circular_range\""
  }
}

35.覆盖物关联window

方法： CoverCustomCloudRenderAPI#AddCoverWindow

入参：

| coverings_id | string | 是 | | 覆盖物的ID | | -------------- | ------ | ---- | ---------------- | -------------- | | coverings_type | string | 是 | range | 区域轮廓 | | | string | 是 | columnar_heatmap | 柱状热力图 | | | string | 是 | migration_map | 迁徙图 | | | string | 是 | circular_range | 圆形区域轮廓 | | | string | 是 | path | 路径 | | | string | 是 | heatmap | 区域热力图 | | | string | 是 | road_heatmap | 路径热力图 | | POIData | Object | 是 | | window POI数据 |

POIData：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | ---------------- | | id | string | 是 | | window POI id | | window | Object | 是 | | 要展示的HTMl参数 |

window：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | -------- | -------- | ------------ | ---------------- | | url | string | | | 要展示的html链接 | | size | string | | | window框大小 | | offset | string | | | 未启用偏移 |

出参：

{
  "command": "Event",
    "module_name": "Cover",
    "api_args": {
    "func_name": "AddCoverWindow",
      "success": true,
        "args": {}
  }
}

36.删除覆盖物关联Window

方法： CoverCustomCloudRenderAPI#RemoveCoverWindow

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------------- | -------- | -------- | ---------------- | ------------ | | coverings_id | string | 是 | | 覆盖物的ID | | coverings_type | string | 是 | range | 区域轮廓 | | | string | 是 | columnar_heatmap | 柱状热力图 | | | string | 是 | migration_map | 迁徙图 | | | string | 是 | circular_range | 圆形区域轮廓 | | | string | 是 | path | 路径 | | | string | 是 | heatmap | 区域热力图 | | | string | 是 | road_heatmap | 路径热力图 |

出参：

{
  "command": "Event",
    "module_name": "Cover",
    "api_args": {
    "func_name": "RemoveCoverWindow",
      "success": true,
        "args": {}
  }
}

37.Actor沿覆盖物移动

方法： CoverCustomCloudRenderAPI#CoverToMove

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------------- | -------- | -------- | -------------- | ------------------------- | | attach_id | string | 是 | | 要移动的覆盖物id | | attach_type | string | 是 | standard | 标准POI | | | string | 是 | 3d_text | 3D文字 | | coverings_id | string | 是 | | 覆盖物的ID | | coverings_type | string | 是 | range | 区域轮廓 -- 暂不支持 | | | string | 是 | circular_range | 圆形区域轮廓 -- 暂不支持 | | | string | 是 | path | 路径 | | cover_move_state | Object | 是 | | 状态参数 |

cover_move_state：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------------- | -------- | -------- | ------------ | --------------------- | | | speed | float | 是 | | 移动速度 (单位:米/秒) | | loop | bool | 是 | | 是否循环 | | reverse | bool | 是 | | 是否反向移动 | | current_attitude | bool | | | 未启用 | | pitch | float | 否 | | 俯仰角 | | yaw | float | 否 | | 偏航角 | | roll | float | 否 | | 翻滚角 |

出参：

{
  "command": "Event",
    "module_name": "Cover",
    "api_args": {
    "func_name": "CoverToMove",
      "success": true,
        "args": {}
  }
}

38.添加路径

方法： PathCustomCloudRenderAPI#AddPath

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | --------------- | ------ | --------- | ----------- | ------------------------------------------------------------ | | advancedSetting | Object | 是 | | | | coord_type | int | 是 | 0, 1 | 位置的坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z_type | int | 否未启用 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效)；默认值为“0” | | cad_mapkey | string | 否未启用 | | CAD基准点Key值, 项目中约定；默认值为空 | | pass_color | string | 否未启用 | 十六进制HEX | 覆盖物移动经过路径颜色(HEX颜色值)；默认值为“ffff00” | | width | int | 是 | 任意正整数 | 宽度(单位:米, 圆柱直径或方柱边长) | | points | Array | 是 | | |

advancedSetting：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------- | ------ | --------- | -------------------------------- | ------------------------------------------------------------ | | smoothnessOfCorners | string | 否未启用 | extremelyHigh, high, middle, low | extremelyHigh:极高; high:高; middle:中; low:低;；默认值为"middle" |

points：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------- | ------ | ---- | -------- | ------------- | | coord | string | 是 | | 坐标 lng,lat | | coord_z | int | 是 | 任意整数 | 高度(单位:米) |

出参：

{
    "command": "event",
    "func_name": "OnAddPathSuccess/OnAddPathFailed",
    "args": {
        "id": "Path_id",
        "cost_time": "0.0"
    }
}

39.BatchAddPath

方法： PathCustomCloudRenderAPI#BatchAddPath

入参：

advancedSetting：

subobj：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------ | -------- | ---- | ----------- | ------------------------------------------------------------ | | id | string | 是 | | | | type | string | 是 | | 类型名称：arrow（实心圆管箭头）flash（圆管线型）solid（实心粗线型）railway（管道型）flash_dot（大辉光线型）flash_line（小辉光线型）flow（流星线型）scan_line（管道多线型）stream_dot（细流星线型）stream_line（多流星线型）indicator_oneway（空心线型）indicator_twoway（双色线型）indicator_prohibition（多股线型）（只有arrow、flash_dot、flash_line型路径能更改颜色） | | color | string | 是 | 十六进制HEX | 颜色(HEX颜色值, 空值即透明; railway类型无效, 默认黑白色) | | points | object[] | 是 | | 路径坐标 |

points：

出参：

{
    "command": "event",
    "func_name": "OnAddShpPathInfo",          
    "guid": "3121bdd1-47a2-475c-bca4-8879580b858e",
    "args": {
        "Faild_id": [],                      
        "Success_id": [                      
            "Path_id_0",
            "Path_id_1",
            "Path_id_2",
            "Path_id_3",
            "Path_id_4",
            "Path_id_5"
        ]
    }
}

40.更新路径数据点

方法： PathCustomCloudRenderAPI#UpdatePathCoord

入参：

| id | string | 是 | | | | ------------ | -------- | --------- | ---------- | ------------------------------------------------------------ | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z_type | int | 否未启用 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效) | | cad_mapkey | string | 否未启用 | | CAD基准点Key值, 项目中约定 | | is_append | boolean | 否未启用 | true/false | true: 追加路径数据(注意顺序); false: 重建路径数据 | | points | object[] | 是 | | 路径坐标 |

points：

出参：

{
    "command": "event",
    "func_name": "OnUpdatePathCoordSuccess/OnUpdatePathCoordFailed",
    "args": {
        "id": "Path_id",
        "cost_time": "0.0"
    }
}

41.更新路径样式

方法： PathCustomCloudRenderAPI#UpdatePathStyle

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ---------- | ------ | --------- | ----------- | ------------------------------------------------------------ | | id | string | 是 | | | | type | string | 是 | | 类型名称：arrow（实心圆管箭头）flash（圆管线型）solid（实心粗线型）railway（管道型）flash_dot（大辉光线型）flash_line（小辉光线型）flow（流星线型）scan_line（管道多线型）stream_dot（细流星线型）stream_line（多流星线型）indicator_oneway（空心线型）indicator_twoway（双色线型）indicator_prohibition（多股线型）（只有arrow、flash_dot、flash_line型路径能更改颜色） | | color | string | 是 | 十六进制HEX | 颜色(HEX颜色值, 空值即透明; railway类型无效, 默认黑白色) | | pass_color | string | 否未启用 | 十六进制HEX | 覆盖物移动经过路径颜色(HEX颜色值) | | width | int | 是 | 任意正整数 | 宽度(单位:米, 圆柱直径或方柱边长) |

出参：

{
    "command": "event",
    "func_name": "OnUpdatePathStyleSuccess/OnUpdatePathStyleFailed",
    "args": {
        "id": "Path_id",
        "cost_time": "0.0"
    }
}

42.修改路径数据点

方法： PathCustomCloudRenderAPI#ModifyPathCoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | -------- | --------- | ---------------------- | ------------------------------------------------------------ | | id | string | 是 | | 路径id | | index | int | 是 | | 坐标点索引 | | coord_type | int | 是 | 0,1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z_type | int | 否未启用 | 0, 1, 2 | 坐标高度类型(0:相对3D世界表面; 1:相对3D世界地面; 2:相对3D世界海拔; 注:cad坐标无效) | | operation | string | 是 | insert, modify, delete | insert: 添加; modify: 修改; delete: 删除[coord_z_type, points字段可省略] insert 加点规则: index: 1, 在第一个坐标点之外加点; index: 2, 在坐标点[1~2]之间加点; index: 3, 在坐标点[2~3]之间加点; ... ... 依此类推; index: n, 在坐标点[n-1~n]之间加点; index: n+1, 在最后一个坐标点之外加点; | | points | object[] | 是 | | 路径坐标 |

points :

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------- | ------ | ---- | -------- | ---------- | | coord | string | 是 | | 坐标点数据 | | coord_z | number | 是 | | 坐标点高 |

43.添加区域热力图

方法： RegionalHeatMapCustomCloudRenderAPI#AddHeatMap

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------ | ------ | --------- | ---------------------------------- | ------------------------------------------------------------ | | id | string | 是 | | | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标))；默认值为“0” | | coord_z | int | 是 | 任意整数 | 高度(单位:米) | | cad_mapkey | string | 否未启用 | | CAD基准点Key值, 项目中约定)；默认值为空 | | coord_z_type | int | 否未启用 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效))；默认值为“0” | | center_coord | string | 是 | | 热力数据点的中心点坐标 | | heatmap_type | int | 否未启用 | 1，2 | 样式类型(1: 投影型, 贴合地面; 2:平面型) | | brush_diameter | int | 是 | 任意正整数 | 热力点笔刷直径(单位:米, 单个热力点覆盖直径) | | heatpoint_minvalue | int | 否未启用 | 任意比heatpoint_maxvalue小的正整数 | 热力点热力值范围最小值(1:绿色接近透明, 100:最红, 线性计算) | | heatpoint_maxvalue | int | 否未启用 | 任意比heatpoint_minvalue大的正整数 | 热力点热力值范围最大值 | | gradient_setting | object | 否未启用 | color1-color5 | 自定义热力点渐变颜色(HEX颜色值,共5个色值)；默认值为示例代码中的参数 | | data | object | 是 | | 热力数据点 |

data:

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | -------- | ------ | ---- | ---------------------------------------- | -------------------------------------------- | | coord | string | 是 | | 热力数据点的坐标 lng,lat | | size | int | 是 | [heatpoint_minvalue，heatpoint_maxvalue] | 热力数据点的热力值 | | strength | int | 是 | | 热力点颜色强度（数值越大中心颜色范围占比越大 |

出参：

{
    "command": "event",
    "func_name": "OnAddHeatMapSuccess/OnAddHeatMapFailed",
    "args": {
        "id": "HeatMap_id",
        "cost_time": "0.0"
    }
}

44.更新区域热力图数据点

方法： RegionalHeatMapCustomCloudRenderAPI#UpdateHeatMapCoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | ------- | --------- | -------- | ------------------------------------------------------------ | | id | string | 是 | | | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z | int | 是 | 任意整数 | 高度(单位:米) | | cad_mapkey | string | 否未启用 | | CAD基准点Key值, 项目中约定 | | coord_z_type | int | 否未启用 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效) | | center_coord | string | 是 | | 热力区域中心坐标 | | is_append | boolean | 否未启用 | | | | data | object | 是 | | 热力数据点 |

data:

45.更新区域热力图样式

方法： RegionalHeatMapCustomCloudRenderAPI#UpdateHeatMapCoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------ | ------ | --------- | ---------------------------------- | ---------------------------------------------------------- | | id | string | 是 | | | | heatmap_type | int | 否未启用 | 1，2 | 样式类型(1: 投影型, 贴合地面; 2:平面型) | | brush_diameter | int | 是 | 任意正整数 | 热力点笔刷直径(单位:米, 单个热力点覆盖直径) | | heatpoint_minvalue | int | 否未启用 | 任意比heatpoint_maxvalue小的正整数 | 热力点热力值范围最小值(1:绿色接近透明, 100:最红, 线性计算) | | heatpoint_maxvalue | int | 否未启用 | 任意比heatpoint_minvalue大的正整数 | 热力点热力值范围最大值 | | gradient_setting | object | 是 | color1-color5 | 自定义热力点渐变颜色(HEX颜色值,共5个色值) |

出参：

{
    "command": "event",
    "func_name": "OnUpdateHeatMapCoordSuccess/OnUpdateHeatMapCoordFailed",
    "args": {
        "id": "HeatMap_id",
        "cost_time": "0.0"
    }
}

46.添加柱状热力图

方法： ColumnHeatMapCustomCloudRenderAPI#AddColumnHeatMap

入参:

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------- | ------ | ---- | ---------------------------------------- | ------------------------------------------------------------ | | id | string | 是 | | | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z | int | 否 | 任意正数 | 高度(单位:米)；默认值为“0” | | cad_mapkey | string | 否 | | CAD基准点Key值, 项目中约定；默认值为空 | | coord_z_type | int | 是 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效)；默认值为“0” | | yaw | int | 否 | 0~360 | 偏航角(绕Z轴旋转的角度） | | columnar_type | string | 是 | cube, cylinder, needle, frame | cube:方柱, cylinder:圆柱, | | brush_diameter | int | 是 | 任意正整数 | 热力点笔刷直径(单位:米, 单个热力点覆盖直径) | | heatpoint_minvalue | int | 是 | 任意比heatpoint_maxvalue小的正整数 | 热力点热力值范围最小值(1:绿色接近透明, 100:最红, 线性计算) | | heatpoint_maxvalue | int | 是 | 任意比heatpoint_minvalue大的正整数 | 热力点热力值范围最大值 | | columnar_width | int | 是 | | (单位:米), 柱状热力图单体宽度 | | columnar_min_height | int | 是 | 任意比columnar_max_height小的正整数 | 单体柱表达最小值的实际高度(单位:米; 空值即无底色) | | columnar_max_height | int | 是 | 任意比columnar_min_height大的正整数 | 单体柱表达最大值的实际高度(单位:米) | | gap | int | 是 | 大于等于0的任意数 | 柱子之间的间隙（单位：米） | | coord | string | 是 | | 热力数据点的坐标 lng,lat | | value | int | 是 | [heatpoint_minvalue，heatpoint_maxvalue] | 热力数据点的热力值 | | gradient_setting | object | 否 | color1-color5 | 自定义热力点渐变颜色(HEX颜色值,共5个色值)；默认值为示例代码中参数 |

出参：

{
    "command": "event",
    "func_name": "OnAddColumnHeatMapSuccess/OnAddColumnHeatMapFailed",
    "args": {
        "id": "Column_HeatMap_id",
        "cost_time": "0.0"
    }
}

47.更新柱状热力图数据点

方法： ColumnHeatMapCustomCloudRenderAPI#UpdateColumnHeatMapCoord

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------ | ------ | ---- | -------- | ------------------------------------------------------------ | | id | string | 是 | | | | coord_type | int | 是 | 0, 1 | 坐标类型(0:经纬度坐标, 1:世界坐标) | | coord_z | int | 是 | 任意整数 | 高度(单位:米) | | cad_mapkey | string | 是 | | CAD基准点Key值, 项目中约定 | | coord_z_type | int | 是 | 0，1，2 | 坐标高度类型(0:相对3D世界表面；1:相对3D世界地面；2:相对3D世界海拔; 注:cad坐标无效) | | coord | string | 是 | | 热力数据点的坐标 lng,lat | | yaw | int | 否 | 0~360 | 偏航角(绕Z轴旋转的角度） |

出参：

{
    "command": "event",
    "func_name": "OnUpdateColumnHeatMapCoordSuccess/OnUpdateColumnHeatMapCoordFailed",
    "args": {
        "id": "Column_HeatMap_id",
        "cost_time": "0.0"
    }
}

49.更新柱状热力图样式

方法： ColumnHeatMapCustomCloudRenderAPI#UpdateColumnHeatMapStyle

入参：

| 参数 | 类型 | 必填 | 取值范围 | 备注 | | ------------------- | ------ | ---- | ----------------------------------- | ---------------------------------------------------------- | | id | string | 是 | | | | columnar_type | string | 是 | cube, cylinder

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

1.使用 npm 安装

2.CDN

3.初始化 在项目中引入下方代码建立像素流通信

4.特效使用方法(简要介绍)

1.添加3D文字

2.更新3D文字样式

3.更新3D文字数据点

4.添加场景镜头

5.获取场景镜头信息

6.切换场景镜头

7.设置场景镜头移动

8.设置镜头绕中心点旋转

9.场景镜头视界行为

10.重置场景镜头视界

11.锁定场景镜头视界

12.解除场景镜头视界限制(解除场景镜头锁定)

13.重置场景初始镜头

14.添加POI点

15.更新POI数据点

16.更新POI点样式

17.设置POI点状态 - 同时会触发POI的点击事件

18.隐藏POI

19.显示POI

20.聚焦POI

21.删除POI

22.修改POI颜色

22.添加自定义POI点

23.更新POI数据点

24.更新自定义POI点的样式

25.更新自定义POI点Marker

26.更新自定义POI点Label

27.更新自定义POI点Window

29.隐藏自定义POI

30.显示自定义POI

31.删除自定义POI

32.添加window自定义POI点

33.显示或隐藏覆盖物

34.删除覆盖物

35.覆盖物关联window

36.删除覆盖物关联Window

37.Actor沿覆盖物移动

38.添加路径

39.BatchAddPath

40.更新路径数据点

41.更新路径样式

42.修改路径数据点

43.添加区域热力图

44.更新区域热力图数据点

45.更新区域热力图样式

46.添加柱状热力图

47.更新柱状热力图数据点

49.更新柱状热力图样式

3.初始化在项目中引入下方代码建立像素流通信