@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,875 +1,803 @@
1
- # PCB\_PrimitiveImage class
2
-
3
- PCB & footprint / image primitive class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class PCB_PrimitiveImage implements IPCB_PrimitiveAPI
9
- ```
10
- **Implements:** [IPCB\_PrimitiveAPI](../interfaces/IPCB_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(x, y, complexPolygon, layer, width, height, rotation, horizonMirror, primitiveLock)](./PCB_PrimitiveImage.md)
30
-
31
- </td><td>
32
-
33
- </td><td>
34
-
35
- Create Image
36
-
37
- </td></tr>
38
- <tr><td>
39
-
40
- [delete(primitiveIds)](./PCB_PrimitiveImage.md)
41
-
42
- </td><td>
43
-
44
- </td><td>
45
-
46
- **_(BETA)_** Delete Image
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- [get(primitiveIds)](./PCB_PrimitiveImage.md)
52
-
53
- </td><td>
54
-
55
- </td><td>
56
-
57
- **_(BETA)_** Get Image
58
-
59
- </td></tr>
60
- <tr><td>
61
-
62
- [get(primitiveIds)](./PCB_PrimitiveImage.md)
63
-
64
- </td><td>
65
-
66
- </td><td>
67
-
68
- **_(BETA)_** Get Image
69
-
70
- </td></tr>
71
- <tr><td>
72
-
73
- [getAll(layer, primitiveLock)](./PCB_PrimitiveImage.md)
74
-
75
- </td><td>
76
-
77
- </td><td>
78
-
79
- **_(BETA)_** Get all Image
80
-
81
- </td></tr>
82
- <tr><td>
83
-
84
- [getAllPrimitiveId(layer, primitiveLock)](./PCB_PrimitiveImage.md)
85
-
86
- </td><td>
87
-
88
- </td><td>
89
-
90
- **_(BETA)_** Get all Image primitive IDs
91
-
92
- </td></tr>
93
- <tr><td>
94
-
95
- [modify(primitiveId, property)](./PCB_PrimitiveImage.md)
96
-
97
- </td><td>
98
-
99
- </td><td>
100
-
101
- **_(BETA)_** Modify Image
102
-
103
- </td></tr>
104
- </tbody></table>
105
-
106
- ---
107
-
108
- ## 方法详情
109
-
110
- ### create
111
-
112
- # PCB\_PrimitiveImage.create() method
113
-
114
- Create Image
115
-
116
- ## Signature
117
-
118
- ```typescript
119
- function create(
120
- x: number,
121
- y: number,
122
- complexPolygon:
123
- | TPCB_PolygonSourceArray
124
- | Array<TPCB_PolygonSourceArray>
125
- | IPCB_Polygon
126
- | IPCB_ComplexPolygon,
127
- layer: TPCB_LayersOfImage,
128
- width?: number,
129
- height?: number,
130
- rotation?: number,
131
- horizonMirror?: boolean,
132
- primitiveLock?: boolean,
133
- ): Promise<IPCB_PrimitiveImage | undefined>;
134
- ```
135
-
136
- ## Parameters
137
-
138
- <table><thead><tr><th>
139
-
140
- Parameter
141
-
142
- </th><th>
143
-
144
- Type
145
-
146
- </th><th>
147
-
148
- Description
149
-
150
- </th></tr></thead>
151
- <tbody><tr><td>
152
-
153
- x
154
-
155
- </td><td>
156
-
157
- number
158
-
159
- </td><td>
160
-
161
- BBox top-left point coordinates X
162
-
163
- </td></tr>
164
- <tr><td>
165
-
166
- y
167
-
168
- </td><td>
169
-
170
- number
171
-
172
- </td><td>
173
-
174
- BBox top-left point coordinates Y
175
-
176
- </td></tr>
177
- <tr><td>
178
-
179
- complexPolygon
180
-
181
- </td><td>
182
-
183
- [TPCB\_PolygonSourceArray](../types/TPCB_PolygonSourceArray.md) \| Array&lt;[TPCB\_PolygonSourceArray](../types/TPCB_PolygonSourceArray.md)<!-- -->&gt; \| [IPCB\_Polygon](./IPCB_Polygon.md) \| [IPCB\_ComplexPolygon](./IPCB_ComplexPolygon.md)
184
-
185
- </td><td>
186
-
187
- Image source data (complex polygon). You can use the [PCB\_MathPolygon.convertImageToComplexPolygon()](./PCB_MathPolygon.md) method to convert an image file into complex polygon data
188
-
189
- </td></tr>
190
- <tr><td>
191
-
192
- layer
193
-
194
- </td><td>
195
-
196
- [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
197
-
198
- </td><td>
199
-
200
- Layer
201
-
202
- </td></tr>
203
- <tr><td>
204
-
205
- width
206
-
207
- </td><td>
208
-
209
- number
210
-
211
- </td><td>
212
-
213
- _(Optional)_ Width
214
-
215
- </td></tr>
216
- <tr><td>
217
-
218
- height
219
-
220
- </td><td>
221
-
222
- number
223
-
224
- </td><td>
225
-
226
- _(Optional)_ Height
227
-
228
- </td></tr>
229
- <tr><td>
230
-
231
- rotation
232
-
233
- </td><td>
234
-
235
- number
236
-
237
- </td><td>
238
-
239
- _(Optional)_ Rotation angle
240
-
241
- </td></tr>
242
- <tr><td>
243
-
244
- horizonMirror
245
-
246
- </td><td>
247
-
248
- boolean
249
-
250
- </td><td>
251
-
252
- _(Optional)_ Whether it is horizontally mirrored
253
-
254
- </td></tr>
255
- <tr><td>
256
-
257
- primitiveLock
258
-
259
- </td><td>
260
-
261
- boolean
262
-
263
- </td><td>
264
-
265
- _(Optional)_ Whether it is locked
266
-
267
- </td></tr>
268
- </tbody></table>
269
-
270
- ## Returns
271
-
272
- Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
273
-
274
- Image primitive object
275
-
276
- ## Remarks
277
-
278
- To create a color silkscreen image, use the [binary embedded object primitive class](./PCB_PrimitiveObject.md)
279
-
280
- ## Example
281
-
282
- ```javascript
283
- // 1. 生成随机基准坐标,避免与画布上已有的图像重合
284
- const x = 2000 + Math.floor(Math.random() * 100000);
285
- const y = 2000 + Math.floor(Math.random() * 100000);
286
-
287
- // 2. 构造折线多边形轮廓(局部坐标 200×150 的五边形),图像轮廓必须是 ComplexPolygon 对象
288
- const complexPolygon = eda.pcb_MathPolygon.createComplexPolygon([
289
- 0,
290
- 0,
291
- 'L',
292
- 200,
293
- 0,
294
- 200,
295
- 150,
296
- 100,
297
- 220,
298
- 0,
299
- 150
300
- ]);
301
-
302
- // 3. 在顶层铜层(1)创建图像,宽 400、高 300,不旋转、不镜像、不锁定
303
- const image = await eda.pcb_PrimitiveImage.create(x, y, complexPolygon, 1, 400, 300, 0, false, false);
304
-
305
- // 4. 创建类保留现场,不删除图元
306
- console.log('primitiveId:', image.getState_PrimitiveId());
307
- console.log('layer:', image.getState_Layer());
308
- console.log('width:', image.getState_Width());
309
- console.log('height:', image.getState_Height());
310
- console.log('primitiveType:', image.getState_PrimitiveType());
311
- ```
312
-
313
- ### delete
314
-
315
- # PCB\_PrimitiveImage.delete() method
316
-
317
- > 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.
318
-
319
- Delete Image
320
-
321
- ## Signature
322
-
323
- ```typescript
324
- function delete(primitiveIds: string | IPCB_PrimitiveImage | Array<string> | Array<IPCB_PrimitiveImage>): Promise<boolean>;
325
- ```
326
-
327
- ## Parameters
328
-
329
- <table><thead><tr><th>
330
-
331
- Parameter
332
-
333
- </th><th>
334
-
335
- Type
336
-
337
- </th><th>
338
-
339
- Description
340
-
341
- </th></tr></thead>
342
- <tbody><tr><td>
343
-
344
- primitiveIds
345
-
346
- </td><td>
347
-
348
- string \| [IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| Array&lt;string&gt; \| Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;
349
-
350
- </td><td>
351
-
352
- Image primitive ID or Image primitive object
353
-
354
- </td></tr>
355
- </tbody></table>
356
-
357
- ## Returns
358
-
359
- Promise&lt;boolean&gt;
360
-
361
- Delete Whether the operation is successful
362
-
363
- ## Example
364
-
365
- ```javascript
366
- // 1. 创建两个待删除的测试图像(随机坐标避免与画布已有图像重合)
367
- const x = 2000 + Math.floor(Math.random() * 100000);
368
- const y = 2000 + Math.floor(Math.random() * 100000);
369
- const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
370
- const image1 = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
371
- const image2 = await eda.pcb_PrimitiveImage.create(x, y + 1000, cp, 1, 400, 300, 0, false, false);
372
-
373
- // 2. 记录删除前的图像数量
374
- const beforeCount = (await eda.pcb_PrimitiveImage.getAll()).length;
375
-
376
- // 3. 以 ID 数组形式批量删除两个图像
377
- const deleted = await eda.pcb_PrimitiveImage.delete([
378
- image1.getState_PrimitiveId(),
379
- image2.getState_PrimitiveId()
380
- ]);
381
-
382
- // 4. 删除类保留现场(图元已删除,不恢复)
383
- const afterCount = (await eda.pcb_PrimitiveImage.getAll()).length;
384
-
385
- console.log('deleted:', deleted);
386
- console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
387
- ```
388
-
389
- ### get
390
-
391
- # PCB\_PrimitiveImage.get() method
392
-
393
- > 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.
394
-
395
- Get Image
396
-
397
- ## Signature
398
-
399
- ```typescript
400
- function get(primitiveIds: string): Promise<IPCB_PrimitiveImage | undefined>;
401
- ```
402
-
403
- ## Parameters
404
-
405
- <table><thead><tr><th>
406
-
407
- Parameter
408
-
409
- </th><th>
410
-
411
- Type
412
-
413
- </th><th>
414
-
415
- Description
416
-
417
- </th></tr></thead>
418
- <tbody><tr><td>
419
-
420
- primitiveIds
421
-
422
- </td><td>
423
-
424
- string
425
-
426
- </td><td>
427
-
428
- Image primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
429
-
430
- </td></tr>
431
- </tbody></table>
432
-
433
- ## Returns
434
-
435
- Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
436
-
437
- Image primitive object, `undefined` indicates that the retrieval failed
438
-
439
- ## Example
440
-
441
- ```javascript
442
- // 1. 创建两个测试图像(随机坐标避免重合,轮廓用折线多边形)
443
- const x = 2000 + Math.floor(Math.random() * 100000);
444
- const y = 2000 + Math.floor(Math.random() * 100000);
445
- const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
446
- const image1 = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
447
- const image2 = await eda.pcb_PrimitiveImage.create(x, y + 1000, cp, 1, 400, 300, 0, false, false);
448
-
449
- // 2. 传单个 ID 字符串,返回单个图像对象
450
- const single = await eda.pcb_PrimitiveImage.get(image1.getState_PrimitiveId());
451
-
452
- // 3. 传 ID 数组,返回图像对象数组
453
- const arr = await eda.pcb_PrimitiveImage.get([
454
- image1.getState_PrimitiveId(),
455
- image2.getState_PrimitiveId()
456
- ]);
457
-
458
- // 4. 清理测试图元(查询类需要清理)
459
- await eda.pcb_PrimitiveImage.delete([
460
- image1.getState_PrimitiveId(),
461
- image2.getState_PrimitiveId()
462
- ]);
463
-
464
- console.log('single layer:', single.getState_Layer());
465
- console.log('single width:', single.getState_Width());
466
- console.log('array length:', arr.length);
467
- console.log('image2 rotation:', arr[1].getState_Rotation());
468
- ```
469
-
470
- ### get_1
471
-
472
- # PCB\_PrimitiveImage.get() method
473
-
474
- > 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.
475
-
476
- Get Image
477
-
478
- ## Signature
479
-
480
- ```typescript
481
- function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveImage>>;
482
- ```
483
-
484
- ## Parameters
485
-
486
- <table><thead><tr><th>
487
-
488
- Parameter
489
-
490
- </th><th>
491
-
492
- Type
493
-
494
- </th><th>
495
-
496
- Description
497
-
498
- </th></tr></thead>
499
- <tbody><tr><td>
500
-
501
- primitiveIds
502
-
503
- </td><td>
504
-
505
- Array&lt;string&gt;
506
-
507
- </td><td>
508
-
509
- Image primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
510
-
511
- </td></tr>
512
- </tbody></table>
513
-
514
- ## Returns
515
-
516
- Promise&lt;Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;&gt;
517
-
518
- Image primitive object; an empty array indicates that the retrieval failed
519
-
520
- ## Remarks
521
-
522
- 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.
523
-
524
- ### getall
525
-
526
- # PCB\_PrimitiveImage.getAll() method
527
-
528
- > 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.
529
-
530
- Get all Image
531
-
532
- ## Signature
533
-
534
- ```typescript
535
- function getAll(
536
- layer?: TPCB_LayersOfImage,
537
- primitiveLock?: boolean,
538
- ): Promise<Array<IPCB_PrimitiveImage>>;
539
- ```
540
-
541
- ## Parameters
542
-
543
- <table><thead><tr><th>
544
-
545
- Parameter
546
-
547
- </th><th>
548
-
549
- Type
550
-
551
- </th><th>
552
-
553
- Description
554
-
555
- </th></tr></thead>
556
- <tbody><tr><td>
557
-
558
- layer
559
-
560
- </td><td>
561
-
562
- [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
563
-
564
- </td><td>
565
-
566
- _(Optional)_ Layer
567
-
568
- </td></tr>
569
- <tr><td>
570
-
571
- primitiveLock
572
-
573
- </td><td>
574
-
575
- boolean
576
-
577
- </td><td>
578
-
579
- _(Optional)_ Whether it is locked
580
-
581
- </td></tr>
582
- </tbody></table>
583
-
584
- ## Returns
585
-
586
- Promise&lt;Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;&gt;
587
-
588
- Array of Image primitive objects
589
-
590
- ## Example
591
-
592
- ```javascript
593
- // 1. 创建一个顶层铜层(1)测试图像作为过滤目标(随机坐标避免重合)
594
- const x = 2000 + Math.floor(Math.random() * 100000);
595
- const y = 2000 + Math.floor(Math.random() * 100000);
596
- const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
597
- const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
598
- const imageId = image.getState_PrimitiveId();
599
-
600
- // 2. 不带参数:获取 PCB 上全部图像
601
- const all = await eda.pcb_PrimitiveImage.getAll();
602
-
603
- // 3. 按层过滤:只取顶层铜层(1)的图像
604
- const topCopper = await eda.pcb_PrimitiveImage.getAll(1);
605
-
606
- // 4. 清理测试图元(查询类需要清理)
607
- await eda.pcb_PrimitiveImage.delete([imageId]);
608
-
609
- console.log('total images:', all.length);
610
- console.log('top copper images:', topCopper.length);
611
- console.log('marker image found:', topCopper.some(i => i.getState_PrimitiveId() === imageId));
612
- ```
613
-
614
- ### getallprimitiveid
615
-
616
- # PCB\_PrimitiveImage.getAllPrimitiveId() method
617
-
618
- > 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.
619
-
620
- Get all Image primitive IDs
621
-
622
- ## Signature
623
-
624
- ```typescript
625
- function getAllPrimitiveId(
626
- layer?: TPCB_LayersOfImage,
627
- primitiveLock?: boolean,
628
- ): Promise<Array<string>>;
629
- ```
630
-
631
- ## Parameters
632
-
633
- <table><thead><tr><th>
634
-
635
- Parameter
636
-
637
- </th><th>
638
-
639
- Type
640
-
641
- </th><th>
642
-
643
- Description
644
-
645
- </th></tr></thead>
646
- <tbody><tr><td>
647
-
648
- layer
649
-
650
- </td><td>
651
-
652
- [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
653
-
654
- </td><td>
655
-
656
- _(Optional)_ Layer
657
-
658
- </td></tr>
659
- <tr><td>
660
-
661
- primitiveLock
662
-
663
- </td><td>
664
-
665
- boolean
666
-
667
- </td><td>
668
-
669
- _(Optional)_ Whether it is locked
670
-
671
- </td></tr>
672
- </tbody></table>
673
-
674
- ## Returns
675
-
676
- Promise&lt;Array&lt;string&gt;&gt;
677
-
678
- Array of Image primitive IDs
679
-
680
- ## Example
681
-
682
- ```javascript
683
- // 1. 创建一个顶层铜层(1)测试图像作为查找目标(随机坐标避免重合)
684
- const x = 2000 + Math.floor(Math.random() * 100000);
685
- const y = 2000 + Math.floor(Math.random() * 100000);
686
- const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
687
- const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
688
- const imageId = image.getState_PrimitiveId();
689
-
690
- // 2. 获取全部图像的图元 ID
691
- const allIds = await eda.pcb_PrimitiveImage.getAllPrimitiveId();
692
-
693
- // 3. 按层过滤:只取顶层铜层(1)图像的图元 ID
694
- const topCopperIds = await eda.pcb_PrimitiveImage.getAllPrimitiveId(1);
695
-
696
- // 4. 清理测试图元(查询类需要清理)
697
- await eda.pcb_PrimitiveImage.delete([imageId]);
698
-
699
- console.log('total image ids:', allIds.length);
700
- console.log('top copper image ids:', topCopperIds.length);
701
- console.log('marker id in top copper list:', topCopperIds.includes(imageId));
702
- ```
703
-
704
- ### modify
705
-
706
- # PCB\_PrimitiveImage.modify() method
707
-
708
- > 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.
709
-
710
- Modify Image
711
-
712
- ## Signature
713
-
714
- ```typescript
715
- function modify(
716
- primitiveId: string | IPCB_PrimitiveImage,
717
- property: {
718
- x?: undefined | number;
719
- y?: undefined | number;
720
- layer?:
721
- | undefined
722
- | EPCB_LayerId.TOP
723
- | EPCB_LayerId.TOP_SILKSCREEN
724
- | EPCB_LayerId.TOP_SOLDER_MASK
725
- | EPCB_LayerId.TOP_ASSEMBLY
726
- | EPCB_LayerId.BOTTOM
727
- | EPCB_LayerId.BOTTOM_SILKSCREEN
728
- | EPCB_LayerId.BOTTOM_SOLDER_MASK
729
- | EPCB_LayerId.BOTTOM_ASSEMBLY
730
- | EPCB_LayerId.DOCUMENT
731
- | EPCB_LayerId.MECHANICAL
732
- | EPCB_LayerId.INNER_1
733
- | EPCB_LayerId.INNER_2
734
- | EPCB_LayerId.INNER_3
735
- | EPCB_LayerId.INNER_4
736
- | EPCB_LayerId.INNER_5
737
- | EPCB_LayerId.INNER_6
738
- | EPCB_LayerId.INNER_7
739
- | EPCB_LayerId.INNER_8
740
- | EPCB_LayerId.INNER_9
741
- | EPCB_LayerId.INNER_10
742
- | EPCB_LayerId.INNER_11
743
- | EPCB_LayerId.INNER_12
744
- | EPCB_LayerId.INNER_13
745
- | EPCB_LayerId.INNER_14
746
- | EPCB_LayerId.INNER_15
747
- | EPCB_LayerId.INNER_16
748
- | EPCB_LayerId.INNER_17
749
- | EPCB_LayerId.INNER_18
750
- | EPCB_LayerId.INNER_19
751
- | EPCB_LayerId.INNER_20
752
- | EPCB_LayerId.INNER_21
753
- | EPCB_LayerId.INNER_22
754
- | EPCB_LayerId.INNER_23
755
- | EPCB_LayerId.INNER_24
756
- | EPCB_LayerId.INNER_25
757
- | EPCB_LayerId.INNER_26
758
- | EPCB_LayerId.INNER_27
759
- | EPCB_LayerId.INNER_28
760
- | EPCB_LayerId.INNER_29
761
- | EPCB_LayerId.INNER_30
762
- | EPCB_LayerId.CUSTOM_1
763
- | EPCB_LayerId.CUSTOM_2
764
- | EPCB_LayerId.CUSTOM_3
765
- | EPCB_LayerId.CUSTOM_4
766
- | EPCB_LayerId.CUSTOM_5
767
- | EPCB_LayerId.CUSTOM_6
768
- | EPCB_LayerId.CUSTOM_7
769
- | EPCB_LayerId.CUSTOM_8
770
- | EPCB_LayerId.CUSTOM_9
771
- | EPCB_LayerId.CUSTOM_10
772
- | EPCB_LayerId.CUSTOM_11
773
- | EPCB_LayerId.CUSTOM_12
774
- | EPCB_LayerId.CUSTOM_13
775
- | EPCB_LayerId.CUSTOM_14
776
- | EPCB_LayerId.CUSTOM_15
777
- | EPCB_LayerId.CUSTOM_16
778
- | EPCB_LayerId.CUSTOM_17
779
- | EPCB_LayerId.CUSTOM_18
780
- | EPCB_LayerId.CUSTOM_19
781
- | EPCB_LayerId.CUSTOM_20
782
- | EPCB_LayerId.CUSTOM_21
783
- | EPCB_LayerId.CUSTOM_22
784
- | EPCB_LayerId.CUSTOM_23
785
- | EPCB_LayerId.CUSTOM_24
786
- | EPCB_LayerId.CUSTOM_25
787
- | EPCB_LayerId.CUSTOM_26
788
- | EPCB_LayerId.CUSTOM_27
789
- | EPCB_LayerId.CUSTOM_28
790
- | EPCB_LayerId.CUSTOM_29
791
- | EPCB_LayerId.CUSTOM_30
792
- | EPCB_LayerId.DRILL_DRAWING;
793
- width?: undefined | number;
794
- height?: undefined | number;
795
- rotation?: undefined | number;
796
- horizonMirror?: undefined | false | true;
797
- primitiveLock?: undefined | false | true;
798
- },
799
- ): Promise<IPCB_PrimitiveImage | undefined>;
800
- ```
801
-
802
- ## Parameters
803
-
804
- <table><thead><tr><th>
805
-
806
- Parameter
807
-
808
- </th><th>
809
-
810
- Type
811
-
812
- </th><th>
813
-
814
- Description
815
-
816
- </th></tr></thead>
817
- <tbody><tr><td>
818
-
819
- primitiveId
820
-
821
- </td><td>
822
-
823
- string \| [IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)
824
-
825
- </td><td>
826
-
827
- Primitive ID
828
-
829
- </td></tr>
830
- <tr><td>
831
-
832
- property
833
-
834
- </td><td>
835
-
836
- { x?: undefined \| number; y?: undefined \| number; layer?: undefined \| [EPCB\_LayerId.TOP](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.TOP\_SILKSCREEN](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.TOP\_SOLDER\_MASK](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.TOP\_ASSEMBLY](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM\_SILKSCREEN](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM\_SOLDER\_MASK](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM\_ASSEMBLY](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.DOCUMENT](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.MECHANICAL](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_1](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_2](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_3](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_4](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_5](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_6](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_7](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_8](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_9](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_10](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_11](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_12](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_13](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_14](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_15](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_16](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_17](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_18](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_19](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_20](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_21](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_22](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_23](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_24](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_25](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_26](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_27](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_28](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_29](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.INNER\_30](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_1](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_2](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_3](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_4](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_5](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_6](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_7](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_8](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_9](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_10](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_11](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_12](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_13](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_14](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_15](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_16](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_17](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_18](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_19](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_20](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_21](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_22](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_23](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_24](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_25](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_26](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_27](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_28](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_29](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.CUSTOM\_30](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.DRILL\_DRAWING](../enums/EPCB_LayerId.md)<!-- -->; width?: undefined \| number; height?: undefined \| number; rotation?: undefined \| number; horizonMirror?: undefined \| false \| true; primitiveLock?: undefined \| false \| true }
837
-
838
- </td><td>
839
-
840
- Modify Parameter
841
-
842
- </td></tr>
843
- </tbody></table>
844
-
845
- ## Returns
846
-
847
- Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
848
-
849
- Image primitive object
850
-
851
- ## Example
852
-
853
- ```javascript
854
- // 1. 创建待修改的测试图像(随机坐标避免与画布已有图像重合)
855
- const x = 2000 + Math.floor(Math.random() * 100000);
856
- const y = 2000 + Math.floor(Math.random() * 100000);
857
- const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
858
- const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
859
- const imageId = image.getState_PrimitiveId();
860
-
861
- // 2. 读取修改前的层与旋转角度
862
- const beforeLayer = image.getState_Layer();
863
- const beforeRotation = image.getState_Rotation();
864
-
865
- // 3. 批量修改:顶层铜层(1)→ 顶层丝印(3),旋转 0° → 90°
866
- await eda.pcb_PrimitiveImage.modify(imageId, { layer: 3, rotation: 90 });
867
-
868
- // 4. modify 返回后需要重新 get() 才能读到画布上的最新值
869
- const refreshed = await eda.pcb_PrimitiveImage.get(imageId);
870
-
871
- // 5. 修改类保留现场,供观察修改结果
872
- console.log('primitiveId:', imageId);
873
- console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
874
- console.log('rotation:', beforeRotation, '→', refreshed.getState_Rotation());
875
- ```
1
+ # PCB\_PrimitiveImage class
2
+
3
+ PCB &amp; footprint / image primitive class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class PCB_PrimitiveImage implements IPCB_PrimitiveAPI
9
+ ```
10
+ **Implements:** [IPCB\_PrimitiveAPI](../interfaces/IPCB_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(x, y, complexPolygon, layer, width, height, rotation, horizonMirror, primitiveLock)](./PCB_PrimitiveImage.md)
30
+
31
+ </td><td>
32
+
33
+ </td><td>
34
+
35
+ Create Image
36
+
37
+ </td></tr>
38
+ <tr><td>
39
+
40
+ [delete(primitiveIds)](./PCB_PrimitiveImage.md)
41
+
42
+ </td><td>
43
+
44
+ </td><td>
45
+
46
+ **_(BETA)_** Delete Image
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ [get(primitiveIds)](./PCB_PrimitiveImage.md)
52
+
53
+ </td><td>
54
+
55
+ </td><td>
56
+
57
+ **_(BETA)_** Get Image
58
+
59
+ </td></tr>
60
+ <tr><td>
61
+
62
+ [get(primitiveIds)](./PCB_PrimitiveImage.md)
63
+
64
+ </td><td>
65
+
66
+ </td><td>
67
+
68
+ **_(BETA)_** Get Image
69
+
70
+ </td></tr>
71
+ <tr><td>
72
+
73
+ [getAll(layer, primitiveLock)](./PCB_PrimitiveImage.md)
74
+
75
+ </td><td>
76
+
77
+ </td><td>
78
+
79
+ **_(BETA)_** Get all Image
80
+
81
+ </td></tr>
82
+ <tr><td>
83
+
84
+ [getAllPrimitiveId(layer, primitiveLock)](./PCB_PrimitiveImage.md)
85
+
86
+ </td><td>
87
+
88
+ </td><td>
89
+
90
+ **_(BETA)_** Get all Image primitive IDs
91
+
92
+ </td></tr>
93
+ <tr><td>
94
+
95
+ [modify(primitiveId, property)](./PCB_PrimitiveImage.md)
96
+
97
+ </td><td>
98
+
99
+ </td><td>
100
+
101
+ **_(BETA)_** Modify Image
102
+
103
+ </td></tr>
104
+ </tbody></table>
105
+
106
+ ---
107
+
108
+ ## 方法详情
109
+
110
+ ### create
111
+
112
+ # PCB\_PrimitiveImage.create() method
113
+
114
+ Create Image
115
+
116
+ ## Signature
117
+
118
+ ```typescript
119
+ function create(
120
+ x: number,
121
+ y: number,
122
+ complexPolygon:
123
+ | TPCB_PolygonSourceArray
124
+ | Array<TPCB_PolygonSourceArray>
125
+ | IPCB_Polygon
126
+ | IPCB_ComplexPolygon,
127
+ layer: TPCB_LayersOfImage,
128
+ width?: number,
129
+ height?: number,
130
+ rotation?: number,
131
+ horizonMirror?: boolean,
132
+ primitiveLock?: boolean,
133
+ ): Promise<IPCB_PrimitiveImage | undefined>;
134
+ ```
135
+
136
+ ## Parameters
137
+
138
+ <table><thead><tr><th>
139
+
140
+ Parameter
141
+
142
+ </th><th>
143
+
144
+ Type
145
+
146
+ </th><th>
147
+
148
+ Description
149
+
150
+ </th></tr></thead>
151
+ <tbody><tr><td>
152
+
153
+ x
154
+
155
+ </td><td>
156
+
157
+ number
158
+
159
+ </td><td>
160
+
161
+ BBox top-left point coordinates X
162
+
163
+ </td></tr>
164
+ <tr><td>
165
+
166
+ y
167
+
168
+ </td><td>
169
+
170
+ number
171
+
172
+ </td><td>
173
+
174
+ BBox top-left point coordinates Y
175
+
176
+ </td></tr>
177
+ <tr><td>
178
+
179
+ complexPolygon
180
+
181
+ </td><td>
182
+
183
+ [TPCB\_PolygonSourceArray](../types/TPCB_PolygonSourceArray.md) \| Array&lt;[TPCB\_PolygonSourceArray](../types/TPCB_PolygonSourceArray.md)<!-- -->&gt; \| [IPCB\_Polygon](./IPCB_Polygon.md) \| [IPCB\_ComplexPolygon](./IPCB_ComplexPolygon.md)
184
+
185
+ </td><td>
186
+
187
+ Image source data (complex polygon). You can use the [PCB\_MathPolygon.convertImageToComplexPolygon()](./PCB_MathPolygon.md) method to convert an image file into complex polygon data
188
+
189
+ </td></tr>
190
+ <tr><td>
191
+
192
+ layer
193
+
194
+ </td><td>
195
+
196
+ [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
197
+
198
+ </td><td>
199
+
200
+ Layer
201
+
202
+ </td></tr>
203
+ <tr><td>
204
+
205
+ width
206
+
207
+ </td><td>
208
+
209
+ number
210
+
211
+ </td><td>
212
+
213
+ _(Optional)_ Width
214
+
215
+ </td></tr>
216
+ <tr><td>
217
+
218
+ height
219
+
220
+ </td><td>
221
+
222
+ number
223
+
224
+ </td><td>
225
+
226
+ _(Optional)_ Height
227
+
228
+ </td></tr>
229
+ <tr><td>
230
+
231
+ rotation
232
+
233
+ </td><td>
234
+
235
+ number
236
+
237
+ </td><td>
238
+
239
+ _(Optional)_ Rotation angle
240
+
241
+ </td></tr>
242
+ <tr><td>
243
+
244
+ horizonMirror
245
+
246
+ </td><td>
247
+
248
+ boolean
249
+
250
+ </td><td>
251
+
252
+ _(Optional)_ Whether it is horizontally mirrored
253
+
254
+ </td></tr>
255
+ <tr><td>
256
+
257
+ primitiveLock
258
+
259
+ </td><td>
260
+
261
+ boolean
262
+
263
+ </td><td>
264
+
265
+ _(Optional)_ Whether it is locked
266
+
267
+ </td></tr>
268
+ </tbody></table>
269
+
270
+ ## Returns
271
+
272
+ Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
273
+
274
+ Image primitive object
275
+
276
+ ## Remarks
277
+
278
+ To create a color silkscreen image, use the [binary embedded object primitive class](./PCB_PrimitiveObject.md)
279
+
280
+ ## Example
281
+
282
+ ```javascript
283
+ // 1. 生成随机基准坐标,避免与画布上已有的图像重合
284
+ const x = 2000 + Math.floor(Math.random() * 100000);
285
+ const y = 2000 + Math.floor(Math.random() * 100000);
286
+
287
+ // 2. 构造折线多边形轮廓(局部坐标 200×150 的五边形),图像轮廓必须是 ComplexPolygon 对象
288
+ const complexPolygon = eda.pcb_MathPolygon.createComplexPolygon([
289
+ 0,
290
+ 0,
291
+ 'L',
292
+ 200,
293
+ 0,
294
+ 200,
295
+ 150,
296
+ 100,
297
+ 220,
298
+ 0,
299
+ 150
300
+ ]);
301
+
302
+ // 3. 在顶层铜层(1)创建图像,宽 400、高 300,不旋转、不镜像、不锁定
303
+ const image = await eda.pcb_PrimitiveImage.create(x, y, complexPolygon, 1, 400, 300, 0, false, false);
304
+
305
+ // 4. 创建类保留现场,不删除图元
306
+ console.log('primitiveId:', image.getState_PrimitiveId());
307
+ console.log('layer:', image.getState_Layer());
308
+ console.log('width:', image.getState_Width());
309
+ console.log('height:', image.getState_Height());
310
+ console.log('primitiveType:', image.getState_PrimitiveType());
311
+ ```
312
+
313
+ ### delete
314
+
315
+ # PCB\_PrimitiveImage.delete() method
316
+
317
+ > 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.
318
+
319
+ Delete Image
320
+
321
+ ## Signature
322
+
323
+ ```typescript
324
+ function delete(primitiveIds: string | IPCB_PrimitiveImage | Array<string> | Array<IPCB_PrimitiveImage>): Promise<boolean>;
325
+ ```
326
+
327
+ ## Parameters
328
+
329
+ <table><thead><tr><th>
330
+
331
+ Parameter
332
+
333
+ </th><th>
334
+
335
+ Type
336
+
337
+ </th><th>
338
+
339
+ Description
340
+
341
+ </th></tr></thead>
342
+ <tbody><tr><td>
343
+
344
+ primitiveIds
345
+
346
+ </td><td>
347
+
348
+ string \| [IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| Array&lt;string&gt; \| Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;
349
+
350
+ </td><td>
351
+
352
+ Image primitive ID or Image primitive object
353
+
354
+ </td></tr>
355
+ </tbody></table>
356
+
357
+ ## Returns
358
+
359
+ Promise&lt;boolean&gt;
360
+
361
+ Delete Whether the operation is successful
362
+
363
+ ## Example
364
+
365
+ ```javascript
366
+ // 1. 创建两个待删除的测试图像(随机坐标避免与画布已有图像重合)
367
+ const x = 2000 + Math.floor(Math.random() * 100000);
368
+ const y = 2000 + Math.floor(Math.random() * 100000);
369
+ const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
370
+ const image1 = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
371
+ const image2 = await eda.pcb_PrimitiveImage.create(x, y + 1000, cp, 1, 400, 300, 0, false, false);
372
+
373
+ // 2. 记录删除前的图像数量
374
+ const beforeCount = (await eda.pcb_PrimitiveImage.getAll()).length;
375
+
376
+ // 3. 以 ID 数组形式批量删除两个图像
377
+ const deleted = await eda.pcb_PrimitiveImage.delete([
378
+ image1.getState_PrimitiveId(),
379
+ image2.getState_PrimitiveId()
380
+ ]);
381
+
382
+ // 4. 删除类保留现场(图元已删除,不恢复)
383
+ const afterCount = (await eda.pcb_PrimitiveImage.getAll()).length;
384
+
385
+ console.log('deleted:', deleted);
386
+ console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
387
+ ```
388
+
389
+ ### get
390
+
391
+ # PCB\_PrimitiveImage.get() method
392
+
393
+ > 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.
394
+
395
+ Get Image
396
+
397
+ ## Signature
398
+
399
+ ```typescript
400
+ function get(primitiveIds: string): Promise<IPCB_PrimitiveImage | undefined>;
401
+ ```
402
+
403
+ ## Parameters
404
+
405
+ <table><thead><tr><th>
406
+
407
+ Parameter
408
+
409
+ </th><th>
410
+
411
+ Type
412
+
413
+ </th><th>
414
+
415
+ Description
416
+
417
+ </th></tr></thead>
418
+ <tbody><tr><td>
419
+
420
+ primitiveIds
421
+
422
+ </td><td>
423
+
424
+ string
425
+
426
+ </td><td>
427
+
428
+ Image primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
429
+
430
+ </td></tr>
431
+ </tbody></table>
432
+
433
+ ## Returns
434
+
435
+ Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
436
+
437
+ Image primitive object, `undefined` indicates that the retrieval failed
438
+
439
+ ## Example
440
+
441
+ ```javascript
442
+ // 1. 创建两个测试图像(随机坐标避免重合,轮廓用折线多边形)
443
+ const x = 2000 + Math.floor(Math.random() * 100000);
444
+ const y = 2000 + Math.floor(Math.random() * 100000);
445
+ const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
446
+ const image1 = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
447
+ const image2 = await eda.pcb_PrimitiveImage.create(x, y + 1000, cp, 1, 400, 300, 0, false, false);
448
+
449
+ // 2. 传单个 ID 字符串,返回单个图像对象
450
+ const single = await eda.pcb_PrimitiveImage.get(image1.getState_PrimitiveId());
451
+
452
+ // 3. 传 ID 数组,返回图像对象数组
453
+ const arr = await eda.pcb_PrimitiveImage.get([
454
+ image1.getState_PrimitiveId(),
455
+ image2.getState_PrimitiveId()
456
+ ]);
457
+
458
+ // 4. 清理测试图元(查询类需要清理)
459
+ await eda.pcb_PrimitiveImage.delete([
460
+ image1.getState_PrimitiveId(),
461
+ image2.getState_PrimitiveId()
462
+ ]);
463
+
464
+ console.log('single layer:', single.getState_Layer());
465
+ console.log('single width:', single.getState_Width());
466
+ console.log('array length:', arr.length);
467
+ console.log('image2 rotation:', arr[1].getState_Rotation());
468
+ ```
469
+
470
+ ### get_1
471
+
472
+ # PCB\_PrimitiveImage.get() method
473
+
474
+ > 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.
475
+
476
+ Get Image
477
+
478
+ ## Signature
479
+
480
+ ```typescript
481
+ function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveImage>>;
482
+ ```
483
+
484
+ ## Parameters
485
+
486
+ <table><thead><tr><th>
487
+
488
+ Parameter
489
+
490
+ </th><th>
491
+
492
+ Type
493
+
494
+ </th><th>
495
+
496
+ Description
497
+
498
+ </th></tr></thead>
499
+ <tbody><tr><td>
500
+
501
+ primitiveIds
502
+
503
+ </td><td>
504
+
505
+ Array&lt;string&gt;
506
+
507
+ </td><td>
508
+
509
+ Image primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
510
+
511
+ </td></tr>
512
+ </tbody></table>
513
+
514
+ ## Returns
515
+
516
+ Promise&lt;Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;&gt;
517
+
518
+ Image primitive object; an empty array indicates that the retrieval failed
519
+
520
+ ## Remarks
521
+
522
+ 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.
523
+
524
+ ### getall
525
+
526
+ # PCB\_PrimitiveImage.getAll() method
527
+
528
+ > 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.
529
+
530
+ Get all Image
531
+
532
+ ## Signature
533
+
534
+ ```typescript
535
+ function getAll(
536
+ layer?: TPCB_LayersOfImage,
537
+ primitiveLock?: boolean,
538
+ ): Promise<Array<IPCB_PrimitiveImage>>;
539
+ ```
540
+
541
+ ## Parameters
542
+
543
+ <table><thead><tr><th>
544
+
545
+ Parameter
546
+
547
+ </th><th>
548
+
549
+ Type
550
+
551
+ </th><th>
552
+
553
+ Description
554
+
555
+ </th></tr></thead>
556
+ <tbody><tr><td>
557
+
558
+ layer
559
+
560
+ </td><td>
561
+
562
+ [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
563
+
564
+ </td><td>
565
+
566
+ _(Optional)_ Layer
567
+
568
+ </td></tr>
569
+ <tr><td>
570
+
571
+ primitiveLock
572
+
573
+ </td><td>
574
+
575
+ boolean
576
+
577
+ </td><td>
578
+
579
+ _(Optional)_ Whether it is locked
580
+
581
+ </td></tr>
582
+ </tbody></table>
583
+
584
+ ## Returns
585
+
586
+ Promise&lt;Array&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)<!-- -->&gt;&gt;
587
+
588
+ Array of Image primitive objects
589
+
590
+ ## Example
591
+
592
+ ```javascript
593
+ // 1. 创建一个顶层铜层(1)测试图像作为过滤目标(随机坐标避免重合)
594
+ const x = 2000 + Math.floor(Math.random() * 100000);
595
+ const y = 2000 + Math.floor(Math.random() * 100000);
596
+ const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
597
+ const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
598
+ const imageId = image.getState_PrimitiveId();
599
+
600
+ // 2. 不带参数:获取 PCB 上全部图像
601
+ const all = await eda.pcb_PrimitiveImage.getAll();
602
+
603
+ // 3. 按层过滤:只取顶层铜层(1)的图像
604
+ const topCopper = await eda.pcb_PrimitiveImage.getAll(1);
605
+
606
+ // 4. 清理测试图元(查询类需要清理)
607
+ await eda.pcb_PrimitiveImage.delete([imageId]);
608
+
609
+ console.log('total images:', all.length);
610
+ console.log('top copper images:', topCopper.length);
611
+ console.log('marker image found:', topCopper.some(i => i.getState_PrimitiveId() === imageId));
612
+ ```
613
+
614
+ ### getallprimitiveid
615
+
616
+ # PCB\_PrimitiveImage.getAllPrimitiveId() method
617
+
618
+ > 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.
619
+
620
+ Get all Image primitive IDs
621
+
622
+ ## Signature
623
+
624
+ ```typescript
625
+ function getAllPrimitiveId(
626
+ layer?: TPCB_LayersOfImage,
627
+ primitiveLock?: boolean,
628
+ ): Promise<Array<string>>;
629
+ ```
630
+
631
+ ## Parameters
632
+
633
+ <table><thead><tr><th>
634
+
635
+ Parameter
636
+
637
+ </th><th>
638
+
639
+ Type
640
+
641
+ </th><th>
642
+
643
+ Description
644
+
645
+ </th></tr></thead>
646
+ <tbody><tr><td>
647
+
648
+ layer
649
+
650
+ </td><td>
651
+
652
+ [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)
653
+
654
+ </td><td>
655
+
656
+ _(Optional)_ Layer
657
+
658
+ </td></tr>
659
+ <tr><td>
660
+
661
+ primitiveLock
662
+
663
+ </td><td>
664
+
665
+ boolean
666
+
667
+ </td><td>
668
+
669
+ _(Optional)_ Whether it is locked
670
+
671
+ </td></tr>
672
+ </tbody></table>
673
+
674
+ ## Returns
675
+
676
+ Promise&lt;Array&lt;string&gt;&gt;
677
+
678
+ Array of Image primitive IDs
679
+
680
+ ## Example
681
+
682
+ ```javascript
683
+ // 1. 创建一个顶层铜层(1)测试图像作为查找目标(随机坐标避免重合)
684
+ const x = 2000 + Math.floor(Math.random() * 100000);
685
+ const y = 2000 + Math.floor(Math.random() * 100000);
686
+ const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
687
+ const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
688
+ const imageId = image.getState_PrimitiveId();
689
+
690
+ // 2. 获取全部图像的图元 ID
691
+ const allIds = await eda.pcb_PrimitiveImage.getAllPrimitiveId();
692
+
693
+ // 3. 按层过滤:只取顶层铜层(1)图像的图元 ID
694
+ const topCopperIds = await eda.pcb_PrimitiveImage.getAllPrimitiveId(1);
695
+
696
+ // 4. 清理测试图元(查询类需要清理)
697
+ await eda.pcb_PrimitiveImage.delete([imageId]);
698
+
699
+ console.log('total image ids:', allIds.length);
700
+ console.log('top copper image ids:', topCopperIds.length);
701
+ console.log('marker id in top copper list:', topCopperIds.includes(imageId));
702
+ ```
703
+
704
+ ### modify
705
+
706
+ # PCB\_PrimitiveImage.modify() method
707
+
708
+ > 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.
709
+
710
+ Modify Image
711
+
712
+ ## Signature
713
+
714
+ ```typescript
715
+ function modify(
716
+ primitiveId: string | IPCB_PrimitiveImage,
717
+ property: {
718
+ x?: number;
719
+ y?: number;
720
+ layer?: TPCB_LayersOfImage;
721
+ width?: number;
722
+ height?: number;
723
+ rotation?: number;
724
+ horizonMirror?: boolean;
725
+ primitiveLock?: boolean;
726
+ },
727
+ ): Promise<IPCB_PrimitiveImage | undefined>;
728
+ ```
729
+
730
+ ## Parameters
731
+
732
+ <table><thead><tr><th>
733
+
734
+ Parameter
735
+
736
+ </th><th>
737
+
738
+ Type
739
+
740
+ </th><th>
741
+
742
+ Description
743
+
744
+ </th></tr></thead>
745
+ <tbody><tr><td>
746
+
747
+ primitiveId
748
+
749
+ </td><td>
750
+
751
+ string \| [IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md)
752
+
753
+ </td><td>
754
+
755
+ Primitive ID
756
+
757
+ </td></tr>
758
+ <tr><td>
759
+
760
+ property
761
+
762
+ </td><td>
763
+
764
+ { x?: number; y?: number; layer?: [TPCB\_LayersOfImage](../types/TPCB_LayersOfImage.md)<!-- -->; width?: number; height?: number; rotation?: number; horizonMirror?: boolean; primitiveLock?: boolean }
765
+
766
+ </td><td>
767
+
768
+ Modify Parameter
769
+
770
+ </td></tr>
771
+ </tbody></table>
772
+
773
+ ## Returns
774
+
775
+ Promise&lt;[IPCB\_PrimitiveImage](./IPCB_PrimitiveImage.md) \| undefined&gt;
776
+
777
+ Image primitive object
778
+
779
+ ## Example
780
+
781
+ ```javascript
782
+ // 1. 创建待修改的测试图像(随机坐标避免与画布已有图像重合)
783
+ const x = 2000 + Math.floor(Math.random() * 100000);
784
+ const y = 2000 + Math.floor(Math.random() * 100000);
785
+ const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
786
+ const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
787
+ const imageId = image.getState_PrimitiveId();
788
+
789
+ // 2. 读取修改前的层与旋转角度
790
+ const beforeLayer = image.getState_Layer();
791
+ const beforeRotation = image.getState_Rotation();
792
+
793
+ // 3. 批量修改:顶层铜层(1)→ 顶层丝印(3),旋转 0° → 90°
794
+ await eda.pcb_PrimitiveImage.modify(imageId, { layer: 3, rotation: 90 });
795
+
796
+ // 4. modify 返回后需要重新 get() 才能读到画布上的最新值
797
+ const refreshed = await eda.pcb_PrimitiveImage.get(imageId);
798
+
799
+ // 5. 修改类保留现场,供观察修改结果
800
+ console.log('primitiveId:', imageId);
801
+ console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
802
+ console.log('rotation:', beforeRotation, '→', refreshed.getState_Rotation());
803
+ ```