@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,1195 +1,1341 @@
1
- # LIB\_Symbol class
2
-
3
- Comprehensive library / symbol class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class LIB_Symbol
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
- [copy(symbolUuid, libraryUuid, targetLibraryUuid, targetClassification, newSymbolName)](./LIB_Symbol.md)
29
-
30
- </td><td>
31
-
32
- </td><td>
33
-
34
- **_(BETA)_** Copy Symbol
35
-
36
- </td></tr>
37
- <tr><td>
38
-
39
- [create(libraryUuid, symbolName, classification, symbolType, description)](./LIB_Symbol.md)
40
-
41
- </td><td>
42
-
43
- </td><td>
44
-
45
- **_(BETA)_** Create Symbol
46
-
47
- </td></tr>
48
- <tr><td>
49
-
50
- [delete(symbolUuid, libraryUuid)](./LIB_Symbol.md)
51
-
52
- </td><td>
53
-
54
- </td><td>
55
-
56
- **_(BETA)_** Delete Symbol
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- [get(symbolUuid, libraryUuid)](./LIB_Symbol.md)
62
-
63
- </td><td>
64
-
65
- </td><td>
66
-
67
- **_(BETA)_** Get all properties of the symbol
68
-
69
- </td></tr>
70
- <tr><td>
71
-
72
- [getRenderImage(source)](./LIB_Symbol.md)
73
-
74
- </td><td>
75
-
76
- </td><td>
77
-
78
- **_(BETA)_** Get the symbol render image
79
-
80
- </td></tr>
81
- <tr><td>
82
-
83
- [modify(symbolUuid, libraryUuid, symbolName, classification, description)](./LIB_Symbol.md)
84
-
85
- </td><td>
86
-
87
- </td><td>
88
-
89
- **_(BETA)_** Modify Symbol
90
-
91
- </td></tr>
92
- <tr><td>
93
-
94
- [openInEditor(symbolUuid, libraryUuid, splitScreenId)](./LIB_Symbol.md)
95
-
96
- </td><td>
97
-
98
- </td><td>
99
-
100
- **_(BETA)_** Open in the editor document
101
-
102
- </td></tr>
103
- <tr><td>
104
-
105
- [search(key, libraryUuid, classification, symbolType, itemsOfPage, page)](./LIB_Symbol.md)
106
-
107
- </td><td>
108
-
109
- </td><td>
110
-
111
- **_(BETA)_** Search symbol
112
-
113
- </td></tr>
114
- <tr><td>
115
-
116
- [searchByProperties(properties, libraryUuid)](./LIB_Symbol.md)
117
-
118
- </td><td>
119
-
120
- </td><td>
121
-
122
- **_(BETA)_** Search symbols precisely by properties
123
-
124
- </td></tr>
125
- <tr><td>
126
-
127
- [updateDocumentSource(symbolUuid, libraryUuid, documentSource)](./LIB_Symbol.md)
128
-
129
- </td><td>
130
-
131
- </td><td>
132
-
133
- **_(BETA)_** Update the document source code of the symbol
134
-
135
- </td></tr>
136
- </tbody></table>
137
-
138
- ---
139
-
140
- ## 方法详情
141
-
142
- ### copy
143
-
144
- # LIB\_Symbol.copy() method
145
-
146
- > 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.
147
-
148
- Copy Symbol
149
-
150
- ## Signature
151
-
152
- ```typescript
153
- function copy(
154
- symbolUuid: string,
155
- libraryUuid: string,
156
- targetLibraryUuid: string,
157
- targetClassification?: ILIB_ClassificationIndex | Array<string>,
158
- newSymbolName?: string,
159
- ): Promise<string | undefined>;
160
- ```
161
-
162
- ## Parameters
163
-
164
- <table><thead><tr><th>
165
-
166
- Parameter
167
-
168
- </th><th>
169
-
170
- Type
171
-
172
- </th><th>
173
-
174
- Description
175
-
176
- </th></tr></thead>
177
- <tbody><tr><td>
178
-
179
- symbolUuid
180
-
181
- </td><td>
182
-
183
- string
184
-
185
- </td><td>
186
-
187
- Symbol UUID
188
-
189
- </td></tr>
190
- <tr><td>
191
-
192
- libraryUuid
193
-
194
- </td><td>
195
-
196
- string
197
-
198
- </td><td>
199
-
200
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
201
-
202
- </td></tr>
203
- <tr><td>
204
-
205
- targetLibraryUuid
206
-
207
- </td><td>
208
-
209
- string
210
-
211
- </td><td>
212
-
213
- Target library UUID
214
-
215
- </td></tr>
216
- <tr><td>
217
-
218
- targetClassification
219
-
220
- </td><td>
221
-
222
- [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
223
-
224
- </td><td>
225
-
226
- _(Optional)_ Classification in the target library
227
-
228
- </td></tr>
229
- <tr><td>
230
-
231
- newSymbolName
232
-
233
- </td><td>
234
-
235
- string
236
-
237
- </td><td>
238
-
239
- _(Optional)_ New symbol name. If a symbol with the same name exists in the target library, the copy will fail
240
-
241
- </td></tr>
242
- </tbody></table>
243
-
244
- ## Returns
245
-
246
- Promise&lt;string \| undefined&gt;
247
-
248
- UUID of the new symbol in the target library
249
-
250
- ## Example
251
-
252
- ```javascript
253
- // 1. 列出系统库符号(关键字传空 = 列出全部),取一个作为复制来源
254
- const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
255
-
256
- // 2. 获取个人库 UUID
257
- const targetLibraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
258
-
259
- // 3. 从系统库复制到个人库,指定新名称避免同名冲突(分类传 [] = 不分类)
260
- const newName = `嘉立创示例_符号副本_${Date.now()}`;
261
- const copiedUuid = await eda.lib_Symbol.copy(
262
- source.uuid,
263
- source.libraryUuid,
264
- targetLibraryUuid,
265
- [],
266
- newName
267
- );
268
-
269
- // 创建类保留现场(副本留在个人库中供观察)
270
-
271
- console.log('sourceUuid:', source.uuid);
272
- console.log('copiedUuid:', copiedUuid);
273
- console.log('newName:', newName);
274
- ```
275
-
276
- ### create
277
-
278
- # LIB\_Symbol.create() method
279
-
280
- > 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.
281
-
282
- Create Symbol
283
-
284
- ## Signature
285
-
286
- ```typescript
287
- function create(
288
- libraryUuid: string,
289
- symbolName: string,
290
- classification?: ILIB_ClassificationIndex | Array<string>,
291
- symbolType?: ELIB_SymbolType,
292
- description?: string,
293
- ): Promise<string | undefined>;
294
- ```
295
-
296
- ## Parameters
297
-
298
- <table><thead><tr><th>
299
-
300
- Parameter
301
-
302
- </th><th>
303
-
304
- Type
305
-
306
- </th><th>
307
-
308
- Description
309
-
310
- </th></tr></thead>
311
- <tbody><tr><td>
312
-
313
- libraryUuid
314
-
315
- </td><td>
316
-
317
- string
318
-
319
- </td><td>
320
-
321
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
322
-
323
- </td></tr>
324
- <tr><td>
325
-
326
- symbolName
327
-
328
- </td><td>
329
-
330
- string
331
-
332
- </td><td>
333
-
334
- Symbol name
335
-
336
- </td></tr>
337
- <tr><td>
338
-
339
- classification
340
-
341
- </td><td>
342
-
343
- [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
344
-
345
- </td><td>
346
-
347
- _(Optional)_ Classification
348
-
349
- </td></tr>
350
- <tr><td>
351
-
352
- symbolType
353
-
354
- </td><td>
355
-
356
- [ELIB\_SymbolType](../enums/ELIB_SymbolType.md)
357
-
358
- </td><td>
359
-
360
- _(Optional)_ Symbol type
361
-
362
- </td></tr>
363
- <tr><td>
364
-
365
- description
366
-
367
- </td><td>
368
-
369
- string
370
-
371
- </td><td>
372
-
373
- _(Optional)_ Description
374
-
375
- </td></tr>
376
- </tbody></table>
377
-
378
- ## Returns
379
-
380
- Promise&lt;string \| undefined&gt;
381
-
382
- Symbol UUID
383
-
384
- ## Example
385
-
386
- ```javascript
387
- // 1. 获取个人库 UUID
388
- const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
389
-
390
- // 2. 创建符号(分类传 [] = 不分类;符号类型 '1' = 原理图符号,见 ELIB_SymbolType)
391
- const symbolName = `嘉立创示例_新符号_${Date.now()}`;
392
- const symbolUuid = await eda.lib_Symbol.create(libraryUuid, symbolName, [], '1', '示例符号描述');
393
-
394
- // 创建类保留现场(新符号留在个人库中供观察)
395
-
396
- console.log('symbolUuid:', symbolUuid);
397
- console.log('symbolName:', symbolName);
398
- ```
399
-
400
- ### delete
401
-
402
- # LIB\_Symbol.delete() method
403
-
404
- > 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.
405
-
406
- Delete Symbol
407
-
408
- ## Signature
409
-
410
- ```typescript
411
- function delete(symbolUuid: string, libraryUuid: string): Promise<boolean>;
412
- ```
413
-
414
- ## Parameters
415
-
416
- <table><thead><tr><th>
417
-
418
- Parameter
419
-
420
- </th><th>
421
-
422
- Type
423
-
424
- </th><th>
425
-
426
- Description
427
-
428
- </th></tr></thead>
429
- <tbody><tr><td>
430
-
431
- symbolUuid
432
-
433
- </td><td>
434
-
435
- string
436
-
437
- </td><td>
438
-
439
- Symbol UUID
440
-
441
- </td></tr>
442
- <tr><td>
443
-
444
- libraryUuid
445
-
446
- </td><td>
447
-
448
- string
449
-
450
- </td><td>
451
-
452
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
453
-
454
- </td></tr>
455
- </tbody></table>
456
-
457
- ## Returns
458
-
459
- Promise&lt;boolean&gt;
460
-
461
- Whether the operation is successful
462
-
463
- ## Example
464
-
465
- ```javascript
466
- // 1. 获取个人库 UUID 并新建删除对象
467
- const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
468
- const symbolUuid = await eda.lib_Symbol.create(libraryUuid, `嘉立创示例_待删除符号_${Date.now()}`, []);
469
-
470
- // 2. 删除该符号
471
- const deleted = await eda.lib_Symbol.delete(symbolUuid, libraryUuid);
472
-
473
- console.log('symbolUuid:', symbolUuid);
474
- console.log('deleted:', deleted);
475
- ```
476
-
477
- ### get
478
-
479
- # LIB\_Symbol.get() method
480
-
481
- > 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.
482
-
483
- Get all properties of the symbol
484
-
485
- ## Signature
486
-
487
- ```typescript
488
- function get(symbolUuid: string, libraryUuid?: string): Promise<ILIB_SymbolItem | undefined>;
489
- ```
490
-
491
- ## Parameters
492
-
493
- <table><thead><tr><th>
494
-
495
- Parameter
496
-
497
- </th><th>
498
-
499
- Type
500
-
501
- </th><th>
502
-
503
- Description
504
-
505
- </th></tr></thead>
506
- <tbody><tr><td>
507
-
508
- symbolUuid
509
-
510
- </td><td>
511
-
512
- string
513
-
514
- </td><td>
515
-
516
- Symbol UUID
517
-
518
- </td></tr>
519
- <tr><td>
520
-
521
- libraryUuid
522
-
523
- </td><td>
524
-
525
- string
526
-
527
- </td><td>
528
-
529
- _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
530
-
531
- </td></tr>
532
- </tbody></table>
533
-
534
- ## Returns
535
-
536
- Promise&lt;[ILIB\_SymbolItem](../interfaces/ILIB_SymbolItem.md) \| undefined&gt;
537
-
538
- Symbol property
539
-
540
- ### getrenderimage
541
-
542
- # LIB\_Symbol.getRenderImage() method
543
-
544
- > 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.
545
-
546
- Get the symbol render image
547
-
548
- ## Signature
549
-
550
- ```typescript
551
- function getRenderImage(source: {
552
- symbolUuid: string;
553
- libraryUuid: string;
554
- subPartName?: undefined | string;
555
- }): Promise<Blob | undefined>;
556
- ```
557
-
558
- ## Parameters
559
-
560
- <table><thead><tr><th>
561
-
562
- Parameter
563
-
564
- </th><th>
565
-
566
- Type
567
-
568
- </th><th>
569
-
570
- Description
571
-
572
- </th></tr></thead>
573
- <tbody><tr><td>
574
-
575
- source
576
-
577
- </td><td>
578
-
579
- \{ symbolUuid: string; libraryUuid: string; subPartName?: undefined \| string \}
580
-
581
- </td><td>
582
-
583
- </td></tr>
584
- </tbody></table>
585
-
586
- ## Returns
587
-
588
- Promise&lt;Blob \| undefined&gt;
589
-
590
- Symbol render image
591
-
592
- ## Example
593
-
594
- ```javascript
595
- // 1. 列出系统库符号,取一个作为渲染来源
596
- const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
597
-
598
- // 2. 获取渲染图(PNG Blob)
599
- const blob = await eda.lib_Symbol.getRenderImage({
600
- symbolUuid: source.uuid,
601
- libraryUuid: source.libraryUuid,
602
- });
603
-
604
- // 3. Blob 可转成 URL 直接展示:URL.createObjectURL(blob)
605
- console.log('sourceName:', source.name);
606
- console.log('imageSize:', blob.size);
607
- console.log('imageType:', blob.type);
608
- ```
609
-
610
- ### modify
611
-
612
- # LIB\_Symbol.modify() method
613
-
614
- > 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.
615
-
616
- Modify Symbol
617
-
618
- ## Signature
619
-
620
- ```typescript
621
- function modify(
622
- symbolUuid: string,
623
- libraryUuid: string,
624
- symbolName?: string,
625
- classification?: ILIB_ClassificationIndex | Array<string> | null,
626
- description?: string | null,
627
- ): Promise<boolean>;
628
- ```
629
-
630
- ## Parameters
631
-
632
- <table><thead><tr><th>
633
-
634
- Parameter
635
-
636
- </th><th>
637
-
638
- Type
639
-
640
- </th><th>
641
-
642
- Description
643
-
644
- </th></tr></thead>
645
- <tbody><tr><td>
646
-
647
- symbolUuid
648
-
649
- </td><td>
650
-
651
- string
652
-
653
- </td><td>
654
-
655
- Symbol UUID
656
-
657
- </td></tr>
658
- <tr><td>
659
-
660
- libraryUuid
661
-
662
- </td><td>
663
-
664
- string
665
-
666
- </td><td>
667
-
668
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
669
-
670
- </td></tr>
671
- <tr><td>
672
-
673
- symbolName
674
-
675
- </td><td>
676
-
677
- string
678
-
679
- </td><td>
680
-
681
- _(Optional)_ Symbol name
682
-
683
- </td></tr>
684
- <tr><td>
685
-
686
- classification
687
-
688
- </td><td>
689
-
690
- [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt; \| null
691
-
692
- </td><td>
693
-
694
- _(Optional)_ Classification
695
-
696
- </td></tr>
697
- <tr><td>
698
-
699
- description
700
-
701
- </td><td>
702
-
703
- string \| null
704
-
705
- </td><td>
706
-
707
- _(Optional)_ Description
708
-
709
- </td></tr>
710
- </tbody></table>
711
-
712
- ## Returns
713
-
714
- Promise&lt;boolean&gt;
715
-
716
- Whether the operation is successful
717
-
718
- ## Remarks
719
-
720
- If you want to clear certain properties, set their values to `null`
721
-
722
- ## Example
723
-
724
- ```javascript
725
- // 1. 获取个人库 UUID 并新建修改对象
726
- const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
727
- const symbolUuid = await eda.lib_Symbol.create(
728
- libraryUuid,
729
- `嘉立创示例_符号修改前_${Date.now()}`,
730
- [],
731
- '1',
732
- '修改前的描述'
733
- );
734
-
735
- // 2. 修改名称和描述(分类保持不变传 [])
736
- const newName = `嘉立创示例_符号修改后_${Date.now()}`;
737
- const modified = await eda.lib_Symbol.modify(symbolUuid, libraryUuid, newName, [], '修改后的描述');
738
-
739
- // 修改类保留现场
740
-
741
- console.log('symbolUuid:', symbolUuid);
742
- console.log('modified:', modified);
743
- console.log('newName:', newName);
744
- ```
745
-
746
- ### openineditor
747
-
748
- # LIB\_Symbol.openInEditor() method
749
-
750
- > 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.
751
-
752
- Open in the editor document
753
-
754
- ## Signature
755
-
756
- ```typescript
757
- function openInEditor(
758
- symbolUuid: string,
759
- libraryUuid: string,
760
- splitScreenId?: string,
761
- ): Promise<string | undefined>;
762
- ```
763
-
764
- ## Parameters
765
-
766
- <table><thead><tr><th>
767
-
768
- Parameter
769
-
770
- </th><th>
771
-
772
- Type
773
-
774
- </th><th>
775
-
776
- Description
777
-
778
- </th></tr></thead>
779
- <tbody><tr><td>
780
-
781
- symbolUuid
782
-
783
- </td><td>
784
-
785
- string
786
-
787
- </td><td>
788
-
789
- Symbol UUID
790
-
791
- </td></tr>
792
- <tr><td>
793
-
794
- libraryUuid
795
-
796
- </td><td>
797
-
798
- string
799
-
800
- </td><td>
801
-
802
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
803
-
804
- </td></tr>
805
- <tr><td>
806
-
807
- splitScreenId
808
-
809
- </td><td>
810
-
811
- string
812
-
813
- </td><td>
814
-
815
- _(Optional)_ Split screen ID. If not filled in, it opens in the split screen with the last input focus by default. It can be obtained using the APIs in [DMT\_EditorControl](./DMT_EditorControl.md)
816
-
817
- </td></tr>
818
- </tbody></table>
819
-
820
- ## Returns
821
-
822
- Promise&lt;string \| undefined&gt;
823
-
824
- Tab ID, corresponding to [IDMT\_EditorTabItem.tabId](../interfaces/IDMT_EditorTabItem.md)<!-- -->. You can use [DMT\_EditorControl.getSplitScreenIdByTabId()](./DMT_EditorControl.md) to get the split screen ID
825
-
826
- ## Example
827
-
828
- ```javascript
829
- // 1. 获取个人库 UUID,从系统库复制一个符号作为编辑对象
830
- const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
831
- const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
832
- const symbolUuid = await eda.lib_Symbol.copy(
833
- source.uuid,
834
- source.libraryUuid,
835
- libraryUuid,
836
- [],
837
- `嘉立创示例_编辑符号_${Date.now()}`
838
- );
839
-
840
- // 2. 在编辑器中打开该符号,返回标签页 ID(uuid@libraryUuid 格式)
841
- const tabId = await eda.lib_Symbol.openInEditor(symbolUuid, libraryUuid);
842
-
843
- // 打开后保留现场(编辑器停留在新符号页供观察;不需要时可传 tabId 给
844
- // dmt_EditorControl.closeDocument 关闭)
845
-
846
- console.log('symbolUuid:', symbolUuid);
847
- console.log('tabId:', tabId);
848
- ```
849
-
850
- ### search
851
-
852
- # LIB\_Symbol.search() method
853
-
854
- > 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.
855
-
856
- Search symbol
857
-
858
- ## Signature
859
-
860
- ```typescript
861
- function search(
862
- key: string,
863
- libraryUuid?: string,
864
- classification?: ILIB_ClassificationIndex | Array<string>,
865
- symbolType?: ELIB_SymbolType,
866
- itemsOfPage?: number,
867
- page?: number,
868
- ): Promise<Array<ILIB_SymbolSearchItem>>;
869
- ```
870
-
871
- ## Parameters
872
-
873
- <table><thead><tr><th>
874
-
875
- Parameter
876
-
877
- </th><th>
878
-
879
- Type
880
-
881
- </th><th>
882
-
883
- Description
884
-
885
- </th></tr></thead>
886
- <tbody><tr><td>
887
-
888
- key
889
-
890
- </td><td>
891
-
892
- string
893
-
894
- </td><td>
895
-
896
- Search keyword
897
-
898
- </td></tr>
899
- <tr><td>
900
-
901
- libraryUuid
902
-
903
- </td><td>
904
-
905
- string
906
-
907
- </td><td>
908
-
909
- _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
910
-
911
- </td></tr>
912
- <tr><td>
913
-
914
- classification
915
-
916
- </td><td>
917
-
918
- [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
919
-
920
- </td><td>
921
-
922
- _(Optional)_ Classification, defaults to all
923
-
924
- </td></tr>
925
- <tr><td>
926
-
927
- symbolType
928
-
929
- </td><td>
930
-
931
- [ELIB\_SymbolType](../enums/ELIB_SymbolType.md)
932
-
933
- </td><td>
934
-
935
- _(Optional)_ Symbol type, defaults to all
936
-
937
- </td></tr>
938
- <tr><td>
939
-
940
- itemsOfPage
941
-
942
- </td><td>
943
-
944
- number
945
-
946
- </td><td>
947
-
948
- _(Optional)_ Number of search results per page
949
-
950
- </td></tr>
951
- <tr><td>
952
-
953
- page
954
-
955
- </td><td>
956
-
957
- number
958
-
959
- </td><td>
960
-
961
- _(Optional)_ Page count
962
-
963
- </td></tr>
964
- </tbody></table>
965
-
966
- ## Returns
967
-
968
- Promise&lt;Array&lt;[ILIB\_SymbolSearchItem](../interfaces/ILIB_SymbolSearchItem.md)<!-- -->&gt;&gt;
969
-
970
- List of searched symbol properties
971
-
972
- ## Example
973
-
974
- ```javascript
975
- // 1. 尝试按关键字搜索(当前版本非空关键字会抛错,如实展示)
976
- try {
977
- const keywordResults = await eda.lib_Symbol.search('0402');
978
- console.log('关键字搜索返回', keywordResults.length, '条');
979
- }
980
- catch (e) {
981
- // 剥掉错误类型前缀;注意:正则写法尾部会产生星号+斜杠序列,会闭掉 tsdoc 注释,故用 split
982
- console.log('关键字搜索当前版本抛错:', String(e.message).split('Error: ').pop());
983
- }
984
-
985
- // 2. 改用空关键字列出系统库符号,每页 5 条
986
- const results = await eda.lib_Symbol.search('', undefined, [], undefined, 5, 1);
987
-
988
- // 3. 输出搜索结果(需要过滤时可按 item.name 自行筛选)
989
- console.log('count:', results.length);
990
- results.forEach((item, i) => {
991
- console.log(`[${i}] name:`, item.name, 'uuid:', item.uuid, 'libraryUuid:', item.libraryUuid);
992
- });
993
- ```
994
-
995
- ### searchbyproperties
996
-
997
- # LIB\_Symbol.searchByProperties() method
998
-
999
- > 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.
1000
-
1001
- Search symbols precisely by properties
1002
-
1003
- ## Signature
1004
-
1005
- ```typescript
1006
- function searchByProperties(
1007
- properties: ILIB_SymbolPropertiesForSearch,
1008
- libraryUuid?: string,
1009
- ): Promise<Array<ILIB_SymbolSearchItem>>;
1010
- ```
1011
-
1012
- ## Parameters
1013
-
1014
- <table><thead><tr><th>
1015
-
1016
- Parameter
1017
-
1018
- </th><th>
1019
-
1020
- Type
1021
-
1022
- </th><th>
1023
-
1024
- Description
1025
-
1026
- </th></tr></thead>
1027
- <tbody><tr><td>
1028
-
1029
- properties
1030
-
1031
- </td><td>
1032
-
1033
- [ILIB\_SymbolPropertiesForSearch](../interfaces/ILIB_SymbolPropertiesForSearch.md)
1034
-
1035
- </td><td>
1036
-
1037
- Property
1038
-
1039
- </td></tr>
1040
- <tr><td>
1041
-
1042
- libraryUuid
1043
-
1044
- </td><td>
1045
-
1046
- string
1047
-
1048
- </td><td>
1049
-
1050
- _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
1051
-
1052
- </td></tr>
1053
- </tbody></table>
1054
-
1055
- ## Returns
1056
-
1057
- Promise&lt;Array&lt;[ILIB\_SymbolSearchItem](../interfaces/ILIB_SymbolSearchItem.md)<!-- -->&gt;&gt;
1058
-
1059
- List of searched symbol properties
1060
-
1061
- ## Example
1062
-
1063
- ```javascript
1064
- // 1. 按名称精确搜索(官方属性集合目前仅支持 name)
1065
- // 当前版本该接口不稳定:可能抛错,也可能正常返回 undefined,两种都要兼容
1066
- let results;
1067
- try {
1068
- results = await eda.lib_Symbol.searchByProperties({ name: '0402' });
1069
- }
1070
- catch (e) {
1071
- console.log('当前版本按 name 搜索抛错:', e.message);
1072
- }
1073
- if (!Array.isArray(results))
1074
- results = [];
1075
-
1076
- // 2. 输出搜索结果
1077
- console.log('count:', results.length);
1078
- results.forEach((item, i) => {
1079
- console.log(`[${i}] name:`, item.name, 'uuid:', item.uuid, 'libraryUuid:', item.libraryUuid);
1080
- });
1081
- ```
1082
-
1083
- ### updatedocumentsource
1084
-
1085
- # LIB\_Symbol.updateDocumentSource() method
1086
-
1087
- > 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.
1088
-
1089
- Update the document source code of the symbol
1090
-
1091
- ## Signature
1092
-
1093
- ```typescript
1094
- function updateDocumentSource(
1095
- symbolUuid: string,
1096
- libraryUuid: string,
1097
- documentSource: string,
1098
- ): Promise<boolean | undefined>;
1099
- ```
1100
-
1101
- ## Parameters
1102
-
1103
- <table><thead><tr><th>
1104
-
1105
- Parameter
1106
-
1107
- </th><th>
1108
-
1109
- Type
1110
-
1111
- </th><th>
1112
-
1113
- Description
1114
-
1115
- </th></tr></thead>
1116
- <tbody><tr><td>
1117
-
1118
- symbolUuid
1119
-
1120
- </td><td>
1121
-
1122
- string
1123
-
1124
- </td><td>
1125
-
1126
- Symbol UUID
1127
-
1128
- </td></tr>
1129
- <tr><td>
1130
-
1131
- libraryUuid
1132
-
1133
- </td><td>
1134
-
1135
- string
1136
-
1137
- </td><td>
1138
-
1139
- Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
1140
-
1141
- </td></tr>
1142
- <tr><td>
1143
-
1144
- documentSource
1145
-
1146
- </td><td>
1147
-
1148
- string
1149
-
1150
- </td><td>
1151
-
1152
- Document source code
1153
-
1154
- </td></tr>
1155
- </tbody></table>
1156
-
1157
- ## Returns
1158
-
1159
- Promise&lt;boolean \| undefined&gt;
1160
-
1161
- Whether the update is successful
1162
-
1163
- ## Example
1164
-
1165
- ```javascript
1166
- // 1. 获取个人库 UUID,从系统库复制一个符号(有内容,源码链路才完整)
1167
- const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
1168
- const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
1169
- const symbolUuid = await eda.lib_Symbol.copy(
1170
- source.uuid,
1171
- source.libraryUuid,
1172
- libraryUuid,
1173
- [],
1174
- `嘉立创示例_源码符号_${Date.now()}`
1175
- );
1176
-
1177
- // 2. 在编辑器中打开符号,等待文档加载完成
1178
- const tabId = await eda.lib_Symbol.openInEditor(symbolUuid, libraryUuid);
1179
- await new Promise(r => setTimeout(r, 1500));
1180
-
1181
- // 3. 读取当前打开符号的文档源码
1182
- const documentSource = await eda.sys_FileManager.getDocumentSource();
1183
-
1184
- // 4. 把源码写回库中的符号(此处原样写回;实际使用时可先改写 documentSource)
1185
- const updated = await eda.lib_Symbol.updateDocumentSource(symbolUuid, libraryUuid, documentSource);
1186
-
1187
- // 5. 关闭编辑器标签页(符号本体保留在库中)
1188
- await eda.dmt_EditorControl.closeDocument(tabId);
1189
-
1190
- // 修改类保留现场
1191
-
1192
- console.log('symbolUuid:', symbolUuid);
1193
- console.log('sourceLength:', documentSource.length);
1194
- console.log('updated:', updated);
1195
- ```
1
+ # LIB\_Symbol class
2
+
3
+ Comprehensive library / symbol class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class LIB_Symbol
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
+ [copy(symbolUuid, libraryUuid, targetLibraryUuid, targetClassification, newSymbolName)](./LIB_Symbol.md)
29
+
30
+ </td><td>
31
+
32
+ </td><td>
33
+
34
+ **_(BETA)_** Copy Symbol
35
+
36
+ </td></tr>
37
+ <tr><td>
38
+
39
+ [create(libraryUuid, symbolName, classification, symbolType, description, otherProperty)](./LIB_Symbol.md)
40
+
41
+ </td><td>
42
+
43
+ </td><td>
44
+
45
+ **_(BETA)_** Create Symbol
46
+
47
+ </td></tr>
48
+ <tr><td>
49
+
50
+ [delete(symbolUuid, libraryUuid)](./LIB_Symbol.md)
51
+
52
+ </td><td>
53
+
54
+ </td><td>
55
+
56
+ **_(BETA)_** Delete Symbol
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [get(symbolUuid, libraryUuid)](./LIB_Symbol.md)
62
+
63
+ </td><td>
64
+
65
+ </td><td>
66
+
67
+ **_(BETA)_** Get all properties of the symbol
68
+
69
+ </td></tr>
70
+ <tr><td>
71
+
72
+ [getDocumentSource(symbolUuid, libraryUuid)](./LIB_Symbol.md)
73
+
74
+ </td><td>
75
+
76
+ </td><td>
77
+
78
+ **_(BETA)_** 获取符号的文档源码
79
+
80
+ </td></tr>
81
+ <tr><td>
82
+
83
+ [getRenderImage(source)](./LIB_Symbol.md)
84
+
85
+ </td><td>
86
+
87
+ </td><td>
88
+
89
+ **_(BETA)_** Get the symbol render image
90
+
91
+ </td></tr>
92
+ <tr><td>
93
+
94
+ [modify(symbolUuid, libraryUuid, symbolName, classification, description, otherProperty)](./LIB_Symbol.md)
95
+
96
+ </td><td>
97
+
98
+ </td><td>
99
+
100
+ **_(BETA)_** Modify Symbol
101
+
102
+ </td></tr>
103
+ <tr><td>
104
+
105
+ [openInEditor(symbolUuid, libraryUuid, splitScreenId)](./LIB_Symbol.md)
106
+
107
+ </td><td>
108
+
109
+ </td><td>
110
+
111
+ **_(BETA)_** Open in the editor document
112
+
113
+ </td></tr>
114
+ <tr><td>
115
+
116
+ [search(key, libraryUuid, classification, symbolType, itemsOfPage, page)](./LIB_Symbol.md)
117
+
118
+ </td><td>
119
+
120
+ </td><td>
121
+
122
+ **_(BETA)_** Search symbol
123
+
124
+ </td></tr>
125
+ <tr><td>
126
+
127
+ [searchByProperties(properties, libraryUuid)](./LIB_Symbol.md)
128
+
129
+ </td><td>
130
+
131
+ </td><td>
132
+
133
+ **_(BETA)_** Search symbols precisely by properties
134
+
135
+ </td></tr>
136
+ <tr><td>
137
+
138
+ [updateDocumentSource(symbolUuid, libraryUuid, documentSource)](./LIB_Symbol.md)
139
+
140
+ </td><td>
141
+
142
+ </td><td>
143
+
144
+ **_(BETA)_** Update the document source code of the symbol
145
+
146
+ </td></tr>
147
+ </tbody></table>
148
+
149
+ ---
150
+
151
+ ## 方法详情
152
+
153
+ ### copy
154
+
155
+ # LIB\_Symbol.copy() method
156
+
157
+ > 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.
158
+
159
+ Copy Symbol
160
+
161
+ ## Signature
162
+
163
+ ```typescript
164
+ function copy(
165
+ symbolUuid: string,
166
+ libraryUuid: string,
167
+ targetLibraryUuid: string,
168
+ targetClassification?: ILIB_ClassificationIndex | Array<string>,
169
+ newSymbolName?: string,
170
+ ): Promise<string | undefined>;
171
+ ```
172
+
173
+ ## Parameters
174
+
175
+ <table><thead><tr><th>
176
+
177
+ Parameter
178
+
179
+ </th><th>
180
+
181
+ Type
182
+
183
+ </th><th>
184
+
185
+ Description
186
+
187
+ </th></tr></thead>
188
+ <tbody><tr><td>
189
+
190
+ symbolUuid
191
+
192
+ </td><td>
193
+
194
+ string
195
+
196
+ </td><td>
197
+
198
+ Symbol UUID
199
+
200
+ </td></tr>
201
+ <tr><td>
202
+
203
+ libraryUuid
204
+
205
+ </td><td>
206
+
207
+ string
208
+
209
+ </td><td>
210
+
211
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
212
+
213
+ </td></tr>
214
+ <tr><td>
215
+
216
+ targetLibraryUuid
217
+
218
+ </td><td>
219
+
220
+ string
221
+
222
+ </td><td>
223
+
224
+ Target library UUID
225
+
226
+ </td></tr>
227
+ <tr><td>
228
+
229
+ targetClassification
230
+
231
+ </td><td>
232
+
233
+ [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
234
+
235
+ </td><td>
236
+
237
+ _(Optional)_ Classification in the target library
238
+
239
+ </td></tr>
240
+ <tr><td>
241
+
242
+ newSymbolName
243
+
244
+ </td><td>
245
+
246
+ string
247
+
248
+ </td><td>
249
+
250
+ _(Optional)_ New symbol name. If a symbol with the same name exists in the target library, the copy will fail
251
+
252
+ </td></tr>
253
+ </tbody></table>
254
+
255
+ ## Returns
256
+
257
+ Promise&lt;string \| undefined&gt;
258
+
259
+ UUID of the new symbol in the target library
260
+
261
+ ## Example
262
+
263
+ ```javascript
264
+ // 1. 列出系统库符号(关键字传空 = 列出全部),取一个作为复制来源
265
+ const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
266
+
267
+ // 2. 获取个人库 UUID
268
+ const targetLibraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
269
+
270
+ // 3. 从系统库复制到个人库,指定新名称避免同名冲突(分类传 [] = 不分类)
271
+ const newName = `嘉立创示例_符号副本_${Date.now()}`;
272
+ const copiedUuid = await eda.lib_Symbol.copy(
273
+ source.uuid,
274
+ source.libraryUuid,
275
+ targetLibraryUuid,
276
+ [],
277
+ newName
278
+ );
279
+
280
+ // 创建类保留现场(副本留在个人库中供观察)
281
+
282
+ console.log('sourceUuid:', source.uuid);
283
+ console.log('copiedUuid:', copiedUuid);
284
+ console.log('newName:', newName);
285
+ ```
286
+
287
+ ### create
288
+
289
+ # LIB\_Symbol.create() method
290
+
291
+ > 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.
292
+
293
+ Create Symbol
294
+
295
+ ## Signature
296
+
297
+ ```typescript
298
+ function create(
299
+ libraryUuid: string,
300
+ symbolName: string,
301
+ classification?: ILIB_ClassificationIndex | Array<string>,
302
+ symbolType?: ELIB_SymbolType,
303
+ description?: string,
304
+ otherProperty?: Record<string, boolean | number | string | undefined>,
305
+ ): Promise<string | undefined>;
306
+ ```
307
+
308
+ ## Parameters
309
+
310
+ <table><thead><tr><th>
311
+
312
+ Parameter
313
+
314
+ </th><th>
315
+
316
+ Type
317
+
318
+ </th><th>
319
+
320
+ Description
321
+
322
+ </th></tr></thead>
323
+ <tbody><tr><td>
324
+
325
+ libraryUuid
326
+
327
+ </td><td>
328
+
329
+ string
330
+
331
+ </td><td>
332
+
333
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
334
+
335
+ </td></tr>
336
+ <tr><td>
337
+
338
+ symbolName
339
+
340
+ </td><td>
341
+
342
+ string
343
+
344
+ </td><td>
345
+
346
+ Symbol name
347
+
348
+ </td></tr>
349
+ <tr><td>
350
+
351
+ classification
352
+
353
+ </td><td>
354
+
355
+ [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
356
+
357
+ </td><td>
358
+
359
+ _(Optional)_ Classification
360
+
361
+ </td></tr>
362
+ <tr><td>
363
+
364
+ symbolType
365
+
366
+ </td><td>
367
+
368
+ [ELIB\_SymbolType](../enums/ELIB_SymbolType.md)
369
+
370
+ </td><td>
371
+
372
+ _(Optional)_ Symbol type
373
+
374
+ </td></tr>
375
+ <tr><td>
376
+
377
+ description
378
+
379
+ </td><td>
380
+
381
+ string
382
+
383
+ </td><td>
384
+
385
+ _(Optional)_ Description
386
+
387
+ </td></tr>
388
+ <tr><td>
389
+
390
+ otherProperty
391
+
392
+ </td><td>
393
+
394
+ Record&lt;string, boolean \| number \| string \| undefined&gt;
395
+
396
+ </td><td>
397
+
398
+ _(Optional)_ 其它属性
399
+
400
+ </td></tr>
401
+ </tbody></table>
402
+
403
+ ## Returns
404
+
405
+ Promise&lt;string \| undefined&gt;
406
+
407
+ Symbol UUID
408
+
409
+ ## Example
410
+
411
+ ```javascript
412
+ // 1. 获取个人库 UUID
413
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
414
+
415
+ // 2. 创建符号(分类传 [] = 不分类;符号类型见 ELIB_SymbolType)
416
+ const symbolName = `嘉立创示例_新符号_${Date.now()}`;
417
+ const symbolUuid = await eda.lib_Symbol.create(libraryUuid, symbolName, [], ELIB_SymbolType.COMPONENT, '示例符号描述');
418
+
419
+ // 创建类保留现场(新符号留在个人库中供观察)
420
+
421
+ console.log('symbolUuid:', symbolUuid);
422
+ console.log('symbolName:', symbolName);
423
+ ```
424
+
425
+ ### delete
426
+
427
+ # LIB\_Symbol.delete() method
428
+
429
+ > 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.
430
+
431
+ Delete Symbol
432
+
433
+ ## Signature
434
+
435
+ ```typescript
436
+ function delete(symbolUuid: string, libraryUuid: string): Promise<boolean | undefined>;
437
+ ```
438
+
439
+ ## Parameters
440
+
441
+ <table><thead><tr><th>
442
+
443
+ Parameter
444
+
445
+ </th><th>
446
+
447
+ Type
448
+
449
+ </th><th>
450
+
451
+ Description
452
+
453
+ </th></tr></thead>
454
+ <tbody><tr><td>
455
+
456
+ symbolUuid
457
+
458
+ </td><td>
459
+
460
+ string
461
+
462
+ </td><td>
463
+
464
+ Symbol UUID
465
+
466
+ </td></tr>
467
+ <tr><td>
468
+
469
+ libraryUuid
470
+
471
+ </td><td>
472
+
473
+ string
474
+
475
+ </td><td>
476
+
477
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
478
+
479
+ </td></tr>
480
+ </tbody></table>
481
+
482
+ ## Returns
483
+
484
+ Promise&lt;boolean \| undefined&gt;
485
+
486
+ Whether the operation is successful
487
+
488
+ ## Example
489
+
490
+ ```javascript
491
+ // 1. 获取个人库 UUID 并新建删除对象
492
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
493
+ const symbolUuid = await eda.lib_Symbol.create(libraryUuid, `嘉立创示例_待删除符号_${Date.now()}`, []);
494
+
495
+ // 2. 删除该符号
496
+ const deleted = await eda.lib_Symbol.delete(symbolUuid, libraryUuid);
497
+
498
+ console.log('symbolUuid:', symbolUuid);
499
+ console.log('deleted:', deleted);
500
+ ```
501
+
502
+ ### get
503
+
504
+ # LIB\_Symbol.get() method
505
+
506
+ > 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.
507
+
508
+ Get all properties of the symbol
509
+
510
+ ## Signature
511
+
512
+ ```typescript
513
+ function get(symbolUuid: string, libraryUuid?: string): Promise<ILIB_SymbolItem | undefined>;
514
+ ```
515
+
516
+ ## Parameters
517
+
518
+ <table><thead><tr><th>
519
+
520
+ Parameter
521
+
522
+ </th><th>
523
+
524
+ Type
525
+
526
+ </th><th>
527
+
528
+ Description
529
+
530
+ </th></tr></thead>
531
+ <tbody><tr><td>
532
+
533
+ symbolUuid
534
+
535
+ </td><td>
536
+
537
+ string
538
+
539
+ </td><td>
540
+
541
+ Symbol UUID
542
+
543
+ </td></tr>
544
+ <tr><td>
545
+
546
+ libraryUuid
547
+
548
+ </td><td>
549
+
550
+ string
551
+
552
+ </td><td>
553
+
554
+ _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
555
+
556
+ </td></tr>
557
+ </tbody></table>
558
+
559
+ ## Returns
560
+
561
+ Promise&lt;[ILIB\_SymbolItem](../interfaces/ILIB_SymbolItem.md) \| undefined&gt;
562
+
563
+ Symbol property
564
+
565
+ ### getdocumentsource
566
+
567
+ # LIB\_Symbol.getDocumentSource() method
568
+
569
+ > 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.
570
+
571
+ 获取符号的文档源码
572
+
573
+ ## Signature
574
+
575
+ ```typescript
576
+ function getDocumentSource(symbolUuid: string, libraryUuid?: string): Promise<string | undefined>;
577
+ ```
578
+
579
+ ## Parameters
580
+
581
+ <table><thead><tr><th>
582
+
583
+ Parameter
584
+
585
+ </th><th>
586
+
587
+ Type
588
+
589
+ </th><th>
590
+
591
+ Description
592
+
593
+ </th></tr></thead>
594
+ <tbody><tr><td>
595
+
596
+ symbolUuid
597
+
598
+ </td><td>
599
+
600
+ string
601
+
602
+ </td><td>
603
+
604
+ 符号 UUID
605
+
606
+ </td></tr>
607
+ <tr><td>
608
+
609
+ libraryUuid
610
+
611
+ </td><td>
612
+
613
+ string
614
+
615
+ </td><td>
616
+
617
+ _(Optional)_ 库 UUID,默认为系统库,可以使用 [LIB\_LibrariesList](./LIB_LibrariesList.md) 内的接口获取
618
+
619
+ </td></tr>
620
+ </tbody></table>
621
+
622
+ ## Returns
623
+
624
+ Promise&lt;string \| undefined&gt;
625
+
626
+ 符号的 3.0 文档源码(esym JSON 字符串),获取失败返回 `undefined`
627
+
628
+ ## Remarks
629
+
630
+ 与 [LIB\_Symbol.updateDocumentSource()](./LIB_Symbol.md) 对称的读取接口;返回 \*\*3.0 格式\*\*(esym)的符号源数据, 可直接用于组装原理图源数据(如 AI 生成 eprj3 工程)。
631
+
632
+ 支持工程库 / 非工程库(系统库 / 个人库 / 扩展库): - 工程库:从当前打开的工程 worker 读取(含未保存内容); - 非工程库:从 lib.worker 读取(含未保存内容),worker 无缓存时回退网络获取, 自动处理 `history_uuid`<!-- -->(历史版本)、`dataStrId`<!-- -->(远程存储)与 2.0 → 3.0 格式转换。
633
+
634
+ 获取失败(如库条目不存在)将返回 `undefined`
635
+
636
+ ## Example
637
+
638
+ ```javascript
639
+ // 1. 获取个人库 UUID 并新建符号作为读取对象(第四参数为符号类型,见 ELIB_SymbolType)
640
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
641
+ const symbolUuid = await eda.lib_Symbol.create(
642
+ libraryUuid,
643
+ `嘉立创示例_读取源码_${Date.now()}`,
644
+ [],
645
+ ELIB_SymbolType.COMPONENT
646
+ );
647
+
648
+ // 2. 读取该符号的文档源码(第二参数为符号所属库)
649
+ const pending = eda.lib_Symbol.getDocumentSource(symbolUuid, libraryUuid);
650
+
651
+ // 3. 等待 3 秒观察结果状态(当前版本 Promise 不 settle,用超时保护避免卡住)
652
+ const settled = await Promise.race([
653
+ Promise.resolve(pending).then(
654
+ source => `fulfilled,源码长度 ${source ? source.length : '空'}`,
655
+ () => 'rejected'
656
+ ),
657
+ new Promise(resolve => setTimeout(() => resolve('pending(3 秒内未返回)'), 3000)),
658
+ ]);
659
+
660
+ // 4. 清理测试符号(查询类需要清理)
661
+ await eda.lib_Symbol.delete(symbolUuid, libraryUuid);
662
+
663
+ console.log('symbolUuid:', symbolUuid);
664
+ console.log('returns:', typeof pending.then === 'function' ? 'Promise' : typeof pending);
665
+ console.log('settled:', settled);
666
+ ```
667
+
668
+ ### getrenderimage
669
+
670
+ # LIB\_Symbol.getRenderImage() method
671
+
672
+ > 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.
673
+
674
+ Get the symbol render image
675
+
676
+ ## Signature
677
+
678
+ ```typescript
679
+ function getRenderImage(source: {
680
+ symbolUuid: string;
681
+ libraryUuid: string;
682
+ subPartName?: string;
683
+ }): Promise<Blob | undefined>;
684
+ ```
685
+
686
+ ## Parameters
687
+
688
+ <table><thead><tr><th>
689
+
690
+ Parameter
691
+
692
+ </th><th>
693
+
694
+ Type
695
+
696
+ </th><th>
697
+
698
+ Description
699
+
700
+ </th></tr></thead>
701
+ <tbody><tr><td>
702
+
703
+ source
704
+
705
+ </td><td>
706
+
707
+ \{ symbolUuid: string; libraryUuid: string; subPartName?: string \}
708
+
709
+ </td><td>
710
+
711
+ </td></tr>
712
+ </tbody></table>
713
+
714
+ ## Returns
715
+
716
+ Promise&lt;Blob \| undefined&gt;
717
+
718
+ Symbol render image
719
+
720
+ ## Example
721
+
722
+ ```javascript
723
+ // 1. 列出系统库符号,取一个作为渲染来源
724
+ const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
725
+
726
+ // 2. 获取渲染图(PNG Blob)
727
+ const blob = await eda.lib_Symbol.getRenderImage({
728
+ symbolUuid: source.uuid,
729
+ libraryUuid: source.libraryUuid,
730
+ });
731
+
732
+ // 3. Blob 可转成 URL 直接展示:URL.createObjectURL(blob)
733
+ console.log('sourceName:', source.name);
734
+ console.log('imageSize:', blob.size);
735
+ console.log('imageType:', blob.type);
736
+ ```
737
+
738
+ ### modify
739
+
740
+ # LIB\_Symbol.modify() method
741
+
742
+ > 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.
743
+
744
+ Modify Symbol
745
+
746
+ ## Signature
747
+
748
+ ```typescript
749
+ function modify(
750
+ symbolUuid: string,
751
+ libraryUuid: string,
752
+ symbolName?: string,
753
+ classification?: ILIB_ClassificationIndex | Array<string> | null,
754
+ description?: string | null,
755
+ otherProperty?: Record<string, boolean | number | string | undefined | null>,
756
+ ): Promise<boolean>;
757
+ ```
758
+
759
+ ## Parameters
760
+
761
+ <table><thead><tr><th>
762
+
763
+ Parameter
764
+
765
+ </th><th>
766
+
767
+ Type
768
+
769
+ </th><th>
770
+
771
+ Description
772
+
773
+ </th></tr></thead>
774
+ <tbody><tr><td>
775
+
776
+ symbolUuid
777
+
778
+ </td><td>
779
+
780
+ string
781
+
782
+ </td><td>
783
+
784
+ Symbol UUID
785
+
786
+ </td></tr>
787
+ <tr><td>
788
+
789
+ libraryUuid
790
+
791
+ </td><td>
792
+
793
+ string
794
+
795
+ </td><td>
796
+
797
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
798
+
799
+ </td></tr>
800
+ <tr><td>
801
+
802
+ symbolName
803
+
804
+ </td><td>
805
+
806
+ string
807
+
808
+ </td><td>
809
+
810
+ _(Optional)_ Symbol name
811
+
812
+ </td></tr>
813
+ <tr><td>
814
+
815
+ classification
816
+
817
+ </td><td>
818
+
819
+ [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt; \| null
820
+
821
+ </td><td>
822
+
823
+ _(Optional)_ Classification
824
+
825
+ </td></tr>
826
+ <tr><td>
827
+
828
+ description
829
+
830
+ </td><td>
831
+
832
+ string \| null
833
+
834
+ </td><td>
835
+
836
+ _(Optional)_ Description
837
+
838
+ </td></tr>
839
+ <tr><td>
840
+
841
+ otherProperty
842
+
843
+ </td><td>
844
+
845
+ Record&lt;string, boolean \| number \| string \| undefined \| null&gt;
846
+
847
+ </td><td>
848
+
849
+ _(Optional)_ 其它属性,如希望清除某些属性,则将其的值设置为 `null`
850
+
851
+ </td></tr>
852
+ </tbody></table>
853
+
854
+ ## Returns
855
+
856
+ Promise&lt;boolean&gt;
857
+
858
+ Whether the operation is successful
859
+
860
+ ## Remarks
861
+
862
+ If you want to clear certain properties, set their values to `null`
863
+
864
+ ## Example
865
+
866
+ ```javascript
867
+ // 1. 获取个人库 UUID 并新建修改对象
868
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
869
+ const symbolUuid = await eda.lib_Symbol.create(
870
+ libraryUuid,
871
+ `嘉立创示例_符号修改前_${Date.now()}`,
872
+ [],
873
+ ELIB_SymbolType.COMPONENT,
874
+ '修改前的描述'
875
+ );
876
+
877
+ // 2. 修改名称和描述(分类保持不变传 [])
878
+ const newName = `嘉立创示例_符号修改后_${Date.now()}`;
879
+ const modified = await eda.lib_Symbol.modify(symbolUuid, libraryUuid, newName, [], '修改后的描述');
880
+
881
+ // 修改类保留现场
882
+
883
+ console.log('symbolUuid:', symbolUuid);
884
+ console.log('modified:', modified);
885
+ console.log('newName:', newName);
886
+ ```
887
+
888
+ ### openineditor
889
+
890
+ # LIB\_Symbol.openInEditor() method
891
+
892
+ > 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.
893
+
894
+ Open in the editor document
895
+
896
+ ## Signature
897
+
898
+ ```typescript
899
+ function openInEditor(
900
+ symbolUuid: string,
901
+ libraryUuid: string,
902
+ splitScreenId?: string,
903
+ ): Promise<string | undefined>;
904
+ ```
905
+
906
+ ## Parameters
907
+
908
+ <table><thead><tr><th>
909
+
910
+ Parameter
911
+
912
+ </th><th>
913
+
914
+ Type
915
+
916
+ </th><th>
917
+
918
+ Description
919
+
920
+ </th></tr></thead>
921
+ <tbody><tr><td>
922
+
923
+ symbolUuid
924
+
925
+ </td><td>
926
+
927
+ string
928
+
929
+ </td><td>
930
+
931
+ Symbol UUID
932
+
933
+ </td></tr>
934
+ <tr><td>
935
+
936
+ libraryUuid
937
+
938
+ </td><td>
939
+
940
+ string
941
+
942
+ </td><td>
943
+
944
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
945
+
946
+ </td></tr>
947
+ <tr><td>
948
+
949
+ splitScreenId
950
+
951
+ </td><td>
952
+
953
+ string
954
+
955
+ </td><td>
956
+
957
+ _(Optional)_ Split screen ID. If not filled in, it opens in the split screen with the last input focus by default. It can be obtained using the APIs in [DMT\_EditorControl](./DMT_EditorControl.md)
958
+
959
+ </td></tr>
960
+ </tbody></table>
961
+
962
+ ## Returns
963
+
964
+ Promise&lt;string \| undefined&gt;
965
+
966
+ Tab ID, corresponding to [IDMT\_EditorTabItem.tabId](../interfaces/IDMT_EditorTabItem.md)<!-- -->. You can use [DMT\_EditorControl.getSplitScreenIdByTabId()](./DMT_EditorControl.md) to get the split screen ID
967
+
968
+ ## Example
969
+
970
+ ```javascript
971
+ // 1. 获取个人库 UUID,从系统库复制一个符号作为编辑对象
972
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
973
+ const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
974
+ const symbolUuid = await eda.lib_Symbol.copy(
975
+ source.uuid,
976
+ source.libraryUuid,
977
+ libraryUuid,
978
+ [],
979
+ `嘉立创示例_编辑符号_${Date.now()}`
980
+ );
981
+
982
+ // 2. 在编辑器中打开该符号,返回标签页 ID(uuid@libraryUuid 格式)
983
+ const tabId = await eda.lib_Symbol.openInEditor(symbolUuid, libraryUuid);
984
+
985
+ // 打开后保留现场(编辑器停留在新符号页供观察;不需要时可传 tabId 给
986
+ // dmt_EditorControl.closeDocument 关闭)
987
+
988
+ console.log('symbolUuid:', symbolUuid);
989
+ console.log('tabId:', tabId);
990
+ ```
991
+
992
+ ### search
993
+
994
+ # LIB\_Symbol.search() method
995
+
996
+ > 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.
997
+
998
+ Search symbol
999
+
1000
+ ## Signature
1001
+
1002
+ ```typescript
1003
+ function search(
1004
+ key: string,
1005
+ libraryUuid?: string,
1006
+ classification?: ILIB_ClassificationIndex | Array<string>,
1007
+ symbolType?: ELIB_SymbolType,
1008
+ itemsOfPage?: number,
1009
+ page?: number,
1010
+ ): Promise<Array<ILIB_SymbolSearchItem>>;
1011
+ ```
1012
+
1013
+ ## Parameters
1014
+
1015
+ <table><thead><tr><th>
1016
+
1017
+ Parameter
1018
+
1019
+ </th><th>
1020
+
1021
+ Type
1022
+
1023
+ </th><th>
1024
+
1025
+ Description
1026
+
1027
+ </th></tr></thead>
1028
+ <tbody><tr><td>
1029
+
1030
+ key
1031
+
1032
+ </td><td>
1033
+
1034
+ string
1035
+
1036
+ </td><td>
1037
+
1038
+ Search keyword
1039
+
1040
+ </td></tr>
1041
+ <tr><td>
1042
+
1043
+ libraryUuid
1044
+
1045
+ </td><td>
1046
+
1047
+ string
1048
+
1049
+ </td><td>
1050
+
1051
+ _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
1052
+
1053
+ </td></tr>
1054
+ <tr><td>
1055
+
1056
+ classification
1057
+
1058
+ </td><td>
1059
+
1060
+ [ILIB\_ClassificationIndex](../interfaces/ILIB_ClassificationIndex.md) \| Array&lt;string&gt;
1061
+
1062
+ </td><td>
1063
+
1064
+ _(Optional)_ Classification, defaults to all
1065
+
1066
+ </td></tr>
1067
+ <tr><td>
1068
+
1069
+ symbolType
1070
+
1071
+ </td><td>
1072
+
1073
+ [ELIB\_SymbolType](../enums/ELIB_SymbolType.md)
1074
+
1075
+ </td><td>
1076
+
1077
+ _(Optional)_ Symbol type, defaults to all
1078
+
1079
+ </td></tr>
1080
+ <tr><td>
1081
+
1082
+ itemsOfPage
1083
+
1084
+ </td><td>
1085
+
1086
+ number
1087
+
1088
+ </td><td>
1089
+
1090
+ _(Optional)_ Number of search results per page
1091
+
1092
+ </td></tr>
1093
+ <tr><td>
1094
+
1095
+ page
1096
+
1097
+ </td><td>
1098
+
1099
+ number
1100
+
1101
+ </td><td>
1102
+
1103
+ _(Optional)_ Page count
1104
+
1105
+ </td></tr>
1106
+ </tbody></table>
1107
+
1108
+ ## Returns
1109
+
1110
+ Promise&lt;Array&lt;[ILIB\_SymbolSearchItem](../interfaces/ILIB_SymbolSearchItem.md)<!-- -->&gt;&gt;
1111
+
1112
+ List of searched symbol properties
1113
+
1114
+ ## Example
1115
+
1116
+ ```javascript
1117
+ // 1. 尝试按关键字搜索(当前版本非空关键字会抛错,如实展示)
1118
+ try {
1119
+ const keywordResults = await eda.lib_Symbol.search('0402');
1120
+ console.log('关键字搜索返回', keywordResults.length, '条');
1121
+ }
1122
+ catch (e) {
1123
+ // 剥掉错误类型前缀;注意:正则写法尾部会产生星号+斜杠序列,会闭掉 tsdoc 注释,故用 split
1124
+ console.log('关键字搜索当前版本抛错:', String(e.message).split('Error: ').pop());
1125
+ }
1126
+
1127
+ // 2. 改用空关键字列出系统库符号,每页 5 条
1128
+ const results = await eda.lib_Symbol.search('', undefined, [], undefined, 5, 1);
1129
+
1130
+ // 3. 输出搜索结果(需要过滤时可按 item.name 自行筛选)
1131
+ console.log('count:', results.length);
1132
+ results.forEach((item, i) => {
1133
+ console.log(`[${i}] name:`, item.name, 'uuid:', item.uuid, 'libraryUuid:', item.libraryUuid);
1134
+ });
1135
+ ```
1136
+
1137
+ ### searchbyproperties
1138
+
1139
+ # LIB\_Symbol.searchByProperties() method
1140
+
1141
+ > 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.
1142
+
1143
+ Search symbols precisely by properties
1144
+
1145
+ ## Signature
1146
+
1147
+ ```typescript
1148
+ function searchByProperties(
1149
+ properties: ILIB_SymbolPropertiesForSearch,
1150
+ libraryUuid?: string,
1151
+ ): Promise<Array<ILIB_SymbolSearchItem>>;
1152
+ ```
1153
+
1154
+ ## Parameters
1155
+
1156
+ <table><thead><tr><th>
1157
+
1158
+ Parameter
1159
+
1160
+ </th><th>
1161
+
1162
+ Type
1163
+
1164
+ </th><th>
1165
+
1166
+ Description
1167
+
1168
+ </th></tr></thead>
1169
+ <tbody><tr><td>
1170
+
1171
+ properties
1172
+
1173
+ </td><td>
1174
+
1175
+ [ILIB\_SymbolPropertiesForSearch](../interfaces/ILIB_SymbolPropertiesForSearch.md)
1176
+
1177
+ </td><td>
1178
+
1179
+ Property
1180
+
1181
+ </td></tr>
1182
+ <tr><td>
1183
+
1184
+ libraryUuid
1185
+
1186
+ </td><td>
1187
+
1188
+ string
1189
+
1190
+ </td><td>
1191
+
1192
+ _(Optional)_ Library UUID, default is system library, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
1193
+
1194
+ </td></tr>
1195
+ </tbody></table>
1196
+
1197
+ ## Returns
1198
+
1199
+ Promise&lt;Array&lt;[ILIB\_SymbolSearchItem](../interfaces/ILIB_SymbolSearchItem.md)<!-- -->&gt;&gt;
1200
+
1201
+ List of searched symbol properties
1202
+
1203
+ ## Remarks
1204
+
1205
+ 该接口暂时不支持工程库的精确搜索
1206
+
1207
+ ## Example
1208
+
1209
+ ```javascript
1210
+ // 1. 按名称精确搜索(官方属性集合目前仅支持 name)
1211
+ // 当前版本该接口不稳定:可能抛错,也可能正常返回 undefined,两种都要兼容
1212
+ let results;
1213
+ try {
1214
+ results = await eda.lib_Symbol.searchByProperties({ name: '0402' });
1215
+ }
1216
+ catch (e) {
1217
+ console.log('当前版本按 name 搜索抛错:', e.message);
1218
+ }
1219
+ if (!Array.isArray(results))
1220
+ results = [];
1221
+
1222
+ // 2. 输出搜索结果
1223
+ console.log('count:', results.length);
1224
+ results.forEach((item, i) => {
1225
+ console.log(`[${i}] name:`, item.name, 'uuid:', item.uuid, 'libraryUuid:', item.libraryUuid);
1226
+ });
1227
+ ```
1228
+
1229
+ ### updatedocumentsource
1230
+
1231
+ # LIB\_Symbol.updateDocumentSource() method
1232
+
1233
+ > 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.
1234
+
1235
+ Update the document source code of the symbol
1236
+
1237
+ ## Signature
1238
+
1239
+ ```typescript
1240
+ function updateDocumentSource(
1241
+ symbolUuid: string,
1242
+ libraryUuid: string,
1243
+ documentSource: string,
1244
+ ): Promise<boolean | undefined>;
1245
+ ```
1246
+
1247
+ ## Parameters
1248
+
1249
+ <table><thead><tr><th>
1250
+
1251
+ Parameter
1252
+
1253
+ </th><th>
1254
+
1255
+ Type
1256
+
1257
+ </th><th>
1258
+
1259
+ Description
1260
+
1261
+ </th></tr></thead>
1262
+ <tbody><tr><td>
1263
+
1264
+ symbolUuid
1265
+
1266
+ </td><td>
1267
+
1268
+ string
1269
+
1270
+ </td><td>
1271
+
1272
+ Symbol UUID
1273
+
1274
+ </td></tr>
1275
+ <tr><td>
1276
+
1277
+ libraryUuid
1278
+
1279
+ </td><td>
1280
+
1281
+ string
1282
+
1283
+ </td><td>
1284
+
1285
+ Library UUID, you can use [LIB\_LibrariesList](./LIB_LibrariesList.md) APIs in
1286
+
1287
+ </td></tr>
1288
+ <tr><td>
1289
+
1290
+ documentSource
1291
+
1292
+ </td><td>
1293
+
1294
+ string
1295
+
1296
+ </td><td>
1297
+
1298
+ Document source code
1299
+
1300
+ </td></tr>
1301
+ </tbody></table>
1302
+
1303
+ ## Returns
1304
+
1305
+ Promise&lt;boolean \| undefined&gt;
1306
+
1307
+ Whether the update is successful
1308
+
1309
+ ## Example
1310
+
1311
+ ```javascript
1312
+ // 1. 获取个人库 UUID,从系统库复制一个符号(有内容,源码链路才完整)
1313
+ const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();
1314
+ const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);
1315
+ const symbolUuid = await eda.lib_Symbol.copy(
1316
+ source.uuid,
1317
+ source.libraryUuid,
1318
+ libraryUuid,
1319
+ [],
1320
+ `嘉立创示例_源码符号_${Date.now()}`
1321
+ );
1322
+
1323
+ // 2. 在编辑器中打开符号,等待文档加载完成
1324
+ const tabId = await eda.lib_Symbol.openInEditor(symbolUuid, libraryUuid);
1325
+ await new Promise(r => setTimeout(r, 1500));
1326
+
1327
+ // 3. 读取当前打开符号的文档源码
1328
+ const documentSource = await eda.sys_FileManager.getDocumentSource();
1329
+
1330
+ // 4. 把源码写回库中的符号(此处原样写回;实际使用时可先改写 documentSource)
1331
+ const updated = await eda.lib_Symbol.updateDocumentSource(symbolUuid, libraryUuid, documentSource);
1332
+
1333
+ // 5. 关闭编辑器标签页(符号本体保留在库中)
1334
+ await eda.dmt_EditorControl.closeDocument(tabId);
1335
+
1336
+ // 修改类保留现场
1337
+
1338
+ console.log('symbolUuid:', symbolUuid);
1339
+ console.log('sourceLength:', documentSource.length);
1340
+ console.log('updated:', updated);
1341
+ ```