GIS

GIS模块,提供地理消息行业支持

27 个 APIpiclient.emit
gis.setPOIOptionsGIS-设置POI选项
#

设置地理相关的POI的显示选项

输入

参数类型必填默认值说明
enablebooleantrue是否启用显示,false则不显示
radiusnumber0.0显示半径多少米,相机为中心点方圆多少米内的poi点位
levelstringGIS比例尺级别,1-18, 0=自动
queryTypestring查询类型, 1(普通POI),2(统计),3(行政区),4(建议词搜索),5(线路结果) http://lbs.tianditu.gov.cn/server/search2.html
可选值:cnserversearch2
dataTypestring行政地名, 加油站, 水利设施, //显示的类型,详情参考 https://download.tianditu.gov.cn/download/xzqh/Type.csv
可选值:cndownloadxzqhType
maxNumstring最大显示数量
colorstringff0000

调用

typescript
piclient.emit("gis.setPOIOptions",{
	enable: true, //是否启用显示,false则不显示
	radius: 0.0, //显示半径多少米,相机为中心点方圆多少米内的poi点位
	level: "", //GIS比例尺级别,1-18, 0=自动
	queryType: "", //查询类型, 1(普通POI),2(统计),3(行政区),4(建议词搜索),5(线路结果) http://lbs.tianditu.gov.cn/server/search2.html
	dataType: "", //行政地名, 加油站, 水利设施, //显示的类型,详情参考 https://download.tianditu.gov.cn/download/xzqh/Type.csv
	maxNum: "", //最大显示数量
	color: "ff0000",
})
gis.setDistrictOptionsGIS-设置区域选项
#

设置行政区域,项目区域等区域的显示选项

输入

参数类型必填默认值说明
enablebooleantrue是否启用显示,false则不显示
borderThicknessstring10边缘粗细,单位米
borderHeightstring1.5边缘厚度,单位米
borderColorstringff00003F
fillHeightstring1.1填充区域厚度,单位米
fillColorstring2f3f001F
textVisiblebooleantrue是否启用显示,false则不显示
textColorstring2f3f001F
textScalestring1.0缩放倍数

调用

typescript
piclient.emit("gis.setDistrictOptions",{
	enable: true, //是否启用显示,false则不显示
	borderThickness: "10", //边缘粗细,单位米
	borderHeight: "1.5", //边缘厚度,单位米
	borderColor: "ff00003F",
	fillHeight: "1.1", //填充区域厚度,单位米
	fillColor: "2f3f001F",
	textVisible: true, //是否启用显示,false则不显示
	textColor: "2f3f001F",
	textScale: "1.0", //缩放倍数
})
gis.loadVectorLayerFileGIS-加载矢量数据文件
#

全球环境下加载矢量数据文件

输入

参数类型必填默认值说明
filePathstring
offsetstring
layerTypestring00 SHP File,1 GeoJson,2 CustomJson
enablePointbooleantrue是否启用显示,false则不显示
enableLinestring1是否启用显示,false则不显示
enableFacebooleantrue是否启用显示,false则不显示
snapLandbooleantrue是否贴合地形,false则不显示
pointColorstring#FFFFFF
lineColorstring#FFFFFF
faceColorstring#FFFFFF
faceMaterialIdstringmaterialId

调用

typescript
piclient.emit("gis.loadVectorLayerFile",{
	filePath: "",
	offset: "",
	layerType: "0", //0 SHP File,1 GeoJson,2 CustomJson
	enablePoint: true, //是否启用显示,false则不显示
	enableLine: "1", //是否启用显示,false则不显示
	enableFace: true, //是否启用显示,false则不显示
	snapLand: true, //是否贴合地形,false则不显示
	pointColor: "#FFFFFF",
	lineColor: "#FFFFFF",
	faceColor: "#FFFFFF",
	faceMaterialId: "materialId",
})
gis.loadVectorLayerDataGIS-加载矢量图层数据
#

全球环境下加载矢量图层数据

输入

参数类型必填默认值说明
datastring
offsetstring
layerTypestring11 GeoJson,2 CustomJson
enablePointbooleantrue是否启用显示,false则不显示
enableLinestring1是否启用显示,false则不显示
enableFacebooleantrue是否启用显示,false则不显示
snapLandbooleantrue是否贴合地形,false则不显示
pointColorstring#FFFFFF
lineColorstring#FFFFFF
faceColorstring#FFFFFF
faceMaterialIdstringmaterialId

调用

typescript
piclient.emit("gis.loadVectorLayerData",{
	// 通过数据创建图层只支持 GeoJson和CustomJson
	filePath: "",
	offset: "",
	layerType: "1", //1 GeoJson,2 CustomJson
	enablePoint: true, //是否启用显示,false则不显示
	enableLine: "1", //是否启用显示,false则不显示
	enableFace: true, //是否启用显示,false则不显示
	snapLand: true, //是否贴合地形,false则不显示
	pointColor: "#FFFFFF",
	lineColor: "#FFFFFF",
	faceColor: "#FFFFFF",
	faceMaterialId: "materialId",
})
gis.updatePresetLayerGIS-更新地形预设层
#

全球环境下更新地形预设层

输入

参数类型必填默认值说明
markLayerTypestring00 不显示标记图层,1 仅显示地名标记,2 仅显示边界,3 仅显示地名和路网
enableLandHeightstringtruetrue 开启地形高度,false不开启地形高度
backgroundLayerTypestring00 必应影像,1 天地图地形,2 天地图矢量,3 天地图影像

调用

typescript
piclient.emit("gis.updatePresetLayer",{
	markLayerType: "0", //0 不显示标记图层,1 仅显示地名标记,2 仅显示边界,3 仅显示地名和路网
	enableLandHeight: "true", //true 开启地形高度,false不开启地形高度
	backgroundLayerType: "0", //0 必应影像,1 天地图地形,2 天地图矢量,3 天地图影像
})
gis.updateVectorLayerFileByIdGIS-更新矢量图层文件
#

全球环境下更新矢量图层文件

输入

参数类型必填默认值说明
layerIdstring0
layerTypestring00 SHP File,1 GeoJson,2 CustomJson
filePathstring
offsetstring
enablePointbooleantrue是否启用显示,false则不显示
enableLinestring1是否启用显示,false则不显示
enableFacebooleantrue是否启用显示,false则不显示
snapLandbooleantrue是否贴合地形,false则不显示
pointColorstring#FFFFFF
lineColorstring#FFFFFF
faceColorstring#FFFFFF

调用

typescript
piclient.emit("gis.updateVectorLayerFileById",{
	layerId: "0",
	layerType: "0", //0 SHP File,1 GeoJson,2 CustomJson
	filePath: "",
	offset: "",
	enablePoint: true, //是否启用显示,false则不显示
	enableLine: "1", //是否启用显示,false则不显示
	enableFace: true, //是否启用显示,false则不显示
	snapLand: true, //是否贴合地形,false则不显示
	pointColor: "#FFFFFF",
	lineColor: "#FFFFFF",
	faceColor: "#FFFFFF",
})
gis.addOrUpdateWebMapLayerGIS-添加或更新网络图层
#

输入

参数类型必填默认值说明
bVisiablestring1
urlstringString
protalstringWMTS
layerstringString
stylestringString
formatstringString
bCustomLevelbooleantrue
maxLevelstring18
minLevelstring1
tileMatrixSetIdstringString
tileMatrixLabelPrefixstringString
bUseWebMercatorbooleantrue

调用

typescript
piclient.emit("gis.addOrUpdateWebMapLayer",{
	bVisiable: "1",
	url: "String",
	protal: "WMTS",
	layer: "String",
	style: "String",
	format: "String",
	bCustomLevel: true,
	maxLevel: "18",
	minLevel: "1",
	tileMatrixSetId: "String",
	tileMatrixLabelPrefix: "String",
	bUseWebMercator: true
})
gis.updateVectorLayerDataByIdGIS-更新矢量图层字符串
#

全球环境下更新矢量图层字符串

输入

参数类型必填默认值说明
layerIdstring0
layerTypestring11 GeoJson,2 CustomJson
datastring
offsetstring
enablePointbooleantrue是否启用显示,false则不显示
enableLinestring1是否启用显示,false则不显示
enableFacebooleantrue是否启用显示,false则不显示
snapLandbooleantrue是否贴合地形,false则不显示
pointColorstring#FFFFFF
lineColorstring#FFFFFF
faceColorstring#FFFFFF

调用

typescript
piclient.emit("gis.updateVectorLayerDataById",{
	layerId: "0",
	layerType: "1", //1 GeoJson,2 CustomJson
	data: "",
	offset: "",
	enablePoint: true, //是否启用显示,false则不显示
	enableLine: "1", //是否启用显示,false则不显示
	enableFace: true, //是否启用显示,false则不显示
	snapLand: true, //是否贴合地形,false则不显示
	pointColor: "#FFFFFF",
	lineColor: "#FFFFFF",
	faceColor: "#FFFFFF",
})
gis.focusLayerByIdGIS-聚焦图层
#

全球环境下聚焦到特定图层

输入

参数类型必填默认值说明
layerIdstring0对象ID

调用

typescript
piclient.emit("gis.focusLayerById",{
	layerId : "0", // 对象ID
})
gis.removeLayerByIdGIS-删除图层
#

全球环境下删除特定图层

输入

参数类型必填默认值说明
layerIdstring0对象ID

调用

typescript
piclient.emit("gis.removeLayerById",{
	layerId : "0", // 对象ID
})
gis.setLayerVisibilityByIdGIS-设置图层可见性
#

全球环境下设置图层可见性

输入

参数类型必填默认值说明
layerIdstring0对象ID
visiblestringtrue是否可见

调用

typescript
piclient.emit("gis.setLayerVisibilityById",{
	layerId: "0",// 对象ID
	visible: "true",// 是否可见
})
gis.createProjectionImageGIS-创建图片投影
#

创建图片投影

输入

参数类型必填默认值说明
imagePathstring投影图片,jpg/png
可选值:jpgpng
positionstring位置
rotationstring朝向
scalestring缩放
alphanumber0.0透明度 0代表不可见,1代表可见
colorstring#FFFFFF叠加颜色

调用

typescript
piclient.emit("gis.createProjectionImage",{
	imagePath: "",// 投影图片,jpg/png
	position: "",// 位置
	rotation: "",// 朝向
	scale: "",// 缩放
	alpha: 0.0,// 透明度 0代表不可见,1代表可见
	color: "#FFFFFF",// 叠加颜色
})
gis.updateProjectionImageGIS-更新图片投影
#

更新图片投影

输入

参数类型必填默认值说明
idstring对象ID
imagePathstring投影图片,jpg/png
可选值:jpgpng
positionstring位置
rotationstring朝向
scalestring缩放
alphanumber0.0透明度
colorstring#FFFFFF叠加颜色

调用

typescript
piclient.emit("gis.updateProjectionImage",{
	id: "",// 对象ID
	imagePath: "",// 投影图片,jpg/png
	position: "",// 位置
	rotation: "",// 朝向
	scale: "",// 缩放
	alpha: 0.0,// 透明度
	color: "#FFFFFF",// 叠加颜色
})
gis.showProjectionImageInPipeGIS-创建管道投影
#

创建管道外表面投影

输入

参数类型必填默认值说明
startIdstring
endIdstring
deviceWithnumber0.0
pipeRadiusstring设备半径
pipeShowImageRotatenumber0.0外表面相对于圆心的角度,,逆时针0-360
distancenumber0.0相对于起始点距离
tagstring
imagePathstring
sizestring

调用

typescript
piclient.emit("gis.showProjectionImageInPipe",{
	startId: "",//起点模型id
	endId: "",//终点模型id
	deviceWith: 0.0,
	pipeRadius: "", //设备半径
	pipeShowImageRotate: 0.0, //外表面相对于圆心的角度,,逆时针0-360
	distance: 0.0, //相对于起始点距离
	tag: "",
	imagePath: "",//图片路径
	size: "",
})
gis.createProjectionVideoGIS-创建投影视频
#

创建投影视频

输入

参数类型必填默认值说明
videoPathstring
positionstring0.0, 0.0, 0.0
rotationstring0.0, -90.0, 90.0
scalestring1.0, 1.0, 1.0
intensitystring1
orderstring0

调用

typescript
piclient.emit("gis.createProjectionVideo",{
	videoPath: "",//视频路径
	position: "0.0, 0.0, 0.0",//引擎坐标位置
	rotation: "0.0, -90.0, 90.0",//朝向
	scale: "1.0, 1.0, 1.0",//缩放
	intensity: "1",
	order: "0",
})
gis.updateProjectionVideoGIS-更新投影视频
#

更新投影视频

输入

参数类型必填默认值说明
idstring
videoPathstring
positionstring0.0, 0.0, 0.0
rotationstring0.0, -90.0, 90.0
scalestring1.0, 1.0, 1.0
intensitystring1
orderstring0

调用

typescript
piclient.emit("gis.updateProjectionVideo",{
	id: "",//投影视频对象id
	videoPath: "",//视频路径
	position: "0.0, 0.0, 0.0",//引擎坐标位置
	rotation: "0.0, -90.0, 90.0",//朝向
	scale: "1.0, 1.0, 1.0",//缩放
	intensity: "1",
	order: "0",
})
gis.createCFDObjectGIS-创建CFD对象
#

创建CFD对象

输入

参数类型必填默认值说明
objectTypestring00 表面着色模型、1 矢量场模型、2 粒子轨迹模型
filePathstringString文件路径
positionstring0.0, 0.0, 0.0位置
rotationstring0.0, -90.0, 90.0朝向
scalestring1.0, 1.0, 1.0缩放
elementScalestring0元素缩放
sampleGapstring0采样间隔
renderTypestring3渲染类型,0 cube、1 sphere、2 cone、3 arrow
centralizebooleantrue数据居中
inverseFacebooleantrue反转面

调用

typescript
piclient.emit("gis.createCFDObject",{
	objectType: "0", //0 表面着色模型、1 矢量场模型、2 粒子轨迹模型
	filePath: "String", //文件路径
	position: "0.0, 0.0, 0.0", //位置
	rotation: "0.0, -90.0, 90.0", //朝向
	scale: "1.0, 1.0, 1.0", //缩放
	elementScale: "0", //元素缩放
	sampleGap: "0", //采样间隔
	renderType: "3", //渲染类型,0 cube、1 sphere、2 cone、3 arrow
	centralize: true, //数据居中
	inverseFace: true, //反转面
})
gis.updateCFDObjectGIS-更新CFD对象
#

更新CFD对象

输入

参数类型必填默认值说明
idstringString
objectTypestring00 表面着色模型、1 矢量场模型、2 粒子轨迹模型
filePathstringString文件路径
positionstring0.0, 0.0, 0.0位置
rotationstring0.0, -90.0, 90.0朝向
scalestring1.0, 1.0, 1.0缩放
elementScalestring0元素缩放
sampleGapstring0采样间隔
renderTypestring3渲染类型,0 cube、1 sphere、2 cone、3 arrow
centralizebooleantrue数据居中
inverseFacebooleantrue反转面

调用

typescript
piclient.emit("gis.updateCFDObject",{
	id: "String",
	objectType: "0", //0 表面着色模型、1 矢量场模型、2 粒子轨迹模型
	filePath: "String", //文件路径
	position: "0.0, 0.0, 0.0", //位置
	rotation: "0.0, -90.0, 90.0", //朝向
	scale: "1.0, 1.0, 1.0", //缩放
	elementScale: "0", //元素缩放
	sampleGap: "0", //采样间隔
	renderType: "3", //渲染类型,0 cube、1 sphere、2 cone、3 arrow
	centralize: true, //数据居中
	inverseFace: true, //反转面
})
gis.createProjectionVideo2GIS-创建视频融合2.0
#

创建视频融合

输入

参数类型必填默认值说明
videoPathstring
positionstring0.0, 0.0, 0.0
rotationstring0.0, -90.0, 0.0
scalestring1.0, 1.0, 1.0
intensitystring1
distancestring100000
FOVstring30
aspectRatiostring1
uvOffsetstring0, 0
uvScalestring1.0, 1.0
featheringSizestring0
featheringAttenuationstring0

调用

typescript
piclient.emit("gis.createProjectionVideo2",{
    "videoPath": "", // 文件路径需额外添加转义符,如:"D:\project\filename.mp4"需要写成"D:\\project\\filename.mp4"
    "position": "1131.05, -148.33, 161.1", // 位置坐标
    "rotation": "0.0, -33.900002 , -30.9", //旋转坐标
    "scale": "1.0, 1.0, 1.0", // 缩放大小
    "intensity": "1", // 画面亮度
    "distance": "100000", // 投影距离
    "FOV": "30", // 视角FOV
    "aspectRatio": "1", // 画面宽高比
    "uvOffset": "0, 0", // UV偏移X,UV偏移Y
    "uvScale": "1.0, 1.0", // UV重复X,UV重复Y
    "featheringSize": "0", // 羽化率
    "featheringAttenuation": "0" // 羽化衰减
})
gis.updateProjectionVideo2GIS-更新视频融合2.0
#

更新视频融合2.0

输入

参数类型必填默认值说明
idstring
videoPathstring
positionstring0.0, 0.0, 0.0
rotationstring0.0, -90.0, 0.0
scalestring1.0, 1.0, 1.0
intensitystring1
distancestring100000
FOVstring30
aspectRatiostring1
uvOffsetstring0, 0
uvScalestring1.0, 1.0
featheringSizestring0
featheringAttenuationstring0

调用

typescript
piclient.emit("gis.updateProjectionVideo2",{
    id: "",
	videoPath: "",
	position: "0.0, 0.0, 0.0",
	rotation: "0.0, -90.0, 0.0",
	scale: "1.0, 1.0, 1.0",
	intensity: "1",
	distance: "100000",
	FOV: "30",
	aspectRatio: "1",
	uvOffset: "0, 0",
	uvScale: "1.0, 1.0",
	featheringSize: "0",
	featheringAttenuation: "0",
})
gis.enableFieldViewPickupGIS-开启粒子场采样
#

开启粒子场鼠标点选采样

输入

参数类型必填默认值说明
enablestringtrue

调用

typescript
piclient.emit("gis.enableFieldViewPickup",{
    enable: "true",
})
gis.playPathFieldGIS-播放粒子场轨迹
#

播放粒子场轨迹

输入

参数类型必填默认值说明
idstring0
typestring00 停止播放,1从头开始播放,2暂停播放,3继续播放

调用

typescript
piclient.emit("gis.playPathField",{
    id: "0",
	type: "0", //0 停止播放,1从头开始播放,2暂停播放,3继续播放
})
gis.highlight3DTileWithIdGIS-高亮3D瓦片组件
#

高亮3D瓦片组件

输入

参数类型必填默认值说明
idstring0唯一标记组件的ID
globalSelectColorstring#00FF00

调用

typescript
piclient.emit("gis.highlight3DTileWithId",{
	id: "0", //唯一标记组件的ID
	globalSelectColor: "#00FF00",
})
gis.flushProjectionVideoGIS-刷新投影视频组件
#

刷新投影视频组件,刷新会更新组件

输入

参数类型必填默认值说明
idstring0唯一标记组件的ID

调用

typescript
piclient.emit("gis.flushProjectionVideo",{
	id: "0", //唯一标记组件的ID
})
gis.initVisibleStateOf3DTilesGIS-初始化3D瓦片组件可见性
#

初始化3D瓦片组件可见性

输入

参数类型必填默认值说明
idstring0
visiableStatestring0设置Feature的可见性,格式如下:
resetVisibilitybooleantrue

调用

typescript
piclient.emit("gis.initVisibleStateOf3DTiles",{
	id: "0",
	visiableState: "0", //设置Feature的可见性,格式如下:ID1:1 / ID2:0 ...
	resetVisibility: true,
})
gis.updateVisibilityOf3DTilesSectionGIS-设置或更新3D瓦片组件可见性
#

设置或更新3D瓦片组件可见性

输入

参数类型必填默认值说明
idstring0
sectionIdstring0可以是ID,也可以是分类,具体取决于瓦片设置里指定的哪个字段
visiablebooleantrue

调用

typescript
piclient.emit("gis.updateVisibilityOf3DTilesSection",{
	id: "0",
	sectionId: "0", //可以是ID,也可以是分类,具体取决于瓦片设置里指定的哪个字段
	visiable: true,
})
gis.setUnControlSectionVisibilityOf3DTilesGIS-设置3D瓦片其余部分的可见性
#

设置3D瓦片其余部分的可见性

输入

参数类型必填默认值说明
idstring0
restVisiablebooleantrue

调用

typescript
piclient.emit("gis.setUnControlSectionVisibilityOf3DTiles",{
	id: "0",
	restVisiable: true,
})