Extension API Reference
Classes
Class | Description |
|---|---|
文档树 / 板子管理类 | |
文档树 / 编辑器控制类 | |
文档树 / 事件类 | |
文档树 / 文件夹类 | |
文档树 / 面板管理类 | |
文档树 / PCB 管理类 | |
文档树 / 工程管理类 | |
文档树 / 原理图管理类 | |
文档树 / 选择控制类 | |
文档树 / 团队类 | |
文档树 / 工作区类 | |
嘉立创 EDA 专业版用户 API 接口 | |
复杂多边形 | |
单多边形 | |
圆弧线图元 | |
属性图元 | |
器件图元 | |
器件焊盘图元 | |
尺寸标注图元 | |
填充图元 | |
图像图元 | |
直线图元 | |
二进制内嵌对象图元 | |
焊盘图元 | |
折线图元 | |
覆铜边框图元 | |
覆铜填充图元 | |
区域图元 | |
文本图元 | |
过孔图元 | |
圆弧图元 | |
属性图元 | |
总线图元 | |
复用模块符号图元 | |
圆图元 | |
器件图元 | |
器件引脚图元 | |
二进制内嵌对象图元 | |
引脚图元 | |
多边形(折线)图元 | |
矩形图元 | |
文本图元 | |
导线图元 | |
综合库 / 3D 模型类 | |
综合库 / 复用模块类 | |
综合库 / 库分类索引类 | |
综合库 / 器件类 | |
综合库 / 封装类 | |
综合库 / 库列表类 | |
综合库 / 面板库类 | |
综合库 / 选择控制类 | |
综合库 / 仿真模型类 | |
综合库 / 符号类 | |
PCB & 封装 / 文档操作类 | |
PCB & 封装 / 设计规则检查(DRC)类 | |
PCB & 封装 / 事件类 | |
PCB & 封装 / 图层操作类 | |
PCB & 封装 / 生产资料类 | |
PCB & 封装 / 多边形数学类 | |
PCB & 封装 / 网络类 | |
PCB & 封装 / 图元类 | |
PCB & 封装 / 圆弧线图元类 | |
PCB & 封装 / 属性图元类 | |
PCB & 封装 / 器件图元类 | |
PCB & 封装 / 尺寸标注图元类 | |
PCB & 封装 / 填充图元类 | |
PCB & 封装 / 图像图元类 | |
PCB & 封装 / 直线图元类 | |
PCB & 封装 / 二进制内嵌对象图元类 | |
PCB & 封装 / 焊盘图元类 | |
PCB & 封装 / 折线图元类 | |
PCB & 封装 / 覆铜边框图元类 | |
PCB & 封装 / 覆铜填充图元类 | |
PCB & 封装 / 禁止区域和约束区域图元类 | |
PCB & 封装 / 文本图元类 | |
PCB & 封装 / 过孔图元类 | |
PCB & 封装 / 光线追踪引擎类 | |
PCB & 封装 / 选择控制类 | |
面板 / 文档操作类 | |
原理图 & 符号 / 文档操作类 | |
原理图 & 符号 / 设计规则检查(DRC)类 | |
原理图 & 符号 / 事件类 | |
原理图 & 符号 / 生产资料类 | |
原理图 & 符号 / 网络类 | |
原理图 & 符号 / 网表类 | |
原理图 & 符号 / 图元类 | |
原理图 & 符号 / 圆弧图元类 | |
原理图 & 符号 / 属性图元类 | |
原理图 & 符号 / 总线图元类 | |
原理图 & 符号 / 圆图元类 | |
原理图 & 符号 / 器件图元类 | |
原理图 & 符号 / 二进制内嵌对象图元类 | |
原理图 & 符号 / 引脚图元类 | |
原理图 & 符号 / 多边形(折线)图元类 | |
原理图 & 符号 / 矩形图元类 | |
原理图 & 符号 / 文本图元类 | |
原理图 & 符号 / 导线图元类 | |
原理图 & 符号 / 选择控制类 | |
原理图 & 符号 / 仿真引擎类 | |
原理图 & 符号 / 工具类 | |
系统 / 外部请求类 | |
系统 / 对话框类 | |
系统 / 运行环境类 | |
系统 / 文件管理类 | |
系统 / 文件系统交互类 | |
系统 / 字体管理类 | |
系统 / 格式转换(Chameleon)类 | |
系统 / 顶部菜单类 | |
系统 / 多语言类 | |
系统 / 内联框架窗口类 | |
系统 / 加载与进度条类 | |
系统 / 日志类 | |
系统 / 数学计算类 | |
系统 / 消息通知类 | |
系统 / 消息框类 | |
系统 / 消息总线类 | |
系统 / 面板控制类 | |
系统 / 右键菜单类 | |
系统 / 设置类 | |
系统 / 快捷键类 | |
系统 / 存储类 | |
系统 / 定时器类 | |
系统 / 吐司消息类 | |
系统 / 工具类 | |
系统 / 单位类 | |
系统 / WebSocket 类 | |
系统 / 窗口类 |
Enumerations
Enumeration | Description |
|---|---|
编辑器文档类型 | |
编辑器分屏方向 | |
编辑器标签页事件类型 | |
指示标记类型 | |
文档树项目类型 | |
工程协作模式 | |
嘉立创贴片库类别 | |
综合库库类型 | |
预览视图类型 | |
仿真模型类型 | |
符号类型 | |
自动布线拐角风格 | |
自动布线对已有导线/过孔的处理方式 | |
自动布线效果优先级 | |
画布更新计算功能状态 | |
文档飞线计算功能状态 | |
非激活层展示模式 | |
图层颜色配置 | |
图层 ID | |
层状态 | |
图层类型 | |
鼠标事件类型 | |
网络事件类型 | |
PCB 板材类型 | |
PDF 输出方式 | |
圆弧交互模式 | |
尺寸标注类型 | |
图元事件类型 | |
填充图元填充模式 | |
焊盘热焊连接方式 | |
焊盘钻孔类型 | |
焊盘外形种类 | |
焊盘类型 | |
覆铜填充方法 | |
区域图元区域规则类型 | |
文本对齐模式 | |
图元类型 | |
过孔类型 | |
动态仿真引擎拉取事件类型 | |
动态仿真引擎推送事件类型 | |
导出文档文件类型 | |
鼠标事件类型 | |
器件类型 | |
图元事件类型 | |
填充样式 | |
线型 | |
引脚形状 | |
引脚类型 | |
文本对齐模式 | |
图元类型 | |
仿真网表类型 | |
Spice 仿真引擎拉取事件类型 | |
Spice 仿真引擎推送事件类型 | |
底部面板标签页 | |
顶部菜单环境 | |
导入工程板边框来源 | |
导入工程导入选项 | |
导入工程原理图图元样式 | |
导入工程过孔阻焊扩展 | |
左侧面板标签页 | |
日志类型 | |
网表类型 | |
右侧面板标签页 | |
快捷键生效页面范围 | |
快捷键生效场景范围 | |
开始页快速启动项 | |
主题 | |
吐司消息类型 | |
单位 | |
窗口事件类型 | |
打开窗口上下文目标 | |
网络端口符号对应的器件名称 | |
悬浮框特殊符号对应的器件名称 |
Functions
Function | Description |
|---|---|
创建一个组件化弹出窗口的通信入口(客户端 API)。 扩展可在任意环境(iframe / worker / Main)调用,返回一个 IDesignPortal 对象, 所有通信(发消息 + 收事件)均封装在对象内部,扩展无需感知 bus。 扩展结合 lc-editor-design-react 的 VirtualRender / 虚拟机组件使用: tsx 1 2 3 4 5 6 7 | |
注册组件化弹出窗口服务端(仅在 Main 环境调用一次)。 监听客户端(iframe / worker / Main)经 bus 发来的 create/update/detach 消息, 驱动 Main 端的 EditorDesignPortal 实际渲染组件,并将组件事件回传给客户端。 |
Interfaces
Interface | Description |
|---|---|
分组面板:带标题的可折叠/分组容器 | |
按钮组件:可点击触发的操作按钮 | |
复选框组件:可勾选的状态控件 | |
组件名 → Props 类型映射 作为 createComponent 泛型约束的唯一来源 | |
对话框组件:带标题栏、可拖拽缩放的组合弹窗 | |
Flex 子项:Flex 布局中的单个子元素 | |
布局容器:灵活的 Flex 布局容器 | |
Grid 子项:网格中的单个子元素 | |
布局容器:固定列数的网格布局容器 | |
图标配置:通过 URL 或 CSS class 指定图标 | |
组件树操作契约。 | |
板子属性 | |
简略工程属性 | |
编辑器文档对象 | |
编辑器分屏属性 | |
编辑器标签页 | |
文件夹属性 | |
指示标记外形 | |
面板属性 | |
PCB 属性 | |
工程属性 | |
原理图属性 | |
原理图图页属性 | |
团队属性 | |
工作区属性 | |
3D 模型属性 | |
搜索到的 3D 模型属性 | |
复用模块属性 | |
搜索到的复用模块属性 | |
分类索引 | |
器件关联符号、封装属性 | |
器件扩展属性 | |
器件属性 | |
可用于精确搜索的器件参数 | |
搜索到的器件属性 | |
外部库 3D 模型方法 | |
外部库复用模块方法 | |
外部库分类索引 | |
外部库器件方法 | |
外部库封装方法 | |
外部库方法 | |
外部库元素 | |
外部库元素索引 | |
外部库搜索参数 | |
外部库搜索结果 | |
外部库搜索结果数据行 | |
外部库符号方法 | |
外部库用户索引 | |
封装属性 | |
可用于精确搜索的封装参数 | |
搜索到的封装属性 | |
库信息 | |
库属性 | |
面板库属性 | |
搜索到的面板库属性 | |
仿真模型属性 | |
搜索到的仿真模型属性 | |
符号属性 | |
可用于精确搜索的符号参数 | |
搜索到的符号属性 | |
图片组件:展示单张图片 | |
输入框组件:支持下拉、搜索、清除、前后缀等多种形态 | |
自动布局结果 | |
自动布线入参 | |
自动布线结果 | |
BOM 列的属性及排序规则 | |
差分对属性 | |
离散化点 | |
离散化选项 | |
等长网络组属性 | |
图层属性 | |
网络类属性 | |
网络属性 | |
焊盘对组属性 | |
焊盘对最短导线长度属性 | |
物理叠层配置 | |
PCB 图元 | |
PCB 图元接口 | |
焊盘热焊优化参数 | |
覆铜填充区域 | |
阻焊/助焊扩展 | |
基板物理属性 | |
原始数据 - net | |
原始数据 - pureSchematic | |
原始数据 - schematic | |
原始数据 - wire | |
DRC 错误条目 | |
DRC 错误涉及的图元 | |
网络属性 | |
原理图图元 | |
原理图图元接口 | |
工程网络属性 | |
导线属性 | |
文件系统文件路径 | |
顶部菜单项 | |
顶部二级菜单项 | |
顶部三级菜单项 | |
顶部一级菜单项 | |
日志行 | |
BBox(最小外接矩形) | |
离散点 | |
带孔洞的多边形 | |
消息总线任务 | |
多语言数据 | |
PCB 对比响应 | |
右键菜单项 | |
快捷键数据 | |
包含 CallFn 的快捷键数据 | |
包含 userDefinedShortcutKey 的快捷键数据 | |
窗口事件监听可移除对象 | |
列表项:支持多级嵌套分组 | |
列表组件:支持多级嵌套、图标、展开的列表 | |
模态弹窗:可拖拽、可调整大小的顶层弹窗 | |
单选组组件:一组互斥的单选选项 | |
单选组中的单个选项 | |
滚动组件:虚拟滚动列表,仅渲染可见行 | |
下拉选项:支持多级嵌套分组 | |
下拉选择器:基于输入框的下拉选择控件 | |
插槽组件:为父组件提供具名内容占位 | |
通用样式属性:可被布局容器等组件继承的样式集合 | |
多行文本输入组件 | |
文本组件:静态文本展示 |
Variables
Variable | Description |
|---|---|
Type Aliases
Type Alias | Description |
|---|---|
语言数据键值对 | |
可选中图层 | |
器件所属层 | |
铜箔所属层 | |
自定义层 | |
尺寸标注所属层 | |
填充所属层 | |
复杂多边形图(SVG 图像、文本)所属层 | |
内层 | |
线所属层 | |
二进制内嵌对象所属层 | |
焊盘所属层 | |
区域所属层 | |
内层允许设置的图层类型 | |
铜箔层数 | |
单多边形源数组 | |
尺寸标注坐标集 | |
焊盘钻孔 | |
焊盘外形 | |
特殊焊盘外形 | |
多边形组 | |
多边形输入类型 | |
PCB 对比失败错误码 | |
快捷键按键 |