English
Home > SCH_Document > getElementsInRegion
SCH_Document.getElementsInRegion() method
获取区域内的元素
cli - 一次调用取回区域内全部元素的业务属性,无需逐图元查询
Signature
typescript
function getElementsInRegion(
options: ISCH_DocumentGetElementsInRegionOptions,
): Promise<TSCH_SourceResult<Array<ISCH_DocumentRegionElement>>>;1
2
3
2
3
Parameters
Parameter | Type | Description |
|---|---|---|
options | 区域查询选项 |
Returns
Promise<TSCH_SourceResult<Array<ISCH_DocumentRegionElement>>>
区域内的元素列表,失败时通过 error.code 返回错误码
Remarks
全页唯一的区域 / 过滤入口;返回不定长集合,集合大小由区域内元素决定,与入参无关。
**本接口要求工程已在前端打开**:工程未打开时由原理图侧返回 PROJECT_NOT_FOUND;原理图编辑器 / 扩展 API 未就绪或调用超时返回 INTERNAL_ERROR;未提供 branchUuid 且无法回退当前激活工程分支时返回 PARAM_REQUIRED。 客户端会先校验区域:坐标非有限数值或 minX >= maxX、minY >= maxY 时直接返回 REGION_INVALID。 返回结果中若出现未知元素类型,会跳过该元素并 console.warn,不影响其余已知元素返回。 与 sch_SourceDocument 下直接操作工程源数据、不依赖前端已打开图页的接口不同。 ADD since EDA v4.1.83