English
Home > SCH_Document > renderRegion
SCH_Document.renderRegion() method
渲染区域
cli - 一次调用取回指定区域的图像文件,无需前端截图
Signature
typescript
function renderRegion(options: ISCH_DocumentRenderRegionOptions): Promise<TSCH_SourceResult<File>>;1
Parameters
Parameter | Type | Description |
|---|---|---|
options | 区域渲染选项 |
Returns
Promise<TSCH_SourceResult<File>>
渲染结果文件;失败时通过 error.code 返回 INTERNAL_ERROR / PARAM_REQUIRED / REGION_INVALID
Remarks
本接口是文档级接口中唯一返回非 JSON 值的方法,也是唯一会触发渲染的方法。
**本接口要求工程已在前端打开**。pro-sch 的 typed 契约是 File | undefined: 成功返回 File;目标工程 / 图页不可用、参数非法或渲染失败时一律返回 undefined (错误细节只记录在 pro-sch 控制台,不回传业务错误码,因此没有 PROJECT_NOT_FOUND 等业务错误码)。 pro-api 收到 undefined 或通道 / 传输异常时返回 INTERNAL_ERROR;未提供 branchUuid 且无法回退当前激活工程分支时返回 PARAM_REQUIRED。 客户端会先校验区域:坐标非有限数值或 minX >= maxX、minY >= maxY 时直接返回 REGION_INVALID,不会透传给原理图侧。 与 sch_SourceDocument 下直接操作工程源数据、不依赖前端已打开图页的接口不同。 ADD since EDA v4.1.83