Home > LIB_Symbol > getDocumentSource

LIB_Symbol.getDocumentSource() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

获取符号的文档源码

Signature

function getDocumentSource(symbolUuid: string, libraryUuid?: string): Promise<string | undefined>;

Parameters

Parameter	Type	Description
symbolUuid	string	符号 UUID
libraryUuid	string	(Optional) 库 UUID，默认为系统库，可以使用 LIB_LibrariesList 内的接口获取

Returns

Promise<string | undefined>

符号的 3.0 文档源码（esym JSON 字符串），获取失败返回 undefined

Remarks

与 LIB_Symbol.updateDocumentSource() 对称的读取接口；返回 **3.0 格式**（esym）的符号源数据， 可直接用于组装原理图源数据（如 AI 生成 eprj3 工程）。

支持工程库 / 非工程库（系统库 / 个人库 / 扩展库）： - 工程库：从当前打开的工程 worker 读取（含未保存内容）； - 非工程库：从 lib.worker 读取（含未保存内容），worker 无缓存时回退网络获取， 自动处理 history_uuid（历史版本）、dataStrId（远程存储）与 2.0 → 3.0 格式转换。

获取失败（如库条目不存在）将返回 undefined