@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,535 +1,541 @@
1
- # SYS\_IFrame class
2
-
3
- System / iframe window class
4
-
5
- ## Signature
6
-
7
- ```typescript
8
- class SYS_IFrame
9
- ```
10
-
11
- ## Remarks
12
-
13
- ## Methods
14
-
15
- <table><thead><tr><th>
16
-
17
- Method
18
-
19
- </th><th>
20
-
21
- Modifiers
22
-
23
- </th><th>
24
-
25
- Description
26
-
27
- </th></tr></thead>
28
- <tbody><tr><td>
29
-
30
- [closeIFrame(id)](./SYS_IFrame.md)
31
-
32
- </td><td>
33
-
34
- </td><td>
35
-
36
- **_(BETA)_** Close iframe window
37
-
38
- </td></tr>
39
- <tr><td>
40
-
41
- [hideIFrame(id)](./SYS_IFrame.md)
42
-
43
- </td><td>
44
-
45
- </td><td>
46
-
47
- **_(BETA)_** Hide iframe window
48
-
49
- </td></tr>
50
- <tr><td>
51
-
52
- [isIFrameAlreadyExist(id)](./SYS_IFrame.md)
53
-
54
- </td><td>
55
-
56
- </td><td>
57
-
58
- **_(BETA)_** Whether the iframe already exists
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- [openIFrame(htmlFileName, width, height, id, props)](./SYS_IFrame.md)
64
-
65
- </td><td>
66
-
67
- </td><td>
68
-
69
- **_(BETA)_** Open iframe window
70
-
71
- </td></tr>
72
- <tr><td>
73
-
74
- [showIFrame(id)](./SYS_IFrame.md)
75
-
76
- </td><td>
77
-
78
- </td><td>
79
-
80
- **_(BETA)_** Show iframe window
81
-
82
- </td></tr>
83
- </tbody></table>
84
-
85
- ---
86
-
87
- ## 方法详情
88
-
89
- ### closeiframe
90
-
91
- # SYS\_IFrame.closeIFrame() method
92
-
93
- > 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.
94
-
95
- Close iframe window
96
-
97
- ## Signature
98
-
99
- ```typescript
100
- function closeIFrame(id?: string): Promise<boolean>;
101
- ```
102
-
103
- ## Parameters
104
-
105
- <table><thead><tr><th>
106
-
107
- Parameter
108
-
109
- </th><th>
110
-
111
- Type
112
-
113
- </th><th>
114
-
115
- Description
116
-
117
- </th></tr></thead>
118
- <tbody><tr><td>
119
-
120
- id
121
-
122
- </td><td>
123
-
124
- string
125
-
126
- </td><td>
127
-
128
- _(Optional)_ Iframe window ID. If not passed in, all iframe windows opened by this extension will be closed
129
-
130
- </td></tr>
131
- </tbody></table>
132
-
133
- ## Returns
134
-
135
- Promise&lt;boolean&gt;
136
-
137
- Whether the operation is successful
138
-
139
- ## Remarks
140
-
141
- Close the iframe window with the specified ID
142
-
143
- Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
144
-
145
- ## Example
146
-
147
- ```javascript
148
- // 1. 打开两个内联框架窗口(自建 fixture,演示按 ID 定向关闭)
149
- await eda.sys_IFrame.openIFrame('/extension.json', 300, 200, '嘉立创示例_窗口A', { title: '嘉立创示例 窗口A' });
150
- await eda.sys_IFrame.openIFrame('/extension.json', 300, 200, '嘉立创示例_窗口B', { title: '嘉立创示例 窗口B' });
151
- console.log('已打开两个窗口:嘉立创示例_窗口A / 嘉立创示例_窗口B');
152
-
153
- // 2. 按 ID 关闭指定窗口
154
- const closedById = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口A');
155
- console.log('按 ID 关闭窗口 A 结果:', closedById);
156
-
157
- // 3. 不传 id,关闭本扩展打开的全部剩余窗口(清理窗口 B,还原界面)
158
- const closedAll = await eda.sys_IFrame.closeIFrame();
159
- console.log('关闭全部剩余窗口结果:', closedAll);
160
-
161
- // 4. 对已不存在的窗口再关闭一次,验证幂等语义(返回 true 而非 false)
162
- const closedAgain = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口A');
163
- console.log('重复关闭已关窗口结果:', closedAgain);
164
- ```
165
-
166
- ### hideiframe
167
-
168
- # SYS\_IFrame.hideIFrame() method
169
-
170
- > 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.
171
-
172
- Hide iframe window
173
-
174
- ## Signature
175
-
176
- ```typescript
177
- function hideIFrame(id?: string): Promise<boolean>;
178
- ```
179
-
180
- ## Parameters
181
-
182
- <table><thead><tr><th>
183
-
184
- Parameter
185
-
186
- </th><th>
187
-
188
- Type
189
-
190
- </th><th>
191
-
192
- Description
193
-
194
- </th></tr></thead>
195
- <tbody><tr><td>
196
-
197
- id
198
-
199
- </td><td>
200
-
201
- string
202
-
203
- </td><td>
204
-
205
- _(Optional)_ Iframe window ID. If not passed in, all iframe windows associated with the extension will be hidden
206
-
207
- </td></tr>
208
- </tbody></table>
209
-
210
- ## Returns
211
-
212
- Promise&lt;boolean&gt;
213
-
214
- Whether the operation is successful
215
-
216
- ## Remarks
217
-
218
- This API is result-oriented: If the specified iframe window is not found, the API returns `false`<!-- -->; if the iframe window was already hidden before the operation, the API returns `true`
219
-
220
- Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
221
-
222
- ## Example
223
-
224
- ```javascript
225
- // 1. 打开一个内联框架窗口(自建 fixture)
226
- const opened = await eda.sys_IFrame.openIFrame('/extension.json', 320, 200, '嘉立创示例_隐藏演示', {
227
- title: '嘉立创示例 隐藏演示窗口',
228
- });
229
- console.log('打开结果:', opened);
230
-
231
- // 2. 隐藏该窗口(窗口从界面消失,但未被销毁)
232
- const hidden = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
233
- console.log('隐藏结果:', hidden);
234
-
235
- // 3. 对已隐藏的窗口再次隐藏,验证幂等语义(返回 true)
236
- const hideAgain = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
237
- console.log('重复隐藏结果:', hideAgain);
238
-
239
- // 4. 对不存在的窗口 ID 隐藏,结果导向返回 false(不抛错)
240
- const hideMissing = await eda.sys_IFrame.hideIFrame('嘉立创示例_不存在的窗口');
241
- console.log('不存在的窗口 ID →', hideMissing);
242
-
243
- // 5. 关闭隐藏状态的窗口还原界面(隐藏的窗口可直接关闭)
244
- const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_隐藏演示');
245
- console.log('关闭隐藏窗口结果:', closed);
246
- ```
247
-
248
- ### isiframealreadyexist
249
-
250
- # SYS\_IFrame.isIFrameAlreadyExist() method
251
-
252
- > 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.
253
-
254
- Whether the iframe already exists
255
-
256
- ## Signature
257
-
258
- ```typescript
259
- function isIFrameAlreadyExist(id: string): Promise<boolean>;
260
- ```
261
-
262
- ## Parameters
263
-
264
- <table><thead><tr><th>
265
-
266
- Parameter
267
-
268
- </th><th>
269
-
270
- Type
271
-
272
- </th><th>
273
-
274
- Description
275
-
276
- </th></tr></thead>
277
- <tbody><tr><td>
278
-
279
- id
280
-
281
- </td><td>
282
-
283
- string
284
-
285
- </td><td>
286
-
287
- Iframe ID
288
-
289
- </td></tr>
290
- </tbody></table>
291
-
292
- ## Returns
293
-
294
- Promise&lt;boolean&gt;
295
-
296
- Whether Exists
297
-
298
- ## Remarks
299
-
300
- Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error` ADD since EDA v4.2
301
-
302
- ### openiframe
303
-
304
- # SYS\_IFrame.openIFrame() method
305
-
306
- > 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.
307
-
308
- Open iframe window
309
-
310
- ## Signature
311
-
312
- ```typescript
313
- function openIFrame(
314
- htmlFileName: string,
315
- width?: number,
316
- height?: number,
317
- id?: string,
318
- props?: {
319
- maximizeButton?: undefined | false | true;
320
- minimizeButton?: undefined | false | true;
321
- minimizeStyle?: undefined | 'collapsed' | 'constricted';
322
- buttonCallbackFn?:
323
- undefined | ((button: 'close' | 'minimize' | 'maximize') => void | Promise<void>);
324
- onBeforeCloseCallFn?:
325
- undefined | (() => boolean | undefined | Promise<boolean | undefined>);
326
- grayscaleMask?: undefined | false | true;
327
- title?: undefined | string;
328
- x?: undefined | number;
329
- y?: undefined | number;
330
- },
331
- ): Promise<boolean>;
332
- ```
333
-
334
- ## Parameters
335
-
336
- <table><thead><tr><th>
337
-
338
- Parameter
339
-
340
- </th><th>
341
-
342
- Type
343
-
344
- </th><th>
345
-
346
- Description
347
-
348
- </th></tr></thead>
349
- <tbody><tr><td>
350
-
351
- htmlFileName
352
-
353
- </td><td>
354
-
355
- string
356
-
357
- </td><td>
358
-
359
- The path of the HTML file to load within the extension package, starting from the extension root directory, e.g. `/iframe/index.html`
360
-
361
- </td></tr>
362
- <tr><td>
363
-
364
- width
365
-
366
- </td><td>
367
-
368
- number
369
-
370
- </td><td>
371
-
372
- _(Optional)_ Width of the iframe window
373
-
374
- </td></tr>
375
- <tr><td>
376
-
377
- height
378
-
379
- </td><td>
380
-
381
- number
382
-
383
- </td><td>
384
-
385
- _(Optional)_ Height of the iframe window
386
-
387
- </td></tr>
388
- <tr><td>
389
-
390
- id
391
-
392
- </td><td>
393
-
394
- string
395
-
396
- </td><td>
397
-
398
- _(Optional)_ Iframe window ID, used to close the iframe window
399
-
400
- </td></tr>
401
- <tr><td>
402
-
403
- props
404
-
405
- </td><td>
406
-
407
- { maximizeButton?: undefined \| false \| true; minimizeButton?: undefined \| false \| true; minimizeStyle?: undefined \| 'collapsed' \| 'constricted'; buttonCallbackFn?: undefined \| ((button: 'close' \| 'minimize' \| 'maximize') =&gt; void \| Promise&lt;void&gt;); onBeforeCloseCallFn?: undefined \| (() =&gt; boolean \| undefined \| Promise&lt;boolean \| undefined&gt;); grayscaleMask?: undefined \| false \| true; title?: undefined \| string; x?: undefined \| number; y?: undefined \| number }
408
-
409
- </td><td>
410
-
411
- _(Optional)_ Other parameters
412
-
413
- </td></tr>
414
- </tbody></table>
415
-
416
- ## Returns
417
-
418
- Promise&lt;boolean&gt;
419
-
420
- Whether the operation is successful
421
-
422
- ## Remarks
423
-
424
- This API can only be called by extension packages. Users need to include an HTML file for embedding in the extension package;
425
-
426
- After this API is called, a Dialog window will open. The title of the Dialog window is the `<title>` of the HTML file, and the title bar has a close button;
427
-
428
- The body is an iframe. `width` and `height` are the width and height of the iframe in the body;
429
-
430
- The iframe needs to display the content of `htmlFileName`<!-- -->. This HTML is obtained from the extension package and has been stored in IndexedDB during installation
431
-
432
- Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
433
-
434
- ## Example
435
-
436
- ```javascript
437
- // 1. 打开一个带标题和最大化/最小化按钮的内联框架窗口(自建 ID 便于后续定位)
438
- const opened = await eda.sys_IFrame.openIFrame('/extension.json', 360, 240, '嘉立创示例_窗口', {
439
- title: '嘉立创示例 内联框架窗口',
440
- minimizeButton: true,
441
- maximizeButton: true,
442
- grayscaleMask: false,
443
- });
444
- console.log('打开结果:', opened);
445
-
446
- // 2. 关闭刚才打开的窗口还原界面(自建自删,保证案例可重复运行)
447
- const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口');
448
- console.log('关闭结果:', closed);
449
- ```
450
-
451
- ### showiframe
452
-
453
- # SYS\_IFrame.showIFrame() method
454
-
455
- > 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.
456
-
457
- Show iframe window
458
-
459
- ## Signature
460
-
461
- ```typescript
462
- function showIFrame(id?: string): Promise<boolean>;
463
- ```
464
-
465
- ## Parameters
466
-
467
- <table><thead><tr><th>
468
-
469
- Parameter
470
-
471
- </th><th>
472
-
473
- Type
474
-
475
- </th><th>
476
-
477
- Description
478
-
479
- </th></tr></thead>
480
- <tbody><tr><td>
481
-
482
- id
483
-
484
- </td><td>
485
-
486
- string
487
-
488
- </td><td>
489
-
490
- _(Optional)_ Iframe window ID. If not passed in, all iframe windows associated with the extension will be shown
491
-
492
- </td></tr>
493
- </tbody></table>
494
-
495
- ## Returns
496
-
497
- Promise&lt;boolean&gt;
498
-
499
- Whether the operation is successful
500
-
501
- ## Remarks
502
-
503
- This API is result-oriented: If the specified iframe window is not found, the API returns `false`<!-- -->; if the iframe window was already in the shown state before the operation, the API returns `true`
504
-
505
- Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
506
-
507
- ## Example
508
-
509
- ```javascript
510
- // 1. 打开一个内联框架窗口(自建 fixture)
511
- const opened = await eda.sys_IFrame.openIFrame('/extension.json', 320, 200, '嘉立创示例_显示演示', {
512
- title: '嘉立创示例 显示演示窗口',
513
- });
514
- console.log('打开结果:', opened);
515
-
516
- // 2. 先隐藏窗口,制造"待恢复"状态
517
- await eda.sys_IFrame.hideIFrame('嘉立创示例_显示演示');
518
- console.log('已隐藏窗口,准备恢复显示');
519
-
520
- // 3. 显示该窗口(从隐藏状态恢复,界面重新可见)
521
- const shown = await eda.sys_IFrame.showIFrame('嘉立创示例_显示演示');
522
- console.log('显示结果:', shown);
523
-
524
- // 4. 对已显示的窗口再次显示,验证幂等语义(返回 true)
525
- const showAgain = await eda.sys_IFrame.showIFrame('嘉立创示例_显示演示');
526
- console.log('重复显示结果:', showAgain);
527
-
528
- // 5. 对不存在的窗口 ID 显示,结果导向返回 false(不抛错)
529
- const showMissing = await eda.sys_IFrame.showIFrame('嘉立创示例_不存在的窗口');
530
- console.log('不存在的窗口 ID →', showMissing);
531
-
532
- // 6. 关闭窗口还原界面
533
- const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_显示演示');
534
- console.log('关闭结果:', closed);
535
- ```
1
+ # SYS\_IFrame class
2
+
3
+ System / iframe window class
4
+
5
+ ## Signature
6
+
7
+ ```typescript
8
+ class SYS_IFrame
9
+ ```
10
+
11
+ ## Remarks
12
+
13
+ ## Methods
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Method
18
+
19
+ </th><th>
20
+
21
+ Modifiers
22
+
23
+ </th><th>
24
+
25
+ Description
26
+
27
+ </th></tr></thead>
28
+ <tbody><tr><td>
29
+
30
+ [closeIFrame(id)](./SYS_IFrame.md)
31
+
32
+ </td><td>
33
+
34
+ </td><td>
35
+
36
+ **_(BETA)_** Close iframe window
37
+
38
+ </td></tr>
39
+ <tr><td>
40
+
41
+ [hideIFrame(id)](./SYS_IFrame.md)
42
+
43
+ </td><td>
44
+
45
+ </td><td>
46
+
47
+ **_(BETA)_** Hide iframe window
48
+
49
+ </td></tr>
50
+ <tr><td>
51
+
52
+ [isIFrameAlreadyExist(id)](./SYS_IFrame.md)
53
+
54
+ </td><td>
55
+
56
+ </td><td>
57
+
58
+ **_(BETA)_** Whether the iframe already exists
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ [openIFrame(htmlFileName, width, height, id, props)](./SYS_IFrame.md)
64
+
65
+ </td><td>
66
+
67
+ </td><td>
68
+
69
+ **_(BETA)_** Open iframe window
70
+
71
+ </td></tr>
72
+ <tr><td>
73
+
74
+ [showIFrame(id)](./SYS_IFrame.md)
75
+
76
+ </td><td>
77
+
78
+ </td><td>
79
+
80
+ **_(BETA)_** Show iframe window
81
+
82
+ </td></tr>
83
+ </tbody></table>
84
+
85
+ ---
86
+
87
+ ## 方法详情
88
+
89
+ ### closeiframe
90
+
91
+ # SYS\_IFrame.closeIFrame() method
92
+
93
+ > 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.
94
+
95
+ Close iframe window
96
+
97
+ ## Signature
98
+
99
+ ```typescript
100
+ function closeIFrame(id?: string): Promise<boolean>;
101
+ ```
102
+
103
+ ## Parameters
104
+
105
+ <table><thead><tr><th>
106
+
107
+ Parameter
108
+
109
+ </th><th>
110
+
111
+ Type
112
+
113
+ </th><th>
114
+
115
+ Description
116
+
117
+ </th></tr></thead>
118
+ <tbody><tr><td>
119
+
120
+ id
121
+
122
+ </td><td>
123
+
124
+ string
125
+
126
+ </td><td>
127
+
128
+ _(Optional)_ Iframe window ID. If not passed in, all iframe windows opened by this extension will be closed
129
+
130
+ </td></tr>
131
+ </tbody></table>
132
+
133
+ ## Returns
134
+
135
+ Promise&lt;boolean&gt;
136
+
137
+ Whether the operation is successful
138
+
139
+ ## Remarks
140
+
141
+ Close the iframe window with the specified ID
142
+
143
+ Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
144
+
145
+ 控制其它扩展打开的内联框架窗口时,`id` 需传入完整 ID 格式:`<其它扩展UUID>.<窗口ID>`<!-- -->(点分隔,窗口 ID 为打开时传入的 `id` 参数)
146
+
147
+ ## Example
148
+
149
+ ```javascript
150
+ // 1. 打开两个内联框架窗口(自建 fixture,演示按 ID 定向关闭)
151
+ await eda.sys_IFrame.openIFrame('/extension.json', 300, 200, '嘉立创示例_窗口A', { title: '嘉立创示例 窗口A' });
152
+ await eda.sys_IFrame.openIFrame('/extension.json', 300, 200, '嘉立创示例_窗口B', { title: '嘉立创示例 窗口B' });
153
+ console.log('已打开两个窗口:嘉立创示例_窗口A / 嘉立创示例_窗口B');
154
+
155
+ // 2. 按 ID 关闭指定窗口
156
+ const closedById = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口A');
157
+ console.log('按 ID 关闭窗口 A 结果:', closedById);
158
+
159
+ // 3. 不传 id,关闭本扩展打开的全部剩余窗口(清理窗口 B,还原界面)
160
+ const closedAll = await eda.sys_IFrame.closeIFrame();
161
+ console.log('关闭全部剩余窗口结果:', closedAll);
162
+
163
+ // 4. 对已不存在的窗口再关闭一次,验证幂等语义(返回 true 而非 false)
164
+ const closedAgain = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口A');
165
+ console.log('重复关闭已关窗口结果:', closedAgain);
166
+ ```
167
+
168
+ ### hideiframe
169
+
170
+ # SYS\_IFrame.hideIFrame() method
171
+
172
+ > 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.
173
+
174
+ Hide iframe window
175
+
176
+ ## Signature
177
+
178
+ ```typescript
179
+ function hideIFrame(id?: string): Promise<boolean>;
180
+ ```
181
+
182
+ ## Parameters
183
+
184
+ <table><thead><tr><th>
185
+
186
+ Parameter
187
+
188
+ </th><th>
189
+
190
+ Type
191
+
192
+ </th><th>
193
+
194
+ Description
195
+
196
+ </th></tr></thead>
197
+ <tbody><tr><td>
198
+
199
+ id
200
+
201
+ </td><td>
202
+
203
+ string
204
+
205
+ </td><td>
206
+
207
+ _(Optional)_ Iframe window ID. If not passed in, all iframe windows associated with the extension will be hidden
208
+
209
+ </td></tr>
210
+ </tbody></table>
211
+
212
+ ## Returns
213
+
214
+ Promise&lt;boolean&gt;
215
+
216
+ Whether the operation is successful
217
+
218
+ ## Remarks
219
+
220
+ This API is result-oriented: If the specified iframe window is not found, the API returns `false`<!-- -->; if the iframe window was already hidden before the operation, the API returns `true`
221
+
222
+ Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
223
+
224
+ 控制其它扩展打开的内联框架窗口时,`id` 需传入完整 ID 格式:`<其它扩展UUID>.<窗口ID>`<!-- -->(点分隔,窗口 ID 为打开时传入的 `id` 参数)
225
+
226
+ ## Example
227
+
228
+ ```javascript
229
+ // 1. 打开一个内联框架窗口(自建 fixture)
230
+ const opened = await eda.sys_IFrame.openIFrame('/extension.json', 320, 200, '嘉立创示例_隐藏演示', {
231
+ title: '嘉立创示例 隐藏演示窗口',
232
+ });
233
+ console.log('打开结果:', opened);
234
+
235
+ // 2. 隐藏该窗口(窗口从界面消失,但未被销毁)
236
+ const hidden = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
237
+ console.log('隐藏结果:', hidden);
238
+
239
+ // 3. 对已隐藏的窗口再次隐藏,验证幂等语义(返回 true)
240
+ const hideAgain = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
241
+ console.log('重复隐藏结果:', hideAgain);
242
+
243
+ // 4. 对不存在的窗口 ID 隐藏,结果导向返回 false(不抛错)
244
+ const hideMissing = await eda.sys_IFrame.hideIFrame('嘉立创示例_不存在的窗口');
245
+ console.log('不存在的窗口 ID →', hideMissing);
246
+
247
+ // 5. 关闭隐藏状态的窗口还原界面(隐藏的窗口可直接关闭)
248
+ const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_隐藏演示');
249
+ console.log('关闭隐藏窗口结果:', closed);
250
+ ```
251
+
252
+ ### isiframealreadyexist
253
+
254
+ # SYS\_IFrame.isIFrameAlreadyExist() method
255
+
256
+ > 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.
257
+
258
+ Whether the iframe already exists
259
+
260
+ ## Signature
261
+
262
+ ```typescript
263
+ function isIFrameAlreadyExist(id: string): Promise<boolean>;
264
+ ```
265
+
266
+ ## Parameters
267
+
268
+ <table><thead><tr><th>
269
+
270
+ Parameter
271
+
272
+ </th><th>
273
+
274
+ Type
275
+
276
+ </th><th>
277
+
278
+ Description
279
+
280
+ </th></tr></thead>
281
+ <tbody><tr><td>
282
+
283
+ id
284
+
285
+ </td><td>
286
+
287
+ string
288
+
289
+ </td><td>
290
+
291
+ Iframe ID
292
+
293
+ </td></tr>
294
+ </tbody></table>
295
+
296
+ ## Returns
297
+
298
+ Promise&lt;boolean&gt;
299
+
300
+ Whether Exists
301
+
302
+ ## Remarks
303
+
304
+ Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
305
+
306
+ 控制其它扩展打开的内联框架窗口时,`id` 需传入完整 ID 格式:`<其它扩展UUID>.<窗口ID>`<!-- -->(点分隔,窗口 ID 为打开时传入的 `id` 参数) ADD since EDA v4.2
307
+
308
+ ### openiframe
309
+
310
+ # SYS\_IFrame.openIFrame() method
311
+
312
+ > 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.
313
+
314
+ Open iframe window
315
+
316
+ ## Signature
317
+
318
+ ```typescript
319
+ function openIFrame(
320
+ htmlFileName: string,
321
+ width?: number,
322
+ height?: number,
323
+ id?: string,
324
+ props?: {
325
+ maximizeButton?: boolean;
326
+ minimizeButton?: boolean;
327
+ minimizeStyle?: 'collapsed' | 'constricted';
328
+ buttonCallbackFn?: (button: 'close' | 'minimize' | 'maximize') => void | Promise<void>;
329
+ onBeforeCloseCallFn?: () => boolean | undefined | Promise<boolean | undefined>;
330
+ grayscaleMask?: boolean;
331
+ title?: string;
332
+ x?: number;
333
+ y?: number;
334
+ },
335
+ ): Promise<boolean>;
336
+ ```
337
+
338
+ ## Parameters
339
+
340
+ <table><thead><tr><th>
341
+
342
+ Parameter
343
+
344
+ </th><th>
345
+
346
+ Type
347
+
348
+ </th><th>
349
+
350
+ Description
351
+
352
+ </th></tr></thead>
353
+ <tbody><tr><td>
354
+
355
+ htmlFileName
356
+
357
+ </td><td>
358
+
359
+ string
360
+
361
+ </td><td>
362
+
363
+ The path of the HTML file to load within the extension package, starting from the extension root directory, e.g. `/iframe/index.html`
364
+
365
+ </td></tr>
366
+ <tr><td>
367
+
368
+ width
369
+
370
+ </td><td>
371
+
372
+ number
373
+
374
+ </td><td>
375
+
376
+ _(Optional)_ Width of the iframe window
377
+
378
+ </td></tr>
379
+ <tr><td>
380
+
381
+ height
382
+
383
+ </td><td>
384
+
385
+ number
386
+
387
+ </td><td>
388
+
389
+ _(Optional)_ Height of the iframe window
390
+
391
+ </td></tr>
392
+ <tr><td>
393
+
394
+ id
395
+
396
+ </td><td>
397
+
398
+ string
399
+
400
+ </td><td>
401
+
402
+ _(Optional)_ Iframe window ID, used to close the iframe window
403
+
404
+ </td></tr>
405
+ <tr><td>
406
+
407
+ props
408
+
409
+ </td><td>
410
+
411
+ { maximizeButton?: boolean; minimizeButton?: boolean; minimizeStyle?: 'collapsed' \| 'constricted'; buttonCallbackFn?: (button: 'close' \| 'minimize' \| 'maximize') =&gt; void \| Promise&lt;void&gt;; onBeforeCloseCallFn?: () =&gt; boolean \| undefined \| Promise&lt;boolean \| undefined&gt;; grayscaleMask?: boolean; title?: string; x?: number; y?: number; }
412
+
413
+ </td><td>
414
+
415
+ _(Optional)_ Other parameters
416
+
417
+ </td></tr>
418
+ </tbody></table>
419
+
420
+ ## Returns
421
+
422
+ Promise&lt;boolean&gt;
423
+
424
+ Whether the operation is successful
425
+
426
+ ## Remarks
427
+
428
+ This API can only be called by extension packages. Users need to include an HTML file for embedding in the extension package;
429
+
430
+ After this API is called, a Dialog window will open. The title of the Dialog window is the `<title>` of the HTML file, and the title bar has a close button;
431
+
432
+ The body is an iframe. `width` and `height` are the width and height of the iframe in the body;
433
+
434
+ The iframe needs to display the content of `htmlFileName`<!-- -->. This HTML is obtained from the extension package and has been stored in IndexedDB during installation
435
+
436
+ Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
437
+
438
+ ## Example
439
+
440
+ ```javascript
441
+ // 1. 打开一个带标题和最大化/最小化按钮的内联框架窗口(自建 ID 便于后续定位)
442
+ const opened = await eda.sys_IFrame.openIFrame('/extension.json', 360, 240, '嘉立创示例_窗口', {
443
+ title: '嘉立创示例 内联框架窗口',
444
+ minimizeButton: true,
445
+ maximizeButton: true,
446
+ grayscaleMask: false,
447
+ });
448
+ console.log('打开结果:', opened);
449
+
450
+ // 2. 关闭刚才打开的窗口还原界面(自建自删,保证案例可重复运行)
451
+ const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_窗口');
452
+ console.log('关闭结果:', closed);
453
+ ```
454
+
455
+ ### showiframe
456
+
457
+ # SYS\_IFrame.showIFrame() method
458
+
459
+ > 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.
460
+
461
+ Show iframe window
462
+
463
+ ## Signature
464
+
465
+ ```typescript
466
+ function showIFrame(id?: string): Promise<boolean>;
467
+ ```
468
+
469
+ ## Parameters
470
+
471
+ <table><thead><tr><th>
472
+
473
+ Parameter
474
+
475
+ </th><th>
476
+
477
+ Type
478
+
479
+ </th><th>
480
+
481
+ Description
482
+
483
+ </th></tr></thead>
484
+ <tbody><tr><td>
485
+
486
+ id
487
+
488
+ </td><td>
489
+
490
+ string
491
+
492
+ </td><td>
493
+
494
+ _(Optional)_ Iframe window ID. If not passed in, all iframe windows associated with the extension will be shown
495
+
496
+ </td></tr>
497
+ </tbody></table>
498
+
499
+ ## Returns
500
+
501
+ Promise&lt;boolean&gt;
502
+
503
+ Whether the operation is successful
504
+
505
+ ## Remarks
506
+
507
+ This API is result-oriented: If the specified iframe window is not found, the API returns `false`<!-- -->; if the iframe window was already in the shown state before the operation, the API returns `true`
508
+
509
+ Note: This API is only valid for extensions. Calling it in a standalone script environment will always `throw Error`
510
+
511
+ 控制其它扩展打开的内联框架窗口时,`id` 需传入完整 ID 格式:`<其它扩展UUID>.<窗口ID>`<!-- -->(点分隔,窗口 ID 为打开时传入的 `id` 参数)
512
+
513
+ ## Example
514
+
515
+ ```javascript
516
+ // 1. 打开一个内联框架窗口(自建 fixture)
517
+ const opened = await eda.sys_IFrame.openIFrame('/extension.json', 320, 200, '嘉立创示例_显示演示', {
518
+ title: '嘉立创示例 显示演示窗口',
519
+ });
520
+ console.log('打开结果:', opened);
521
+
522
+ // 2. 先隐藏窗口,制造"待恢复"状态
523
+ await eda.sys_IFrame.hideIFrame('嘉立创示例_显示演示');
524
+ console.log('已隐藏窗口,准备恢复显示');
525
+
526
+ // 3. 显示该窗口(从隐藏状态恢复,界面重新可见)
527
+ const shown = await eda.sys_IFrame.showIFrame('嘉立创示例_显示演示');
528
+ console.log('显示结果:', shown);
529
+
530
+ // 4. 对已显示的窗口再次显示,验证幂等语义(返回 true)
531
+ const showAgain = await eda.sys_IFrame.showIFrame('嘉立创示例_显示演示');
532
+ console.log('重复显示结果:', showAgain);
533
+
534
+ // 5. 对不存在的窗口 ID 显示,结果导向返回 false(不抛错)
535
+ const showMissing = await eda.sys_IFrame.showIFrame('嘉立创示例_不存在的窗口');
536
+ console.log('不存在的窗口 ID →', showMissing);
537
+
538
+ // 6. 关闭窗口还原界面
539
+ const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_显示演示');
540
+ console.log('关闭结果:', closed);
541
+ ```