@windypro-rourou/dsh-eda 0.1.4 → 0.1.5

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 (483) hide show
  1. package/README.md +1 -1
  2. package/lib/capabilities.js +3 -2
  3. package/lib/client.js +33 -0
  4. package/lib/index.js +89 -2
  5. package/package.json +10 -1
  6. package/skill/INDEX.md +10 -8
  7. package/skill/README.md +125 -0
  8. package/skill/README.zh-Hans.md +125 -0
  9. package/skill/SKILL.md +746 -746
  10. package/skill/format/index.md +152 -152
  11. package/skill/format/pcb/3d.md +166 -166
  12. package/skill/format/pcb/attr.md +63 -63
  13. package/skill/format/pcb/common.md +306 -306
  14. package/skill/format/pcb/component.md +132 -132
  15. package/skill/format/pcb/dimension.md +58 -58
  16. package/skill/format/pcb/index.md +17 -17
  17. package/skill/format/pcb/obj.md +43 -43
  18. package/skill/format/pcb/pad_via.md +151 -151
  19. package/skill/format/pcb/panel.md +64 -64
  20. package/skill/format/pcb/partition.md +43 -43
  21. package/skill/format/pcb/primitive.md +196 -196
  22. package/skill/format/pcb/rule.md +71 -71
  23. package/skill/format/pcb/shape.md +441 -441
  24. package/skill/format/pcb/text.md +62 -62
  25. package/skill/format/project/blob.md +30 -30
  26. package/skill/format/project/common.md +42 -42
  27. package/skill/format/project/group.md +62 -62
  28. package/skill/format/project/index.md +12 -12
  29. package/skill/format/project/instance.md +32 -32
  30. package/skill/format/project/meta.md +189 -189
  31. package/skill/format/project/variant.md +30 -30
  32. package/skill/format/schematic/attr.md +41 -41
  33. package/skill/format/schematic/common.md +47 -47
  34. package/skill/format/schematic/component.md +91 -91
  35. package/skill/format/schematic/index.md +14 -14
  36. package/skill/format/schematic/obj.md +41 -41
  37. package/skill/format/schematic/pin.md +59 -59
  38. package/skill/format/schematic/shape.md +231 -231
  39. package/skill/format/schematic/structure.md +53 -53
  40. package/skill/format/schematic/table.md +109 -109
  41. package/skill/format/schematic/text.md +47 -47
  42. package/skill/format/schematic/wire.md +132 -132
  43. package/skill/guide/ancillary-projects/easyeda-api-sdk.md +1 -0
  44. package/skill/guide/ancillary-projects/pro-api-types.md +5 -5
  45. package/skill/guide/ancillary-projects.md +10 -10
  46. package/skill/guide/cli.md +1510 -0
  47. package/skill/guide/error-handling.md +38 -38
  48. package/skill/guide/extension-json.md +135 -135
  49. package/skill/guide/extensions-marketplace.md +61 -61
  50. package/skill/guide/how-to-start.md +316 -301
  51. package/skill/guide/i18n.md +57 -57
  52. package/skill/guide/index.md +7 -7
  53. package/skill/guide/inline-frame.md +20 -20
  54. package/skill/guide/invoke-apis.md +81 -81
  55. package/skill/guide/stability.md +37 -37
  56. package/skill/references/_index.md +471 -398
  57. package/skill/references/_quick-reference.md +3103 -3028
  58. package/skill/references/classes/DMT_Board.md +537 -533
  59. package/skill/references/classes/DMT_EditorControl.md +1736 -1736
  60. package/skill/references/classes/DMT_Event.md +356 -356
  61. package/skill/references/classes/DMT_Folder.md +775 -775
  62. package/skill/references/classes/DMT_Panel.md +531 -531
  63. package/skill/references/classes/DMT_Pcb.md +579 -575
  64. package/skill/references/classes/DMT_Project.md +734 -573
  65. package/skill/references/classes/DMT_Schematic.md +1482 -1477
  66. package/skill/references/classes/DMT_SelectControl.md +96 -96
  67. package/skill/references/classes/DMT_Team.md +172 -172
  68. package/skill/references/classes/DMT_Workspace.md +198 -198
  69. package/skill/references/classes/EDA.md +1001 -961
  70. package/skill/references/classes/IPCB_ComplexPolygon.md +299 -299
  71. package/skill/references/classes/IPCB_Polygon.md +175 -175
  72. package/skill/references/classes/IPCB_PrimitiveArc.md +1901 -1901
  73. package/skill/references/classes/IPCB_PrimitiveAttribute.md +2993 -2993
  74. package/skill/references/classes/IPCB_PrimitiveComponent.md +2624 -2627
  75. package/skill/references/classes/IPCB_PrimitiveComponentPad.md +410 -410
  76. package/skill/references/classes/IPCB_PrimitiveDimension.md +1419 -1419
  77. package/skill/references/classes/IPCB_PrimitiveFill.md +1325 -1325
  78. package/skill/references/classes/IPCB_PrimitiveImage.md +1461 -1461
  79. package/skill/references/classes/IPCB_PrimitiveLine.md +1639 -1639
  80. package/skill/references/classes/IPCB_PrimitiveObject.md +1700 -1700
  81. package/skill/references/classes/IPCB_PrimitivePad.md +3155 -3155
  82. package/skill/references/classes/IPCB_PrimitivePolyline.md +1193 -1193
  83. package/skill/references/classes/IPCB_PrimitivePour.md +1858 -1858
  84. package/skill/references/classes/IPCB_PrimitivePoured.md +556 -556
  85. package/skill/references/classes/IPCB_PrimitiveRegion.md +1332 -1332
  86. package/skill/references/classes/IPCB_PrimitiveString.md +2315 -2315
  87. package/skill/references/classes/IPCB_PrimitiveVia.md +1588 -1588
  88. package/skill/references/classes/ISCH_PrimitiveArc.md +1676 -1676
  89. package/skill/references/classes/ISCH_PrimitiveAttribute.md +2541 -2541
  90. package/skill/references/classes/ISCH_PrimitiveBus.md +973 -973
  91. package/skill/references/classes/ISCH_PrimitiveCbbSymbolComponent.md +260 -260
  92. package/skill/references/classes/ISCH_PrimitiveCircle.md +1392 -1392
  93. package/skill/references/classes/ISCH_PrimitiveComponent.md +2910 -2913
  94. package/skill/references/classes/ISCH_PrimitiveComponentPin.md +155 -155
  95. package/skill/references/classes/ISCH_PrimitiveObject.md +960 -960
  96. package/skill/references/classes/ISCH_PrimitivePin.md +2402 -2402
  97. package/skill/references/classes/ISCH_PrimitivePolygon.md +1028 -1028
  98. package/skill/references/classes/ISCH_PrimitiveRectangle.md +1777 -1777
  99. package/skill/references/classes/ISCH_PrimitiveText.md +1771 -1771
  100. package/skill/references/classes/ISCH_PrimitiveWire.md +973 -973
  101. package/skill/references/classes/LIB_3DModel.md +782 -780
  102. package/skill/references/classes/LIB_Cbb.md +957 -957
  103. package/skill/references/classes/LIB_Classification.md +969 -965
  104. package/skill/references/classes/LIB_Device.md +1222 -1221
  105. package/skill/references/classes/LIB_Footprint.md +1298 -1153
  106. package/skill/references/classes/LIB_LibrariesList.md +361 -329
  107. package/skill/references/classes/LIB_PanelLibrary.md +855 -855
  108. package/skill/references/classes/LIB_SelectControl.md +89 -89
  109. package/skill/references/classes/LIB_SimulationModel.md +807 -821
  110. package/skill/references/classes/LIB_Symbol.md +1341 -1195
  111. package/skill/references/classes/PCB_Document.md +1770 -1754
  112. package/skill/references/classes/PCB_Drc.md +3379 -3375
  113. package/skill/references/classes/PCB_Event.md +1166 -1081
  114. package/skill/references/classes/PCB_ImageTool.md +363 -0
  115. package/skill/references/classes/PCB_Layer.md +1915 -1911
  116. package/skill/references/classes/PCB_ManufactureData.md +2968 -2968
  117. package/skill/references/classes/PCB_MathPolygon.md +916 -785
  118. package/skill/references/classes/PCB_Net.md +1128 -1128
  119. package/skill/references/classes/PCB_Primitive.md +217 -217
  120. package/skill/references/classes/PCB_PrimitiveArc.md +820 -894
  121. package/skill/references/classes/PCB_PrimitiveAttribute.md +635 -717
  122. package/skill/references/classes/PCB_PrimitiveComponent.md +1050 -1050
  123. package/skill/references/classes/PCB_PrimitiveDimension.md +789 -833
  124. package/skill/references/classes/PCB_PrimitiveFill.md +783 -861
  125. package/skill/references/classes/PCB_PrimitiveImage.md +803 -875
  126. package/skill/references/classes/PCB_PrimitiveLine.md +787 -858
  127. package/skill/references/classes/PCB_PrimitiveObject.md +796 -800
  128. package/skill/references/classes/PCB_PrimitivePad.md +947 -944
  129. package/skill/references/classes/PCB_PrimitivePolyline.md +744 -819
  130. package/skill/references/classes/PCB_PrimitivePour.md +808 -845
  131. package/skill/references/classes/PCB_PrimitivePoured.md +363 -363
  132. package/skill/references/classes/PCB_PrimitiveRegion.md +765 -799
  133. package/skill/references/classes/PCB_PrimitiveString.md +828 -910
  134. package/skill/references/classes/PCB_PrimitiveVia.md +761 -765
  135. package/skill/references/classes/PCB_RayTracerEngine.md +603 -263
  136. package/skill/references/classes/PCB_SelectControl.md +495 -495
  137. package/skill/references/classes/PCB_Tool.md +9 -0
  138. package/skill/references/classes/PNL_Document.md +83 -83
  139. package/skill/references/classes/SCH_Document.md +797 -809
  140. package/skill/references/classes/SCH_Drc.md +246 -242
  141. package/skill/references/classes/SCH_Event.md +583 -583
  142. package/skill/references/classes/SCH_ManufactureData.md +1209 -1205
  143. package/skill/references/classes/SCH_Net.md +200 -200
  144. package/skill/references/classes/SCH_Netlist.md +191 -191
  145. package/skill/references/classes/SCH_Primitive.md +337 -337
  146. package/skill/references/classes/SCH_PrimitiveArc.md +686 -692
  147. package/skill/references/classes/SCH_PrimitiveAttribute.md +579 -590
  148. package/skill/references/classes/SCH_PrimitiveBus.md +618 -624
  149. package/skill/references/classes/SCH_PrimitiveCircle.md +667 -683
  150. package/skill/references/classes/SCH_PrimitiveComponent.md +2256 -2240
  151. package/skill/references/classes/SCH_PrimitiveObject.md +666 -666
  152. package/skill/references/classes/SCH_PrimitivePin.md +737 -754
  153. package/skill/references/classes/SCH_PrimitivePolygon.md +621 -627
  154. package/skill/references/classes/SCH_PrimitiveRectangle.md +715 -731
  155. package/skill/references/classes/SCH_PrimitiveText.md +736 -746
  156. package/skill/references/classes/SCH_PrimitiveWire.md +701 -703
  157. package/skill/references/classes/SCH_SelectControl.md +520 -520
  158. package/skill/references/classes/SCH_SimulationEngine.md +133 -133
  159. package/skill/references/classes/SCH_Utils.md +121 -121
  160. package/skill/references/classes/SYS_ClientUrl.md +173 -173
  161. package/skill/references/classes/SYS_Dialog.md +825 -825
  162. package/skill/references/classes/SYS_Environment.md +640 -502
  163. package/skill/references/classes/SYS_ExternalApi.md +246 -0
  164. package/skill/references/classes/SYS_FileManager.md +1664 -1686
  165. package/skill/references/classes/SYS_FileSystem.md +1366 -1171
  166. package/skill/references/classes/SYS_FontManager.md +224 -224
  167. package/skill/references/classes/SYS_FormatConversion.md +349 -349
  168. package/skill/references/classes/SYS_HeaderMenu.md +480 -479
  169. package/skill/references/classes/SYS_Help.md +141 -0
  170. package/skill/references/classes/SYS_I18n.md +861 -861
  171. package/skill/references/classes/SYS_IFrame.md +541 -535
  172. package/skill/references/classes/SYS_LoadingAndProgressBar.md +246 -246
  173. package/skill/references/classes/SYS_Log.md +422 -424
  174. package/skill/references/classes/SYS_Math.md +1565 -1565
  175. package/skill/references/classes/SYS_Message.md +363 -363
  176. package/skill/references/classes/SYS_MessageBox.md +285 -285
  177. package/skill/references/classes/SYS_MessageBus.md +1618 -1618
  178. package/skill/references/classes/SYS_PanelControl.md +696 -696
  179. package/skill/references/classes/SYS_RightClickMenu.md +175 -175
  180. package/skill/references/classes/SYS_Setting.md +134 -85
  181. package/skill/references/classes/SYS_ShortcutKey.md +623 -623
  182. package/skill/references/classes/SYS_Storage.md +484 -484
  183. package/skill/references/classes/SYS_Timer.md +447 -447
  184. package/skill/references/classes/SYS_ToastMessage.md +194 -194
  185. package/skill/references/classes/SYS_Tool.md +317 -241
  186. package/skill/references/classes/SYS_Unit.md +594 -594
  187. package/skill/references/classes/SYS_WebSocket.md +401 -401
  188. package/skill/references/classes/SYS_Window.md +849 -850
  189. package/skill/references/enums/EDMT_EditorDocumentType.md +324 -278
  190. package/skill/references/enums/EDMT_EditorSplitScreenDirection.md +51 -47
  191. package/skill/references/enums/EDMT_EditorTabEventType.md +68 -62
  192. package/skill/references/enums/EDMT_IndicatorMarkerType.md +90 -80
  193. package/skill/references/enums/EDMT_ItemType.md +181 -157
  194. package/skill/references/enums/EDMT_ProjectCollaborationMode.md +51 -47
  195. package/skill/references/enums/EDMT_ProjectFileFormat.md +60 -0
  196. package/skill/references/enums/EDMT_ProjectReadyState.md +82 -0
  197. package/skill/references/enums/ELIB_DeviceJlcLibraryCategory.md +51 -47
  198. package/skill/references/enums/ELIB_LibraryType.md +129 -113
  199. package/skill/references/enums/ELIB_PreviewType.md +77 -69
  200. package/skill/references/enums/ELIB_SimulationModelType.md +51 -47
  201. package/skill/references/enums/ELIB_SymbolType.md +142 -124
  202. package/skill/references/enums/EPCB_AutoRoutingCornerStyle.md +51 -47
  203. package/skill/references/enums/EPCB_AutoRoutingExistingPrimitiveMode.md +51 -47
  204. package/skill/references/enums/EPCB_AutoRoutingOptimization.md +51 -47
  205. package/skill/references/enums/EPCB_DocumentCanvasUpdateCalculationActiveStatus.md +51 -47
  206. package/skill/references/enums/EPCB_DocumentRatlineCalculatingActiveStatus.md +55 -51
  207. package/skill/references/enums/EPCB_InactiveLayerDisplayMode.md +64 -58
  208. package/skill/references/enums/EPCB_LayerColorConfiguration.md +90 -80
  209. package/skill/references/enums/EPCB_LayerId.md +1169 -881
  210. package/skill/references/enums/EPCB_LayerStatus.md +64 -58
  211. package/skill/references/enums/EPCB_LayerType.md +129 -113
  212. package/skill/references/enums/EPCB_MouseEventType.md +64 -58
  213. package/skill/references/enums/EPCB_NetEventType.md +64 -58
  214. package/skill/references/enums/EPCB_PcbPlateType.md +51 -47
  215. package/skill/references/enums/EPCB_PdfOutputMethod.md +64 -58
  216. package/skill/references/enums/EPCB_PrimitiveArcInteractiveMode.md +51 -47
  217. package/skill/references/enums/EPCB_PrimitiveDimensionType.md +64 -58
  218. package/skill/references/enums/EPCB_PrimitiveEventType.md +64 -58
  219. package/skill/references/enums/EPCB_PrimitiveFillMode.md +68 -62
  220. package/skill/references/enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md +64 -58
  221. package/skill/references/enums/EPCB_PrimitivePadHoleType.md +64 -58
  222. package/skill/references/enums/EPCB_PrimitivePadShapeType.md +90 -80
  223. package/skill/references/enums/EPCB_PrimitivePadType.md +64 -58
  224. package/skill/references/enums/EPCB_PrimitivePourFillMethod.md +64 -58
  225. package/skill/references/enums/EPCB_PrimitiveRegionRuleType.md +107 -95
  226. package/skill/references/enums/EPCB_PrimitiveStringAlignMode.md +142 -124
  227. package/skill/references/enums/EPCB_PrimitiveType.md +233 -201
  228. package/skill/references/enums/EPCB_PrimitiveViaType.md +64 -58
  229. package/skill/references/enums/ESCH_DynamicSimulationEnginePullEventType.md +116 -102
  230. package/skill/references/enums/ESCH_DynamicSimulationEnginePushEventType.md +90 -80
  231. package/skill/references/enums/ESCH_ExportDocumentFileType.md +64 -58
  232. package/skill/references/enums/ESCH_MouseEventType.md +51 -47
  233. package/skill/references/enums/ESCH_PrimitiveComponentType.md +142 -124
  234. package/skill/references/enums/ESCH_PrimitiveEventType.md +77 -69
  235. package/skill/references/enums/ESCH_PrimitiveFillStyle.md +129 -113
  236. package/skill/references/enums/ESCH_PrimitiveLineType.md +77 -69
  237. package/skill/references/enums/ESCH_PrimitivePinShape.md +77 -69
  238. package/skill/references/enums/ESCH_PrimitivePinType.md +168 -146
  239. package/skill/references/enums/ESCH_PrimitiveTextAlignMode.md +142 -124
  240. package/skill/references/enums/ESCH_PrimitiveType.md +207 -179
  241. package/skill/references/enums/ESCH_SimulationNetlistType.md +38 -36
  242. package/skill/references/enums/ESCH_SpiceSimulationEnginePullEventType.md +51 -47
  243. package/skill/references/enums/ESCH_SpiceSimulationEnginePushEventType.md +77 -69
  244. package/skill/references/enums/ESYS_BottomPanelTab.md +94 -80
  245. package/skill/references/enums/ESYS_HeaderMenuEnvironment.md +181 -157
  246. package/skill/references/enums/ESYS_ImportProjectBoardOutlineSource.md +55 -51
  247. package/skill/references/enums/ESYS_ImportProjectImportOption.md +64 -58
  248. package/skill/references/enums/ESYS_ImportProjectSchematicObjectStyle.md +51 -47
  249. package/skill/references/enums/ESYS_ImportProjectViaSolderMaskExpansion.md +55 -51
  250. package/skill/references/enums/ESYS_JobState.md +95 -0
  251. package/skill/references/enums/ESYS_LeftPanelTab.md +94 -80
  252. package/skill/references/enums/ESYS_LogType.md +77 -102
  253. package/skill/references/enums/ESYS_NetlistType.md +129 -113
  254. package/skill/references/enums/ESYS_PanelPosition.md +69 -0
  255. package/skill/references/enums/ESYS_PanelTab.md +368 -0
  256. package/skill/references/enums/ESYS_RightPanelTab.md +237 -201
  257. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorRange.md +220 -190
  258. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorScene.md +103 -91
  259. package/skill/references/enums/ESYS_StartPageQuickStartItem.md +237 -205
  260. package/skill/references/enums/ESYS_Theme.md +51 -47
  261. package/skill/references/enums/ESYS_ToastMessageType.md +90 -80
  262. package/skill/references/enums/ESYS_Unit.md +116 -102
  263. package/skill/references/enums/ESYS_WindowEventType.md +64 -47
  264. package/skill/references/enums/ESYS_WindowOpenTarget.md +51 -47
  265. package/skill/references/enums/NetportDeviceName.md +146 -146
  266. package/skill/references/enums/SchToolBarDeviceName.md +278 -278
  267. package/skill/references/interfaces/BoardProps.md +169 -169
  268. package/skill/references/interfaces/BorderConfig.md +109 -0
  269. package/skill/references/interfaces/ButtonProps.md +196 -169
  270. package/skill/references/interfaces/CellClickInfo.md +142 -0
  271. package/skill/references/interfaces/CellCoord.md +88 -0
  272. package/skill/references/interfaces/CheckBoxProps.md +223 -196
  273. package/skill/references/interfaces/CheckChangeDetail.md +88 -0
  274. package/skill/references/interfaces/CheckboxEditConfig.md +159 -0
  275. package/skill/references/interfaces/ClipboardCellData.md +142 -0
  276. package/skill/references/interfaces/ClipboardConfig.md +115 -0
  277. package/skill/references/interfaces/ColorPickerProps.md +169 -0
  278. package/skill/references/interfaces/ColumnDef.md +605 -0
  279. package/skill/references/interfaces/ColumnEditTrigger.md +57 -0
  280. package/skill/references/interfaces/ColumnGroupDef.md +192 -0
  281. package/skill/references/interfaces/ColumnResizeConfig.md +142 -0
  282. package/skill/references/interfaces/ComponentPropsMap.md +517 -448
  283. package/skill/references/interfaces/CustomHeaderConfig.md +169 -0
  284. package/skill/references/interfaces/DialogProps.md +385 -385
  285. package/skill/references/interfaces/DragSortConfig.md +115 -0
  286. package/skill/references/interfaces/EditingConfig.md +196 -0
  287. package/skill/references/interfaces/FilteringConfig.md +250 -0
  288. package/skill/references/interfaces/FixedColumnConfig.md +88 -0
  289. package/skill/references/interfaces/FlexItemProps.md +116 -116
  290. package/skill/references/interfaces/FlexProps.md +224 -224
  291. package/skill/references/interfaces/GridItemProps.md +143 -143
  292. package/skill/references/interfaces/GridProps.md +143 -143
  293. package/skill/references/interfaces/IDMT_BoardItem.md +171 -171
  294. package/skill/references/interfaces/IDMT_BriefProjectItem.md +171 -171
  295. package/skill/references/interfaces/IDMT_EditorDocumentItem.md +169 -169
  296. package/skill/references/interfaces/IDMT_EditorSplitScreenItem.md +173 -173
  297. package/skill/references/interfaces/IDMT_EditorTabItem.md +169 -169
  298. package/skill/references/interfaces/IDMT_FolderItem.md +225 -225
  299. package/skill/references/interfaces/IDMT_IndicatorMarkerShape.md +393 -393
  300. package/skill/references/interfaces/IDMT_PanelItem.md +144 -144
  301. package/skill/references/interfaces/IDMT_PcbItem.md +171 -171
  302. package/skill/references/interfaces/IDMT_ProjectItem.md +143 -143
  303. package/skill/references/interfaces/IDMT_SchematicItem.md +225 -225
  304. package/skill/references/interfaces/IDMT_SchematicPageItem.md +198 -198
  305. package/skill/references/interfaces/IDMT_TeamItem.md +144 -144
  306. package/skill/references/interfaces/IDMT_WorkspaceItem.md +117 -117
  307. package/skill/references/interfaces/IDesignPortal.md +103 -103
  308. package/skill/references/interfaces/ILIB_3DModelItem.md +198 -198
  309. package/skill/references/interfaces/ILIB_3DModelSearchItem.md +277 -277
  310. package/skill/references/interfaces/ILIB_CbbItem.md +225 -225
  311. package/skill/references/interfaces/ILIB_CbbSearchItem.md +277 -277
  312. package/skill/references/interfaces/ILIB_ClassificationIndex.md +150 -150
  313. package/skill/references/interfaces/ILIB_ClassificationNode.md +98 -0
  314. package/skill/references/interfaces/ILIB_DeviceAssociationItem.md +210 -210
  315. package/skill/references/interfaces/ILIB_DeviceExtendPropertyItem.md +304 -304
  316. package/skill/references/interfaces/ILIB_DeviceItem.md +279 -279
  317. package/skill/references/interfaces/ILIB_DevicePropertiesForSearch.md +250 -250
  318. package/skill/references/interfaces/ILIB_DeviceSearchItem.md +521 -521
  319. package/skill/references/interfaces/ILIB_ExtendLibrary3DModelFunctions.md +64 -64
  320. package/skill/references/interfaces/ILIB_ExtendLibraryCbbFunctions.md +93 -99
  321. package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md +150 -150
  322. package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md +143 -157
  323. package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md +63 -63
  324. package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md +123 -123
  325. package/skill/references/interfaces/ILIB_ExtendLibraryItem.md +97 -97
  326. package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md +98 -98
  327. package/skill/references/interfaces/ILIB_ExtendLibrarySearchProperty.md +115 -115
  328. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResult.md +169 -169
  329. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResultDataLine.md +234 -234
  330. package/skill/references/interfaces/ILIB_ExtendLibrarySymbolFunctions.md +91 -105
  331. package/skill/references/interfaces/ILIB_ExtendLibraryUserIndex.md +96 -96
  332. package/skill/references/interfaces/ILIB_FootprintItem.md +256 -198
  333. package/skill/references/interfaces/ILIB_FootprintPropertiesForSearch.md +61 -61
  334. package/skill/references/interfaces/ILIB_FootprintSearchItem.md +277 -277
  335. package/skill/references/interfaces/ILIB_LibraryInfo.md +92 -92
  336. package/skill/references/interfaces/ILIB_LibraryItem.md +115 -115
  337. package/skill/references/interfaces/ILIB_PanelLibraryItem.md +198 -198
  338. package/skill/references/interfaces/ILIB_PanelLibrarySearchItem.md +277 -277
  339. package/skill/references/interfaces/ILIB_RegisterExtendLibraryProps.md +71 -0
  340. package/skill/references/interfaces/ILIB_SimulationModelItem.md +306 -306
  341. package/skill/references/interfaces/ILIB_SimulationModelSearchItem.md +304 -304
  342. package/skill/references/interfaces/ILIB_SymbolItem.md +306 -279
  343. package/skill/references/interfaces/ILIB_SymbolPropertiesForSearch.md +61 -61
  344. package/skill/references/interfaces/ILIB_SymbolSearchItem.md +304 -304
  345. package/skill/references/interfaces/IPCB_AutoLayoutResult.md +169 -169
  346. package/skill/references/interfaces/IPCB_AutoRoutingProps.md +220 -220
  347. package/skill/references/interfaces/IPCB_AutoRoutingResult.md +169 -169
  348. package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md +169 -169
  349. package/skill/references/interfaces/IPCB_DifferentialPairItem.md +115 -115
  350. package/skill/references/interfaces/IPCB_DiscretizeOptions.md +65 -65
  351. package/skill/references/interfaces/IPCB_DiscretizedPoint.md +88 -88
  352. package/skill/references/interfaces/IPCB_EqualLengthNetGroupItem.md +115 -115
  353. package/skill/references/interfaces/IPCB_LayerItem.md +277 -277
  354. package/skill/references/interfaces/IPCB_NetClassItem.md +115 -115
  355. package/skill/references/interfaces/IPCB_NetInfo.md +115 -115
  356. package/skill/references/interfaces/IPCB_PadPairGroupItem.md +88 -88
  357. package/skill/references/interfaces/IPCB_PadPairMinWireLengthItem.md +88 -88
  358. package/skill/references/interfaces/IPCB_PhysicalStackingConfiguration.md +115 -115
  359. package/skill/references/interfaces/IPCB_Primitive.md +218 -218
  360. package/skill/references/interfaces/IPCB_PrimitiveAPI.md +174 -175
  361. package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md +151 -151
  362. package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md +142 -142
  363. package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md +154 -154
  364. package/skill/references/interfaces/IPCB_RayTracerBackgroundConfig.md +223 -0
  365. package/skill/references/interfaces/IPCB_RayTracerLightConfig.md +412 -0
  366. package/skill/references/interfaces/IPCB_RayTracerMaterialConfig.md +547 -0
  367. package/skill/references/interfaces/IPCB_RayTracerPcbMaterialConfig.md +196 -0
  368. package/skill/references/interfaces/IPCB_RayTracerRenderConfigurations.md +200 -0
  369. package/skill/references/interfaces/IPCB_RayTracerRendererConfig.md +196 -0
  370. package/skill/references/interfaces/IPCB_RayTracerSceneElement.md +115 -0
  371. package/skill/references/interfaces/IPCB_RayTracerSceneElementTransform.md +123 -0
  372. package/skill/references/interfaces/IPCB_RayTracerTexture.md +88 -0
  373. package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md +88 -88
  374. package/skill/references/interfaces/IRawNet.md +103 -103
  375. package/skill/references/interfaces/IRawPureSchematic.md +80 -80
  376. package/skill/references/interfaces/IRawSchematic.md +103 -103
  377. package/skill/references/interfaces/IRawWire.md +149 -149
  378. package/skill/references/interfaces/ISCH_DrcError.md +142 -142
  379. package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md +142 -142
  380. package/skill/references/interfaces/ISCH_ExportPngResolution.md +94 -94
  381. package/skill/references/interfaces/ISCH_NetInfo.md +88 -88
  382. package/skill/references/interfaces/ISCH_Primitive.md +218 -219
  383. package/skill/references/interfaces/ISCH_PrimitiveAPI.md +174 -175
  384. package/skill/references/interfaces/ISCH_ProjectNetInfo.md +142 -142
  385. package/skill/references/interfaces/ISCH_WireInfo.md +169 -169
  386. package/skill/references/interfaces/ISYS_ComparisonResponse.md +115 -0
  387. package/skill/references/interfaces/ISYS_ExtensionExternalApiIndex.md +13 -0
  388. package/skill/references/interfaces/ISYS_ExtensionRegisteredExternalApis.md +13 -0
  389. package/skill/references/interfaces/ISYS_ExternalApiHelp.md +173 -0
  390. package/skill/references/interfaces/ISYS_ExternalApiRegistration.md +146 -0
  391. package/skill/references/interfaces/ISYS_FileSystemFileList.md +169 -169
  392. package/skill/references/interfaces/ISYS_HeaderMenuSub1MenuItem.md +205 -174
  393. package/skill/references/interfaces/ISYS_HeaderMenuSub2MenuItem.md +178 -147
  394. package/skill/references/interfaces/ISYS_HeaderMenuTopMenuItem.md +115 -115
  395. package/skill/references/interfaces/ISYS_HeaderMenus.md +408 -408
  396. package/skill/references/interfaces/ISYS_HelpAudienceEntry.md +92 -0
  397. package/skill/references/interfaces/ISYS_HelpClassSummary.md +205 -0
  398. package/skill/references/interfaces/ISYS_HelpData.md +92 -0
  399. package/skill/references/interfaces/ISYS_HelpMethodDetail.md +310 -0
  400. package/skill/references/interfaces/ISYS_JobHandle.md +65 -0
  401. package/skill/references/interfaces/ISYS_JobLogEntry.md +142 -0
  402. package/skill/references/interfaces/ISYS_JobStatus.md +176 -0
  403. package/skill/references/interfaces/ISYS_LogLine.md +115 -115
  404. package/skill/references/interfaces/ISYS_MathBBox.md +142 -142
  405. package/skill/references/interfaces/ISYS_MathPoint.md +88 -88
  406. package/skill/references/interfaces/ISYS_MathPolygonWithHoles.md +92 -92
  407. package/skill/references/interfaces/ISYS_MessageBusTask.md +115 -115
  408. package/skill/references/interfaces/ISYS_MultilingualLanguagesData.md +12 -12
  409. package/skill/references/interfaces/ISYS_RightClickMenuItem.md +174 -174
  410. package/skill/references/interfaces/ISYS_ShortcutKeyData.md +169 -169
  411. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithCallFn.md +62 -62
  412. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithUserDefinedShortcutKey.md +62 -62
  413. package/skill/references/interfaces/ISYS_WindowEventListenerRemovableObject.md +109 -109
  414. package/skill/references/interfaces/IconProps.md +88 -88
  415. package/skill/references/interfaces/ImageProps.md +115 -115
  416. package/skill/references/interfaces/InputEditConfig.md +182 -0
  417. package/skill/references/interfaces/InputProps.md +547 -520
  418. package/skill/references/interfaces/KeyboardConfig.md +61 -0
  419. package/skill/references/interfaces/ListChildren.md +223 -223
  420. package/skill/references/interfaces/ListProps.md +250 -223
  421. package/skill/references/interfaces/ModalProps.md +358 -358
  422. package/skill/references/interfaces/NumberEditConfig.md +234 -0
  423. package/skill/references/interfaces/RadioGroupProps.md +196 -196
  424. package/skill/references/interfaces/RadioItem.md +115 -115
  425. package/skill/references/interfaces/RichTableProps.md +1357 -0
  426. package/skill/references/interfaces/RowMetaConfig.md +142 -0
  427. package/skill/references/interfaces/ScrollerProps.md +169 -169
  428. package/skill/references/interfaces/SelectEditConfig.md +211 -0
  429. package/skill/references/interfaces/SelectListItem.md +142 -142
  430. package/skill/references/interfaces/SelectOption.md +142 -0
  431. package/skill/references/interfaces/SelectProps.md +169 -169
  432. package/skill/references/interfaces/SelectionConfig.md +358 -0
  433. package/skill/references/interfaces/SliderProps.md +142 -0
  434. package/skill/references/interfaces/SlotProps.md +88 -88
  435. package/skill/references/interfaces/SortState.md +88 -0
  436. package/skill/references/interfaces/SortingConfig.md +169 -0
  437. package/skill/references/interfaces/StyleProps.md +439 -385
  438. package/skill/references/interfaces/TextAreaProps.md +196 -196
  439. package/skill/references/interfaces/TextProps.md +169 -169
  440. package/skill/references/interfaces/TextareaEditConfig.md +182 -0
  441. package/skill/references/interfaces/ValidationRule.md +223 -0
  442. package/skill/references/interfaces/VirtualScrollConfig.md +115 -0
  443. package/skill/references/types/Align.md +9 -0
  444. package/skill/references/types/CellContentType.md +9 -0
  445. package/skill/references/types/ColumnDefOrGroup.md +12 -0
  446. package/skill/references/types/ColumnEditConfig.md +13 -0
  447. package/skill/references/types/ColumnType.md +9 -0
  448. package/skill/references/types/DataChangeType.md +9 -0
  449. package/skill/references/types/FilterMatchMode.md +9 -0
  450. package/skill/references/types/RichTableRow.md +12 -0
  451. package/skill/references/types/Serializable.md +10 -0
  452. package/skill/references/types/SerializablePrimitive.md +9 -0
  453. package/skill/references/types/SortOrder.md +9 -0
  454. package/skill/references/types/TPCB_LayerTypesOfInnerLayer.md +11 -11
  455. package/skill/references/types/TPCB_LayersInTheSelectable.md +42 -42
  456. package/skill/references/types/TPCB_LayersOfComponent.md +11 -11
  457. package/skill/references/types/TPCB_LayersOfCopper.md +15 -15
  458. package/skill/references/types/TPCB_LayersOfCustom.md +41 -41
  459. package/skill/references/types/TPCB_LayersOfDimension.md +16 -16
  460. package/skill/references/types/TPCB_LayersOfFill.md +28 -28
  461. package/skill/references/types/TPCB_LayersOfImage.md +22 -22
  462. package/skill/references/types/TPCB_LayersOfInner.md +41 -41
  463. package/skill/references/types/TPCB_LayersOfLine.md +25 -25
  464. package/skill/references/types/TPCB_LayersOfObject.md +12 -12
  465. package/skill/references/types/TPCB_LayersOfPad.md +11 -11
  466. package/skill/references/types/TPCB_LayersOfRegion.md +11 -11
  467. package/skill/references/types/TPCB_NumberOfCopperLayers.md +9 -9
  468. package/skill/references/types/TPCB_PolygonSourceArray.md +85 -83
  469. package/skill/references/types/TPCB_PrimitiveDimensionCoordinateSet.md +66 -66
  470. package/skill/references/types/TPCB_PrimitivePadHole.md +30 -30
  471. package/skill/references/types/TPCB_PrimitivePadShape.md +61 -61
  472. package/skill/references/types/TPCB_PrimitiveSpecialPadShape.md +19 -19
  473. package/skill/references/types/TSYS_ComparisonErrorCode.md +15 -0
  474. package/skill/references/types/TSYS_LanguageKeyValuePairs.md +13 -0
  475. package/skill/references/types/TSYS_MathPolygonGroup.md +15 -15
  476. package/skill/references/types/TSYS_MathPolygonInput.md +20 -20
  477. package/skill/references/types/TSYS_ShortcutKeys.md +96 -96
  478. package/skill/user-guide/using-extension.md +47 -47
  479. package/src/json-gen.test.js +430 -0
  480. package/skill/guide/ancillary-projects/pro-api-sdk.md +0 -1
  481. package/skill/references/interfaces/ISYS_PcbComparisonResponse.md +0 -115
  482. package/skill/references/types/ISYS_LanguageKeyValuePairs.md +0 -13
  483. package/skill/references/types/TSYS_PcbComparisonErrorCode.md +0 -10
@@ -1,703 +1,701 @@
1
- # SCH\_PrimitiveWire class
2
-
3
- Schematic & symbol / wire primitive class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class SCH_PrimitiveWire implements ISCH_PrimitiveAPI
9
- ```
10
- **Implements:** [ISCH\_PrimitiveAPI](../interfaces/ISCH_PrimitiveAPI.md)
11
-
12
- ## Methods
13
-
14
- <table><thead><tr><th>
15
-
16
- Method
17
-
18
- </th><th>
19
-
20
- Modifiers
21
-
22
- </th><th>
23
-
24
- Description
25
-
26
- </th></tr></thead>
27
- <tbody><tr><td>
28
-
29
- [create(line, net, color, lineWidth, lineType)](./SCH_PrimitiveWire.md)
30
-
31
- </td><td>
32
-
33
- </td><td>
34
-
35
- **_(BETA)_** Create Wire
36
-
37
- </td></tr>
38
- <tr><td>
39
-
40
- [delete(primitiveIds)](./SCH_PrimitiveWire.md)
41
-
42
- </td><td>
43
-
44
- </td><td>
45
-
46
- **_(BETA)_** Delete Wire
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- [get(primitiveIds)](./SCH_PrimitiveWire.md)
52
-
53
- </td><td>
54
-
55
- </td><td>
56
-
57
- **_(BETA)_** Get Wire
58
-
59
- </td></tr>
60
- <tr><td>
61
-
62
- [get(primitiveIds)](./SCH_PrimitiveWire.md)
63
-
64
- </td><td>
65
-
66
- </td><td>
67
-
68
- **_(BETA)_** Get Wire
69
-
70
- </td></tr>
71
- <tr><td>
72
-
73
- [getAll(net)](./SCH_PrimitiveWire.md)
74
-
75
- </td><td>
76
-
77
- </td><td>
78
-
79
- **_(BETA)_** Get all Wire
80
-
81
- </td></tr>
82
- <tr><td>
83
-
84
- [getAllPrimitiveId(net)](./SCH_PrimitiveWire.md)
85
-
86
- </td><td>
87
-
88
- </td><td>
89
-
90
- **_(BETA)_** Get all Wire primitive IDs
91
-
92
- </td></tr>
93
- <tr><td>
94
-
95
- [modify(primitiveId, property)](./SCH_PrimitiveWire.md)
96
-
97
- </td><td>
98
-
99
- </td><td>
100
-
101
- **_(BETA)_** Modify Wire
102
-
103
- </td></tr>
104
- </tbody></table>
105
-
106
- ---
107
-
108
- ## 方法详情
109
-
110
- ### create
111
-
112
- # SCH\_PrimitiveWire.create() method
113
-
114
- > 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.
115
-
116
- Create Wire
117
-
118
- ## Signature
119
-
120
- ```typescript
121
- function create(
122
- line: Array<number> | Array<Array<number>>,
123
- net?: string,
124
- color?: string | null,
125
- lineWidth?: number | null,
126
- lineType?: ESCH_PrimitiveLineType | null,
127
- ): Promise<ISCH_PrimitiveWire | undefined>;
128
- ```
129
-
130
- ## Parameters
131
-
132
- <table><thead><tr><th>
133
-
134
- Parameter
135
-
136
- </th><th>
137
-
138
- Type
139
-
140
- </th><th>
141
-
142
- Description
143
-
144
- </th></tr></thead>
145
- <tbody><tr><td>
146
-
147
- line
148
-
149
- </td><td>
150
-
151
- Array&lt;number&gt; \| Array&lt;Array&lt;number&gt;&gt;
152
-
153
- </td><td>
154
-
155
- Polyline coordinate group. Each segment is a continuous line described by `[x1, y1, x2, y2, x3, y3]`<!-- -->. If the polylines have no connection to each other, the creation will fail. Examples for the type `Array<Array<number>>`<!-- -->: 1. `[[], [0, 0, 0, 1]]` - segment 1 has no path, invalid; 2. `[[1], [0, 0, 0, 1]]` - segment 1 only has x, missing y, invalid; 3. `[[0, 0, -1, 0], [0, 0, 1, 1]]` - segment 1 is a horizontal line but segment 2 is a diagonal line, invalid; 4. `[[0, 0, -1, 0, -1, 1], [0, 1, 1, 1]]` - the two segments have no connection, invalid; 5. `[[1, 1], [1, 2, 2, 2]]` - segment 1 has only one point, ignored; segment 2 is a horizontal segment, and the final path keeps only segment 2, valid; 6. `[[1, 1], [1, 2]]` - segment 1 has only one point, ignored; segment 2 is also ignored, and the final path is empty, invalid
156
-
157
- </td></tr>
158
- <tr><td>
159
-
160
- net
161
-
162
- </td><td>
163
-
164
- string
165
-
166
- </td><td>
167
-
168
- _(Optional)_ Net name. If not specified, the following rules apply: 1. If no coordinate falls on any primitive, the empty net is used by default; 2. If one coordinate point is on a primitive of a net, the net of that primitive is followed; 3. If multiple coordinate points are on primitives of different nets, the creation fails. If specified, the following rules apply: 1. If one or more coordinate points are on primitives of other nets, and those other primitives do not explicitly (usually via net labels or net ports) specify a net, they follow the specified net; 2. If other primitives have specified a net, the creation fails
169
-
170
- </td></tr>
171
- <tr><td>
172
-
173
- color
174
-
175
- </td><td>
176
-
177
- string \| null
178
-
179
- </td><td>
180
-
181
- _(Optional)_ Wire color, `null` indicates the default
182
-
183
- </td></tr>
184
- <tr><td>
185
-
186
- lineWidth
187
-
188
- </td><td>
189
-
190
- number \| null
191
-
192
- </td><td>
193
-
194
- _(Optional)_ Line width, range `1-10`<!-- -->. `null` indicates the default
195
-
196
- </td></tr>
197
- <tr><td>
198
-
199
- lineType
200
-
201
- </td><td>
202
-
203
- [ESCH\_PrimitiveLineType](../enums/ESCH_PrimitiveLineType.md) \| null
204
-
205
- </td><td>
206
-
207
- _(Optional)_ Line type. `null` indicates the default
208
-
209
- </td></tr>
210
- </tbody></table>
211
-
212
- ## Returns
213
-
214
- Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
215
-
216
- Wire primitive object
217
-
218
- ## Example
219
-
220
- ```javascript
221
- // 1. 生成随机起点坐标,避免与画布上已有的导线重合(SCH 坐标单位 10mil)
222
- const x = 2000 + Math.floor(Math.random() * 8000);
223
- const y = 2000 + Math.floor(Math.random() * 8000);
224
-
225
- // 2. 创建一条两段相连的 L 形导线:先向右再向上,段与段必须首尾相连且各自水平或垂直
226
- const wire = await eda.sch_PrimitiveWire.create(
227
- [[x, y, x + 400, y], [x + 400, y, x + 400, y + 200]],
228
- 'SIG_A', // 网络名称(自由字符串,未指定时按落点自动推断)
229
- '#FF0000', // 导线颜色
230
- 6, // 线宽(范围 1-10)
231
- 1 // 线型:1 = DASHED(虚线)
232
- );
233
-
234
- // 3. 创建类保留现场,不删除图元;Line 读回是画布规格化坐标(端点顺序可能与传入相反),只打印不做断言
235
- console.log('primitiveId:', wire.getState_PrimitiveId());
236
- console.log('primitiveType:', wire.getState_PrimitiveType());
237
- console.log('net:', wire.getState_Net());
238
- console.log('color:', wire.getState_Color());
239
- console.log('lineWidth:', wire.getState_LineWidth());
240
- console.log('line:', JSON.stringify(wire.getState_Line()));
241
- ```
242
-
243
- ### delete
244
-
245
- # SCH\_PrimitiveWire.delete() method
246
-
247
- > 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.
248
-
249
- Delete Wire
250
-
251
- ## Signature
252
-
253
- ```typescript
254
- function delete(primitiveIds: string | ISCH_PrimitiveWire | Array<string> | Array<ISCH_PrimitiveWire>): Promise<boolean>;
255
- ```
256
-
257
- ## Parameters
258
-
259
- <table><thead><tr><th>
260
-
261
- Parameter
262
-
263
- </th><th>
264
-
265
- Type
266
-
267
- </th><th>
268
-
269
- Description
270
-
271
- </th></tr></thead>
272
- <tbody><tr><td>
273
-
274
- primitiveIds
275
-
276
- </td><td>
277
-
278
- string \| [ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| Array&lt;string&gt; \| Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;
279
-
280
- </td><td>
281
-
282
- Wire primitive ID or Wire primitive object
283
-
284
- </td></tr>
285
- </tbody></table>
286
-
287
- ## Returns
288
-
289
- Promise&lt;boolean&gt;
290
-
291
- Delete Whether the operation is successful
292
-
293
- ## Example
294
-
295
- ```javascript
296
- // 1. 创建两条待删除的测试导线(随机坐标避免重合,SCH 坐标单位 10mil)
297
- const x = 2000 + Math.floor(Math.random() * 8000);
298
- const y = 2000 + Math.floor(Math.random() * 8000);
299
- const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
300
- const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
301
-
302
- // 2. 记录删除前的导线数量
303
- const beforeCount = (await eda.sch_PrimitiveWire.getAll()).length;
304
-
305
- // 3. 分别以 ID 字符串和图元对象两种形式删除两条导线
306
- const deleted1 = await eda.sch_PrimitiveWire.delete(wire1.getState_PrimitiveId());
307
- const deleted2 = await eda.sch_PrimitiveWire.delete(wire2);
308
-
309
- // 4. 删除类保留现场(图元已删除,不恢复)
310
- const afterCount = (await eda.sch_PrimitiveWire.getAll()).length;
311
-
312
- console.log('deleted by id:', deleted1);
313
- console.log('deleted by object:', deleted2);
314
- console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
315
- ```
316
-
317
- ### get
318
-
319
- # SCH\_PrimitiveWire.get() method
320
-
321
- > 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.
322
-
323
- Get Wire
324
-
325
- ## Signature
326
-
327
- ```typescript
328
- function get(primitiveIds: string): Promise<ISCH_PrimitiveWire | undefined>;
329
- ```
330
-
331
- ## Parameters
332
-
333
- <table><thead><tr><th>
334
-
335
- Parameter
336
-
337
- </th><th>
338
-
339
- Type
340
-
341
- </th><th>
342
-
343
- Description
344
-
345
- </th></tr></thead>
346
- <tbody><tr><td>
347
-
348
- primitiveIds
349
-
350
- </td><td>
351
-
352
- string
353
-
354
- </td><td>
355
-
356
- Wire primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
357
-
358
- </td></tr>
359
- </tbody></table>
360
-
361
- ## Returns
362
-
363
- Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
364
-
365
- Wire primitive object, `undefined` indicates that the retrieval failed
366
-
367
- ## Example
368
-
369
- ```javascript
370
- // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
371
- const x = 2000 + Math.floor(Math.random() * 8000);
372
- const y = 2000 + Math.floor(Math.random() * 8000);
373
- const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
374
- const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
375
-
376
- // 2. 传单个 ID 字符串,返回单条导线对象
377
- const single = await eda.sch_PrimitiveWire.get(wire1.getState_PrimitiveId());
378
-
379
- // 3. 传 ID 数组,返回导线对象数组(任一 ID 未匹配不影响其它图元的返回)
380
- const arr = await eda.sch_PrimitiveWire.get([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
381
-
382
- // 4. 清理测试图元(查询类需要清理)
383
- await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
384
-
385
- console.log('single net:', single.getState_Net());
386
- console.log('array length:', arr.length);
387
- console.log('wire2 net:', arr[1].getState_Net());
388
- ```
389
-
390
- ### get_1
391
-
392
- # SCH\_PrimitiveWire.get() method
393
-
394
- > 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.
395
-
396
- Get Wire
397
-
398
- ## Signature
399
-
400
- ```typescript
401
- function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveWire>>;
402
- ```
403
-
404
- ## Parameters
405
-
406
- <table><thead><tr><th>
407
-
408
- Parameter
409
-
410
- </th><th>
411
-
412
- Type
413
-
414
- </th><th>
415
-
416
- Description
417
-
418
- </th></tr></thead>
419
- <tbody><tr><td>
420
-
421
- primitiveIds
422
-
423
- </td><td>
424
-
425
- Array&lt;string&gt;
426
-
427
- </td><td>
428
-
429
- Wire primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
430
-
431
- </td></tr>
432
- </tbody></table>
433
-
434
- ## Returns
435
-
436
- Promise&lt;Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;&gt;
437
-
438
- Wire primitive object; an empty array indicates that the retrieval failed
439
-
440
- ## Remarks
441
-
442
- If multiple primitive IDs are passed in, a primitive ID that is not matched will not affect the return of other primitives; that is, fewer primitive objects than the number of primitive IDs passed in may be returned.
443
-
444
- ### getall
445
-
446
- # SCH\_PrimitiveWire.getAll() method
447
-
448
- > 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.
449
-
450
- Get all Wire
451
-
452
- ## Signature
453
-
454
- ```typescript
455
- function getAll(net?: string | Array<string>): Promise<Array<ISCH_PrimitiveWire>>;
456
- ```
457
-
458
- ## Parameters
459
-
460
- <table><thead><tr><th>
461
-
462
- Parameter
463
-
464
- </th><th>
465
-
466
- Type
467
-
468
- </th><th>
469
-
470
- Description
471
-
472
- </th></tr></thead>
473
- <tbody><tr><td>
474
-
475
- net
476
-
477
- </td><td>
478
-
479
- string \| Array&lt;string&gt;
480
-
481
- </td><td>
482
-
483
- _(Optional)_ Net name
484
-
485
- </td></tr>
486
- </tbody></table>
487
-
488
- ## Returns
489
-
490
- Promise&lt;Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;&gt;
491
-
492
- Array of Wire primitive objects
493
-
494
- ## Example
495
-
496
- ```javascript
497
- // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
498
- const x = 2000 + Math.floor(Math.random() * 8000);
499
- const y = 2000 + Math.floor(Math.random() * 8000);
500
- const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
501
- const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
502
- const wire1Id = wire1.getState_PrimitiveId();
503
-
504
- // 2. 不传参数,获取当前原理图页上的全部导线
505
- const all = await eda.sch_PrimitiveWire.getAll();
506
-
507
- // 3. 传网络名称,只获取该网络的导线
508
- const onlyA = await eda.sch_PrimitiveWire.getAll('SIG_A');
509
-
510
- // 4. 清理测试图元(查询类需要清理)
511
- await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
512
-
513
- console.log('total wires:', all.length);
514
- console.log('marker wire found:', all.some(w => w.getState_PrimitiveId() === wire1Id));
515
- console.log('SIG_A wires:', onlyA.length);
516
- console.log('SIG_A all same net:', onlyA.every(w => w.getState_Net() === 'SIG_A'));
517
- ```
518
-
519
- ### getallprimitiveid
520
-
521
- # SCH\_PrimitiveWire.getAllPrimitiveId() method
522
-
523
- > 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.
524
-
525
- Get all Wire primitive IDs
526
-
527
- ## Signature
528
-
529
- ```typescript
530
- function getAllPrimitiveId(net?: string | Array<string>): Promise<Array<string>>;
531
- ```
532
-
533
- ## Parameters
534
-
535
- <table><thead><tr><th>
536
-
537
- Parameter
538
-
539
- </th><th>
540
-
541
- Type
542
-
543
- </th><th>
544
-
545
- Description
546
-
547
- </th></tr></thead>
548
- <tbody><tr><td>
549
-
550
- net
551
-
552
- </td><td>
553
-
554
- string \| Array&lt;string&gt;
555
-
556
- </td><td>
557
-
558
- _(Optional)_ Net name
559
-
560
- </td></tr>
561
- </tbody></table>
562
-
563
- ## Returns
564
-
565
- Promise&lt;Array&lt;string&gt;&gt;
566
-
567
- Array of Wire primitive IDs
568
-
569
- ## Example
570
-
571
- ```javascript
572
- // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
573
- const x = 2000 + Math.floor(Math.random() * 8000);
574
- const y = 2000 + Math.floor(Math.random() * 8000);
575
- const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
576
- const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
577
- const wire1Id = wire1.getState_PrimitiveId();
578
-
579
- // 2. 不传参数,获取全部导线的图元 ID
580
- const allIds = await eda.sch_PrimitiveWire.getAllPrimitiveId();
581
-
582
- // 3. 传网络名称,只获取该网络导线的图元 ID
583
- const onlyAIds = await eda.sch_PrimitiveWire.getAllPrimitiveId('SIG_A');
584
-
585
- // 4. 清理测试图元(查询类需要清理)
586
- await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
587
-
588
- console.log('total wire ids:', allIds.length);
589
- console.log('marker id in list:', allIds.includes(wire1Id));
590
- console.log('SIG_A id count:', onlyAIds.length);
591
- console.log('SIG_A contains marker:', onlyAIds.includes(wire1Id));
592
- ```
593
-
594
- ### modify
595
-
596
- # SCH\_PrimitiveWire.modify() method
597
-
598
- > 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.
599
-
600
- Modify Wire
601
-
602
- ## Signature
603
-
604
- ```typescript
605
- function modify(
606
- primitiveId: string | ISCH_PrimitiveWire,
607
- property: {
608
- line?: undefined | number[] | number[][];
609
- net?: undefined | string;
610
- color?: undefined | null | string;
611
- lineWidth?: undefined | null | number;
612
- lineType?:
613
- | undefined
614
- | null
615
- | ESCH_PrimitiveLineType.SOLID
616
- | ESCH_PrimitiveLineType.DASHED
617
- | ESCH_PrimitiveLineType.DOTTED
618
- | ESCH_PrimitiveLineType.DOT_DASHED;
619
- },
620
- ): Promise<ISCH_PrimitiveWire | undefined>;
621
- ```
622
-
623
- ## Parameters
624
-
625
- <table><thead><tr><th>
626
-
627
- Parameter
628
-
629
- </th><th>
630
-
631
- Type
632
-
633
- </th><th>
634
-
635
- Description
636
-
637
- </th></tr></thead>
638
- <tbody><tr><td>
639
-
640
- primitiveId
641
-
642
- </td><td>
643
-
644
- string \| [ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)
645
-
646
- </td><td>
647
-
648
- Wire primitive ID or Wire primitive object
649
-
650
- </td></tr>
651
- <tr><td>
652
-
653
- property
654
-
655
- </td><td>
656
-
657
- { line?: undefined \| number\[\] \| number\[\]\[\]; net?: undefined \| string; color?: undefined \| null \| string; lineWidth?: undefined \| null \| number; lineType?: undefined \| null \| [ESCH\_PrimitiveLineType.SOLID](../enums/ESCH_PrimitiveLineType.md) \| [ESCH\_PrimitiveLineType.DASHED](../enums/ESCH_PrimitiveLineType.md) \| [ESCH\_PrimitiveLineType.DOTTED](../enums/ESCH_PrimitiveLineType.md) \| [ESCH\_PrimitiveLineType.DOT\_DASHED](../enums/ESCH_PrimitiveLineType.md) }
658
-
659
- </td><td>
660
-
661
- Modify Parameter
662
-
663
- </td></tr>
664
- </tbody></table>
665
-
666
- ## Returns
667
-
668
- Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
669
-
670
- Wire primitive object
671
-
672
- ## Example
673
-
674
- ```javascript
675
- // 1. 创建待修改的测试导线(随机坐标避免与画布已有导线重合)
676
- const x = 2000 + Math.floor(Math.random() * 8000);
677
- const y = 2000 + Math.floor(Math.random() * 8000);
678
- const wire = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A', '#FF0000', 6, 1);
679
- const wireId = wire.getState_PrimitiveId();
680
-
681
- // 2. 读取修改前的网络、线宽与颜色
682
- const beforeNet = wire.getState_Net();
683
- const beforeWidth = wire.getState_LineWidth();
684
- const beforeColor = wire.getState_Color();
685
-
686
- // 3. 批量修改:网络 SIG_A → SIG_B、线宽 6 → 10、颜色改为绿色,路径改为向右再向上的 L 形
687
- await eda.sch_PrimitiveWire.modify(wireId, {
688
- line: [[x, y, x + 400, y], [x + 400, y, x + 400, y + 200]],
689
- net: 'SIG_B',
690
- lineWidth: 10,
691
- color: '#00AA00',
692
- });
693
-
694
- // 4. modify 返回后需要重新 get() 才能读到画布上的最新值(Line 是规格化坐标,只打印不断言)
695
- const refreshed = await eda.sch_PrimitiveWire.get(wireId);
696
-
697
- // 5. 修改类保留现场,供观察修改结果
698
- console.log('primitiveId:', wireId);
699
- console.log('net:', beforeNet, '→', refreshed.getState_Net());
700
- console.log('lineWidth:', beforeWidth, '→', refreshed.getState_LineWidth());
701
- console.log('color:', beforeColor, '→', refreshed.getState_Color());
702
- console.log('line:', JSON.stringify(refreshed.getState_Line()));
703
- ```
1
+ # SCH\_PrimitiveWire class
2
+
3
+ Schematic &amp; symbol / wire primitive class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class SCH_PrimitiveWire implements ISCH_PrimitiveAPI
9
+ ```
10
+ **Implements:** [ISCH\_PrimitiveAPI](../interfaces/ISCH_PrimitiveAPI.md)
11
+
12
+ ## Methods
13
+
14
+ <table><thead><tr><th>
15
+
16
+ Method
17
+
18
+ </th><th>
19
+
20
+ Modifiers
21
+
22
+ </th><th>
23
+
24
+ Description
25
+
26
+ </th></tr></thead>
27
+ <tbody><tr><td>
28
+
29
+ [create(line, net, color, lineWidth, lineType)](./SCH_PrimitiveWire.md)
30
+
31
+ </td><td>
32
+
33
+ </td><td>
34
+
35
+ **_(BETA)_** Create Wire
36
+
37
+ </td></tr>
38
+ <tr><td>
39
+
40
+ [delete(primitiveIds)](./SCH_PrimitiveWire.md)
41
+
42
+ </td><td>
43
+
44
+ </td><td>
45
+
46
+ **_(BETA)_** Delete Wire
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ [get(primitiveIds)](./SCH_PrimitiveWire.md)
52
+
53
+ </td><td>
54
+
55
+ </td><td>
56
+
57
+ **_(BETA)_** Get Wire
58
+
59
+ </td></tr>
60
+ <tr><td>
61
+
62
+ [get(primitiveIds)](./SCH_PrimitiveWire.md)
63
+
64
+ </td><td>
65
+
66
+ </td><td>
67
+
68
+ **_(BETA)_** Get Wire
69
+
70
+ </td></tr>
71
+ <tr><td>
72
+
73
+ [getAll(net)](./SCH_PrimitiveWire.md)
74
+
75
+ </td><td>
76
+
77
+ </td><td>
78
+
79
+ **_(BETA)_** Get all Wire
80
+
81
+ </td></tr>
82
+ <tr><td>
83
+
84
+ [getAllPrimitiveId(net)](./SCH_PrimitiveWire.md)
85
+
86
+ </td><td>
87
+
88
+ </td><td>
89
+
90
+ **_(BETA)_** Get all Wire primitive IDs
91
+
92
+ </td></tr>
93
+ <tr><td>
94
+
95
+ [modify(primitiveId, property)](./SCH_PrimitiveWire.md)
96
+
97
+ </td><td>
98
+
99
+ </td><td>
100
+
101
+ **_(BETA)_** Modify Wire
102
+
103
+ </td></tr>
104
+ </tbody></table>
105
+
106
+ ---
107
+
108
+ ## 方法详情
109
+
110
+ ### create
111
+
112
+ # SCH\_PrimitiveWire.create() method
113
+
114
+ > 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.
115
+
116
+ Create Wire
117
+
118
+ ## Signature
119
+
120
+ ```typescript
121
+ function create(
122
+ line: Array<number> | Array<Array<number>>,
123
+ net?: string,
124
+ color?: string | null,
125
+ lineWidth?: number | null,
126
+ lineType?: ESCH_PrimitiveLineType | null,
127
+ ): Promise<ISCH_PrimitiveWire | undefined>;
128
+ ```
129
+
130
+ ## Parameters
131
+
132
+ <table><thead><tr><th>
133
+
134
+ Parameter
135
+
136
+ </th><th>
137
+
138
+ Type
139
+
140
+ </th><th>
141
+
142
+ Description
143
+
144
+ </th></tr></thead>
145
+ <tbody><tr><td>
146
+
147
+ line
148
+
149
+ </td><td>
150
+
151
+ Array&lt;number&gt; \| Array&lt;Array&lt;number&gt;&gt;
152
+
153
+ </td><td>
154
+
155
+ Polyline coordinate group. Each segment is a continuous line described by `[x1, y1, x2, y2, x3, y3]`<!-- -->. If the polylines have no connection to each other, the creation will fail. Examples for the type `Array<Array<number>>`<!-- -->: 1. `[[], [0, 0, 0, 1]]` - segment 1 has no path, invalid; 2. `[[1], [0, 0, 0, 1]]` - segment 1 only has x, missing y, invalid; 3. `[[0, 0, -1, 0], [0, 0, 1, 1]]` - segment 1 is a horizontal line but segment 2 is a diagonal line, invalid; 4. `[[0, 0, -1, 0, -1, 1], [0, 1, 1, 1]]` - the two segments have no connection, invalid; 5. `[[1, 1], [1, 2, 2, 2]]` - segment 1 has only one point, ignored; segment 2 is a horizontal segment, and the final path keeps only segment 2, valid; 6. `[[1, 1], [1, 2]]` - segment 1 has only one point, ignored; segment 2 is also ignored, and the final path is empty, invalid
156
+
157
+ </td></tr>
158
+ <tr><td>
159
+
160
+ net
161
+
162
+ </td><td>
163
+
164
+ string
165
+
166
+ </td><td>
167
+
168
+ _(Optional)_ Net name. If not specified, the following rules apply: 1. If no coordinate falls on any primitive, the empty net is used by default; 2. If one coordinate point is on a primitive of a net, the net of that primitive is followed; 3. If multiple coordinate points are on primitives of different nets, the creation fails. If specified, the following rules apply: 1. If one or more coordinate points are on primitives of other nets, and those other primitives do not explicitly (usually via net labels or net ports) specify a net, they follow the specified net; 2. If other primitives have specified a net, the creation fails
169
+
170
+ </td></tr>
171
+ <tr><td>
172
+
173
+ color
174
+
175
+ </td><td>
176
+
177
+ string \| null
178
+
179
+ </td><td>
180
+
181
+ _(Optional)_ Wire color, `null` indicates the default
182
+
183
+ </td></tr>
184
+ <tr><td>
185
+
186
+ lineWidth
187
+
188
+ </td><td>
189
+
190
+ number \| null
191
+
192
+ </td><td>
193
+
194
+ _(Optional)_ Line width, range `1-10`<!-- -->. `null` indicates the default
195
+
196
+ </td></tr>
197
+ <tr><td>
198
+
199
+ lineType
200
+
201
+ </td><td>
202
+
203
+ [ESCH\_PrimitiveLineType](../enums/ESCH_PrimitiveLineType.md) \| null
204
+
205
+ </td><td>
206
+
207
+ _(Optional)_ Line type. `null` indicates the default
208
+
209
+ </td></tr>
210
+ </tbody></table>
211
+
212
+ ## Returns
213
+
214
+ Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
215
+
216
+ Wire primitive object
217
+
218
+ ## Remarks
219
+
220
+ WIRE 组即连通性模型:同网络折线若写成多个 WIRE 组,即使端点相同也不会连通; 编辑器 `create()` 会自动把同网络折线合并为一个 WIRE primitive group,跨组连通需确保段与段首尾相接
221
+
222
+ ## Example
223
+
224
+ ```javascript
225
+ // 1. 生成随机起点坐标,避免与画布上已有的导线重合(SCH 坐标单位 10mil)
226
+ const x = 2000 + Math.floor(Math.random() * 8000);
227
+ const y = 2000 + Math.floor(Math.random() * 8000);
228
+
229
+ // 2. 创建一条两段相连的 L 形导线:先向右再向上,段与段必须首尾相连且各自水平或垂直
230
+ const wire = await eda.sch_PrimitiveWire.create(
231
+ [[x, y, x + 400, y], [x + 400, y, x + 400, y + 200]],
232
+ 'SIG_A', // 网络名称(自由字符串,未指定时按落点自动推断)
233
+ '#FF0000', // 导线颜色
234
+ 6, // 线宽(范围 1-10)
235
+ 1 // 线型:1 = DASHED(虚线)
236
+ );
237
+
238
+ // 3. 创建类保留现场,不删除图元;Line 读回是画布规格化坐标(端点顺序可能与传入相反),只打印不做断言
239
+ console.log('primitiveId:', wire.getState_PrimitiveId());
240
+ console.log('primitiveType:', wire.getState_PrimitiveType());
241
+ console.log('net:', wire.getState_Net());
242
+ console.log('color:', wire.getState_Color());
243
+ console.log('lineWidth:', wire.getState_LineWidth());
244
+ console.log('line:', JSON.stringify(wire.getState_Line()));
245
+ ```
246
+
247
+ ### delete
248
+
249
+ # SCH\_PrimitiveWire.delete() method
250
+
251
+ > 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.
252
+
253
+ Delete Wire
254
+
255
+ ## Signature
256
+
257
+ ```typescript
258
+ function delete(primitiveIds: string | ISCH_PrimitiveWire | Array<string> | Array<ISCH_PrimitiveWire>): Promise<boolean>;
259
+ ```
260
+
261
+ ## Parameters
262
+
263
+ <table><thead><tr><th>
264
+
265
+ Parameter
266
+
267
+ </th><th>
268
+
269
+ Type
270
+
271
+ </th><th>
272
+
273
+ Description
274
+
275
+ </th></tr></thead>
276
+ <tbody><tr><td>
277
+
278
+ primitiveIds
279
+
280
+ </td><td>
281
+
282
+ string \| [ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| Array&lt;string&gt; \| Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;
283
+
284
+ </td><td>
285
+
286
+ Wire primitive ID or Wire primitive object
287
+
288
+ </td></tr>
289
+ </tbody></table>
290
+
291
+ ## Returns
292
+
293
+ Promise&lt;boolean&gt;
294
+
295
+ Delete Whether the operation is successful
296
+
297
+ ## Example
298
+
299
+ ```javascript
300
+ // 1. 创建两条待删除的测试导线(随机坐标避免重合,SCH 坐标单位 10mil)
301
+ const x = 2000 + Math.floor(Math.random() * 8000);
302
+ const y = 2000 + Math.floor(Math.random() * 8000);
303
+ const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
304
+ const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
305
+
306
+ // 2. 记录删除前的导线数量
307
+ const beforeCount = (await eda.sch_PrimitiveWire.getAll()).length;
308
+
309
+ // 3. 分别以 ID 字符串和图元对象两种形式删除两条导线
310
+ const deleted1 = await eda.sch_PrimitiveWire.delete(wire1.getState_PrimitiveId());
311
+ const deleted2 = await eda.sch_PrimitiveWire.delete(wire2);
312
+
313
+ // 4. 删除类保留现场(图元已删除,不恢复)
314
+ const afterCount = (await eda.sch_PrimitiveWire.getAll()).length;
315
+
316
+ console.log('deleted by id:', deleted1);
317
+ console.log('deleted by object:', deleted2);
318
+ console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
319
+ ```
320
+
321
+ ### get
322
+
323
+ # SCH\_PrimitiveWire.get() method
324
+
325
+ > 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.
326
+
327
+ Get Wire
328
+
329
+ ## Signature
330
+
331
+ ```typescript
332
+ function get(primitiveIds: string): Promise<ISCH_PrimitiveWire | undefined>;
333
+ ```
334
+
335
+ ## Parameters
336
+
337
+ <table><thead><tr><th>
338
+
339
+ Parameter
340
+
341
+ </th><th>
342
+
343
+ Type
344
+
345
+ </th><th>
346
+
347
+ Description
348
+
349
+ </th></tr></thead>
350
+ <tbody><tr><td>
351
+
352
+ primitiveIds
353
+
354
+ </td><td>
355
+
356
+ string
357
+
358
+ </td><td>
359
+
360
+ Wire primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
361
+
362
+ </td></tr>
363
+ </tbody></table>
364
+
365
+ ## Returns
366
+
367
+ Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
368
+
369
+ Wire primitive object, `undefined` indicates that the retrieval failed
370
+
371
+ ## Example
372
+
373
+ ```javascript
374
+ // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
375
+ const x = 2000 + Math.floor(Math.random() * 8000);
376
+ const y = 2000 + Math.floor(Math.random() * 8000);
377
+ const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
378
+ const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
379
+
380
+ // 2. 传单个 ID 字符串,返回单条导线对象
381
+ const single = await eda.sch_PrimitiveWire.get(wire1.getState_PrimitiveId());
382
+
383
+ // 3. 传 ID 数组,返回导线对象数组(任一 ID 未匹配不影响其它图元的返回)
384
+ const arr = await eda.sch_PrimitiveWire.get([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
385
+
386
+ // 4. 清理测试图元(查询类需要清理)
387
+ await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
388
+
389
+ console.log('single net:', single.getState_Net());
390
+ console.log('array length:', arr.length);
391
+ console.log('wire2 net:', arr[1].getState_Net());
392
+ ```
393
+
394
+ ### get_1
395
+
396
+ # SCH\_PrimitiveWire.get() method
397
+
398
+ > 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.
399
+
400
+ Get Wire
401
+
402
+ ## Signature
403
+
404
+ ```typescript
405
+ function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveWire>>;
406
+ ```
407
+
408
+ ## Parameters
409
+
410
+ <table><thead><tr><th>
411
+
412
+ Parameter
413
+
414
+ </th><th>
415
+
416
+ Type
417
+
418
+ </th><th>
419
+
420
+ Description
421
+
422
+ </th></tr></thead>
423
+ <tbody><tr><td>
424
+
425
+ primitiveIds
426
+
427
+ </td><td>
428
+
429
+ Array&lt;string&gt;
430
+
431
+ </td><td>
432
+
433
+ Wire primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
434
+
435
+ </td></tr>
436
+ </tbody></table>
437
+
438
+ ## Returns
439
+
440
+ Promise&lt;Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;&gt;
441
+
442
+ Wire primitive object; an empty array indicates that the retrieval failed
443
+
444
+ ## Remarks
445
+
446
+ If multiple primitive IDs are passed in, a primitive ID that is not matched will not affect the return of other primitives; that is, fewer primitive objects than the number of primitive IDs passed in may be returned.
447
+
448
+ ### getall
449
+
450
+ # SCH\_PrimitiveWire.getAll() method
451
+
452
+ > 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.
453
+
454
+ Get all Wire
455
+
456
+ ## Signature
457
+
458
+ ```typescript
459
+ function getAll(net?: string | Array<string>): Promise<Array<ISCH_PrimitiveWire>>;
460
+ ```
461
+
462
+ ## Parameters
463
+
464
+ <table><thead><tr><th>
465
+
466
+ Parameter
467
+
468
+ </th><th>
469
+
470
+ Type
471
+
472
+ </th><th>
473
+
474
+ Description
475
+
476
+ </th></tr></thead>
477
+ <tbody><tr><td>
478
+
479
+ net
480
+
481
+ </td><td>
482
+
483
+ string \| Array&lt;string&gt;
484
+
485
+ </td><td>
486
+
487
+ _(Optional)_ Net name
488
+
489
+ </td></tr>
490
+ </tbody></table>
491
+
492
+ ## Returns
493
+
494
+ Promise&lt;Array&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)<!-- -->&gt;&gt;
495
+
496
+ Array of Wire primitive objects
497
+
498
+ ## Example
499
+
500
+ ```javascript
501
+ // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
502
+ const x = 2000 + Math.floor(Math.random() * 8000);
503
+ const y = 2000 + Math.floor(Math.random() * 8000);
504
+ const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
505
+ const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
506
+ const wire1Id = wire1.getState_PrimitiveId();
507
+
508
+ // 2. 不传参数,获取当前原理图页上的全部导线
509
+ const all = await eda.sch_PrimitiveWire.getAll();
510
+
511
+ // 3. 传网络名称,只获取该网络的导线
512
+ const onlyA = await eda.sch_PrimitiveWire.getAll('SIG_A');
513
+
514
+ // 4. 清理测试图元(查询类需要清理)
515
+ await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
516
+
517
+ console.log('total wires:', all.length);
518
+ console.log('marker wire found:', all.some(w => w.getState_PrimitiveId() === wire1Id));
519
+ console.log('SIG_A wires:', onlyA.length);
520
+ console.log('SIG_A all same net:', onlyA.every(w => w.getState_Net() === 'SIG_A'));
521
+ ```
522
+
523
+ ### getallprimitiveid
524
+
525
+ # SCH\_PrimitiveWire.getAllPrimitiveId() method
526
+
527
+ > 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.
528
+
529
+ Get all Wire primitive IDs
530
+
531
+ ## Signature
532
+
533
+ ```typescript
534
+ function getAllPrimitiveId(net?: string | Array<string>): Promise<Array<string>>;
535
+ ```
536
+
537
+ ## Parameters
538
+
539
+ <table><thead><tr><th>
540
+
541
+ Parameter
542
+
543
+ </th><th>
544
+
545
+ Type
546
+
547
+ </th><th>
548
+
549
+ Description
550
+
551
+ </th></tr></thead>
552
+ <tbody><tr><td>
553
+
554
+ net
555
+
556
+ </td><td>
557
+
558
+ string \| Array&lt;string&gt;
559
+
560
+ </td><td>
561
+
562
+ _(Optional)_ Net name
563
+
564
+ </td></tr>
565
+ </tbody></table>
566
+
567
+ ## Returns
568
+
569
+ Promise&lt;Array&lt;string&gt;&gt;
570
+
571
+ Array of Wire primitive IDs
572
+
573
+ ## Example
574
+
575
+ ```javascript
576
+ // 1. 创建两条测试导线,分别属于不同网络(随机坐标避免重合,SCH 坐标单位 10mil)
577
+ const x = 2000 + Math.floor(Math.random() * 8000);
578
+ const y = 2000 + Math.floor(Math.random() * 8000);
579
+ const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
580
+ const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');
581
+ const wire1Id = wire1.getState_PrimitiveId();
582
+
583
+ // 2. 不传参数,获取全部导线的图元 ID
584
+ const allIds = await eda.sch_PrimitiveWire.getAllPrimitiveId();
585
+
586
+ // 3. 传网络名称,只获取该网络导线的图元 ID
587
+ const onlyAIds = await eda.sch_PrimitiveWire.getAllPrimitiveId('SIG_A');
588
+
589
+ // 4. 清理测试图元(查询类需要清理)
590
+ await eda.sch_PrimitiveWire.delete([wire1.getState_PrimitiveId(), wire2.getState_PrimitiveId()]);
591
+
592
+ console.log('total wire ids:', allIds.length);
593
+ console.log('marker id in list:', allIds.includes(wire1Id));
594
+ console.log('SIG_A id count:', onlyAIds.length);
595
+ console.log('SIG_A contains marker:', onlyAIds.includes(wire1Id));
596
+ ```
597
+
598
+ ### modify
599
+
600
+ # SCH\_PrimitiveWire.modify() method
601
+
602
+ > 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.
603
+
604
+ Modify Wire
605
+
606
+ ## Signature
607
+
608
+ ```typescript
609
+ function modify(
610
+ primitiveId: string | ISCH_PrimitiveWire,
611
+ property: {
612
+ line?: Array<number> | Array<Array<number>>;
613
+ net?: string;
614
+ color?: string | null;
615
+ lineWidth?: number | null;
616
+ lineType?: ESCH_PrimitiveLineType | null;
617
+ },
618
+ ): Promise<ISCH_PrimitiveWire | undefined>;
619
+ ```
620
+
621
+ ## Parameters
622
+
623
+ <table><thead><tr><th>
624
+
625
+ Parameter
626
+
627
+ </th><th>
628
+
629
+ Type
630
+
631
+ </th><th>
632
+
633
+ Description
634
+
635
+ </th></tr></thead>
636
+ <tbody><tr><td>
637
+
638
+ primitiveId
639
+
640
+ </td><td>
641
+
642
+ string \| [ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md)
643
+
644
+ </td><td>
645
+
646
+ Wire primitive ID or Wire primitive object
647
+
648
+ </td></tr>
649
+ <tr><td>
650
+
651
+ property
652
+
653
+ </td><td>
654
+
655
+ { line?: Array&lt;number&gt; \| Array&lt;Array&lt;number&gt;&gt;; net?: string; color?: string \| null; lineWidth?: number \| null; lineType?: [ESCH\_PrimitiveLineType](../enums/ESCH_PrimitiveLineType.md) \| null }
656
+
657
+ </td><td>
658
+
659
+ Modify Parameter
660
+
661
+ </td></tr>
662
+ </tbody></table>
663
+
664
+ ## Returns
665
+
666
+ Promise&lt;[ISCH\_PrimitiveWire](./ISCH_PrimitiveWire.md) \| undefined&gt;
667
+
668
+ Wire primitive object
669
+
670
+ ## Example
671
+
672
+ ```javascript
673
+ // 1. 创建待修改的测试导线(随机坐标避免与画布已有导线重合)
674
+ const x = 2000 + Math.floor(Math.random() * 8000);
675
+ const y = 2000 + Math.floor(Math.random() * 8000);
676
+ const wire = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A', '#FF0000', 6, 1);
677
+ const wireId = wire.getState_PrimitiveId();
678
+
679
+ // 2. 读取修改前的网络、线宽与颜色
680
+ const beforeNet = wire.getState_Net();
681
+ const beforeWidth = wire.getState_LineWidth();
682
+ const beforeColor = wire.getState_Color();
683
+
684
+ // 3. 批量修改:网络 SIG_A → SIG_B、线宽 6 → 10、颜色改为绿色,路径改为向右再向上的 L 形
685
+ await eda.sch_PrimitiveWire.modify(wireId, {
686
+ line: [[x, y, x + 400, y], [x + 400, y, x + 400, y + 200]],
687
+ net: 'SIG_B',
688
+ lineWidth: 10,
689
+ color: '#00AA00',
690
+ });
691
+
692
+ // 4. modify 返回后需要重新 get() 才能读到画布上的最新值(Line 是规格化坐标,只打印不断言)
693
+ const refreshed = await eda.sch_PrimitiveWire.get(wireId);
694
+
695
+ // 5. 修改类保留现场,供观察修改结果
696
+ console.log('primitiveId:', wireId);
697
+ console.log('net:', beforeNet, '→', refreshed.getState_Net());
698
+ console.log('lineWidth:', beforeWidth, '→', refreshed.getState_LineWidth());
699
+ console.log('color:', beforeColor, '→', refreshed.getState_Color());
700
+ console.log('line:', JSON.stringify(refreshed.getState_Line()));
701
+ ```