@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,1205 +1,1209 @@
1
- # SCH\_ManufactureData class
2
-
3
- Schematic & symbol / manufacture data class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class SCH_ManufactureData
9
- ```
10
-
11
- ## Remarks
12
-
13
- Get the manufacture data files of the current schematic sheet and quick ordering
14
-
15
- ## Methods
16
-
17
- <table><thead><tr><th>
18
-
19
- Method
20
-
21
- </th><th>
22
-
23
- Modifiers
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
- </th></tr></thead>
30
- <tbody><tr><td>
31
-
32
- [deleteBomTemplate(template)](./SCH_ManufactureData.md)
33
-
34
- </td><td>
35
-
36
- </td><td>
37
-
38
- **_(BETA)_** Delete BOM template
39
-
40
- </td></tr>
41
- <tr><td>
42
-
43
- [getAssemblyVariantsConfigs()](./SCH_ManufactureData.md)
44
-
45
- </td><td>
46
-
47
- </td><td>
48
-
49
- **_(BETA)_** Get the assembly variants configuration list
50
-
51
- </td></tr>
52
- <tr><td>
53
-
54
- [getBomFile(fileName, fileType, template, filterOptions, statistics, property, columns, assemblyVariantsConfig)](./SCH_ManufactureData.md)
55
-
56
- </td><td>
57
-
58
- </td><td>
59
-
60
- **_(BETA)_** Get BOM file
61
-
62
- </td></tr>
63
- <tr><td>
64
-
65
- [getBomTemplateFile(template)](./SCH_ManufactureData.md)
66
-
67
- </td><td>
68
-
69
- </td><td>
70
-
71
- **_(BETA)_** Get BOM template file
72
-
73
- </td></tr>
74
- <tr><td>
75
-
76
- [getBomTemplates()](./SCH_ManufactureData.md)
77
-
78
- </td><td>
79
-
80
- </td><td>
81
-
82
- **_(BETA)_** Get BOM template list
83
-
84
- </td></tr>
85
- <tr><td>
86
-
87
- [getExportDocumentFile(fileName, fileType, typeSpecificParams, object, objectSpecificParams)](./SCH_ManufactureData.md)
88
-
89
- </td><td>
90
-
91
- </td><td>
92
-
93
- **_(BETA)_** Get Export document file
94
-
95
- </td></tr>
96
- <tr><td>
97
-
98
- [getNetlistFile(fileName, netlistType)](./SCH_ManufactureData.md)
99
-
100
- </td><td>
101
-
102
- </td><td>
103
-
104
- **_(BETA)_** Get the netlist file (Netlist)
105
-
106
- </td></tr>
107
- <tr><td>
108
-
109
- [getPngFile(fileName, resolution)](./SCH_ManufactureData.md)
110
-
111
- </td><td>
112
-
113
- </td><td>
114
-
115
- **_(BETA)_** 获取 PNG 文件
116
-
117
- </td></tr>
118
- <tr><td>
119
-
120
- [getSimulationNetlistFile(fileName, netlistType)](./SCH_ManufactureData.md)
121
-
122
- </td><td>
123
-
124
- </td><td>
125
-
126
- **_(BETA)_** Get the simulation netlist file
127
-
128
- </td></tr>
129
- <tr><td>
130
-
131
- [getSvgFile(fileName)](./SCH_ManufactureData.md)
132
-
133
- </td><td>
134
-
135
- </td><td>
136
-
137
- **_(BETA)_** 获取 SVG 文件
138
-
139
- </td></tr>
140
- <tr><td>
141
-
142
- [placeComponentsOrder(interactive, ignoreWarning)](./SCH_ManufactureData.md)
143
-
144
- </td><td>
145
-
146
- </td><td>
147
-
148
- **_(BETA)_** Component ordering
149
-
150
- </td></tr>
151
- <tr><td>
152
-
153
- [placeSmtComponentsOrder(interactive, ignoreWarning)](./SCH_ManufactureData.md)
154
-
155
- </td><td>
156
-
157
- </td><td>
158
-
159
- **_(BETA)_** SMT component ordering
160
-
161
- </td></tr>
162
- <tr><td>
163
-
164
- [uploadBomTemplateFile(templateFile, template)](./SCH_ManufactureData.md)
165
-
166
- </td><td>
167
-
168
- </td><td>
169
-
170
- **_(BETA)_** Upload a BOM template file
171
-
172
- </td></tr>
173
- </tbody></table>
174
-
175
- ---
176
-
177
- ## 方法详情
178
-
179
- ### deletebomtemplate
180
-
181
- # SCH\_ManufactureData.deleteBomTemplate() method
182
-
183
- > 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.
184
-
185
- Delete BOM template
186
-
187
- ## Signature
188
-
189
- ```typescript
190
- function deleteBomTemplate(template: string): Promise<boolean>;
191
- ```
192
-
193
- ## Parameters
194
-
195
- <table><thead><tr><th>
196
-
197
- Parameter
198
-
199
- </th><th>
200
-
201
- Type
202
-
203
- </th><th>
204
-
205
- Description
206
-
207
- </th></tr></thead>
208
- <tbody><tr><td>
209
-
210
- template
211
-
212
- </td><td>
213
-
214
- string
215
-
216
- </td><td>
217
-
218
- BOM template name
219
-
220
- </td></tr>
221
- </tbody></table>
222
-
223
- ## Returns
224
-
225
- Promise&lt;boolean&gt;
226
-
227
- Whether the operation is successful
228
-
229
- ## Example
230
-
231
- ```javascript
232
- // 1. 查看当前账号下的 BOM 模板
233
- const templates = await eda.sch_ManufactureData.getBomTemplates();
234
- console.log('当前模板:', templates.join('、'));
235
-
236
- // 2. 删除一个不存在的模板名,验证 API 的返回行为(不影响任何已有模板)
237
- const success = await eda.sch_ManufactureData.deleteBomTemplate('嘉立创示例_不存在的模板');
238
- console.log('删除不存在模板的返回值:', success);
239
- ```
240
-
241
- ### getassemblyvariantsconfigs
242
-
243
- # SCH\_ManufactureData.getAssemblyVariantsConfigs() method
244
-
245
- > 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.
246
-
247
- Get the assembly variants configuration list
248
-
249
- ## Signature
250
-
251
- ```typescript
252
- function getAssemblyVariantsConfigs(): Promise<Array<{ text: string; value: string }>>;
253
- ```
254
-
255
- ## Returns
256
-
257
- Promise&lt;Array&lt;{ text: string; value: string }&gt;&gt;
258
-
259
- Assembly variants configuration list
260
-
261
- ## Example
262
-
263
- ```javascript
264
- // 1. 获取全部装配体变量配置
265
- const variantsConfigs = await eda.sch_ManufactureData.getAssemblyVariantsConfigs();
266
-
267
- // 2. 逐个查看
268
- console.log('配置数量:', variantsConfigs.length);
269
- variantsConfigs.forEach((config, index) => console.log(`配置 ${index + 1}:`, config.text, config.value));
270
- ```
271
-
272
- ### getbomfile
273
-
274
- # SCH\_ManufactureData.getBomFile() method
275
-
276
- > 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.
277
-
278
- Get BOM file
279
-
280
- ## Signature
281
-
282
- ```typescript
283
- function getBomFile(
284
- fileName?: string,
285
- fileType?: 'xlsx' | 'csv',
286
- template?: string,
287
- filterOptions?: Array<{ property: string; includeValue: string | false | true }>,
288
- statistics?: Array<string>,
289
- property?: Array<string>,
290
- columns?: Array<IPCB_BomPropertiesTableColumns>,
291
- assemblyVariantsConfig?: { text: string; value: string },
292
- ): Promise<File | undefined>;
293
- ```
294
-
295
- ## Parameters
296
-
297
- <table><thead><tr><th>
298
-
299
- Parameter
300
-
301
- </th><th>
302
-
303
- Type
304
-
305
- </th><th>
306
-
307
- Description
308
-
309
- </th></tr></thead>
310
- <tbody><tr><td>
311
-
312
- fileName
313
-
314
- </td><td>
315
-
316
- string
317
-
318
- </td><td>
319
-
320
- _(Optional)_ File name
321
-
322
- </td></tr>
323
- <tr><td>
324
-
325
- fileType
326
-
327
- </td><td>
328
-
329
- 'xlsx' \| 'csv'
330
-
331
- </td><td>
332
-
333
- _(Optional)_ File type
334
-
335
- </td></tr>
336
- <tr><td>
337
-
338
- template
339
-
340
- </td><td>
341
-
342
- string
343
-
344
- </td><td>
345
-
346
- _(Optional)_ Template name
347
-
348
- </td></tr>
349
- <tr><td>
350
-
351
- filterOptions
352
-
353
- </td><td>
354
-
355
- Array&lt;{ property: string; includeValue: string \| false \| true }&gt;
356
-
357
- </td><td>
358
-
359
- _(Optional)_ Filter rules, which should only contain the rules to be enabled. `property` is the rule name, and `includeValue` is the matched value
360
-
361
- </td></tr>
362
- <tr><td>
363
-
364
- statistics
365
-
366
- </td><td>
367
-
368
- Array&lt;string&gt;
369
-
370
- </td><td>
371
-
372
- _(Optional)_ Statistics, containing the names of all statistic items to be enabled
373
-
374
- </td></tr>
375
- <tr><td>
376
-
377
- property
378
-
379
- </td><td>
380
-
381
- Array&lt;string&gt;
382
-
383
- </td><td>
384
-
385
- _(Optional)_ Properties, containing the names of all properties to be enabled
386
-
387
- </td></tr>
388
- <tr><td>
389
-
390
- columns
391
-
392
- </td><td>
393
-
394
- Array&lt;[IPCB\_BomPropertiesTableColumns](../interfaces/IPCB_BomPropertiesTableColumns.md)<!-- -->&gt;
395
-
396
- </td><td>
397
-
398
- _(Optional)_ Column properties and sorting. If `title`<!-- -->, `sort`<!-- -->, `group`<!-- -->, and `orderWeight` are not passed in, default values are used. `null` means \*\*none\*\* or \*\*empty\*\*
399
-
400
- </td></tr>
401
- <tr><td>
402
-
403
- assemblyVariantsConfig
404
-
405
- </td><td>
406
-
407
- \{ text: string; value: string \}
408
-
409
- </td><td>
410
-
411
- _(Optional)_ Assembly variants configuration
412
-
413
- </td></tr>
414
- </tbody></table>
415
-
416
- ## Returns
417
-
418
- Promise&lt;File \| undefined&gt;
419
-
420
- BOM file data
421
-
422
- ## Remarks
423
-
424
- You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
425
-
426
- ## Example
427
-
428
- ```javascript
429
- // 1. 导出 xlsx 格式 BOM,只包含标记了加入 BOM 的元件
430
- const bomFile = await eda.sch_ManufactureData.getBomFile(
431
- '嘉立创示例_BOM',
432
- 'xlsx',
433
- undefined,
434
- [{ property: 'Add into BOM', includeValue: 'yes' }]
435
- );
436
-
437
- // 2. 查看导出结果
438
- console.log('导出文件名:', bomFile?.name);
439
- console.log('文件大小:', bomFile?.size);
440
- ```
441
-
442
- ### getbomtemplatefile
443
-
444
- # SCH\_ManufactureData.getBomTemplateFile() method
445
-
446
- > 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.
447
-
448
- Get BOM template file
449
-
450
- ## Signature
451
-
452
- ```typescript
453
- function getBomTemplateFile(template: string): Promise<File | undefined>;
454
- ```
455
-
456
- ## Parameters
457
-
458
- <table><thead><tr><th>
459
-
460
- Parameter
461
-
462
- </th><th>
463
-
464
- Type
465
-
466
- </th><th>
467
-
468
- Description
469
-
470
- </th></tr></thead>
471
- <tbody><tr><td>
472
-
473
- template
474
-
475
- </td><td>
476
-
477
- string
478
-
479
- </td><td>
480
-
481
- BOM template name
482
-
483
- </td></tr>
484
- </tbody></table>
485
-
486
- ## Returns
487
-
488
- Promise&lt;File \| undefined&gt;
489
-
490
- BOM template file
491
-
492
- ## Example
493
-
494
- ```javascript
495
- // 1. 先拿到账号下可用的 BOM 模板列表
496
- const templates = await eda.sch_ManufactureData.getBomTemplates();
497
- console.log('可用模板:', templates.join('、'));
498
-
499
- // 2. 导出第一个模板的文件
500
- const templateFile = await eda.sch_ManufactureData.getBomTemplateFile(templates[0]);
501
-
502
- // 3. 查看导出结果
503
- console.log('模板文件大小:', templateFile?.size);
504
- ```
505
-
506
- ### getbomtemplates
507
-
508
- # SCH\_ManufactureData.getBomTemplates() method
509
-
510
- > 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.
511
-
512
- Get BOM template list
513
-
514
- ## Signature
515
-
516
- ```typescript
517
- function getBomTemplates(): Promise<Array<string>>;
518
- ```
519
-
520
- ## Returns
521
-
522
- Promise&lt;Array&lt;string&gt;&gt;
523
-
524
- BOM template list
525
-
526
- ## Example
527
-
528
- ```javascript
529
- // 1. 获取全部 BOM 模板名
530
- const templates = await eda.sch_ManufactureData.getBomTemplates();
531
-
532
- // 2. 逐个查看
533
- console.log('模板数量:', templates.length);
534
- templates.forEach((name, index) => console.log(`模板 ${index + 1}:`, name));
535
- ```
536
-
537
- ### getexportdocumentfile
538
-
539
- # SCH\_ManufactureData.getExportDocumentFile() method
540
-
541
- > 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.
542
-
543
- > Warning: This API is now obsolete.
544
- >
545
- > - DEPRECATED since EDA v4.1
546
-
547
- Get Export document file
548
-
549
- ## Signature
550
-
551
- ```typescript
552
- function getExportDocumentFile(
553
- fileName?: string,
554
- fileType?: ESCH_ExportDocumentFileType,
555
- typeSpecificParams?: {
556
- theme?: undefined | 'Default' | 'White on Black' | 'Black on White';
557
- lineWidth?: undefined | 'Default' | 'Always 1px' | 'Follow the Zoom Change';
558
- displayAttributesAsMenu?: undefined | false | true;
559
- size?:
560
- | undefined
561
- | string
562
- | { width: number; height: number; unit: ESYS_Unit.MILLIMETER | ESYS_Unit.INCH };
563
- },
564
- object?: 'All Schematic' | 'Current Schematic' | 'Current Schematic Page' | string,
565
- objectSpecificParams?: {
566
- range?: undefined | 'All' | any;
567
- outputMethod?: undefined | 'Merged sheet' | 'Separated sheet';
568
- },
569
- ): Promise<File | undefined>;
570
- ```
571
-
572
- ## Parameters
573
-
574
- <table><thead><tr><th>
575
-
576
- Parameter
577
-
578
- </th><th>
579
-
580
- Type
581
-
582
- </th><th>
583
-
584
- Description
585
-
586
- </th></tr></thead>
587
- <tbody><tr><td>
588
-
589
- fileName
590
-
591
- </td><td>
592
-
593
- string
594
-
595
- </td><td>
596
-
597
- _(Optional)_ File name
598
-
599
- </td></tr>
600
- <tr><td>
601
-
602
- fileType
603
-
604
- </td><td>
605
-
606
- [ESCH\_ExportDocumentFileType](../enums/ESCH_ExportDocumentFileType.md)
607
-
608
- </td><td>
609
-
610
- _(Optional)_ File type
611
-
612
- </td></tr>
613
- <tr><td>
614
-
615
- typeSpecificParams
616
-
617
- </td><td>
618
-
619
- { theme?: undefined \| 'Default' \| 'White on Black' \| 'Black on White'; lineWidth?: undefined \| 'Default' \| 'Always 1px' \| 'Follow the Zoom Change'; displayAttributesAsMenu?: undefined \| false \| true; size?: undefined \| string \| { width: number; height: number; unit: [ESYS\_Unit.MILLIMETER](../enums/ESYS_Unit.md) \| [ESYS\_Unit.INCH](../enums/ESYS_Unit.md) } }
620
-
621
- </td><td>
622
-
623
- _(Optional)_ Type-specific parameters
624
-
625
- </td></tr>
626
- <tr><td>
627
-
628
- object
629
-
630
- </td><td>
631
-
632
- 'All Schematic' \| 'Current Schematic' \| 'Current Schematic Page' \| string
633
-
634
- </td><td>
635
-
636
- _(Optional)_ Object
637
-
638
- </td></tr>
639
- <tr><td>
640
-
641
- objectSpecificParams
642
-
643
- </td><td>
644
-
645
- { range?: undefined \| 'All' \| any; outputMethod?: undefined \| 'Merged sheet' \| 'Separated sheet' }
646
-
647
- </td><td>
648
-
649
- _(Optional)_ Object-specific parameters
650
-
651
- </td></tr>
652
- </tbody></table>
653
-
654
- ## Returns
655
-
656
- Promise&lt;File \| undefined&gt;
657
-
658
- Exported document file data (or archive)
659
-
660
- ## Remarks
661
-
662
- You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
663
-
664
- ## Example
665
-
666
- ```javascript
667
- // 1. 把当前图页导出为 PDF('PDF' 对应 ESCH_ExportDocumentFileType.PDF)
668
- // const pdfFile = await eda.sch_ManufactureData.getExportDocumentFile(
669
- // '嘉立创示例_原理图',
670
- // 'PDF',
671
- // undefined,
672
- // 'Current Schematic Page'
673
- // );
674
- // console.log('导出文件名:', pdfFile?.name);
675
- // 2. 也可以导出 PNG 位图,并通过类型特定参数控制主题和线宽
676
- // const pngFile = await eda.sch_ManufactureData.getExportDocumentFile(
677
- // '嘉立创示例_原理图',
678
- // 'PNG',
679
- // { theme: 'Black on White', lineWidth: 'Always 1px' },
680
- // 'All Schematic',
681
- // { outputMethod: 'Separated sheet' } // 多图页时逐页分张输出
682
- // );
683
- // console.log('导出文件名:', pngFile?.name);
684
- // 3. 拿到文件后用 sys_FileSystem.saveFile() 保存到本地
685
- console.log('演示调用:getExportDocumentFile(文件名, 文件类型, 显示参数, 导出范围, 多页参数)');
686
- ```
687
-
688
- ### getnetlistfile
689
-
690
- # SCH\_ManufactureData.getNetlistFile() method
691
-
692
- > 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.
693
-
694
- Get the netlist file (Netlist)
695
-
696
- ## Signature
697
-
698
- ```typescript
699
- function getNetlistFile(
700
- fileName?: string,
701
- netlistType?: ESYS_NetlistType,
702
- ): Promise<File | undefined>;
703
- ```
704
-
705
- ## Parameters
706
-
707
- <table><thead><tr><th>
708
-
709
- Parameter
710
-
711
- </th><th>
712
-
713
- Type
714
-
715
- </th><th>
716
-
717
- Description
718
-
719
- </th></tr></thead>
720
- <tbody><tr><td>
721
-
722
- fileName
723
-
724
- </td><td>
725
-
726
- string
727
-
728
- </td><td>
729
-
730
- _(Optional)_ File name
731
-
732
- </td></tr>
733
- <tr><td>
734
-
735
- netlistType
736
-
737
- </td><td>
738
-
739
- [ESYS\_NetlistType](../enums/ESYS_NetlistType.md)
740
-
741
- </td><td>
742
-
743
- _(Optional)_ Netlist type
744
-
745
- </td></tr>
746
- </tbody></table>
747
-
748
- ## Returns
749
-
750
- Promise&lt;File \| undefined&gt;
751
-
752
- Netlist file data
753
-
754
- ## Remarks
755
-
756
- You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
757
-
758
- ## Example
759
-
760
- ```javascript
761
- // 1. 导出 Altium Designer 格式的网表('Protel2' 对应 ESYS_NetlistType.ALTIUM_DESIGNER)
762
- try {
763
- const netlistFile = await eda.sch_ManufactureData.getNetlistFile('嘉立创示例_网表', 'Protel2');
764
- console.log('导出文件名:', netlistFile?.name);
765
- console.log('文件大小:', netlistFile?.size);
766
- }
767
- catch (e) {
768
- // 原理图数据不满足网表校验(如引脚编号重复)时会抛错
769
- console.log('当前原理图数据不满足网表导出要求,导出未完成');
770
- }
771
- ```
772
-
773
- ### getpngfile
774
-
775
- # SCH\_ManufactureData.getPngFile() method
776
-
777
- > 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.
778
-
779
- 获取 PNG 文件
780
-
781
- ## Signature
782
-
783
- ```typescript
784
- function getPngFile(
785
- fileName?: string,
786
- resolution?: ISCH_ExportPngResolution,
787
- ): Promise<File | undefined>;
788
- ```
789
-
790
- ## Parameters
791
-
792
- <table><thead><tr><th>
793
-
794
- Parameter
795
-
796
- </th><th>
797
-
798
- Type
799
-
800
- </th><th>
801
-
802
- Description
803
-
804
- </th></tr></thead>
805
- <tbody><tr><td>
806
-
807
- fileName
808
-
809
- </td><td>
810
-
811
- string
812
-
813
- </td><td>
814
-
815
- _(Optional)_ 文件名
816
-
817
- </td></tr>
818
- <tr><td>
819
-
820
- resolution
821
-
822
- </td><td>
823
-
824
- [ISCH\_ExportPngResolution](../interfaces/ISCH_ExportPngResolution.md)
825
-
826
- </td><td>
827
-
828
- _(Optional)_ 导出图片分辨率,见 [ISCH\_ExportPngResolution](../interfaces/ISCH_ExportPngResolution.md)
829
-
830
- </td></tr>
831
- </tbody></table>
832
-
833
- ## Returns
834
-
835
- Promise&lt;File \| undefined&gt;
836
-
837
- PNG 文件数据(或压缩包)
838
-
839
- ## Remarks
840
-
841
- ADD since EDA v3.2.183 支持按长宽分辨率导出高清图片(最大 4096); 支持只传入 `width` 或 `height` 中的任意一个,另一侧将按原始比例自动拉伸输出; `width` 与 `height` 均不传时,按当前一倍分辨率输出
842
-
843
- / EDA v4.1.23
844
-
845
- ### getsimulationnetlistfile
846
-
847
- # SCH\_ManufactureData.getSimulationNetlistFile() method
848
-
849
- > 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.
850
-
851
- Get the simulation netlist file
852
-
853
- ## Signature
854
-
855
- ```typescript
856
- function getSimulationNetlistFile(
857
- fileName?: string,
858
- netlistType?: ESCH_SimulationNetlistType,
859
- ): Promise<File | undefined>;
860
- ```
861
-
862
- ## Parameters
863
-
864
- <table><thead><tr><th>
865
-
866
- Parameter
867
-
868
- </th><th>
869
-
870
- Type
871
-
872
- </th><th>
873
-
874
- Description
875
-
876
- </th></tr></thead>
877
- <tbody><tr><td>
878
-
879
- fileName
880
-
881
- </td><td>
882
-
883
- string
884
-
885
- </td><td>
886
-
887
- _(Optional)_ File name
888
-
889
- </td></tr>
890
- <tr><td>
891
-
892
- netlistType
893
-
894
- </td><td>
895
-
896
- [ESCH\_SimulationNetlistType](../enums/ESCH_SimulationNetlistType.md)
897
-
898
- </td><td>
899
-
900
- _(Optional)_ Netlist type
901
-
902
- </td></tr>
903
- </tbody></table>
904
-
905
- ## Returns
906
-
907
- Promise&lt;File \| undefined&gt;
908
-
909
- Simulation netlist file data
910
-
911
- ## Remarks
912
-
913
- You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
914
-
915
- ## Example
916
-
917
- ```javascript
918
- // 1. 导出 Ngspice 仿真网表('Ngspice' 对应 ESCH_SimulationNetlistType.NGSPICE)
919
- // const simNetlistFile = await eda.sch_ManufactureData.getSimulationNetlistFile('嘉立创示例_仿真网表', 'Ngspice');
920
- // console.log('导出文件名:', simNetlistFile?.name);
921
- // console.log('文件大小:', simNetlistFile?.size);
922
- // 2. 拿到文件后用 sys_FileSystem.saveFile() 保存到本地,或交给仿真工具直接使用
923
- console.log('演示调用:getSimulationNetlistFile(文件名, 网表类型)');
924
- ```
925
-
926
- ### getsvgfile
927
-
928
- # SCH\_ManufactureData.getSvgFile() method
929
-
930
- > 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.
931
-
932
- 获取 SVG 文件
933
-
934
- ## Signature
935
-
936
- ```typescript
937
- function getSvgFile(fileName?: string): Promise<File | undefined>;
938
- ```
939
-
940
- ## Parameters
941
-
942
- <table><thead><tr><th>
943
-
944
- Parameter
945
-
946
- </th><th>
947
-
948
- Type
949
-
950
- </th><th>
951
-
952
- Description
953
-
954
- </th></tr></thead>
955
- <tbody><tr><td>
956
-
957
- fileName
958
-
959
- </td><td>
960
-
961
- string
962
-
963
- </td><td>
964
-
965
- _(Optional)_ 文件名
966
-
967
- </td></tr>
968
- </tbody></table>
969
-
970
- ## Returns
971
-
972
- Promise&lt;File \| undefined&gt;
973
-
974
- SVG 文件数据(或压缩包)
975
-
976
- ## Remarks
977
-
978
- ADD since EDA v3.2.183 多图页时会导出为压缩包(zip)
979
-
980
- / EDA v4.1.23
981
-
982
- ### placecomponentsorder
983
-
984
- # SCH\_ManufactureData.placeComponentsOrder() method
985
-
986
- > 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.
987
-
988
- Component ordering
989
-
990
- ## Signature
991
-
992
- ```typescript
993
- function placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
994
- ```
995
-
996
- ## Parameters
997
-
998
- <table><thead><tr><th>
999
-
1000
- Parameter
1001
-
1002
- </th><th>
1003
-
1004
- Type
1005
-
1006
- </th><th>
1007
-
1008
- Description
1009
-
1010
- </th></tr></thead>
1011
- <tbody><tr><td>
1012
-
1013
- interactive
1014
-
1015
- </td><td>
1016
-
1017
- boolean
1018
-
1019
- </td><td>
1020
-
1021
- _(Optional)_ Whether to enable interactive checking. If enabled, a popup will wait for user interaction, and the `ignoreWarning` parameter cannot be used to ignore warnings; that is, the `ignoreWarning` parameter will be ignored. If disabled, no EDA internal popup will appear after the call, and the program performs a silent check. If the ordering conditions are met, `true` will be returned and the ordering page will be opened in a new tab
1022
-
1023
- </td></tr>
1024
- <tr><td>
1025
-
1026
- ignoreWarning
1027
-
1028
- </td><td>
1029
-
1030
- boolean
1031
-
1032
- </td><td>
1033
-
1034
- _(Optional)_ Ignore warnings during non-interactive checking. If set to `true`<!-- -->, all check warning items will be ignored and the ordering data will be generated as much as possible; if set to `false`<!-- -->, any warning will interrupt execution and return `false`
1035
-
1036
- </td></tr>
1037
- </tbody></table>
1038
-
1039
- ## Returns
1040
-
1041
- Promise&lt;boolean&gt;
1042
-
1043
- Whether the ordering check passed
1044
-
1045
- ## Example
1046
-
1047
- ```javascript
1048
- // 1. 交互式下单检查:弹出检查弹窗等待确认,确认后打开购买页面
1049
- // const passed = await eda.sch_ManufactureData.placeComponentsOrder(true);
1050
- // 2. 静默检查:不弹任何弹窗,忽略警告并直接生成下单资料
1051
- // const passed = await eda.sch_ManufactureData.placeComponentsOrder(false, true);
1052
- // console.log('下单检查结果 ' + passed);
1053
- // 下单会真实打开订单页面并产生订单数据,案例中不实际执行
1054
- console.log('演示调用:placeComponentsOrder(true) 交互式检查,或 placeComponentsOrder(false, true) 静默下单');
1055
- ```
1056
-
1057
- ### placesmtcomponentsorder
1058
-
1059
- # SCH\_ManufactureData.placeSmtComponentsOrder() method
1060
-
1061
- > 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.
1062
-
1063
- SMT component ordering
1064
-
1065
- ## Signature
1066
-
1067
- ```typescript
1068
- function placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
1069
- ```
1070
-
1071
- ## Parameters
1072
-
1073
- <table><thead><tr><th>
1074
-
1075
- Parameter
1076
-
1077
- </th><th>
1078
-
1079
- Type
1080
-
1081
- </th><th>
1082
-
1083
- Description
1084
-
1085
- </th></tr></thead>
1086
- <tbody><tr><td>
1087
-
1088
- interactive
1089
-
1090
- </td><td>
1091
-
1092
- boolean
1093
-
1094
- </td><td>
1095
-
1096
- _(Optional)_ Whether to enable interactive checking. If enabled, a popup will wait for user interaction, and the `ignoreWarning` parameter cannot be used to ignore warnings; that is, the `ignoreWarning` parameter will be ignored. If disabled, no EDA internal popup will appear after the call, and the program performs a silent check. If the ordering conditions are met, `true` will be returned and the ordering page will be opened in a new tab
1097
-
1098
- </td></tr>
1099
- <tr><td>
1100
-
1101
- ignoreWarning
1102
-
1103
- </td><td>
1104
-
1105
- boolean
1106
-
1107
- </td><td>
1108
-
1109
- _(Optional)_ Ignore warnings during non-interactive checking. If set to `true`<!-- -->, all check warning items will be ignored and the ordering data will be generated as much as possible; if set to `false`<!-- -->, any warning will interrupt execution and return `false`
1110
-
1111
- </td></tr>
1112
- </tbody></table>
1113
-
1114
- ## Returns
1115
-
1116
- Promise&lt;boolean&gt;
1117
-
1118
- Whether the ordering check passed
1119
-
1120
- ## Example
1121
-
1122
- ```javascript
1123
- // 1. 交互式下单检查:弹出检查弹窗等待确认,确认后打开下单页面
1124
- // const passed = await eda.sch_ManufactureData.placeSmtComponentsOrder(true);
1125
- // 2. 静默检查:不弹任何弹窗,忽略警告并直接生成下单资料
1126
- // const passed = await eda.sch_ManufactureData.placeSmtComponentsOrder(false, true);
1127
- // console.log('下单检查结果 ' + passed);
1128
- // 下单会真实打开订单页面并产生订单数据,案例中不实际执行
1129
- console.log('演示调用:placeSmtComponentsOrder(true) 交互式检查,或 placeSmtComponentsOrder(false, true) 静默下单');
1130
- ```
1131
-
1132
- ### uploadbomtemplatefile
1133
-
1134
- # SCH\_ManufactureData.uploadBomTemplateFile() method
1135
-
1136
- > 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.
1137
-
1138
- Upload a BOM template file
1139
-
1140
- ## Signature
1141
-
1142
- ```typescript
1143
- function uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;
1144
- ```
1145
-
1146
- ## Parameters
1147
-
1148
- <table><thead><tr><th>
1149
-
1150
- Parameter
1151
-
1152
- </th><th>
1153
-
1154
- Type
1155
-
1156
- </th><th>
1157
-
1158
- Description
1159
-
1160
- </th></tr></thead>
1161
- <tbody><tr><td>
1162
-
1163
- templateFile
1164
-
1165
- </td><td>
1166
-
1167
- File
1168
-
1169
- </td><td>
1170
-
1171
- BOM template file
1172
-
1173
- </td></tr>
1174
- <tr><td>
1175
-
1176
- template
1177
-
1178
- </td><td>
1179
-
1180
- string
1181
-
1182
- </td><td>
1183
-
1184
- _(Optional)_ BOM template name. If it is `undefined`<!-- -->, the value is automatically taken from `templateFile`
1185
-
1186
- </td></tr>
1187
- </tbody></table>
1188
-
1189
- ## Returns
1190
-
1191
- Promise&lt;string \| undefined&gt;
1192
-
1193
- BOM template name
1194
-
1195
- ## Example
1196
-
1197
- ```javascript
1198
- // 1. 从本地选择模板文件(弹窗需要用户交互)
1199
- // const templateFile = await eda.sys_FileSystem.openReadFileDialog('.xlsx');
1200
- // 2. 上传为新的 BOM 模板(第二参数指定模板名,不传则从文件名取)
1201
- // const templateName = await eda.sch_ManufactureData.uploadBomTemplateFile(templateFile, '嘉立创示例_模板');
1202
- // console.log('上传后的模板名 ' + templateName);
1203
- // 3. 上传后用 getBomTemplates 查看列表确认,不再需要时用 deleteBomTemplate 删除
1204
- console.log('演示流程:openReadFileDialog 读取 xlsx → uploadBomTemplateFile 上传 → getBomTemplates 确认');
1205
- ```
1
+ # SCH\_ManufactureData class
2
+
3
+ Schematic &amp; symbol / manufacture data class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class SCH_ManufactureData
9
+ ```
10
+
11
+ ## Remarks
12
+
13
+ Get the manufacture data files of the current schematic sheet and quick ordering
14
+
15
+ ## Methods
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Method
20
+
21
+ </th><th>
22
+
23
+ Modifiers
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+ </th></tr></thead>
30
+ <tbody><tr><td>
31
+
32
+ [deleteBomTemplate(template)](./SCH_ManufactureData.md)
33
+
34
+ </td><td>
35
+
36
+ </td><td>
37
+
38
+ **_(BETA)_** Delete BOM template
39
+
40
+ </td></tr>
41
+ <tr><td>
42
+
43
+ [getAssemblyVariantsConfigs()](./SCH_ManufactureData.md)
44
+
45
+ </td><td>
46
+
47
+ </td><td>
48
+
49
+ **_(BETA)_** Get the assembly variants configuration list
50
+
51
+ </td></tr>
52
+ <tr><td>
53
+
54
+ [getBomFile(fileName, fileType, template, filterOptions, statistics, property, columns, assemblyVariantsConfig)](./SCH_ManufactureData.md)
55
+
56
+ </td><td>
57
+
58
+ </td><td>
59
+
60
+ **_(BETA)_** Get BOM file
61
+
62
+ </td></tr>
63
+ <tr><td>
64
+
65
+ [getBomTemplateFile(template)](./SCH_ManufactureData.md)
66
+
67
+ </td><td>
68
+
69
+ </td><td>
70
+
71
+ **_(BETA)_** Get BOM template file
72
+
73
+ </td></tr>
74
+ <tr><td>
75
+
76
+ [getBomTemplates()](./SCH_ManufactureData.md)
77
+
78
+ </td><td>
79
+
80
+ </td><td>
81
+
82
+ **_(BETA)_** Get BOM template list
83
+
84
+ </td></tr>
85
+ <tr><td>
86
+
87
+ [getExportDocumentFile(fileName, fileType, typeSpecificParams, object, objectSpecificParams)](./SCH_ManufactureData.md)
88
+
89
+ </td><td>
90
+
91
+ </td><td>
92
+
93
+ **_(BETA)_** Get Export document file
94
+
95
+ </td></tr>
96
+ <tr><td>
97
+
98
+ [getNetlistFile(fileName, netlistType)](./SCH_ManufactureData.md)
99
+
100
+ </td><td>
101
+
102
+ </td><td>
103
+
104
+ **_(BETA)_** Get the netlist file (Netlist)
105
+
106
+ </td></tr>
107
+ <tr><td>
108
+
109
+ [getPngFile(fileName, resolution)](./SCH_ManufactureData.md)
110
+
111
+ </td><td>
112
+
113
+ </td><td>
114
+
115
+ **_(BETA)_** 获取 PNG 文件
116
+
117
+ </td></tr>
118
+ <tr><td>
119
+
120
+ [getSimulationNetlistFile(fileName, netlistType)](./SCH_ManufactureData.md)
121
+
122
+ </td><td>
123
+
124
+ </td><td>
125
+
126
+ **_(BETA)_** Get the simulation netlist file
127
+
128
+ </td></tr>
129
+ <tr><td>
130
+
131
+ [getSvgFile(fileName)](./SCH_ManufactureData.md)
132
+
133
+ </td><td>
134
+
135
+ </td><td>
136
+
137
+ **_(BETA)_** 获取 SVG 文件
138
+
139
+ </td></tr>
140
+ <tr><td>
141
+
142
+ [placeComponentsOrder(interactive, ignoreWarning)](./SCH_ManufactureData.md)
143
+
144
+ </td><td>
145
+
146
+ </td><td>
147
+
148
+ **_(BETA)_** Component ordering
149
+
150
+ </td></tr>
151
+ <tr><td>
152
+
153
+ [placeSmtComponentsOrder(interactive, ignoreWarning)](./SCH_ManufactureData.md)
154
+
155
+ </td><td>
156
+
157
+ </td><td>
158
+
159
+ **_(BETA)_** SMT component ordering
160
+
161
+ </td></tr>
162
+ <tr><td>
163
+
164
+ [uploadBomTemplateFile(templateFile, template)](./SCH_ManufactureData.md)
165
+
166
+ </td><td>
167
+
168
+ </td><td>
169
+
170
+ **_(BETA)_** Upload a BOM template file
171
+
172
+ </td></tr>
173
+ </tbody></table>
174
+
175
+ ---
176
+
177
+ ## 方法详情
178
+
179
+ ### deletebomtemplate
180
+
181
+ # SCH\_ManufactureData.deleteBomTemplate() method
182
+
183
+ > 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.
184
+
185
+ Delete BOM template
186
+
187
+ ## Signature
188
+
189
+ ```typescript
190
+ function deleteBomTemplate(template: string): Promise<boolean>;
191
+ ```
192
+
193
+ ## Parameters
194
+
195
+ <table><thead><tr><th>
196
+
197
+ Parameter
198
+
199
+ </th><th>
200
+
201
+ Type
202
+
203
+ </th><th>
204
+
205
+ Description
206
+
207
+ </th></tr></thead>
208
+ <tbody><tr><td>
209
+
210
+ template
211
+
212
+ </td><td>
213
+
214
+ string
215
+
216
+ </td><td>
217
+
218
+ BOM template name
219
+
220
+ </td></tr>
221
+ </tbody></table>
222
+
223
+ ## Returns
224
+
225
+ Promise&lt;boolean&gt;
226
+
227
+ Whether the operation is successful
228
+
229
+ ## Example
230
+
231
+ ```javascript
232
+ // 1. 查看当前账号下的 BOM 模板
233
+ const templates = await eda.sch_ManufactureData.getBomTemplates();
234
+ console.log('当前模板:', templates.join('、'));
235
+
236
+ // 2. 删除一个不存在的模板名,验证 API 的返回行为(不影响任何已有模板)
237
+ const success = await eda.sch_ManufactureData.deleteBomTemplate('嘉立创示例_不存在的模板');
238
+ console.log('删除不存在模板的返回值:', success);
239
+ ```
240
+
241
+ ### getassemblyvariantsconfigs
242
+
243
+ # SCH\_ManufactureData.getAssemblyVariantsConfigs() method
244
+
245
+ > 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.
246
+
247
+ Get the assembly variants configuration list
248
+
249
+ ## Signature
250
+
251
+ ```typescript
252
+ function getAssemblyVariantsConfigs(): Promise<Array<{ text: string; value: string }>>;
253
+ ```
254
+
255
+ ## Returns
256
+
257
+ Promise&lt;Array&lt;{ text: string; value: string }&gt;&gt;
258
+
259
+ Assembly variants configuration list
260
+
261
+ ## Example
262
+
263
+ ```javascript
264
+ // 1. 获取全部装配体变量配置
265
+ const variantsConfigs = await eda.sch_ManufactureData.getAssemblyVariantsConfigs();
266
+
267
+ // 2. 逐个查看
268
+ console.log('配置数量:', variantsConfigs.length);
269
+ variantsConfigs.forEach((config, index) => console.log(`配置 ${index + 1}:`, config.text, config.value));
270
+ ```
271
+
272
+ ### getbomfile
273
+
274
+ # SCH\_ManufactureData.getBomFile() method
275
+
276
+ > 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.
277
+
278
+ Get BOM file
279
+
280
+ ## Signature
281
+
282
+ ```typescript
283
+ function getBomFile(
284
+ fileName?: string,
285
+ fileType?: 'xlsx' | 'csv',
286
+ template?: string,
287
+ filterOptions?: Array<{ property: string; includeValue: boolean | string }>,
288
+ statistics?: Array<string>,
289
+ property?: Array<string>,
290
+ columns?: Array<IPCB_BomPropertiesTableColumns>,
291
+ assemblyVariantsConfig?: { text: string; value: string },
292
+ ): Promise<File | undefined>;
293
+ ```
294
+
295
+ ## Parameters
296
+
297
+ <table><thead><tr><th>
298
+
299
+ Parameter
300
+
301
+ </th><th>
302
+
303
+ Type
304
+
305
+ </th><th>
306
+
307
+ Description
308
+
309
+ </th></tr></thead>
310
+ <tbody><tr><td>
311
+
312
+ fileName
313
+
314
+ </td><td>
315
+
316
+ string
317
+
318
+ </td><td>
319
+
320
+ _(Optional)_ File name
321
+
322
+ </td></tr>
323
+ <tr><td>
324
+
325
+ fileType
326
+
327
+ </td><td>
328
+
329
+ 'xlsx' \| 'csv'
330
+
331
+ </td><td>
332
+
333
+ _(Optional)_ File type
334
+
335
+ </td></tr>
336
+ <tr><td>
337
+
338
+ template
339
+
340
+ </td><td>
341
+
342
+ string
343
+
344
+ </td><td>
345
+
346
+ _(Optional)_ Template name
347
+
348
+ </td></tr>
349
+ <tr><td>
350
+
351
+ filterOptions
352
+
353
+ </td><td>
354
+
355
+ Array&lt;{ property: string; includeValue: boolean \| string }&gt;
356
+
357
+ </td><td>
358
+
359
+ _(Optional)_ Filter rules, which should only contain the rules to be enabled. `property` is the rule name, and `includeValue` is the matched value
360
+
361
+ </td></tr>
362
+ <tr><td>
363
+
364
+ statistics
365
+
366
+ </td><td>
367
+
368
+ Array&lt;string&gt;
369
+
370
+ </td><td>
371
+
372
+ _(Optional)_ Statistics, containing the names of all statistic items to be enabled
373
+
374
+ </td></tr>
375
+ <tr><td>
376
+
377
+ property
378
+
379
+ </td><td>
380
+
381
+ Array&lt;string&gt;
382
+
383
+ </td><td>
384
+
385
+ _(Optional)_ Properties, containing the names of all properties to be enabled
386
+
387
+ </td></tr>
388
+ <tr><td>
389
+
390
+ columns
391
+
392
+ </td><td>
393
+
394
+ Array&lt;[IPCB\_BomPropertiesTableColumns](../interfaces/IPCB_BomPropertiesTableColumns.md)<!-- -->&gt;
395
+
396
+ </td><td>
397
+
398
+ _(Optional)_ Column properties and sorting. If `title`<!-- -->, `sort`<!-- -->, `group`<!-- -->, and `orderWeight` are not passed in, default values are used. `null` means \*\*none\*\* or \*\*empty\*\*
399
+
400
+ </td></tr>
401
+ <tr><td>
402
+
403
+ assemblyVariantsConfig
404
+
405
+ </td><td>
406
+
407
+ \{ text: string; value: string \}
408
+
409
+ </td><td>
410
+
411
+ _(Optional)_ Assembly variants configuration
412
+
413
+ </td></tr>
414
+ </tbody></table>
415
+
416
+ ## Returns
417
+
418
+ Promise&lt;File \| undefined&gt;
419
+
420
+ BOM file data
421
+
422
+ ## Remarks
423
+
424
+ You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
425
+
426
+ ## Example
427
+
428
+ ```javascript
429
+ // 1. 导出 xlsx 格式 BOM,只包含标记了加入 BOM 的元件
430
+ const bomFile = await eda.sch_ManufactureData.getBomFile(
431
+ '嘉立创示例_BOM',
432
+ 'xlsx',
433
+ undefined,
434
+ [{ property: 'Add into BOM', includeValue: 'yes' }]
435
+ );
436
+
437
+ // 2. 查看导出结果
438
+ console.log('导出文件名:', bomFile?.name);
439
+ console.log('文件大小:', bomFile?.size);
440
+ ```
441
+
442
+ ### getbomtemplatefile
443
+
444
+ # SCH\_ManufactureData.getBomTemplateFile() method
445
+
446
+ > 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.
447
+
448
+ Get BOM template file
449
+
450
+ ## Signature
451
+
452
+ ```typescript
453
+ function getBomTemplateFile(template: string): Promise<File | undefined>;
454
+ ```
455
+
456
+ ## Parameters
457
+
458
+ <table><thead><tr><th>
459
+
460
+ Parameter
461
+
462
+ </th><th>
463
+
464
+ Type
465
+
466
+ </th><th>
467
+
468
+ Description
469
+
470
+ </th></tr></thead>
471
+ <tbody><tr><td>
472
+
473
+ template
474
+
475
+ </td><td>
476
+
477
+ string
478
+
479
+ </td><td>
480
+
481
+ BOM template name
482
+
483
+ </td></tr>
484
+ </tbody></table>
485
+
486
+ ## Returns
487
+
488
+ Promise&lt;File \| undefined&gt;
489
+
490
+ BOM template file
491
+
492
+ ## Example
493
+
494
+ ```javascript
495
+ // 1. 先拿到账号下可用的 BOM 模板列表
496
+ const templates = await eda.sch_ManufactureData.getBomTemplates();
497
+ console.log('可用模板:', templates.join('、'));
498
+
499
+ // 2. 导出第一个模板的文件
500
+ const templateFile = await eda.sch_ManufactureData.getBomTemplateFile(templates[0]);
501
+
502
+ // 3. 查看导出结果
503
+ console.log('模板文件大小:', templateFile?.size);
504
+ ```
505
+
506
+ ### getbomtemplates
507
+
508
+ # SCH\_ManufactureData.getBomTemplates() method
509
+
510
+ > 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.
511
+
512
+ Get BOM template list
513
+
514
+ ## Signature
515
+
516
+ ```typescript
517
+ function getBomTemplates(): Promise<Array<string>>;
518
+ ```
519
+
520
+ ## Returns
521
+
522
+ Promise&lt;Array&lt;string&gt;&gt;
523
+
524
+ BOM template list
525
+
526
+ ## Example
527
+
528
+ ```javascript
529
+ // 1. 获取全部 BOM 模板名
530
+ const templates = await eda.sch_ManufactureData.getBomTemplates();
531
+
532
+ // 2. 逐个查看
533
+ console.log('模板数量:', templates.length);
534
+ templates.forEach((name, index) => console.log(`模板 ${index + 1}:`, name));
535
+ ```
536
+
537
+ ### getexportdocumentfile
538
+
539
+ # SCH\_ManufactureData.getExportDocumentFile() method
540
+
541
+ > 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.
542
+
543
+ > Warning: This API is now obsolete.
544
+ >
545
+ > - DEPRECATED since EDA v4.1
546
+
547
+ Get Export document file
548
+
549
+ ## Signature
550
+
551
+ ```typescript
552
+ function getExportDocumentFile(
553
+ fileName?: string,
554
+ fileType?: ESCH_ExportDocumentFileType,
555
+ typeSpecificParams?: {
556
+ theme?: 'Default' | 'White on Black' | 'Black on White';
557
+ lineWidth?: 'Default' | 'Always 1px' | 'Follow the Zoom Change';
558
+ displayAttributesAsMenu?: boolean;
559
+ size?:
560
+ | 'Original Size'
561
+ | string
562
+ | { width: number; height: number; unit: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER };
563
+ },
564
+ object?: 'All Schematic' | 'Current Schematic' | 'Current Schematic Page' | string,
565
+ objectSpecificParams?: {
566
+ range?: 'All' | [number, number];
567
+ outputMethod?: 'Merged sheet' | 'Separated sheet';
568
+ },
569
+ ): Promise<File | undefined>;
570
+ ```
571
+
572
+ ## Parameters
573
+
574
+ <table><thead><tr><th>
575
+
576
+ Parameter
577
+
578
+ </th><th>
579
+
580
+ Type
581
+
582
+ </th><th>
583
+
584
+ Description
585
+
586
+ </th></tr></thead>
587
+ <tbody><tr><td>
588
+
589
+ fileName
590
+
591
+ </td><td>
592
+
593
+ string
594
+
595
+ </td><td>
596
+
597
+ _(Optional)_ File name
598
+
599
+ </td></tr>
600
+ <tr><td>
601
+
602
+ fileType
603
+
604
+ </td><td>
605
+
606
+ [ESCH\_ExportDocumentFileType](../enums/ESCH_ExportDocumentFileType.md)
607
+
608
+ </td><td>
609
+
610
+ _(Optional)_ File type
611
+
612
+ </td></tr>
613
+ <tr><td>
614
+
615
+ typeSpecificParams
616
+
617
+ </td><td>
618
+
619
+ { theme?: 'Default' \| 'White on Black' \| 'Black on White'; lineWidth?: 'Default' \| 'Always 1px' \| 'Follow the Zoom Change'; displayAttributesAsMenu?: boolean; size?: 'Original Size' \| string \| { width: number; height: number; unit: [ESYS\_Unit.INCH](../enums/ESYS_Unit.md) \| [ESYS\_Unit.MILLIMETER](../enums/ESYS_Unit.md) } }
620
+
621
+ </td><td>
622
+
623
+ _(Optional)_ Type-specific parameters
624
+
625
+ </td></tr>
626
+ <tr><td>
627
+
628
+ object
629
+
630
+ </td><td>
631
+
632
+ 'All Schematic' \| 'Current Schematic' \| 'Current Schematic Page' \| string
633
+
634
+ </td><td>
635
+
636
+ _(Optional)_ Object
637
+
638
+ </td></tr>
639
+ <tr><td>
640
+
641
+ objectSpecificParams
642
+
643
+ </td><td>
644
+
645
+ { range?: 'All' \| \[number, number\]; outputMethod?: 'Merged sheet' \| 'Separated sheet' }
646
+
647
+ </td><td>
648
+
649
+ _(Optional)_ Object-specific parameters
650
+
651
+ </td></tr>
652
+ </tbody></table>
653
+
654
+ ## Returns
655
+
656
+ Promise&lt;File \| undefined&gt;
657
+
658
+ Exported document file data (or archive)
659
+
660
+ ## Remarks
661
+
662
+ You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
663
+
664
+ ## Example
665
+
666
+ ```javascript
667
+ // 1. 把当前图页导出为 PDF('PDF' 对应 ESCH_ExportDocumentFileType.PDF)
668
+ // const pdfFile = await eda.sch_ManufactureData.getExportDocumentFile(
669
+ // '嘉立创示例_原理图',
670
+ // 'PDF',
671
+ // undefined,
672
+ // 'Current Schematic Page'
673
+ // );
674
+ // console.log('导出文件名:', pdfFile?.name);
675
+ // 2. 也可以导出 PNG 位图,并通过类型特定参数控制主题和线宽
676
+ // const pngFile = await eda.sch_ManufactureData.getExportDocumentFile(
677
+ // '嘉立创示例_原理图',
678
+ // 'PNG',
679
+ // { theme: 'Black on White', lineWidth: 'Always 1px' },
680
+ // 'All Schematic',
681
+ // { outputMethod: 'Separated sheet' } // 多图页时逐页分张输出
682
+ // );
683
+ // console.log('导出文件名:', pngFile?.name);
684
+ // 3. 拿到文件后用 sys_FileSystem.saveFile() 保存到本地
685
+ console.log('演示调用:getExportDocumentFile(文件名, 文件类型, 显示参数, 导出范围, 多页参数)');
686
+ ```
687
+
688
+ ### getnetlistfile
689
+
690
+ # SCH\_ManufactureData.getNetlistFile() method
691
+
692
+ > 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.
693
+
694
+ Get the netlist file (Netlist)
695
+
696
+ ## Signature
697
+
698
+ ```typescript
699
+ function getNetlistFile(
700
+ fileName?: string,
701
+ netlistType?: ESYS_NetlistType,
702
+ ): Promise<File | undefined>;
703
+ ```
704
+
705
+ ## Parameters
706
+
707
+ <table><thead><tr><th>
708
+
709
+ Parameter
710
+
711
+ </th><th>
712
+
713
+ Type
714
+
715
+ </th><th>
716
+
717
+ Description
718
+
719
+ </th></tr></thead>
720
+ <tbody><tr><td>
721
+
722
+ fileName
723
+
724
+ </td><td>
725
+
726
+ string
727
+
728
+ </td><td>
729
+
730
+ _(Optional)_ File name
731
+
732
+ </td></tr>
733
+ <tr><td>
734
+
735
+ netlistType
736
+
737
+ </td><td>
738
+
739
+ [ESYS\_NetlistType](../enums/ESYS_NetlistType.md)
740
+
741
+ </td><td>
742
+
743
+ _(Optional)_ Netlist type
744
+
745
+ </td></tr>
746
+ </tbody></table>
747
+
748
+ ## Returns
749
+
750
+ Promise&lt;File \| undefined&gt;
751
+
752
+ Netlist file data
753
+
754
+ ## Remarks
755
+
756
+ You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
757
+
758
+ ## Example
759
+
760
+ ```javascript
761
+ // 1. 导出 Altium Designer 格式的网表('Protel2' 对应 ESYS_NetlistType.ALTIUM_DESIGNER)
762
+ try {
763
+ const netlistFile = await eda.sch_ManufactureData.getNetlistFile('嘉立创示例_网表', 'Protel2');
764
+ console.log('导出文件名:', netlistFile?.name);
765
+ console.log('文件大小:', netlistFile?.size);
766
+ }
767
+ catch (e) {
768
+ // 原理图数据不满足网表校验(如引脚编号重复)时会抛错
769
+ console.log('当前原理图数据不满足网表导出要求,导出未完成');
770
+ }
771
+ ```
772
+
773
+ ### getpngfile
774
+
775
+ # SCH\_ManufactureData.getPngFile() method
776
+
777
+ > 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.
778
+
779
+ 获取 PNG 文件
780
+
781
+ ## Signature
782
+
783
+ ```typescript
784
+ function getPngFile(
785
+ fileName?: string,
786
+ resolution?: ISCH_ExportPngResolution,
787
+ ): Promise<File | undefined>;
788
+ ```
789
+
790
+ ## Parameters
791
+
792
+ <table><thead><tr><th>
793
+
794
+ Parameter
795
+
796
+ </th><th>
797
+
798
+ Type
799
+
800
+ </th><th>
801
+
802
+ Description
803
+
804
+ </th></tr></thead>
805
+ <tbody><tr><td>
806
+
807
+ fileName
808
+
809
+ </td><td>
810
+
811
+ string
812
+
813
+ </td><td>
814
+
815
+ _(Optional)_ 文件名
816
+
817
+ </td></tr>
818
+ <tr><td>
819
+
820
+ resolution
821
+
822
+ </td><td>
823
+
824
+ [ISCH\_ExportPngResolution](../interfaces/ISCH_ExportPngResolution.md)
825
+
826
+ </td><td>
827
+
828
+ _(Optional)_ 导出图片分辨率,见 [ISCH\_ExportPngResolution](../interfaces/ISCH_ExportPngResolution.md)
829
+
830
+ </td></tr>
831
+ </tbody></table>
832
+
833
+ ## Returns
834
+
835
+ Promise&lt;File \| undefined&gt;
836
+
837
+ PNG 文件数据(或压缩包)
838
+
839
+ ## Remarks
840
+
841
+ ADD since EDA v3.2.183 支持按长宽分辨率导出高清图片(最大 4096); 支持只传入 `width` 或 `height` 中的任意一个,另一侧将按原始比例自动拉伸输出; `width` 与 `height` 均不传时,按当前一倍分辨率输出
842
+
843
+ 注意:多图页时返回的文件与 [getSvgFile](./SCH_ManufactureData.md) 同名(`schematic.zip`<!-- -->), 保存时须自行改名以免互相覆盖
844
+
845
+ / EDA v4.1.23
846
+
847
+ ### getsimulationnetlistfile
848
+
849
+ # SCH\_ManufactureData.getSimulationNetlistFile() method
850
+
851
+ > 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.
852
+
853
+ Get the simulation netlist file
854
+
855
+ ## Signature
856
+
857
+ ```typescript
858
+ function getSimulationNetlistFile(
859
+ fileName?: string,
860
+ netlistType?: ESCH_SimulationNetlistType,
861
+ ): Promise<File | undefined>;
862
+ ```
863
+
864
+ ## Parameters
865
+
866
+ <table><thead><tr><th>
867
+
868
+ Parameter
869
+
870
+ </th><th>
871
+
872
+ Type
873
+
874
+ </th><th>
875
+
876
+ Description
877
+
878
+ </th></tr></thead>
879
+ <tbody><tr><td>
880
+
881
+ fileName
882
+
883
+ </td><td>
884
+
885
+ string
886
+
887
+ </td><td>
888
+
889
+ _(Optional)_ File name
890
+
891
+ </td></tr>
892
+ <tr><td>
893
+
894
+ netlistType
895
+
896
+ </td><td>
897
+
898
+ [ESCH\_SimulationNetlistType](../enums/ESCH_SimulationNetlistType.md)
899
+
900
+ </td><td>
901
+
902
+ _(Optional)_ Netlist type
903
+
904
+ </td></tr>
905
+ </tbody></table>
906
+
907
+ ## Returns
908
+
909
+ Promise&lt;File \| undefined&gt;
910
+
911
+ Simulation netlist file data
912
+
913
+ ## Remarks
914
+
915
+ You can use [SYS\_FileSystem.saveFile()](./SYS_FileSystem.md) API export the file to the local file system
916
+
917
+ ## Example
918
+
919
+ ```javascript
920
+ // 1. 导出 Ngspice 仿真网表('Ngspice' 对应 ESCH_SimulationNetlistType.NGSPICE)
921
+ // const simNetlistFile = await eda.sch_ManufactureData.getSimulationNetlistFile('嘉立创示例_仿真网表', 'Ngspice');
922
+ // console.log('导出文件名:', simNetlistFile?.name);
923
+ // console.log('文件大小:', simNetlistFile?.size);
924
+ // 2. 拿到文件后用 sys_FileSystem.saveFile() 保存到本地,或交给仿真工具直接使用
925
+ console.log('演示调用:getSimulationNetlistFile(文件名, 网表类型)');
926
+ ```
927
+
928
+ ### getsvgfile
929
+
930
+ # SCH\_ManufactureData.getSvgFile() method
931
+
932
+ > 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.
933
+
934
+ 获取 SVG 文件
935
+
936
+ ## Signature
937
+
938
+ ```typescript
939
+ function getSvgFile(fileName?: string): Promise<File | undefined>;
940
+ ```
941
+
942
+ ## Parameters
943
+
944
+ <table><thead><tr><th>
945
+
946
+ Parameter
947
+
948
+ </th><th>
949
+
950
+ Type
951
+
952
+ </th><th>
953
+
954
+ Description
955
+
956
+ </th></tr></thead>
957
+ <tbody><tr><td>
958
+
959
+ fileName
960
+
961
+ </td><td>
962
+
963
+ string
964
+
965
+ </td><td>
966
+
967
+ _(Optional)_ 文件名
968
+
969
+ </td></tr>
970
+ </tbody></table>
971
+
972
+ ## Returns
973
+
974
+ Promise&lt;File \| undefined&gt;
975
+
976
+ SVG 文件数据(或压缩包)
977
+
978
+ ## Remarks
979
+
980
+ ADD since EDA v3.2.183 多图页时会导出为压缩包(zip)
981
+
982
+ 注意:返回的文件与 [getPngFile](./SCH_ManufactureData.md) 同名(`schematic.zip`<!-- -->), 保存时须自行改名以免互相覆盖
983
+
984
+ / EDA v4.1.23
985
+
986
+ ### placecomponentsorder
987
+
988
+ # SCH\_ManufactureData.placeComponentsOrder() method
989
+
990
+ > 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.
991
+
992
+ Component ordering
993
+
994
+ ## Signature
995
+
996
+ ```typescript
997
+ function placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
998
+ ```
999
+
1000
+ ## Parameters
1001
+
1002
+ <table><thead><tr><th>
1003
+
1004
+ Parameter
1005
+
1006
+ </th><th>
1007
+
1008
+ Type
1009
+
1010
+ </th><th>
1011
+
1012
+ Description
1013
+
1014
+ </th></tr></thead>
1015
+ <tbody><tr><td>
1016
+
1017
+ interactive
1018
+
1019
+ </td><td>
1020
+
1021
+ boolean
1022
+
1023
+ </td><td>
1024
+
1025
+ _(Optional)_ Whether to enable interactive checking. If enabled, a popup will wait for user interaction, and the `ignoreWarning` parameter cannot be used to ignore warnings; that is, the `ignoreWarning` parameter will be ignored. If disabled, no EDA internal popup will appear after the call, and the program performs a silent check. If the ordering conditions are met, `true` will be returned and the ordering page will be opened in a new tab
1026
+
1027
+ </td></tr>
1028
+ <tr><td>
1029
+
1030
+ ignoreWarning
1031
+
1032
+ </td><td>
1033
+
1034
+ boolean
1035
+
1036
+ </td><td>
1037
+
1038
+ _(Optional)_ Ignore warnings during non-interactive checking. If set to `true`<!-- -->, all check warning items will be ignored and the ordering data will be generated as much as possible; if set to `false`<!-- -->, any warning will interrupt execution and return `false`
1039
+
1040
+ </td></tr>
1041
+ </tbody></table>
1042
+
1043
+ ## Returns
1044
+
1045
+ Promise&lt;boolean&gt;
1046
+
1047
+ Whether the ordering check passed
1048
+
1049
+ ## Example
1050
+
1051
+ ```javascript
1052
+ // 1. 交互式下单检查:弹出检查弹窗等待确认,确认后打开购买页面
1053
+ // const passed = await eda.sch_ManufactureData.placeComponentsOrder(true);
1054
+ // 2. 静默检查:不弹任何弹窗,忽略警告并直接生成下单资料
1055
+ // const passed = await eda.sch_ManufactureData.placeComponentsOrder(false, true);
1056
+ // console.log('下单检查结果 ' + passed);
1057
+ // 下单会真实打开订单页面并产生订单数据,案例中不实际执行
1058
+ console.log('演示调用:placeComponentsOrder(true) 交互式检查,或 placeComponentsOrder(false, true) 静默下单');
1059
+ ```
1060
+
1061
+ ### placesmtcomponentsorder
1062
+
1063
+ # SCH\_ManufactureData.placeSmtComponentsOrder() method
1064
+
1065
+ > 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.
1066
+
1067
+ SMT component ordering
1068
+
1069
+ ## Signature
1070
+
1071
+ ```typescript
1072
+ function placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;
1073
+ ```
1074
+
1075
+ ## Parameters
1076
+
1077
+ <table><thead><tr><th>
1078
+
1079
+ Parameter
1080
+
1081
+ </th><th>
1082
+
1083
+ Type
1084
+
1085
+ </th><th>
1086
+
1087
+ Description
1088
+
1089
+ </th></tr></thead>
1090
+ <tbody><tr><td>
1091
+
1092
+ interactive
1093
+
1094
+ </td><td>
1095
+
1096
+ boolean
1097
+
1098
+ </td><td>
1099
+
1100
+ _(Optional)_ Whether to enable interactive checking. If enabled, a popup will wait for user interaction, and the `ignoreWarning` parameter cannot be used to ignore warnings; that is, the `ignoreWarning` parameter will be ignored. If disabled, no EDA internal popup will appear after the call, and the program performs a silent check. If the ordering conditions are met, `true` will be returned and the ordering page will be opened in a new tab
1101
+
1102
+ </td></tr>
1103
+ <tr><td>
1104
+
1105
+ ignoreWarning
1106
+
1107
+ </td><td>
1108
+
1109
+ boolean
1110
+
1111
+ </td><td>
1112
+
1113
+ _(Optional)_ Ignore warnings during non-interactive checking. If set to `true`<!-- -->, all check warning items will be ignored and the ordering data will be generated as much as possible; if set to `false`<!-- -->, any warning will interrupt execution and return `false`
1114
+
1115
+ </td></tr>
1116
+ </tbody></table>
1117
+
1118
+ ## Returns
1119
+
1120
+ Promise&lt;boolean&gt;
1121
+
1122
+ Whether the ordering check passed
1123
+
1124
+ ## Example
1125
+
1126
+ ```javascript
1127
+ // 1. 交互式下单检查:弹出检查弹窗等待确认,确认后打开下单页面
1128
+ // const passed = await eda.sch_ManufactureData.placeSmtComponentsOrder(true);
1129
+ // 2. 静默检查:不弹任何弹窗,忽略警告并直接生成下单资料
1130
+ // const passed = await eda.sch_ManufactureData.placeSmtComponentsOrder(false, true);
1131
+ // console.log('下单检查结果 ' + passed);
1132
+ // 下单会真实打开订单页面并产生订单数据,案例中不实际执行
1133
+ console.log('演示调用:placeSmtComponentsOrder(true) 交互式检查,或 placeSmtComponentsOrder(false, true) 静默下单');
1134
+ ```
1135
+
1136
+ ### uploadbomtemplatefile
1137
+
1138
+ # SCH\_ManufactureData.uploadBomTemplateFile() method
1139
+
1140
+ > 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.
1141
+
1142
+ Upload a BOM template file
1143
+
1144
+ ## Signature
1145
+
1146
+ ```typescript
1147
+ function uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;
1148
+ ```
1149
+
1150
+ ## Parameters
1151
+
1152
+ <table><thead><tr><th>
1153
+
1154
+ Parameter
1155
+
1156
+ </th><th>
1157
+
1158
+ Type
1159
+
1160
+ </th><th>
1161
+
1162
+ Description
1163
+
1164
+ </th></tr></thead>
1165
+ <tbody><tr><td>
1166
+
1167
+ templateFile
1168
+
1169
+ </td><td>
1170
+
1171
+ File
1172
+
1173
+ </td><td>
1174
+
1175
+ BOM template file
1176
+
1177
+ </td></tr>
1178
+ <tr><td>
1179
+
1180
+ template
1181
+
1182
+ </td><td>
1183
+
1184
+ string
1185
+
1186
+ </td><td>
1187
+
1188
+ _(Optional)_ BOM template name. If it is `undefined`<!-- -->, the value is automatically taken from `templateFile`
1189
+
1190
+ </td></tr>
1191
+ </tbody></table>
1192
+
1193
+ ## Returns
1194
+
1195
+ Promise&lt;string \| undefined&gt;
1196
+
1197
+ BOM template name
1198
+
1199
+ ## Example
1200
+
1201
+ ```javascript
1202
+ // 1. 从本地选择模板文件(弹窗需要用户交互)
1203
+ // const templateFile = await eda.sys_FileSystem.openReadFileDialog('.xlsx');
1204
+ // 2. 上传为新的 BOM 模板(第二参数指定模板名,不传则从文件名取)
1205
+ // const templateName = await eda.sch_ManufactureData.uploadBomTemplateFile(templateFile, '嘉立创示例_模板');
1206
+ // console.log('上传后的模板名 ' + templateName);
1207
+ // 3. 上传后用 getBomTemplates 查看列表确认,不再需要时用 deleteBomTemplate 删除
1208
+ console.log('演示流程:openReadFileDialog 读取 xlsx → uploadBomTemplateFile 上传 → getBomTemplates 确认');
1209
+ ```