@windypro-rourou/dsh-eda 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (484) hide show
  1. package/README.md +1 -1
  2. package/lib/backend.js +49 -0
  3. package/lib/capabilities.js +6 -2
  4. package/lib/client.js +33 -0
  5. package/lib/index.js +197 -3
  6. package/package.json +10 -1
  7. package/skill/INDEX.md +10 -8
  8. package/skill/README.md +125 -0
  9. package/skill/README.zh-Hans.md +125 -0
  10. package/skill/SKILL.md +746 -746
  11. package/skill/format/index.md +152 -152
  12. package/skill/format/pcb/3d.md +166 -166
  13. package/skill/format/pcb/attr.md +63 -63
  14. package/skill/format/pcb/common.md +306 -306
  15. package/skill/format/pcb/component.md +132 -132
  16. package/skill/format/pcb/dimension.md +58 -58
  17. package/skill/format/pcb/index.md +17 -17
  18. package/skill/format/pcb/obj.md +43 -43
  19. package/skill/format/pcb/pad_via.md +151 -151
  20. package/skill/format/pcb/panel.md +64 -64
  21. package/skill/format/pcb/partition.md +43 -43
  22. package/skill/format/pcb/primitive.md +196 -196
  23. package/skill/format/pcb/rule.md +71 -71
  24. package/skill/format/pcb/shape.md +441 -441
  25. package/skill/format/pcb/text.md +62 -62
  26. package/skill/format/project/blob.md +30 -30
  27. package/skill/format/project/common.md +42 -42
  28. package/skill/format/project/group.md +62 -62
  29. package/skill/format/project/index.md +12 -12
  30. package/skill/format/project/instance.md +32 -32
  31. package/skill/format/project/meta.md +189 -189
  32. package/skill/format/project/variant.md +30 -30
  33. package/skill/format/schematic/attr.md +41 -41
  34. package/skill/format/schematic/common.md +47 -47
  35. package/skill/format/schematic/component.md +91 -91
  36. package/skill/format/schematic/index.md +14 -14
  37. package/skill/format/schematic/obj.md +41 -41
  38. package/skill/format/schematic/pin.md +59 -59
  39. package/skill/format/schematic/shape.md +231 -231
  40. package/skill/format/schematic/structure.md +53 -53
  41. package/skill/format/schematic/table.md +109 -109
  42. package/skill/format/schematic/text.md +47 -47
  43. package/skill/format/schematic/wire.md +132 -132
  44. package/skill/guide/ancillary-projects/easyeda-api-sdk.md +1 -0
  45. package/skill/guide/ancillary-projects/pro-api-types.md +5 -5
  46. package/skill/guide/ancillary-projects.md +10 -10
  47. package/skill/guide/cli.md +1510 -0
  48. package/skill/guide/error-handling.md +38 -38
  49. package/skill/guide/extension-json.md +135 -135
  50. package/skill/guide/extensions-marketplace.md +61 -61
  51. package/skill/guide/how-to-start.md +316 -301
  52. package/skill/guide/i18n.md +57 -57
  53. package/skill/guide/index.md +7 -7
  54. package/skill/guide/inline-frame.md +20 -20
  55. package/skill/guide/invoke-apis.md +81 -81
  56. package/skill/guide/stability.md +37 -37
  57. package/skill/references/_index.md +471 -398
  58. package/skill/references/_quick-reference.md +3103 -3028
  59. package/skill/references/classes/DMT_Board.md +537 -533
  60. package/skill/references/classes/DMT_EditorControl.md +1736 -1736
  61. package/skill/references/classes/DMT_Event.md +356 -356
  62. package/skill/references/classes/DMT_Folder.md +775 -775
  63. package/skill/references/classes/DMT_Panel.md +531 -531
  64. package/skill/references/classes/DMT_Pcb.md +579 -575
  65. package/skill/references/classes/DMT_Project.md +734 -573
  66. package/skill/references/classes/DMT_Schematic.md +1482 -1477
  67. package/skill/references/classes/DMT_SelectControl.md +96 -96
  68. package/skill/references/classes/DMT_Team.md +172 -172
  69. package/skill/references/classes/DMT_Workspace.md +198 -198
  70. package/skill/references/classes/EDA.md +1001 -961
  71. package/skill/references/classes/IPCB_ComplexPolygon.md +299 -299
  72. package/skill/references/classes/IPCB_Polygon.md +175 -175
  73. package/skill/references/classes/IPCB_PrimitiveArc.md +1901 -1901
  74. package/skill/references/classes/IPCB_PrimitiveAttribute.md +2993 -2993
  75. package/skill/references/classes/IPCB_PrimitiveComponent.md +2624 -2627
  76. package/skill/references/classes/IPCB_PrimitiveComponentPad.md +410 -410
  77. package/skill/references/classes/IPCB_PrimitiveDimension.md +1419 -1419
  78. package/skill/references/classes/IPCB_PrimitiveFill.md +1325 -1325
  79. package/skill/references/classes/IPCB_PrimitiveImage.md +1461 -1461
  80. package/skill/references/classes/IPCB_PrimitiveLine.md +1639 -1639
  81. package/skill/references/classes/IPCB_PrimitiveObject.md +1700 -1700
  82. package/skill/references/classes/IPCB_PrimitivePad.md +3155 -3155
  83. package/skill/references/classes/IPCB_PrimitivePolyline.md +1193 -1193
  84. package/skill/references/classes/IPCB_PrimitivePour.md +1858 -1858
  85. package/skill/references/classes/IPCB_PrimitivePoured.md +556 -556
  86. package/skill/references/classes/IPCB_PrimitiveRegion.md +1332 -1332
  87. package/skill/references/classes/IPCB_PrimitiveString.md +2315 -2315
  88. package/skill/references/classes/IPCB_PrimitiveVia.md +1588 -1588
  89. package/skill/references/classes/ISCH_PrimitiveArc.md +1676 -1676
  90. package/skill/references/classes/ISCH_PrimitiveAttribute.md +2541 -2541
  91. package/skill/references/classes/ISCH_PrimitiveBus.md +973 -973
  92. package/skill/references/classes/ISCH_PrimitiveCbbSymbolComponent.md +260 -260
  93. package/skill/references/classes/ISCH_PrimitiveCircle.md +1392 -1392
  94. package/skill/references/classes/ISCH_PrimitiveComponent.md +2910 -2913
  95. package/skill/references/classes/ISCH_PrimitiveComponentPin.md +155 -155
  96. package/skill/references/classes/ISCH_PrimitiveObject.md +960 -960
  97. package/skill/references/classes/ISCH_PrimitivePin.md +2402 -2402
  98. package/skill/references/classes/ISCH_PrimitivePolygon.md +1028 -1028
  99. package/skill/references/classes/ISCH_PrimitiveRectangle.md +1777 -1777
  100. package/skill/references/classes/ISCH_PrimitiveText.md +1771 -1771
  101. package/skill/references/classes/ISCH_PrimitiveWire.md +973 -973
  102. package/skill/references/classes/LIB_3DModel.md +782 -780
  103. package/skill/references/classes/LIB_Cbb.md +957 -957
  104. package/skill/references/classes/LIB_Classification.md +969 -965
  105. package/skill/references/classes/LIB_Device.md +1222 -1221
  106. package/skill/references/classes/LIB_Footprint.md +1298 -1153
  107. package/skill/references/classes/LIB_LibrariesList.md +361 -329
  108. package/skill/references/classes/LIB_PanelLibrary.md +855 -855
  109. package/skill/references/classes/LIB_SelectControl.md +89 -89
  110. package/skill/references/classes/LIB_SimulationModel.md +807 -821
  111. package/skill/references/classes/LIB_Symbol.md +1341 -1195
  112. package/skill/references/classes/PCB_Document.md +1770 -1754
  113. package/skill/references/classes/PCB_Drc.md +3379 -3375
  114. package/skill/references/classes/PCB_Event.md +1166 -1081
  115. package/skill/references/classes/PCB_ImageTool.md +363 -0
  116. package/skill/references/classes/PCB_Layer.md +1915 -1911
  117. package/skill/references/classes/PCB_ManufactureData.md +2968 -2968
  118. package/skill/references/classes/PCB_MathPolygon.md +916 -785
  119. package/skill/references/classes/PCB_Net.md +1128 -1128
  120. package/skill/references/classes/PCB_Primitive.md +217 -217
  121. package/skill/references/classes/PCB_PrimitiveArc.md +820 -894
  122. package/skill/references/classes/PCB_PrimitiveAttribute.md +635 -717
  123. package/skill/references/classes/PCB_PrimitiveComponent.md +1050 -1050
  124. package/skill/references/classes/PCB_PrimitiveDimension.md +789 -833
  125. package/skill/references/classes/PCB_PrimitiveFill.md +783 -861
  126. package/skill/references/classes/PCB_PrimitiveImage.md +803 -875
  127. package/skill/references/classes/PCB_PrimitiveLine.md +787 -858
  128. package/skill/references/classes/PCB_PrimitiveObject.md +796 -800
  129. package/skill/references/classes/PCB_PrimitivePad.md +947 -944
  130. package/skill/references/classes/PCB_PrimitivePolyline.md +744 -819
  131. package/skill/references/classes/PCB_PrimitivePour.md +808 -845
  132. package/skill/references/classes/PCB_PrimitivePoured.md +363 -363
  133. package/skill/references/classes/PCB_PrimitiveRegion.md +765 -799
  134. package/skill/references/classes/PCB_PrimitiveString.md +828 -910
  135. package/skill/references/classes/PCB_PrimitiveVia.md +761 -765
  136. package/skill/references/classes/PCB_RayTracerEngine.md +603 -263
  137. package/skill/references/classes/PCB_SelectControl.md +495 -495
  138. package/skill/references/classes/PCB_Tool.md +9 -0
  139. package/skill/references/classes/PNL_Document.md +83 -83
  140. package/skill/references/classes/SCH_Document.md +797 -809
  141. package/skill/references/classes/SCH_Drc.md +246 -242
  142. package/skill/references/classes/SCH_Event.md +583 -583
  143. package/skill/references/classes/SCH_ManufactureData.md +1209 -1205
  144. package/skill/references/classes/SCH_Net.md +200 -200
  145. package/skill/references/classes/SCH_Netlist.md +191 -191
  146. package/skill/references/classes/SCH_Primitive.md +337 -337
  147. package/skill/references/classes/SCH_PrimitiveArc.md +686 -692
  148. package/skill/references/classes/SCH_PrimitiveAttribute.md +579 -590
  149. package/skill/references/classes/SCH_PrimitiveBus.md +618 -624
  150. package/skill/references/classes/SCH_PrimitiveCircle.md +667 -683
  151. package/skill/references/classes/SCH_PrimitiveComponent.md +2256 -2240
  152. package/skill/references/classes/SCH_PrimitiveObject.md +666 -666
  153. package/skill/references/classes/SCH_PrimitivePin.md +737 -754
  154. package/skill/references/classes/SCH_PrimitivePolygon.md +621 -627
  155. package/skill/references/classes/SCH_PrimitiveRectangle.md +715 -731
  156. package/skill/references/classes/SCH_PrimitiveText.md +736 -746
  157. package/skill/references/classes/SCH_PrimitiveWire.md +701 -703
  158. package/skill/references/classes/SCH_SelectControl.md +520 -520
  159. package/skill/references/classes/SCH_SimulationEngine.md +133 -133
  160. package/skill/references/classes/SCH_Utils.md +121 -121
  161. package/skill/references/classes/SYS_ClientUrl.md +173 -173
  162. package/skill/references/classes/SYS_Dialog.md +825 -825
  163. package/skill/references/classes/SYS_Environment.md +640 -502
  164. package/skill/references/classes/SYS_ExternalApi.md +246 -0
  165. package/skill/references/classes/SYS_FileManager.md +1664 -1686
  166. package/skill/references/classes/SYS_FileSystem.md +1366 -1171
  167. package/skill/references/classes/SYS_FontManager.md +224 -224
  168. package/skill/references/classes/SYS_FormatConversion.md +349 -349
  169. package/skill/references/classes/SYS_HeaderMenu.md +480 -479
  170. package/skill/references/classes/SYS_Help.md +141 -0
  171. package/skill/references/classes/SYS_I18n.md +861 -861
  172. package/skill/references/classes/SYS_IFrame.md +541 -535
  173. package/skill/references/classes/SYS_LoadingAndProgressBar.md +246 -246
  174. package/skill/references/classes/SYS_Log.md +422 -424
  175. package/skill/references/classes/SYS_Math.md +1565 -1565
  176. package/skill/references/classes/SYS_Message.md +363 -363
  177. package/skill/references/classes/SYS_MessageBox.md +285 -285
  178. package/skill/references/classes/SYS_MessageBus.md +1618 -1618
  179. package/skill/references/classes/SYS_PanelControl.md +696 -696
  180. package/skill/references/classes/SYS_RightClickMenu.md +175 -175
  181. package/skill/references/classes/SYS_Setting.md +134 -85
  182. package/skill/references/classes/SYS_ShortcutKey.md +623 -623
  183. package/skill/references/classes/SYS_Storage.md +484 -484
  184. package/skill/references/classes/SYS_Timer.md +447 -447
  185. package/skill/references/classes/SYS_ToastMessage.md +194 -194
  186. package/skill/references/classes/SYS_Tool.md +317 -241
  187. package/skill/references/classes/SYS_Unit.md +594 -594
  188. package/skill/references/classes/SYS_WebSocket.md +401 -401
  189. package/skill/references/classes/SYS_Window.md +849 -850
  190. package/skill/references/enums/EDMT_EditorDocumentType.md +324 -278
  191. package/skill/references/enums/EDMT_EditorSplitScreenDirection.md +51 -47
  192. package/skill/references/enums/EDMT_EditorTabEventType.md +68 -62
  193. package/skill/references/enums/EDMT_IndicatorMarkerType.md +90 -80
  194. package/skill/references/enums/EDMT_ItemType.md +181 -157
  195. package/skill/references/enums/EDMT_ProjectCollaborationMode.md +51 -47
  196. package/skill/references/enums/EDMT_ProjectFileFormat.md +60 -0
  197. package/skill/references/enums/EDMT_ProjectReadyState.md +82 -0
  198. package/skill/references/enums/ELIB_DeviceJlcLibraryCategory.md +51 -47
  199. package/skill/references/enums/ELIB_LibraryType.md +129 -113
  200. package/skill/references/enums/ELIB_PreviewType.md +77 -69
  201. package/skill/references/enums/ELIB_SimulationModelType.md +51 -47
  202. package/skill/references/enums/ELIB_SymbolType.md +142 -124
  203. package/skill/references/enums/EPCB_AutoRoutingCornerStyle.md +51 -47
  204. package/skill/references/enums/EPCB_AutoRoutingExistingPrimitiveMode.md +51 -47
  205. package/skill/references/enums/EPCB_AutoRoutingOptimization.md +51 -47
  206. package/skill/references/enums/EPCB_DocumentCanvasUpdateCalculationActiveStatus.md +51 -47
  207. package/skill/references/enums/EPCB_DocumentRatlineCalculatingActiveStatus.md +55 -51
  208. package/skill/references/enums/EPCB_InactiveLayerDisplayMode.md +64 -58
  209. package/skill/references/enums/EPCB_LayerColorConfiguration.md +90 -80
  210. package/skill/references/enums/EPCB_LayerId.md +1169 -881
  211. package/skill/references/enums/EPCB_LayerStatus.md +64 -58
  212. package/skill/references/enums/EPCB_LayerType.md +129 -113
  213. package/skill/references/enums/EPCB_MouseEventType.md +64 -58
  214. package/skill/references/enums/EPCB_NetEventType.md +64 -58
  215. package/skill/references/enums/EPCB_PcbPlateType.md +51 -47
  216. package/skill/references/enums/EPCB_PdfOutputMethod.md +64 -58
  217. package/skill/references/enums/EPCB_PrimitiveArcInteractiveMode.md +51 -47
  218. package/skill/references/enums/EPCB_PrimitiveDimensionType.md +64 -58
  219. package/skill/references/enums/EPCB_PrimitiveEventType.md +64 -58
  220. package/skill/references/enums/EPCB_PrimitiveFillMode.md +68 -62
  221. package/skill/references/enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md +64 -58
  222. package/skill/references/enums/EPCB_PrimitivePadHoleType.md +64 -58
  223. package/skill/references/enums/EPCB_PrimitivePadShapeType.md +90 -80
  224. package/skill/references/enums/EPCB_PrimitivePadType.md +64 -58
  225. package/skill/references/enums/EPCB_PrimitivePourFillMethod.md +64 -58
  226. package/skill/references/enums/EPCB_PrimitiveRegionRuleType.md +107 -95
  227. package/skill/references/enums/EPCB_PrimitiveStringAlignMode.md +142 -124
  228. package/skill/references/enums/EPCB_PrimitiveType.md +233 -201
  229. package/skill/references/enums/EPCB_PrimitiveViaType.md +64 -58
  230. package/skill/references/enums/ESCH_DynamicSimulationEnginePullEventType.md +116 -102
  231. package/skill/references/enums/ESCH_DynamicSimulationEnginePushEventType.md +90 -80
  232. package/skill/references/enums/ESCH_ExportDocumentFileType.md +64 -58
  233. package/skill/references/enums/ESCH_MouseEventType.md +51 -47
  234. package/skill/references/enums/ESCH_PrimitiveComponentType.md +142 -124
  235. package/skill/references/enums/ESCH_PrimitiveEventType.md +77 -69
  236. package/skill/references/enums/ESCH_PrimitiveFillStyle.md +129 -113
  237. package/skill/references/enums/ESCH_PrimitiveLineType.md +77 -69
  238. package/skill/references/enums/ESCH_PrimitivePinShape.md +77 -69
  239. package/skill/references/enums/ESCH_PrimitivePinType.md +168 -146
  240. package/skill/references/enums/ESCH_PrimitiveTextAlignMode.md +142 -124
  241. package/skill/references/enums/ESCH_PrimitiveType.md +207 -179
  242. package/skill/references/enums/ESCH_SimulationNetlistType.md +38 -36
  243. package/skill/references/enums/ESCH_SpiceSimulationEnginePullEventType.md +51 -47
  244. package/skill/references/enums/ESCH_SpiceSimulationEnginePushEventType.md +77 -69
  245. package/skill/references/enums/ESYS_BottomPanelTab.md +94 -80
  246. package/skill/references/enums/ESYS_HeaderMenuEnvironment.md +181 -157
  247. package/skill/references/enums/ESYS_ImportProjectBoardOutlineSource.md +55 -51
  248. package/skill/references/enums/ESYS_ImportProjectImportOption.md +64 -58
  249. package/skill/references/enums/ESYS_ImportProjectSchematicObjectStyle.md +51 -47
  250. package/skill/references/enums/ESYS_ImportProjectViaSolderMaskExpansion.md +55 -51
  251. package/skill/references/enums/ESYS_JobState.md +95 -0
  252. package/skill/references/enums/ESYS_LeftPanelTab.md +94 -80
  253. package/skill/references/enums/ESYS_LogType.md +77 -102
  254. package/skill/references/enums/ESYS_NetlistType.md +129 -113
  255. package/skill/references/enums/ESYS_PanelPosition.md +69 -0
  256. package/skill/references/enums/ESYS_PanelTab.md +368 -0
  257. package/skill/references/enums/ESYS_RightPanelTab.md +237 -201
  258. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorRange.md +220 -190
  259. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorScene.md +103 -91
  260. package/skill/references/enums/ESYS_StartPageQuickStartItem.md +237 -205
  261. package/skill/references/enums/ESYS_Theme.md +51 -47
  262. package/skill/references/enums/ESYS_ToastMessageType.md +90 -80
  263. package/skill/references/enums/ESYS_Unit.md +116 -102
  264. package/skill/references/enums/ESYS_WindowEventType.md +64 -47
  265. package/skill/references/enums/ESYS_WindowOpenTarget.md +51 -47
  266. package/skill/references/enums/NetportDeviceName.md +146 -146
  267. package/skill/references/enums/SchToolBarDeviceName.md +278 -278
  268. package/skill/references/interfaces/BoardProps.md +169 -169
  269. package/skill/references/interfaces/BorderConfig.md +109 -0
  270. package/skill/references/interfaces/ButtonProps.md +196 -169
  271. package/skill/references/interfaces/CellClickInfo.md +142 -0
  272. package/skill/references/interfaces/CellCoord.md +88 -0
  273. package/skill/references/interfaces/CheckBoxProps.md +223 -196
  274. package/skill/references/interfaces/CheckChangeDetail.md +88 -0
  275. package/skill/references/interfaces/CheckboxEditConfig.md +159 -0
  276. package/skill/references/interfaces/ClipboardCellData.md +142 -0
  277. package/skill/references/interfaces/ClipboardConfig.md +115 -0
  278. package/skill/references/interfaces/ColorPickerProps.md +169 -0
  279. package/skill/references/interfaces/ColumnDef.md +605 -0
  280. package/skill/references/interfaces/ColumnEditTrigger.md +57 -0
  281. package/skill/references/interfaces/ColumnGroupDef.md +192 -0
  282. package/skill/references/interfaces/ColumnResizeConfig.md +142 -0
  283. package/skill/references/interfaces/ComponentPropsMap.md +517 -448
  284. package/skill/references/interfaces/CustomHeaderConfig.md +169 -0
  285. package/skill/references/interfaces/DialogProps.md +385 -385
  286. package/skill/references/interfaces/DragSortConfig.md +115 -0
  287. package/skill/references/interfaces/EditingConfig.md +196 -0
  288. package/skill/references/interfaces/FilteringConfig.md +250 -0
  289. package/skill/references/interfaces/FixedColumnConfig.md +88 -0
  290. package/skill/references/interfaces/FlexItemProps.md +116 -116
  291. package/skill/references/interfaces/FlexProps.md +224 -224
  292. package/skill/references/interfaces/GridItemProps.md +143 -143
  293. package/skill/references/interfaces/GridProps.md +143 -143
  294. package/skill/references/interfaces/IDMT_BoardItem.md +171 -171
  295. package/skill/references/interfaces/IDMT_BriefProjectItem.md +171 -171
  296. package/skill/references/interfaces/IDMT_EditorDocumentItem.md +169 -169
  297. package/skill/references/interfaces/IDMT_EditorSplitScreenItem.md +173 -173
  298. package/skill/references/interfaces/IDMT_EditorTabItem.md +169 -169
  299. package/skill/references/interfaces/IDMT_FolderItem.md +225 -225
  300. package/skill/references/interfaces/IDMT_IndicatorMarkerShape.md +393 -393
  301. package/skill/references/interfaces/IDMT_PanelItem.md +144 -144
  302. package/skill/references/interfaces/IDMT_PcbItem.md +171 -171
  303. package/skill/references/interfaces/IDMT_ProjectItem.md +143 -143
  304. package/skill/references/interfaces/IDMT_SchematicItem.md +225 -225
  305. package/skill/references/interfaces/IDMT_SchematicPageItem.md +198 -198
  306. package/skill/references/interfaces/IDMT_TeamItem.md +144 -144
  307. package/skill/references/interfaces/IDMT_WorkspaceItem.md +117 -117
  308. package/skill/references/interfaces/IDesignPortal.md +103 -103
  309. package/skill/references/interfaces/ILIB_3DModelItem.md +198 -198
  310. package/skill/references/interfaces/ILIB_3DModelSearchItem.md +277 -277
  311. package/skill/references/interfaces/ILIB_CbbItem.md +225 -225
  312. package/skill/references/interfaces/ILIB_CbbSearchItem.md +277 -277
  313. package/skill/references/interfaces/ILIB_ClassificationIndex.md +150 -150
  314. package/skill/references/interfaces/ILIB_ClassificationNode.md +98 -0
  315. package/skill/references/interfaces/ILIB_DeviceAssociationItem.md +210 -210
  316. package/skill/references/interfaces/ILIB_DeviceExtendPropertyItem.md +304 -304
  317. package/skill/references/interfaces/ILIB_DeviceItem.md +279 -279
  318. package/skill/references/interfaces/ILIB_DevicePropertiesForSearch.md +250 -250
  319. package/skill/references/interfaces/ILIB_DeviceSearchItem.md +521 -521
  320. package/skill/references/interfaces/ILIB_ExtendLibrary3DModelFunctions.md +64 -64
  321. package/skill/references/interfaces/ILIB_ExtendLibraryCbbFunctions.md +93 -99
  322. package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md +150 -150
  323. package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md +143 -157
  324. package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md +63 -63
  325. package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md +123 -123
  326. package/skill/references/interfaces/ILIB_ExtendLibraryItem.md +97 -97
  327. package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md +98 -98
  328. package/skill/references/interfaces/ILIB_ExtendLibrarySearchProperty.md +115 -115
  329. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResult.md +169 -169
  330. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResultDataLine.md +234 -234
  331. package/skill/references/interfaces/ILIB_ExtendLibrarySymbolFunctions.md +91 -105
  332. package/skill/references/interfaces/ILIB_ExtendLibraryUserIndex.md +96 -96
  333. package/skill/references/interfaces/ILIB_FootprintItem.md +256 -198
  334. package/skill/references/interfaces/ILIB_FootprintPropertiesForSearch.md +61 -61
  335. package/skill/references/interfaces/ILIB_FootprintSearchItem.md +277 -277
  336. package/skill/references/interfaces/ILIB_LibraryInfo.md +92 -92
  337. package/skill/references/interfaces/ILIB_LibraryItem.md +115 -115
  338. package/skill/references/interfaces/ILIB_PanelLibraryItem.md +198 -198
  339. package/skill/references/interfaces/ILIB_PanelLibrarySearchItem.md +277 -277
  340. package/skill/references/interfaces/ILIB_RegisterExtendLibraryProps.md +71 -0
  341. package/skill/references/interfaces/ILIB_SimulationModelItem.md +306 -306
  342. package/skill/references/interfaces/ILIB_SimulationModelSearchItem.md +304 -304
  343. package/skill/references/interfaces/ILIB_SymbolItem.md +306 -279
  344. package/skill/references/interfaces/ILIB_SymbolPropertiesForSearch.md +61 -61
  345. package/skill/references/interfaces/ILIB_SymbolSearchItem.md +304 -304
  346. package/skill/references/interfaces/IPCB_AutoLayoutResult.md +169 -169
  347. package/skill/references/interfaces/IPCB_AutoRoutingProps.md +220 -220
  348. package/skill/references/interfaces/IPCB_AutoRoutingResult.md +169 -169
  349. package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md +169 -169
  350. package/skill/references/interfaces/IPCB_DifferentialPairItem.md +115 -115
  351. package/skill/references/interfaces/IPCB_DiscretizeOptions.md +65 -65
  352. package/skill/references/interfaces/IPCB_DiscretizedPoint.md +88 -88
  353. package/skill/references/interfaces/IPCB_EqualLengthNetGroupItem.md +115 -115
  354. package/skill/references/interfaces/IPCB_LayerItem.md +277 -277
  355. package/skill/references/interfaces/IPCB_NetClassItem.md +115 -115
  356. package/skill/references/interfaces/IPCB_NetInfo.md +115 -115
  357. package/skill/references/interfaces/IPCB_PadPairGroupItem.md +88 -88
  358. package/skill/references/interfaces/IPCB_PadPairMinWireLengthItem.md +88 -88
  359. package/skill/references/interfaces/IPCB_PhysicalStackingConfiguration.md +115 -115
  360. package/skill/references/interfaces/IPCB_Primitive.md +218 -218
  361. package/skill/references/interfaces/IPCB_PrimitiveAPI.md +174 -175
  362. package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md +151 -151
  363. package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md +142 -142
  364. package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md +154 -154
  365. package/skill/references/interfaces/IPCB_RayTracerBackgroundConfig.md +223 -0
  366. package/skill/references/interfaces/IPCB_RayTracerLightConfig.md +412 -0
  367. package/skill/references/interfaces/IPCB_RayTracerMaterialConfig.md +547 -0
  368. package/skill/references/interfaces/IPCB_RayTracerPcbMaterialConfig.md +196 -0
  369. package/skill/references/interfaces/IPCB_RayTracerRenderConfigurations.md +200 -0
  370. package/skill/references/interfaces/IPCB_RayTracerRendererConfig.md +196 -0
  371. package/skill/references/interfaces/IPCB_RayTracerSceneElement.md +115 -0
  372. package/skill/references/interfaces/IPCB_RayTracerSceneElementTransform.md +123 -0
  373. package/skill/references/interfaces/IPCB_RayTracerTexture.md +88 -0
  374. package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md +88 -88
  375. package/skill/references/interfaces/IRawNet.md +103 -103
  376. package/skill/references/interfaces/IRawPureSchematic.md +80 -80
  377. package/skill/references/interfaces/IRawSchematic.md +103 -103
  378. package/skill/references/interfaces/IRawWire.md +149 -149
  379. package/skill/references/interfaces/ISCH_DrcError.md +142 -142
  380. package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md +142 -142
  381. package/skill/references/interfaces/ISCH_ExportPngResolution.md +94 -94
  382. package/skill/references/interfaces/ISCH_NetInfo.md +88 -88
  383. package/skill/references/interfaces/ISCH_Primitive.md +218 -219
  384. package/skill/references/interfaces/ISCH_PrimitiveAPI.md +174 -175
  385. package/skill/references/interfaces/ISCH_ProjectNetInfo.md +142 -142
  386. package/skill/references/interfaces/ISCH_WireInfo.md +169 -169
  387. package/skill/references/interfaces/ISYS_ComparisonResponse.md +115 -0
  388. package/skill/references/interfaces/ISYS_ExtensionExternalApiIndex.md +13 -0
  389. package/skill/references/interfaces/ISYS_ExtensionRegisteredExternalApis.md +13 -0
  390. package/skill/references/interfaces/ISYS_ExternalApiHelp.md +173 -0
  391. package/skill/references/interfaces/ISYS_ExternalApiRegistration.md +146 -0
  392. package/skill/references/interfaces/ISYS_FileSystemFileList.md +169 -169
  393. package/skill/references/interfaces/ISYS_HeaderMenuSub1MenuItem.md +205 -174
  394. package/skill/references/interfaces/ISYS_HeaderMenuSub2MenuItem.md +178 -147
  395. package/skill/references/interfaces/ISYS_HeaderMenuTopMenuItem.md +115 -115
  396. package/skill/references/interfaces/ISYS_HeaderMenus.md +408 -408
  397. package/skill/references/interfaces/ISYS_HelpAudienceEntry.md +92 -0
  398. package/skill/references/interfaces/ISYS_HelpClassSummary.md +205 -0
  399. package/skill/references/interfaces/ISYS_HelpData.md +92 -0
  400. package/skill/references/interfaces/ISYS_HelpMethodDetail.md +310 -0
  401. package/skill/references/interfaces/ISYS_JobHandle.md +65 -0
  402. package/skill/references/interfaces/ISYS_JobLogEntry.md +142 -0
  403. package/skill/references/interfaces/ISYS_JobStatus.md +176 -0
  404. package/skill/references/interfaces/ISYS_LogLine.md +115 -115
  405. package/skill/references/interfaces/ISYS_MathBBox.md +142 -142
  406. package/skill/references/interfaces/ISYS_MathPoint.md +88 -88
  407. package/skill/references/interfaces/ISYS_MathPolygonWithHoles.md +92 -92
  408. package/skill/references/interfaces/ISYS_MessageBusTask.md +115 -115
  409. package/skill/references/interfaces/ISYS_MultilingualLanguagesData.md +12 -12
  410. package/skill/references/interfaces/ISYS_RightClickMenuItem.md +174 -174
  411. package/skill/references/interfaces/ISYS_ShortcutKeyData.md +169 -169
  412. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithCallFn.md +62 -62
  413. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithUserDefinedShortcutKey.md +62 -62
  414. package/skill/references/interfaces/ISYS_WindowEventListenerRemovableObject.md +109 -109
  415. package/skill/references/interfaces/IconProps.md +88 -88
  416. package/skill/references/interfaces/ImageProps.md +115 -115
  417. package/skill/references/interfaces/InputEditConfig.md +182 -0
  418. package/skill/references/interfaces/InputProps.md +547 -520
  419. package/skill/references/interfaces/KeyboardConfig.md +61 -0
  420. package/skill/references/interfaces/ListChildren.md +223 -223
  421. package/skill/references/interfaces/ListProps.md +250 -223
  422. package/skill/references/interfaces/ModalProps.md +358 -358
  423. package/skill/references/interfaces/NumberEditConfig.md +234 -0
  424. package/skill/references/interfaces/RadioGroupProps.md +196 -196
  425. package/skill/references/interfaces/RadioItem.md +115 -115
  426. package/skill/references/interfaces/RichTableProps.md +1357 -0
  427. package/skill/references/interfaces/RowMetaConfig.md +142 -0
  428. package/skill/references/interfaces/ScrollerProps.md +169 -169
  429. package/skill/references/interfaces/SelectEditConfig.md +211 -0
  430. package/skill/references/interfaces/SelectListItem.md +142 -142
  431. package/skill/references/interfaces/SelectOption.md +142 -0
  432. package/skill/references/interfaces/SelectProps.md +169 -169
  433. package/skill/references/interfaces/SelectionConfig.md +358 -0
  434. package/skill/references/interfaces/SliderProps.md +142 -0
  435. package/skill/references/interfaces/SlotProps.md +88 -88
  436. package/skill/references/interfaces/SortState.md +88 -0
  437. package/skill/references/interfaces/SortingConfig.md +169 -0
  438. package/skill/references/interfaces/StyleProps.md +439 -385
  439. package/skill/references/interfaces/TextAreaProps.md +196 -196
  440. package/skill/references/interfaces/TextProps.md +169 -169
  441. package/skill/references/interfaces/TextareaEditConfig.md +182 -0
  442. package/skill/references/interfaces/ValidationRule.md +223 -0
  443. package/skill/references/interfaces/VirtualScrollConfig.md +115 -0
  444. package/skill/references/types/Align.md +9 -0
  445. package/skill/references/types/CellContentType.md +9 -0
  446. package/skill/references/types/ColumnDefOrGroup.md +12 -0
  447. package/skill/references/types/ColumnEditConfig.md +13 -0
  448. package/skill/references/types/ColumnType.md +9 -0
  449. package/skill/references/types/DataChangeType.md +9 -0
  450. package/skill/references/types/FilterMatchMode.md +9 -0
  451. package/skill/references/types/RichTableRow.md +12 -0
  452. package/skill/references/types/Serializable.md +10 -0
  453. package/skill/references/types/SerializablePrimitive.md +9 -0
  454. package/skill/references/types/SortOrder.md +9 -0
  455. package/skill/references/types/TPCB_LayerTypesOfInnerLayer.md +11 -11
  456. package/skill/references/types/TPCB_LayersInTheSelectable.md +42 -42
  457. package/skill/references/types/TPCB_LayersOfComponent.md +11 -11
  458. package/skill/references/types/TPCB_LayersOfCopper.md +15 -15
  459. package/skill/references/types/TPCB_LayersOfCustom.md +41 -41
  460. package/skill/references/types/TPCB_LayersOfDimension.md +16 -16
  461. package/skill/references/types/TPCB_LayersOfFill.md +28 -28
  462. package/skill/references/types/TPCB_LayersOfImage.md +22 -22
  463. package/skill/references/types/TPCB_LayersOfInner.md +41 -41
  464. package/skill/references/types/TPCB_LayersOfLine.md +25 -25
  465. package/skill/references/types/TPCB_LayersOfObject.md +12 -12
  466. package/skill/references/types/TPCB_LayersOfPad.md +11 -11
  467. package/skill/references/types/TPCB_LayersOfRegion.md +11 -11
  468. package/skill/references/types/TPCB_NumberOfCopperLayers.md +9 -9
  469. package/skill/references/types/TPCB_PolygonSourceArray.md +85 -83
  470. package/skill/references/types/TPCB_PrimitiveDimensionCoordinateSet.md +66 -66
  471. package/skill/references/types/TPCB_PrimitivePadHole.md +30 -30
  472. package/skill/references/types/TPCB_PrimitivePadShape.md +61 -61
  473. package/skill/references/types/TPCB_PrimitiveSpecialPadShape.md +19 -19
  474. package/skill/references/types/TSYS_ComparisonErrorCode.md +15 -0
  475. package/skill/references/types/TSYS_LanguageKeyValuePairs.md +13 -0
  476. package/skill/references/types/TSYS_MathPolygonGroup.md +15 -15
  477. package/skill/references/types/TSYS_MathPolygonInput.md +20 -20
  478. package/skill/references/types/TSYS_ShortcutKeys.md +96 -96
  479. package/skill/user-guide/using-extension.md +47 -47
  480. package/src/json-gen.test.js +430 -0
  481. package/skill/guide/ancillary-projects/pro-api-sdk.md +0 -1
  482. package/skill/references/interfaces/ISYS_PcbComparisonResponse.md +0 -115
  483. package/skill/references/types/ISYS_LanguageKeyValuePairs.md +0 -13
  484. package/skill/references/types/TSYS_PcbComparisonErrorCode.md +0 -10
@@ -1,573 +1,734 @@
1
- # DMT\_Project class
2
-
3
- Document tree / Project management class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class DMT_Project
9
- ```
10
-
11
- ## Methods
12
-
13
- <table><thead><tr><th>
14
-
15
- Method
16
-
17
- </th><th>
18
-
19
- Modifiers
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody><tr><td>
27
-
28
- [createProject(projectFriendlyName, projectName, teamUuid, folderUuid, description, collaborationMode)](./DMT_Project.md)
29
-
30
- </td><td>
31
-
32
- </td><td>
33
-
34
- **_(BETA)_** Create Project
35
-
36
- </td></tr>
37
- <tr><td>
38
-
39
- [getAllProjectsUuid(teamUuid, folderUuid, workspaceUuid)](./DMT_Project.md)
40
-
41
- </td><td>
42
-
43
- </td><td>
44
-
45
- Get the UUIDs of all projects
46
-
47
- </td></tr>
48
- <tr><td>
49
-
50
- [getCurrentProjectInfo()](./DMT_Project.md)
51
-
52
- </td><td>
53
-
54
- </td><td>
55
-
56
- Get detailed properties of Current project
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- [getProjectInfo(projectUuid)](./DMT_Project.md)
62
-
63
- </td><td>
64
-
65
- </td><td>
66
-
67
- Get Project property
68
-
69
- </td></tr>
70
- <tr><td>
71
-
72
- [moveProjectToFolder(projectUuid, folderUuid)](./DMT_Project.md)
73
-
74
- </td><td>
75
-
76
- </td><td>
77
-
78
- Move a project to a folder
79
-
80
- </td></tr>
81
- <tr><td>
82
-
83
- [openProject(projectUuid)](./DMT_Project.md)
84
-
85
- </td><td>
86
-
87
- </td><td>
88
-
89
- Open project
90
-
91
- </td></tr>
92
- </tbody></table>
93
-
94
- ---
95
-
96
- ## 方法详情
97
-
98
- ### createproject
99
-
100
- # DMT\_Project.createProject() method
101
-
102
- > 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.
103
-
104
- Create Project
105
-
106
- ## Signature
107
-
108
- ```typescript
109
- function createProject(
110
- projectFriendlyName: string,
111
- projectName?: string,
112
- teamUuid?: string,
113
- folderUuid?: string,
114
- description?: string,
115
- collaborationMode?: EDMT_ProjectCollaborationMode,
116
- ): Promise<string | undefined>;
117
- ```
118
-
119
- ## Parameters
120
-
121
- <table><thead><tr><th>
122
-
123
- Parameter
124
-
125
- </th><th>
126
-
127
- Type
128
-
129
- </th><th>
130
-
131
- Description
132
-
133
- </th></tr></thead>
134
- <tbody><tr><td>
135
-
136
- projectFriendlyName
137
-
138
- </td><td>
139
-
140
- string
141
-
142
- </td><td>
143
-
144
- Project friendly name
145
-
146
- </td></tr>
147
- <tr><td>
148
-
149
- projectName
150
-
151
- </td><td>
152
-
153
- string
154
-
155
- </td><td>
156
-
157
- _(Optional)_ Project name, which cannot be duplicated. Only letters `a-zA-Z`<!-- -->, digits `0-9`<!-- -->, and hyphens `-` are supported. If not specified, it is automatically generated based on the project friendly name
158
-
159
- </td></tr>
160
- <tr><td>
161
-
162
- teamUuid
163
-
164
- </td><td>
165
-
166
- string
167
-
168
- </td><td>
169
-
170
- _(Optional)_ Team UUID. If not specified, it defaults to personal. In an environment where personal projects do not exist, a team UUID must be specified
171
-
172
- </td></tr>
173
- <tr><td>
174
-
175
- folderUuid
176
-
177
- </td><td>
178
-
179
- string
180
-
181
- </td><td>
182
-
183
- _(Optional)_ Folder UUID. If not specified, it is the root folder
184
-
185
- </td></tr>
186
- <tr><td>
187
-
188
- description
189
-
190
- </td><td>
191
-
192
- string
193
-
194
- </td><td>
195
-
196
- _(Optional)_ Project description
197
-
198
- </td></tr>
199
- <tr><td>
200
-
201
- collaborationMode
202
-
203
- </td><td>
204
-
205
- [EDMT\_ProjectCollaborationMode](../enums/EDMT_ProjectCollaborationMode.md)
206
-
207
- </td><td>
208
-
209
- _(Optional)_ Project collaboration mode. If the team permission does not require the project to set a collaboration mode, this parameter will be ignored
210
-
211
- </td></tr>
212
- </tbody></table>
213
-
214
- ## Returns
215
-
216
- Promise&lt;string \| undefined&gt;
217
-
218
- Project UUID, if it is `undefined` creation fails
219
-
220
- ## Example
221
-
222
- ```javascript
223
- // 1. 创建测试工程(友好名带时间戳避免重名,名称与团队留空走默认)
224
- const projectUuid = await eda.dmt_Project.createProject(
225
- `嘉立创示例_工程 ${Date.now()}`,
226
- undefined,
227
- undefined,
228
- undefined,
229
- '嘉立创示例:工程创建演示',
230
- );
231
-
232
- // 2. 等待工作区同步后回读,确认工程已落地
233
- await new Promise(r => setTimeout(r, 1500));
234
- const brief = await eda.dmt_Project.getProjectInfo(projectUuid);
235
-
236
- const folderLabel = !brief?.folderUuid ? '(根目录)' : brief.folderUuid;
237
-
238
- console.log('projectUuid:', projectUuid);
239
- console.log('friendlyName:', brief?.friendlyName);
240
- console.log('folderUuid:', folderLabel);
241
- ```
242
-
243
- ### getallprojectsuuid
244
-
245
- # DMT\_Project.getAllProjectsUuid() method
246
-
247
- Get the UUIDs of all projects
248
-
249
- ## Signature
250
-
251
- ```typescript
252
- function getAllProjectsUuid(
253
- teamUuid?: string,
254
- folderUuid?: string,
255
- workspaceUuid?: string,
256
- ): Promise<Array<string>>;
257
- ```
258
-
259
- ## Parameters
260
-
261
- <table><thead><tr><th>
262
-
263
- Parameter
264
-
265
- </th><th>
266
-
267
- Type
268
-
269
- </th><th>
270
-
271
- Description
272
-
273
- </th></tr></thead>
274
- <tbody><tr><td>
275
-
276
- teamUuid
277
-
278
- </td><td>
279
-
280
- string
281
-
282
- </td><td>
283
-
284
- _(Optional)_ Team UUID
285
-
286
- </td></tr>
287
- <tr><td>
288
-
289
- folderUuid
290
-
291
- </td><td>
292
-
293
- string
294
-
295
- </td><td>
296
-
297
- _(Optional)_ Folder UUID. If not specified, it defaults to the root folder of the team
298
-
299
- </td></tr>
300
- <tr><td>
301
-
302
- workspaceUuid
303
-
304
- </td><td>
305
-
306
- string
307
-
308
- </td><td>
309
-
310
- _(Optional)_ Workspace UUID
311
-
312
- </td></tr>
313
- </tbody></table>
314
-
315
- ## Returns
316
-
317
- Promise&lt;Array&lt;string&gt;&gt;
318
-
319
- Project UUID array
320
-
321
- ## Remarks
322
-
323
- If `teamUuid` is specified, all projects under the specified team are obtained;
324
-
325
- If `folderUuid` is specified, all projects under the specified folder are obtained;
326
-
327
- `teamUuid`<!-- -->, `folderUuid` only one of them may be specified, if both are specified, only `folderUuid`<!-- -->;
328
-
329
- If `workspaceUuid` is specified, all projects under the specified team/folder are obtained in the specified Workspace
330
-
331
- ## Example
332
-
333
- ```javascript
334
- // 1. 取当前工程所属团队
335
- const projectInfo = await eda.dmt_Project.getCurrentProjectInfo();
336
- const teamUuid = projectInfo.teamUuid;
337
-
338
- // 2. 获取该团队下所有工程的 UUID
339
- const projectUuids = await eda.dmt_Project.getAllProjectsUuid(teamUuid);
340
-
341
- console.log('projectCount:', projectUuids.length);
342
- console.log('projectUuids:', projectUuids.join(', '));
343
- ```
344
-
345
- ### getcurrentprojectinfo
346
-
347
- # DMT\_Project.getCurrentProjectInfo() method
348
-
349
- Get detailed properties of Current project
350
-
351
- ## Signature
352
-
353
- ```typescript
354
- function getCurrentProjectInfo(): Promise<IDMT_ProjectItem | undefined>;
355
- ```
356
-
357
- ## Returns
358
-
359
- Promise&lt;[IDMT\_ProjectItem](../interfaces/IDMT_ProjectItem.md) \| undefined&gt;
360
-
361
- Project property; if it is `undefined`<!-- -->, the retrieval failed
362
-
363
- ## Remarks
364
-
365
- It will get the detailed properties of the project associated with the currently open schematic, PCB, or panel that has the last input focus
366
-
367
- ### getprojectinfo
368
-
369
- # DMT\_Project.getProjectInfo() method
370
-
371
- Get Project property
372
-
373
- ## Signature
374
-
375
- ```typescript
376
- function getProjectInfo(projectUuid: string): Promise<IDMT_BriefProjectItem | undefined>;
377
- ```
378
-
379
- ## Parameters
380
-
381
- <table><thead><tr><th>
382
-
383
- Parameter
384
-
385
- </th><th>
386
-
387
- Type
388
-
389
- </th><th>
390
-
391
- Description
392
-
393
- </th></tr></thead>
394
- <tbody><tr><td>
395
-
396
- projectUuid
397
-
398
- </td><td>
399
-
400
- string
401
-
402
- </td><td>
403
-
404
- Project UUID
405
-
406
- </td></tr>
407
- </tbody></table>
408
-
409
- ## Returns
410
-
411
- Promise&lt;[IDMT\_BriefProjectItem](../interfaces/IDMT_BriefProjectItem.md) \| undefined&gt;
412
-
413
- Brief project properties. If it is `undefined`<!-- -->, the retrieval failed
414
-
415
- ## Remarks
416
-
417
- This API can only read brief project properties. For the detailed project tree, use the [getCurrentProjectInfo](./DMT_Project.md) API
418
-
419
- ### moveprojecttofolder
420
-
421
- # DMT\_Project.moveProjectToFolder() method
422
-
423
- Move a project to a folder
424
-
425
- ## Signature
426
-
427
- ```typescript
428
- function moveProjectToFolder(projectUuid: string, folderUuid?: string): Promise<boolean>;
429
- ```
430
-
431
- ## Parameters
432
-
433
- <table><thead><tr><th>
434
-
435
- Parameter
436
-
437
- </th><th>
438
-
439
- Type
440
-
441
- </th><th>
442
-
443
- Description
444
-
445
- </th></tr></thead>
446
- <tbody><tr><td>
447
-
448
- projectUuid
449
-
450
- </td><td>
451
-
452
- string
453
-
454
- </td><td>
455
-
456
- Project UUID
457
-
458
- </td></tr>
459
- <tr><td>
460
-
461
- folderUuid
462
-
463
- </td><td>
464
-
465
- string
466
-
467
- </td><td>
468
-
469
- _(Optional)_ Folder UUID, which can only be a folder under the team or personal space where the current project is located. If it is `undefined`<!-- -->, it is moved to the root folder of the current team
470
-
471
- </td></tr>
472
- </tbody></table>
473
-
474
- ## Returns
475
-
476
- Promise&lt;boolean&gt;
477
-
478
- Whether the move is successful
479
-
480
- ## Example
481
-
482
- ```javascript
483
- // 1. 记录当前工程的位置,作为移动后恢复的锚点
484
- const info = await eda.dmt_Project.getCurrentProjectInfo();
485
- const projectUuid = info.uuid;
486
- const teamUuid = info.teamUuid;
487
- const originalFolderUuid = info.folderUuid; // 可能为 undefined(团队根目录)
488
-
489
- // 2. 创建目标文件夹,等待 1.5s 让工作区同步
490
- const targetFolderUuid = await eda.dmt_Folder.createFolder('嘉立创示例_目标文件夹', teamUuid);
491
- await new Promise(r => setTimeout(r, 1500));
492
-
493
- // 3. 把当前工程移到目标文件夹下
494
- const moved = await eda.dmt_Project.moveProjectToFolder(projectUuid, targetFolderUuid);
495
- await new Promise(r => setTimeout(r, 1000));
496
-
497
- // 4. 回读验证工程已落到目标文件夹
498
- const after = await eda.dmt_Project.getCurrentProjectInfo();
499
- const folderChanged = after?.folderUuid === targetFolderUuid;
500
-
501
- // 5. 恢复:移回原位置(原为根目录时传 undefined)
502
- const restored = await eda.dmt_Project.moveProjectToFolder(projectUuid, originalFolderUuid);
503
- await new Promise(r => setTimeout(r, 1000));
504
-
505
- console.log('moved:', moved);
506
- console.log('folderChanged:', folderChanged);
507
- console.log('restored:', restored);
508
- ```
509
-
510
- ### openproject
511
-
512
- # DMT\_Project.openProject() method
513
-
514
- Open project
515
-
516
- ## Signature
517
-
518
- ```typescript
519
- function openProject(projectUuid: string): Promise<boolean>;
520
- ```
521
-
522
- ## Parameters
523
-
524
- <table><thead><tr><th>
525
-
526
- Parameter
527
-
528
- </th><th>
529
-
530
- Type
531
-
532
- </th><th>
533
-
534
- Description
535
-
536
- </th></tr></thead>
537
- <tbody><tr><td>
538
-
539
- projectUuid
540
-
541
- </td><td>
542
-
543
- string
544
-
545
- </td><td>
546
-
547
- Project UUID
548
-
549
- </td></tr>
550
- </tbody></table>
551
-
552
- ## Returns
553
-
554
- Promise&lt;boolean&gt;
555
-
556
- Whether Successful open project
557
-
558
- ## Remarks
559
-
560
- This operation will open the specified project in the EDA front end. If another project was previously opened with unsaved changes, executing this operation will directly lose all unsaved data
561
-
562
- ## Example
563
-
564
- ```javascript
565
- // 1. 取当前工程 UUID(打开自身,避免切换到其它工程)
566
- const info = await eda.dmt_Project.getCurrentProjectInfo();
567
- const projectUuid = info.uuid;
568
-
569
- // 2. 打开该工程
570
- const opened = await eda.dmt_Project.openProject(projectUuid);
571
-
572
- console.log('opened:', opened);
573
- ```
1
+ # DMT\_Project class
2
+
3
+ Document tree / Project management class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class DMT_Project
9
+ ```
10
+
11
+ ## Methods
12
+
13
+ <table><thead><tr><th>
14
+
15
+ Method
16
+
17
+ </th><th>
18
+
19
+ Modifiers
20
+
21
+ </th><th>
22
+
23
+ Description
24
+
25
+ </th></tr></thead>
26
+ <tbody><tr><td>
27
+
28
+ [createProject(projectFriendlyName, projectName, teamUuid, folderUuid, description, collaborationMode, fileFormat)](./DMT_Project.md)
29
+
30
+ </td><td>
31
+
32
+ </td><td>
33
+
34
+ **_(BETA)_** Create Project
35
+
36
+ </td></tr>
37
+ <tr><td>
38
+
39
+ [getAllProjectsUuid(teamUuid, folderUuid, workspaceUuid)](./DMT_Project.md)
40
+
41
+ </td><td>
42
+
43
+ </td><td>
44
+
45
+ Get the UUIDs of all projects
46
+
47
+ </td></tr>
48
+ <tr><td>
49
+
50
+ [getCurrentProjectInfo()](./DMT_Project.md)
51
+
52
+ </td><td>
53
+
54
+ </td><td>
55
+
56
+ Get detailed properties of Current project
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [getProjectInfo(projectUuid)](./DMT_Project.md)
62
+
63
+ </td><td>
64
+
65
+ </td><td>
66
+
67
+ Get Project property
68
+
69
+ </td></tr>
70
+ <tr><td>
71
+
72
+ [getReadyState(projectUuid)](./DMT_Project.md)
73
+
74
+ </td><td>
75
+
76
+ </td><td>
77
+
78
+ **_(BETA)_** 获取工程的就绪状态
79
+
80
+ </td></tr>
81
+ <tr><td>
82
+
83
+ [moveProjectToFolder(projectUuid, folderUuid)](./DMT_Project.md)
84
+
85
+ </td><td>
86
+
87
+ </td><td>
88
+
89
+ Move a project to a folder
90
+
91
+ </td></tr>
92
+ <tr><td>
93
+
94
+ [openProject(projectUuid)](./DMT_Project.md)
95
+
96
+ </td><td>
97
+
98
+ </td><td>
99
+
100
+ Open project
101
+
102
+ </td></tr>
103
+ <tr><td>
104
+
105
+ [waitForReady(projectUuid, timeoutMs)](./DMT_Project.md)
106
+
107
+ </td><td>
108
+
109
+ </td><td>
110
+
111
+ **_(BETA)_** 等待工程就绪
112
+
113
+ </td></tr>
114
+ </tbody></table>
115
+
116
+ ---
117
+
118
+ ## 方法详情
119
+
120
+ ### createproject
121
+
122
+ # DMT\_Project.createProject() method
123
+
124
+ > 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.
125
+
126
+ Create Project
127
+
128
+ ## Signature
129
+
130
+ ```typescript
131
+ function createProject(
132
+ projectFriendlyName: string,
133
+ projectName?: string,
134
+ teamUuid?: string,
135
+ folderUuid?: string,
136
+ description?: string,
137
+ collaborationMode?: EDMT_ProjectCollaborationMode,
138
+ fileFormat?: EDMT_ProjectFileFormat,
139
+ ): Promise<string | undefined>;
140
+ ```
141
+
142
+ ## Parameters
143
+
144
+ <table><thead><tr><th>
145
+
146
+ Parameter
147
+
148
+ </th><th>
149
+
150
+ Type
151
+
152
+ </th><th>
153
+
154
+ Description
155
+
156
+ </th></tr></thead>
157
+ <tbody><tr><td>
158
+
159
+ projectFriendlyName
160
+
161
+ </td><td>
162
+
163
+ string
164
+
165
+ </td><td>
166
+
167
+ Project friendly name
168
+
169
+ </td></tr>
170
+ <tr><td>
171
+
172
+ projectName
173
+
174
+ </td><td>
175
+
176
+ string
177
+
178
+ </td><td>
179
+
180
+ _(Optional)_ Project name, which cannot be duplicated. Only letters `a-zA-Z`<!-- -->, digits `0-9`<!-- -->, and hyphens `-` are supported. If not specified, it is automatically generated based on the project friendly name
181
+
182
+ </td></tr>
183
+ <tr><td>
184
+
185
+ teamUuid
186
+
187
+ </td><td>
188
+
189
+ string
190
+
191
+ </td><td>
192
+
193
+ _(Optional)_ Team UUID. If not specified, it defaults to personal. In an environment where personal projects do not exist, a team UUID must be specified
194
+
195
+ </td></tr>
196
+ <tr><td>
197
+
198
+ folderUuid
199
+
200
+ </td><td>
201
+
202
+ string
203
+
204
+ </td><td>
205
+
206
+ _(Optional)_ Folder UUID. If not specified, it is the root folder
207
+
208
+ </td></tr>
209
+ <tr><td>
210
+
211
+ description
212
+
213
+ </td><td>
214
+
215
+ string
216
+
217
+ </td><td>
218
+
219
+ _(Optional)_ Project description
220
+
221
+ </td></tr>
222
+ <tr><td>
223
+
224
+ collaborationMode
225
+
226
+ </td><td>
227
+
228
+ [EDMT\_ProjectCollaborationMode](../enums/EDMT_ProjectCollaborationMode.md)
229
+
230
+ </td><td>
231
+
232
+ _(Optional)_ Project collaboration mode. If the team permission does not require the project to set a collaboration mode, this parameter will be ignored
233
+
234
+ </td></tr>
235
+ <tr><td>
236
+
237
+ fileFormat
238
+
239
+ </td><td>
240
+
241
+ [EDMT\_ProjectFileFormat](../enums/EDMT_ProjectFileFormat.md)
242
+
243
+ </td><td>
244
+
245
+ _(Optional)_ 工程文件格式,缺省为 `EPRJ3`<!-- -->;仅在客户端半离线 / 全离线模式生效,在线环境将忽略该参数
246
+
247
+ </td></tr>
248
+ </tbody></table>
249
+
250
+ ## Returns
251
+
252
+ Promise&lt;string \| undefined&gt;
253
+
254
+ Project UUID, if it is `undefined` creation fails
255
+
256
+ ## Remarks
257
+
258
+ 新建工程 \*\*不初始化任何文档\*\*(`getAllBoardsInfo` 等返回空数组), 需显式创建 schematic / pcb / board / 首页后再使用
259
+
260
+ ## Example
261
+
262
+ ```javascript
263
+ // 1. 创建测试工程(友好名带时间戳避免重名,名称与团队留空走默认)
264
+ const projectUuid = await eda.dmt_Project.createProject(
265
+ `嘉立创示例_工程 ${Date.now()}`,
266
+ undefined,
267
+ undefined,
268
+ undefined,
269
+ '嘉立创示例:工程创建演示',
270
+ );
271
+
272
+ // 2. 等待工作区同步后回读,确认工程已落地
273
+ await new Promise(r => setTimeout(r, 1500));
274
+ const brief = await eda.dmt_Project.getProjectInfo(projectUuid);
275
+
276
+ const folderLabel = !brief?.folderUuid ? '(根目录)' : brief.folderUuid;
277
+
278
+ console.log('projectUuid:', projectUuid);
279
+ console.log('friendlyName:', brief?.friendlyName);
280
+ console.log('folderUuid:', folderLabel);
281
+ ```
282
+
283
+ ### getallprojectsuuid
284
+
285
+ # DMT\_Project.getAllProjectsUuid() method
286
+
287
+ Get the UUIDs of all projects
288
+
289
+ ## Signature
290
+
291
+ ```typescript
292
+ function getAllProjectsUuid(
293
+ teamUuid?: string,
294
+ folderUuid?: string,
295
+ workspaceUuid?: string,
296
+ ): Promise<Array<string>>;
297
+ ```
298
+
299
+ ## Parameters
300
+
301
+ <table><thead><tr><th>
302
+
303
+ Parameter
304
+
305
+ </th><th>
306
+
307
+ Type
308
+
309
+ </th><th>
310
+
311
+ Description
312
+
313
+ </th></tr></thead>
314
+ <tbody><tr><td>
315
+
316
+ teamUuid
317
+
318
+ </td><td>
319
+
320
+ string
321
+
322
+ </td><td>
323
+
324
+ _(Optional)_ Team UUID
325
+
326
+ </td></tr>
327
+ <tr><td>
328
+
329
+ folderUuid
330
+
331
+ </td><td>
332
+
333
+ string
334
+
335
+ </td><td>
336
+
337
+ _(Optional)_ Folder UUID. If not specified, it defaults to the root folder of the team
338
+
339
+ </td></tr>
340
+ <tr><td>
341
+
342
+ workspaceUuid
343
+
344
+ </td><td>
345
+
346
+ string
347
+
348
+ </td><td>
349
+
350
+ _(Optional)_ Workspace UUID
351
+
352
+ </td></tr>
353
+ </tbody></table>
354
+
355
+ ## Returns
356
+
357
+ Promise&lt;Array&lt;string&gt;&gt;
358
+
359
+ Project UUID array
360
+
361
+ ## Remarks
362
+
363
+ If `teamUuid` is specified, all projects under the specified team are obtained;
364
+
365
+ If `folderUuid` is specified, all projects under the specified folder are obtained;
366
+
367
+ `teamUuid`<!-- -->, `folderUuid` only one of them may be specified, if both are specified, only `folderUuid`<!-- -->;
368
+
369
+ If `workspaceUuid` is specified, all projects under the specified team/folder are obtained in the specified Workspace
370
+
371
+ ## Example
372
+
373
+ ```javascript
374
+ // 1. 取当前工程所属团队
375
+ const projectInfo = await eda.dmt_Project.getCurrentProjectInfo();
376
+ const teamUuid = projectInfo.teamUuid;
377
+
378
+ // 2. 获取该团队下所有工程的 UUID
379
+ const projectUuids = await eda.dmt_Project.getAllProjectsUuid(teamUuid);
380
+
381
+ console.log('projectCount:', projectUuids.length);
382
+ console.log('projectUuids:', projectUuids.join(', '));
383
+ ```
384
+
385
+ ### getcurrentprojectinfo
386
+
387
+ # DMT\_Project.getCurrentProjectInfo() method
388
+
389
+ Get detailed properties of Current project
390
+
391
+ ## Signature
392
+
393
+ ```typescript
394
+ function getCurrentProjectInfo(): Promise<IDMT_ProjectItem | undefined>;
395
+ ```
396
+
397
+ ## Returns
398
+
399
+ Promise&lt;[IDMT\_ProjectItem](../interfaces/IDMT_ProjectItem.md) \| undefined&gt;
400
+
401
+ Project property; if it is `undefined`<!-- -->, the retrieval failed
402
+
403
+ ## Remarks
404
+
405
+ It will get the detailed properties of the project associated with the currently open schematic, PCB, or panel that has the last input focus
406
+
407
+ ### getprojectinfo
408
+
409
+ # DMT\_Project.getProjectInfo() method
410
+
411
+ Get Project property
412
+
413
+ ## Signature
414
+
415
+ ```typescript
416
+ function getProjectInfo(projectUuid: string): Promise<IDMT_BriefProjectItem | undefined>;
417
+ ```
418
+
419
+ ## Parameters
420
+
421
+ <table><thead><tr><th>
422
+
423
+ Parameter
424
+
425
+ </th><th>
426
+
427
+ Type
428
+
429
+ </th><th>
430
+
431
+ Description
432
+
433
+ </th></tr></thead>
434
+ <tbody><tr><td>
435
+
436
+ projectUuid
437
+
438
+ </td><td>
439
+
440
+ string
441
+
442
+ </td><td>
443
+
444
+ Project UUID
445
+
446
+ </td></tr>
447
+ </tbody></table>
448
+
449
+ ## Returns
450
+
451
+ Promise&lt;[IDMT\_BriefProjectItem](../interfaces/IDMT_BriefProjectItem.md) \| undefined&gt;
452
+
453
+ Brief project properties. If it is `undefined`<!-- -->, the retrieval failed
454
+
455
+ ## Remarks
456
+
457
+ This API can only read brief project properties. For the detailed project tree, use the [getCurrentProjectInfo](./DMT_Project.md) API
458
+
459
+ ### getreadystate
460
+
461
+ # DMT\_Project.getReadyState() method
462
+
463
+ > 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.
464
+
465
+ 获取工程的就绪状态
466
+
467
+ ## Signature
468
+
469
+ ```typescript
470
+ function getReadyState(projectUuid?: string): Promise<EDMT_ProjectReadyState>;
471
+ ```
472
+
473
+ ## Parameters
474
+
475
+ <table><thead><tr><th>
476
+
477
+ Parameter
478
+
479
+ </th><th>
480
+
481
+ Type
482
+
483
+ </th><th>
484
+
485
+ Description
486
+
487
+ </th></tr></thead>
488
+ <tbody><tr><td>
489
+
490
+ projectUuid
491
+
492
+ </td><td>
493
+
494
+ string
495
+
496
+ </td><td>
497
+
498
+ _(Optional)_ 工程 UUID 或客户端工程文件路径,如若不指定,则默认为当前工程
499
+
500
+ </td></tr>
501
+ </tbody></table>
502
+
503
+ ## Returns
504
+
505
+ Promise&lt;[EDMT\_ProjectReadyState](../enums/EDMT_ProjectReadyState.md)<!-- -->&gt;
506
+
507
+ 目标工程的就绪状态
508
+
509
+ ## Remarks
510
+
511
+ 返回工程的就绪阶段(未加载 / 加载中 / 就绪 / 失败),无需依赖业务数据推断 ADD since EDA v4.1.79
512
+
513
+ ### moveprojecttofolder
514
+
515
+ # DMT\_Project.moveProjectToFolder() method
516
+
517
+ Move a project to a folder
518
+
519
+ ## Signature
520
+
521
+ ```typescript
522
+ function moveProjectToFolder(projectUuid: string, folderUuid?: string): Promise<boolean>;
523
+ ```
524
+
525
+ ## Parameters
526
+
527
+ <table><thead><tr><th>
528
+
529
+ Parameter
530
+
531
+ </th><th>
532
+
533
+ Type
534
+
535
+ </th><th>
536
+
537
+ Description
538
+
539
+ </th></tr></thead>
540
+ <tbody><tr><td>
541
+
542
+ projectUuid
543
+
544
+ </td><td>
545
+
546
+ string
547
+
548
+ </td><td>
549
+
550
+ Project UUID
551
+
552
+ </td></tr>
553
+ <tr><td>
554
+
555
+ folderUuid
556
+
557
+ </td><td>
558
+
559
+ string
560
+
561
+ </td><td>
562
+
563
+ _(Optional)_ Folder UUID, which can only be a folder under the team or personal space where the current project is located. If it is `undefined`<!-- -->, it is moved to the root folder of the current team
564
+
565
+ </td></tr>
566
+ </tbody></table>
567
+
568
+ ## Returns
569
+
570
+ Promise&lt;boolean&gt;
571
+
572
+ Whether the move is successful
573
+
574
+ ## Example
575
+
576
+ ```javascript
577
+ // 1. 记录当前工程的位置,作为移动后恢复的锚点
578
+ const info = await eda.dmt_Project.getCurrentProjectInfo();
579
+ const projectUuid = info.uuid;
580
+ const teamUuid = info.teamUuid;
581
+ const originalFolderUuid = info.folderUuid; // 可能为 undefined(团队根目录)
582
+
583
+ // 2. 创建目标文件夹,等待 1.5s 让工作区同步
584
+ const targetFolderUuid = await eda.dmt_Folder.createFolder('嘉立创示例_目标文件夹', teamUuid);
585
+ await new Promise(r => setTimeout(r, 1500));
586
+
587
+ // 3. 把当前工程移到目标文件夹下
588
+ const moved = await eda.dmt_Project.moveProjectToFolder(projectUuid, targetFolderUuid);
589
+ await new Promise(r => setTimeout(r, 1000));
590
+
591
+ // 4. 回读验证工程已落到目标文件夹
592
+ const after = await eda.dmt_Project.getCurrentProjectInfo();
593
+ const folderChanged = after?.folderUuid === targetFolderUuid;
594
+
595
+ // 5. 恢复:移回原位置(原为根目录时传 undefined)
596
+ const restored = await eda.dmt_Project.moveProjectToFolder(projectUuid, originalFolderUuid);
597
+ await new Promise(r => setTimeout(r, 1000));
598
+
599
+ console.log('moved:', moved);
600
+ console.log('folderChanged:', folderChanged);
601
+ console.log('restored:', restored);
602
+ ```
603
+
604
+ ### openproject
605
+
606
+ # DMT\_Project.openProject() method
607
+
608
+ Open project
609
+
610
+ ## Signature
611
+
612
+ ```typescript
613
+ function openProject(projectUuid: string): Promise<boolean>;
614
+ ```
615
+
616
+ ## Parameters
617
+
618
+ <table><thead><tr><th>
619
+
620
+ Parameter
621
+
622
+ </th><th>
623
+
624
+ Type
625
+
626
+ </th><th>
627
+
628
+ Description
629
+
630
+ </th></tr></thead>
631
+ <tbody><tr><td>
632
+
633
+ projectUuid
634
+
635
+ </td><td>
636
+
637
+ string
638
+
639
+ </td><td>
640
+
641
+ Project UUID
642
+
643
+ </td></tr>
644
+ </tbody></table>
645
+
646
+ ## Returns
647
+
648
+ Promise&lt;boolean&gt;
649
+
650
+ Whether Successful open project
651
+
652
+ ## Remarks
653
+
654
+ This operation will open the specified project in the EDA front end. If another project was previously opened with unsaved changes, executing this operation will directly lose all unsaved data
655
+
656
+ ## Example
657
+
658
+ ```javascript
659
+ // 1. 取当前工程 UUID(打开自身,避免切换到其它工程)
660
+ const info = await eda.dmt_Project.getCurrentProjectInfo();
661
+ const projectUuid = info.uuid;
662
+
663
+ // 2. 打开该工程
664
+ const opened = await eda.dmt_Project.openProject(projectUuid);
665
+
666
+ console.log('opened:', opened);
667
+ ```
668
+
669
+ ### waitforready
670
+
671
+ # DMT\_Project.waitForReady() method
672
+
673
+ > 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.
674
+
675
+ 等待工程就绪
676
+
677
+ ## Signature
678
+
679
+ ```typescript
680
+ function waitForReady(projectUuid?: string, timeoutMs?: number): Promise<boolean>;
681
+ ```
682
+
683
+ ## Parameters
684
+
685
+ <table><thead><tr><th>
686
+
687
+ Parameter
688
+
689
+ </th><th>
690
+
691
+ Type
692
+
693
+ </th><th>
694
+
695
+ Description
696
+
697
+ </th></tr></thead>
698
+ <tbody><tr><td>
699
+
700
+ projectUuid
701
+
702
+ </td><td>
703
+
704
+ string
705
+
706
+ </td><td>
707
+
708
+ _(Optional)_ 工程 UUID 或客户端工程文件路径,如若不指定,则默认为当前工程
709
+
710
+ </td></tr>
711
+ <tr><td>
712
+
713
+ timeoutMs
714
+
715
+ </td><td>
716
+
717
+ number
718
+
719
+ </td><td>
720
+
721
+ _(Optional)_ 最长等待时间(毫秒),缺省为 60000
722
+
723
+ </td></tr>
724
+ </tbody></table>
725
+
726
+ ## Returns
727
+
728
+ Promise&lt;boolean&gt;
729
+
730
+ 工程是否已在超时前就绪
731
+
732
+ ## Remarks
733
+
734
+ 阻塞等待目标工程数据加载完成,返回前不会误判「工程为空」;超过 `timeoutMs` 仍未就绪时返回 `false` ADD since EDA v4.1.79