ElementAttribute
构件属性相关接口。
来源于@ksj/bw
| 接口 | 说明 |
|---|---|
| GetNVsByIds | 获取多个构件属性 |
| getAttachNvs | 获取单个构件附加属性 |
| addAttachProperty | 添加构件附加属性 |
| deleteAttachProperties | 删除构件附加属性 |
| deleteAttachPropertiesByName | 删除构件附加属性 |
# 1. GetNVsByIds
获取构件属性。
async GetNVsByIds( iModel: IModelConnection, ids:string[] )
参数:
iModel 对用的模型。
ids: 构件ID的数组。注:该数组不宜过大,否则可能因为查询时间过长导致错误。
返回:
失败 返回 undefined。
成功: 返回构件属性的数组 [{id:string, nvs:[{name:string, value:string, sub:[{name:string, value:string, sub: }]}];
id: 构件的ID
name: 属性名称
value: 属性值
sub: 下级属性
# 2. getAttachNvs
获取单个构件附加属性
async getAttachNvs( id:string )
参数:
id: 构件ID。
返回:
失败: 返回 undefined
成功: 返回构件属性的数组 [{name:string, value:string}]
name: 属性名称
value: 属性值
# 3. addAttachProperty
添加构件附加属性
async addAttachProperty( id:string, name:string, value:string )
参数:
id: 构件ID
name: 属性名
value: 属性值
备注:
如果构件已经存在对应的附加属性项,则修改该属性项的值。
# 4. deleteAttachProperties
删除构件附加属性
async deleteAttachProperties( id:string )
参数:
id: 构件ID
# 5. deleteAttachPropertiesByName
删除构件某一项附加属性项
async deleteAttachPropertiesByName( id:string, name:string )
参数:
id: 构件ID
name: 属性名