Skip to content

Latest commit

 

History

History
333 lines (312 loc) · 26 KB

File metadata and controls

333 lines (312 loc) · 26 KB

EasyEDA Pro API 文档索引

此文档由构建脚本自动生成,供 AI 编程工具使用。 全局变量 eda 是 EDA 类的实例,所有 API 通过 eda.xxx 调用。

快速导航

  • classes/ - 类文档(包含全部方法和属性)
  • enums/ - 枚举文档
  • interfaces/ - 接口文档(包含全部属性)
  • types/ - 类型别名文档

API 访问方式

所有 API 通过全局变量 eda 访问,例如:

  • eda.dmt_Board.createBoard() — 文档树 / 板子管理
  • eda.pcb_PrimitiveLine.create() — PCB 直线图元创建
  • eda.sys_WebSocket.register() — WebSocket 连接注册
  • eda.sch_PrimitiveComponent.create() — 原理图器件创建

类 (Classes)

类名 描述 备注
DMT_Board 文档树 / 板子管理类
DMT_EditorControl 文档树 / 编辑器控制类
DMT_Folder 文档树 / 文件夹类
DMT_Panel 文档树 / 面板管理类
DMT_Pcb 文档树 / PCB 管理类
DMT_Project 文档树 / 工程管理类
DMT_Schematic 文档树 / 原理图管理类
DMT_SelectControl 文档树 / 选择控制类
DMT_Team 文档树 / 团队类
DMT_Workspace 文档树 / 工作区类
EDA 嘉立创 EDA 专业版用户 API 接口
IPCB_ComplexPolygon 复杂多边形
IPCB_Polygon 单多边形
IPCB_PrimitiveArc 圆弧线图元
IPCB_PrimitiveAttribute 属性图元
IPCB_PrimitiveComponent 器件图元
IPCB_PrimitiveComponentPad 器件焊盘图元
IPCB_PrimitiveDimension 尺寸标注图元
IPCB_PrimitiveFill 填充图元
IPCB_PrimitiveImage 图像图元
IPCB_PrimitiveLine 直线图元
IPCB_PrimitiveObject 二进制内嵌对象图元
IPCB_PrimitivePad 焊盘图元
IPCB_PrimitivePolyline 折线图元
IPCB_PrimitivePour 覆铜边框图元
IPCB_PrimitivePoured 覆铜填充图元
IPCB_PrimitiveRegion 区域图元
IPCB_PrimitiveString 文本图元
IPCB_PrimitiveVia 过孔图元
ISCH_PrimitiveArc 圆弧图元
ISCH_PrimitiveAttribute 属性图元
ISCH_PrimitiveBus 总线图元
ISCH_PrimitiveCbbSymbolComponent 复用模块符号图元
ISCH_PrimitiveCircle 圆图元
ISCH_PrimitiveComponent 器件图元
ISCH_PrimitiveComponentPin 器件引脚图元
ISCH_PrimitivePin 引脚图元
ISCH_PrimitivePolygon 多边形(折线)图元
ISCH_PrimitiveRectangle 矩形图元
ISCH_PrimitiveText 文本图元
ISCH_PrimitiveWire 导线图元
LIB_3DModel 综合库 / 3D 模型类
LIB_Cbb 综合库 / 复用模块类
LIB_Classification 综合库 / 库分类索引类
LIB_Device 综合库 / 器件类
LIB_Footprint 综合库 / 封装类
LIB_LibrariesList 综合库 / 库列表类
LIB_PanelLibrary 综合库 / 面板库类
LIB_SelectControl 综合库 / 选择控制类
LIB_Symbol 综合库 / 符号类
PCB_Document PCB & 封装 / 文档操作类
PCB_Drc PCB & 封装 / 设计规则检查(DRC)类
PCB_Event PCB & 封装 / 事件类
PCB_Layer PCB & 封装 / 图层操作类
PCB_ManufactureData PCB & 封装 / 生产资料类
PCB_MathPolygon PCB & 封装 / 多边形数学类
PCB_Net PCB & 封装 / 网络类
PCB_Primitive PCB & 封装 / 图元类
PCB_PrimitiveArc PCB & 封装 / 圆弧线图元类
PCB_PrimitiveAttribute PCB & 封装 / 属性图元类
PCB_PrimitiveComponent PCB & 封装 / 器件图元类
PCB_PrimitiveDimension PCB & 封装 / 尺寸标注图元类
PCB_PrimitiveFill PCB & 封装 / 填充图元类
PCB_PrimitiveImage PCB & 封装 / 图像图元类
PCB_PrimitiveLine PCB & 封装 / 直线图元类
PCB_PrimitiveObject PCB & 封装 / 二进制内嵌对象图元类
PCB_PrimitivePad PCB & 封装 / 焊盘图元类
PCB_PrimitivePolyline PCB & 封装 / 折线图元类
PCB_PrimitivePour PCB & 封装 / 覆铜边框图元类
PCB_PrimitivePoured PCB & 封装 / 覆铜填充图元类
PCB_PrimitiveRegion PCB & 封装 / 禁止区域和约束区域图元类
PCB_PrimitiveString PCB & 封装 / 文本图元类
PCB_PrimitiveVia PCB & 封装 / 过孔图元类
PCB_RayTracerEngine PCB & 封装 / 光线追踪引擎类
PCB_SelectControl PCB & 封装 / 选择控制类
PNL_Document 面板 / 文档操作类
SCH_Document 原理图 & 符号 / 文档操作类
SCH_Drc 原理图 & 符号 / 设计规则检查(DRC)类
SCH_Event 原理图 & 符号 / 事件类
SCH_ManufactureData 原理图 & 符号 / 生产资料类
SCH_Net 原理图 & 符号 / 网络类
SCH_Netlist 原理图 & 符号 / 网表类
SCH_Primitive 原理图 & 符号 / 图元类
SCH_PrimitiveArc 原理图 & 符号 / 圆弧图元类
SCH_PrimitiveAttribute 原理图 & 符号 / 属性图元类
SCH_PrimitiveBus 原理图 & 符号 / 总线图元类
SCH_PrimitiveCircle 原理图 & 符号 / 圆图元类
SCH_PrimitiveComponent 原理图 & 符号 / 器件图元类
SCH_PrimitiveObject 原理图 & 符号 / 二进制内嵌对象图元类
SCH_PrimitivePin 原理图 & 符号 / 引脚图元类
SCH_PrimitivePolygon 原理图 & 符号 / 多边形(折线)图元类
SCH_PrimitiveRectangle 原理图 & 符号 / 矩形图元类
SCH_PrimitiveText 原理图 & 符号 / 文本图元类
SCH_PrimitiveWire 原理图 & 符号 / 导线图元类
SCH_SelectControl 原理图 & 符号 / 选择控制类
SCH_SimulationEngine 原理图 & 符号 / 仿真引擎类
SCH_Utils 原理图 & 符号 / 工具类
SYS_ClientUrl 系统 / 外部请求类
SYS_Dialog 系统 / 对话框类
SYS_Environment 系统 / 运行环境类
SYS_FileManager 系统 / 文件管理类
SYS_FileSystem 系统 / 文件系统交互类
SYS_FontManager 系统 / 字体管理类
SYS_FormatConversion 系统 / 格式转换(Chameleon)类
SYS_HeaderMenu 系统 / 顶部菜单类
SYS_I18n 系统 / 多语言类
SYS_IFrame 系统 / 内联框架窗口类
SYS_LoadingAndProgressBar 系统 / 加载与进度条类
SYS_Log 系统 / 日志类
SYS_Message 系统 / 消息通知类
SYS_MessageBox 系统 / 消息框类
SYS_MessageBus 系统 / 消息总线类
SYS_PanelControl 系统 / 面板控制类
SYS_RightClickMenu 系统 / 右键菜单类
SYS_Setting 系统 / 设置类
SYS_ShortcutKey 系统 / 快捷键类
SYS_Storage 系统 / 存储类
SYS_Timer 系统 / 定时器类
SYS_ToastMessage 系统 / 吐司消息类
SYS_Tool 系统 / 工具类
SYS_Unit 系统 / 单位类
SYS_WebSocket 系统 / WebSocket 类
SYS_Window 系统 / 窗口类

枚举 (Enumerations)

枚举名 描述 备注
EDMT_EditorDocumentType 编辑器文档类型
EDMT_EditorSplitScreenDirection 编辑器分屏方向
EDMT_IndicatorMarkerType 指示标记类型
EDMT_ItemType 文档树项目类型
EDMT_ProjectCollaborationMode 工程协作模式
ELIB_DeviceJlcLibraryCategory 嘉立创贴片库类别
ELIB_LibraryType 综合库库类型
ELIB_PreviewType 预览视图类型
ELIB_SymbolType 符号类型
EPCB_DocumentRatlineCalculatingActiveStatus 文档飞线计算功能状态
EPCB_InactiveLayerDisplayMode 非激活层展示模式
EPCB_LayerColorConfiguration 图层颜色配置
EPCB_LayerId 图层 ID
EPCB_LayerStatus 层状态
EPCB_LayerType 图层类型
EPCB_PcbPlateType PCB 板材类型
EPCB_PdfOutputMethod PDF 输出方式
EPCB_PrimitiveArcInteractiveMode 圆弧交互模式
EPCB_PrimitiveDimensionType 尺寸标注类型
EPCB_PrimitiveFillMode 填充图元填充模式
EPCB_PrimitivePadHeatWeldingConnectionMethod 焊盘热焊连接方式
EPCB_PrimitivePadHoleType 焊盘钻孔类型
EPCB_PrimitivePadShapeType 焊盘外形种类
EPCB_PrimitivePadType 焊盘类型
EPCB_PrimitivePourFillMethod 覆铜填充方法
EPCB_PrimitiveRegionRuleType 区域图元区域规则类型
EPCB_PrimitiveStringAlignMode 文本对齐模式
EPCB_PrimitiveType 图元类型
EPCB_PrimitiveViaType 过孔类型
ESCH_DynamicSimulationEnginePullEventType 动态仿真引擎拉取事件类型
ESCH_DynamicSimulationEnginePushEventType 动态仿真引擎推送事件类型
ESCH_ExportDocumentFileType 导出文档文件类型
ESCH_MouseEventType 鼠标事件类型
ESCH_PrimitiveComponentType 器件类型
ESCH_PrimitiveEventType 图元事件类型
ESCH_PrimitiveFillStyle 填充样式
ESCH_PrimitiveLineType 线型
ESCH_PrimitivePinShape 引脚形状
ESCH_PrimitivePinType 引脚类型
ESCH_PrimitiveTextAlignMode 文本对齐模式
ESCH_PrimitiveType 图元类型
ESCH_ShapeType 图元类型
ESCH_SimulationNetlistType 仿真网表类型
ESCH_SpiceSimulationEnginePullEventType Spice 仿真引擎拉取事件类型
ESCH_SpiceSimulationEnginePushEventType Spice 仿真引擎推送事件类型
ESYS_BottomPanelTab 底部面板标签页
ESYS_HeaderMenuEnvironment 顶部菜单环境
ESYS_ImportProjectBoardOutlineSource 导入工程板边框来源
ESYS_ImportProjectImportOption 导入工程导入选项
ESYS_ImportProjectSchematicObjectStyle 导入工程原理图图元样式
ESYS_ImportProjectViaSolderMaskExpansion 导入工程过孔阻焊扩展
ESYS_LeftPanelTab 左侧面板标签页
ESYS_LogType 日志类型
ESYS_NetlistType 网表类型
ESYS_RightPanelTab 右侧面板标签页
ESYS_ShortcutKeyEffectiveEditorDocumentType 快捷键生效页面范围
ESYS_ShortcutKeyEffectiveEditorScene 快捷键生效场景范围
ESYS_Theme 主题
ESYS_ToastMessageType 吐司消息类型
ESYS_Unit 单位
ESYS_WindowEventType 窗口事件类型
ESYS_WindowOpenTarget 打开窗口上下文目标

接口 (Interfaces)

接口名 描述 备注
IDMT_BoardItem 板子属性
IDMT_BriefProjectItem 简略工程属性
IDMT_EditorDocumentItem 编辑器文档对象
IDMT_EditorSplitScreenItem 编辑器分屏属性
IDMT_EditorTabItem 编辑器标签页
IDMT_FolderItem 文件夹属性
IDMT_IndicatorMarkerShape 指示标记外形
IDMT_PanelItem 面板属性
IDMT_PcbItem PCB 属性
IDMT_ProjectItem 工程属性
IDMT_SchematicItem 原理图属性
IDMT_SchematicPageItem 原理图图页属性
IDMT_TeamItem 团队属性
IDMT_WorkspaceItem 工作区属性
ILIB_3DModelItem 3D 模型属性
ILIB_3DModelSearchItem 搜索到的 3D 模型属性
ILIB_CbbItem 复用模块属性
ILIB_CbbSearchItem 搜索到的复用模块属性
ILIB_ClassificationIndex 分类索引
ILIB_DeviceAssociationItem 器件关联符号、封装属性
ILIB_DeviceExtendPropertyItem 器件扩展属性
ILIB_DeviceItem 器件属性
ILIB_DeviceSearchItem 搜索到的器件属性
ILIB_ExtendLibrary3DModelFunctions 外部库 3D 模型方法
ILIB_ExtendLibraryCbbFunctions 外部库复用模块方法
ILIB_ExtendLibraryClassificationIndex 外部库分类索引
ILIB_ExtendLibraryDeviceFunctions 外部库器件方法
ILIB_ExtendLibraryFootprintFunctions 外部库封装方法
ILIB_ExtendLibraryFunctions 外部库方法
ILIB_ExtendLibraryItem 外部库元素
ILIB_ExtendLibraryItemIndex 外部库元素索引
ILIB_ExtendLibrarySearchProperty 外部库搜索参数
ILIB_ExtendLibrarySearchResult 外部库搜索结果
ILIB_ExtendLibrarySearchResultDataLine 外部库搜索结果数据行
ILIB_ExtendLibrarySymbolFunctions 外部库符号方法
ILIB_ExtendLibraryUserIndex 外部库用户索引
ILIB_FootprintItem 封装属性
ILIB_FootprintSearchItem 搜索到的封装属性
ILIB_LibraryInfo 库信息
ILIB_LibraryItem 库属性
ILIB_PanelLibraryItem 面板库属性
ILIB_PanelLibrarySearchItem 搜索到的面板库属性
ILIB_SymbolItem 符号属性
ILIB_SymbolSearchItem 搜索到的符号属性
IPCB_BomPropertiesTableColumns BOM 列的属性及排序规则
IPCB_DifferentialPairItem 差分对属性
IPCB_EqualLengthNetGroupItem 等长网络组属性
IPCB_LayerItem 图层属性
IPCB_NetClassItem 网络类属性
IPCB_NetInfo 网络属性
IPCB_PadPairGroupItem 焊盘对组属性
IPCB_PadPairMinWireLengthItem 焊盘对最短导线长度属性
IPCB_Primitive PCB 图元
IPCB_PrimitiveAPI PCB 图元接口
IPCB_PrimitivePouredPourFill 覆铜填充区域
IPCB_PrimitiveSolderMaskAndPasteMaskExpansion 阻焊/助焊扩展
ISCH_NetInfo 网络属性
ISCH_Primitive 原理图图元
ISCH_PrimitiveAPI 原理图图元接口
ISCH_ProjectNetInfo 工程网络属性
ISCH_WireInfo 导线属性
ISYS_FileSystemFileList 文件系统文件路径
ISYS_HeaderMenus 顶部菜单项
ISYS_HeaderMenuSub1MenuItem 顶部二级菜单项
ISYS_HeaderMenuSub2MenuItem 顶部三级菜单项
ISYS_HeaderMenuTopMenuItem 顶部一级菜单项
ISYS_LanguageKeyValuePairs 语言数据键值对
ISYS_LogLine 日志行
ISYS_MessageBusTask 消息总线任务
ISYS_MultilingualLanguagesData 多语言数据
ISYS_ReactComponentizationDialogInterface (ALPHA) React 组件化弹出窗口接口
ISYS_ReactComponentizationDialogReactInstance (ALPHA) React 实例接口 用于接收扩展的 React 实例
ISYS_ReactComponentizationDialogReconcilerInstance (ALPHA) React Reconciler 实例接口 用于接收扩展的 react-reconciler 实例
ISYS_ReactComponentizationDialogVirtualRender (ALPHA) VirtualRender 类接口 用于在虚拟环境中渲染 React 组件
ISYS_ReactComponentizationDialogWorkerPortal (ALPHA) WorkerPortal 类接口 用于管理组件的生命周期和事件处理
ISYS_RightClickMenuItem 右键菜单项
ISYS_WindowEventListenerRemovableObject 窗口事件监听可移除对象

类型别名 (Type Aliases)

类型名 描述 备注
LC_DESIGN_COMPONENTS
TPCB_LayersInTheSelectable 可选中图层
TPCB_LayersOfComponent 器件所属层
TPCB_LayersOfCopper 铜箔所属层
TPCB_LayersOfCustom 自定义层
TPCB_LayersOfDimension 尺寸标注所属层
TPCB_LayersOfFill 填充所属层
TPCB_LayersOfImage 复杂多边形图(SVG 图像、文本)所属层
TPCB_LayersOfInner 内层
TPCB_LayersOfLine 线所属层
TPCB_LayersOfObject 二进制内嵌对象所属层
TPCB_LayersOfPad 焊盘所属层
TPCB_LayersOfRegion 区域所属层
TPCB_LayerTypesOfInnerLayer 内层允许设置的图层类型
TPCB_PolygonSourceArray 单多边形源数组
TPCB_PrimitiveDimensionCoordinateSet 尺寸标注坐标集
TPCB_PrimitivePadHole 焊盘钻孔
TPCB_PrimitivePadShape 焊盘外形
TPCB_PrimitiveSpecialPadShape 特殊焊盘外形
TSYS_ShortcutKeys 快捷键按键