披萨引擎接入指南

综合搜索特效

综合搜索特效

方法

cloudObj.RAPI("getEffect", params, (res) => {});

请求示例

cons params = {
  "area": {
    "height": 0,
    "latitude": 0,
    "longitude": 0,
    "radius": 0
  },
  "attributeList": [],
  "attributeListUnion": true,
  "detail": true,
  "disableTree": true,
  "foreignKey": [],
  "guids": [],
  "name": "",
  "objectData": {
    "type": 0,
    "typeName": ""
  },
  "tagList": [],
  "view": true
}

请求参数

参数名称	参数说明	是否必须	数据类型
area		false
height	高度	false	number
latitude	纬度	false	number
longitude	经度	false	number
radius	圆的半径	false	number
attributeList	属性列表	false	array
attributeListUnion	属性列表是否为并集，当其默认为true时,属性列表中的元素大于1个时候，只要有一个匹配即可，如果为false,则属性列表中的元素必须全部匹配	false	boolean
detail	是否显示详细信息，默认为false,在删除相关操作中强制被置为false	false	boolean
disableTree	是否以左侧树形式返回，目前只开放建筑的左侧树返回形式	false	boolean
foreignKey	根据外键搜索,与guid为共存关系	false	array
guids	直接搜索优先级最高	false	array
name	名称模糊搜索	false	string
objectData	元素的细节,在删除相关操作中被强制Null	false
type		false	number
typeName		false	string
tagList	tags列表	false	array
view	视野内参数，默认不启用，该参数为后置过滤参数,该参数在建筑，场景漫游等非实体概念的功能中被自动屏蔽。	false	boolean

响应示例

[
	{
		"attributeList": [],
		"buildID": "",
		"displayModel": true,
		"elementData": {
			"_backToInitialView": true,
			"_blendColor": {
				"w": 0,
				"x": 0,
				"y": 0,
				"z": 0
			},
			"_effectBBColorValid": true,
			"_effectBBMergin": 0,
			"_effectColorValid": true,
			"_effectMode": 0,
			"_effectState": 0,
			"_effectTemplateID": "",
			"_effectText": "",
			"_effectTextBoundBoxColor": {
				"w": 0,
				"x": 0,
				"y": 0,
				"z": 0
			},
			"_effectTextColor": {
				"w": 0,
				"x": 0,
				"y": 0,
				"z": 0
			},
			"_effectTextMargin": 0,
			"_effectTextSize": 0,
			"_firstView": true,
			"_flashStyle": {
				"_backgroundColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_effectBBMargin": 0,
				"_effectColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_fontSize": 0,
				"_textBorderVisible": true,
				"_textColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_textMargin": 0
			},
			"_generalStyle": {
				"_backgroundColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_effectBBMargin": 0,
				"_effectColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_fontSize": 0,
				"_textBorderVisible": true,
				"_textColor": {
					"_customColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_defaultColor": {
						"w": 0,
						"x": 0,
						"y": 0,
						"z": 0
					},
					"_useCustomColor": true
				},
				"_textMargin": 0
			},
			"_isMoveState": 0,
			"_isReverseMoving": true,
			"_lock": true,
			"_loopMove": true,
			"_movePathID": "",
			"_moveSpeed": 0,
			"_normalColor": {
				"w": 0,
				"x": 0,
				"y": 0,
				"z": 0
			},
			"_pulse": true,
			"_pulseColor": {
				"w": 0,
				"x": 0,
				"y": 0,
				"z": 0
			},
			"_pulseTime": 0,
			"_selfLodScale": 0,
			"_tetherState": true,
			"_troggleShader": true,
			"_troggleText": true,
			"_troggleTextBoundBoxLine": true
		},
		"floorIndex": 0,
		"foreignKey": "",
		"geometry": {
			"geometryStructure": {},
			"geometryType": "",
			"worldCoordinates": {
				"height": 0,
				"latitude": 0,
				"longitude": 0
			}
		},
		"guid": "",
		"name": "",
		"tagList": [],
		"type": 0,
		"viewPointList": [
			{
				"heading": 0,
				"height": 0,
				"home": true,
				"id": "",
				"index": 0,
				"latitude": 0,
				"longitude": 0,
				"name": "",
				"pitch": 0,
				"range": 0,
				"relPosX": 0,
				"relPosY": 0,
				"relPosZ": 0,
				"staytime": 0,
				"throughtime": 0,
				"vaild": true
			}
		]
	}
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

响应参数

参数名称	参数说明	类型
attributeList	外部属性，键值对	array
buildID	该元素所处的建筑ID,不参与搜索，只用于展示	string
displayModel	是否显隐	boolean
elementData
_backToInitialView		boolean
_blendColor	V4版本混合透明颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_effectBBColorValid	V4版本文字背景颜色有效性	boolean
_effectBBMergin	V4版本文字与模型距离	number
_effectColorValid	V4版本是否启用文字自定义颜色	boolean
_effectMode	使用模板样式还是自定义样式 0:模板 1：自定义	number
_effectState	V5使用闪烁功能 0：不使用 1：使用	number
_effectTemplateID	模板ID	string
_effectText	V4版本文字内容	string
_effectTextBoundBoxColor	V4版本文字背景颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_effectTextColor	V4版本文字自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_effectTextMargin	V4版本文字自身边距	number
_effectTextSize	V4版本文字缩放比	number
_firstView		boolean
_flashStyle	V5版本闪烁样式
_backgroundColor	背景色
_customColor	BackGroundColor自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	BackGroundColor的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_effectBBMargin	backgroundMargin	number
_effectColor	特效颜色
_customColor	特效自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	特效的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_fontSize	字体颜色	number
_textBorderVisible	文字框是否可见	boolean
_textColor	文字颜色
_customColor	文字自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	文字的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_textMargin	文字Margin	number
_generalStyle	V5版本普通样式
_backgroundColor	背景色
_customColor	BackGroundColor自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	BackGroundColor的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_effectBBMargin	backgroundMargin	number
_effectColor	特效颜色
_customColor	特效自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	特效的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_fontSize	字体颜色	number
_textBorderVisible	文字框是否可见	boolean
_textColor	文字颜色
_customColor	文字自定义颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_defaultColor	文字的原始颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_useCustomColor	是否使用自定义颜色	boolean
_textMargin	文字Margin	number
_isMoveState	数据驱动状态，0：开始，恢复暂停 1：暂停， 2：结束	number
_isReverseMoving	是否倒着移动	boolean
_lock	是否锁定	boolean
_loopMove	循环移动	boolean
_movePathID	特效绑定的路径	string
_moveSpeed	移动速度	number
_normalColor	V4版本正常颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_pulse	开启关闭闪烁	boolean
_pulseColor	V4版本闪烁颜色
w	对应的alpha通道,范围在 0-1	number
x	对应的R通道,范围在 0-1，取值为标准0-255/255	number
y	对应的G通道,范围在 0-1,取值为标准0-255/255	number
z	对应的B通道,范围在 0-1,取值为标准0-255/255	number
_pulseTime	V4版本闪烁时间	number
_selfLodScale	5.2后的控制可视范围参数	number
_tetherState		boolean
_troggleShader	V4版本启用改色	boolean
_troggleText	是否启用文字	boolean
_troggleTextBoundBoxLine	是否启用文字边框	boolean
floorIndex	该元素所处的楼层序号，不参与搜索，只用于展示	number
foreignKey	外键	string
geometry
geometryStructure	几何结构具体结构
geometryType	几何结构类型，在增加与更新接口时非必填字段	string
worldCoordinates	世界经纬度坐标,对于多边形，圆形这类手工创建的形状，世界坐标是计算得出，所以直接设置其世界坐标会不起作用。类似区域轮廓，高亮区域，路径
height	高度	number
latitude	纬度	number
longitude	经度	number
guid	唯一ID	string
name	名字	string
tagList	tag属性	array
type	类型	number
viewPointList	自定义的视点，用于组结构的孪生体	array
heading		number
height		number
home		boolean
id		string
index		number
latitude		number
longitude		number
name		string
pitch		number
range		number
relPosX		number
relPosY		number
relPosZ		number
staytime		number
throughtime		number
vaild		boolean

综合搜索特效 ​

方法 ​

请求示例 ​

请求参数 ​

响应示例 ​

响应参数 ​

综合搜索特效

方法

请求示例

请求参数

响应示例

响应参数