POI

POI模块,提供点位显示支持

6 个 APIpiclient.emit
poi.createPOIPOI-创建POI
#

创建POI

参数说明

参数类型必填默认值说明
tagstring否—标记
geostring否—经纬度,经度,纬度[,高程] 支持可选的高程
enginestring否—引擎坐标X,Y,Z
rotatestring否—3D POI可选值
parentIdstring否—附加的父对象,为空表示独立存在
parentTagstring否—附加的父对象,为空表示独立存在
offsetstring否—x,y,z
iconPathstring否—图片路径,内置/网络图片
iconPathHLstring否—图片路径,内置/网络图片
iconPathLeavestring否—图片路径,内置/网络图片
iconColorstring否—//图标颜色是‌十六进制颜色代码,常见‌红色‌: ‌红色‌:#FF0000;绿色‌:#00FF00;蓝色‌:#0000FF;黄色‌:#FFFF00;青色‌:#00FFFF;黑色‌:#000000;白色‌:#FFFFFF;灰色‌:#808080;深灰色‌:#A9A9A9;浅灰色‌:#D3D3D3;棕色‌:#A52A2A;橙色‌:#FFA500;粉红色‌:#FFC0CB;紫色‌:#800080;
iconScalestring否1图标缩放
focusFlyboolean否true双击飞行到POI,非瞬移
followCameraboolean否true3D POI可选
iconSizestring否—50x50,长x宽
iconOffsetstring否—0x0,左右x上下
labelTextstring否—标题文本
labelOffsetstring否—0x0,左右x上下
labelColorstring否—//图标颜色是‌十六进制颜色代码,常见‌红色‌: ‌红色‌:#FF0000;绿色‌:#00FF00;蓝色‌:#0000FF;黄色‌:#FFFF00;青色‌:#00FFFF;黑色‌:#000000;白色‌:#FFFFFF;灰色‌:#808080;深灰色‌:#A9A9A9;浅灰色‌:#D3D3D3;棕色‌:#A52A2A;橙色‌:#FFA500;粉红色‌:#FFC0CB;紫色‌:#800080;
labelSizestring否12文字大小
labelContentstring否String内容文本/模板
labelContentColorstring否String模板,内容颜色ff0000
templateIdstring否String0
menuOffsetstring否—0x0,左右x上下
MenuWebUrlstring否——
poiTypestring否2D2D/3D/Dimension/2DTemplate
styleTypestring否Horizontal图标和文本摆放状态:Horizontal(水平)/Vertica(垂直)/Overlay(覆盖)/IconOnly(只显示图标)/TextOnly(只显示文本)
dataIDstring否——

调用

typescript
piclient.emit("poi.createPOI",{
	tag: "", //标记
	geo: "", //经纬度,经度,纬度[,高程] 支持可选的高程
	engine: "", //引擎坐标X,Y,Z
	rotate: "", //3D POI可选值
	parentId: "", //附加的父对象,为空表示独立存在
	parentTag: "", //附加的父对象,为空表示独立存在
	offset: "", //x,y,z
	iconPath: "", //图片路径,内置/网络图片
	iconPathHL: "", //图片路径,内置/网络图片
	iconPathLeave: "", //图片路径,内置/网络图片
	iconColor: "", ////图标颜色是‌十六进制颜色代码,常见‌红色‌: ‌红色‌:#FF0000;绿色‌:#00FF00;蓝色‌:#0000FF;黄色‌:#FFFF00;青色‌:#00FFFF;黑色‌:#000000;白色‌:#FFFFFF;灰色‌:#808080;深灰色‌:#A9A9A9;浅灰色‌:#D3D3D3;棕色‌:#A52A2A;橙色‌:#FFA500;粉红色‌:#FFC0CB;紫色‌:#800080;
	iconScale: "1", //图标缩放
	focusFly: true, //双击飞行到POI,非瞬移
	followCamera: true, //3D POI可选
	iconSize: "", //50x50,长x宽
	iconOffset: "", //0x0,左右x上下
	labelText: "", //标题文本
	labelOffset: "", //0x0,左右x上下
	labelColor: "", ////图标颜色是‌十六进制颜色代码,常见‌红色‌: ‌红色‌:#FF0000;绿色‌:#00FF00;蓝色‌:#0000FF;黄色‌:#FFFF00;青色‌:#00FFFF;黑色‌:#000000;白色‌:#FFFFFF;灰色‌:#808080;深灰色‌:#A9A9A9;浅灰色‌:#D3D3D3;棕色‌:#A52A2A;橙色‌:#FFA500;粉红色‌:#FFC0CB;紫色‌:#800080;
	labelSize: "12", //文字大小
	labelContent: "String", //内容文本/模板
	labelContentColor: "String", //模板,内容颜色ff0000
	templateId: "String", //0
	menuOffset: "", //0x0,左右x上下
	MenuWebUrl: "",
	poiType: "2D", //2D/3D/Dimension/2DTemplate
	styleType: "Horizontal", //图标和文本摆放状态:Horizontal(水平)/Vertica(垂直)/Overlay(覆盖)/IconOnly(只显示图标)/TextOnly(只显示文本)
	dataID: "",
})
poi.modifyPOIPOI-修改POI
#

修改POI

参数说明

参数类型必填默认值说明
poiIdstring否——
tagstring否—标记
geostring否—经纬度,经度,纬度[,高程] 支持可选的高程
enginestring否—引擎坐标
visibilitystring否01显示/0隐藏
modelStatusnumber否0.0气泡正常0/高亮1/离线2
rotatestring否—3D POI可选值
dataIDstring否——
iconColorstring否—图标颜色ff0000
iconScalestring否1图标缩放
iconPathstring否—图片路径,内置/网络图片
iconPathHLstring否—图片路径,内置/网络图片
iconPathLeavestring否—图片路径,内置/网络图片
focusFlyboolean否true双击飞行到POI,非瞬移
followCameraboolean否true3D POI可选
iconSizestring否—50x50,长x宽
iconOffsetstring否—0x0,左右x上下
labelTextstring否——
labelOffsetstring否—0x0,左右x上下
labelSizestring否12文字大小
labelColorstring否FFFFFFFF标题颜色
labelContentstring否String内容文本/模板专用
labelContentColorstring否String模板专用,颜色ff0000
menuOffsetstring否—0x0,左右x上下
menuWebUrlstring否——

调用

typescript
piclient.emit("poi.modifyPOI",{
	poiId: "",
	tag: "", //标记
	geo: "", //经纬度,经度,纬度[,高程] 支持可选的高程
	engine: "", //引擎坐标
	visibility: "0", //1显示/0隐藏
	modelStatus: 0.0, //气泡正常0/高亮1/离线2
	rotate: "", //3D POI可选值
	dataID: "",
	iconColor: "", //图标颜色ff0000
	iconScale: "1", //图标缩放
	iconPath: "", //图片路径,内置/网络图片
	iconPathHL: "", //图片路径,内置/网络图片
	iconPathLeave: "", //图片路径,内置/网络图片
	focusFly: true, //双击飞行到POI,非瞬移
	followCamera: true, //3D POI可选
	iconSize: "", //50x50,长x宽
	iconOffset: "", //0x0,左右x上下
	labelText: "",
	labelOffset: "", //0x0,左右x上下
	labelSize: "12", //文字大小
	labelColor: "FFFFFFFF", //标题颜色
	labelContent: "String", //内容文本/模板专用
	labelContentColor: "String", //模板专用,颜色ff0000
	menuOffset: "", //0x0,左右x上下
	menuWebUrl: "",
})
poi.loadPOIFromFilePOI-从文件批量加载POI
#

批量加载POI

参数说明

参数类型必填默认值说明
appendboolean否true是否追加模式,false=清空原有
groupIdstring否——
filePathstring否—文件地址,内容参考poi.loadPOIFromData

调用

javascript
piclient.emit("poi.loadPOIFromFile",{
	append: true, //是否追加模式,false=清空原有
	groupId: "",
	filePath: "", //文件地址,内容参考poi.loadPOIFromData
})
poi.loadPOIFromDataPOI-从数据批量加载POI
#

批量加载POI

参数说明

参数类型必填默认值说明
appendboolean否true是否追加模式,false=清空原有
groupIdstring否——
datastring否—格式 {"groupId":"id","data":[{"id":"","name":"","iconChar":"\ue030","level":11,"geoPos":"","color":"","type":"","focusOnClick":false},{}]}

调用

typescript
piclient.emit("poi.loadPOIFromData",{
	append: true, //是否追加模式,false=清空原有
	groupId: "",
	data: "", //格式 {"groupId":"id","data":[{"id":"","name":"","iconChar":"\ue030","level":11,"geoPos":"","color":"","type":"","focusOnClick":false},{}]}
})
poi.showPOIWebPOI-网页展示
#

POI网页展示

参数说明

参数类型必填默认值说明
targetstring否ObjectId—
playStatestring否toggletoggle/show/hide
可选值:toggleshowhide

调用

typescript
piclient.emit("poi.showPOIWeb",{
	target: "ObjectId",
	playState: "toggle", //toggle/show/hide
})
poi.mergePOIPOI-点聚合
#

点聚合

参数说明

参数类型必填默认值说明
mergePOIboolean否true点聚合开关
mergePOIDistancestring否50000点聚合距离
iconPathstring否String图片路径,内置/网络图片
iconSizestring否String50x50,长x宽
labelOffsetstring否String0x0,左右x上下
labelSizestring否12文字大小
labelColorstring否FFFFFFFF文字颜色
tagstring否String分类带merge_的标记
menuWebUrlstring否String—

调用

typescript
piclient.emit("poi.mergePOI",{
	mergePOI: true, //点聚合开关
	mergePOIDistance: "50000", //点聚合距离
	iconPath: "String", //图片路径,内置/网络图片
	iconSize: "String", //50x50,长x宽
	labelOffset: "String", //0x0,左右x上下
	labelSize: "12", //文字大小
	labelColor: "FFFFFFFF", //文字颜色
	tag: "String", //分类带merge_的标记
	menuWebUrl: "String",
})