Extension API Reference

Classes

Class	Description
DMT_Board	Document tree / Board management class
DMT_EditorControl	Document tree / Editor control class
DMT_Event	Document tree / event class
DMT_Folder	Document tree / Folder class
DMT_Panel	Document tree / Panel management class
DMT_Pcb	Document tree / PCB management class
DMT_Project	Document tree / Project management class
DMT_Schematic	Document tree / Schematic management class
DMT_SelectControl	Document tree / selection control class
DMT_Team	Document tree / Team class
DMT_Workspace	Document tree / Workspace class
EDA	EasyEDA Pro user API interface
IPCB_ComplexPolygon	Complex polygon
IPCB_Polygon	Single polygon
IPCB_PrimitiveArc	Arc line primitive
IPCB_PrimitiveAttribute	Property primitive
IPCB_PrimitiveComponent	Device primitive
IPCB_PrimitiveComponentPad	Device pad primitive
IPCB_PrimitiveDimension	Dimension primitive
IPCB_PrimitiveFill	Fill primitive
IPCB_PrimitiveImage	Image primitive
IPCB_PrimitiveLine	Line primitive
IPCB_PrimitiveObject	Binary embedded object primitive
IPCB_PrimitivePad	Pad primitive
IPCB_PrimitivePolyline	Polyline primitive
IPCB_PrimitivePour	Copper border primitive
IPCB_PrimitivePoured	Copper fill primitive
IPCB_PrimitiveRegion	Region primitive
IPCB_PrimitiveString	Text primitive
IPCB_PrimitiveVia	Via primitive
ISCH_PrimitiveArc	Arc primitive
ISCH_PrimitiveAttribute	Property primitive
ISCH_PrimitiveBus	Bus primitive
ISCH_PrimitiveCbbSymbolComponent	Reuse block symbol primitive
ISCH_PrimitiveCircle	Circle primitive
ISCH_PrimitiveComponent	Device primitive
ISCH_PrimitiveComponentPin	Device pin primitive
ISCH_PrimitiveObject	Binary embedded object primitive
ISCH_PrimitivePin	Pin primitive
ISCH_PrimitivePolygon	Polygon (polyline) primitive
ISCH_PrimitiveRectangle	Rectangle primitive
ISCH_PrimitiveText	Text primitive
ISCH_PrimitiveWire	Wire primitive
LIB_3DModel	Comprehensive library / 3D model class
LIB_Cbb	Comprehensive library / reuse block class
LIB_Classification	Comprehensive library / library classification index class
LIB_Device	Comprehensive library / device class
LIB_Footprint	Comprehensive library / footprint class
LIB_LibrariesList	Comprehensive library / library list class
LIB_PanelLibrary	Comprehensive library / panel library class
LIB_SelectControl	Comprehensive library / selection control class
LIB_SimulationModel	Comprehensive library / simulation model class
LIB_Symbol	Comprehensive library / symbol class
PCB_Document	PCB & footprint / document operation class
PCB_Drc	PCB & footprint / design rule check (DRC) class
PCB_Event	PCB & footprint / event class
PCB_Layer	PCB & footprint / layer operation class
PCB_ManufactureData	PCB & footprint / manufacture data class
PCB_MathPolygon	PCB & footprint / polygon math class
PCB_Net	PCB & footprint / net class
PCB_Primitive	PCB & footprint / primitive class
PCB_PrimitiveArc	PCB & footprint / arc line primitive class
PCB_PrimitiveAttribute	PCB & footprint / property primitive class
PCB_PrimitiveComponent	PCB & footprint / device primitive class
PCB_PrimitiveDimension	PCB & footprint / dimension primitive class
PCB_PrimitiveFill	PCB & footprint / fill primitive class
PCB_PrimitiveImage	PCB & footprint / image primitive class
PCB_PrimitiveLine	PCB & footprint / line primitive class
PCB_PrimitiveObject	PCB & footprint / binary embedded object primitive class
PCB_PrimitivePad	PCB & footprint / pad primitive class
PCB_PrimitivePolyline	PCB & footprint / polyline primitive class
PCB_PrimitivePour	PCB & footprint / copper border primitive class
PCB_PrimitivePoured	PCB & footprint / copper fill primitive class
PCB_PrimitiveRegion	PCB & footprint / forbidden region and constrained region primitive class
PCB_PrimitiveString	PCB & footprint / text primitive class
PCB_PrimitiveVia	PCB & footprint / via primitive class
PCB_RayTracerEngine	PCB & footprint / ray tracer engine class
PCB_SelectControl	PCB & footprint / selection control class
PNL_Document	Panel / document operation class
SCH_Document	Schematic & symbol / document operation class
SCH_Drc	Schematic & symbol / design rule check (DRC) class
SCH_Event	Schematic & symbol / event class
SCH_ManufactureData	Schematic & symbol / manufacture data class
SCH_Net	Schematic & symbol / net class
SCH_Netlist	Schematic & symbol / netlist class
SCH_Primitive	Schematic & symbol / primitive class
SCH_PrimitiveArc	Schematic & symbol / arc primitive class
SCH_PrimitiveAttribute	Schematic & symbol / property primitive class
SCH_PrimitiveBus	Schematic & symbol / bus primitive class
SCH_PrimitiveCircle	Schematic & symbol / circle primitive class
SCH_PrimitiveComponent	Schematic & symbol / device primitive class
SCH_PrimitiveObject	Schematic & symbol / binary embedded object primitive class
SCH_PrimitivePin	Schematic & symbol / pin primitive class
SCH_PrimitivePolygon	Schematic & symbol / polygon (polyline) primitive class
SCH_PrimitiveRectangle	Schematic & symbol / rectangle primitive class
SCH_PrimitiveText	Schematic & symbol / text primitive class
SCH_PrimitiveWire	Schematic & symbol / wire primitive class
SCH_SelectControl	Schematic & symbol / selection control class
SCH_SimulationEngine	Schematic & symbol / simulation engine class
SCH_Utils	Schematic & symbol / utility class
SYS_ClientUrl	System / external request class
SYS_Dialog	System / dialog class
SYS_Environment	System / runtime environment class
SYS_FileManager	System / file manager class
SYS_FileSystem	System / file system interaction class
SYS_FontManager	System / font manager class
SYS_FormatConversion	System / format conversion (Chameleon) class
SYS_HeaderMenu	System / header menu class
SYS_I18n	System / multilingual class
SYS_IFrame	System / iframe window class
SYS_LoadingAndProgressBar	System / loading and progress bar class
SYS_Log	System / log class
SYS_Math	System / math class
SYS_Message	System / message notification class
SYS_MessageBox	System / message box class
SYS_MessageBus	System / message bus class
SYS_PanelControl	System / panel control class
SYS_RightClickMenu	System / right-click menu class
SYS_Setting	System / settings class
SYS_ShortcutKey	System / shortcut key class
SYS_Storage	System / storage class
SYS_Timer	System / timer class
SYS_ToastMessage	System / toast message class
SYS_Tool	System / tool class
SYS_Unit	System / unit class
SYS_WebSocket	System / WebSocket class
SYS_Window	System / window class

Enumerations

Enumeration	Description
EDMT_EditorDocumentType	Editor document type
EDMT_EditorSplitScreenDirection	Editor split screen direction
EDMT_EditorTabEventType	Editor tab event type
EDMT_IndicatorMarkerType	Indicator marker type
EDMT_ItemType	Document tree project type
EDMT_ProjectCollaborationMode	Project collaboration mode
ELIB_DeviceJlcLibraryCategory	EasyEDA SMT library category
ELIB_LibraryType	Comprehensive library library type
ELIB_PreviewType	Preview view type
ELIB_SimulationModelType	Simulation model type
ELIB_SymbolType	Symbol type
EPCB_AutoRoutingCornerStyle	Auto routing corner style
EPCB_AutoRoutingExistingPrimitiveMode	How auto routing handles existing wires/vias
EPCB_AutoRoutingOptimization	Auto routing optimization priority
EPCB_DocumentCanvasUpdateCalculationActiveStatus	Canvas update calculation function status
EPCB_DocumentRatlineCalculatingActiveStatus	Document ratline calculation function status
EPCB_InactiveLayerDisplayMode	Inactive layer display mode
EPCB_LayerColorConfiguration	Layer color configuration
EPCB_LayerId	Layer ID
EPCB_LayerStatus	Layer status
EPCB_LayerType	Layer type
EPCB_MouseEventType	Mouse event type
EPCB_NetEventType	Net event type
EPCB_PcbPlateType	PCB plate type
EPCB_PdfOutputMethod	PDF output method
EPCB_PrimitiveArcInteractiveMode	Arc interaction mode
EPCB_PrimitiveDimensionType	Dimension type
EPCB_PrimitiveEventType	Primitive event type
EPCB_PrimitiveFillMode	Fill primitive fill mode
EPCB_PrimitivePadHeatWeldingConnectionMethod	Pad heat welding connection method
EPCB_PrimitivePadHoleType	Pad drilling type
EPCB_PrimitivePadShapeType	Pad shape type
EPCB_PrimitivePadType	Pad type
EPCB_PrimitivePourFillMethod	Copper fill method
EPCB_PrimitiveRegionRuleType	Region primitive region rule type
EPCB_PrimitiveStringAlignMode	Text alignment mode
EPCB_PrimitiveType	Primitive type
EPCB_PrimitiveViaType	Via type
ESCH_DynamicSimulationEnginePullEventType	Dynamic simulation engine pull event type
ESCH_DynamicSimulationEnginePushEventType	Dynamic simulation engine push event type
ESCH_ExportDocumentFileType	Export document file type
ESCH_MouseEventType	Mouse event type
ESCH_PrimitiveComponentType	Device type
ESCH_PrimitiveEventType	Primitive event type
ESCH_PrimitiveFillStyle	Fill style
ESCH_PrimitiveLineType	Line type
ESCH_PrimitivePinShape	Pin shape
ESCH_PrimitivePinType	Pin type
ESCH_PrimitiveTextAlignMode	Text alignment mode
ESCH_PrimitiveType	Primitive type
ESCH_SimulationNetlistType	Simulation netlist type
ESCH_SpiceSimulationEnginePullEventType	Spice simulation engine pull event type
ESCH_SpiceSimulationEnginePushEventType	Spice simulation engine push event type
ESYS_BottomPanelTab	Bottom panel tab
ESYS_HeaderMenuEnvironment	Header menu environment
ESYS_ImportProjectBoardOutlineSource	Import project board outline source
ESYS_ImportProjectImportOption	Import project import option
ESYS_ImportProjectSchematicObjectStyle	Import project schematic primitive style
ESYS_ImportProjectViaSolderMaskExpansion	Import project via solder mask extension
ESYS_LeftPanelTab	Left panel tab
ESYS_LogType	Log type
ESYS_NetlistType	Netlist type
ESYS_RightPanelTab	Right panel tab
ESYS_ShortcutKeyEffectiveEditorRange	Effective page range of the shortcut key
ESYS_ShortcutKeyEffectiveEditorScene	Effective scene range of the shortcut key
ESYS_StartPageQuickStartItem	Start page quick start item
ESYS_Theme	Theme
ESYS_ToastMessageType	Toast message type
ESYS_Unit	Unit
ESYS_WindowEventType	Window event type
ESYS_WindowOpenTarget	Open window context target
NetportDeviceName	网络端口符号对应的器件名称
SchToolBarDeviceName	悬浮框特殊符号对应的器件名称

Interfaces

Interface	Description
BoardProps	分组面板：带标题的可折叠/分组容器
ButtonProps	按钮组件：可点击触发的操作按钮
CheckBoxProps	复选框组件：可勾选的状态控件
ComponentPropsMap	Component name → Props type mapping, serving as the sole source of the createComponent generic constraint
DialogProps	对话框组件：带标题栏、可拖拽缩放的组合弹窗
FlexItemProps	Flex 子项：Flex 布局中的单个子元素
FlexProps	布局容器：灵活的 Flex 布局容器
GridItemProps	Grid 子项：网格中的单个子元素
GridProps	布局容器：固定列数的网格布局容器
IconProps	图标配置：通过 URL 或 CSS class 指定图标
IDesignPortal	Component tree operation contract.
IDMT_BoardItem	Board property
IDMT_BriefProjectItem	Brief project properties
IDMT_EditorDocumentItem	Editor document object
IDMT_EditorSplitScreenItem	Editor split screen property
IDMT_EditorTabItem	Editor tab
IDMT_FolderItem	Folder property
IDMT_IndicatorMarkerShape	Indicator marker shape
IDMT_PanelItem	Panel property
IDMT_PcbItem	PCB property
IDMT_ProjectItem	Project property
IDMT_SchematicItem	Schematic property
IDMT_SchematicPageItem	Schematic sheet property
IDMT_TeamItem	Team properties
IDMT_WorkspaceItem	Workspace properties
ILIB_3DModelItem	3D model property
ILIB_3DModelSearchItem	Searched 3D model properties
ILIB_CbbItem	Reuse block property
ILIB_CbbSearchItem	Searched reuse block properties
ILIB_ClassificationIndex	Classification index
ILIB_DeviceAssociationItem	Device associated symbol, footprint property
ILIB_DeviceExtendPropertyItem	Device extension property
ILIB_DeviceItem	Device property
ILIB_DevicePropertiesForSearch	Device parameters that can be used for precise search
ILIB_DeviceSearchItem	Searched device properties
ILIB_ExtendLibrary3DModelFunctions	External library 3D model functions
ILIB_ExtendLibraryCbbFunctions	External library reuse block functions
ILIB_ExtendLibraryClassificationIndex	External library classification index
ILIB_ExtendLibraryDeviceFunctions	External library device functions
ILIB_ExtendLibraryFootprintFunctions	External library footprint functions
ILIB_ExtendLibraryFunctions	External library functions
ILIB_ExtendLibraryItem	External library item
ILIB_ExtendLibraryItemIndex	External library item index
ILIB_ExtendLibrarySearchProperty	External library search property
ILIB_ExtendLibrarySearchResult	External library search result
ILIB_ExtendLibrarySearchResultDataLine	External library search result data line
ILIB_ExtendLibrarySymbolFunctions	External library symbol functions
ILIB_ExtendLibraryUserIndex	External library user index
ILIB_FootprintItem	Footprint property
ILIB_FootprintPropertiesForSearch	Footprint parameters that can be used for precise search
ILIB_FootprintSearchItem	Searched footprint properties
ILIB_LibraryInfo	Library information
ILIB_LibraryItem	Library property
ILIB_PanelLibraryItem	Panel library property
ILIB_PanelLibrarySearchItem	Searched panel library properties
ILIB_SimulationModelItem	Simulation model properties
ILIB_SimulationModelSearchItem	Searched simulation model properties
ILIB_SymbolItem	Symbol property
ILIB_SymbolPropertiesForSearch	Symbol parameters that can be used for precise search
ILIB_SymbolSearchItem	Searched symbol properties
ImageProps	图片组件：展示单张图片
InputProps	输入框组件：支持下拉、搜索、清除、前后缀等多种形态
IPCB_AutoLayoutResult	Auto layout result
IPCB_AutoRoutingProps	Auto routing props
IPCB_AutoRoutingResult	Auto routing result
IPCB_BomPropertiesTableColumns	BOM column properties and sorting rules
IPCB_DifferentialPairItem	Differential pair properties
IPCB_DiscretizedPoint	Discretized point
IPCB_DiscretizeOptions	Discretization options
IPCB_EqualLengthNetGroupItem	Equal-length net group properties
IPCB_LayerItem	Layer properties
IPCB_NetClassItem	Net class property
IPCB_NetInfo	Net property
IPCB_PadPairGroupItem	Pad pair group properties
IPCB_PadPairMinWireLengthItem	Pad pair minimum wire length properties
IPCB_PhysicalStackingConfiguration	Physical stacking configuration
IPCB_Primitive	PCB primitive
IPCB_PrimitiveAPI	PCB primitive API
IPCB_PrimitivePadHeatWelding	Pad thermal relief optimization parameters
IPCB_PrimitivePouredPourFill	Copper fill region
IPCB_PrimitiveSolderMaskAndPasteMaskExpansion	Solder mask / paste mask expansion
IPCB_SubstratePhysicalProperties	Substrate physical properties
IRawNet	Raw data - net
IRawPureSchematic	Raw data - pureSchematic
IRawSchematic	Raw data - schematic
IRawWire	Raw data - wire
ISCH_DrcError	DRC error item
ISCH_DrcErrorPrimitive	Primitive involved in a DRC error
ISCH_ExportPngResolution	原理图导出图片分辨率
ISCH_NetInfo	Net property
ISCH_Primitive	Schematic primitive
ISCH_PrimitiveAPI	Schematic primitive API
ISCH_ProjectNetInfo	Project net property
ISCH_WireInfo	Wire property
ISYS_FileSystemFileList	File system file path
ISYS_HeaderMenus	Header menu item
ISYS_HeaderMenuSub1MenuItem	Top-level secondary menu item
ISYS_HeaderMenuSub2MenuItem	Top-level tertiary menu item
ISYS_HeaderMenuTopMenuItem	Top-level primary menu item
ISYS_LogLine	Log line
ISYS_MathBBox	BBox (minimum bounding rectangle)
ISYS_MathPoint	Discrete points
ISYS_MathPolygonWithHoles	Polygon with holes
ISYS_MessageBusTask	Message bus task
ISYS_MultilingualLanguagesData	Multilingual data
ISYS_PcbComparisonResponse	PCB comparison response
ISYS_RightClickMenuItem	Right-click menu item
ISYS_ShortcutKeyData	Shortcut key data
ISYS_ShortcutKeyDataWithCallFn	Shortcut key data with CallFn
ISYS_ShortcutKeyDataWithUserDefinedShortcutKey	Shortcut key data with userDefinedShortcutKey
ISYS_WindowEventListenerRemovableObject	Window event listener can remove object
ListChildren	列表项：支持多级嵌套分组
ListProps	列表组件：支持多级嵌套、图标、展开的列表
ModalProps	模态弹窗：可拖拽、可调整大小的顶层弹窗
RadioGroupProps	单选组组件：一组互斥的单选选项
RadioItem	单选组中的单个选项
ScrollerProps	滚动组件：虚拟滚动列表，仅渲染可见行
SelectListItem	下拉选项：支持多级嵌套分组
SelectProps	下拉选择器：基于输入框的下拉选择控件
SlotProps	插槽组件：为父组件提供具名内容占位
StyleProps	通用样式属性：可被布局容器等组件继承的样式集合
TextAreaProps	多行文本输入组件
TextProps	文本组件：静态文本展示

Variables

Variable	Description
eda

Type Aliases

Type Alias	Description
ISYS_LanguageKeyValuePairs	Language data key value for
TPCB_LayersInTheSelectable	Selectable layers
TPCB_LayersOfComponent	Layers of the device
TPCB_LayersOfCopper	Layers of copper
TPCB_LayersOfCustom	Custom layers
TPCB_LayersOfDimension	Layers of the dimension
TPCB_LayersOfFill	Layers of the fill
TPCB_LayersOfImage	Layers of complex polygon figures (SVG images, text)
TPCB_LayersOfInner	Inner layers
TPCB_LayersOfLine	Layers of the line
TPCB_LayersOfObject	Layers of binary embedded objects
TPCB_LayersOfPad	Layers of the pad
TPCB_LayersOfRegion	Layers of the region
TPCB_LayerTypesOfInnerLayer	Layer types allowed to be set for inner layers
TPCB_NumberOfCopperLayers	Number of copper layers
TPCB_PolygonSourceArray	Single polygon source array
TPCB_PrimitiveDimensionCoordinateSet	Dimension coordinate set
TPCB_PrimitivePadHole	Pad drilling
TPCB_PrimitivePadShape	Pad shape
TPCB_PrimitiveSpecialPadShape	Special pad shape
TSYS_MathPolygonGroup	Polygon group
TSYS_MathPolygonInput	Polygon input type
TSYS_PcbComparisonErrorCode	PCB comparison failure error code
TSYS_ShortcutKeys	Shortcut key