@windypro-rourou/dsh-eda 0.1.0 → 0.1.1

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 (407) hide show
  1. package/README.md +71 -119
  2. package/cordis.patch.yml +9 -7
  3. package/lib/board.js +80 -0
  4. package/lib/client.js +2 -2
  5. package/lib/index.js +339 -11
  6. package/lib/installer.js +4 -4
  7. package/lib/skill.js +138 -0
  8. package/package.json +12 -2
  9. package/skill/INDEX.md +193 -0
  10. package/skill/README.official.md +125 -0
  11. package/skill/README.zh-Hans.official.md +125 -0
  12. package/skill/SKILL.md +746 -0
  13. package/skill/format/index.md +152 -0
  14. package/skill/format/pcb/3d.md +166 -0
  15. package/skill/format/pcb/attr.md +63 -0
  16. package/skill/format/pcb/common.md +306 -0
  17. package/skill/format/pcb/component.md +132 -0
  18. package/skill/format/pcb/dimension.md +58 -0
  19. package/skill/format/pcb/index.md +17 -0
  20. package/skill/format/pcb/obj.md +43 -0
  21. package/skill/format/pcb/pad_via.md +151 -0
  22. package/skill/format/pcb/panel.md +64 -0
  23. package/skill/format/pcb/partition.md +43 -0
  24. package/skill/format/pcb/primitive.md +196 -0
  25. package/skill/format/pcb/rule.md +71 -0
  26. package/skill/format/pcb/shape.md +441 -0
  27. package/skill/format/pcb/text.md +62 -0
  28. package/skill/format/project/blob.md +30 -0
  29. package/skill/format/project/common.md +42 -0
  30. package/skill/format/project/group.md +62 -0
  31. package/skill/format/project/index.md +12 -0
  32. package/skill/format/project/instance.md +32 -0
  33. package/skill/format/project/meta.md +189 -0
  34. package/skill/format/project/variant.md +30 -0
  35. package/skill/format/schematic/attr.md +41 -0
  36. package/skill/format/schematic/common.md +47 -0
  37. package/skill/format/schematic/component.md +91 -0
  38. package/skill/format/schematic/index.md +14 -0
  39. package/skill/format/schematic/obj.md +41 -0
  40. package/skill/format/schematic/pin.md +59 -0
  41. package/skill/format/schematic/shape.md +231 -0
  42. package/skill/format/schematic/structure.md +53 -0
  43. package/skill/format/schematic/table.md +109 -0
  44. package/skill/format/schematic/text.md +47 -0
  45. package/skill/format/schematic/wire.md +132 -0
  46. package/skill/guide/ancillary-projects/pro-api-sdk.md +1 -0
  47. package/skill/guide/ancillary-projects/pro-api-types.md +5 -0
  48. package/skill/guide/ancillary-projects.md +10 -0
  49. package/skill/guide/error-handling.md +38 -0
  50. package/skill/guide/extension-json.md +135 -0
  51. package/skill/guide/extensions-marketplace.md +61 -0
  52. package/skill/guide/how-to-start.md +301 -0
  53. package/skill/guide/i18n.md +57 -0
  54. package/skill/guide/index.md +7 -0
  55. package/skill/guide/inline-frame.md +20 -0
  56. package/skill/guide/invoke-apis.md +81 -0
  57. package/skill/guide/stability.md +37 -0
  58. package/skill/references/_index.md +398 -0
  59. package/skill/references/_quick-reference.md +3028 -0
  60. package/skill/references/classes/DMT_Board.md +533 -0
  61. package/skill/references/classes/DMT_EditorControl.md +1736 -0
  62. package/skill/references/classes/DMT_Event.md +356 -0
  63. package/skill/references/classes/DMT_Folder.md +775 -0
  64. package/skill/references/classes/DMT_Panel.md +531 -0
  65. package/skill/references/classes/DMT_Pcb.md +575 -0
  66. package/skill/references/classes/DMT_Project.md +573 -0
  67. package/skill/references/classes/DMT_Schematic.md +1477 -0
  68. package/skill/references/classes/DMT_SelectControl.md +96 -0
  69. package/skill/references/classes/DMT_Team.md +172 -0
  70. package/skill/references/classes/DMT_Workspace.md +198 -0
  71. package/skill/references/classes/EDA.md +961 -0
  72. package/skill/references/classes/IPCB_ComplexPolygon.md +299 -0
  73. package/skill/references/classes/IPCB_Polygon.md +175 -0
  74. package/skill/references/classes/IPCB_PrimitiveArc.md +1901 -0
  75. package/skill/references/classes/IPCB_PrimitiveAttribute.md +2993 -0
  76. package/skill/references/classes/IPCB_PrimitiveComponent.md +2627 -0
  77. package/skill/references/classes/IPCB_PrimitiveComponentPad.md +410 -0
  78. package/skill/references/classes/IPCB_PrimitiveDimension.md +1419 -0
  79. package/skill/references/classes/IPCB_PrimitiveFill.md +1325 -0
  80. package/skill/references/classes/IPCB_PrimitiveImage.md +1461 -0
  81. package/skill/references/classes/IPCB_PrimitiveLine.md +1639 -0
  82. package/skill/references/classes/IPCB_PrimitiveObject.md +1700 -0
  83. package/skill/references/classes/IPCB_PrimitivePad.md +3155 -0
  84. package/skill/references/classes/IPCB_PrimitivePolyline.md +1193 -0
  85. package/skill/references/classes/IPCB_PrimitivePour.md +1858 -0
  86. package/skill/references/classes/IPCB_PrimitivePoured.md +556 -0
  87. package/skill/references/classes/IPCB_PrimitiveRegion.md +1332 -0
  88. package/skill/references/classes/IPCB_PrimitiveString.md +2315 -0
  89. package/skill/references/classes/IPCB_PrimitiveVia.md +1588 -0
  90. package/skill/references/classes/ISCH_PrimitiveArc.md +1676 -0
  91. package/skill/references/classes/ISCH_PrimitiveAttribute.md +2541 -0
  92. package/skill/references/classes/ISCH_PrimitiveBus.md +973 -0
  93. package/skill/references/classes/ISCH_PrimitiveCbbSymbolComponent.md +260 -0
  94. package/skill/references/classes/ISCH_PrimitiveCircle.md +1392 -0
  95. package/skill/references/classes/ISCH_PrimitiveComponent.md +2913 -0
  96. package/skill/references/classes/ISCH_PrimitiveComponentPin.md +155 -0
  97. package/skill/references/classes/ISCH_PrimitiveObject.md +960 -0
  98. package/skill/references/classes/ISCH_PrimitivePin.md +2402 -0
  99. package/skill/references/classes/ISCH_PrimitivePolygon.md +1028 -0
  100. package/skill/references/classes/ISCH_PrimitiveRectangle.md +1777 -0
  101. package/skill/references/classes/ISCH_PrimitiveText.md +1771 -0
  102. package/skill/references/classes/ISCH_PrimitiveWire.md +973 -0
  103. package/skill/references/classes/LIB_3DModel.md +780 -0
  104. package/skill/references/classes/LIB_Cbb.md +957 -0
  105. package/skill/references/classes/LIB_Classification.md +965 -0
  106. package/skill/references/classes/LIB_Device.md +1221 -0
  107. package/skill/references/classes/LIB_Footprint.md +1153 -0
  108. package/skill/references/classes/LIB_LibrariesList.md +329 -0
  109. package/skill/references/classes/LIB_PanelLibrary.md +855 -0
  110. package/skill/references/classes/LIB_SelectControl.md +89 -0
  111. package/skill/references/classes/LIB_SimulationModel.md +821 -0
  112. package/skill/references/classes/LIB_Symbol.md +1195 -0
  113. package/skill/references/classes/PCB_Document.md +1754 -0
  114. package/skill/references/classes/PCB_Drc.md +3375 -0
  115. package/skill/references/classes/PCB_Event.md +1081 -0
  116. package/skill/references/classes/PCB_Layer.md +1911 -0
  117. package/skill/references/classes/PCB_ManufactureData.md +2968 -0
  118. package/skill/references/classes/PCB_MathPolygon.md +785 -0
  119. package/skill/references/classes/PCB_Net.md +1128 -0
  120. package/skill/references/classes/PCB_Primitive.md +217 -0
  121. package/skill/references/classes/PCB_PrimitiveArc.md +894 -0
  122. package/skill/references/classes/PCB_PrimitiveAttribute.md +717 -0
  123. package/skill/references/classes/PCB_PrimitiveComponent.md +1050 -0
  124. package/skill/references/classes/PCB_PrimitiveDimension.md +833 -0
  125. package/skill/references/classes/PCB_PrimitiveFill.md +861 -0
  126. package/skill/references/classes/PCB_PrimitiveImage.md +875 -0
  127. package/skill/references/classes/PCB_PrimitiveLine.md +858 -0
  128. package/skill/references/classes/PCB_PrimitiveObject.md +800 -0
  129. package/skill/references/classes/PCB_PrimitivePad.md +944 -0
  130. package/skill/references/classes/PCB_PrimitivePolyline.md +819 -0
  131. package/skill/references/classes/PCB_PrimitivePour.md +845 -0
  132. package/skill/references/classes/PCB_PrimitivePoured.md +363 -0
  133. package/skill/references/classes/PCB_PrimitiveRegion.md +799 -0
  134. package/skill/references/classes/PCB_PrimitiveString.md +910 -0
  135. package/skill/references/classes/PCB_PrimitiveVia.md +765 -0
  136. package/skill/references/classes/PCB_RayTracerEngine.md +263 -0
  137. package/skill/references/classes/PCB_SelectControl.md +495 -0
  138. package/skill/references/classes/PNL_Document.md +83 -0
  139. package/skill/references/classes/SCH_Document.md +809 -0
  140. package/skill/references/classes/SCH_Drc.md +242 -0
  141. package/skill/references/classes/SCH_Event.md +583 -0
  142. package/skill/references/classes/SCH_ManufactureData.md +1205 -0
  143. package/skill/references/classes/SCH_Net.md +200 -0
  144. package/skill/references/classes/SCH_Netlist.md +191 -0
  145. package/skill/references/classes/SCH_Primitive.md +337 -0
  146. package/skill/references/classes/SCH_PrimitiveArc.md +692 -0
  147. package/skill/references/classes/SCH_PrimitiveAttribute.md +590 -0
  148. package/skill/references/classes/SCH_PrimitiveBus.md +624 -0
  149. package/skill/references/classes/SCH_PrimitiveCircle.md +683 -0
  150. package/skill/references/classes/SCH_PrimitiveComponent.md +2240 -0
  151. package/skill/references/classes/SCH_PrimitiveObject.md +666 -0
  152. package/skill/references/classes/SCH_PrimitivePin.md +754 -0
  153. package/skill/references/classes/SCH_PrimitivePolygon.md +627 -0
  154. package/skill/references/classes/SCH_PrimitiveRectangle.md +731 -0
  155. package/skill/references/classes/SCH_PrimitiveText.md +746 -0
  156. package/skill/references/classes/SCH_PrimitiveWire.md +703 -0
  157. package/skill/references/classes/SCH_SelectControl.md +520 -0
  158. package/skill/references/classes/SCH_SimulationEngine.md +133 -0
  159. package/skill/references/classes/SCH_Utils.md +121 -0
  160. package/skill/references/classes/SYS_ClientUrl.md +173 -0
  161. package/skill/references/classes/SYS_Dialog.md +825 -0
  162. package/skill/references/classes/SYS_Environment.md +502 -0
  163. package/skill/references/classes/SYS_FileManager.md +1686 -0
  164. package/skill/references/classes/SYS_FileSystem.md +1171 -0
  165. package/skill/references/classes/SYS_FontManager.md +224 -0
  166. package/skill/references/classes/SYS_FormatConversion.md +349 -0
  167. package/skill/references/classes/SYS_HeaderMenu.md +479 -0
  168. package/skill/references/classes/SYS_I18n.md +861 -0
  169. package/skill/references/classes/SYS_IFrame.md +535 -0
  170. package/skill/references/classes/SYS_LoadingAndProgressBar.md +246 -0
  171. package/skill/references/classes/SYS_Log.md +424 -0
  172. package/skill/references/classes/SYS_Math.md +1565 -0
  173. package/skill/references/classes/SYS_Message.md +363 -0
  174. package/skill/references/classes/SYS_MessageBox.md +285 -0
  175. package/skill/references/classes/SYS_MessageBus.md +1618 -0
  176. package/skill/references/classes/SYS_PanelControl.md +696 -0
  177. package/skill/references/classes/SYS_RightClickMenu.md +175 -0
  178. package/skill/references/classes/SYS_Setting.md +85 -0
  179. package/skill/references/classes/SYS_ShortcutKey.md +623 -0
  180. package/skill/references/classes/SYS_Storage.md +484 -0
  181. package/skill/references/classes/SYS_Timer.md +447 -0
  182. package/skill/references/classes/SYS_ToastMessage.md +194 -0
  183. package/skill/references/classes/SYS_Tool.md +241 -0
  184. package/skill/references/classes/SYS_Unit.md +594 -0
  185. package/skill/references/classes/SYS_WebSocket.md +401 -0
  186. package/skill/references/classes/SYS_Window.md +850 -0
  187. package/skill/references/enums/EDMT_EditorDocumentType.md +279 -0
  188. package/skill/references/enums/EDMT_EditorSplitScreenDirection.md +48 -0
  189. package/skill/references/enums/EDMT_EditorTabEventType.md +63 -0
  190. package/skill/references/enums/EDMT_IndicatorMarkerType.md +81 -0
  191. package/skill/references/enums/EDMT_ItemType.md +158 -0
  192. package/skill/references/enums/EDMT_ProjectCollaborationMode.md +48 -0
  193. package/skill/references/enums/ELIB_DeviceJlcLibraryCategory.md +48 -0
  194. package/skill/references/enums/ELIB_LibraryType.md +114 -0
  195. package/skill/references/enums/ELIB_PreviewType.md +70 -0
  196. package/skill/references/enums/ELIB_SimulationModelType.md +48 -0
  197. package/skill/references/enums/ELIB_SymbolType.md +125 -0
  198. package/skill/references/enums/EPCB_AutoRoutingCornerStyle.md +48 -0
  199. package/skill/references/enums/EPCB_AutoRoutingExistingPrimitiveMode.md +48 -0
  200. package/skill/references/enums/EPCB_AutoRoutingOptimization.md +48 -0
  201. package/skill/references/enums/EPCB_DocumentCanvasUpdateCalculationActiveStatus.md +48 -0
  202. package/skill/references/enums/EPCB_DocumentRatlineCalculatingActiveStatus.md +52 -0
  203. package/skill/references/enums/EPCB_InactiveLayerDisplayMode.md +59 -0
  204. package/skill/references/enums/EPCB_LayerColorConfiguration.md +81 -0
  205. package/skill/references/enums/EPCB_LayerId.md +882 -0
  206. package/skill/references/enums/EPCB_LayerStatus.md +59 -0
  207. package/skill/references/enums/EPCB_LayerType.md +114 -0
  208. package/skill/references/enums/EPCB_MouseEventType.md +59 -0
  209. package/skill/references/enums/EPCB_NetEventType.md +59 -0
  210. package/skill/references/enums/EPCB_PcbPlateType.md +48 -0
  211. package/skill/references/enums/EPCB_PdfOutputMethod.md +59 -0
  212. package/skill/references/enums/EPCB_PrimitiveArcInteractiveMode.md +48 -0
  213. package/skill/references/enums/EPCB_PrimitiveDimensionType.md +59 -0
  214. package/skill/references/enums/EPCB_PrimitiveEventType.md +59 -0
  215. package/skill/references/enums/EPCB_PrimitiveFillMode.md +63 -0
  216. package/skill/references/enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md +59 -0
  217. package/skill/references/enums/EPCB_PrimitivePadHoleType.md +59 -0
  218. package/skill/references/enums/EPCB_PrimitivePadShapeType.md +81 -0
  219. package/skill/references/enums/EPCB_PrimitivePadType.md +59 -0
  220. package/skill/references/enums/EPCB_PrimitivePourFillMethod.md +59 -0
  221. package/skill/references/enums/EPCB_PrimitiveRegionRuleType.md +96 -0
  222. package/skill/references/enums/EPCB_PrimitiveStringAlignMode.md +125 -0
  223. package/skill/references/enums/EPCB_PrimitiveType.md +202 -0
  224. package/skill/references/enums/EPCB_PrimitiveViaType.md +59 -0
  225. package/skill/references/enums/ESCH_DynamicSimulationEnginePullEventType.md +103 -0
  226. package/skill/references/enums/ESCH_DynamicSimulationEnginePushEventType.md +81 -0
  227. package/skill/references/enums/ESCH_ExportDocumentFileType.md +59 -0
  228. package/skill/references/enums/ESCH_MouseEventType.md +48 -0
  229. package/skill/references/enums/ESCH_PrimitiveComponentType.md +125 -0
  230. package/skill/references/enums/ESCH_PrimitiveEventType.md +70 -0
  231. package/skill/references/enums/ESCH_PrimitiveFillStyle.md +114 -0
  232. package/skill/references/enums/ESCH_PrimitiveLineType.md +70 -0
  233. package/skill/references/enums/ESCH_PrimitivePinShape.md +70 -0
  234. package/skill/references/enums/ESCH_PrimitivePinType.md +147 -0
  235. package/skill/references/enums/ESCH_PrimitiveTextAlignMode.md +125 -0
  236. package/skill/references/enums/ESCH_PrimitiveType.md +180 -0
  237. package/skill/references/enums/ESCH_SimulationNetlistType.md +37 -0
  238. package/skill/references/enums/ESCH_SpiceSimulationEnginePullEventType.md +48 -0
  239. package/skill/references/enums/ESCH_SpiceSimulationEnginePushEventType.md +70 -0
  240. package/skill/references/enums/ESYS_BottomPanelTab.md +81 -0
  241. package/skill/references/enums/ESYS_HeaderMenuEnvironment.md +158 -0
  242. package/skill/references/enums/ESYS_ImportProjectBoardOutlineSource.md +52 -0
  243. package/skill/references/enums/ESYS_ImportProjectImportOption.md +59 -0
  244. package/skill/references/enums/ESYS_ImportProjectSchematicObjectStyle.md +48 -0
  245. package/skill/references/enums/ESYS_ImportProjectViaSolderMaskExpansion.md +52 -0
  246. package/skill/references/enums/ESYS_LeftPanelTab.md +81 -0
  247. package/skill/references/enums/ESYS_LogType.md +103 -0
  248. package/skill/references/enums/ESYS_NetlistType.md +114 -0
  249. package/skill/references/enums/ESYS_RightPanelTab.md +202 -0
  250. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorRange.md +191 -0
  251. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorScene.md +92 -0
  252. package/skill/references/enums/ESYS_StartPageQuickStartItem.md +206 -0
  253. package/skill/references/enums/ESYS_Theme.md +48 -0
  254. package/skill/references/enums/ESYS_ToastMessageType.md +81 -0
  255. package/skill/references/enums/ESYS_Unit.md +103 -0
  256. package/skill/references/enums/ESYS_WindowEventType.md +48 -0
  257. package/skill/references/enums/ESYS_WindowOpenTarget.md +48 -0
  258. package/skill/references/enums/NetportDeviceName.md +147 -0
  259. package/skill/references/enums/SchToolBarDeviceName.md +279 -0
  260. package/skill/references/interfaces/BoardProps.md +169 -0
  261. package/skill/references/interfaces/ButtonProps.md +169 -0
  262. package/skill/references/interfaces/CheckBoxProps.md +196 -0
  263. package/skill/references/interfaces/ComponentPropsMap.md +448 -0
  264. package/skill/references/interfaces/DialogProps.md +385 -0
  265. package/skill/references/interfaces/FlexItemProps.md +116 -0
  266. package/skill/references/interfaces/FlexProps.md +224 -0
  267. package/skill/references/interfaces/GridItemProps.md +143 -0
  268. package/skill/references/interfaces/GridProps.md +143 -0
  269. package/skill/references/interfaces/IDMT_BoardItem.md +171 -0
  270. package/skill/references/interfaces/IDMT_BriefProjectItem.md +171 -0
  271. package/skill/references/interfaces/IDMT_EditorDocumentItem.md +169 -0
  272. package/skill/references/interfaces/IDMT_EditorSplitScreenItem.md +173 -0
  273. package/skill/references/interfaces/IDMT_EditorTabItem.md +169 -0
  274. package/skill/references/interfaces/IDMT_FolderItem.md +225 -0
  275. package/skill/references/interfaces/IDMT_IndicatorMarkerShape.md +393 -0
  276. package/skill/references/interfaces/IDMT_PanelItem.md +144 -0
  277. package/skill/references/interfaces/IDMT_PcbItem.md +171 -0
  278. package/skill/references/interfaces/IDMT_ProjectItem.md +143 -0
  279. package/skill/references/interfaces/IDMT_SchematicItem.md +225 -0
  280. package/skill/references/interfaces/IDMT_SchematicPageItem.md +198 -0
  281. package/skill/references/interfaces/IDMT_TeamItem.md +144 -0
  282. package/skill/references/interfaces/IDMT_WorkspaceItem.md +117 -0
  283. package/skill/references/interfaces/IDesignPortal.md +103 -0
  284. package/skill/references/interfaces/ILIB_3DModelItem.md +198 -0
  285. package/skill/references/interfaces/ILIB_3DModelSearchItem.md +277 -0
  286. package/skill/references/interfaces/ILIB_CbbItem.md +225 -0
  287. package/skill/references/interfaces/ILIB_CbbSearchItem.md +277 -0
  288. package/skill/references/interfaces/ILIB_ClassificationIndex.md +150 -0
  289. package/skill/references/interfaces/ILIB_DeviceAssociationItem.md +210 -0
  290. package/skill/references/interfaces/ILIB_DeviceExtendPropertyItem.md +304 -0
  291. package/skill/references/interfaces/ILIB_DeviceItem.md +279 -0
  292. package/skill/references/interfaces/ILIB_DevicePropertiesForSearch.md +250 -0
  293. package/skill/references/interfaces/ILIB_DeviceSearchItem.md +521 -0
  294. package/skill/references/interfaces/ILIB_ExtendLibrary3DModelFunctions.md +64 -0
  295. package/skill/references/interfaces/ILIB_ExtendLibraryCbbFunctions.md +99 -0
  296. package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md +150 -0
  297. package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md +157 -0
  298. package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md +63 -0
  299. package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md +123 -0
  300. package/skill/references/interfaces/ILIB_ExtendLibraryItem.md +97 -0
  301. package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md +98 -0
  302. package/skill/references/interfaces/ILIB_ExtendLibrarySearchProperty.md +115 -0
  303. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResult.md +169 -0
  304. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResultDataLine.md +234 -0
  305. package/skill/references/interfaces/ILIB_ExtendLibrarySymbolFunctions.md +105 -0
  306. package/skill/references/interfaces/ILIB_ExtendLibraryUserIndex.md +96 -0
  307. package/skill/references/interfaces/ILIB_FootprintItem.md +198 -0
  308. package/skill/references/interfaces/ILIB_FootprintPropertiesForSearch.md +61 -0
  309. package/skill/references/interfaces/ILIB_FootprintSearchItem.md +277 -0
  310. package/skill/references/interfaces/ILIB_LibraryInfo.md +92 -0
  311. package/skill/references/interfaces/ILIB_LibraryItem.md +115 -0
  312. package/skill/references/interfaces/ILIB_PanelLibraryItem.md +198 -0
  313. package/skill/references/interfaces/ILIB_PanelLibrarySearchItem.md +277 -0
  314. package/skill/references/interfaces/ILIB_SimulationModelItem.md +306 -0
  315. package/skill/references/interfaces/ILIB_SimulationModelSearchItem.md +304 -0
  316. package/skill/references/interfaces/ILIB_SymbolItem.md +279 -0
  317. package/skill/references/interfaces/ILIB_SymbolPropertiesForSearch.md +61 -0
  318. package/skill/references/interfaces/ILIB_SymbolSearchItem.md +304 -0
  319. package/skill/references/interfaces/IPCB_AutoLayoutResult.md +169 -0
  320. package/skill/references/interfaces/IPCB_AutoRoutingProps.md +220 -0
  321. package/skill/references/interfaces/IPCB_AutoRoutingResult.md +169 -0
  322. package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md +169 -0
  323. package/skill/references/interfaces/IPCB_DifferentialPairItem.md +115 -0
  324. package/skill/references/interfaces/IPCB_DiscretizeOptions.md +65 -0
  325. package/skill/references/interfaces/IPCB_DiscretizedPoint.md +88 -0
  326. package/skill/references/interfaces/IPCB_EqualLengthNetGroupItem.md +115 -0
  327. package/skill/references/interfaces/IPCB_LayerItem.md +277 -0
  328. package/skill/references/interfaces/IPCB_NetClassItem.md +115 -0
  329. package/skill/references/interfaces/IPCB_NetInfo.md +115 -0
  330. package/skill/references/interfaces/IPCB_PadPairGroupItem.md +88 -0
  331. package/skill/references/interfaces/IPCB_PadPairMinWireLengthItem.md +88 -0
  332. package/skill/references/interfaces/IPCB_PhysicalStackingConfiguration.md +115 -0
  333. package/skill/references/interfaces/IPCB_Primitive.md +218 -0
  334. package/skill/references/interfaces/IPCB_PrimitiveAPI.md +175 -0
  335. package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md +151 -0
  336. package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md +142 -0
  337. package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md +154 -0
  338. package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md +88 -0
  339. package/skill/references/interfaces/IRawNet.md +103 -0
  340. package/skill/references/interfaces/IRawPureSchematic.md +80 -0
  341. package/skill/references/interfaces/IRawSchematic.md +103 -0
  342. package/skill/references/interfaces/IRawWire.md +149 -0
  343. package/skill/references/interfaces/ISCH_DrcError.md +142 -0
  344. package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md +142 -0
  345. package/skill/references/interfaces/ISCH_ExportPngResolution.md +94 -0
  346. package/skill/references/interfaces/ISCH_NetInfo.md +88 -0
  347. package/skill/references/interfaces/ISCH_Primitive.md +219 -0
  348. package/skill/references/interfaces/ISCH_PrimitiveAPI.md +175 -0
  349. package/skill/references/interfaces/ISCH_ProjectNetInfo.md +142 -0
  350. package/skill/references/interfaces/ISCH_WireInfo.md +169 -0
  351. package/skill/references/interfaces/ISYS_FileSystemFileList.md +169 -0
  352. package/skill/references/interfaces/ISYS_HeaderMenuSub1MenuItem.md +174 -0
  353. package/skill/references/interfaces/ISYS_HeaderMenuSub2MenuItem.md +147 -0
  354. package/skill/references/interfaces/ISYS_HeaderMenuTopMenuItem.md +115 -0
  355. package/skill/references/interfaces/ISYS_HeaderMenus.md +408 -0
  356. package/skill/references/interfaces/ISYS_LogLine.md +115 -0
  357. package/skill/references/interfaces/ISYS_MathBBox.md +142 -0
  358. package/skill/references/interfaces/ISYS_MathPoint.md +88 -0
  359. package/skill/references/interfaces/ISYS_MathPolygonWithHoles.md +92 -0
  360. package/skill/references/interfaces/ISYS_MessageBusTask.md +115 -0
  361. package/skill/references/interfaces/ISYS_MultilingualLanguagesData.md +13 -0
  362. package/skill/references/interfaces/ISYS_PcbComparisonResponse.md +115 -0
  363. package/skill/references/interfaces/ISYS_RightClickMenuItem.md +174 -0
  364. package/skill/references/interfaces/ISYS_ShortcutKeyData.md +169 -0
  365. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithCallFn.md +62 -0
  366. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithUserDefinedShortcutKey.md +62 -0
  367. package/skill/references/interfaces/ISYS_WindowEventListenerRemovableObject.md +109 -0
  368. package/skill/references/interfaces/IconProps.md +88 -0
  369. package/skill/references/interfaces/ImageProps.md +115 -0
  370. package/skill/references/interfaces/InputProps.md +520 -0
  371. package/skill/references/interfaces/ListChildren.md +223 -0
  372. package/skill/references/interfaces/ListProps.md +223 -0
  373. package/skill/references/interfaces/ModalProps.md +358 -0
  374. package/skill/references/interfaces/RadioGroupProps.md +196 -0
  375. package/skill/references/interfaces/RadioItem.md +115 -0
  376. package/skill/references/interfaces/ScrollerProps.md +169 -0
  377. package/skill/references/interfaces/SelectListItem.md +142 -0
  378. package/skill/references/interfaces/SelectProps.md +169 -0
  379. package/skill/references/interfaces/SlotProps.md +88 -0
  380. package/skill/references/interfaces/StyleProps.md +385 -0
  381. package/skill/references/interfaces/TextAreaProps.md +196 -0
  382. package/skill/references/interfaces/TextProps.md +169 -0
  383. package/skill/references/types/ISYS_LanguageKeyValuePairs.md +13 -0
  384. package/skill/references/types/TPCB_LayerTypesOfInnerLayer.md +12 -0
  385. package/skill/references/types/TPCB_LayersInTheSelectable.md +43 -0
  386. package/skill/references/types/TPCB_LayersOfComponent.md +12 -0
  387. package/skill/references/types/TPCB_LayersOfCopper.md +16 -0
  388. package/skill/references/types/TPCB_LayersOfCustom.md +42 -0
  389. package/skill/references/types/TPCB_LayersOfDimension.md +17 -0
  390. package/skill/references/types/TPCB_LayersOfFill.md +29 -0
  391. package/skill/references/types/TPCB_LayersOfImage.md +23 -0
  392. package/skill/references/types/TPCB_LayersOfInner.md +42 -0
  393. package/skill/references/types/TPCB_LayersOfLine.md +26 -0
  394. package/skill/references/types/TPCB_LayersOfObject.md +13 -0
  395. package/skill/references/types/TPCB_LayersOfPad.md +12 -0
  396. package/skill/references/types/TPCB_LayersOfRegion.md +12 -0
  397. package/skill/references/types/TPCB_NumberOfCopperLayers.md +10 -0
  398. package/skill/references/types/TPCB_PolygonSourceArray.md +83 -0
  399. package/skill/references/types/TPCB_PrimitiveDimensionCoordinateSet.md +67 -0
  400. package/skill/references/types/TPCB_PrimitivePadHole.md +31 -0
  401. package/skill/references/types/TPCB_PrimitivePadShape.md +62 -0
  402. package/skill/references/types/TPCB_PrimitiveSpecialPadShape.md +20 -0
  403. package/skill/references/types/TSYS_MathPolygonGroup.md +16 -0
  404. package/skill/references/types/TSYS_MathPolygonInput.md +21 -0
  405. package/skill/references/types/TSYS_PcbComparisonErrorCode.md +10 -0
  406. package/skill/references/types/TSYS_ShortcutKeys.md +97 -0
  407. package/skill/user-guide/using-extension.md +47 -0
@@ -0,0 +1,799 @@
1
+ # PCB\_PrimitiveRegion class
2
+
3
+ PCB & footprint / forbidden region and constrained region primitive class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class PCB_PrimitiveRegion 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(layer, complexPolygon, ruleType, regionName, lineWidth, primitiveLock)](./PCB_PrimitiveRegion.md)
30
+
31
+ </td><td>
32
+
33
+ </td><td>
34
+
35
+ **_(BETA)_** Create Region
36
+
37
+ </td></tr>
38
+ <tr><td>
39
+
40
+ [delete(primitiveIds)](./PCB_PrimitiveRegion.md)
41
+
42
+ </td><td>
43
+
44
+ </td><td>
45
+
46
+ **_(BETA)_** Delete Region
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ [get(primitiveIds)](./PCB_PrimitiveRegion.md)
52
+
53
+ </td><td>
54
+
55
+ </td><td>
56
+
57
+ **_(BETA)_** Get Region
58
+
59
+ </td></tr>
60
+ <tr><td>
61
+
62
+ [get(primitiveIds)](./PCB_PrimitiveRegion.md)
63
+
64
+ </td><td>
65
+
66
+ </td><td>
67
+
68
+ **_(BETA)_** Get Region
69
+
70
+ </td></tr>
71
+ <tr><td>
72
+
73
+ [getAll(layer, ruleType, primitiveLock)](./PCB_PrimitiveRegion.md)
74
+
75
+ </td><td>
76
+
77
+ </td><td>
78
+
79
+ **_(BETA)_** Get all Region
80
+
81
+ </td></tr>
82
+ <tr><td>
83
+
84
+ [getAllPrimitiveId(layer, ruleType, primitiveLock)](./PCB_PrimitiveRegion.md)
85
+
86
+ </td><td>
87
+
88
+ </td><td>
89
+
90
+ **_(BETA)_** Get all Region primitive IDs
91
+
92
+ </td></tr>
93
+ <tr><td>
94
+
95
+ [modify(primitiveId, property)](./PCB_PrimitiveRegion.md)
96
+
97
+ </td><td>
98
+
99
+ </td><td>
100
+
101
+ **_(BETA)_** Modify Region
102
+
103
+ </td></tr>
104
+ </tbody></table>
105
+
106
+ ---
107
+
108
+ ## 方法详情
109
+
110
+ ### create
111
+
112
+ # PCB\_PrimitiveRegion.create() method
113
+
114
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
115
+
116
+ Create Region
117
+
118
+ ## Signature
119
+
120
+ ```typescript
121
+ function create(
122
+ layer: TPCB_LayersOfRegion,
123
+ complexPolygon: IPCB_Polygon,
124
+ ruleType?: Array<EPCB_PrimitiveRegionRuleType>,
125
+ regionName?: string,
126
+ lineWidth?: number,
127
+ primitiveLock?: boolean,
128
+ ): Promise<IPCB_PrimitiveRegion | undefined>;
129
+ ```
130
+
131
+ ## Parameters
132
+
133
+ <table><thead><tr><th>
134
+
135
+ Parameter
136
+
137
+ </th><th>
138
+
139
+ Type
140
+
141
+ </th><th>
142
+
143
+ Description
144
+
145
+ </th></tr></thead>
146
+ <tbody><tr><td>
147
+
148
+ layer
149
+
150
+ </td><td>
151
+
152
+ [TPCB\_LayersOfRegion](../types/TPCB_LayersOfRegion.md)
153
+
154
+ </td><td>
155
+
156
+ Layer
157
+
158
+ </td></tr>
159
+ <tr><td>
160
+
161
+ complexPolygon
162
+
163
+ </td><td>
164
+
165
+ [IPCB\_Polygon](./IPCB_Polygon.md)
166
+
167
+ </td><td>
168
+
169
+ Complex polygon object
170
+
171
+ </td></tr>
172
+ <tr><td>
173
+
174
+ ruleType
175
+
176
+ </td><td>
177
+
178
+ Array&lt;[EPCB\_PrimitiveRegionRuleType](../enums/EPCB_PrimitiveRegionRuleType.md)<!-- -->&gt;
179
+
180
+ </td><td>
181
+
182
+ _(Optional)_ Region rule type
183
+
184
+ </td></tr>
185
+ <tr><td>
186
+
187
+ regionName
188
+
189
+ </td><td>
190
+
191
+ string
192
+
193
+ </td><td>
194
+
195
+ _(Optional)_ Region name
196
+
197
+ </td></tr>
198
+ <tr><td>
199
+
200
+ lineWidth
201
+
202
+ </td><td>
203
+
204
+ number
205
+
206
+ </td><td>
207
+
208
+ _(Optional)_ Line width
209
+
210
+ </td></tr>
211
+ <tr><td>
212
+
213
+ primitiveLock
214
+
215
+ </td><td>
216
+
217
+ boolean
218
+
219
+ </td><td>
220
+
221
+ _(Optional)_ Whether it is locked
222
+
223
+ </td></tr>
224
+ </tbody></table>
225
+
226
+ ## Returns
227
+
228
+ Promise&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md) \| undefined&gt;
229
+
230
+ Region primitive object
231
+
232
+ ## Example
233
+
234
+ ```javascript
235
+ // 1. 生成随机起点坐标,避免与画布上已有的区域重合
236
+ const x = 2000 + Math.floor(Math.random() * 100000);
237
+ const y = 2000 + Math.floor(Math.random() * 100000);
238
+
239
+ // 2. 用 pcb_MathPolygon.createPolygon 构造矩形边界:宽 500、高 300
240
+ const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
241
+
242
+ // 3. 在顶层铜层创建禁止区域:规则 [2, 5] 即禁止元件 + 禁止布线,线宽 10mil,不锁定
243
+ const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2, 5], '嘉立创示例_禁布区', 10, false);
244
+
245
+ // 4. 创建类保留现场,不删除图元
246
+ console.log('primitiveId:', region.getState_PrimitiveId());
247
+ console.log('primitiveType:', region.getState_PrimitiveType());
248
+ console.log('layer:', region.getState_Layer());
249
+ console.log('ruleType:', region.getState_RuleType());
250
+ console.log('regionName:', region.getState_RegionName());
251
+ ```
252
+
253
+ ### delete
254
+
255
+ # PCB\_PrimitiveRegion.delete() method
256
+
257
+ > 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.
258
+
259
+ Delete Region
260
+
261
+ ## Signature
262
+
263
+ ```typescript
264
+ function delete(primitiveIds: string | IPCB_PrimitiveRegion | Array<string> | Array<IPCB_PrimitiveRegion>): Promise<boolean>;
265
+ ```
266
+
267
+ ## Parameters
268
+
269
+ <table><thead><tr><th>
270
+
271
+ Parameter
272
+
273
+ </th><th>
274
+
275
+ Type
276
+
277
+ </th><th>
278
+
279
+ Description
280
+
281
+ </th></tr></thead>
282
+ <tbody><tr><td>
283
+
284
+ primitiveIds
285
+
286
+ </td><td>
287
+
288
+ string \| [IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md) \| Array&lt;string&gt; \| Array&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md)<!-- -->&gt;
289
+
290
+ </td><td>
291
+
292
+ Region primitive ID or Region primitive object
293
+
294
+ </td></tr>
295
+ </tbody></table>
296
+
297
+ ## Returns
298
+
299
+ Promise&lt;boolean&gt;
300
+
301
+ Delete Whether the operation is successful
302
+
303
+ ## Example
304
+
305
+ ```javascript
306
+ // 1. 创建两个待删除的测试区域(随机坐标避免重合)
307
+ const x = 2000 + Math.floor(Math.random() * 100000);
308
+ const y = 2000 + Math.floor(Math.random() * 100000);
309
+ const polygon1 = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
310
+ const polygon2 = eda.pcb_MathPolygon.createPolygon(['R', x, y + 500, 500, 300, 0, 0]);
311
+ const region1 = await eda.pcb_PrimitiveRegion.create(1, polygon1, [2], '嘉立创示例_删除A');
312
+ const region2 = await eda.pcb_PrimitiveRegion.create(1, polygon2, [5], '嘉立创示例_删除B');
313
+
314
+ // 2. 记录删除前的区域数量
315
+ const beforeCount = (await eda.pcb_PrimitiveRegion.getAll()).length;
316
+
317
+ // 3. 以 ID 数组形式批量删除两个区域
318
+ const deleted = await eda.pcb_PrimitiveRegion.delete([region1.getState_PrimitiveId(), region2.getState_PrimitiveId()]);
319
+
320
+ // 4. 删除类保留现场(图元已删除,不恢复)
321
+ const afterCount = (await eda.pcb_PrimitiveRegion.getAll()).length;
322
+
323
+ console.log('deleted:', deleted);
324
+ console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
325
+ ```
326
+
327
+ ### get
328
+
329
+ # PCB\_PrimitiveRegion.get() method
330
+
331
+ > 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.
332
+
333
+ Get Region
334
+
335
+ ## Signature
336
+
337
+ ```typescript
338
+ function get(primitiveIds: string): Promise<IPCB_PrimitiveRegion | undefined>;
339
+ ```
340
+
341
+ ## Parameters
342
+
343
+ <table><thead><tr><th>
344
+
345
+ Parameter
346
+
347
+ </th><th>
348
+
349
+ Type
350
+
351
+ </th><th>
352
+
353
+ Description
354
+
355
+ </th></tr></thead>
356
+ <tbody><tr><td>
357
+
358
+ primitiveIds
359
+
360
+ </td><td>
361
+
362
+ string
363
+
364
+ </td><td>
365
+
366
+ Region primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
367
+
368
+ </td></tr>
369
+ </tbody></table>
370
+
371
+ ## Returns
372
+
373
+ Promise&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md) \| undefined&gt;
374
+
375
+ Region primitive object, `undefined` indicates that the retrieval failed
376
+
377
+ ## Example
378
+
379
+ ```javascript
380
+ // 1. 创建两个测试区域(随机坐标避免重合),分别用不同规则便于区分
381
+ const x = 2000 + Math.floor(Math.random() * 100000);
382
+ const y = 2000 + Math.floor(Math.random() * 100000);
383
+ const polygon1 = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
384
+ const polygon2 = eda.pcb_MathPolygon.createPolygon(['R', x, y + 500, 500, 300, 0, 0]);
385
+ const region1 = await eda.pcb_PrimitiveRegion.create(1, polygon1, [2], '嘉立创示例_区域A');
386
+ const region2 = await eda.pcb_PrimitiveRegion.create(1, polygon2, [5], '嘉立创示例_区域B');
387
+
388
+ // 2. 传单个 ID 字符串,返回单个区域对象
389
+ const single = await eda.pcb_PrimitiveRegion.get(region1.getState_PrimitiveId());
390
+
391
+ // 3. 传 ID 数组,返回区域对象数组
392
+ const arr = await eda.pcb_PrimitiveRegion.get([region1.getState_PrimitiveId(), region2.getState_PrimitiveId()]);
393
+
394
+ // 4. 清理测试图元(查询类需要清理)
395
+ await eda.pcb_PrimitiveRegion.delete([region1.getState_PrimitiveId(), region2.getState_PrimitiveId()]);
396
+
397
+ console.log('single ruleType:', single.getState_RuleType());
398
+ console.log('array length:', arr.length);
399
+ console.log('region2 ruleType:', arr[1].getState_RuleType());
400
+ ```
401
+
402
+ ### get_1
403
+
404
+ # PCB\_PrimitiveRegion.get() method
405
+
406
+ > 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.
407
+
408
+ Get Region
409
+
410
+ ## Signature
411
+
412
+ ```typescript
413
+ function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveRegion>>;
414
+ ```
415
+
416
+ ## Parameters
417
+
418
+ <table><thead><tr><th>
419
+
420
+ Parameter
421
+
422
+ </th><th>
423
+
424
+ Type
425
+
426
+ </th><th>
427
+
428
+ Description
429
+
430
+ </th></tr></thead>
431
+ <tbody><tr><td>
432
+
433
+ primitiveIds
434
+
435
+ </td><td>
436
+
437
+ Array&lt;string&gt;
438
+
439
+ </td><td>
440
+
441
+ Region primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
442
+
443
+ </td></tr>
444
+ </tbody></table>
445
+
446
+ ## Returns
447
+
448
+ Promise&lt;Array&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md)<!-- -->&gt;&gt;
449
+
450
+ Region primitive object; an empty array indicates that the retrieval failed
451
+
452
+ ## Remarks
453
+
454
+ 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.
455
+
456
+ ### getall
457
+
458
+ # PCB\_PrimitiveRegion.getAll() method
459
+
460
+ > 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.
461
+
462
+ Get all Region
463
+
464
+ ## Signature
465
+
466
+ ```typescript
467
+ function getAll(
468
+ layer?: TPCB_LayersOfRegion,
469
+ ruleType?: Array<EPCB_PrimitiveRegionRuleType>,
470
+ primitiveLock?: boolean,
471
+ ): Promise<Array<IPCB_PrimitiveRegion>>;
472
+ ```
473
+
474
+ ## Parameters
475
+
476
+ <table><thead><tr><th>
477
+
478
+ Parameter
479
+
480
+ </th><th>
481
+
482
+ Type
483
+
484
+ </th><th>
485
+
486
+ Description
487
+
488
+ </th></tr></thead>
489
+ <tbody><tr><td>
490
+
491
+ layer
492
+
493
+ </td><td>
494
+
495
+ [TPCB\_LayersOfRegion](../types/TPCB_LayersOfRegion.md)
496
+
497
+ </td><td>
498
+
499
+ _(Optional)_ Layer
500
+
501
+ </td></tr>
502
+ <tr><td>
503
+
504
+ ruleType
505
+
506
+ </td><td>
507
+
508
+ Array&lt;[EPCB\_PrimitiveRegionRuleType](../enums/EPCB_PrimitiveRegionRuleType.md)<!-- -->&gt;
509
+
510
+ </td><td>
511
+
512
+ _(Optional)_ Region rule type. Only primitives whose rule types are all consistent will be matched
513
+
514
+ </td></tr>
515
+ <tr><td>
516
+
517
+ primitiveLock
518
+
519
+ </td><td>
520
+
521
+ boolean
522
+
523
+ </td><td>
524
+
525
+ _(Optional)_ Whether it is locked
526
+
527
+ </td></tr>
528
+ </tbody></table>
529
+
530
+ ## Returns
531
+
532
+ Promise&lt;Array&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md)<!-- -->&gt;&gt;
533
+
534
+ Array of Region primitive objects
535
+
536
+ ## Example
537
+
538
+ ```javascript
539
+ // 1. 创建一个顶层测试区域作为过滤目标:规则 [2] 即禁止元件(随机坐标避免重合)
540
+ const x = 2000 + Math.floor(Math.random() * 100000);
541
+ const y = 2000 + Math.floor(Math.random() * 100000);
542
+ const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
543
+ const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2], '嘉立创示例_过滤目标');
544
+ const regionId = region.getState_PrimitiveId();
545
+
546
+ // 2. 不带参数:获取 PCB 上全部区域
547
+ const all = await eda.pcb_PrimitiveRegion.getAll();
548
+
549
+ // 3. 按层过滤:只取顶层(1)的区域
550
+ const topLayer = await eda.pcb_PrimitiveRegion.getAll(1);
551
+
552
+ // 4. 按规则类型过滤:只取规则为 [2](禁止元件)的区域,要求规则完全一致
553
+ const noComponents = await eda.pcb_PrimitiveRegion.getAll(undefined, [2]);
554
+
555
+ // 5. 清理测试图元(查询类需要清理)
556
+ await eda.pcb_PrimitiveRegion.delete([regionId]);
557
+
558
+ console.log('total regions:', all.length);
559
+ console.log('top layer regions:', topLayer.length);
560
+ console.log('no-component regions:', noComponents.length);
561
+ console.log('marker region found:', noComponents.some(r => r.getState_PrimitiveId() === regionId));
562
+ ```
563
+
564
+ ### getallprimitiveid
565
+
566
+ # PCB\_PrimitiveRegion.getAllPrimitiveId() method
567
+
568
+ > 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.
569
+
570
+ Get all Region primitive IDs
571
+
572
+ ## Signature
573
+
574
+ ```typescript
575
+ function getAllPrimitiveId(
576
+ layer?: TPCB_LayersOfRegion,
577
+ ruleType?: Array<EPCB_PrimitiveRegionRuleType>,
578
+ primitiveLock?: boolean,
579
+ ): Promise<Array<string>>;
580
+ ```
581
+
582
+ ## Parameters
583
+
584
+ <table><thead><tr><th>
585
+
586
+ Parameter
587
+
588
+ </th><th>
589
+
590
+ Type
591
+
592
+ </th><th>
593
+
594
+ Description
595
+
596
+ </th></tr></thead>
597
+ <tbody><tr><td>
598
+
599
+ layer
600
+
601
+ </td><td>
602
+
603
+ [TPCB\_LayersOfRegion](../types/TPCB_LayersOfRegion.md)
604
+
605
+ </td><td>
606
+
607
+ _(Optional)_ Layer
608
+
609
+ </td></tr>
610
+ <tr><td>
611
+
612
+ ruleType
613
+
614
+ </td><td>
615
+
616
+ Array&lt;[EPCB\_PrimitiveRegionRuleType](../enums/EPCB_PrimitiveRegionRuleType.md)<!-- -->&gt;
617
+
618
+ </td><td>
619
+
620
+ _(Optional)_ Region rule type. Only primitives whose rule types are all consistent will be matched
621
+
622
+ </td></tr>
623
+ <tr><td>
624
+
625
+ primitiveLock
626
+
627
+ </td><td>
628
+
629
+ boolean
630
+
631
+ </td><td>
632
+
633
+ _(Optional)_ Whether it is locked
634
+
635
+ </td></tr>
636
+ </tbody></table>
637
+
638
+ ## Returns
639
+
640
+ Promise&lt;Array&lt;string&gt;&gt;
641
+
642
+ Array of Region primitive IDs
643
+
644
+ ## Example
645
+
646
+ ```javascript
647
+ // 1. 创建一个顶层测试区域作为查找目标:规则 [2] 即禁止元件(随机坐标避免重合)
648
+ const x = 2000 + Math.floor(Math.random() * 100000);
649
+ const y = 2000 + Math.floor(Math.random() * 100000);
650
+ const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
651
+ const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2], '嘉立创示例_ID查找目标');
652
+ const regionId = region.getState_PrimitiveId();
653
+
654
+ // 2. 获取全部区域的图元 ID
655
+ const allIds = await eda.pcb_PrimitiveRegion.getAllPrimitiveId();
656
+
657
+ // 3. 按层 + 规则类型过滤:只取顶层(1)禁止元件([2])区域的图元 ID
658
+ const filteredIds = await eda.pcb_PrimitiveRegion.getAllPrimitiveId(1, [2]);
659
+
660
+ // 4. 清理测试图元(查询类需要清理)
661
+ await eda.pcb_PrimitiveRegion.delete([regionId]);
662
+
663
+ console.log('total region ids:', allIds.length);
664
+ console.log('filtered region ids:', filteredIds.length);
665
+ console.log('marker id in filtered list:', filteredIds.includes(regionId));
666
+ ```
667
+
668
+ ### modify
669
+
670
+ # PCB\_PrimitiveRegion.modify() method
671
+
672
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
673
+
674
+ Modify Region
675
+
676
+ ## Signature
677
+
678
+ ```typescript
679
+ function modify(
680
+ primitiveId: string | IPCB_PrimitiveRegion,
681
+ property: {
682
+ layer?:
683
+ | undefined
684
+ | EPCB_LayerId.TOP
685
+ | EPCB_LayerId.BOTTOM
686
+ | EPCB_LayerId.MULTI
687
+ | EPCB_LayerId.INNER_1
688
+ | EPCB_LayerId.INNER_2
689
+ | EPCB_LayerId.INNER_3
690
+ | EPCB_LayerId.INNER_4
691
+ | EPCB_LayerId.INNER_5
692
+ | EPCB_LayerId.INNER_6
693
+ | EPCB_LayerId.INNER_7
694
+ | EPCB_LayerId.INNER_8
695
+ | EPCB_LayerId.INNER_9
696
+ | EPCB_LayerId.INNER_10
697
+ | EPCB_LayerId.INNER_11
698
+ | EPCB_LayerId.INNER_12
699
+ | EPCB_LayerId.INNER_13
700
+ | EPCB_LayerId.INNER_14
701
+ | EPCB_LayerId.INNER_15
702
+ | EPCB_LayerId.INNER_16
703
+ | EPCB_LayerId.INNER_17
704
+ | EPCB_LayerId.INNER_18
705
+ | EPCB_LayerId.INNER_19
706
+ | EPCB_LayerId.INNER_20
707
+ | EPCB_LayerId.INNER_21
708
+ | EPCB_LayerId.INNER_22
709
+ | EPCB_LayerId.INNER_23
710
+ | EPCB_LayerId.INNER_24
711
+ | EPCB_LayerId.INNER_25
712
+ | EPCB_LayerId.INNER_26
713
+ | EPCB_LayerId.INNER_27
714
+ | EPCB_LayerId.INNER_28
715
+ | EPCB_LayerId.INNER_29
716
+ | EPCB_LayerId.INNER_30;
717
+ complexPolygon?: undefined | IPCB_Polygon;
718
+ ruleType?: undefined | EPCB_PrimitiveRegionRuleType[];
719
+ regionName?: undefined | string;
720
+ lineWidth?: undefined | number;
721
+ primitiveLock?: undefined | false | true;
722
+ },
723
+ ): Promise<IPCB_PrimitiveRegion | undefined>;
724
+ ```
725
+
726
+ ## Parameters
727
+
728
+ <table><thead><tr><th>
729
+
730
+ Parameter
731
+
732
+ </th><th>
733
+
734
+ Type
735
+
736
+ </th><th>
737
+
738
+ Description
739
+
740
+ </th></tr></thead>
741
+ <tbody><tr><td>
742
+
743
+ primitiveId
744
+
745
+ </td><td>
746
+
747
+ string \| [IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md)
748
+
749
+ </td><td>
750
+
751
+ Primitive ID
752
+
753
+ </td></tr>
754
+ <tr><td>
755
+
756
+ property
757
+
758
+ </td><td>
759
+
760
+ { layer?: undefined \| [EPCB\_LayerId.TOP](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.MULTI](../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)<!-- -->; complexPolygon?: undefined \| [IPCB\_Polygon](./IPCB_Polygon.md)<!-- -->; ruleType?: undefined \| [EPCB\_PrimitiveRegionRuleType](../enums/EPCB_PrimitiveRegionRuleType.md)<!-- -->\[\]; regionName?: undefined \| string; lineWidth?: undefined \| number; primitiveLock?: undefined \| false \| true }
761
+
762
+ </td><td>
763
+
764
+ Modify Parameter
765
+
766
+ </td></tr>
767
+ </tbody></table>
768
+
769
+ ## Returns
770
+
771
+ Promise&lt;[IPCB\_PrimitiveRegion](./IPCB_PrimitiveRegion.md) \| undefined&gt;
772
+
773
+ Region primitive object, `undefined` indicates that the modification failed
774
+
775
+ ## Example
776
+
777
+ ```javascript
778
+ // 1. 创建待修改的测试区域:顶层,规则 [2] 即禁止元件(随机坐标避免重合)
779
+ const x = 2000 + Math.floor(Math.random() * 100000);
780
+ const y = 2000 + Math.floor(Math.random() * 100000);
781
+ const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
782
+ const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2], '嘉立创示例_待修改');
783
+ const regionId = region.getState_PrimitiveId();
784
+
785
+ // 2. 读取修改前的层与规则类型
786
+ const beforeLayer = region.getState_Layer();
787
+ const beforeRuleType = region.getState_RuleType();
788
+
789
+ // 3. 批量修改:层从顶层(1)换到底层(2),规则 [2] 禁止元件扩展为 [2, 5] 禁止元件 + 禁止布线
790
+ await eda.pcb_PrimitiveRegion.modify(regionId, { layer: 2, ruleType: [2, 5] });
791
+
792
+ // 4. modify 返回后需要重新 get() 才能读到画布上的最新值
793
+ const refreshed = await eda.pcb_PrimitiveRegion.get(regionId);
794
+
795
+ // 5. 修改类保留现场,供观察修改结果
796
+ console.log('primitiveId:', regionId);
797
+ console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
798
+ console.log('ruleType:', JSON.stringify(beforeRuleType), '→', JSON.stringify(refreshed.getState_RuleType()));
799
+ ```