@windypro-rourou/dsh-eda 0.1.3 → 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 +3 -1
  2. package/lib/capabilities.js +3 -2
  3. package/lib/client.js +576 -452
  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,152 +1,152 @@
1
- # EasyEDA File Format
2
-
3
- ## V2.2 File Format
4
-
5
- V2.2 file format: [lceda-pro-file-format-v2.2_2022.12.15.zip](https://image.lceda.cn/files/lceda-pro-file-format-v2.2_2022.12.15.zip)
6
-
7
- Hint: This is not the latest file format specification, but it contains most of the format details.
8
-
9
- ## V3 File Format
10
-
11
- V3 uses a brand-new source format, completely different from previous formats.
12
-
13
- Hint: EasyEDA 3.0 fully redesigned the project format, using the concept of logs for incremental storage of project changes; and switched from the array offset design style in 2.0 to a key-value style, making future format evolution easier, compatibility code development simpler, and readability improved.
14
-
15
- V3 file format (example files included in the zip):
16
- - [lceda-pro-file-format-v3_2025.10.21.zip](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.zip)
17
- - [lceda-pro-file-format-v3_2025.10.21.md](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.md)
18
- - [lceda-pro-file-format-v3_2025.10.21.pdf](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.pdf)
19
-
20
- ### Format Details Documents
21
-
22
- - [Project Format](/en/format/project/index/)
23
- - [Schematic Format](/en/format/schematic/index/)
24
- - [PCB Format](/en/format/pcb/index/)
25
-
26
- ### Basic Document Format
27
-
28
- #### Document Conventions
29
-
30
- - All project data is stored in a log document. The first line of each change record must be the file header `DOCTYPE` to distinguish different document types. `DOCTYPE` exists as a `block-level element` in the project log.
31
- - Each line consists of two valid JSON objects concatenated together. The first object is used by the eventual consistency framework for parsing, and the latter is the `atomic structural object`.
32
- - Key names use camelCase, with the first letter of each word capitalized (except the first word), and no underscores or other separators between words.
33
- - All primitives must carry a `unique ID` within the file.
34
- - `Rotation angle` is positive in the counter-clockwise direction, and angles are always in degrees.
35
- - Unless otherwise specified, all coordinates, lengths, and sizes use `0.01 inch` as the unit.
36
- - All colors are expressed as `"#RRGGBB"`. To indicate no color (fully transparent), use `""`.
37
- - All properties described as `whether XXXX` are encoded with `1` for yes and `0` for no.
38
- - Parts not explicitly described in these conventions (such as escaping) follow [RFC 7195 The JavaScript Object Notation (JSON) Data Interchange Format](https://tools.ietf.org/html/rfc7159).
39
-
40
- #### Type Categories
41
-
42
- - **Common Data**: Includes basic information, creation information, modification information, etc.
43
- - **Basic Information**: Includes metadata for project config, board, schematic, PCB, panel, symbol, footprint, device, etc.
44
- - **BLOB True-Color Image**: True-color image data format.
45
- - **Instance Attribute Override**: Instance attribute override format.
46
- - **Variant**: Variant data format.
47
- - **Component Grouping**: Component grouping data format.
48
-
49
- #### Document Header
50
-
51
- - All data must begin with a document header to distinguish different document types.
52
- - When parsing line by line, encountering a document header means the following data belongs to that document until the next document header is encountered.
53
-
54
- ```json
55
- { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "clientID" }|
56
- ```
57
-
58
- 1. type: "DOCHEAD", document header identifier.
59
- 2. docType: document type.
60
- 3. uuid: document unique ID, unique within the project.
61
- 4. client: terminal identifier for eventual consistency.
62
-
63
- ###### docType Document Types
64
-
65
- - Project config `PROJECT_CONFIG`
66
- - Board `BOARD`
67
- - Schematic `SCH`
68
- - Schematic page `SCH_PAGE`
69
- - PCB `PCB`
70
- - Panel `PANEL`
71
- - Symbol `SYMBOL`
72
- - Footprint `FOOTPRINT`
73
- - Device `DEVICE`
74
- - True-color image `BLOB`
75
- - Instance attributes `INSTANCE`
76
-
77
- #### Data Format
78
-
79
- ```json
80
- { "type": "TYPE", "id": "UUID", "ticket": 1}||{["key": string]: any}|
81
- ```
82
-
83
- The identifier `||` splits a record into inner and outer layers:
84
-
85
- 1. Outer layer data: used by the eventual consistency framework to ensure data consistency.
86
- 1. type: data type.
87
- 2. id: unique ID, must be unique within the specific type in the document.
88
- 3. ticket: logical clock, only used by the eventual consistency framework to ensure data uniqueness.
89
- 2. Inner layer data: primitive atomic data, a `key-value` object. Specific contents are detailed in the corresponding document for each type.
90
-
91
- The reason for splitting into inner and outer layers is that in the eventual consistency framework, the specific primitive data does not need to be concerned; only the outer layer data is needed to ensure data uniqueness, reducing unnecessary JSON parsing and saving memory.
92
-
93
- ```json
94
- { "type": "META", "ticket": 1}||{"name": "name"}|
95
- ```
96
-
97
- Some data can only retain one record within a document. The `type` field alone can indicate uniqueness, so the `id` field is omitted. The `id` field is only used to distinguish multiple records of the same type.
98
-
99
- #### Eventual Consistency
100
-
101
- - In Storage 3.0, adding, deleting, or modifying data adds a record to the log, so multiple records in the log may represent the same data.
102
- - The eventual consistency framework decides which record to keep based on the `type`, `id`, and `ticket` fields.
103
-
104
- ps: For more details, please refer to the eventual consistency design document. Here we only explain the use of relevant fields.
105
-
106
- ###### Two records with the same type and id
107
-
108
- ```json
109
- { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
110
- ```
111
-
112
- ```json
113
- { "type": "TYPE", "id": "UUID", "ticket": 2}||{"data": 2}|
114
- ```
115
-
116
- The eventual consistency framework compares the `ticket` field and keeps the record with the larger ticket. In the example above, the record with `data` 2 is kept.
117
-
118
- ###### Same type, same id, and same ticket
119
-
120
- ```json
121
- { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "1" }|
122
- { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
123
- ```
124
-
125
- ```json
126
- { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "2" }|
127
- { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 2}|
128
- ```
129
-
130
- Then the `client` field in the document header is compared, and the record with the smaller client identifier is kept. In the example above, the record with `data` 1 is kept.
131
-
132
- #### Deletion
133
-
134
- ##### Atomic Data Deletion
135
-
136
- ```json
137
- { "type": "TYPE", "id": "UUID", "ticket": 1}||""
138
- ```
139
-
140
- Deleting data actually means setting the inner layer data to an empty string.
141
-
142
- ##### Document Deletion
143
-
144
- ```json
145
- { "type": "DELETE_DOC", "ticket": 1}||{"isDelete": true}|
146
- ```
147
-
148
- 1. type `DELETE_DOC` document deletion identifier.
149
- 2. isDelete whether deleted.
150
-
151
- - Document deletion actually adds a deletion marker and does not directly delete document data from the log, to facilitate undoing document deletion and maintaining data consistency.
152
- - All deleted data is retained in the log. If users want to remove deleted data records from the project, they should clone the project. Log snapshots will not clear related deletion records.
1
+ # EasyEDA File Format
2
+
3
+ ## V2.2 File Format
4
+
5
+ V2.2 file format: [lceda-pro-file-format-v2.2_2022.12.15.zip](https://image.lceda.cn/files/lceda-pro-file-format-v2.2_2022.12.15.zip)
6
+
7
+ Hint: This is not the latest file format specification, but it contains most of the format details.
8
+
9
+ ## V3 File Format
10
+
11
+ V3 uses a brand-new source format, completely different from previous formats.
12
+
13
+ Hint: EasyEDA 3.0 fully redesigned the project format, using the concept of logs for incremental storage of project changes; and switched from the array offset design style in 2.0 to a key-value style, making future format evolution easier, compatibility code development simpler, and readability improved.
14
+
15
+ V3 file format (example files included in the zip):
16
+ - [lceda-pro-file-format-v3_2025.10.21.zip](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.zip)
17
+ - [lceda-pro-file-format-v3_2025.10.21.md](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.md)
18
+ - [lceda-pro-file-format-v3_2025.10.21.pdf](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.pdf)
19
+
20
+ ### Format Details Documents
21
+
22
+ - [Project Format](/en/format/project/index/)
23
+ - [Schematic Format](/en/format/schematic/index/)
24
+ - [PCB Format](/en/format/pcb/index/)
25
+
26
+ ### Basic Document Format
27
+
28
+ #### Document Conventions
29
+
30
+ - All project data is stored in a log document. The first line of each change record must be the file header `DOCTYPE` to distinguish different document types. `DOCTYPE` exists as a `block-level element` in the project log.
31
+ - Each line consists of two valid JSON objects concatenated together. The first object is used by the eventual consistency framework for parsing, and the latter is the `atomic structural object`.
32
+ - Key names use camelCase, with the first letter of each word capitalized (except the first word), and no underscores or other separators between words.
33
+ - All primitives must carry a `unique ID` within the file.
34
+ - `Rotation angle` is positive in the counter-clockwise direction, and angles are always in degrees.
35
+ - Unless otherwise specified, all coordinates, lengths, and sizes use `0.01 inch` as the unit.
36
+ - All colors are expressed as `"#RRGGBB"`. To indicate no color (fully transparent), use `""`.
37
+ - All properties described as `whether XXXX` are encoded with `1` for yes and `0` for no.
38
+ - Parts not explicitly described in these conventions (such as escaping) follow [RFC 7195 The JavaScript Object Notation (JSON) Data Interchange Format](https://tools.ietf.org/html/rfc7159).
39
+
40
+ #### Type Categories
41
+
42
+ - **Common Data**: Includes basic information, creation information, modification information, etc.
43
+ - **Basic Information**: Includes metadata for project config, board, schematic, PCB, panel, symbol, footprint, device, etc.
44
+ - **BLOB True-Color Image**: True-color image data format.
45
+ - **Instance Attribute Override**: Instance attribute override format.
46
+ - **Variant**: Variant data format.
47
+ - **Component Grouping**: Component grouping data format.
48
+
49
+ #### Document Header
50
+
51
+ - All data must begin with a document header to distinguish different document types.
52
+ - When parsing line by line, encountering a document header means the following data belongs to that document until the next document header is encountered.
53
+
54
+ ```json
55
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "clientID" }|
56
+ ```
57
+
58
+ 1. type: "DOCHEAD", document header identifier.
59
+ 2. docType: document type.
60
+ 3. uuid: document unique ID, unique within the project.
61
+ 4. client: terminal identifier for eventual consistency.
62
+
63
+ ###### docType Document Types
64
+
65
+ - Project config `PROJECT_CONFIG`
66
+ - Board `BOARD`
67
+ - Schematic `SCH`
68
+ - Schematic page `SCH_PAGE`
69
+ - PCB `PCB`
70
+ - Panel `PANEL`
71
+ - Symbol `SYMBOL`
72
+ - Footprint `FOOTPRINT`
73
+ - Device `DEVICE`
74
+ - True-color image `BLOB`
75
+ - Instance attributes `INSTANCE`
76
+
77
+ #### Data Format
78
+
79
+ ```json
80
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{["key": string]: any}|
81
+ ```
82
+
83
+ The identifier `||` splits a record into inner and outer layers:
84
+
85
+ 1. Outer layer data: used by the eventual consistency framework to ensure data consistency.
86
+ 1. type: data type.
87
+ 2. id: unique ID, must be unique within the specific type in the document.
88
+ 3. ticket: logical clock, only used by the eventual consistency framework to ensure data uniqueness.
89
+ 2. Inner layer data: primitive atomic data, a `key-value` object. Specific contents are detailed in the corresponding document for each type.
90
+
91
+ The reason for splitting into inner and outer layers is that in the eventual consistency framework, the specific primitive data does not need to be concerned; only the outer layer data is needed to ensure data uniqueness, reducing unnecessary JSON parsing and saving memory.
92
+
93
+ ```json
94
+ { "type": "META", "ticket": 1}||{"name": "name"}|
95
+ ```
96
+
97
+ Some data can only retain one record within a document. The `type` field alone can indicate uniqueness, so the `id` field is omitted. The `id` field is only used to distinguish multiple records of the same type.
98
+
99
+ #### Eventual Consistency
100
+
101
+ - In Storage 3.0, adding, deleting, or modifying data adds a record to the log, so multiple records in the log may represent the same data.
102
+ - The eventual consistency framework decides which record to keep based on the `type`, `id`, and `ticket` fields.
103
+
104
+ ps: For more details, please refer to the eventual consistency design document. Here we only explain the use of relevant fields.
105
+
106
+ ###### Two records with the same type and id
107
+
108
+ ```json
109
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
110
+ ```
111
+
112
+ ```json
113
+ { "type": "TYPE", "id": "UUID", "ticket": 2}||{"data": 2}|
114
+ ```
115
+
116
+ The eventual consistency framework compares the `ticket` field and keeps the record with the larger ticket. In the example above, the record with `data` 2 is kept.
117
+
118
+ ###### Same type, same id, and same ticket
119
+
120
+ ```json
121
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "1" }|
122
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
123
+ ```
124
+
125
+ ```json
126
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "2" }|
127
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 2}|
128
+ ```
129
+
130
+ Then the `client` field in the document header is compared, and the record with the smaller client identifier is kept. In the example above, the record with `data` 1 is kept.
131
+
132
+ #### Deletion
133
+
134
+ ##### Atomic Data Deletion
135
+
136
+ ```json
137
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||""
138
+ ```
139
+
140
+ Deleting data actually means setting the inner layer data to an empty string.
141
+
142
+ ##### Document Deletion
143
+
144
+ ```json
145
+ { "type": "DELETE_DOC", "ticket": 1}||{"isDelete": true}|
146
+ ```
147
+
148
+ 1. type `DELETE_DOC` document deletion identifier.
149
+ 2. isDelete whether deleted.
150
+
151
+ - Document deletion actually adds a deletion marker and does not directly delete document data from the log, to facilitate undoing document deletion and maintaining data consistency.
152
+ - All deleted data is retained in the log. If users want to remove deleted data records from the project, they should clone the project. Log snapshots will not clear related deletion records.
@@ -1,166 +1,166 @@
1
- # 3D Shell System
2
-
3
- ## SHELL Shell
4
-
5
- ```json
6
- { "type": "SHELL", "id":"UUID", "ticket": 1 }||
7
- {
8
- "partitionId":null,
9
- "groupId":0,
10
- "locked":1,
11
- "zIndex":0.223,
12
- "shellType":"T&B",
13
- "shellHeight":50,
14
- "pcbHeight":100,
15
- "strokeWidth":10,
16
- "path":"complex polygon",
17
- "attrs":{},
18
- }|
19
- ```
20
-
21
- 1. type shell `SHELL`.
22
- 2. id primitive ID, unique within the document.
23
- 3. ticket logical clock.
24
- 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
25
- 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
26
- 6. locked whether locked.
27
- 7. zIndex Z-axis height.
28
- 8. shellType shell type.
29
- - `T&B` top & bottom shell.
30
- - `DRAWER` drawer.
31
- - `CLAM` clamshell.
32
- 9. shellHeight shell height.
33
- 10. pcbHeight PCB height.
34
- 11. strokeWidth \*line width (deprecated).
35
- 12. path see complex polygon.
36
- 13. attrs custom attributes: each 3D shell type has a set of custom shell attributes.
37
- - T&B
38
- - Thickness: shell thickness.
39
- - BottomHeight: bottom shell height.
40
- - TopInnerHeight: top shell inner wall height.
41
- - TopInnerThickness: top shell inner wall thickness.
42
- - DRAWER
43
- - Thickness: shell thickness.
44
- - Direction: drawer direction.
45
- - `1` positive X axis.
46
- - `2` negative X axis.
47
- - `4` positive Y axis.
48
- - `8` negative Y axis.
49
-
50
- ## CREASE Side Reference Line (Crease)
51
-
52
- `CREASE` primitives need to be used with `CONNECT` to associate `SHELL_ENTITY` and `BOSS` to express shell slots.
53
-
54
- ```json
55
- { "type": "CREASE", "id":"UUID", "ticket": 1 }||
56
- {
57
- "partitionId":null,
58
- "groupId":0,
59
- "locked":1,
60
- "zIndex":8.275,
61
- "layerId":49,
62
- "startX":20,
63
- "startY":30,
64
- "endX":40,
65
- "endY":50,
66
- "angle":90,
67
- }|
68
- ```
69
-
70
- 1. type crease `CREASE`.
71
- 2. id primitive ID, unique within the document.
72
- 3. ticket logical clock.
73
- 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
74
- 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
75
- 6. locked whether locked.
76
- 7. zIndex Z-axis height.
77
- 8. layerId layer.
78
- 9. startX start X.
79
- 10. startY start Y.
80
- 11. endX end X.
81
- 12. endY end Y.
82
- 13. angle fold angle.
83
-
84
- ## SHELL_ENTITY Shell Entity Area
85
-
86
- A `SHELL_ENTITY` not associated with `CREASE` via `CONNECT` performs vertical fill/cut (slotting) for the top and bottom shells.
87
-
88
- ```json
89
- { "type": "SHELL_ENTITY", "id":"UUID", "ticket": 1 }||
90
- {
91
- "partitionId":null,
92
- "groupId":0,
93
- "locked":1,
94
- "zIndex":0.15,
95
- "layerId":50,
96
- "booleanOperation":0,
97
- "belong":0,
98
- "depth":10,
99
- "strokeWidth":10,
100
- "path":"complex polygon",
101
- }|
102
- ```
103
-
104
- 1. type shell entity area `SHELL_ENTITY`.
105
- 2. id primitive ID, unique within the document.
106
- 3. ticket logical clock.
107
- 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
108
- 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
109
- 6. locked whether locked.
110
- 7. zIndex Z-axis height.
111
- 8. layerId layer.
112
- 9. booleanOperation boolean operation: 0 cut, 1 fill.
113
- 10. belong affiliation: 0 auto, 1 top shell, 2 bottom shell, 4 shell border, 8 boss, 16 entity. Can be combined by addition.
114
- - top + bottom shells: 3 = 1 + 2
115
- - shell border + boss: 12 = 4 + 8
116
- - boss + entity: 24 = 8 + 16
117
- - shell border + boss + entity: 28 = 4 + 8 + 16
118
- 11. depth depth.
119
- 12. strokeWidth line width.
120
- 13. path see complex polygon.
121
-
122
- ## BOSS Boss
123
-
124
- A `BOSS` associated with `CREASE` via `CONNECT` adds a side boss.
125
-
126
- ```json
127
- { "type": "BOSS", "id":"UUID", "ticket": 1 }||
128
- {
129
- "partitionId":null,
130
- "groupId":0,
131
- "locked":1,
132
- "zIndex":0.8976,
133
- "layerId":50,
134
- "centerX":100,
135
- "centerY":200,
136
- "specification":"M2",
137
- "depth":100,
138
- "thickness":10,
139
- "holeDiameter":20,
140
- "counterBore":[100, 20],
141
- "stiffener":[20, 40, 20, 10],
142
- }|
143
- ```
144
-
145
- 1. type boss `BOSS`.
146
- 2. id primitive ID, unique within the document.
147
- 3. ticket logical clock.
148
- 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
149
- 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
150
- 6. locked whether locked.
151
- 7. zIndex Z-axis height.
152
- 8. layerId layer.
153
- 9. centerX center X.
154
- 10. centerY center Y.
155
- 11. specification screw specification: `"M2"`, `"M3"`, etc., or `null` for custom.
156
- 12. depth boss height.
157
- 13. thickness boss wall thickness.
158
- 14. holeDiameter through-hole diameter.
159
- 15. counterBore counterbore parameters, `null` means no counterbore.
160
- - screw head height.
161
- - screw head diameter.
162
- 16. stiffener rib parameters, `null` means no rib.
163
- - rib top width.
164
- - rib bottom width.
165
- - rib distance from top of boss.
166
- - rib thickness.
1
+ # 3D Shell System
2
+
3
+ ## SHELL Shell
4
+
5
+ ```json
6
+ { "type": "SHELL", "id":"UUID", "ticket": 1 }||
7
+ {
8
+ "partitionId":null,
9
+ "groupId":0,
10
+ "locked":1,
11
+ "zIndex":0.223,
12
+ "shellType":"T&B",
13
+ "shellHeight":50,
14
+ "pcbHeight":100,
15
+ "strokeWidth":10,
16
+ "path":"complex polygon",
17
+ "attrs":{},
18
+ }|
19
+ ```
20
+
21
+ 1. type shell `SHELL`.
22
+ 2. id primitive ID, unique within the document.
23
+ 3. ticket logical clock.
24
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
25
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
26
+ 6. locked whether locked.
27
+ 7. zIndex Z-axis height.
28
+ 8. shellType shell type.
29
+ - `T&B` top & bottom shell.
30
+ - `DRAWER` drawer.
31
+ - `CLAM` clamshell.
32
+ 9. shellHeight shell height.
33
+ 10. pcbHeight PCB height.
34
+ 11. strokeWidth \*line width (deprecated).
35
+ 12. path see complex polygon.
36
+ 13. attrs custom attributes: each 3D shell type has a set of custom shell attributes.
37
+ - T&B
38
+ - Thickness: shell thickness.
39
+ - BottomHeight: bottom shell height.
40
+ - TopInnerHeight: top shell inner wall height.
41
+ - TopInnerThickness: top shell inner wall thickness.
42
+ - DRAWER
43
+ - Thickness: shell thickness.
44
+ - Direction: drawer direction.
45
+ - `1` positive X axis.
46
+ - `2` negative X axis.
47
+ - `4` positive Y axis.
48
+ - `8` negative Y axis.
49
+
50
+ ## CREASE Side Reference Line (Crease)
51
+
52
+ `CREASE` primitives need to be used with `CONNECT` to associate `SHELL_ENTITY` and `BOSS` to express shell slots.
53
+
54
+ ```json
55
+ { "type": "CREASE", "id":"UUID", "ticket": 1 }||
56
+ {
57
+ "partitionId":null,
58
+ "groupId":0,
59
+ "locked":1,
60
+ "zIndex":8.275,
61
+ "layerId":49,
62
+ "startX":20,
63
+ "startY":30,
64
+ "endX":40,
65
+ "endY":50,
66
+ "angle":90,
67
+ }|
68
+ ```
69
+
70
+ 1. type crease `CREASE`.
71
+ 2. id primitive ID, unique within the document.
72
+ 3. ticket logical clock.
73
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
74
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
75
+ 6. locked whether locked.
76
+ 7. zIndex Z-axis height.
77
+ 8. layerId layer.
78
+ 9. startX start X.
79
+ 10. startY start Y.
80
+ 11. endX end X.
81
+ 12. endY end Y.
82
+ 13. angle fold angle.
83
+
84
+ ## SHELL_ENTITY Shell Entity Area
85
+
86
+ A `SHELL_ENTITY` not associated with `CREASE` via `CONNECT` performs vertical fill/cut (slotting) for the top and bottom shells.
87
+
88
+ ```json
89
+ { "type": "SHELL_ENTITY", "id":"UUID", "ticket": 1 }||
90
+ {
91
+ "partitionId":null,
92
+ "groupId":0,
93
+ "locked":1,
94
+ "zIndex":0.15,
95
+ "layerId":50,
96
+ "booleanOperation":0,
97
+ "belong":0,
98
+ "depth":10,
99
+ "strokeWidth":10,
100
+ "path":"complex polygon",
101
+ }|
102
+ ```
103
+
104
+ 1. type shell entity area `SHELL_ENTITY`.
105
+ 2. id primitive ID, unique within the document.
106
+ 3. ticket logical clock.
107
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
108
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
109
+ 6. locked whether locked.
110
+ 7. zIndex Z-axis height.
111
+ 8. layerId layer.
112
+ 9. booleanOperation boolean operation: 0 cut, 1 fill.
113
+ 10. belong affiliation: 0 auto, 1 top shell, 2 bottom shell, 4 shell border, 8 boss, 16 entity. Can be combined by addition.
114
+ - top + bottom shells: 3 = 1 + 2
115
+ - shell border + boss: 12 = 4 + 8
116
+ - boss + entity: 24 = 8 + 16
117
+ - shell border + boss + entity: 28 = 4 + 8 + 16
118
+ 11. depth depth.
119
+ 12. strokeWidth line width.
120
+ 13. path see complex polygon.
121
+
122
+ ## BOSS Boss
123
+
124
+ A `BOSS` associated with `CREASE` via `CONNECT` adds a side boss.
125
+
126
+ ```json
127
+ { "type": "BOSS", "id":"UUID", "ticket": 1 }||
128
+ {
129
+ "partitionId":null,
130
+ "groupId":0,
131
+ "locked":1,
132
+ "zIndex":0.8976,
133
+ "layerId":50,
134
+ "centerX":100,
135
+ "centerY":200,
136
+ "specification":"M2",
137
+ "depth":100,
138
+ "thickness":10,
139
+ "holeDiameter":20,
140
+ "counterBore":[100, 20],
141
+ "stiffener":[20, 40, 20, 10],
142
+ }|
143
+ ```
144
+
145
+ 1. type boss `BOSS`.
146
+ 2. id primitive ID, unique within the document.
147
+ 3. ticket logical clock.
148
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
149
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
150
+ 6. locked whether locked.
151
+ 7. zIndex Z-axis height.
152
+ 8. layerId layer.
153
+ 9. centerX center X.
154
+ 10. centerY center Y.
155
+ 11. specification screw specification: `"M2"`, `"M3"`, etc., or `null` for custom.
156
+ 12. depth boss height.
157
+ 13. thickness boss wall thickness.
158
+ 14. holeDiameter through-hole diameter.
159
+ 15. counterBore counterbore parameters, `null` means no counterbore.
160
+ - screw head height.
161
+ - screw head diameter.
162
+ 16. stiffener rib parameters, `null` means no rib.
163
+ - rib top width.
164
+ - rib bottom width.
165
+ - rib distance from top of boss.
166
+ - rib thickness.