@windypro-rourou/dsh-eda 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -119
- package/cordis.patch.yml +9 -7
- package/lib/board.js +80 -0
- package/lib/client.js +2 -2
- package/lib/index.js +339 -11
- package/lib/installer.js +4 -4
- package/lib/skill.js +138 -0
- package/package.json +12 -2
- package/skill/INDEX.md +193 -0
- package/skill/README.official.md +125 -0
- package/skill/README.zh-Hans.official.md +125 -0
- package/skill/SKILL.md +746 -0
- package/skill/format/index.md +152 -0
- package/skill/format/pcb/3d.md +166 -0
- package/skill/format/pcb/attr.md +63 -0
- package/skill/format/pcb/common.md +306 -0
- package/skill/format/pcb/component.md +132 -0
- package/skill/format/pcb/dimension.md +58 -0
- package/skill/format/pcb/index.md +17 -0
- package/skill/format/pcb/obj.md +43 -0
- package/skill/format/pcb/pad_via.md +151 -0
- package/skill/format/pcb/panel.md +64 -0
- package/skill/format/pcb/partition.md +43 -0
- package/skill/format/pcb/primitive.md +196 -0
- package/skill/format/pcb/rule.md +71 -0
- package/skill/format/pcb/shape.md +441 -0
- package/skill/format/pcb/text.md +62 -0
- package/skill/format/project/blob.md +30 -0
- package/skill/format/project/common.md +42 -0
- package/skill/format/project/group.md +62 -0
- package/skill/format/project/index.md +12 -0
- package/skill/format/project/instance.md +32 -0
- package/skill/format/project/meta.md +189 -0
- package/skill/format/project/variant.md +30 -0
- package/skill/format/schematic/attr.md +41 -0
- package/skill/format/schematic/common.md +47 -0
- package/skill/format/schematic/component.md +91 -0
- package/skill/format/schematic/index.md +14 -0
- package/skill/format/schematic/obj.md +41 -0
- package/skill/format/schematic/pin.md +59 -0
- package/skill/format/schematic/shape.md +231 -0
- package/skill/format/schematic/structure.md +53 -0
- package/skill/format/schematic/table.md +109 -0
- package/skill/format/schematic/text.md +47 -0
- package/skill/format/schematic/wire.md +132 -0
- package/skill/guide/ancillary-projects/pro-api-sdk.md +1 -0
- package/skill/guide/ancillary-projects/pro-api-types.md +5 -0
- package/skill/guide/ancillary-projects.md +10 -0
- package/skill/guide/error-handling.md +38 -0
- package/skill/guide/extension-json.md +135 -0
- package/skill/guide/extensions-marketplace.md +61 -0
- package/skill/guide/how-to-start.md +301 -0
- package/skill/guide/i18n.md +57 -0
- package/skill/guide/index.md +7 -0
- package/skill/guide/inline-frame.md +20 -0
- package/skill/guide/invoke-apis.md +81 -0
- package/skill/guide/stability.md +37 -0
- package/skill/references/_index.md +398 -0
- package/skill/references/_quick-reference.md +3028 -0
- package/skill/references/classes/DMT_Board.md +533 -0
- package/skill/references/classes/DMT_EditorControl.md +1736 -0
- package/skill/references/classes/DMT_Event.md +356 -0
- package/skill/references/classes/DMT_Folder.md +775 -0
- package/skill/references/classes/DMT_Panel.md +531 -0
- package/skill/references/classes/DMT_Pcb.md +575 -0
- package/skill/references/classes/DMT_Project.md +573 -0
- package/skill/references/classes/DMT_Schematic.md +1477 -0
- package/skill/references/classes/DMT_SelectControl.md +96 -0
- package/skill/references/classes/DMT_Team.md +172 -0
- package/skill/references/classes/DMT_Workspace.md +198 -0
- package/skill/references/classes/EDA.md +961 -0
- package/skill/references/classes/IPCB_ComplexPolygon.md +299 -0
- package/skill/references/classes/IPCB_Polygon.md +175 -0
- package/skill/references/classes/IPCB_PrimitiveArc.md +1901 -0
- package/skill/references/classes/IPCB_PrimitiveAttribute.md +2993 -0
- package/skill/references/classes/IPCB_PrimitiveComponent.md +2627 -0
- package/skill/references/classes/IPCB_PrimitiveComponentPad.md +410 -0
- package/skill/references/classes/IPCB_PrimitiveDimension.md +1419 -0
- package/skill/references/classes/IPCB_PrimitiveFill.md +1325 -0
- package/skill/references/classes/IPCB_PrimitiveImage.md +1461 -0
- package/skill/references/classes/IPCB_PrimitiveLine.md +1639 -0
- package/skill/references/classes/IPCB_PrimitiveObject.md +1700 -0
- package/skill/references/classes/IPCB_PrimitivePad.md +3155 -0
- package/skill/references/classes/IPCB_PrimitivePolyline.md +1193 -0
- package/skill/references/classes/IPCB_PrimitivePour.md +1858 -0
- package/skill/references/classes/IPCB_PrimitivePoured.md +556 -0
- package/skill/references/classes/IPCB_PrimitiveRegion.md +1332 -0
- package/skill/references/classes/IPCB_PrimitiveString.md +2315 -0
- package/skill/references/classes/IPCB_PrimitiveVia.md +1588 -0
- package/skill/references/classes/ISCH_PrimitiveArc.md +1676 -0
- package/skill/references/classes/ISCH_PrimitiveAttribute.md +2541 -0
- package/skill/references/classes/ISCH_PrimitiveBus.md +973 -0
- package/skill/references/classes/ISCH_PrimitiveCbbSymbolComponent.md +260 -0
- package/skill/references/classes/ISCH_PrimitiveCircle.md +1392 -0
- package/skill/references/classes/ISCH_PrimitiveComponent.md +2913 -0
- package/skill/references/classes/ISCH_PrimitiveComponentPin.md +155 -0
- package/skill/references/classes/ISCH_PrimitiveObject.md +960 -0
- package/skill/references/classes/ISCH_PrimitivePin.md +2402 -0
- package/skill/references/classes/ISCH_PrimitivePolygon.md +1028 -0
- package/skill/references/classes/ISCH_PrimitiveRectangle.md +1777 -0
- package/skill/references/classes/ISCH_PrimitiveText.md +1771 -0
- package/skill/references/classes/ISCH_PrimitiveWire.md +973 -0
- package/skill/references/classes/LIB_3DModel.md +780 -0
- package/skill/references/classes/LIB_Cbb.md +957 -0
- package/skill/references/classes/LIB_Classification.md +965 -0
- package/skill/references/classes/LIB_Device.md +1221 -0
- package/skill/references/classes/LIB_Footprint.md +1153 -0
- package/skill/references/classes/LIB_LibrariesList.md +329 -0
- package/skill/references/classes/LIB_PanelLibrary.md +855 -0
- package/skill/references/classes/LIB_SelectControl.md +89 -0
- package/skill/references/classes/LIB_SimulationModel.md +821 -0
- package/skill/references/classes/LIB_Symbol.md +1195 -0
- package/skill/references/classes/PCB_Document.md +1754 -0
- package/skill/references/classes/PCB_Drc.md +3375 -0
- package/skill/references/classes/PCB_Event.md +1081 -0
- package/skill/references/classes/PCB_Layer.md +1911 -0
- package/skill/references/classes/PCB_ManufactureData.md +2968 -0
- package/skill/references/classes/PCB_MathPolygon.md +785 -0
- package/skill/references/classes/PCB_Net.md +1128 -0
- package/skill/references/classes/PCB_Primitive.md +217 -0
- package/skill/references/classes/PCB_PrimitiveArc.md +894 -0
- package/skill/references/classes/PCB_PrimitiveAttribute.md +717 -0
- package/skill/references/classes/PCB_PrimitiveComponent.md +1050 -0
- package/skill/references/classes/PCB_PrimitiveDimension.md +833 -0
- package/skill/references/classes/PCB_PrimitiveFill.md +861 -0
- package/skill/references/classes/PCB_PrimitiveImage.md +875 -0
- package/skill/references/classes/PCB_PrimitiveLine.md +858 -0
- package/skill/references/classes/PCB_PrimitiveObject.md +800 -0
- package/skill/references/classes/PCB_PrimitivePad.md +944 -0
- package/skill/references/classes/PCB_PrimitivePolyline.md +819 -0
- package/skill/references/classes/PCB_PrimitivePour.md +845 -0
- package/skill/references/classes/PCB_PrimitivePoured.md +363 -0
- package/skill/references/classes/PCB_PrimitiveRegion.md +799 -0
- package/skill/references/classes/PCB_PrimitiveString.md +910 -0
- package/skill/references/classes/PCB_PrimitiveVia.md +765 -0
- package/skill/references/classes/PCB_RayTracerEngine.md +263 -0
- package/skill/references/classes/PCB_SelectControl.md +495 -0
- package/skill/references/classes/PNL_Document.md +83 -0
- package/skill/references/classes/SCH_Document.md +809 -0
- package/skill/references/classes/SCH_Drc.md +242 -0
- package/skill/references/classes/SCH_Event.md +583 -0
- package/skill/references/classes/SCH_ManufactureData.md +1205 -0
- package/skill/references/classes/SCH_Net.md +200 -0
- package/skill/references/classes/SCH_Netlist.md +191 -0
- package/skill/references/classes/SCH_Primitive.md +337 -0
- package/skill/references/classes/SCH_PrimitiveArc.md +692 -0
- package/skill/references/classes/SCH_PrimitiveAttribute.md +590 -0
- package/skill/references/classes/SCH_PrimitiveBus.md +624 -0
- package/skill/references/classes/SCH_PrimitiveCircle.md +683 -0
- package/skill/references/classes/SCH_PrimitiveComponent.md +2240 -0
- package/skill/references/classes/SCH_PrimitiveObject.md +666 -0
- package/skill/references/classes/SCH_PrimitivePin.md +754 -0
- package/skill/references/classes/SCH_PrimitivePolygon.md +627 -0
- package/skill/references/classes/SCH_PrimitiveRectangle.md +731 -0
- package/skill/references/classes/SCH_PrimitiveText.md +746 -0
- package/skill/references/classes/SCH_PrimitiveWire.md +703 -0
- package/skill/references/classes/SCH_SelectControl.md +520 -0
- package/skill/references/classes/SCH_SimulationEngine.md +133 -0
- package/skill/references/classes/SCH_Utils.md +121 -0
- package/skill/references/classes/SYS_ClientUrl.md +173 -0
- package/skill/references/classes/SYS_Dialog.md +825 -0
- package/skill/references/classes/SYS_Environment.md +502 -0
- package/skill/references/classes/SYS_FileManager.md +1686 -0
- package/skill/references/classes/SYS_FileSystem.md +1171 -0
- package/skill/references/classes/SYS_FontManager.md +224 -0
- package/skill/references/classes/SYS_FormatConversion.md +349 -0
- package/skill/references/classes/SYS_HeaderMenu.md +479 -0
- package/skill/references/classes/SYS_I18n.md +861 -0
- package/skill/references/classes/SYS_IFrame.md +535 -0
- package/skill/references/classes/SYS_LoadingAndProgressBar.md +246 -0
- package/skill/references/classes/SYS_Log.md +424 -0
- package/skill/references/classes/SYS_Math.md +1565 -0
- package/skill/references/classes/SYS_Message.md +363 -0
- package/skill/references/classes/SYS_MessageBox.md +285 -0
- package/skill/references/classes/SYS_MessageBus.md +1618 -0
- package/skill/references/classes/SYS_PanelControl.md +696 -0
- package/skill/references/classes/SYS_RightClickMenu.md +175 -0
- package/skill/references/classes/SYS_Setting.md +85 -0
- package/skill/references/classes/SYS_ShortcutKey.md +623 -0
- package/skill/references/classes/SYS_Storage.md +484 -0
- package/skill/references/classes/SYS_Timer.md +447 -0
- package/skill/references/classes/SYS_ToastMessage.md +194 -0
- package/skill/references/classes/SYS_Tool.md +241 -0
- package/skill/references/classes/SYS_Unit.md +594 -0
- package/skill/references/classes/SYS_WebSocket.md +401 -0
- package/skill/references/classes/SYS_Window.md +850 -0
- package/skill/references/enums/EDMT_EditorDocumentType.md +279 -0
- package/skill/references/enums/EDMT_EditorSplitScreenDirection.md +48 -0
- package/skill/references/enums/EDMT_EditorTabEventType.md +63 -0
- package/skill/references/enums/EDMT_IndicatorMarkerType.md +81 -0
- package/skill/references/enums/EDMT_ItemType.md +158 -0
- package/skill/references/enums/EDMT_ProjectCollaborationMode.md +48 -0
- package/skill/references/enums/ELIB_DeviceJlcLibraryCategory.md +48 -0
- package/skill/references/enums/ELIB_LibraryType.md +114 -0
- package/skill/references/enums/ELIB_PreviewType.md +70 -0
- package/skill/references/enums/ELIB_SimulationModelType.md +48 -0
- package/skill/references/enums/ELIB_SymbolType.md +125 -0
- package/skill/references/enums/EPCB_AutoRoutingCornerStyle.md +48 -0
- package/skill/references/enums/EPCB_AutoRoutingExistingPrimitiveMode.md +48 -0
- package/skill/references/enums/EPCB_AutoRoutingOptimization.md +48 -0
- package/skill/references/enums/EPCB_DocumentCanvasUpdateCalculationActiveStatus.md +48 -0
- package/skill/references/enums/EPCB_DocumentRatlineCalculatingActiveStatus.md +52 -0
- package/skill/references/enums/EPCB_InactiveLayerDisplayMode.md +59 -0
- package/skill/references/enums/EPCB_LayerColorConfiguration.md +81 -0
- package/skill/references/enums/EPCB_LayerId.md +882 -0
- package/skill/references/enums/EPCB_LayerStatus.md +59 -0
- package/skill/references/enums/EPCB_LayerType.md +114 -0
- package/skill/references/enums/EPCB_MouseEventType.md +59 -0
- package/skill/references/enums/EPCB_NetEventType.md +59 -0
- package/skill/references/enums/EPCB_PcbPlateType.md +48 -0
- package/skill/references/enums/EPCB_PdfOutputMethod.md +59 -0
- package/skill/references/enums/EPCB_PrimitiveArcInteractiveMode.md +48 -0
- package/skill/references/enums/EPCB_PrimitiveDimensionType.md +59 -0
- package/skill/references/enums/EPCB_PrimitiveEventType.md +59 -0
- package/skill/references/enums/EPCB_PrimitiveFillMode.md +63 -0
- package/skill/references/enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md +59 -0
- package/skill/references/enums/EPCB_PrimitivePadHoleType.md +59 -0
- package/skill/references/enums/EPCB_PrimitivePadShapeType.md +81 -0
- package/skill/references/enums/EPCB_PrimitivePadType.md +59 -0
- package/skill/references/enums/EPCB_PrimitivePourFillMethod.md +59 -0
- package/skill/references/enums/EPCB_PrimitiveRegionRuleType.md +96 -0
- package/skill/references/enums/EPCB_PrimitiveStringAlignMode.md +125 -0
- package/skill/references/enums/EPCB_PrimitiveType.md +202 -0
- package/skill/references/enums/EPCB_PrimitiveViaType.md +59 -0
- package/skill/references/enums/ESCH_DynamicSimulationEnginePullEventType.md +103 -0
- package/skill/references/enums/ESCH_DynamicSimulationEnginePushEventType.md +81 -0
- package/skill/references/enums/ESCH_ExportDocumentFileType.md +59 -0
- package/skill/references/enums/ESCH_MouseEventType.md +48 -0
- package/skill/references/enums/ESCH_PrimitiveComponentType.md +125 -0
- package/skill/references/enums/ESCH_PrimitiveEventType.md +70 -0
- package/skill/references/enums/ESCH_PrimitiveFillStyle.md +114 -0
- package/skill/references/enums/ESCH_PrimitiveLineType.md +70 -0
- package/skill/references/enums/ESCH_PrimitivePinShape.md +70 -0
- package/skill/references/enums/ESCH_PrimitivePinType.md +147 -0
- package/skill/references/enums/ESCH_PrimitiveTextAlignMode.md +125 -0
- package/skill/references/enums/ESCH_PrimitiveType.md +180 -0
- package/skill/references/enums/ESCH_SimulationNetlistType.md +37 -0
- package/skill/references/enums/ESCH_SpiceSimulationEnginePullEventType.md +48 -0
- package/skill/references/enums/ESCH_SpiceSimulationEnginePushEventType.md +70 -0
- package/skill/references/enums/ESYS_BottomPanelTab.md +81 -0
- package/skill/references/enums/ESYS_HeaderMenuEnvironment.md +158 -0
- package/skill/references/enums/ESYS_ImportProjectBoardOutlineSource.md +52 -0
- package/skill/references/enums/ESYS_ImportProjectImportOption.md +59 -0
- package/skill/references/enums/ESYS_ImportProjectSchematicObjectStyle.md +48 -0
- package/skill/references/enums/ESYS_ImportProjectViaSolderMaskExpansion.md +52 -0
- package/skill/references/enums/ESYS_LeftPanelTab.md +81 -0
- package/skill/references/enums/ESYS_LogType.md +103 -0
- package/skill/references/enums/ESYS_NetlistType.md +114 -0
- package/skill/references/enums/ESYS_RightPanelTab.md +202 -0
- package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorRange.md +191 -0
- package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorScene.md +92 -0
- package/skill/references/enums/ESYS_StartPageQuickStartItem.md +206 -0
- package/skill/references/enums/ESYS_Theme.md +48 -0
- package/skill/references/enums/ESYS_ToastMessageType.md +81 -0
- package/skill/references/enums/ESYS_Unit.md +103 -0
- package/skill/references/enums/ESYS_WindowEventType.md +48 -0
- package/skill/references/enums/ESYS_WindowOpenTarget.md +48 -0
- package/skill/references/enums/NetportDeviceName.md +147 -0
- package/skill/references/enums/SchToolBarDeviceName.md +279 -0
- package/skill/references/interfaces/BoardProps.md +169 -0
- package/skill/references/interfaces/ButtonProps.md +169 -0
- package/skill/references/interfaces/CheckBoxProps.md +196 -0
- package/skill/references/interfaces/ComponentPropsMap.md +448 -0
- package/skill/references/interfaces/DialogProps.md +385 -0
- package/skill/references/interfaces/FlexItemProps.md +116 -0
- package/skill/references/interfaces/FlexProps.md +224 -0
- package/skill/references/interfaces/GridItemProps.md +143 -0
- package/skill/references/interfaces/GridProps.md +143 -0
- package/skill/references/interfaces/IDMT_BoardItem.md +171 -0
- package/skill/references/interfaces/IDMT_BriefProjectItem.md +171 -0
- package/skill/references/interfaces/IDMT_EditorDocumentItem.md +169 -0
- package/skill/references/interfaces/IDMT_EditorSplitScreenItem.md +173 -0
- package/skill/references/interfaces/IDMT_EditorTabItem.md +169 -0
- package/skill/references/interfaces/IDMT_FolderItem.md +225 -0
- package/skill/references/interfaces/IDMT_IndicatorMarkerShape.md +393 -0
- package/skill/references/interfaces/IDMT_PanelItem.md +144 -0
- package/skill/references/interfaces/IDMT_PcbItem.md +171 -0
- package/skill/references/interfaces/IDMT_ProjectItem.md +143 -0
- package/skill/references/interfaces/IDMT_SchematicItem.md +225 -0
- package/skill/references/interfaces/IDMT_SchematicPageItem.md +198 -0
- package/skill/references/interfaces/IDMT_TeamItem.md +144 -0
- package/skill/references/interfaces/IDMT_WorkspaceItem.md +117 -0
- package/skill/references/interfaces/IDesignPortal.md +103 -0
- package/skill/references/interfaces/ILIB_3DModelItem.md +198 -0
- package/skill/references/interfaces/ILIB_3DModelSearchItem.md +277 -0
- package/skill/references/interfaces/ILIB_CbbItem.md +225 -0
- package/skill/references/interfaces/ILIB_CbbSearchItem.md +277 -0
- package/skill/references/interfaces/ILIB_ClassificationIndex.md +150 -0
- package/skill/references/interfaces/ILIB_DeviceAssociationItem.md +210 -0
- package/skill/references/interfaces/ILIB_DeviceExtendPropertyItem.md +304 -0
- package/skill/references/interfaces/ILIB_DeviceItem.md +279 -0
- package/skill/references/interfaces/ILIB_DevicePropertiesForSearch.md +250 -0
- package/skill/references/interfaces/ILIB_DeviceSearchItem.md +521 -0
- package/skill/references/interfaces/ILIB_ExtendLibrary3DModelFunctions.md +64 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryCbbFunctions.md +99 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md +150 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md +157 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md +63 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md +123 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryItem.md +97 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md +98 -0
- package/skill/references/interfaces/ILIB_ExtendLibrarySearchProperty.md +115 -0
- package/skill/references/interfaces/ILIB_ExtendLibrarySearchResult.md +169 -0
- package/skill/references/interfaces/ILIB_ExtendLibrarySearchResultDataLine.md +234 -0
- package/skill/references/interfaces/ILIB_ExtendLibrarySymbolFunctions.md +105 -0
- package/skill/references/interfaces/ILIB_ExtendLibraryUserIndex.md +96 -0
- package/skill/references/interfaces/ILIB_FootprintItem.md +198 -0
- package/skill/references/interfaces/ILIB_FootprintPropertiesForSearch.md +61 -0
- package/skill/references/interfaces/ILIB_FootprintSearchItem.md +277 -0
- package/skill/references/interfaces/ILIB_LibraryInfo.md +92 -0
- package/skill/references/interfaces/ILIB_LibraryItem.md +115 -0
- package/skill/references/interfaces/ILIB_PanelLibraryItem.md +198 -0
- package/skill/references/interfaces/ILIB_PanelLibrarySearchItem.md +277 -0
- package/skill/references/interfaces/ILIB_SimulationModelItem.md +306 -0
- package/skill/references/interfaces/ILIB_SimulationModelSearchItem.md +304 -0
- package/skill/references/interfaces/ILIB_SymbolItem.md +279 -0
- package/skill/references/interfaces/ILIB_SymbolPropertiesForSearch.md +61 -0
- package/skill/references/interfaces/ILIB_SymbolSearchItem.md +304 -0
- package/skill/references/interfaces/IPCB_AutoLayoutResult.md +169 -0
- package/skill/references/interfaces/IPCB_AutoRoutingProps.md +220 -0
- package/skill/references/interfaces/IPCB_AutoRoutingResult.md +169 -0
- package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md +169 -0
- package/skill/references/interfaces/IPCB_DifferentialPairItem.md +115 -0
- package/skill/references/interfaces/IPCB_DiscretizeOptions.md +65 -0
- package/skill/references/interfaces/IPCB_DiscretizedPoint.md +88 -0
- package/skill/references/interfaces/IPCB_EqualLengthNetGroupItem.md +115 -0
- package/skill/references/interfaces/IPCB_LayerItem.md +277 -0
- package/skill/references/interfaces/IPCB_NetClassItem.md +115 -0
- package/skill/references/interfaces/IPCB_NetInfo.md +115 -0
- package/skill/references/interfaces/IPCB_PadPairGroupItem.md +88 -0
- package/skill/references/interfaces/IPCB_PadPairMinWireLengthItem.md +88 -0
- package/skill/references/interfaces/IPCB_PhysicalStackingConfiguration.md +115 -0
- package/skill/references/interfaces/IPCB_Primitive.md +218 -0
- package/skill/references/interfaces/IPCB_PrimitiveAPI.md +175 -0
- package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md +151 -0
- package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md +142 -0
- package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md +154 -0
- package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md +88 -0
- package/skill/references/interfaces/IRawNet.md +103 -0
- package/skill/references/interfaces/IRawPureSchematic.md +80 -0
- package/skill/references/interfaces/IRawSchematic.md +103 -0
- package/skill/references/interfaces/IRawWire.md +149 -0
- package/skill/references/interfaces/ISCH_DrcError.md +142 -0
- package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md +142 -0
- package/skill/references/interfaces/ISCH_ExportPngResolution.md +94 -0
- package/skill/references/interfaces/ISCH_NetInfo.md +88 -0
- package/skill/references/interfaces/ISCH_Primitive.md +219 -0
- package/skill/references/interfaces/ISCH_PrimitiveAPI.md +175 -0
- package/skill/references/interfaces/ISCH_ProjectNetInfo.md +142 -0
- package/skill/references/interfaces/ISCH_WireInfo.md +169 -0
- package/skill/references/interfaces/ISYS_FileSystemFileList.md +169 -0
- package/skill/references/interfaces/ISYS_HeaderMenuSub1MenuItem.md +174 -0
- package/skill/references/interfaces/ISYS_HeaderMenuSub2MenuItem.md +147 -0
- package/skill/references/interfaces/ISYS_HeaderMenuTopMenuItem.md +115 -0
- package/skill/references/interfaces/ISYS_HeaderMenus.md +408 -0
- package/skill/references/interfaces/ISYS_LogLine.md +115 -0
- package/skill/references/interfaces/ISYS_MathBBox.md +142 -0
- package/skill/references/interfaces/ISYS_MathPoint.md +88 -0
- package/skill/references/interfaces/ISYS_MathPolygonWithHoles.md +92 -0
- package/skill/references/interfaces/ISYS_MessageBusTask.md +115 -0
- package/skill/references/interfaces/ISYS_MultilingualLanguagesData.md +13 -0
- package/skill/references/interfaces/ISYS_PcbComparisonResponse.md +115 -0
- package/skill/references/interfaces/ISYS_RightClickMenuItem.md +174 -0
- package/skill/references/interfaces/ISYS_ShortcutKeyData.md +169 -0
- package/skill/references/interfaces/ISYS_ShortcutKeyDataWithCallFn.md +62 -0
- package/skill/references/interfaces/ISYS_ShortcutKeyDataWithUserDefinedShortcutKey.md +62 -0
- package/skill/references/interfaces/ISYS_WindowEventListenerRemovableObject.md +109 -0
- package/skill/references/interfaces/IconProps.md +88 -0
- package/skill/references/interfaces/ImageProps.md +115 -0
- package/skill/references/interfaces/InputProps.md +520 -0
- package/skill/references/interfaces/ListChildren.md +223 -0
- package/skill/references/interfaces/ListProps.md +223 -0
- package/skill/references/interfaces/ModalProps.md +358 -0
- package/skill/references/interfaces/RadioGroupProps.md +196 -0
- package/skill/references/interfaces/RadioItem.md +115 -0
- package/skill/references/interfaces/ScrollerProps.md +169 -0
- package/skill/references/interfaces/SelectListItem.md +142 -0
- package/skill/references/interfaces/SelectProps.md +169 -0
- package/skill/references/interfaces/SlotProps.md +88 -0
- package/skill/references/interfaces/StyleProps.md +385 -0
- package/skill/references/interfaces/TextAreaProps.md +196 -0
- package/skill/references/interfaces/TextProps.md +169 -0
- package/skill/references/types/ISYS_LanguageKeyValuePairs.md +13 -0
- package/skill/references/types/TPCB_LayerTypesOfInnerLayer.md +12 -0
- package/skill/references/types/TPCB_LayersInTheSelectable.md +43 -0
- package/skill/references/types/TPCB_LayersOfComponent.md +12 -0
- package/skill/references/types/TPCB_LayersOfCopper.md +16 -0
- package/skill/references/types/TPCB_LayersOfCustom.md +42 -0
- package/skill/references/types/TPCB_LayersOfDimension.md +17 -0
- package/skill/references/types/TPCB_LayersOfFill.md +29 -0
- package/skill/references/types/TPCB_LayersOfImage.md +23 -0
- package/skill/references/types/TPCB_LayersOfInner.md +42 -0
- package/skill/references/types/TPCB_LayersOfLine.md +26 -0
- package/skill/references/types/TPCB_LayersOfObject.md +13 -0
- package/skill/references/types/TPCB_LayersOfPad.md +12 -0
- package/skill/references/types/TPCB_LayersOfRegion.md +12 -0
- package/skill/references/types/TPCB_NumberOfCopperLayers.md +10 -0
- package/skill/references/types/TPCB_PolygonSourceArray.md +83 -0
- package/skill/references/types/TPCB_PrimitiveDimensionCoordinateSet.md +67 -0
- package/skill/references/types/TPCB_PrimitivePadHole.md +31 -0
- package/skill/references/types/TPCB_PrimitivePadShape.md +62 -0
- package/skill/references/types/TPCB_PrimitiveSpecialPadShape.md +20 -0
- package/skill/references/types/TSYS_MathPolygonGroup.md +16 -0
- package/skill/references/types/TSYS_MathPolygonInput.md +21 -0
- package/skill/references/types/TSYS_PcbComparisonErrorCode.md +10 -0
- package/skill/references/types/TSYS_ShortcutKeys.md +97 -0
- package/skill/user-guide/using-extension.md +47 -0
|
@@ -0,0 +1,3028 @@
|
|
|
1
|
+
# EasyEDA API 快速参考
|
|
2
|
+
|
|
3
|
+
> 此文件提供所有类及其方法/属性的签名一览,便于 AI 快速查找。
|
|
4
|
+
> 详细参数和返回值请查看 docs/classes/<ClassName>.md
|
|
5
|
+
|
|
6
|
+
## 全局入口
|
|
7
|
+
|
|
8
|
+
```typescript
|
|
9
|
+
declare const eda: EDA;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
EDA 类的属性即为各模块的入口,如 `eda.dmt_Board`, `eda.pcb_PrimitiveLine` 等。
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## DMT_Board
|
|
17
|
+
|
|
18
|
+
Document tree / Board management class
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
class DMT_Board
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
- **copyboard**: `function copyBoard(sourceBoardName: string): Promise<string | undefined>;`
|
|
25
|
+
- **createboard**: `function createBoard(schematicUuid?: string, pcbUuid?: string): Promise<string | undefined>;`
|
|
26
|
+
- **deleteboard**: `function deleteBoard(boardName: string): Promise<boolean>;`
|
|
27
|
+
- **getallboardsinfo**: `function getAllBoardsInfo(): Promise<Array<IDMT_BoardItem>>;`
|
|
28
|
+
- **getboardinfo**: `function getBoardInfo(boardName: string): Promise<IDMT_BoardItem | undefined>;`
|
|
29
|
+
- **getcurrentboardinfo**: `function getCurrentBoardInfo(): Promise<IDMT_BoardItem | undefined>;`
|
|
30
|
+
- **modifyboardname**: `function modifyBoardName(originalBoardName: string, boardName: string): Promise<boolean>;`
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## DMT_EditorControl
|
|
35
|
+
|
|
36
|
+
Document tree / Editor control class
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
class DMT_EditorControl
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
- **activatedocument**: `function activateDocument(tabId: string): Promise<boolean>;`
|
|
43
|
+
- **activatesplitscreen**: `function activateSplitScreen(splitScreenId: string): Promise<boolean>;`
|
|
44
|
+
- **closedocument**: `function closeDocument(tabId: string): Promise<boolean>;`
|
|
45
|
+
- **createsplitscreen**: `function createSplitScreen( splitScreenType: EDMT_EditorSplitScreenDirection, tabId: string, ): Promise<{ sourceSplitScreenId: string; newSplitScreenId: string } | undefined>;`
|
|
46
|
+
- **generateindicatormarkers**: `function generateIndicatorMarkers( markers: Array<IDMT_IndicatorMarkerShape>, color?: { r: number; g: number; b: number; alpha: number }, lineWidth?: number, zoom?: boolean, tabId?: string, ): Promise<boolean>;`
|
|
47
|
+
- **getcurrentrenderedareaimage**: `function getCurrentRenderedAreaImage(tabId?: string): Promise<Blob | undefined>;`
|
|
48
|
+
- **getsplitscreenidbytabid**: `function getSplitScreenIdByTabId(tabId: string): Promise<string | undefined>;`
|
|
49
|
+
- **getsplitscreentree**: `function getSplitScreenTree(): Promise<IDMT_EditorSplitScreenItem | undefined>;`
|
|
50
|
+
- **gettabsbysplitscreenid**: `function getTabsBySplitScreenId(splitScreenId: string): Promise<Array<IDMT_EditorTabItem>>;`
|
|
51
|
+
- **mergealldocumentfromsplitscreen**: `function mergeAllDocumentFromSplitScreen(): Promise<boolean>;`
|
|
52
|
+
- **movedocumenttosplitscreen**: `function moveDocumentToSplitScreen(tabId: string, splitScreenId: string): Promise<boolean>;`
|
|
53
|
+
- **opendocument**: `function openDocument(documentUuid: string, splitScreenId?: string): Promise<string | undefined>;`
|
|
54
|
+
- **openlibrarydocument**: `function openLibraryDocument( libraryUuid: string, libraryType: ELIB_LibraryType.SYMBOL | ELIB_LibraryType.FOOTPRINT, uuid: string, splitScreenId?: string, ): Promise<string | undefined>;`
|
|
55
|
+
- **removeindicatormarkers**: `function removeIndicatorMarkers(tabId?: string): Promise<boolean>;`
|
|
56
|
+
- **tilealldocumenttosplitscreen**: `function tileAllDocumentToSplitScreen(): Promise<boolean>;`
|
|
57
|
+
- **zoomto**: `function zoomTo( x?: number, y?: number, scaleRatio?: number, tabId?: string, ): Promise<{ left: number; right: number; top: number; bottom: number } | false>;`
|
|
58
|
+
- **zoomtoallprimitives**: `function zoomToAllPrimitives( tabId?: string, ): Promise<{ left: number; right: number; top: number; bottom: number } | false>;`
|
|
59
|
+
- **zoomtoregion**: `function zoomToRegion( left: number, right: number, top: number, bottom: number, tabId?: string, ): Promise<boolean>;`
|
|
60
|
+
- **zoomtoselectedprimitives**: `function zoomToSelectedPrimitives( tabId?: string, ): Promise<{ left: number; right: number; top: number; bottom: number } | false>;`
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## DMT_Event
|
|
65
|
+
|
|
66
|
+
Document tree / event class
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
class DMT_Event
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
- **addeditortabeventlistener**: `function addEditorTabEventListener( id: string, eventType: 'all' | EDMT_EditorTabEventType, callFn: ( eventType: EDMT_EditorTabEventType, props: { documentType: EDMT_EditorDocumentType; title: string; tabId: string }, ) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
73
|
+
- **iseventlisteneralreadyexist**: `function isEventListenerAlreadyExist(id: string): boolean;`
|
|
74
|
+
- **removeeventlistener**: `function removeEventListener(id: string): boolean;`
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## DMT_Folder
|
|
79
|
+
|
|
80
|
+
Document tree / Folder class
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
class DMT_Folder
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
- **createfolder**: `function createFolder( folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string, ): Promise<string | undefined>;`
|
|
87
|
+
- **deletefolder**: `function deleteFolder(teamUuid: string, folderUuid: string): Promise<boolean>;`
|
|
88
|
+
- **getallfoldersuuid**: `function getAllFoldersUuid(teamUuid: string): Promise<Array<string>>;`
|
|
89
|
+
- **getfolderinfo**: `function getFolderInfo(teamUuid: string, folderUuid: string): Promise<IDMT_FolderItem | undefined>;`
|
|
90
|
+
- **modifyfolderdescription**: `function modifyFolderDescription( teamUuid: string, folderUuid: string, description?: string, ): Promise<boolean>;`
|
|
91
|
+
- **modifyfoldername**: `function modifyFolderName( teamUuid: string, folderUuid: string, folderName: string, ): Promise<boolean>;`
|
|
92
|
+
- **movefoldertofolder**: `function moveFolderToFolder( teamUuid: string, folderUuid: string, parentFolderUuid?: string, ): Promise<boolean>;`
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## DMT_Panel
|
|
97
|
+
|
|
98
|
+
Document tree / Panel management class
|
|
99
|
+
|
|
100
|
+
```typescript
|
|
101
|
+
class DMT_Panel
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
- **copypanel**: `function copyPanel(panelUuid: string): Promise<string | undefined>;`
|
|
105
|
+
- **createpanel**: `function createPanel(): Promise<string | undefined>;`
|
|
106
|
+
- **deletepanel**: `function deletePanel(panelUuid: string): Promise<boolean>;`
|
|
107
|
+
- **getallpanelsinfo**: `function getAllPanelsInfo(): Promise<Array<IDMT_PanelItem>>;`
|
|
108
|
+
- **getcurrentpanelinfo**: `function getCurrentPanelInfo(): Promise<IDMT_PanelItem | undefined>;`
|
|
109
|
+
- **getpanelinfo**: `function getPanelInfo(panelUuid: string): Promise<IDMT_PanelItem | undefined>;`
|
|
110
|
+
- **modifypanelname**: `function modifyPanelName(panelUuid: string, panelName: string): Promise<boolean>;`
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## DMT_Pcb
|
|
115
|
+
|
|
116
|
+
Document tree / PCB management class
|
|
117
|
+
|
|
118
|
+
```typescript
|
|
119
|
+
class DMT_Pcb
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
- **copypcb**: `function copyPcb(pcbUuid: string, boardName?: string): Promise<string | undefined>;`
|
|
123
|
+
- **createpcb**: `function createPcb(boardName?: string): Promise<string | undefined>;`
|
|
124
|
+
- **deletepcb**: `function deletePcb(pcbUuid: string): Promise<boolean>;`
|
|
125
|
+
- **getallpcbsinfo**: `function getAllPcbsInfo(): Promise<Array<IDMT_PcbItem>>;`
|
|
126
|
+
- **getcurrentpcbinfo**: `function getCurrentPcbInfo(): Promise<IDMT_PcbItem | undefined>;`
|
|
127
|
+
- **getpcbinfo**: `function getPcbInfo(pcbUuid: string): Promise<IDMT_PcbItem | undefined>;`
|
|
128
|
+
- **modifypcbname**: `function modifyPcbName(pcbUuid: string, pcbName: string): Promise<boolean>;`
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## DMT_Project
|
|
133
|
+
|
|
134
|
+
Document tree / Project management class
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
class DMT_Project
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
- **createproject**: `function createProject( projectFriendlyName: string, projectName?: string, teamUuid?: string, folderUuid?: string, description?: string, collaborationMode?: EDMT_ProjectCollaborationMode, ): Promise<string | undefined>;`
|
|
141
|
+
- **getallprojectsuuid**: `function getAllProjectsUuid( teamUuid?: string, folderUuid?: string, workspaceUuid?: string, ): Promise<Array<string>>;`
|
|
142
|
+
- **getcurrentprojectinfo**: `function getCurrentProjectInfo(): Promise<IDMT_ProjectItem | undefined>;`
|
|
143
|
+
- **getprojectinfo**: `function getProjectInfo(projectUuid: string): Promise<IDMT_BriefProjectItem | undefined>;`
|
|
144
|
+
- **moveprojecttofolder**: `function moveProjectToFolder(projectUuid: string, folderUuid?: string): Promise<boolean>;`
|
|
145
|
+
- **openproject**: `function openProject(projectUuid: string): Promise<boolean>;`
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## DMT_Schematic
|
|
150
|
+
|
|
151
|
+
Document tree / Schematic management class
|
|
152
|
+
|
|
153
|
+
```typescript
|
|
154
|
+
class DMT_Schematic
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
- **copyschematic**: `function copySchematic(schematicUuid: string, boardName?: string): Promise<string | undefined>;`
|
|
158
|
+
- **copyschematicpage**: `function copySchematicPage( schematicPageUuid: string, schematicUuid?: string, ): Promise<string | undefined>;`
|
|
159
|
+
- **createschematic**: `function createSchematic(boardName?: string): Promise<string | undefined>;`
|
|
160
|
+
- **createschematicpage**: `function createSchematicPage(schematicUuid: string): Promise<string | undefined>;`
|
|
161
|
+
- **deleteschematic**: `function deleteSchematic(schematicUuid: string): Promise<boolean>;`
|
|
162
|
+
- **deleteschematicpage**: `function deleteSchematicPage(schematicPageUuid: string): Promise<boolean>;`
|
|
163
|
+
- **getallschematicpagesinfo**: `function getAllSchematicPagesInfo(): Promise<Array<IDMT_SchematicPageItem>>;`
|
|
164
|
+
- **getallschematicsinfo**: `function getAllSchematicsInfo(): Promise<Array<IDMT_SchematicItem>>;`
|
|
165
|
+
- **getcurrentschematicallschematicpagesinfo**: `function getCurrentSchematicAllSchematicPagesInfo(): Promise<Array<IDMT_SchematicPageItem>>;`
|
|
166
|
+
- **getcurrentschematicinfo**: `function getCurrentSchematicInfo(): Promise<IDMT_SchematicItem | undefined>;`
|
|
167
|
+
- **getcurrentschematicpageinfo**: `function getCurrentSchematicPageInfo(): Promise<IDMT_SchematicPageItem | undefined>;`
|
|
168
|
+
- **getschematicinfo**: `function getSchematicInfo(schematicUuid: string): Promise<IDMT_SchematicItem | undefined>;`
|
|
169
|
+
- **getschematicpageinfo**: `function getSchematicPageInfo( schematicPageUuid: string, ): Promise<IDMT_SchematicPageItem | undefined>;`
|
|
170
|
+
- **modifyschematicname**: `function modifySchematicName(schematicUuid: string, schematicName: string): Promise<boolean>;`
|
|
171
|
+
- **modifyschematicpagename**: `function modifySchematicPageName( schematicPageUuid: string, schematicPageName: string, ): Promise<boolean>;`
|
|
172
|
+
- **modifyschematicpagetitleblock**: `function modifySchematicPageTitleBlock( showTitleBlock?: boolean, titleBlockData?: Record< string, { showTitle?: undefined | false | true; showValue?: undefined | false | true; value?: any } >, ): Promise<boolean>;`
|
|
173
|
+
- **reorderschematicpages**: `function reorderSchematicPages( schematicUuid: string, schematicPageItemsArray: Array<IDMT_SchematicPageItem>, ): Promise<boolean>;`
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## DMT_SelectControl
|
|
178
|
+
|
|
179
|
+
Document tree / selection control class
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
class DMT_SelectControl
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
- **getcurrentdocumentinfo**: `function getCurrentDocumentInfo(): Promise<IDMT_EditorDocumentItem | undefined>;`
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
## DMT_Team
|
|
190
|
+
|
|
191
|
+
Document tree / Team class
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
class DMT_Team
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
- **getallinvolvedteaminfo**: `function getAllInvolvedTeamInfo(): Promise<Array<IDMT_TeamItem>>;`
|
|
198
|
+
- **getallteamsinfo**: `function getAllTeamsInfo(): Promise<Array<IDMT_TeamItem>>;`
|
|
199
|
+
- **getcurrentteaminfo**: `function getCurrentTeamInfo(): Promise<IDMT_TeamItem | undefined>;`
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## DMT_Workspace
|
|
204
|
+
|
|
205
|
+
Document tree / Workspace class
|
|
206
|
+
|
|
207
|
+
```typescript
|
|
208
|
+
class DMT_Workspace
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
- **getallworkspacesinfo**: `function getAllWorkspacesInfo(): Promise<Array<IDMT_WorkspaceItem>>;`
|
|
212
|
+
- **getcurrentworkspaceinfo**: `function getCurrentWorkspaceInfo(): Promise<IDMT_WorkspaceItem | undefined>;`
|
|
213
|
+
- **toggletoworkspace**: `function toggleToWorkspace(workspaceUuid?: string): Promise<boolean>;`
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## EDA
|
|
218
|
+
|
|
219
|
+
EasyEDA Pro user API interface
|
|
220
|
+
|
|
221
|
+
```typescript
|
|
222
|
+
eda: EDA;
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
- **dmt_board**: `function dmt_Board: DMT_Board;`
|
|
226
|
+
- **dmt_editorcontrol**: `function dmt_EditorControl: DMT_EditorControl;`
|
|
227
|
+
- **dmt_event**: `function dmt_Event: DMT_Event;`
|
|
228
|
+
- **dmt_folder**: `function dmt_Folder: DMT_Folder;`
|
|
229
|
+
- **dmt_panel**: `function dmt_Panel: DMT_Panel;`
|
|
230
|
+
- **dmt_pcb**: `function dmt_Pcb: DMT_Pcb;`
|
|
231
|
+
- **dmt_project**: `function dmt_Project: DMT_Project;`
|
|
232
|
+
- **dmt_schematic**: `function dmt_Schematic: DMT_Schematic;`
|
|
233
|
+
- **dmt_selectcontrol**: `function dmt_SelectControl: DMT_SelectControl;`
|
|
234
|
+
- **dmt_team**: `function dmt_Team: DMT_Team;`
|
|
235
|
+
- **dmt_workspace**: `function dmt_Workspace: DMT_Workspace;`
|
|
236
|
+
- **lib_3dmodel**: `function lib_3DModel: LIB_3DModel;`
|
|
237
|
+
- **lib_cbb**: `function lib_Cbb: LIB_Cbb;`
|
|
238
|
+
- **lib_classification**: `function lib_Classification: LIB_Classification;`
|
|
239
|
+
- **lib_device**: `function lib_Device: LIB_Device;`
|
|
240
|
+
- **lib_footprint**: `function lib_Footprint: LIB_Footprint;`
|
|
241
|
+
- **lib_librarieslist**: `function lib_LibrariesList: LIB_LibrariesList;`
|
|
242
|
+
- **lib_panellibrary**: `function lib_PanelLibrary: LIB_PanelLibrary;`
|
|
243
|
+
- **lib_selectcontrol**: `function lib_SelectControl: LIB_SelectControl;`
|
|
244
|
+
- **lib_simulationmodel**: `function lib_SimulationModel: LIB_SimulationModel;`
|
|
245
|
+
- **lib_symbol**: `function lib_Symbol: LIB_Symbol;`
|
|
246
|
+
- **pcb_document**: `function pcb_Document: PCB_Document;`
|
|
247
|
+
- **pcb_drc**: `function pcb_Drc: PCB_Drc;`
|
|
248
|
+
- **pcb_event**: `function pcb_Event: PCB_Event;`
|
|
249
|
+
- **pcb_layer**: `function pcb_Layer: PCB_Layer;`
|
|
250
|
+
- **pcb_manufacturedata**: `function pcb_ManufactureData: PCB_ManufactureData;`
|
|
251
|
+
- **pcb_mathpolygon**: `function pcb_MathPolygon: PCB_MathPolygon;`
|
|
252
|
+
- **pcb_net**: `function pcb_Net: PCB_Net;`
|
|
253
|
+
- **pcb_primitive**: `function pcb_Primitive: PCB_Primitive;`
|
|
254
|
+
- **pcb_primitivearc**: `function pcb_PrimitiveArc: PCB_PrimitiveArc;`
|
|
255
|
+
- **pcb_primitiveattribute**: `function pcb_PrimitiveAttribute: PCB_PrimitiveAttribute;`
|
|
256
|
+
- **pcb_primitivecomponent**: `function pcb_PrimitiveComponent: PCB_PrimitiveComponent;`
|
|
257
|
+
- **pcb_primitivedimension**: `function pcb_PrimitiveDimension: PCB_PrimitiveDimension;`
|
|
258
|
+
- **pcb_primitivefill**: `function pcb_PrimitiveFill: PCB_PrimitiveFill;`
|
|
259
|
+
- **pcb_primitiveimage**: `function pcb_PrimitiveImage: PCB_PrimitiveImage;`
|
|
260
|
+
- **pcb_primitiveline**: `function pcb_PrimitiveLine: PCB_PrimitiveLine;`
|
|
261
|
+
- **pcb_primitiveobject**: `function pcb_PrimitiveObject: PCB_PrimitiveObject;`
|
|
262
|
+
- **pcb_primitivepad**: `function pcb_PrimitivePad: PCB_PrimitivePad;`
|
|
263
|
+
- **pcb_primitivepolyline**: `function pcb_PrimitivePolyline: PCB_PrimitivePolyline;`
|
|
264
|
+
- **pcb_primitivepour**: `function pcb_PrimitivePour: PCB_PrimitivePour;`
|
|
265
|
+
- **pcb_primitivepoured**: `function pcb_PrimitivePoured: PCB_PrimitivePoured;`
|
|
266
|
+
- **pcb_primitiveregion**: `function pcb_PrimitiveRegion: PCB_PrimitiveRegion;`
|
|
267
|
+
- **pcb_primitivestring**: `function pcb_PrimitiveString: PCB_PrimitiveString;`
|
|
268
|
+
- **pcb_primitivevia**: `function pcb_PrimitiveVia: PCB_PrimitiveVia;`
|
|
269
|
+
- **pcb_raytracerengine**: `function pcb_RayTracerEngine: PCB_RayTracerEngine;`
|
|
270
|
+
- **pcb_selectcontrol**: `function pcb_SelectControl: PCB_SelectControl;`
|
|
271
|
+
- **pnl_document**: `function pnl_Document: PNL_Document;`
|
|
272
|
+
- **sch_document**: `function sch_Document: SCH_Document;`
|
|
273
|
+
- **sch_drc**: `function sch_Drc: SCH_Drc;`
|
|
274
|
+
- **sch_event**: `function sch_Event: SCH_Event;`
|
|
275
|
+
- **sch_manufacturedata**: `function sch_ManufactureData: SCH_ManufactureData;`
|
|
276
|
+
- **sch_net**: `function sch_Net: SCH_Net;`
|
|
277
|
+
- **sch_netlist**: `function sch_Netlist: SCH_Netlist;`
|
|
278
|
+
- **sch_primitive**: `function sch_Primitive: SCH_Primitive;`
|
|
279
|
+
- **sch_primitivearc**: `function sch_PrimitiveArc: SCH_PrimitiveArc;`
|
|
280
|
+
- **sch_primitiveattribute**: `function sch_PrimitiveAttribute: SCH_PrimitiveAttribute;`
|
|
281
|
+
- **sch_primitivebus**: `function sch_PrimitiveBus: SCH_PrimitiveBus;`
|
|
282
|
+
- **sch_primitivecircle**: `function sch_PrimitiveCircle: SCH_PrimitiveCircle;`
|
|
283
|
+
- **sch_primitivecomponent**: `function sch_PrimitiveComponent: SCH_PrimitiveComponent;`
|
|
284
|
+
- **sch_primitiveobject**: `function sch_PrimitiveObject: SCH_PrimitiveObject;`
|
|
285
|
+
- **sch_primitivepin**: `function sch_PrimitivePin: SCH_PrimitivePin;`
|
|
286
|
+
- **sch_primitivepolygon**: `function sch_PrimitivePolygon: SCH_PrimitivePolygon;`
|
|
287
|
+
- **sch_primitiverectangle**: `function sch_PrimitiveRectangle: SCH_PrimitiveRectangle;`
|
|
288
|
+
- **sch_primitivetext**: `function sch_PrimitiveText: SCH_PrimitiveText;`
|
|
289
|
+
- **sch_primitivewire**: `function sch_PrimitiveWire: SCH_PrimitiveWire;`
|
|
290
|
+
- **sch_selectcontrol**: `function sch_SelectControl: SCH_SelectControl;`
|
|
291
|
+
- **sch_simulationengine**: `function sch_SimulationEngine: SCH_SimulationEngine;`
|
|
292
|
+
- **sch_utils**: `function sch_Utils: SCH_Utils;`
|
|
293
|
+
- **sys_clienturl**: `function sys_ClientUrl: SYS_ClientUrl;`
|
|
294
|
+
- **sys_dialog**: `function sys_Dialog: SYS_Dialog;`
|
|
295
|
+
- **sys_environment**: `function sys_Environment: SYS_Environment;`
|
|
296
|
+
- **sys_filemanager**: `function sys_FileManager: SYS_FileManager;`
|
|
297
|
+
- **sys_filesystem**: `function sys_FileSystem: SYS_FileSystem;`
|
|
298
|
+
- **sys_fontmanager**: `function sys_FontManager: SYS_FontManager;`
|
|
299
|
+
- **sys_formatconversion**: `function sys_FormatConversion: SYS_FormatConversion;`
|
|
300
|
+
- **sys_headermenu**: `function sys_HeaderMenu: SYS_HeaderMenu;`
|
|
301
|
+
- **sys_i18n**: `function sys_I18n: SYS_I18n;`
|
|
302
|
+
- **sys_iframe**: `function sys_IFrame: SYS_IFrame;`
|
|
303
|
+
- **sys_loadingandprogressbar**: `function sys_LoadingAndProgressBar: SYS_LoadingAndProgressBar;`
|
|
304
|
+
- **sys_log**: `function sys_Log: SYS_Log;`
|
|
305
|
+
- **sys_math**: `function sys_Math: SYS_Math;`
|
|
306
|
+
- **sys_message**: `function sys_Message: SYS_Message;`
|
|
307
|
+
- **sys_messagebox**: `function sys_MessageBox: SYS_MessageBox;`
|
|
308
|
+
- **sys_messagebus**: `function sys_MessageBus: SYS_MessageBus;`
|
|
309
|
+
- **sys_panelcontrol**: `function sys_PanelControl: SYS_PanelControl;`
|
|
310
|
+
- **sys_rightclickmenu**: `function sys_RightClickMenu: SYS_RightClickMenu;`
|
|
311
|
+
- **sys_setting**: `function sys_Setting: SYS_Setting;`
|
|
312
|
+
- **sys_shortcutkey**: `function sys_ShortcutKey: SYS_ShortcutKey;`
|
|
313
|
+
- **sys_storage**: `function sys_Storage: SYS_Storage;`
|
|
314
|
+
- **sys_timer**: `function sys_Timer: SYS_Timer;`
|
|
315
|
+
- **sys_toastmessage**: `function sys_ToastMessage: SYS_ToastMessage;`
|
|
316
|
+
- **sys_tool**: `function sys_Tool: SYS_Tool;`
|
|
317
|
+
- **sys_unit**: `function sys_Unit: SYS_Unit;`
|
|
318
|
+
- **sys_websocket**: `function sys_WebSocket: SYS_WebSocket;`
|
|
319
|
+
- **sys_window**: `function sys_Window: SYS_Window;`
|
|
320
|
+
|
|
321
|
+
---
|
|
322
|
+
|
|
323
|
+
## IPCB_ComplexPolygon
|
|
324
|
+
|
|
325
|
+
Complex polygon
|
|
326
|
+
|
|
327
|
+
```typescript
|
|
328
|
+
class IPCB_ComplexPolygon
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
- **addsource**: `function addSource( complexPolygon: | TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | Array<IPCB_Polygon>, ): IPCB_ComplexPolygon;`
|
|
332
|
+
- **getcenter**: `function getCenter(): Promise<{ x: number; y: number }>;`
|
|
333
|
+
- **getsource**: `function getSource(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;`
|
|
334
|
+
- **getsourcestrictcomplex**: `function getSourceStrictComplex(): Array<TPCB_PolygonSourceArray>;`
|
|
335
|
+
- **topolygon**: `function toPolygon(): Array<IPCB_Polygon>;`
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
## IPCB_Polygon
|
|
340
|
+
|
|
341
|
+
Single polygon
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
class IPCB_Polygon
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
- **discretize**: `function discretize(options?: IPCB_DiscretizeOptions): Promise<Array<IPCB_DiscretizedPoint>>;`
|
|
348
|
+
- **getcenter**: `function getCenter(): Promise<{ x: number; y: number }>;`
|
|
349
|
+
- **getsource**: `function getSource(): TPCB_PolygonSourceArray;`
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
## IPCB_PrimitiveArc
|
|
354
|
+
|
|
355
|
+
Arc line primitive
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
class IPCB_PrimitiveArc implements IPCB_Primitive
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveArc>;`
|
|
362
|
+
- **getadjacentprimitives**: `function getAdjacentPrimitives(): Promise< Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc> >;`
|
|
363
|
+
- **getentiretrack**: `function getEntireTrack(includeVias: false): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;`
|
|
364
|
+
- **getentiretrack_1**: `function getEntireTrack( includeVias: true, ): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;`
|
|
365
|
+
- **getstate_arcangle**: `function getState_ArcAngle(): number;`
|
|
366
|
+
- **getstate_endx**: `function getState_EndX(): number;`
|
|
367
|
+
- **getstate_endy**: `function getState_EndY(): number;`
|
|
368
|
+
- **getstate_interactivemode**: `function getState_InteractiveMode(): EPCB_PrimitiveArcInteractiveMode;`
|
|
369
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfLine;`
|
|
370
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
371
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
372
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
373
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
374
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
375
|
+
- **getstate_startx**: `function getState_StartX(): number;`
|
|
376
|
+
- **getstate_starty**: `function getState_StartY(): number;`
|
|
377
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
378
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveArc>;`
|
|
379
|
+
- **setstate_arcangle**: `function setState_ArcAngle(arcAngle: number): IPCB_PrimitiveArc;`
|
|
380
|
+
- **setstate_endx**: `function setState_EndX(endX: number): IPCB_PrimitiveArc;`
|
|
381
|
+
- **setstate_endy**: `function setState_EndY(endY: number): IPCB_PrimitiveArc;`
|
|
382
|
+
- **setstate_interactivemode**: `function setState_InteractiveMode( interactiveMode: EPCB_PrimitiveArcInteractiveMode, ): IPCB_PrimitiveArc;`
|
|
383
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveArc;`
|
|
384
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveArc;`
|
|
385
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitiveArc;`
|
|
386
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveArc;`
|
|
387
|
+
- **setstate_startx**: `function setState_StartX(startX: number): IPCB_PrimitiveArc;`
|
|
388
|
+
- **setstate_starty**: `function setState_StartY(startY: number): IPCB_PrimitiveArc;`
|
|
389
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveArc;`
|
|
390
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveArc;`
|
|
391
|
+
|
|
392
|
+
---
|
|
393
|
+
|
|
394
|
+
## IPCB_PrimitiveAttribute
|
|
395
|
+
|
|
396
|
+
Property primitive
|
|
397
|
+
|
|
398
|
+
```typescript
|
|
399
|
+
class IPCB_PrimitiveAttribute implements IPCB_Primitive
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
- **_constructor_**: `function constructor( layer: TPCB_LayersOfImage, x: number | null, y: number | null, key: string, value: string, keyVisible: boolean, valueVisible: boolean, fontFamily: string, fontSize: number, lineWidth: number, alignMode: EPCB_PrimitiveStringAlignMode, rotation: number, reverse: boolean, expansion: number, mirror: boolean, primitiveLock: boolean, primitiveId: string, parentPrimitiveId: string, );`
|
|
403
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveAttribute>;`
|
|
404
|
+
- **getstate_alignmode**: `function getState_AlignMode(): EPCB_PrimitiveStringAlignMode;`
|
|
405
|
+
- **getstate_expansion**: `function getState_Expansion(): number;`
|
|
406
|
+
- **getstate_fontfamily**: `function getState_FontFamily(): string;`
|
|
407
|
+
- **getstate_fontsize**: `function getState_FontSize(): number;`
|
|
408
|
+
- **getstate_key**: `function getState_Key(): string;`
|
|
409
|
+
- **getstate_keyvisible**: `function getState_KeyVisible(): boolean;`
|
|
410
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfImage;`
|
|
411
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
412
|
+
- **getstate_mirror**: `function getState_Mirror(): boolean;`
|
|
413
|
+
- **getstate_parentprimitiveid**: `function getState_ParentPrimitiveId(): string;`
|
|
414
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
415
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
416
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
417
|
+
- **getstate_reverse**: `function getState_Reverse(): boolean;`
|
|
418
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
419
|
+
- **getstate_value**: `function getState_Value(): string;`
|
|
420
|
+
- **getstate_valuevisible**: `function getState_ValueVisible(): boolean;`
|
|
421
|
+
- **getstate_x**: `function getState_X(): number | null;`
|
|
422
|
+
- **getstate_y**: `function getState_Y(): number | null;`
|
|
423
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
424
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveAttribute>;`
|
|
425
|
+
- **setstate_alignmode**: `function setState_AlignMode(alignMode: EPCB_PrimitiveStringAlignMode): IPCB_PrimitiveAttribute;`
|
|
426
|
+
- **setstate_expansion**: `function setState_Expansion(expansion: number): IPCB_PrimitiveAttribute;`
|
|
427
|
+
- **setstate_fontfamily**: `function setState_FontFamily(fontFamily: string): IPCB_PrimitiveAttribute;`
|
|
428
|
+
- **setstate_fontsize**: `function setState_FontSize(fontSize: number): IPCB_PrimitiveAttribute;`
|
|
429
|
+
- **setstate_key**: `function setState_Key(key: string): IPCB_PrimitiveAttribute;`
|
|
430
|
+
- **setstate_keyvisible**: `function setState_KeyVisible(keyVisible: boolean): IPCB_PrimitiveAttribute;`
|
|
431
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveAttribute;`
|
|
432
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveAttribute;`
|
|
433
|
+
- **setstate_mirror**: `function setState_Mirror(mirror: boolean): IPCB_PrimitiveAttribute;`
|
|
434
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveAttribute;`
|
|
435
|
+
- **setstate_reverse**: `function setState_Reverse(reverse: boolean): IPCB_PrimitiveAttribute;`
|
|
436
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitiveAttribute;`
|
|
437
|
+
- **setstate_value**: `function setState_Value(value: string): IPCB_PrimitiveAttribute;`
|
|
438
|
+
- **setstate_valuevisible**: `function setState_ValueVisible(valueVisible: boolean): IPCB_PrimitiveAttribute;`
|
|
439
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitiveAttribute;`
|
|
440
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitiveAttribute;`
|
|
441
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveAttribute;`
|
|
442
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveAttribute;`
|
|
443
|
+
|
|
444
|
+
---
|
|
445
|
+
|
|
446
|
+
## IPCB_PrimitiveComponent
|
|
447
|
+
|
|
448
|
+
Device primitive
|
|
449
|
+
|
|
450
|
+
```typescript
|
|
451
|
+
class IPCB_PrimitiveComponent implements IPCB_Primitive
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveComponent>;`
|
|
455
|
+
- **getallpins**: `function getAllPins(): Promise<Array<IPCB_PrimitiveComponentPad>>;`
|
|
456
|
+
- **getstate_addintobom**: `function getState_AddIntoBom(): boolean;`
|
|
457
|
+
- **getstate_component**: `function getState_Component(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
458
|
+
- **getstate_designator**: `function getState_Designator(): string | undefined;`
|
|
459
|
+
- **getstate_footprint**: `function getState_Footprint(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
460
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfComponent;`
|
|
461
|
+
- **getstate_manufacturer**: `function getState_Manufacturer(): string | undefined;`
|
|
462
|
+
- **getstate_manufacturerid**: `function getState_ManufacturerId(): string | undefined;`
|
|
463
|
+
- **getstate_model3d**: `function getState_Model3D(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
464
|
+
- **getstate_name**: `function getState_Name(): string | undefined;`
|
|
465
|
+
- **getstate_otherproperty**: `function getState_OtherProperty(): Record<string, string | number | boolean> | undefined;`
|
|
466
|
+
- **getstate_pads**: `function getState_Pads(): Array<{ primitiveId: string; net: string; padNumber: string }> | undefined;`
|
|
467
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
468
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
469
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
470
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
471
|
+
- **getstate_supplier**: `function getState_Supplier(): string | undefined;`
|
|
472
|
+
- **getstate_supplierid**: `function getState_SupplierId(): string | undefined;`
|
|
473
|
+
- **getstate_uniqueid**: `function getState_UniqueId(): string | undefined;`
|
|
474
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
475
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
476
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
477
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveComponent>;`
|
|
478
|
+
- **setattribute**: `function setAttribute( key: string, value?: string | number | boolean, keyVisible?: boolean, valueVisible?: boolean, ): Promise<IPCB_PrimitiveAttribute>;`
|
|
479
|
+
- **setstate_addintobom**: `function setState_AddIntoBom(addIntoBom: boolean): IPCB_PrimitiveComponent;`
|
|
480
|
+
- **setstate_designator**: `function setState_Designator(designator: string | undefined): IPCB_PrimitiveComponent;`
|
|
481
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfComponent): IPCB_PrimitiveComponent;`
|
|
482
|
+
- **setstate_manufacturer**: `function setState_Manufacturer(manufacturer: string | undefined): IPCB_PrimitiveComponent;`
|
|
483
|
+
- **setstate_manufacturerid**: `function setState_ManufacturerId(manufacturerId: string | undefined): IPCB_PrimitiveComponent;`
|
|
484
|
+
- **setstate_name**: `function setState_Name(name: string | undefined): IPCB_PrimitiveComponent;`
|
|
485
|
+
- **setstate_otherproperty**: `function setState_OtherProperty( otherProperty: Record<string, string | number | boolean>, ): IPCB_PrimitiveComponent;`
|
|
486
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveComponent;`
|
|
487
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitiveComponent;`
|
|
488
|
+
- **setstate_supplier**: `function setState_Supplier(supplier: string | undefined): IPCB_PrimitiveComponent;`
|
|
489
|
+
- **setstate_supplierid**: `function setState_SupplierId(supplierId: string | undefined): IPCB_PrimitiveComponent;`
|
|
490
|
+
- **setstate_uniqueid**: `function setState_UniqueId(uniqueId: string | undefined): IPCB_PrimitiveComponent;`
|
|
491
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitiveComponent;`
|
|
492
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitiveComponent;`
|
|
493
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveComponent;`
|
|
494
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveComponent;`
|
|
495
|
+
|
|
496
|
+
---
|
|
497
|
+
|
|
498
|
+
## IPCB_PrimitiveComponentPad
|
|
499
|
+
|
|
500
|
+
Device pad primitive
|
|
501
|
+
|
|
502
|
+
```typescript
|
|
503
|
+
class IPCB_PrimitiveComponentPad extends IPCB_PrimitivePad
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveComponentPad>;`
|
|
507
|
+
- **getconnectedprimitives**: `function getConnectedPrimitives( onlyCentreConnection: true, ): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;`
|
|
508
|
+
- **getconnectedprimitives_1**: `function getConnectedPrimitives( onlyCentreConnection: false, ): Promise< Array< | IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia | IPCB_PrimitivePolyline | IPCB_PrimitiveFill > >;`
|
|
509
|
+
- **getstate_parentcomponentprimitiveid**: `function getState_ParentComponentPrimitiveId(): string;`
|
|
510
|
+
- **primitivetype**: `function readonly primitiveType: EPCB_PrimitiveType.COMPONENT_PAD;`
|
|
511
|
+
- **setstate_parentcomponentprimitiveid**: `function setState_ParentComponentPrimitiveId(): IPCB_PrimitiveComponentPad;`
|
|
512
|
+
|
|
513
|
+
---
|
|
514
|
+
|
|
515
|
+
## IPCB_PrimitiveDimension
|
|
516
|
+
|
|
517
|
+
Dimension primitive
|
|
518
|
+
|
|
519
|
+
```typescript
|
|
520
|
+
class IPCB_PrimitiveDimension implements IPCB_Primitive
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveDimension>;`
|
|
524
|
+
- **getstate_coordinateset**: `function getState_CoordinateSet(): TPCB_PrimitiveDimensionCoordinateSet;`
|
|
525
|
+
- **getstate_dimensiontype**: `function getState_DimensionType(): EPCB_PrimitiveDimensionType;`
|
|
526
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfDimension;`
|
|
527
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
528
|
+
- **getstate_precision**: `function getState_Precision(): number;`
|
|
529
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
530
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
531
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
532
|
+
- **getstate_textfollow**: `function getState_TextFollow(): 0 | 1;`
|
|
533
|
+
- **getstate_unit**: `function getState_Unit(): ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.INCH | ESYS_Unit.MIL;`
|
|
534
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
535
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveDimension>;`
|
|
536
|
+
- **setstate_coordinateset**: `function setState_CoordinateSet( coordinateSet: TPCB_PrimitiveDimensionCoordinateSet, ): IPCB_PrimitiveDimension;`
|
|
537
|
+
- **setstate_dimensiontype**: `function setState_DimensionType( dimensionType: EPCB_PrimitiveDimensionType, ): IPCB_PrimitiveDimension;`
|
|
538
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfDimension): IPCB_PrimitiveDimension;`
|
|
539
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveDimension;`
|
|
540
|
+
- **setstate_precision**: `function setState_Precision(precision: number): IPCB_PrimitiveDimension;`
|
|
541
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveDimension;`
|
|
542
|
+
- **setstate_unit**: `function setState_Unit( unit: ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.INCH | ESYS_Unit.MIL, ): IPCB_PrimitiveDimension;`
|
|
543
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveDimension;`
|
|
544
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveDimension;`
|
|
545
|
+
|
|
546
|
+
---
|
|
547
|
+
|
|
548
|
+
## IPCB_PrimitiveFill
|
|
549
|
+
|
|
550
|
+
Fill primitive
|
|
551
|
+
|
|
552
|
+
```typescript
|
|
553
|
+
class IPCB_PrimitiveFill implements IPCB_Primitive
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
- **converttopolyline**: `function convertToPolyline(): Promise<IPCB_PrimitivePolyline>;`
|
|
557
|
+
- **converttopour**: `function convertToPour(): Promise<IPCB_PrimitivePour>;`
|
|
558
|
+
- **converttoregion**: `function convertToRegion(): Promise<IPCB_PrimitiveRegion>;`
|
|
559
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveFill>;`
|
|
560
|
+
- **getstate_complexpolygon**: `function getState_ComplexPolygon(): IPCB_Polygon;`
|
|
561
|
+
- **getstate_fillmode**: `function getState_FillMode(): EPCB_PrimitiveFillMode | undefined;`
|
|
562
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfFill;`
|
|
563
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
564
|
+
- **getstate_net**: `function getState_Net(): string | undefined;`
|
|
565
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
566
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
567
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
568
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
569
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveFill>;`
|
|
570
|
+
- **setstate_complexpolygon**: `function setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveFill;`
|
|
571
|
+
- **setstate_fillmode**: `function setState_FillMode(fillMode: EPCB_PrimitiveFillMode): IPCB_PrimitiveFill;`
|
|
572
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfFill): IPCB_PrimitiveFill;`
|
|
573
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveFill;`
|
|
574
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitiveFill;`
|
|
575
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveFill;`
|
|
576
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveFill;`
|
|
577
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveFill;`
|
|
578
|
+
|
|
579
|
+
---
|
|
580
|
+
|
|
581
|
+
## IPCB_PrimitiveImage
|
|
582
|
+
|
|
583
|
+
Image primitive
|
|
584
|
+
|
|
585
|
+
```typescript
|
|
586
|
+
class IPCB_PrimitiveImage implements IPCB_Primitive
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveImage>;`
|
|
590
|
+
- **getstate_complexpolygon**: `function getState_ComplexPolygon(): TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>;`
|
|
591
|
+
- **getstate_height**: `function getState_Height(): number;`
|
|
592
|
+
- **getstate_horizonmirror**: `function getState_HorizonMirror(): boolean;`
|
|
593
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfImage;`
|
|
594
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
595
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
596
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
597
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
598
|
+
- **getstate_width**: `function getState_Width(): number;`
|
|
599
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
600
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
601
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
602
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveImage>;`
|
|
603
|
+
- **setstate_height**: `function setState_Height(height: number): IPCB_PrimitiveImage;`
|
|
604
|
+
- **setstate_horizonmirror**: `function setState_HorizonMirror(horizonMirror: boolean): IPCB_PrimitiveImage;`
|
|
605
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveImage;`
|
|
606
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;`
|
|
607
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitiveImage;`
|
|
608
|
+
- **setstate_width**: `function setState_Width(width: number): IPCB_PrimitiveImage;`
|
|
609
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitiveImage;`
|
|
610
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitiveImage;`
|
|
611
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveImage;`
|
|
612
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveImage;`
|
|
613
|
+
|
|
614
|
+
---
|
|
615
|
+
|
|
616
|
+
## IPCB_PrimitiveLine
|
|
617
|
+
|
|
618
|
+
Line primitive
|
|
619
|
+
|
|
620
|
+
```typescript
|
|
621
|
+
class IPCB_PrimitiveLine implements IPCB_Primitive
|
|
622
|
+
```
|
|
623
|
+
|
|
624
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveLine>;`
|
|
625
|
+
- **getadjacentprimitives**: `function getAdjacentPrimitives(): Promise< Array<IPCB_PrimitiveLine | IPCB_PrimitiveVia | IPCB_PrimitiveArc> >;`
|
|
626
|
+
- **getentiretrack**: `function getEntireTrack(includeVias: false): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;`
|
|
627
|
+
- **getentiretrack_1**: `function getEntireTrack( includeVias: true, ): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc | IPCB_PrimitiveVia>>;`
|
|
628
|
+
- **getstate_endx**: `function getState_EndX(): number;`
|
|
629
|
+
- **getstate_endy**: `function getState_EndY(): number;`
|
|
630
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfLine;`
|
|
631
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
632
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
633
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
634
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
635
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
636
|
+
- **getstate_startx**: `function getState_StartX(): number;`
|
|
637
|
+
- **getstate_starty**: `function getState_StartY(): number;`
|
|
638
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
639
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveLine>;`
|
|
640
|
+
- **setstate_endx**: `function setState_EndX(endX: number): IPCB_PrimitiveLine;`
|
|
641
|
+
- **setstate_endy**: `function setState_EndY(endY: number): IPCB_PrimitiveLine;`
|
|
642
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitiveLine;`
|
|
643
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveLine;`
|
|
644
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitiveLine;`
|
|
645
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveLine;`
|
|
646
|
+
- **setstate_startx**: `function setState_StartX(startX: number): IPCB_PrimitiveLine;`
|
|
647
|
+
- **setstate_starty**: `function setState_StartY(startY: number): IPCB_PrimitiveLine;`
|
|
648
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveLine;`
|
|
649
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveLine;`
|
|
650
|
+
|
|
651
|
+
---
|
|
652
|
+
|
|
653
|
+
## IPCB_PrimitiveObject
|
|
654
|
+
|
|
655
|
+
Binary embedded object primitive
|
|
656
|
+
|
|
657
|
+
```typescript
|
|
658
|
+
class IPCB_PrimitiveObject implements IPCB_Primitive
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveObject>;`
|
|
662
|
+
- **getstate_binarydata**: `function getState_BinaryData(): string;`
|
|
663
|
+
- **getstate_filename**: `function getState_FileName(): string;`
|
|
664
|
+
- **getstate_height**: `function getState_Height(): number;`
|
|
665
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfObject | undefined;`
|
|
666
|
+
- **getstate_mirror**: `function getState_Mirror(): boolean;`
|
|
667
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
668
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
669
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
670
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
671
|
+
- **getstate_topleftx**: `function getState_TopLeftX(): number | undefined;`
|
|
672
|
+
- **getstate_toplefty**: `function getState_TopLeftY(): number | undefined;`
|
|
673
|
+
- **getstate_width**: `function getState_Width(): number;`
|
|
674
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
675
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveObject>;`
|
|
676
|
+
- **setstate_binarydata**: `function setState_BinaryData(binaryData: string): IPCB_PrimitiveObject;`
|
|
677
|
+
- **setstate_filename**: `function setState_FileName(fileName: string): IPCB_PrimitiveObject;`
|
|
678
|
+
- **setstate_height**: `function setState_Height(height: number): IPCB_PrimitiveObject;`
|
|
679
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfObject): IPCB_PrimitiveObject;`
|
|
680
|
+
- **setstate_mirror**: `function setState_Mirror(mirror: boolean): IPCB_PrimitiveObject;`
|
|
681
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveObject;`
|
|
682
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitiveObject;`
|
|
683
|
+
- **setstate_topleftx**: `function setState_TopLeftX(topLeftX: number): IPCB_PrimitiveObject;`
|
|
684
|
+
- **setstate_toplefty**: `function setState_TopLeftY(topLeftY: number): IPCB_PrimitiveObject;`
|
|
685
|
+
- **setstate_width**: `function setState_Width(width: number): IPCB_PrimitiveObject;`
|
|
686
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveObject;`
|
|
687
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveObject;`
|
|
688
|
+
|
|
689
|
+
---
|
|
690
|
+
|
|
691
|
+
## IPCB_PrimitivePad
|
|
692
|
+
|
|
693
|
+
Pad primitive
|
|
694
|
+
|
|
695
|
+
```typescript
|
|
696
|
+
class IPCB_PrimitivePad implements IPCB_Primitive
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
- **async**: `function async: boolean;`
|
|
700
|
+
- **create**: `function create(): Promise<IPCB_PrimitivePad>;`
|
|
701
|
+
- **done**: `function done(): Promise<IPCB_PrimitivePad>;`
|
|
702
|
+
- **getstate_heatwelding**: `function getState_HeatWelding(): IPCB_PrimitivePadHeatWelding | null;`
|
|
703
|
+
- **getstate_hole**: `function getState_Hole(): TPCB_PrimitivePadHole | null;`
|
|
704
|
+
- **getstate_holeoffsetx**: `function getState_HoleOffsetX(): number;`
|
|
705
|
+
- **getstate_holeoffsety**: `function getState_HoleOffsetY(): number;`
|
|
706
|
+
- **getstate_holerotation**: `function getState_HoleRotation(): number;`
|
|
707
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfPad;`
|
|
708
|
+
- **getstate_metallization**: `function getState_Metallization(): boolean;`
|
|
709
|
+
- **getstate_net**: `function getState_Net(): string | undefined;`
|
|
710
|
+
- **getstate_pad**: `function getState_Pad(): TPCB_PrimitivePadShape | undefined;`
|
|
711
|
+
- **getstate_padnumber**: `function getState_PadNumber(): string;`
|
|
712
|
+
- **getstate_padtype**: `function getState_PadType(): EPCB_PrimitivePadType;`
|
|
713
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
714
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
715
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
716
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
717
|
+
- **getstate_soldermaskandpastemaskexpansion**: `function getState_SolderMaskAndPasteMaskExpansion(): IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null;`
|
|
718
|
+
- **getstate_specialpad**: `function getState_SpecialPad(): TPCB_PrimitiveSpecialPadShape | undefined;`
|
|
719
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
720
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
721
|
+
- **heatwelding**: `function heatWelding: IPCB_PrimitivePadHeatWelding | null;`
|
|
722
|
+
- **hole**: `function hole: TPCB_PrimitivePadHole | null;`
|
|
723
|
+
- **holeoffsetx**: `function holeOffsetX: number;`
|
|
724
|
+
- **holeoffsety**: `function holeOffsetY: number;`
|
|
725
|
+
- **holerotation**: `function holeRotation: number;`
|
|
726
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
727
|
+
- **layer**: `function layer: TPCB_LayersOfPad;`
|
|
728
|
+
- **metallization**: `function metallization: boolean;`
|
|
729
|
+
- **net**: `function net?: string;`
|
|
730
|
+
- **pad**: `function pad?: TPCB_PrimitivePadShape;`
|
|
731
|
+
- **padnumber**: `function padNumber: string;`
|
|
732
|
+
- **padtype**: `function padType: EPCB_PrimitivePadType;`
|
|
733
|
+
- **primitiveid**: `function primitiveId?: string;`
|
|
734
|
+
- **primitivelock**: `function primitiveLock: boolean;`
|
|
735
|
+
- **primitivetype**: `function readonly primitiveType: EPCB_PrimitiveType;`
|
|
736
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitivePad>;`
|
|
737
|
+
- **rotation**: `function rotation: number;`
|
|
738
|
+
- **setstate_heatwelding**: `function setState_HeatWelding(heatWelding: IPCB_PrimitivePadHeatWelding | null): IPCB_PrimitivePad;`
|
|
739
|
+
- **setstate_hole**: `function setState_Hole(hole: TPCB_PrimitivePadHole): IPCB_PrimitivePad;`
|
|
740
|
+
- **setstate_holeoffsetx**: `function setState_HoleOffsetX(holeOffsetX: number): IPCB_PrimitivePad;`
|
|
741
|
+
- **setstate_holeoffsety**: `function setState_HoleOffsetY(holeOffsetY: number): IPCB_PrimitivePad;`
|
|
742
|
+
- **setstate_holerotation**: `function setState_HoleRotation(holeRotation: number): IPCB_PrimitivePad;`
|
|
743
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfPad): IPCB_PrimitivePad;`
|
|
744
|
+
- **setstate_metallization**: `function setState_Metallization(metallization: boolean): IPCB_PrimitivePad;`
|
|
745
|
+
- **setstate_net**: `function setState_Net(net?: string): IPCB_PrimitivePad;`
|
|
746
|
+
- **setstate_pad**: `function setState_Pad(pad: TPCB_PrimitivePadShape): IPCB_PrimitivePad;`
|
|
747
|
+
- **setstate_padnumber**: `function setState_PadNumber(padNumber: string): IPCB_PrimitivePad;`
|
|
748
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitivePad;`
|
|
749
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitivePad;`
|
|
750
|
+
- **setstate_soldermaskandpastemaskexpansion**: `function setState_SolderMaskAndPasteMaskExpansion( solderMaskAndPasteMaskExpansion: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null, ): IPCB_PrimitivePad;`
|
|
751
|
+
- **setstate_specialpad**: `function setState_SpecialPad(specialPad: TPCB_PrimitiveSpecialPadShape): IPCB_PrimitivePad;`
|
|
752
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitivePad;`
|
|
753
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitivePad;`
|
|
754
|
+
- **soldermaskandpastemaskexpansion**: `function solderMaskAndPasteMaskExpansion: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null;`
|
|
755
|
+
- **specialpad**: `function specialPad?: TPCB_PrimitiveSpecialPadShape;`
|
|
756
|
+
- **toasync**: `function toAsync(): IPCB_PrimitivePad;`
|
|
757
|
+
- **tosync**: `function toSync(): IPCB_PrimitivePad;`
|
|
758
|
+
- **x**: `function x: number;`
|
|
759
|
+
- **y**: `function y: number;`
|
|
760
|
+
|
|
761
|
+
---
|
|
762
|
+
|
|
763
|
+
## IPCB_PrimitivePolyline
|
|
764
|
+
|
|
765
|
+
Polyline primitive
|
|
766
|
+
|
|
767
|
+
```typescript
|
|
768
|
+
class IPCB_PrimitivePolyline implements IPCB_Primitive
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
- **converttofill**: `function convertToFill(): Promise<IPCB_PrimitiveFill>;`
|
|
772
|
+
- **converttopour**: `function convertToPour(): Promise<IPCB_PrimitivePour>;`
|
|
773
|
+
- **converttoregion**: `function convertToRegion(): Promise<IPCB_PrimitiveRegion>;`
|
|
774
|
+
- **done**: `function done(): Promise<IPCB_PrimitivePolyline>;`
|
|
775
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfLine;`
|
|
776
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
777
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
778
|
+
- **getstate_polygon**: `function getState_Polygon(): IPCB_Polygon;`
|
|
779
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
780
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
781
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
782
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
783
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitivePolyline>;`
|
|
784
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfLine): IPCB_PrimitivePolyline;`
|
|
785
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitivePolyline;`
|
|
786
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitivePolyline;`
|
|
787
|
+
- **setstate_polygon**: `function setState_Polygon(polygon: IPCB_Polygon): IPCB_PrimitivePolyline;`
|
|
788
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitivePolyline;`
|
|
789
|
+
- **toasync**: `function toAsync(): IPCB_PrimitivePolyline;`
|
|
790
|
+
- **tosync**: `function toSync(): IPCB_PrimitivePolyline;`
|
|
791
|
+
|
|
792
|
+
---
|
|
793
|
+
|
|
794
|
+
## IPCB_PrimitivePour
|
|
795
|
+
|
|
796
|
+
Copper border primitive
|
|
797
|
+
|
|
798
|
+
```typescript
|
|
799
|
+
class IPCB_PrimitivePour implements IPCB_Primitive
|
|
800
|
+
```
|
|
801
|
+
|
|
802
|
+
- **converttofill**: `function convertToFill(): Promise<IPCB_PrimitiveFill>;`
|
|
803
|
+
- **converttopolyline**: `function convertToPolyline(): Promise<IPCB_PrimitivePolyline>;`
|
|
804
|
+
- **converttoregion**: `function convertToRegion(): Promise<IPCB_PrimitiveRegion>;`
|
|
805
|
+
- **done**: `function done(): Promise<IPCB_PrimitivePour>;`
|
|
806
|
+
- **getcopperregion**: `function getCopperRegion(): Promise<IPCB_PrimitivePoured | undefined>;`
|
|
807
|
+
- **getstate_complexpolygon**: `function getState_ComplexPolygon(): IPCB_Polygon;`
|
|
808
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfCopper;`
|
|
809
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
810
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
811
|
+
- **getstate_pourfillmethod**: `function getState_PourFillMethod(): any;`
|
|
812
|
+
- **getstate_pourname**: `function getState_PourName(): string;`
|
|
813
|
+
- **getstate_pourpriority**: `function getState_PourPriority(): number;`
|
|
814
|
+
- **getstate_preservesilos**: `function getState_PreserveSilos(): boolean;`
|
|
815
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
816
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
817
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
818
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
819
|
+
- **rebuildcopperregion**: `function rebuildCopperRegion(): Promise<IPCB_PrimitivePoured | undefined>;`
|
|
820
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitivePour>;`
|
|
821
|
+
- **setstate_complexpolygon**: `function setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitivePour;`
|
|
822
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfCopper): IPCB_PrimitivePour;`
|
|
823
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitivePour;`
|
|
824
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitivePour;`
|
|
825
|
+
- **setstate_pourfillmethod**: `function setState_PourFillMethod(pourFillMethod: EPCB_PrimitivePourFillMethod): IPCB_PrimitivePour;`
|
|
826
|
+
- **setstate_pourname**: `function setState_PourName(pourName: string): IPCB_PrimitivePour;`
|
|
827
|
+
- **setstate_pourpriority**: `function setState_PourPriority(pourPriority: number): IPCB_PrimitivePour;`
|
|
828
|
+
- **setstate_preservesilos**: `function setState_PreserveSilos(preserveSilos: boolean): IPCB_PrimitivePour;`
|
|
829
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitivePour;`
|
|
830
|
+
- **toasync**: `function toAsync(): IPCB_PrimitivePour;`
|
|
831
|
+
- **tosync**: `function toSync(): IPCB_PrimitivePour;`
|
|
832
|
+
|
|
833
|
+
---
|
|
834
|
+
|
|
835
|
+
## IPCB_PrimitivePoured
|
|
836
|
+
|
|
837
|
+
Copper fill primitive
|
|
838
|
+
|
|
839
|
+
```typescript
|
|
840
|
+
class IPCB_PrimitivePoured implements IPCB_Primitive
|
|
841
|
+
```
|
|
842
|
+
|
|
843
|
+
- **addsoldermaskfill**: `function addSolderMaskFill( pourFillId: IPCB_PrimitivePouredPourFill['id'], ): Promise<IPCB_PrimitiveFill | undefined>;`
|
|
844
|
+
- **converttofill**: `function convertToFill( pourFillId: IPCB_PrimitivePouredPourFill['id'], ): Promise<IPCB_PrimitiveFill | undefined>;`
|
|
845
|
+
- **deletepourfills**: `function deletePourFills( pourFillIds: IPCB_PrimitivePouredPourFill['id'] | Array<IPCB_PrimitivePouredPourFill['id']>, ): Promise<boolean>;`
|
|
846
|
+
- **getstate_pourfills**: `function getState_PourFills(): Array<IPCB_PrimitivePouredPourFill>;`
|
|
847
|
+
- **getstate_pourprimitiveid**: `function getState_PourPrimitiveId(): string;`
|
|
848
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
849
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
850
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitivePoured>;`
|
|
851
|
+
|
|
852
|
+
---
|
|
853
|
+
|
|
854
|
+
## IPCB_PrimitiveRegion
|
|
855
|
+
|
|
856
|
+
Region primitive
|
|
857
|
+
|
|
858
|
+
```typescript
|
|
859
|
+
class IPCB_PrimitiveRegion implements IPCB_Primitive
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
- **converttofill**: `function convertToFill(): Promise<IPCB_PrimitiveFill>;`
|
|
863
|
+
- **converttopolyline**: `function convertToPolyline(): Promise<IPCB_PrimitivePolyline>;`
|
|
864
|
+
- **converttopour**: `function convertToPour(): Promise<IPCB_PrimitivePour>;`
|
|
865
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveRegion>;`
|
|
866
|
+
- **getstate_complexpolygon**: `function getState_ComplexPolygon(): IPCB_Polygon;`
|
|
867
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfRegion;`
|
|
868
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
869
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
870
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
871
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
872
|
+
- **getstate_regionname**: `function getState_RegionName(): string | undefined;`
|
|
873
|
+
- **getstate_ruletype**: `function getState_RuleType(): Array<EPCB_PrimitiveRegionRuleType>;`
|
|
874
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
875
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveRegion>;`
|
|
876
|
+
- **setstate_complexpolygon**: `function setState_ComplexPolygon(complexPolygon: IPCB_Polygon): IPCB_PrimitiveRegion;`
|
|
877
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfRegion): IPCB_PrimitiveRegion;`
|
|
878
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveRegion;`
|
|
879
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveRegion;`
|
|
880
|
+
- **setstate_regionname**: `function setState_RegionName(regionName?: string): IPCB_PrimitiveRegion;`
|
|
881
|
+
- **setstate_ruletype**: `function setState_RuleType(ruleType: Array<EPCB_PrimitiveRegionRuleType>): IPCB_PrimitiveRegion;`
|
|
882
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveRegion;`
|
|
883
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveRegion;`
|
|
884
|
+
|
|
885
|
+
---
|
|
886
|
+
|
|
887
|
+
## IPCB_PrimitiveString
|
|
888
|
+
|
|
889
|
+
Text primitive
|
|
890
|
+
|
|
891
|
+
```typescript
|
|
892
|
+
class IPCB_PrimitiveString implements IPCB_Primitive
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
- **_constructor_**: `function constructor( layer: TPCB_LayersOfImage, x: number, y: number, text: string, fontFamily?: string, fontSize?: number, lineWidth?: number, alignMode?: EPCB_PrimitiveStringAlignMode, rotation?: number, reverse?: boolean, expansion?: number, mirror?: boolean, primitiveLock?: boolean, primitiveId?: string, );`
|
|
896
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveString>;`
|
|
897
|
+
- **getstate_alignmode**: `function getState_AlignMode(): EPCB_PrimitiveStringAlignMode;`
|
|
898
|
+
- **getstate_expansion**: `function getState_Expansion(): number;`
|
|
899
|
+
- **getstate_fontfamily**: `function getState_FontFamily(): string;`
|
|
900
|
+
- **getstate_fontsize**: `function getState_FontSize(): number;`
|
|
901
|
+
- **getstate_layer**: `function getState_Layer(): TPCB_LayersOfImage;`
|
|
902
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number;`
|
|
903
|
+
- **getstate_mirror**: `function getState_Mirror(): boolean;`
|
|
904
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
905
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
906
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
907
|
+
- **getstate_reverse**: `function getState_Reverse(): boolean;`
|
|
908
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
909
|
+
- **getstate_text**: `function getState_Text(): string;`
|
|
910
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
911
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
912
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
913
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveString>;`
|
|
914
|
+
- **setstate_alignmode**: `function setState_AlignMode(alignMode: EPCB_PrimitiveStringAlignMode): IPCB_PrimitiveString;`
|
|
915
|
+
- **setstate_expansion**: `function setState_Expansion(expansion: number): IPCB_PrimitiveString;`
|
|
916
|
+
- **setstate_fontfamily**: `function setState_FontFamily(fontFamily: string): IPCB_PrimitiveString;`
|
|
917
|
+
- **setstate_fontsize**: `function setState_FontSize(fontSize: number): IPCB_PrimitiveString;`
|
|
918
|
+
- **setstate_layer**: `function setState_Layer(layer: TPCB_LayersOfImage): IPCB_PrimitiveString;`
|
|
919
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number): IPCB_PrimitiveString;`
|
|
920
|
+
- **setstate_mirror**: `function setState_Mirror(mirror: boolean): IPCB_PrimitiveString;`
|
|
921
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveString;`
|
|
922
|
+
- **setstate_reverse**: `function setState_Reverse(reverse: boolean): IPCB_PrimitiveString;`
|
|
923
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): IPCB_PrimitiveString;`
|
|
924
|
+
- **setstate_text**: `function setState_Text(text: string): IPCB_PrimitiveString;`
|
|
925
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitiveString;`
|
|
926
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitiveString;`
|
|
927
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveString;`
|
|
928
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveString;`
|
|
929
|
+
|
|
930
|
+
---
|
|
931
|
+
|
|
932
|
+
## IPCB_PrimitiveVia
|
|
933
|
+
|
|
934
|
+
Via primitive
|
|
935
|
+
|
|
936
|
+
```typescript
|
|
937
|
+
class IPCB_PrimitiveVia implements IPCB_Primitive
|
|
938
|
+
```
|
|
939
|
+
|
|
940
|
+
- **done**: `function done(): Promise<IPCB_PrimitiveVia>;`
|
|
941
|
+
- **getadjacentprimitives**: `function getAdjacentPrimitives(): Promise<Array<IPCB_PrimitiveLine | IPCB_PrimitiveArc>>;`
|
|
942
|
+
- **getstate_designruleblindvianame**: `function getState_DesignRuleBlindViaName(): string | null;`
|
|
943
|
+
- **getstate_diameter**: `function getState_Diameter(): number;`
|
|
944
|
+
- **getstate_holediameter**: `function getState_HoleDiameter(): number;`
|
|
945
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
946
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
947
|
+
- **getstate_primitivelock**: `function getState_PrimitiveLock(): boolean;`
|
|
948
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): EPCB_PrimitiveType;`
|
|
949
|
+
- **getstate_soldermaskexpansion**: `function getState_SolderMaskExpansion(): IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null;`
|
|
950
|
+
- **getstate_viatype**: `function getState_ViaType(): EPCB_PrimitiveViaType;`
|
|
951
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
952
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
953
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
954
|
+
- **reset**: `function reset(): Promise<IPCB_PrimitiveVia>;`
|
|
955
|
+
- **setstate_designruleblindvianame**: `function setState_DesignRuleBlindViaName(designRuleBlindViaName: string | null): IPCB_PrimitiveVia;`
|
|
956
|
+
- **setstate_diameter**: `function setState_Diameter(diameter: number): IPCB_PrimitiveVia;`
|
|
957
|
+
- **setstate_holediameter**: `function setState_HoleDiameter(holeDiameter: number): IPCB_PrimitiveVia;`
|
|
958
|
+
- **setstate_net**: `function setState_Net(net: string): IPCB_PrimitiveVia;`
|
|
959
|
+
- **setstate_primitivelock**: `function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveVia;`
|
|
960
|
+
- **setstate_soldermaskexpansion**: `function setState_SolderMaskExpansion( solderMaskExpansion: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null, ): IPCB_PrimitiveVia;`
|
|
961
|
+
- **setstate_viatype**: `function setState_ViaType(viaType: EPCB_PrimitiveViaType): IPCB_PrimitiveVia;`
|
|
962
|
+
- **setstate_x**: `function setState_X(x: number): IPCB_PrimitiveVia;`
|
|
963
|
+
- **setstate_y**: `function setState_Y(y: number): IPCB_PrimitiveVia;`
|
|
964
|
+
- **toasync**: `function toAsync(): IPCB_PrimitiveVia;`
|
|
965
|
+
- **tosync**: `function toSync(): IPCB_PrimitiveVia;`
|
|
966
|
+
|
|
967
|
+
---
|
|
968
|
+
|
|
969
|
+
## ISCH_PrimitiveArc
|
|
970
|
+
|
|
971
|
+
Arc primitive
|
|
972
|
+
|
|
973
|
+
```typescript
|
|
974
|
+
class ISCH_PrimitiveArc implements ISCH_Primitive
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveArc>;`
|
|
978
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
979
|
+
- **getstate_endx**: `function getState_EndX(): number;`
|
|
980
|
+
- **getstate_endy**: `function getState_EndY(): number;`
|
|
981
|
+
- **getstate_fillcolor**: `function getState_FillColor(): string | null;`
|
|
982
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
983
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
984
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
985
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
986
|
+
- **getstate_referencex**: `function getState_ReferenceX(): number;`
|
|
987
|
+
- **getstate_referencey**: `function getState_ReferenceY(): number;`
|
|
988
|
+
- **getstate_startx**: `function getState_StartX(): number;`
|
|
989
|
+
- **getstate_starty**: `function getState_StartY(): number;`
|
|
990
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
991
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveArc>;`
|
|
992
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveArc;`
|
|
993
|
+
- **setstate_endx**: `function setState_EndX(endX: number): ISCH_PrimitiveArc;`
|
|
994
|
+
- **setstate_endy**: `function setState_EndY(endY: number): ISCH_PrimitiveArc;`
|
|
995
|
+
- **setstate_fillcolor**: `function setState_FillColor(fillColor: string | null): ISCH_PrimitiveArc;`
|
|
996
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveArc;`
|
|
997
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveArc;`
|
|
998
|
+
- **setstate_referencex**: `function setState_ReferenceX(referenceX: number): ISCH_PrimitiveArc;`
|
|
999
|
+
- **setstate_referencey**: `function setState_ReferenceY(referenceY: number): ISCH_PrimitiveArc;`
|
|
1000
|
+
- **setstate_startx**: `function setState_StartX(startX: number): ISCH_PrimitiveArc;`
|
|
1001
|
+
- **setstate_starty**: `function setState_StartY(startY: number): ISCH_PrimitiveArc;`
|
|
1002
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveArc;`
|
|
1003
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveArc;`
|
|
1004
|
+
|
|
1005
|
+
---
|
|
1006
|
+
|
|
1007
|
+
## ISCH_PrimitiveAttribute
|
|
1008
|
+
|
|
1009
|
+
Property primitive
|
|
1010
|
+
|
|
1011
|
+
```typescript
|
|
1012
|
+
class ISCH_PrimitiveAttribute implements ISCH_Primitive
|
|
1013
|
+
```
|
|
1014
|
+
|
|
1015
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveAttribute>;`
|
|
1016
|
+
- **getstate_alignmode**: `function getState_AlignMode(): ESCH_PrimitiveTextAlignMode | null;`
|
|
1017
|
+
- **getstate_bold**: `function getState_Bold(): boolean | null;`
|
|
1018
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1019
|
+
- **getstate_fillcolor**: `function getState_FillColor(): string | null;`
|
|
1020
|
+
- **getstate_fontname**: `function getState_FontName(): string | null;`
|
|
1021
|
+
- **getstate_fontsize**: `function getState_FontSize(): number | null;`
|
|
1022
|
+
- **getstate_italic**: `function getState_Italic(): boolean | null;`
|
|
1023
|
+
- **getstate_key**: `function getState_Key(): string;`
|
|
1024
|
+
- **getstate_keyvisible**: `function getState_KeyVisible(): boolean | null;`
|
|
1025
|
+
- **getstate_parentprimitiveid**: `function getState_ParentPrimitiveId(): string;`
|
|
1026
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1027
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1028
|
+
- **getstate_rotation**: `function getState_Rotation(): number | null;`
|
|
1029
|
+
- **getstate_underline**: `function getState_UnderLine(): boolean | null;`
|
|
1030
|
+
- **getstate_value**: `function getState_Value(): string;`
|
|
1031
|
+
- **getstate_valuevisible**: `function getState_ValueVisible(): boolean | null;`
|
|
1032
|
+
- **getstate_x**: `function getState_X(): number | null;`
|
|
1033
|
+
- **getstate_y**: `function getState_Y(): number | null;`
|
|
1034
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1035
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveAttribute>;`
|
|
1036
|
+
- **setstate_alignmode**: `function setState_AlignMode(alignMode: ESCH_PrimitiveTextAlignMode | null): ISCH_PrimitiveAttribute;`
|
|
1037
|
+
- **setstate_bold**: `function setState_Bold(bold: boolean | null): ISCH_PrimitiveAttribute;`
|
|
1038
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveAttribute;`
|
|
1039
|
+
- **setstate_fillcolor**: `function setState_FillColor(fillColor: string | null): ISCH_PrimitiveAttribute;`
|
|
1040
|
+
- **setstate_fontname**: `function setState_FontName(fontName: string | null): ISCH_PrimitiveAttribute;`
|
|
1041
|
+
- **setstate_fontsize**: `function setState_FontSize(fontSize: number | null): ISCH_PrimitiveAttribute;`
|
|
1042
|
+
- **setstate_italic**: `function setState_Italic(italic: boolean | null): ISCH_PrimitiveAttribute;`
|
|
1043
|
+
- **setstate_key**: `function setState_Key(key: string): ISCH_PrimitiveAttribute;`
|
|
1044
|
+
- **setstate_keyvisible**: `function setState_KeyVisible(keyVisible: boolean | null): ISCH_PrimitiveAttribute;`
|
|
1045
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number | null): ISCH_PrimitiveAttribute;`
|
|
1046
|
+
- **setstate_underline**: `function setState_UnderLine(underLine: boolean | null): ISCH_PrimitiveAttribute;`
|
|
1047
|
+
- **setstate_value**: `function setState_Value(value: string): ISCH_PrimitiveAttribute;`
|
|
1048
|
+
- **setstate_valuevisible**: `function setState_ValueVisible(valueVisible: boolean | null): ISCH_PrimitiveAttribute;`
|
|
1049
|
+
- **setstate_x**: `function setState_X(x: number | null): ISCH_PrimitiveAttribute;`
|
|
1050
|
+
- **setstate_y**: `function setState_Y(y: number | null): ISCH_PrimitiveAttribute;`
|
|
1051
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveAttribute;`
|
|
1052
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveAttribute;`
|
|
1053
|
+
|
|
1054
|
+
---
|
|
1055
|
+
|
|
1056
|
+
## ISCH_PrimitiveBus
|
|
1057
|
+
|
|
1058
|
+
Bus primitive
|
|
1059
|
+
|
|
1060
|
+
```typescript
|
|
1061
|
+
class ISCH_PrimitiveBus implements ISCH_Primitive
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveBus>;`
|
|
1065
|
+
- **getstate_busname**: `function getState_BusName(): string;`
|
|
1066
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1067
|
+
- **getstate_line**: `function getState_Line(): Array<number> | Array<Array<number>>;`
|
|
1068
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
1069
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
1070
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1071
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1072
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1073
|
+
- **setstate_busname**: `function setState_BusName(busName: string): ISCH_PrimitiveBus;`
|
|
1074
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveBus;`
|
|
1075
|
+
- **setstate_line**: `function setState_Line(line: Array<number> | Array<Array<number>>): ISCH_PrimitiveBus;`
|
|
1076
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveBus;`
|
|
1077
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveBus;`
|
|
1078
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveBus;`
|
|
1079
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveBus;`
|
|
1080
|
+
|
|
1081
|
+
---
|
|
1082
|
+
|
|
1083
|
+
## ISCH_PrimitiveCbbSymbolComponent
|
|
1084
|
+
|
|
1085
|
+
Reuse block symbol primitive
|
|
1086
|
+
|
|
1087
|
+
```typescript
|
|
1088
|
+
class ISCH_PrimitiveCbbSymbolComponent extends ISCH_PrimitiveComponent
|
|
1089
|
+
```
|
|
1090
|
+
|
|
1091
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveCbbSymbolComponent>;`
|
|
1092
|
+
- **getstate_cbb**: `function getState_Cbb(): { libraryUuid: string; uuid: string };`
|
|
1093
|
+
- **getstate_cbbsymbol**: `function getState_CbbSymbol(): { libraryUuid: string; cbbUuid: string; uuid?: undefined | string; name?: undefined | string; };`
|
|
1094
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveCbbSymbolComponent>;`
|
|
1095
|
+
|
|
1096
|
+
---
|
|
1097
|
+
|
|
1098
|
+
## ISCH_PrimitiveCircle
|
|
1099
|
+
|
|
1100
|
+
Circle primitive
|
|
1101
|
+
|
|
1102
|
+
```typescript
|
|
1103
|
+
class ISCH_PrimitiveCircle implements ISCH_Primitive
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveCircle>;`
|
|
1107
|
+
- **getstate_centerx**: `function getState_CenterX(): number;`
|
|
1108
|
+
- **getstate_centery**: `function getState_CenterY(): number;`
|
|
1109
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1110
|
+
- **getstate_fillcolor**: `function getState_FillColor(): string | null;`
|
|
1111
|
+
- **getstate_fillstyle**: `function getState_FillStyle(): ESCH_PrimitiveFillStyle | null;`
|
|
1112
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
1113
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
1114
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1115
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1116
|
+
- **getstate_radius**: `function getState_Radius(): number;`
|
|
1117
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1118
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveCircle>;`
|
|
1119
|
+
- **setstate_centerx**: `function setState_CenterX(centerX: number): ISCH_PrimitiveCircle;`
|
|
1120
|
+
- **setstate_centery**: `function setState_CenterY(centerY: number): ISCH_PrimitiveCircle;`
|
|
1121
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveCircle;`
|
|
1122
|
+
- **setstate_fillcolor**: `function setState_FillColor(fillColor: string | null): ISCH_PrimitiveCircle;`
|
|
1123
|
+
- **setstate_fillstyle**: `function setState_FillStyle(fillStyle: ESCH_PrimitiveFillStyle | null): ISCH_PrimitiveCircle;`
|
|
1124
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveCircle;`
|
|
1125
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveCircle;`
|
|
1126
|
+
- **setstate_radius**: `function setState_Radius(radius: number): ISCH_PrimitiveCircle;`
|
|
1127
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveCircle;`
|
|
1128
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveCircle;`
|
|
1129
|
+
|
|
1130
|
+
---
|
|
1131
|
+
|
|
1132
|
+
## ISCH_PrimitiveComponent
|
|
1133
|
+
|
|
1134
|
+
Device primitive
|
|
1135
|
+
|
|
1136
|
+
```typescript
|
|
1137
|
+
class ISCH_PrimitiveComponent implements ISCH_Primitive
|
|
1138
|
+
```
|
|
1139
|
+
|
|
1140
|
+
- **async**: `function async: boolean;`
|
|
1141
|
+
- **designator**: `function designator?: string;`
|
|
1142
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveComponent>;`
|
|
1143
|
+
- **getallpins**: `function getAllPins(): Promise<Array<ISCH_PrimitiveComponentPin> | undefined>;`
|
|
1144
|
+
- **getstate_addintobom**: `function getState_AddIntoBom(): boolean | undefined;`
|
|
1145
|
+
- **getstate_addintopcb**: `function getState_AddIntoPcb(): boolean | undefined;`
|
|
1146
|
+
- **getstate_component**: `function getState_Component(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
1147
|
+
- **getstate_componenttype**: `function getState_ComponentType(): ESCH_PrimitiveComponentType;`
|
|
1148
|
+
- **getstate_designator**: `function getState_Designator(): string | undefined;`
|
|
1149
|
+
- **getstate_footprint**: `function getState_Footprint(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
1150
|
+
- **getstate_manufacturer**: `function getState_Manufacturer(): string | undefined;`
|
|
1151
|
+
- **getstate_manufacturerid**: `function getState_ManufacturerId(): string | undefined;`
|
|
1152
|
+
- **getstate_mirror**: `function getState_Mirror(): boolean;`
|
|
1153
|
+
- **getstate_name**: `function getState_Name(): string | undefined;`
|
|
1154
|
+
- **getstate_net**: `function getState_Net(): string | undefined;`
|
|
1155
|
+
- **getstate_otherproperty**: `function getState_OtherProperty(): Record<string, string | number | boolean> | undefined;`
|
|
1156
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1157
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1158
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
1159
|
+
- **getstate_subpartname**: `function getState_SubPartName(): string | undefined;`
|
|
1160
|
+
- **getstate_supplier**: `function getState_Supplier(): string | undefined;`
|
|
1161
|
+
- **getstate_supplierid**: `function getState_SupplierId(): string | undefined;`
|
|
1162
|
+
- **getstate_symbol**: `function getState_Symbol(): { libraryUuid: string; uuid: string; name?: undefined | string } | undefined;`
|
|
1163
|
+
- **getstate_uniqueid**: `function getState_UniqueId(): string | undefined;`
|
|
1164
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
1165
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
1166
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1167
|
+
- **mirror**: `function mirror: boolean;`
|
|
1168
|
+
- **name**: `function name?: string;`
|
|
1169
|
+
- **otherproperty**: `function otherProperty?: Record<string, string | number | boolean>;`
|
|
1170
|
+
- **primitiveid**: `function primitiveId?: string;`
|
|
1171
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveComponent>;`
|
|
1172
|
+
- **rotation**: `function rotation: number;`
|
|
1173
|
+
- **setstate_addintobom**: `function setState_AddIntoBom(addIntoBom: boolean | undefined): ISCH_PrimitiveComponent;`
|
|
1174
|
+
- **setstate_addintopcb**: `function setState_AddIntoPcb(addIntoPcb: boolean | undefined): ISCH_PrimitiveComponent;`
|
|
1175
|
+
- **setstate_designator**: `function setState_Designator(designator: string | undefined): ISCH_PrimitiveComponent;`
|
|
1176
|
+
- **setstate_manufacturer**: `function setState_Manufacturer(manufacturer: string | undefined): ISCH_PrimitiveComponent;`
|
|
1177
|
+
- **setstate_manufacturerid**: `function setState_ManufacturerId(manufacturerId: string | undefined): ISCH_PrimitiveComponent;`
|
|
1178
|
+
- **setstate_mirror**: `function setState_Mirror(mirror: boolean): ISCH_PrimitiveComponent;`
|
|
1179
|
+
- **setstate_name**: `function setState_Name(name: string | undefined): ISCH_PrimitiveComponent;`
|
|
1180
|
+
- **setstate_net**: `function setState_Net(net: string | undefined): ISCH_PrimitiveComponent;`
|
|
1181
|
+
- **setstate_otherproperty**: `function setState_OtherProperty( otherProperty: Record<string, string | number | boolean>, ): ISCH_PrimitiveComponent;`
|
|
1182
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): ISCH_PrimitiveComponent;`
|
|
1183
|
+
- **setstate_supplier**: `function setState_Supplier(supplier: string | undefined): ISCH_PrimitiveComponent;`
|
|
1184
|
+
- **setstate_supplierid**: `function setState_SupplierId(supplierId: string | undefined): ISCH_PrimitiveComponent;`
|
|
1185
|
+
- **setstate_uniqueid**: `function setState_UniqueId(uniqueId: string | undefined): ISCH_PrimitiveComponent;`
|
|
1186
|
+
- **setstate_x**: `function setState_X(x: number): ISCH_PrimitiveComponent;`
|
|
1187
|
+
- **setstate_y**: `function setState_Y(y: number): ISCH_PrimitiveComponent;`
|
|
1188
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveComponent;`
|
|
1189
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveComponent;`
|
|
1190
|
+
- **x**: `function x: number;`
|
|
1191
|
+
- **y**: `function y: number;`
|
|
1192
|
+
|
|
1193
|
+
---
|
|
1194
|
+
|
|
1195
|
+
## ISCH_PrimitiveComponentPin
|
|
1196
|
+
|
|
1197
|
+
Device pin primitive
|
|
1198
|
+
|
|
1199
|
+
```typescript
|
|
1200
|
+
class ISCH_PrimitiveComponentPin extends ISCH_PrimitivePin
|
|
1201
|
+
```
|
|
1202
|
+
|
|
1203
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveComponentPin>;`
|
|
1204
|
+
- **primitivetype**: `function readonly primitiveType: ESCH_PrimitiveType.COMPONENT_PIN;`
|
|
1205
|
+
|
|
1206
|
+
---
|
|
1207
|
+
|
|
1208
|
+
## ISCH_PrimitiveObject
|
|
1209
|
+
|
|
1210
|
+
Binary embedded object primitive
|
|
1211
|
+
|
|
1212
|
+
```typescript
|
|
1213
|
+
class ISCH_PrimitiveObject implements ISCH_Primitive
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveObject>;`
|
|
1217
|
+
- **getstate_content**: `function getState_Content(): File | string;`
|
|
1218
|
+
- **getstate_filename**: `function getState_FileName(): string;`
|
|
1219
|
+
- **getstate_height**: `function getState_Height(): number;`
|
|
1220
|
+
- **getstate_mirror**: `function getState_Mirror(): boolean;`
|
|
1221
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1222
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1223
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
1224
|
+
- **getstate_startx**: `function getState_StartX(): number;`
|
|
1225
|
+
- **getstate_starty**: `function getState_StartY(): number;`
|
|
1226
|
+
- **getstate_width**: `function getState_Width(): number;`
|
|
1227
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1228
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveObject>;`
|
|
1229
|
+
- **setstate_content**: `function setState_Content(content: File | string): ISCH_PrimitiveObject;`
|
|
1230
|
+
- **setstate_filename**: `function setState_FileName(fileName: string): ISCH_PrimitiveObject;`
|
|
1231
|
+
- **setstate_height**: `function setState_Height(height: number): ISCH_PrimitiveObject;`
|
|
1232
|
+
- **setstate_mirror**: `function setState_Mirror(mirror: boolean): ISCH_PrimitiveObject;`
|
|
1233
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): ISCH_PrimitiveObject;`
|
|
1234
|
+
- **setstate_startx**: `function setState_StartX(startX: number): ISCH_PrimitiveObject;`
|
|
1235
|
+
- **setstate_starty**: `function setState_StartY(startY: number): ISCH_PrimitiveObject;`
|
|
1236
|
+
- **setstate_width**: `function setState_Width(width: number): ISCH_PrimitiveObject;`
|
|
1237
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveObject;`
|
|
1238
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveObject;`
|
|
1239
|
+
|
|
1240
|
+
---
|
|
1241
|
+
|
|
1242
|
+
## ISCH_PrimitivePin
|
|
1243
|
+
|
|
1244
|
+
Pin primitive
|
|
1245
|
+
|
|
1246
|
+
```typescript
|
|
1247
|
+
class ISCH_PrimitivePin implements ISCH_Primitive
|
|
1248
|
+
```
|
|
1249
|
+
|
|
1250
|
+
- **async**: `function async: boolean;`
|
|
1251
|
+
- **done**: `function done(): Promise<ISCH_PrimitivePin>;`
|
|
1252
|
+
- **getstate_noconnected**: `function getState_NoConnected(): boolean | undefined;`
|
|
1253
|
+
- **getstate_otherproperty**: `function getState_OtherProperty(): Record<string, string | number | boolean> | undefined;`
|
|
1254
|
+
- **getstate_pincolor**: `function getState_PinColor(): string | null;`
|
|
1255
|
+
- **getstate_pinlength**: `function getState_PinLength(): number;`
|
|
1256
|
+
- **getstate_pinname**: `function getState_PinName(): string;`
|
|
1257
|
+
- **getstate_pinnumber**: `function getState_PinNumber(): string;`
|
|
1258
|
+
- **getstate_pinshape**: `function getState_PinShape(): ESCH_PrimitivePinShape;`
|
|
1259
|
+
- **getstate_pintype**: `function getState_pinType(): ESCH_PrimitivePinType;`
|
|
1260
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1261
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1262
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
1263
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
1264
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
1265
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1266
|
+
- **noconnected**: `function noConnected?: boolean;`
|
|
1267
|
+
- **otherproperty**: `function otherProperty?: Record<string, string | number | boolean>;`
|
|
1268
|
+
- **pincolor**: `function pinColor: string | null;`
|
|
1269
|
+
- **pinlength**: `function pinLength: number;`
|
|
1270
|
+
- **pinname**: `function pinName: string;`
|
|
1271
|
+
- **pinnumber**: `function pinNumber: string;`
|
|
1272
|
+
- **pinshape**: `function pinShape: ESCH_PrimitivePinShape;`
|
|
1273
|
+
- **pintype**: `function pinType: ESCH_PrimitivePinType;`
|
|
1274
|
+
- **primitiveid**: `function primitiveId?: string;`
|
|
1275
|
+
- **primitivetype**: `function readonly primitiveType: ESCH_PrimitiveType;`
|
|
1276
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitivePin>;`
|
|
1277
|
+
- **rotation**: `function rotation: number;`
|
|
1278
|
+
- **setstate_noconnected**: `function setState_NoConnected(noConnected: boolean): ISCH_PrimitivePin;`
|
|
1279
|
+
- **setstate_otherproperty**: `function setState_OtherProperty( otherProperty: Record<string, string | number | boolean>, ): ISCH_PrimitivePin;`
|
|
1280
|
+
- **setstate_pincolor**: `function setState_PinColor(pinColor: string | null): ISCH_PrimitivePin;`
|
|
1281
|
+
- **setstate_pinlength**: `function setState_PinLength(pinLength: number): ISCH_PrimitivePin;`
|
|
1282
|
+
- **setstate_pinname**: `function setState_PinName(pinName: string): ISCH_PrimitivePin;`
|
|
1283
|
+
- **setstate_pinnumber**: `function setState_PinNumber(pinNumber: string): ISCH_PrimitivePin;`
|
|
1284
|
+
- **setstate_pinshape**: `function setState_PinShape(pinShape: ESCH_PrimitivePinShape): ISCH_PrimitivePin;`
|
|
1285
|
+
- **setstate_pintype**: `function setState_PinType(pinType: ESCH_PrimitivePinType): ISCH_PrimitivePin;`
|
|
1286
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): ISCH_PrimitivePin;`
|
|
1287
|
+
- **setstate_x**: `function setState_X(x: number): ISCH_PrimitivePin;`
|
|
1288
|
+
- **setstate_y**: `function setState_Y(y: number): ISCH_PrimitivePin;`
|
|
1289
|
+
- **toasync**: `function toAsync(): ISCH_PrimitivePin;`
|
|
1290
|
+
- **tosync**: `function toSync(): ISCH_PrimitivePin;`
|
|
1291
|
+
- **x**: `function x: number;`
|
|
1292
|
+
- **y**: `function y: number;`
|
|
1293
|
+
|
|
1294
|
+
---
|
|
1295
|
+
|
|
1296
|
+
## ISCH_PrimitivePolygon
|
|
1297
|
+
|
|
1298
|
+
Polygon (polyline) primitive
|
|
1299
|
+
|
|
1300
|
+
```typescript
|
|
1301
|
+
class ISCH_PrimitivePolygon implements ISCH_Primitive
|
|
1302
|
+
```
|
|
1303
|
+
|
|
1304
|
+
- **done**: `function done(): Promise<ISCH_PrimitivePolygon>;`
|
|
1305
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1306
|
+
- **getstate_fillcolor**: `function getState_FillColor(): string | null;`
|
|
1307
|
+
- **getstate_line**: `function getState_Line(): Array<number>;`
|
|
1308
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
1309
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
1310
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1311
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1312
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1313
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitivePolygon>;`
|
|
1314
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitivePolygon;`
|
|
1315
|
+
- **setstate_fillcolor**: `function setState_FillColor(fillColor: string | null): ISCH_PrimitivePolygon;`
|
|
1316
|
+
- **setstate_line**: `function setState_Line(line: Array<number>): ISCH_PrimitivePolygon;`
|
|
1317
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitivePolygon;`
|
|
1318
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitivePolygon;`
|
|
1319
|
+
- **toasync**: `function toAsync(): ISCH_PrimitivePolygon;`
|
|
1320
|
+
- **tosync**: `function toSync(): ISCH_PrimitivePolygon;`
|
|
1321
|
+
|
|
1322
|
+
---
|
|
1323
|
+
|
|
1324
|
+
## ISCH_PrimitiveRectangle
|
|
1325
|
+
|
|
1326
|
+
Rectangle primitive
|
|
1327
|
+
|
|
1328
|
+
```typescript
|
|
1329
|
+
class ISCH_PrimitiveRectangle implements ISCH_Primitive
|
|
1330
|
+
```
|
|
1331
|
+
|
|
1332
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveRectangle>;`
|
|
1333
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1334
|
+
- **getstate_cornerradius**: `function getState_CornerRadius(): number;`
|
|
1335
|
+
- **getstate_fillcolor**: `function getState_FillColor(): string | null;`
|
|
1336
|
+
- **getstate_fillstyle**: `function getState_FillStyle(): ESCH_PrimitiveFillStyle | null;`
|
|
1337
|
+
- **getstate_height**: `function getState_Height(): number;`
|
|
1338
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
1339
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
1340
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1341
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1342
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
1343
|
+
- **getstate_topleftx**: `function getState_TopLeftX(): number;`
|
|
1344
|
+
- **getstate_toplefty**: `function getState_TopLeftY(): number;`
|
|
1345
|
+
- **getstate_width**: `function getState_Width(): number;`
|
|
1346
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1347
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveRectangle>;`
|
|
1348
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveRectangle;`
|
|
1349
|
+
- **setstate_cornerradius**: `function setState_CornerRadius(cornerRadius: number): ISCH_PrimitiveRectangle;`
|
|
1350
|
+
- **setstate_fillcolor**: `function setState_FillColor(fillColor: string | null): ISCH_PrimitiveRectangle;`
|
|
1351
|
+
- **setstate_fillstyle**: `function setState_FillStyle(fillStyle: ESCH_PrimitiveFillStyle | null): ISCH_PrimitiveRectangle;`
|
|
1352
|
+
- **setstate_height**: `function setState_Height(height: number): ISCH_PrimitiveRectangle;`
|
|
1353
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveRectangle;`
|
|
1354
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveRectangle;`
|
|
1355
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): ISCH_PrimitiveRectangle;`
|
|
1356
|
+
- **setstate_topleftx**: `function setState_TopLeftX(topLeftX: number): ISCH_PrimitiveRectangle;`
|
|
1357
|
+
- **setstate_toplefty**: `function setState_TopLeftY(topLeftY: number): ISCH_PrimitiveRectangle;`
|
|
1358
|
+
- **setstate_width**: `function setState_Width(width: number): ISCH_PrimitiveRectangle;`
|
|
1359
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveRectangle;`
|
|
1360
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveRectangle;`
|
|
1361
|
+
|
|
1362
|
+
---
|
|
1363
|
+
|
|
1364
|
+
## ISCH_PrimitiveText
|
|
1365
|
+
|
|
1366
|
+
Text primitive
|
|
1367
|
+
|
|
1368
|
+
```typescript
|
|
1369
|
+
class ISCH_PrimitiveText implements ISCH_Primitive
|
|
1370
|
+
```
|
|
1371
|
+
|
|
1372
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveText>;`
|
|
1373
|
+
- **getstate_alignmode**: `function getState_AlignMode(): ESCH_PrimitiveTextAlignMode;`
|
|
1374
|
+
- **getstate_bold**: `function getState_Bold(): boolean;`
|
|
1375
|
+
- **getstate_content**: `function getState_Content(): string;`
|
|
1376
|
+
- **getstate_fontname**: `function getState_FontName(): string | null;`
|
|
1377
|
+
- **getstate_fontsize**: `function getState_FontSize(): number | null;`
|
|
1378
|
+
- **getstate_italic**: `function getState_Italic(): boolean;`
|
|
1379
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1380
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1381
|
+
- **getstate_rotation**: `function getState_Rotation(): number;`
|
|
1382
|
+
- **getstate_textcolor**: `function getState_TextColor(): string | null;`
|
|
1383
|
+
- **getstate_underline**: `function getState_UnderLine(): boolean;`
|
|
1384
|
+
- **getstate_x**: `function getState_X(): number;`
|
|
1385
|
+
- **getstate_y**: `function getState_Y(): number;`
|
|
1386
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1387
|
+
- **reset**: `function reset(): Promise<ISCH_PrimitiveText>;`
|
|
1388
|
+
- **setstate_alignmode**: `function setState_AlignMode(alignMode: ESCH_PrimitiveTextAlignMode): ISCH_PrimitiveText;`
|
|
1389
|
+
- **setstate_bold**: `function setState_Bold(bold: boolean): ISCH_PrimitiveText;`
|
|
1390
|
+
- **setstate_content**: `function setState_Content(content: string): ISCH_PrimitiveText;`
|
|
1391
|
+
- **setstate_fontname**: `function setState_FontName(fontName: string | null): ISCH_PrimitiveText;`
|
|
1392
|
+
- **setstate_fontsize**: `function setState_FontSize(fontSize: number | null): ISCH_PrimitiveText;`
|
|
1393
|
+
- **setstate_italic**: `function setState_Italic(italic: boolean): ISCH_PrimitiveText;`
|
|
1394
|
+
- **setstate_rotation**: `function setState_Rotation(rotation: number): ISCH_PrimitiveText;`
|
|
1395
|
+
- **setstate_textcolor**: `function setState_TextColor(textColor: string | null): ISCH_PrimitiveText;`
|
|
1396
|
+
- **setstate_underline**: `function setState_UnderLine(underLine: boolean): ISCH_PrimitiveText;`
|
|
1397
|
+
- **setstate_x**: `function setState_X(x: number): ISCH_PrimitiveText;`
|
|
1398
|
+
- **setstate_y**: `function setState_Y(y: number): ISCH_PrimitiveText;`
|
|
1399
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveText;`
|
|
1400
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveText;`
|
|
1401
|
+
|
|
1402
|
+
---
|
|
1403
|
+
|
|
1404
|
+
## ISCH_PrimitiveWire
|
|
1405
|
+
|
|
1406
|
+
Wire primitive
|
|
1407
|
+
|
|
1408
|
+
```typescript
|
|
1409
|
+
class ISCH_PrimitiveWire implements ISCH_Primitive
|
|
1410
|
+
```
|
|
1411
|
+
|
|
1412
|
+
- **done**: `function done(): Promise<ISCH_PrimitiveWire>;`
|
|
1413
|
+
- **getstate_color**: `function getState_Color(): string | null;`
|
|
1414
|
+
- **getstate_line**: `function getState_Line(): Array<number> | Array<Array<number>>;`
|
|
1415
|
+
- **getstate_linetype**: `function getState_LineType(): ESCH_PrimitiveLineType | null;`
|
|
1416
|
+
- **getstate_linewidth**: `function getState_LineWidth(): number | null;`
|
|
1417
|
+
- **getstate_net**: `function getState_Net(): string;`
|
|
1418
|
+
- **getstate_primitiveid**: `function getState_PrimitiveId(): string;`
|
|
1419
|
+
- **getstate_primitivetype**: `function getState_PrimitiveType(): ESCH_PrimitiveType;`
|
|
1420
|
+
- **isasync**: `function isAsync(): boolean;`
|
|
1421
|
+
- **setstate_color**: `function setState_Color(color: string | null): ISCH_PrimitiveWire;`
|
|
1422
|
+
- **setstate_line**: `function setState_Line(line: Array<number> | Array<Array<number>>): ISCH_PrimitiveWire;`
|
|
1423
|
+
- **setstate_linetype**: `function setState_LineType(lineType: ESCH_PrimitiveLineType | null): ISCH_PrimitiveWire;`
|
|
1424
|
+
- **setstate_linewidth**: `function setState_LineWidth(lineWidth: number | null): ISCH_PrimitiveWire;`
|
|
1425
|
+
- **setstate_net**: `function setState_Net(net: string): ISCH_PrimitiveWire;`
|
|
1426
|
+
- **toasync**: `function toAsync(): ISCH_PrimitiveWire;`
|
|
1427
|
+
- **tosync**: `function toSync(): ISCH_PrimitiveWire;`
|
|
1428
|
+
|
|
1429
|
+
---
|
|
1430
|
+
|
|
1431
|
+
## LIB_3DModel
|
|
1432
|
+
|
|
1433
|
+
Comprehensive library / 3D model class
|
|
1434
|
+
|
|
1435
|
+
```typescript
|
|
1436
|
+
class LIB_3DModel
|
|
1437
|
+
```
|
|
1438
|
+
|
|
1439
|
+
- **copy**: `function copy( modelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newModelName?: string, ): Promise<string | undefined>;`
|
|
1440
|
+
- **create**: `function create( libraryUuid: string, modelFile: Blob, classification?: ILIB_ClassificationIndex | Array<string>, unit?: | ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.METER | ESYS_Unit.MIL | ESYS_Unit.INCH, ): Promise<Array<string> | undefined>;`
|
|
1441
|
+
- **delete**: `function delete(modelUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1442
|
+
- **get**: `function get(modelUuid: string, libraryUuid?: string): Promise<ILIB_3DModelItem | undefined>;`
|
|
1443
|
+
- **modify**: `function modify( modelUuid: string, libraryUuid: string, modelName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1444
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_3DModelSearchItem>>;`
|
|
1445
|
+
|
|
1446
|
+
---
|
|
1447
|
+
|
|
1448
|
+
## LIB_Cbb
|
|
1449
|
+
|
|
1450
|
+
Comprehensive library / reuse block class
|
|
1451
|
+
|
|
1452
|
+
```typescript
|
|
1453
|
+
class LIB_Cbb
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
- **copy**: `function copy( cbbUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newCbbName?: string, ): Promise<string | undefined>;`
|
|
1457
|
+
- **create**: `function create( libraryUuid: string, cbbName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string, ): Promise<string | undefined>;`
|
|
1458
|
+
- **delete**: `function delete(cbbUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1459
|
+
- **get**: `function get(cbbUuid: string, libraryUuid?: string): Promise<ILIB_CbbItem | undefined>;`
|
|
1460
|
+
- **modify**: `function modify( cbbUuid: string, libraryUuid: string, cbbName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1461
|
+
- **openprojectineditor**: `function openProjectInEditor(cbbUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1462
|
+
- **opensymbolineditor**: `function openSymbolInEditor( cbbUuid: string, libraryUuid: string, splitScreenId?: string, ): Promise<string | undefined>;`
|
|
1463
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_CbbSearchItem>>;`
|
|
1464
|
+
|
|
1465
|
+
---
|
|
1466
|
+
|
|
1467
|
+
## LIB_Classification
|
|
1468
|
+
|
|
1469
|
+
Comprehensive library / library classification index class
|
|
1470
|
+
|
|
1471
|
+
```typescript
|
|
1472
|
+
class LIB_Classification
|
|
1473
|
+
```
|
|
1474
|
+
|
|
1475
|
+
- **createprimary**: `function createPrimary( libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationName: string, ): Promise<ILIB_ClassificationIndex | undefined>;`
|
|
1476
|
+
- **createsecondary**: `function createSecondary( libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationUuid: string, secondaryClassificationName: string, ): Promise<ILIB_ClassificationIndex | undefined>;`
|
|
1477
|
+
- **deletebyindex**: `function deleteByIndex(classificationIndex: ILIB_ClassificationIndex): Promise<boolean>;`
|
|
1478
|
+
- **deletebyuuid**: `function deleteByUuid(libraryUuid: string, classificationUuid: string): Promise<boolean>;`
|
|
1479
|
+
- **getallclassificationtree**: `function getAllClassificationTree( libraryUuid: string, libraryType: ELIB_LibraryType, ): Promise< Array<{ name: string; uuid: string; children?: undefined | { name: string; uuid: string }[] }> >;`
|
|
1480
|
+
- **getindexbyname**: `function getIndexByName( libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationName: string, secondaryClassificationName?: string, ): Promise<ILIB_ClassificationIndex | undefined>;`
|
|
1481
|
+
- **getnamebyindex**: `function getNameByIndex( classificationIndex: ILIB_ClassificationIndex, ): Promise< | { primaryClassificationName: string; secondaryClassificationName?: undefined | string } | undefined >;`
|
|
1482
|
+
- **getnamebyuuid**: `function getNameByUuid( libraryUuid: string, libraryType: ELIB_LibraryType, primaryClassificationUuid: string, secondaryClassificationUuid?: string, ): Promise< | { primaryClassificationName: string; secondaryClassificationName?: undefined | string } | undefined >;`
|
|
1483
|
+
|
|
1484
|
+
---
|
|
1485
|
+
|
|
1486
|
+
## LIB_Device
|
|
1487
|
+
|
|
1488
|
+
Comprehensive library / device class
|
|
1489
|
+
|
|
1490
|
+
```typescript
|
|
1491
|
+
class LIB_Device
|
|
1492
|
+
```
|
|
1493
|
+
|
|
1494
|
+
- **copy**: `function copy( deviceUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newDeviceName?: string, ): Promise<string | undefined>;`
|
|
1495
|
+
- **create**: *(签名过长,请查看详细文档)*
|
|
1496
|
+
- **delete**: `function delete(deviceUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1497
|
+
- **get**: `function get(deviceUuid: string, libraryUuid?: string): Promise<ILIB_DeviceItem | undefined>;`
|
|
1498
|
+
- **getbylcscids**: `function getByLcscIds<T extends boolean>( lcscIds: string, libraryUuid?: string, allowMultiMatch?: T, ): Promise<T extends true ? ILIB_DeviceSearchItem | undefined : Array<ILIB_DeviceSearchItem>>;`
|
|
1499
|
+
- **getbylcscids_1**: `function getByLcscIds( lcscIds: Array<string>, libraryUuid?: string, allowMultiMatch?: boolean, ): Promise<Array<ILIB_DeviceSearchItem>>;`
|
|
1500
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1501
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_DeviceSearchItem>>;`
|
|
1502
|
+
- **searchbyproperties**: `function searchByProperties( properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_DeviceSearchItem>>;`
|
|
1503
|
+
|
|
1504
|
+
---
|
|
1505
|
+
|
|
1506
|
+
## LIB_Footprint
|
|
1507
|
+
|
|
1508
|
+
Comprehensive library / footprint class
|
|
1509
|
+
|
|
1510
|
+
```typescript
|
|
1511
|
+
class LIB_Footprint
|
|
1512
|
+
```
|
|
1513
|
+
|
|
1514
|
+
- **copy**: `function copy( footprintUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newFootprintName?: string, ): Promise<string | undefined>;`
|
|
1515
|
+
- **create**: `function create( libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string, ): Promise<string | undefined>;`
|
|
1516
|
+
- **delete**: `function delete(footprintUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1517
|
+
- **get**: `function get(footprintUuid: string, libraryUuid?: string): Promise<ILIB_FootprintItem | undefined>;`
|
|
1518
|
+
- **getrenderimage**: `function getRenderImage(source: { footprintUuid: string; libraryUuid: string; }): Promise<Blob | undefined>;`
|
|
1519
|
+
- **modify**: `function modify( footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1520
|
+
- **openineditor**: `function openInEditor( footprintUuid: string, libraryUuid: string, splitScreenId?: string, ): Promise<string | undefined>;`
|
|
1521
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_FootprintSearchItem>>;`
|
|
1522
|
+
- **searchbyproperties**: `function searchByProperties( properties: ILIB_FootprintPropertiesForSearch, libraryUuid?: string, ): Promise<Array<ILIB_FootprintSearchItem>>;`
|
|
1523
|
+
- **updatedocumentsource**: `function updateDocumentSource( footprintUuid: string, libraryUuid: string, documentSource: string, ): Promise<boolean | undefined>;`
|
|
1524
|
+
|
|
1525
|
+
---
|
|
1526
|
+
|
|
1527
|
+
## LIB_LibrariesList
|
|
1528
|
+
|
|
1529
|
+
Comprehensive library / library list class
|
|
1530
|
+
|
|
1531
|
+
```typescript
|
|
1532
|
+
class LIB_LibrariesList
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
- **getalllibrarieslist**: `function getAllLibrariesList(): Promise<Array<ILIB_LibraryInfo>>;`
|
|
1536
|
+
- **getfavoritelibraryuuid**: `function getFavoriteLibraryUuid(): Promise<string | undefined>;`
|
|
1537
|
+
- **getpersonallibraryuuid**: `function getPersonalLibraryUuid(): Promise<string | undefined>;`
|
|
1538
|
+
- **getprojectlibraryuuid**: `function getProjectLibraryUuid(): Promise<string | undefined>;`
|
|
1539
|
+
- **getsystemlibraryuuid**: `function getSystemLibraryUuid(): Promise<string | undefined>;`
|
|
1540
|
+
- **registerextendlibrary**: `function registerExtendLibrary( title: string, libraryFunctions: { device?: undefined | ILIB_ExtendLibraryDeviceFunctions; symbol?: undefined | ILIB_ExtendLibrarySymbolFunctions; footprint?: undefined | ILIB_ExtendLibraryFootprintFunctions; cbb?: undefined | ILIB_ExtendLibraryCbbFunctions; model3d?: undefined | ILIB_ExtendLibrary3DModelFunctions; }, ): Promise<string | undefined>;`
|
|
1541
|
+
|
|
1542
|
+
---
|
|
1543
|
+
|
|
1544
|
+
## LIB_PanelLibrary
|
|
1545
|
+
|
|
1546
|
+
Comprehensive library / panel library class
|
|
1547
|
+
|
|
1548
|
+
```typescript
|
|
1549
|
+
class LIB_PanelLibrary
|
|
1550
|
+
```
|
|
1551
|
+
|
|
1552
|
+
- **copy**: `function copy( panelLibraryUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newPanelLibraryName?: string, ): Promise<string | undefined>;`
|
|
1553
|
+
- **create**: `function create( libraryUuid: string, panelLibraryName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string, ): Promise<string | undefined>;`
|
|
1554
|
+
- **delete**: `function delete(panelLibraryUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1555
|
+
- **get**: `function get( panelLibraryUuid: string, libraryUuid?: string, ): Promise<ILIB_PanelLibraryItem | undefined>;`
|
|
1556
|
+
- **modify**: `function modify( panelLibraryUuid: string, libraryUuid: string, panelLibraryName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1557
|
+
- **openineditor**: `function openInEditor( panelLibraryUuid: string, libraryUuid: string, splitScreenId?: string, ): Promise<string | undefined>;`
|
|
1558
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_PanelLibrarySearchItem>>;`
|
|
1559
|
+
|
|
1560
|
+
---
|
|
1561
|
+
|
|
1562
|
+
## LIB_SelectControl
|
|
1563
|
+
|
|
1564
|
+
Comprehensive library / selection control class
|
|
1565
|
+
|
|
1566
|
+
```typescript
|
|
1567
|
+
class LIB_SelectControl
|
|
1568
|
+
```
|
|
1569
|
+
|
|
1570
|
+
- **getselectedlibraryrowinfo**: `function getSelectedLibraryRowInfo(): Promise<ILIB_LibraryItem | undefined>;`
|
|
1571
|
+
|
|
1572
|
+
---
|
|
1573
|
+
|
|
1574
|
+
## LIB_SimulationModel
|
|
1575
|
+
|
|
1576
|
+
Comprehensive library / simulation model class
|
|
1577
|
+
|
|
1578
|
+
```typescript
|
|
1579
|
+
class LIB_SimulationModel
|
|
1580
|
+
```
|
|
1581
|
+
|
|
1582
|
+
- **copy**: `function copy( simulationModelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: Array<string>, newSimulationModelName?: string, ): Promise<string | undefined>;`
|
|
1583
|
+
- **create**: `function create( libraryUuid: string, model: { modelType: 'Ngspice' } & ( | { modelFile: Blob; modelName?: undefined | string; modelCategory?: undefined | string; modelPin?: undefined | string; } | { modelData: string; modelName?: undefined | string; modelCategory?: undefined | string; modelPin?: undefined | string; } ), classification?: Array<string>, description?: string, ): Promise<string | undefined>;`
|
|
1584
|
+
- **delete**: `function delete(simulationModelUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1585
|
+
- **get**: `function get( simulationModelUuid: string, libraryUuid?: string, ): Promise<ILIB_SimulationModelItem | undefined>;`
|
|
1586
|
+
- **modify**: `function modify( simulationModelUuid: string, libraryUuid: string, modelProps?: { modelName?: undefined | string; modelCategory?: undefined | string; modelPin?: undefined | string; }, classification?: Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1587
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: Array<string>, simulationModelType?: ELIB_SimulationModelType, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_SimulationModelSearchItem>>;`
|
|
1588
|
+
|
|
1589
|
+
---
|
|
1590
|
+
|
|
1591
|
+
## LIB_Symbol
|
|
1592
|
+
|
|
1593
|
+
Comprehensive library / symbol class
|
|
1594
|
+
|
|
1595
|
+
```typescript
|
|
1596
|
+
class LIB_Symbol
|
|
1597
|
+
```
|
|
1598
|
+
|
|
1599
|
+
- **copy**: `function copy( symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newSymbolName?: string, ): Promise<string | undefined>;`
|
|
1600
|
+
- **create**: `function create( libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, description?: string, ): Promise<string | undefined>;`
|
|
1601
|
+
- **delete**: `function delete(symbolUuid: string, libraryUuid: string): Promise<boolean>;`
|
|
1602
|
+
- **get**: `function get(symbolUuid: string, libraryUuid?: string): Promise<ILIB_SymbolItem | undefined>;`
|
|
1603
|
+
- **getrenderimage**: `function getRenderImage(source: { symbolUuid: string; libraryUuid: string; subPartName?: undefined | string; }): Promise<Blob | undefined>;`
|
|
1604
|
+
- **modify**: `function modify( symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null, ): Promise<boolean>;`
|
|
1605
|
+
- **openineditor**: `function openInEditor( symbolUuid: string, libraryUuid: string, splitScreenId?: string, ): Promise<string | undefined>;`
|
|
1606
|
+
- **search**: `function search( key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number, ): Promise<Array<ILIB_SymbolSearchItem>>;`
|
|
1607
|
+
- **searchbyproperties**: `function searchByProperties( properties: ILIB_SymbolPropertiesForSearch, libraryUuid?: string, ): Promise<Array<ILIB_SymbolSearchItem>>;`
|
|
1608
|
+
- **updatedocumentsource**: `function updateDocumentSource( symbolUuid: string, libraryUuid: string, documentSource: string, ): Promise<boolean | undefined>;`
|
|
1609
|
+
|
|
1610
|
+
---
|
|
1611
|
+
|
|
1612
|
+
## PCB_Document
|
|
1613
|
+
|
|
1614
|
+
PCB & footprint / document operation class
|
|
1615
|
+
|
|
1616
|
+
```typescript
|
|
1617
|
+
class PCB_Document
|
|
1618
|
+
```
|
|
1619
|
+
|
|
1620
|
+
- **autolayout**: `function autoLayout(): Promise<IPCB_AutoLayoutResult>;`
|
|
1621
|
+
- **autorouting**: `function autoRouting(props?: IPCB_AutoRoutingProps): Promise<IPCB_AutoRoutingResult>;`
|
|
1622
|
+
- **clearrouting**: `function clearRouting(type?: 'all' | 'net' | 'connection'): Promise<boolean>;`
|
|
1623
|
+
- **convertcanvasorigintodataorigin**: `function convertCanvasOriginToDataOrigin(x: number, y: number): Promise<{ x: number; y: number }>;`
|
|
1624
|
+
- **convertdataorigintocanvasorigin**: `function convertDataOriginToCanvasOrigin(x: number, y: number): Promise<{ x: number; y: number }>;`
|
|
1625
|
+
- **getcalculatingratlinestatus**: `function getCalculatingRatlineStatus(): Promise< EPCB_DocumentRatlineCalculatingActiveStatus | undefined >;`
|
|
1626
|
+
- **getcanvasorigin**: `function getCanvasOrigin(): Promise<{ offsetX: number; offsetY: number }>;`
|
|
1627
|
+
- **getcanvasupdatecalculationstatus**: `function getCanvasUpdateCalculationStatus(): Promise< EPCB_DocumentCanvasUpdateCalculationActiveStatus | undefined >;`
|
|
1628
|
+
- **getcurrentfilterconfiguration**: `function getCurrentFilterConfiguration(): Promise<Record<string, any> | undefined>;`
|
|
1629
|
+
- **getprimitiveatpoint**: `function getPrimitiveAtPoint(x: number, y: number): Promise<IPCB_Primitive | undefined>;`
|
|
1630
|
+
- **getprimitivesinregion**: `function getPrimitivesInRegion( left: number, right: number, top: number, bottom: number, leftToRight?: boolean, ): Promise<Array<IPCB_Primitive>>;`
|
|
1631
|
+
- **importautolayoutjsonfile**: `function importAutoLayoutJsonFile(autoLayoutFile: File): Promise<boolean>;`
|
|
1632
|
+
- **importautoroutejsonfile**: `function importAutoRouteJsonFile(autoRouteFile: File): Promise<boolean>;`
|
|
1633
|
+
- **importautoroutesesfile**: `function importAutoRouteSesFile(autoRouteFile: File): Promise<boolean>;`
|
|
1634
|
+
- **importchanges**: `function importChanges(uuid?: string): Promise<boolean>;`
|
|
1635
|
+
- **navigatetocoordinates**: `function navigateToCoordinates(x: number, y: number): Promise<boolean>;`
|
|
1636
|
+
- **navigatetoregion**: `function navigateToRegion( left: number, right: number, top: number, bottom: number, ): Promise<boolean>;`
|
|
1637
|
+
- **save**: `function save(): Promise<boolean>;`
|
|
1638
|
+
- **setcanvasorigin**: `function setCanvasOrigin(offsetX: number, offsetY: number): Promise<boolean>;`
|
|
1639
|
+
- **startcalculatingratline**: `function startCalculatingRatline(): Promise<boolean>;`
|
|
1640
|
+
- **startcanvasupdatecalculation**: `function startCanvasUpdateCalculation(): Promise<boolean>;`
|
|
1641
|
+
- **stopcalculatingratline**: `function stopCalculatingRatline(): Promise<boolean>;`
|
|
1642
|
+
- **stopcanvasupdatecalculation**: `function stopCanvasUpdateCalculation(): Promise<boolean>;`
|
|
1643
|
+
- **triggercanvasupdatecalculation**: `function triggerCanvasUpdateCalculation(): Promise<boolean>;`
|
|
1644
|
+
- **zoomtoboardoutline**: `function zoomToBoardOutline(): Promise<boolean>;`
|
|
1645
|
+
|
|
1646
|
+
---
|
|
1647
|
+
|
|
1648
|
+
## PCB_Drc
|
|
1649
|
+
|
|
1650
|
+
PCB & footprint / design rule check (DRC) class
|
|
1651
|
+
|
|
1652
|
+
```typescript
|
|
1653
|
+
class PCB_Drc
|
|
1654
|
+
```
|
|
1655
|
+
|
|
1656
|
+
- **addnettoequallengthnetgroup**: `function addNetToEqualLengthNetGroup( equalLengthNetGroupName: string, net: string | Array<string>, ): Promise<boolean>;`
|
|
1657
|
+
- **addnettonetclass**: `function addNetToNetClass(netClassName: string, net: string | Array<string>): Promise<boolean>;`
|
|
1658
|
+
- **addpadpairtopadpairgroup**: `function addPadPairToPadPairGroup( padPairGroupName: string, padPair: [string, string] | Array<[string, string]>, ): Promise<boolean>;`
|
|
1659
|
+
- **check**: `function check( strict: boolean, userInterface: boolean, includeVerboseError: false, ): Promise<boolean>;`
|
|
1660
|
+
- **check_1**: `function check( strict: boolean, userInterface: boolean, includeVerboseError: true, ): Promise<Array<any>>;`
|
|
1661
|
+
- **createdifferentialpair**: `function createDifferentialPair( differentialPairName: string, positiveNet: string, negativeNet: string, ): Promise<boolean>;`
|
|
1662
|
+
- **createequallengthnetgroup**: `function createEqualLengthNetGroup( equalLengthNetGroupName: string, nets: Array<string>, color: IPCB_EqualLengthNetGroupItem['color'], ): Promise<boolean>;`
|
|
1663
|
+
- **createnetclass**: `function createNetClass( netClassName: string, nets: Array<string>, color: IPCB_EqualLengthNetGroupItem['color'], ): Promise<boolean>;`
|
|
1664
|
+
- **createpadpairgroup**: `function createPadPairGroup( padPairGroupName: string, padPairs: Array<[string, string]>, ): Promise<boolean>;`
|
|
1665
|
+
- **deletedifferentialpair**: `function deleteDifferentialPair(differentialPairName: string): Promise<boolean>;`
|
|
1666
|
+
- **deleteequallengthnetgroup**: `function deleteEqualLengthNetGroup(equalLengthNetGroupName: string): Promise<boolean>;`
|
|
1667
|
+
- **deletenetclass**: `function deleteNetClass(netClassName: string): Promise<boolean>;`
|
|
1668
|
+
- **deletepadpairgroup**: `function deletePadPairGroup(padPairGroupName: string): Promise<boolean>;`
|
|
1669
|
+
- **deleteruleconfiguration**: `function deleteRuleConfiguration(configurationName: string): Promise<boolean>;`
|
|
1670
|
+
- **getalldifferentialpairs**: `function getAllDifferentialPairs(): Promise<Array<IPCB_DifferentialPairItem> | Record<string, any>>;`
|
|
1671
|
+
- **getallequallengthnetgroups**: `function getAllEqualLengthNetGroups(): Promise<Array<IPCB_EqualLengthNetGroupItem>>;`
|
|
1672
|
+
- **getallnetclasses**: `function getAllNetClasses(): Promise<Array<IPCB_NetClassItem>>;`
|
|
1673
|
+
- **getallpadpairgroups**: `function getAllPadPairGroups(): Promise<Array<IPCB_PadPairGroupItem>>;`
|
|
1674
|
+
- **getallruleconfigurations**: `function getAllRuleConfigurations(includeSystem?: boolean): Promise<Array<Record<string, any>>>;`
|
|
1675
|
+
- **getcurrentruleconfiguration**: `function getCurrentRuleConfiguration(): Promise<Record<string, any> | undefined>;`
|
|
1676
|
+
- **getcurrentruleconfigurationname**: `function getCurrentRuleConfigurationName(): Promise<string | undefined>;`
|
|
1677
|
+
- **getdefaultruleconfigurationname**: `function getDefaultRuleConfigurationName(): Promise<string | undefined>;`
|
|
1678
|
+
- **getnetbynetrules**: `function getNetByNetRules(): Promise<Record<string, any>>;`
|
|
1679
|
+
- **getnetrules**: `function getNetRules(): Promise<Array<Record<string, any>>>;`
|
|
1680
|
+
- **getpadpairgroupminwirelength**: `function getPadPairGroupMinWireLength( padPairGroupName: string, ): Promise<Array<IPCB_PadPairMinWireLengthItem>>;`
|
|
1681
|
+
- **getrealtimedrcstatus**: `function getRealTimeDrcStatus(): Promise<boolean>;`
|
|
1682
|
+
- **getregionrules**: `function getRegionRules(): Promise<Array<Record<string, any>>>;`
|
|
1683
|
+
- **getruleconfiguration**: `function getRuleConfiguration(configurationName: string): Promise<Record<string, any> | undefined>;`
|
|
1684
|
+
- **modifydifferentialpairname**: `function modifyDifferentialPairName( originalDifferentialPairName: string, differentialPairName: string, ): Promise<boolean>;`
|
|
1685
|
+
- **modifydifferentialpairnegativenet**: `function modifyDifferentialPairNegativeNet( differentialPairName: string, negativeNet: string, ): Promise<boolean>;`
|
|
1686
|
+
- **modifydifferentialpairpositivenet**: `function modifyDifferentialPairPositiveNet( differentialPairName: string, positiveNet: string, ): Promise<boolean>;`
|
|
1687
|
+
- **modifyequallengthnetgroupname**: `function modifyEqualLengthNetGroupName( originalEqualLengthNetGroupName: string, equalLengthNetGroupName: string, ): Promise<boolean>;`
|
|
1688
|
+
- **modifynetclassname**: `function modifyNetClassName(originalNetClassName: string, netClassName: string): Promise<boolean>;`
|
|
1689
|
+
- **modifypadpairgroupname**: `function modifyPadPairGroupName( originalPadPairGroupName: string, padPairGroupName: string, ): Promise<boolean>;`
|
|
1690
|
+
- **overwritecurrentruleconfiguration**: `function overwriteCurrentRuleConfiguration( ruleConfiguration: Record<string, any>, ): Promise<boolean>;`
|
|
1691
|
+
- **overwritenetbynetrules**: `function overwriteNetByNetRules(netByNetRules: Record<string, any>): Promise<boolean>;`
|
|
1692
|
+
- **overwritenetrules**: `function overwriteNetRules(netRules: Array<Record<string, any>>): Promise<boolean>;`
|
|
1693
|
+
- **overwriteregionrules**: `function overwriteRegionRules(regionRules: Array<Record<string, any>>): Promise<boolean>;`
|
|
1694
|
+
- **removenetfromequallengthnetgroup**: `function removeNetFromEqualLengthNetGroup( equalLengthNetGroupName: string, net: string | Array<string>, ): Promise<boolean>;`
|
|
1695
|
+
- **removenetfromnetclass**: `function removeNetFromNetClass(netClassName: string, net: string | Array<string>): Promise<boolean>;`
|
|
1696
|
+
- **removepadpairfrompadpairgroup**: `function removePadPairFromPadPairGroup( padPairGroupName: string, padPair: [string, string] | Array<[string, string]>, ): Promise<boolean>;`
|
|
1697
|
+
- **renameruleconfiguration**: `function renameRuleConfiguration( originalConfigurationName: string, configurationName: string, ): Promise<boolean>;`
|
|
1698
|
+
- **saveruleconfiguration**: `function saveRuleConfiguration( ruleConfiguration: Record<string, any>, configurationName: string, allowOverwrite?: boolean, ): Promise<boolean>;`
|
|
1699
|
+
- **setasdefaultruleconfiguration**: `function setAsDefaultRuleConfiguration(configurationName: string): Promise<boolean>;`
|
|
1700
|
+
- **startrealtimedrc**: `function startRealTimeDrc(): Promise<boolean>;`
|
|
1701
|
+
- **stoprealtimedrc**: `function stopRealTimeDrc(): Promise<boolean>;`
|
|
1702
|
+
|
|
1703
|
+
---
|
|
1704
|
+
|
|
1705
|
+
## PCB_Event
|
|
1706
|
+
|
|
1707
|
+
PCB & footprint / event class
|
|
1708
|
+
|
|
1709
|
+
```typescript
|
|
1710
|
+
class PCB_Event
|
|
1711
|
+
```
|
|
1712
|
+
|
|
1713
|
+
- **addcrossprobeselecteventlistener**: `function addCrossProbeSelectEventListener( id: string, callFn: (props: any) => void | Promise<void>, ): void;`
|
|
1714
|
+
- **addmouseeventlistener**: `function addMouseEventListener( id: string, eventType: 'all' | EPCB_MouseEventType, callFn: ( eventType: EPCB_MouseEventType, props: [ { primitiveId: string; primitiveType: EPCB_PrimitiveType; net?: undefined | string; designator?: undefined | string; parentComponentPrimitiveId?: undefined | string; parentComponentDesignator?: undefined | string; }, ], ) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
1715
|
+
- **addneteventlistener**: `function addNetEventListener( id: string, eventType: 'all' | EPCB_NetEventType, callFn: (eventType: EPCB_NetEventType, props: [{ net: string }]) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
1716
|
+
- **addprimitiveeventlistener**: `function addPrimitiveEventListener( id: string, eventType: 'all' | EPCB_PrimitiveEventType, callFn: ( eventType: EPCB_PrimitiveEventType, props: [ { primitiveId: string; primitiveType: EPCB_PrimitiveType; net?: undefined | string; designator?: undefined | string; parentComponentPrimitiveId?: undefined | string; parentComponentDesignator?: undefined | string; }, ], ) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
1717
|
+
- **addraytracerengine3dviewcamerachangeeventlistener**: `function addRayTracerEngine3DViewCameraChangeEventListener( id: string, callFn: (props: { position: { x: number; y: number; z: number }; rotation: { x: number; y: number; z: number }; focalLength: number; }) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
1718
|
+
- **addraytracerengine3dviewclickmaterialeventlistener**: `function addRayTracerEngine3DViewClickMaterialEventListener( id: string, callFn: (props: { materialId: number; material: any }) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
1719
|
+
- **addrealtimedrcresulteventlistener**: `function addRealTimeDrcResultEventListener( id: string, eventType: 'all', callFn: (eventType: undefined, props: [{ drcResult: any }]) => void | Promise<void>, ): void;`
|
|
1720
|
+
- **iseventlisteneralreadyexist**: `function isEventListenerAlreadyExist(id: string): boolean;`
|
|
1721
|
+
- **removeeventlistener**: `function removeEventListener(id: string): boolean;`
|
|
1722
|
+
|
|
1723
|
+
---
|
|
1724
|
+
|
|
1725
|
+
## PCB_Layer
|
|
1726
|
+
|
|
1727
|
+
PCB & footprint / layer operation class
|
|
1728
|
+
|
|
1729
|
+
```typescript
|
|
1730
|
+
class PCB_Layer
|
|
1731
|
+
```
|
|
1732
|
+
|
|
1733
|
+
- **addcustomlayer**: `function addCustomLayer(): Promise<TPCB_LayersOfCustom | undefined>;`
|
|
1734
|
+
- **deletephysicalstackingconfiguration**: `function deletePhysicalStackingConfiguration( configurationName: string, physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<boolean>;`
|
|
1735
|
+
- **getalllayers**: `function getAllLayers(): Promise<Array<IPCB_LayerItem>>;`
|
|
1736
|
+
- **getallphysicalstackingconfigurations**: `function getAllPhysicalStackingConfigurations( physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<Array<IPCB_PhysicalStackingConfiguration>>;`
|
|
1737
|
+
- **getcurrentlayer**: `function getCurrentLayer(): Promise<IPCB_LayerItem | undefined>;`
|
|
1738
|
+
- **getcurrentphysicalstackingconfiguration**: `function getCurrentPhysicalStackingConfiguration(): Promise< IPCB_PhysicalStackingConfiguration | undefined >;`
|
|
1739
|
+
- **getcurrentphysicalstackingconfigurationname**: `function getCurrentPhysicalStackingConfigurationName(): Promise<string | undefined>;`
|
|
1740
|
+
- **getdefaultphysicalstackingconfigurationname**: `function getDefaultPhysicalStackingConfigurationName( physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<string | undefined>;`
|
|
1741
|
+
- **getphysicalstackingconfiguration**: `function getPhysicalStackingConfiguration( configurationName: string, physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<IPCB_PhysicalStackingConfiguration | undefined>;`
|
|
1742
|
+
- **locklayer**: `function lockLayer( layer?: TPCB_LayersInTheSelectable | Array<TPCB_LayersInTheSelectable>, ): Promise<boolean>;`
|
|
1743
|
+
- **modifylayer**: `function modifyLayer( layer: TPCB_LayersInTheSelectable, property: { name?: undefined | string; type?: undefined | EPCB_LayerType.SIGNAL | EPCB_LayerType.INTERNAL_ELECTRICAL; color?: undefined | string; transparency?: undefined | number; }, ): Promise<boolean>;`
|
|
1744
|
+
- **overwritecurrentphysicalstackingconfiguration**: `function overwriteCurrentPhysicalStackingConfiguration( physicalStackingConfiguration: IPCB_PhysicalStackingConfiguration, ): Promise<boolean>;`
|
|
1745
|
+
- **removelayer**: `function removeLayer(layer: TPCB_LayersOfCustom): Promise<boolean>;`
|
|
1746
|
+
- **renamephysicalstackingconfiguration**: `function renamePhysicalStackingConfiguration( originalConfigurationName: string, configurationName: string, physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<boolean>;`
|
|
1747
|
+
- **savephysicalstackingconfiguration**: `function savePhysicalStackingConfiguration( physicalStackingConfiguration: IPCB_PhysicalStackingConfiguration, configurationName: string, physicalProps?: IPCB_SubstratePhysicalProperties, allowOverwrite?: boolean, ): Promise<boolean>;`
|
|
1748
|
+
- **selectlayer**: `function selectLayer(layer: TPCB_LayersInTheSelectable): Promise<boolean>;`
|
|
1749
|
+
- **setasdefaultphysicalstackingconfiguration**: `function setAsDefaultPhysicalStackingConfiguration( configurationName: string, physicalProps?: IPCB_SubstratePhysicalProperties, ): Promise<boolean>;`
|
|
1750
|
+
- **setinactivelayerdisplaymode**: `function setInactiveLayerDisplayMode(displayMode?: EPCB_InactiveLayerDisplayMode): Promise<boolean>;`
|
|
1751
|
+
- **setinactivelayertransparency**: `function setInactiveLayerTransparency(transparency: number): Promise<boolean>;`
|
|
1752
|
+
- **setlayercolorconfiguration**: `function setLayerColorConfiguration( colorConfiguration: EPCB_LayerColorConfiguration, ): Promise<boolean>;`
|
|
1753
|
+
- **setlayerinvisible**: `function setLayerInvisible( layer?: TPCB_LayersInTheSelectable | Array<TPCB_LayersInTheSelectable>, setOtherLayerVisible?: boolean, ): Promise<boolean>;`
|
|
1754
|
+
- **setlayervisible**: `function setLayerVisible( layer?: TPCB_LayersInTheSelectable | Array<TPCB_LayersInTheSelectable>, setOtherLayerInvisible?: boolean, ): Promise<boolean>;`
|
|
1755
|
+
- **setpcbtype**: `function setPcbType(pcbType: EPCB_PcbPlateType): Promise<boolean>;`
|
|
1756
|
+
- **setthenumberofcopperlayers**: `function setTheNumberOfCopperLayers(numberOfLayers: TPCB_NumberOfCopperLayers): Promise<boolean>;`
|
|
1757
|
+
- **unlocklayer**: `function unlockLayer( layer?: TPCB_LayersInTheSelectable | Array<TPCB_LayersInTheSelectable>, ): Promise<boolean>;`
|
|
1758
|
+
|
|
1759
|
+
---
|
|
1760
|
+
|
|
1761
|
+
## PCB_ManufactureData
|
|
1762
|
+
|
|
1763
|
+
PCB & footprint / manufacture data class
|
|
1764
|
+
|
|
1765
|
+
```typescript
|
|
1766
|
+
class PCB_ManufactureData
|
|
1767
|
+
```
|
|
1768
|
+
|
|
1769
|
+
- **deletebomtemplate**: `function deleteBomTemplate(template: string): Promise<boolean>;`
|
|
1770
|
+
- **get3dfile**: `function get3DFile( fileName?: string, fileType?: 'step' | 'obj', element?: Array<'Component Model' | 'Via' | 'Silkscreen' | 'Wire In Signal Layer'>, modelMode?: 'Outfit' | 'Parts', autoGenerateModels?: boolean, ): Promise<File | undefined>;`
|
|
1771
|
+
- **get3dshellfile**: `function get3DShellFile( fileName?: string, fileType?: 'stl' | 'step' | 'obj', ): Promise<File | undefined>;`
|
|
1772
|
+
- **getaltiumdesignerfile**: `function getAltiumDesignerFile(fileName?: string): Promise<File | undefined>;`
|
|
1773
|
+
- **getautolayoutjsonfile**: `function getAutoLayoutJsonFile(fileName?: string): Promise<File | undefined>;`
|
|
1774
|
+
- **getautoroutejsonfile**: `function getAutoRouteJsonFile(fileName?: string): Promise<File | undefined>;`
|
|
1775
|
+
- **getautoroutejsonfileforjrouter**: `function getAutoRouteJsonFileForJRouter(fileName?: string): Promise<File | undefined>;`
|
|
1776
|
+
- **getbomfile**: `function getBomFile( fileName?: string, fileType?: 'xlsx' | 'csv', template?: string, filterOptions?: Array<{ property: string; includeValue: string | false | true }>, statistics?: Array<string>, property?: Array<string>, columns?: Array<IPCB_BomPropertiesTableColumns>, ): Promise<File | undefined>;`
|
|
1777
|
+
- **getbomtemplatefile**: `function getBomTemplateFile(template: string): Promise<File | undefined>;`
|
|
1778
|
+
- **getbomtemplates**: `function getBomTemplates(): Promise<Array<string>>;`
|
|
1779
|
+
- **getdsnfile**: `function getDsnFile(fileName?: string): Promise<File | undefined>;`
|
|
1780
|
+
- **getdxffile**: `function getDxfFile( fileName?: string, layers?: Array<{ layerId: EPCB_LayerId; mirror: boolean }>, objects?: Array<string>, ): Promise<File | undefined>;`
|
|
1781
|
+
- **getflyingprobetestfile**: `function getFlyingProbeTestFile(fileName?: string): Promise<File | undefined>;`
|
|
1782
|
+
- **getgerberfile**: *(签名过长,请查看详细文档)*
|
|
1783
|
+
- **getidxfile**: `function getIdxFile(fileName?: string): Promise<File | undefined>;`
|
|
1784
|
+
- **getipc2581cfile**: `function getIpc2581CFile( fileName?: string, fileType?: 'xml' | 'cvg' | '2581', unit?: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER, oemNumber?: 'Device' | 'Manufacturer Part' | 'Supplier Part' | 'Comment', ): Promise<File | undefined>;`
|
|
1785
|
+
- **getipcd356afile**: `function getIpcD356AFile(fileName?: string): Promise<File | undefined>;`
|
|
1786
|
+
- **getmanufacturedata**: `function getManufactureData(): Promise<File | undefined>;`
|
|
1787
|
+
- **getnetlistfile**: `function getNetlistFile( fileName?: string, netlistType?: ESYS_NetlistType, ): Promise<File | undefined>;`
|
|
1788
|
+
- **getopendatabasedoubleplusfile**: `function getOpenDatabaseDoublePlusFile( fileName?: string, unit?: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER, otherData?: { metallizedDrilledHoles?: undefined | false | true; nonMetallizedDrilledHoles?: undefined | false | true; drillTable?: undefined | false | true; flyingProbeTestFile?: undefined | false | true; }, layers?: Array<{ layerId: EPCB_LayerId; mirror: boolean }>, objects?: Array<{ objectName: string }>, ): Promise<File | undefined>;`
|
|
1789
|
+
- **getpadsfile**: `function getPadsFile(fileName?: string): Promise<File | undefined>;`
|
|
1790
|
+
- **getpcbinfofile**: `function getPcbInfoFile(fileName?: string): Promise<File | undefined>;`
|
|
1791
|
+
- **getpdffile**: *(签名过长,请查看详细文档)*
|
|
1792
|
+
- **getpickandplacefile**: `function getPickAndPlaceFile( fileName?: string, fileType?: 'xlsx' | 'csv', unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.MIL, ): Promise<File | undefined>;`
|
|
1793
|
+
- **gettestpointfile**: `function getTestPointFile(fileName?: string, fileType?: 'xlsx' | 'csv'): Promise<File | undefined>;`
|
|
1794
|
+
- **place3dshellorder**: `function place3DShellOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
1795
|
+
- **placecomponentsorder**: `function placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
1796
|
+
- **placepcborder**: `function placePcbOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
1797
|
+
- **placesmtcomponentsorder**: `function placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
1798
|
+
- **uploadbomtemplatefile**: `function uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;`
|
|
1799
|
+
|
|
1800
|
+
---
|
|
1801
|
+
|
|
1802
|
+
## PCB_MathPolygon
|
|
1803
|
+
|
|
1804
|
+
PCB & footprint / polygon math class
|
|
1805
|
+
|
|
1806
|
+
```typescript
|
|
1807
|
+
class PCB_MathPolygon
|
|
1808
|
+
```
|
|
1809
|
+
|
|
1810
|
+
- **calculatebboxheight**: `function calculateBBoxHeight( complexPolygon: TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray>, ): number;`
|
|
1811
|
+
- **calculateheight**: `function calculateHeight( complexPolygon: | TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | IPCB_ComplexPolygon, ): number;`
|
|
1812
|
+
- **calculatewidth**: `function calculateWidth( complexPolygon: | TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | IPCB_ComplexPolygon, ): number;`
|
|
1813
|
+
- **convertimagetocomplexpolygon**: `function convertImageToComplexPolygon( imageBlob: Blob, imageWidth: number, imageHeight: number, tolerance?: number, simplification?: number, smoothing?: number, despeckling?: number, whiteAsBackgroundColor?: boolean, inversion?: boolean, ): Promise<IPCB_ComplexPolygon | undefined>;`
|
|
1814
|
+
- **createcomplexpolygon**: `function createComplexPolygon( complexPolygon: | TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | Array<IPCB_Polygon>, ): IPCB_ComplexPolygon | undefined;`
|
|
1815
|
+
- **createpolygon**: `function createPolygon(polygon: TPCB_PolygonSourceArray): IPCB_Polygon | undefined;`
|
|
1816
|
+
- **discretize**: `function discretize( polygon: IPCB_Polygon | TPCB_PolygonSourceArray, options?: IPCB_DiscretizeOptions, ): Promise<Array<IPCB_DiscretizedPoint>>;`
|
|
1817
|
+
- **splitpolygon**: `function splitPolygon(...complexPolygons: Array<IPCB_ComplexPolygon>): Array<IPCB_Polygon>;`
|
|
1818
|
+
|
|
1819
|
+
---
|
|
1820
|
+
|
|
1821
|
+
## PCB_Net
|
|
1822
|
+
|
|
1823
|
+
PCB & footprint / net class
|
|
1824
|
+
|
|
1825
|
+
```typescript
|
|
1826
|
+
class PCB_Net
|
|
1827
|
+
```
|
|
1828
|
+
|
|
1829
|
+
- **getallnetname**: `function getAllNetName(): Promise<Array<string>>;`
|
|
1830
|
+
- **getallnets**: `function getAllNets(): Promise<Array<IPCB_NetInfo>>;`
|
|
1831
|
+
- **getallnetsname**: `function getAllNetsName(): Promise<Array<string>>;`
|
|
1832
|
+
- **getallprimitivesbynet**: `function getAllPrimitivesByNet( net: string, primitiveTypes?: Array<EPCB_PrimitiveType>, ): Promise<Array<IPCB_Primitive>>;`
|
|
1833
|
+
- **getnet**: `function getNet(net: string): Promise<IPCB_NetInfo | undefined>;`
|
|
1834
|
+
- **getnetcolor**: `function getNetColor(net: string): Promise<IPCB_NetInfo['color'] | undefined>;`
|
|
1835
|
+
- **getnetlength**: `function getNetLength(net: string): Promise<number | undefined>;`
|
|
1836
|
+
- **getnetlist**: `function getNetlist(type?: ESYS_NetlistType): Promise<string>;`
|
|
1837
|
+
- **highlightnet**: `function highlightNet(net: string): Promise<boolean>;`
|
|
1838
|
+
- **selectnet**: `function selectNet(net: string): Promise<boolean>;`
|
|
1839
|
+
- **setnetcolor**: `function setNetColor(net: string, color: IPCB_NetInfo['color']): Promise<boolean>;`
|
|
1840
|
+
- **setnetlist**: `function setNetlist(type: ESYS_NetlistType | undefined, netlist: string): Promise<boolean>;`
|
|
1841
|
+
- **unhighlightallnets**: `function unhighlightAllNets(): Promise<boolean>;`
|
|
1842
|
+
- **unhighlightnet**: `function unhighlightNet(net: string): Promise<boolean>;`
|
|
1843
|
+
- **unselectallnets**: `function unselectAllNets(): Promise<boolean>;`
|
|
1844
|
+
- **unselectnet**: `function unselectNet(net: string): Promise<boolean>;`
|
|
1845
|
+
|
|
1846
|
+
---
|
|
1847
|
+
|
|
1848
|
+
## PCB_Primitive
|
|
1849
|
+
|
|
1850
|
+
PCB & footprint / primitive class
|
|
1851
|
+
|
|
1852
|
+
```typescript
|
|
1853
|
+
class PCB_Primitive
|
|
1854
|
+
```
|
|
1855
|
+
|
|
1856
|
+
- **getprimitiveboardline**: `function getPrimitiveBoardLine( primitiveId: string, layers?: Array<EPCB_LayerId>, ): Promise<IPCB_ComplexPolygon | undefined>;`
|
|
1857
|
+
- **getprimitivesbbox**: `function getPrimitivesBBox( primitiveIds: Array<string | IPCB_Primitive>, ): Promise<{ minX: number; minY: number; maxX: number; maxY: number } | undefined>;`
|
|
1858
|
+
|
|
1859
|
+
---
|
|
1860
|
+
|
|
1861
|
+
## PCB_PrimitiveArc
|
|
1862
|
+
|
|
1863
|
+
PCB & footprint / arc line primitive class
|
|
1864
|
+
|
|
1865
|
+
```typescript
|
|
1866
|
+
class PCB_PrimitiveArc implements IPCB_PrimitiveAPI
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
- **create**: `function create( net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, arcAngle: number, lineWidth?: number, interactiveMode?: EPCB_PrimitiveArcInteractiveMode, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveArc | undefined>;`
|
|
1870
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveArc | Array<string> | Array<IPCB_PrimitiveArc>): Promise<boolean>;`
|
|
1871
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveArc | undefined>;`
|
|
1872
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveArc>>;`
|
|
1873
|
+
- **getall**: `function getAll( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveArc>>;`
|
|
1874
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1875
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1876
|
+
|
|
1877
|
+
---
|
|
1878
|
+
|
|
1879
|
+
## PCB_PrimitiveAttribute
|
|
1880
|
+
|
|
1881
|
+
PCB & footprint / property primitive class
|
|
1882
|
+
|
|
1883
|
+
```typescript
|
|
1884
|
+
class PCB_PrimitiveAttribute implements IPCB_PrimitiveAPI
|
|
1885
|
+
```
|
|
1886
|
+
|
|
1887
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveAttribute | Array<string> | Array<IPCB_PrimitiveAttribute>): Promise<boolean>;`
|
|
1888
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveAttribute | undefined>;`
|
|
1889
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveAttribute>>;`
|
|
1890
|
+
- **getall**: `function getAll( parentPrimitiveId?: string, layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveAttribute>>;`
|
|
1891
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( parentPrimitiveId?: string, layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1892
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1893
|
+
|
|
1894
|
+
---
|
|
1895
|
+
|
|
1896
|
+
## PCB_PrimitiveComponent
|
|
1897
|
+
|
|
1898
|
+
PCB & footprint / device primitive class
|
|
1899
|
+
|
|
1900
|
+
```typescript
|
|
1901
|
+
class PCB_PrimitiveComponent implements IPCB_PrimitiveAPI
|
|
1902
|
+
```
|
|
1903
|
+
|
|
1904
|
+
- **create**: `function create( component: | { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem | { libraryType: ELIB_LibraryType.FOOTPRINT; libraryUuid: string; uuid: string } | ILIB_FootprintItem | ILIB_FootprintSearchItem, layer: TPCB_LayersOfComponent, x: number, y: number, rotation?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveComponent | undefined>;`
|
|
1905
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveComponent | Array<string> | Array<IPCB_PrimitiveComponent>): Promise<boolean>;`
|
|
1906
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveComponent | undefined>;`
|
|
1907
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveComponent>>;`
|
|
1908
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfComponent, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveComponent>>;`
|
|
1909
|
+
- **getallpinsbyprimitiveid**: `function getAllPinsByPrimitiveId( primitiveId: string, ): Promise<Array<IPCB_PrimitiveComponentPad> | undefined>;`
|
|
1910
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfComponent, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1911
|
+
- **getallpropertynames**: `function getAllPropertyNames(): Promise<Array<string>>;`
|
|
1912
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1913
|
+
- **placecomponentwithmouse**: `function placeComponentWithMouse( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
1914
|
+
- **placefootprintwithmouse**: `function placeFootprintWithMouse( footprint: { libraryUuid: string; uuid: string } | ILIB_FootprintItem | ILIB_FootprintSearchItem, properties?: Record<string, boolean | number | string | undefined>, ): Promise<boolean>;`
|
|
1915
|
+
|
|
1916
|
+
---
|
|
1917
|
+
|
|
1918
|
+
## PCB_PrimitiveDimension
|
|
1919
|
+
|
|
1920
|
+
PCB & footprint / dimension primitive class
|
|
1921
|
+
|
|
1922
|
+
```typescript
|
|
1923
|
+
class PCB_PrimitiveDimension implements IPCB_PrimitiveAPI
|
|
1924
|
+
```
|
|
1925
|
+
|
|
1926
|
+
- **create**: `function create( dimensionType: EPCB_PrimitiveDimensionType, coordinateSet: TPCB_PrimitiveDimensionCoordinateSet, layer?: TPCB_LayersOfDimension, unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.INCH | ESYS_Unit.MIL, lineWidth?: number, precision?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveDimension | undefined>;`
|
|
1927
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveDimension | Array<string> | Array<IPCB_PrimitiveDimension>): Promise<boolean>;`
|
|
1928
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveDimension | undefined>;`
|
|
1929
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveDimension>>;`
|
|
1930
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfDimension, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveDimension>>;`
|
|
1931
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfDimension, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1932
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1933
|
+
|
|
1934
|
+
---
|
|
1935
|
+
|
|
1936
|
+
## PCB_PrimitiveFill
|
|
1937
|
+
|
|
1938
|
+
PCB & footprint / fill primitive class
|
|
1939
|
+
|
|
1940
|
+
```typescript
|
|
1941
|
+
class PCB_PrimitiveFill implements IPCB_PrimitiveAPI
|
|
1942
|
+
```
|
|
1943
|
+
|
|
1944
|
+
- **create**: `function create( layer: TPCB_LayersOfFill, complexPolygon: IPCB_Polygon, net?: string, fillMode?: EPCB_PrimitiveFillMode, lineWidth?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveFill | undefined>;`
|
|
1945
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveFill | Array<string> | Array<IPCB_PrimitiveFill>): Promise<boolean>;`
|
|
1946
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveFill | undefined>;`
|
|
1947
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveFill>>;`
|
|
1948
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveFill>>;`
|
|
1949
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfFill, net?: string, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1950
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1951
|
+
|
|
1952
|
+
---
|
|
1953
|
+
|
|
1954
|
+
## PCB_PrimitiveImage
|
|
1955
|
+
|
|
1956
|
+
PCB & footprint / image primitive class
|
|
1957
|
+
|
|
1958
|
+
```typescript
|
|
1959
|
+
class PCB_PrimitiveImage implements IPCB_PrimitiveAPI
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
- **create**: `function create( x: number, y: number, complexPolygon: | TPCB_PolygonSourceArray | Array<TPCB_PolygonSourceArray> | IPCB_Polygon | IPCB_ComplexPolygon, layer: TPCB_LayersOfImage, width?: number, height?: number, rotation?: number, horizonMirror?: boolean, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveImage | undefined>;`
|
|
1963
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveImage | Array<string> | Array<IPCB_PrimitiveImage>): Promise<boolean>;`
|
|
1964
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveImage | undefined>;`
|
|
1965
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveImage>>;`
|
|
1966
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveImage>>;`
|
|
1967
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1968
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1969
|
+
|
|
1970
|
+
---
|
|
1971
|
+
|
|
1972
|
+
## PCB_PrimitiveLine
|
|
1973
|
+
|
|
1974
|
+
PCB & footprint / line primitive class
|
|
1975
|
+
|
|
1976
|
+
```typescript
|
|
1977
|
+
class PCB_PrimitiveLine implements IPCB_PrimitiveAPI
|
|
1978
|
+
```
|
|
1979
|
+
|
|
1980
|
+
- **create**: `function create( net: string, layer: TPCB_LayersOfLine, startX: number, startY: number, endX: number, endY: number, lineWidth?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveLine | undefined>;`
|
|
1981
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveLine | Array<string> | Array<IPCB_PrimitiveLine>): Promise<boolean>;`
|
|
1982
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveLine | undefined>;`
|
|
1983
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveLine>>;`
|
|
1984
|
+
- **getall**: `function getAll( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveLine>>;`
|
|
1985
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
1986
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
1987
|
+
|
|
1988
|
+
---
|
|
1989
|
+
|
|
1990
|
+
## PCB_PrimitiveObject
|
|
1991
|
+
|
|
1992
|
+
PCB & footprint / binary embedded object primitive class
|
|
1993
|
+
|
|
1994
|
+
```typescript
|
|
1995
|
+
class PCB_PrimitiveObject implements IPCB_PrimitiveAPI
|
|
1996
|
+
```
|
|
1997
|
+
|
|
1998
|
+
- **create**: `function create( layer: TPCB_LayersOfObject, topLeftX: number, topLeftY: number, binaryData: string, width: number, height: number, rotation?: number, mirror?: boolean, fileName?: string, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveObject | undefined>;`
|
|
1999
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveObject | Array<string> | Array<IPCB_PrimitiveObject>): Promise<boolean>;`
|
|
2000
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveObject | undefined>;`
|
|
2001
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveObject>>;`
|
|
2002
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfObject, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveObject>>;`
|
|
2003
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfObject, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
2004
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2005
|
+
|
|
2006
|
+
---
|
|
2007
|
+
|
|
2008
|
+
## PCB_PrimitivePad
|
|
2009
|
+
|
|
2010
|
+
PCB & footprint / pad primitive class
|
|
2011
|
+
|
|
2012
|
+
```typescript
|
|
2013
|
+
class PCB_PrimitivePad implements IPCB_PrimitiveAPI
|
|
2014
|
+
```
|
|
2015
|
+
|
|
2016
|
+
- **create**: *(签名过长,请查看详细文档)*
|
|
2017
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitivePad | Array<string> | Array<IPCB_PrimitivePad>): Promise<boolean>;`
|
|
2018
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitivePad | undefined>;`
|
|
2019
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePad>>;`
|
|
2020
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean, padType?: EPCB_PrimitivePadType, ): Promise<Array<IPCB_PrimitivePad>>;`
|
|
2021
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfPad, net?: string, primitiveLock?: boolean, padType?: EPCB_PrimitivePadType, ): Promise<Array<string>>;`
|
|
2022
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2023
|
+
|
|
2024
|
+
---
|
|
2025
|
+
|
|
2026
|
+
## PCB_PrimitivePolyline
|
|
2027
|
+
|
|
2028
|
+
PCB & footprint / polyline primitive class
|
|
2029
|
+
|
|
2030
|
+
```typescript
|
|
2031
|
+
class PCB_PrimitivePolyline implements IPCB_PrimitiveAPI
|
|
2032
|
+
```
|
|
2033
|
+
|
|
2034
|
+
- **create**: `function create( net: string, layer: TPCB_LayersOfLine, polygon: IPCB_Polygon, lineWidth?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitivePolyline | undefined>;`
|
|
2035
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitivePolyline | Array<string> | Array<IPCB_PrimitivePolyline>): Promise<boolean>;`
|
|
2036
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitivePolyline | undefined>;`
|
|
2037
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePolyline>>;`
|
|
2038
|
+
- **getall**: `function getAll( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitivePolyline>>;`
|
|
2039
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( net?: string, layer?: TPCB_LayersOfLine, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
2040
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2041
|
+
|
|
2042
|
+
---
|
|
2043
|
+
|
|
2044
|
+
## PCB_PrimitivePour
|
|
2045
|
+
|
|
2046
|
+
PCB & footprint / copper border primitive class
|
|
2047
|
+
|
|
2048
|
+
```typescript
|
|
2049
|
+
class PCB_PrimitivePour implements IPCB_PrimitiveAPI
|
|
2050
|
+
```
|
|
2051
|
+
|
|
2052
|
+
- **create**: `function create( net: string, layer: TPCB_LayersOfCopper, complexPolygon: IPCB_Polygon, pourFillMethod?: EPCB_PrimitivePourFillMethod, preserveSilos?: boolean, pourName?: string, pourPriority?: number, lineWidth?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitivePour | undefined>;`
|
|
2053
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitivePour | Array<string> | Array<IPCB_PrimitivePour>): Promise<boolean>;`
|
|
2054
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitivePour | undefined>;`
|
|
2055
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePour>>;`
|
|
2056
|
+
- **getall**: `function getAll( net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitivePour>>;`
|
|
2057
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( net?: string, layer?: TPCB_LayersOfCopper, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
2058
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2059
|
+
|
|
2060
|
+
---
|
|
2061
|
+
|
|
2062
|
+
## PCB_PrimitivePoured
|
|
2063
|
+
|
|
2064
|
+
PCB & footprint / copper fill primitive class
|
|
2065
|
+
|
|
2066
|
+
```typescript
|
|
2067
|
+
class PCB_PrimitivePoured implements IPCB_PrimitiveAPI
|
|
2068
|
+
```
|
|
2069
|
+
|
|
2070
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitivePoured | Array<string> | Array<IPCB_PrimitivePoured>): Promise<boolean>;`
|
|
2071
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitivePoured | undefined>;`
|
|
2072
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePoured>>;`
|
|
2073
|
+
- **getall**: `function getAll(): Promise<Array<IPCB_PrimitivePoured>>;`
|
|
2074
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2075
|
+
|
|
2076
|
+
---
|
|
2077
|
+
|
|
2078
|
+
## PCB_PrimitiveRegion
|
|
2079
|
+
|
|
2080
|
+
PCB & footprint / forbidden region and constrained region primitive class
|
|
2081
|
+
|
|
2082
|
+
```typescript
|
|
2083
|
+
class PCB_PrimitiveRegion implements IPCB_PrimitiveAPI
|
|
2084
|
+
```
|
|
2085
|
+
|
|
2086
|
+
- **create**: `function create( layer: TPCB_LayersOfRegion, complexPolygon: IPCB_Polygon, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, regionName?: string, lineWidth?: number, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveRegion | undefined>;`
|
|
2087
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveRegion | Array<string> | Array<IPCB_PrimitiveRegion>): Promise<boolean>;`
|
|
2088
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveRegion | undefined>;`
|
|
2089
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveRegion>>;`
|
|
2090
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveRegion>>;`
|
|
2091
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
2092
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2093
|
+
|
|
2094
|
+
---
|
|
2095
|
+
|
|
2096
|
+
## PCB_PrimitiveString
|
|
2097
|
+
|
|
2098
|
+
PCB & footprint / text primitive class
|
|
2099
|
+
|
|
2100
|
+
```typescript
|
|
2101
|
+
class PCB_PrimitiveString implements IPCB_PrimitiveAPI
|
|
2102
|
+
```
|
|
2103
|
+
|
|
2104
|
+
- **create**: `function create( layer: TPCB_LayersOfImage, x: number, y: number, text: string, fontFamily: string, fontSize: number, lineWidth: number, alignMode: EPCB_PrimitiveStringAlignMode, rotation: number, reverse: boolean, expansion: number, mirror: boolean, primitiveLock: boolean, ): Promise<IPCB_PrimitiveString | undefined>;`
|
|
2105
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveString | Array<string> | Array<IPCB_PrimitiveString>): Promise<boolean>;`
|
|
2106
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveString | undefined>;`
|
|
2107
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveString>>;`
|
|
2108
|
+
- **getall**: `function getAll( layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<IPCB_PrimitiveString>>;`
|
|
2109
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( layer?: TPCB_LayersOfImage, primitiveLock?: boolean, ): Promise<Array<string>>;`
|
|
2110
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2111
|
+
|
|
2112
|
+
---
|
|
2113
|
+
|
|
2114
|
+
## PCB_PrimitiveVia
|
|
2115
|
+
|
|
2116
|
+
PCB & footprint / via primitive class
|
|
2117
|
+
|
|
2118
|
+
```typescript
|
|
2119
|
+
class PCB_PrimitiveVia implements IPCB_PrimitiveAPI
|
|
2120
|
+
```
|
|
2121
|
+
|
|
2122
|
+
- **create**: `function create( net: string, x: number, y: number, holeDiameter: number, diameter: number, viaType?: EPCB_PrimitiveViaType, designRuleBlindViaName?: string | null, solderMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null, primitiveLock?: boolean, ): Promise<IPCB_PrimitiveVia | undefined>;`
|
|
2123
|
+
- **delete**: `function delete(primitiveIds: string | IPCB_PrimitiveVia | Array<string> | Array<IPCB_PrimitiveVia>): Promise<boolean>;`
|
|
2124
|
+
- **get**: `function get(primitiveIds: string): Promise<IPCB_PrimitiveVia | undefined>;`
|
|
2125
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitiveVia>>;`
|
|
2126
|
+
- **getall**: `function getAll(net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveVia>>;`
|
|
2127
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(net?: string, primitiveLock?: boolean): Promise<Array<string>>;`
|
|
2128
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2129
|
+
|
|
2130
|
+
---
|
|
2131
|
+
|
|
2132
|
+
## PCB_RayTracerEngine
|
|
2133
|
+
|
|
2134
|
+
PCB & footprint / ray tracer engine class
|
|
2135
|
+
|
|
2136
|
+
```typescript
|
|
2137
|
+
class PCB_RayTracerEngine
|
|
2138
|
+
```
|
|
2139
|
+
|
|
2140
|
+
- **dispose**: `function dispose(): Promise<void>;`
|
|
2141
|
+
- **getlightconfigurations**: `function getLightConfigurations(lightName: string): Promise<any>;`
|
|
2142
|
+
- **getrenderconfigurations**: `function getRenderConfigurations(): Promise<any>;`
|
|
2143
|
+
- **init**: `function init(): Promise<void>;`
|
|
2144
|
+
- **setrenderconfigurations**: `function setRenderConfigurations(configurations: any): Promise<void>;`
|
|
2145
|
+
|
|
2146
|
+
---
|
|
2147
|
+
|
|
2148
|
+
## PCB_SelectControl
|
|
2149
|
+
|
|
2150
|
+
PCB & footprint / selection control class
|
|
2151
|
+
|
|
2152
|
+
```typescript
|
|
2153
|
+
class PCB_SelectControl
|
|
2154
|
+
```
|
|
2155
|
+
|
|
2156
|
+
- **clearselected**: `function clearSelected(): Promise<boolean>;`
|
|
2157
|
+
- **docrossprobeselect**: `function doCrossProbeSelect( components?: Array<string>, pins?: Array<string>, nets?: Array<string>, highlight?: boolean, select?: boolean, ): Promise<boolean>;`
|
|
2158
|
+
- **doselectprimitives**: `function doSelectPrimitives(primitiveIds: string | Array<string>): Promise<boolean>;`
|
|
2159
|
+
- **getallselectedprimitives**: `function getAllSelectedPrimitives(): Promise<Array<IPCB_Primitive>>;`
|
|
2160
|
+
- **getallselectedprimitives_primitiveid**: `function getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;`
|
|
2161
|
+
- **getcurrentmouseposition**: `function getCurrentMousePosition(): Promise<{ x: number; y: number } | undefined>;`
|
|
2162
|
+
- **getselectedprimitives**: `function getSelectedPrimitives(): Promise<Array<object>>;`
|
|
2163
|
+
|
|
2164
|
+
---
|
|
2165
|
+
|
|
2166
|
+
## PNL_Document
|
|
2167
|
+
|
|
2168
|
+
Panel / document operation class
|
|
2169
|
+
|
|
2170
|
+
```typescript
|
|
2171
|
+
class PNL_Document
|
|
2172
|
+
```
|
|
2173
|
+
|
|
2174
|
+
- **save**: `function save(): Promise<boolean>;`
|
|
2175
|
+
|
|
2176
|
+
---
|
|
2177
|
+
|
|
2178
|
+
## SCH_Document
|
|
2179
|
+
|
|
2180
|
+
Schematic & symbol / document operation class
|
|
2181
|
+
|
|
2182
|
+
```typescript
|
|
2183
|
+
class SCH_Document
|
|
2184
|
+
```
|
|
2185
|
+
|
|
2186
|
+
- **autolayout**: *(签名过长,请查看详细文档)*
|
|
2187
|
+
- **autorouting**: *(签名过长,请查看详细文档)*
|
|
2188
|
+
- **getcurrentfilterconfiguration**: `function getCurrentFilterConfiguration(): Promise<Record<string, boolean> | undefined>;`
|
|
2189
|
+
- **getprimitiveatpoint**: `function getPrimitiveAtPoint(x: number, y: number): Promise<ISCH_Primitive | undefined>;`
|
|
2190
|
+
- **getprimitivesinregion**: `function getPrimitivesInRegion( left: number, right: number, top: number, bottom: number, ): Promise<Array<ISCH_Primitive>>;`
|
|
2191
|
+
- **importchanges**: `function importChanges(): Promise<boolean>;`
|
|
2192
|
+
- **navigatetocoordinates**: `function navigateToCoordinates(x: number, y: number): Promise<boolean>;`
|
|
2193
|
+
- **navigatetoregion**: `function navigateToRegion( left: number, right: number, top: number, bottom: number, ): Promise<boolean>;`
|
|
2194
|
+
- **save**: `function save(): Promise<boolean>;`
|
|
2195
|
+
|
|
2196
|
+
---
|
|
2197
|
+
|
|
2198
|
+
## SCH_Drc
|
|
2199
|
+
|
|
2200
|
+
Schematic & symbol / design rule check (DRC) class
|
|
2201
|
+
|
|
2202
|
+
```typescript
|
|
2203
|
+
class SCH_Drc
|
|
2204
|
+
```
|
|
2205
|
+
|
|
2206
|
+
- **check**: `function check( strict: boolean, userInterface: boolean, includeVerboseError: false, ): Promise<boolean>;`
|
|
2207
|
+
- **check_1**: `function check( strict: boolean, userInterface: boolean, includeVerboseError: true, ): Promise<Array<ISCH_DrcError>>;`
|
|
2208
|
+
|
|
2209
|
+
---
|
|
2210
|
+
|
|
2211
|
+
## SCH_Event
|
|
2212
|
+
|
|
2213
|
+
Schematic & symbol / event class
|
|
2214
|
+
|
|
2215
|
+
```typescript
|
|
2216
|
+
class SCH_Event
|
|
2217
|
+
```
|
|
2218
|
+
|
|
2219
|
+
- **addmouseeventlistener**: `function addMouseEventListener( id: string, eventType: 'all' | ESCH_MouseEventType, callFn: (eventType: ESCH_MouseEventType) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
2220
|
+
- **addprimitiveeventlistener**: `function addPrimitiveEventListener( id: string, eventType: 'all' | ESCH_PrimitiveEventType, callFn: ( eventType: ESCH_PrimitiveEventType, props: { primitiveIds: string[] }, ) => void | Promise<void>, onlyOnce?: boolean, ): void;`
|
|
2221
|
+
- **addsimulationenginepulleventlistener**: `function addSimulationEnginePullEventListener( id: string, eventType: 'all', callFn: ( eventType: ESCH_DynamicSimulationEnginePullEventType | ESCH_SpiceSimulationEnginePullEventType, props: Record<string, any>, ) => void | Promise<void>, ): void;`
|
|
2222
|
+
- **iseventlisteneralreadyexist**: `function isEventListenerAlreadyExist(id: string): boolean;`
|
|
2223
|
+
- **removeeventlistener**: `function removeEventListener(id: string): boolean;`
|
|
2224
|
+
|
|
2225
|
+
---
|
|
2226
|
+
|
|
2227
|
+
## SCH_ManufactureData
|
|
2228
|
+
|
|
2229
|
+
Schematic & symbol / manufacture data class
|
|
2230
|
+
|
|
2231
|
+
```typescript
|
|
2232
|
+
class SCH_ManufactureData
|
|
2233
|
+
```
|
|
2234
|
+
|
|
2235
|
+
- **deletebomtemplate**: `function deleteBomTemplate(template: string): Promise<boolean>;`
|
|
2236
|
+
- **getassemblyvariantsconfigs**: `function getAssemblyVariantsConfigs(): Promise<Array<{ text: string; value: string }>>;`
|
|
2237
|
+
- **getbomfile**: `function getBomFile( fileName?: string, fileType?: 'xlsx' | 'csv', template?: string, filterOptions?: Array<{ property: string; includeValue: string | false | true }>, statistics?: Array<string>, property?: Array<string>, columns?: Array<IPCB_BomPropertiesTableColumns>, assemblyVariantsConfig?: { text: string; value: string }, ): Promise<File | undefined>;`
|
|
2238
|
+
- **getbomtemplatefile**: `function getBomTemplateFile(template: string): Promise<File | undefined>;`
|
|
2239
|
+
- **getbomtemplates**: `function getBomTemplates(): Promise<Array<string>>;`
|
|
2240
|
+
- **getexportdocumentfile**: *(签名过长,请查看详细文档)*
|
|
2241
|
+
- **getnetlistfile**: `function getNetlistFile( fileName?: string, netlistType?: ESYS_NetlistType, ): Promise<File | undefined>;`
|
|
2242
|
+
- **getpngfile**: `function getPngFile( fileName?: string, resolution?: ISCH_ExportPngResolution, ): Promise<File | undefined>;`
|
|
2243
|
+
- **getsimulationnetlistfile**: `function getSimulationNetlistFile( fileName?: string, netlistType?: ESCH_SimulationNetlistType, ): Promise<File | undefined>;`
|
|
2244
|
+
- **getsvgfile**: `function getSvgFile(fileName?: string): Promise<File | undefined>;`
|
|
2245
|
+
- **placecomponentsorder**: `function placeComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
2246
|
+
- **placesmtcomponentsorder**: `function placeSmtComponentsOrder(interactive?: boolean, ignoreWarning?: boolean): Promise<boolean>;`
|
|
2247
|
+
- **uploadbomtemplatefile**: `function uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;`
|
|
2248
|
+
|
|
2249
|
+
---
|
|
2250
|
+
|
|
2251
|
+
## SCH_Net
|
|
2252
|
+
|
|
2253
|
+
Schematic & symbol / net class
|
|
2254
|
+
|
|
2255
|
+
```typescript
|
|
2256
|
+
class SCH_Net
|
|
2257
|
+
```
|
|
2258
|
+
|
|
2259
|
+
- **getallnets**: `function getAllNets(): Promise<Array<ISCH_NetInfo>>;`
|
|
2260
|
+
- **getallnetsname**: `function getAllNetsName(): Promise<Array<string>>;`
|
|
2261
|
+
- **getcurrentprojectallnets**: `function getCurrentProjectAllNets(): Promise<Array<ISCH_ProjectNetInfo>>;`
|
|
2262
|
+
- **getnet**: `function getNet(net: string): Promise<ISCH_NetInfo | undefined>;`
|
|
2263
|
+
|
|
2264
|
+
---
|
|
2265
|
+
|
|
2266
|
+
## SCH_Netlist
|
|
2267
|
+
|
|
2268
|
+
Schematic & symbol / netlist class
|
|
2269
|
+
|
|
2270
|
+
```typescript
|
|
2271
|
+
class SCH_Netlist
|
|
2272
|
+
```
|
|
2273
|
+
|
|
2274
|
+
- **getnetlist**: `function getNetlist(type?: ESYS_NetlistType): Promise<string>;`
|
|
2275
|
+
- **setnetlist**: `function setNetlist(type: ESYS_NetlistType | undefined, netlist: string): Promise<void>;`
|
|
2276
|
+
|
|
2277
|
+
---
|
|
2278
|
+
|
|
2279
|
+
## SCH_Primitive
|
|
2280
|
+
|
|
2281
|
+
Schematic & symbol / primitive class
|
|
2282
|
+
|
|
2283
|
+
```typescript
|
|
2284
|
+
class SCH_Primitive
|
|
2285
|
+
```
|
|
2286
|
+
|
|
2287
|
+
- **getprimitivebyprimitiveid**: `function getPrimitiveByPrimitiveId(id: string): Promise<ISCH_Primitive | undefined>;`
|
|
2288
|
+
- **getprimitivesbbox**: `function getPrimitivesBBox( primitiveIds: Array<string | ISCH_Primitive>, ): Promise<{ minX: number; minY: number; maxX: number; maxY: number } | undefined>;`
|
|
2289
|
+
- **getprimitivesbyprimitiveid**: `function getPrimitivesByPrimitiveId(ids: Array<string>): Promise<Array<ISCH_Primitive>>;`
|
|
2290
|
+
- **getprimitivetypebyprimitiveid**: `function getPrimitiveTypeByPrimitiveId(id: string): Promise<ESCH_PrimitiveType | undefined>;`
|
|
2291
|
+
|
|
2292
|
+
---
|
|
2293
|
+
|
|
2294
|
+
## SCH_PrimitiveArc
|
|
2295
|
+
|
|
2296
|
+
Schematic & symbol / arc primitive class
|
|
2297
|
+
|
|
2298
|
+
```typescript
|
|
2299
|
+
class SCH_PrimitiveArc implements ISCH_PrimitiveAPI
|
|
2300
|
+
```
|
|
2301
|
+
|
|
2302
|
+
- **create**: `function create( startX: number, startY: number, referenceX: number, referenceY: number, endX: number, endY: number, color?: string | null, fillColor?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, ): Promise<ISCH_PrimitiveArc | undefined>;`
|
|
2303
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveArc | Array<string> | Array<ISCH_PrimitiveArc>): Promise<boolean>;`
|
|
2304
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveArc | undefined>;`
|
|
2305
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveArc>>;`
|
|
2306
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveArc>>;`
|
|
2307
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2308
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2309
|
+
|
|
2310
|
+
---
|
|
2311
|
+
|
|
2312
|
+
## SCH_PrimitiveAttribute
|
|
2313
|
+
|
|
2314
|
+
Schematic & symbol / property primitive class
|
|
2315
|
+
|
|
2316
|
+
```typescript
|
|
2317
|
+
class SCH_PrimitiveAttribute implements ISCH_PrimitiveAPI
|
|
2318
|
+
```
|
|
2319
|
+
|
|
2320
|
+
- **createnetlabel**: `function createNetLabel( x: number, y: number, net: string, ): Promise<ISCH_PrimitiveAttribute | undefined>;`
|
|
2321
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveAttribute | undefined>;`
|
|
2322
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveAttribute>>;`
|
|
2323
|
+
- **getall**: `function getAll(parentPrimitiveId?: string): Promise<Array<ISCH_PrimitiveAttribute>>;`
|
|
2324
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(parentPrimitiveId?: string): Promise<Array<string>>;`
|
|
2325
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2326
|
+
|
|
2327
|
+
---
|
|
2328
|
+
|
|
2329
|
+
## SCH_PrimitiveBus
|
|
2330
|
+
|
|
2331
|
+
Schematic & symbol / bus primitive class
|
|
2332
|
+
|
|
2333
|
+
```typescript
|
|
2334
|
+
class SCH_PrimitiveBus implements ISCH_PrimitiveAPI
|
|
2335
|
+
```
|
|
2336
|
+
|
|
2337
|
+
- **create**: `function create( busName: string, line: Array<number> | Array<Array<number>>, color?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, ): Promise<ISCH_PrimitiveBus | undefined>;`
|
|
2338
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveBus | Array<string> | Array<ISCH_PrimitiveBus>): Promise<boolean>;`
|
|
2339
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveBus | undefined>;`
|
|
2340
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveBus>>;`
|
|
2341
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveBus>>;`
|
|
2342
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2343
|
+
- **modify**: `function modify( primitiveId: string | ISCH_PrimitiveBus, property: { busName?: undefined | string; line?: undefined | number[] | number[][]; color?: undefined | null | string; lineWidth?: undefined | null | number; lineType?: | undefined | null | ESCH_PrimitiveLineType.SOLID | ESCH_PrimitiveLineType.DASHED | ESCH_PrimitiveLineType.DOTTED | ESCH_PrimitiveLineType.DOT_DASHED; }, ): Promise<ISCH_PrimitiveBus | undefined>;`
|
|
2344
|
+
|
|
2345
|
+
---
|
|
2346
|
+
|
|
2347
|
+
## SCH_PrimitiveCircle
|
|
2348
|
+
|
|
2349
|
+
Schematic & symbol / circle primitive class
|
|
2350
|
+
|
|
2351
|
+
```typescript
|
|
2352
|
+
class SCH_PrimitiveCircle implements ISCH_PrimitiveAPI
|
|
2353
|
+
```
|
|
2354
|
+
|
|
2355
|
+
- **create**: `function create( centerX: number, centerY: number, radius: number, color?: string | null, fillColor?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, fillStyle?: ESCH_PrimitiveFillStyle | null, ): Promise<ISCH_PrimitiveCircle | undefined>;`
|
|
2356
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveCircle | Array<string> | Array<ISCH_PrimitiveCircle>): Promise<boolean>;`
|
|
2357
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveCircle | undefined>;`
|
|
2358
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveCircle>>;`
|
|
2359
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveCircle>>;`
|
|
2360
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2361
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2362
|
+
|
|
2363
|
+
---
|
|
2364
|
+
|
|
2365
|
+
## SCH_PrimitiveComponent
|
|
2366
|
+
|
|
2367
|
+
Schematic & symbol / device primitive class
|
|
2368
|
+
|
|
2369
|
+
```typescript
|
|
2370
|
+
class SCH_PrimitiveComponent implements ISCH_PrimitiveAPI
|
|
2371
|
+
```
|
|
2372
|
+
|
|
2373
|
+
- **create**: `function create( component: | { libraryType?: undefined | ELIB_LibraryType.DEVICE; libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem | { libraryType: ELIB_LibraryType.SYMBOL; libraryUuid: string; uuid: string } | ILIB_SymbolItem | ILIB_SymbolSearchItem, x: number, y: number, subPartName?: string, rotation?: number, mirror?: boolean, addIntoBom?: boolean, addIntoPcb?: boolean, ): Promise<ISCH_PrimitiveComponent | undefined>;`
|
|
2374
|
+
- **createcbbsymbol**: `function createCbbSymbol( cbbSymbol: { libraryUuid: string; cbbUuid: string; uuid?: undefined | string }, x: number, y: number, rotation?: number, mirror?: boolean, ): Promise<ISCH_PrimitiveCbbSymbolComponent | undefined>;`
|
|
2375
|
+
- **createnetflag**: `function createNetFlag( identification: 'Power' | 'Ground' | 'AnalogGround' | 'ProtectGround', net: string, x: number, y: number, rotation?: number, mirror?: boolean, ): Promise<ISCH_PrimitiveComponent | undefined>;`
|
|
2376
|
+
- **createnetport**: `function createNetPort( direction: 'IN' | 'OUT' | 'BI', net: string, x: number, y: number, rotation?: number, mirror?: boolean, ): Promise<ISCH_PrimitiveComponent | undefined>;`
|
|
2377
|
+
- **createshortcircuitflag**: `function createShortCircuitFlag( x: number, y: number, rotation?: number, mirror?: boolean, ): Promise<ISCH_PrimitiveComponent | undefined>;`
|
|
2378
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveComponent | Array<string> | Array<ISCH_PrimitiveComponent>): Promise<boolean>;`
|
|
2379
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveComponent | undefined>;`
|
|
2380
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveComponent>>;`
|
|
2381
|
+
- **getall**: `function getAll( componentType?: ESCH_PrimitiveComponentType, allSchematicPages?: boolean, ): Promise<Array<ISCH_PrimitiveComponent>>;`
|
|
2382
|
+
- **getallpinsbyprimitiveid**: `function getAllPinsByPrimitiveId( primitiveId: string, ): Promise<Array<ISCH_PrimitiveComponentPin> | undefined>;`
|
|
2383
|
+
- **getallprimitiveid**: `function getAllPrimitiveId( componentType?: ESCH_PrimitiveComponentType, allSchematicPages?: boolean, ): Promise<Array<string>>;`
|
|
2384
|
+
- **getallpropertynames**: `function getAllPropertyNames(): Promise<Array<string>>;`
|
|
2385
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2386
|
+
- **placecbbschematicpage**: `function placeCbbSchematicPage( cbbSchematicPage: { libraryUuid: string; cbbUuid: string; uuid: string }, x: number, y: number, props?: { reimportWhenNameRepeated?: undefined | false | true }, ): Promise<boolean>;`
|
|
2387
|
+
- **placecomponentwithmouse**: `function placeComponentWithMouse( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, subPartName?: string, ): Promise<boolean>;`
|
|
2388
|
+
- **placesymbolwithmouse**: `function placeSymbolWithMouse( symbol: { libraryUuid: string; uuid: string } | ILIB_SymbolItem | ILIB_SymbolSearchItem, subPartName?: string, properties?: Record<string, boolean | number | string | undefined>, ): Promise<boolean>;`
|
|
2389
|
+
- **setnetflagcomponentuuid_analogground**: `function setNetFlagComponentUuid_AnalogGround( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2390
|
+
- **setnetflagcomponentuuid_ground**: `function setNetFlagComponentUuid_Ground( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2391
|
+
- **setnetflagcomponentuuid_power**: `function setNetFlagComponentUuid_Power( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2392
|
+
- **setnetflagcomponentuuid_protectground**: `function setNetFlagComponentUuid_ProtectGround( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2393
|
+
- **setnetportcomponentuuid_bi**: `function setNetPortComponentUuid_BI( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2394
|
+
- **setnetportcomponentuuid_in**: `function setNetPortComponentUuid_IN( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2395
|
+
- **setnetportcomponentuuid_out**: `function setNetPortComponentUuid_OUT( component: { libraryUuid: string; uuid: string } | ILIB_DeviceItem | ILIB_DeviceSearchItem, ): Promise<boolean>;`
|
|
2396
|
+
|
|
2397
|
+
---
|
|
2398
|
+
|
|
2399
|
+
## SCH_PrimitiveObject
|
|
2400
|
+
|
|
2401
|
+
Schematic & symbol / binary embedded object primitive class
|
|
2402
|
+
|
|
2403
|
+
```typescript
|
|
2404
|
+
class SCH_PrimitiveObject implements ISCH_PrimitiveAPI
|
|
2405
|
+
```
|
|
2406
|
+
|
|
2407
|
+
- **create**: `function create( content: File | string, startX: number, startY: number, width?: number, height?: number, rotation?: number, mirror?: boolean, fileName?: string, ): Promise<ISCH_PrimitiveObject | undefined>;`
|
|
2408
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveObject | Array<string> | Array<ISCH_PrimitiveObject>): Promise<boolean>;`
|
|
2409
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveObject | undefined>;`
|
|
2410
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveObject>>;`
|
|
2411
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveObject>>;`
|
|
2412
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2413
|
+
- **modify**: `function modify( primitiveId: string | ISCH_PrimitiveObject, property: { content?: undefined | string | File; startX?: undefined | number; startY?: undefined | number; width?: undefined | number; height?: undefined | number; rotation?: undefined | number; mirror?: undefined | false | true; fileName?: undefined | string; }, ): Promise<ISCH_PrimitiveObject | undefined>;`
|
|
2414
|
+
|
|
2415
|
+
---
|
|
2416
|
+
|
|
2417
|
+
## SCH_PrimitivePin
|
|
2418
|
+
|
|
2419
|
+
Schematic & symbol / pin primitive class
|
|
2420
|
+
|
|
2421
|
+
```typescript
|
|
2422
|
+
class SCH_PrimitivePin implements ISCH_PrimitiveAPI
|
|
2423
|
+
```
|
|
2424
|
+
|
|
2425
|
+
- **create**: `function create( x: number, y: number, pinNumber: string, pinName?: string, rotation?: number, pinLength?: number, pinColor?: string | null, pinShape?: ESCH_PrimitivePinShape, pinType?: ESCH_PrimitivePinType, ): Promise<ISCH_PrimitivePin | undefined>;`
|
|
2426
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitivePin | Array<string> | Array<ISCH_PrimitivePin>): Promise<boolean>;`
|
|
2427
|
+
- **get**: `function get( primitiveIds: string, ): Promise<ISCH_PrimitivePin | ISCH_PrimitiveComponentPin | undefined>;`
|
|
2428
|
+
- **get_1**: `function get( primitiveIds: Array<string>, ): Promise<Array<ISCH_PrimitivePin | ISCH_PrimitiveComponentPin>>;`
|
|
2429
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitivePin>>;`
|
|
2430
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2431
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2432
|
+
|
|
2433
|
+
---
|
|
2434
|
+
|
|
2435
|
+
## SCH_PrimitivePolygon
|
|
2436
|
+
|
|
2437
|
+
Schematic & symbol / polygon (polyline) primitive class
|
|
2438
|
+
|
|
2439
|
+
```typescript
|
|
2440
|
+
class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI
|
|
2441
|
+
```
|
|
2442
|
+
|
|
2443
|
+
- **create**: `function create( line: Array<number>, color?: string | null, fillColor?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, ): Promise<ISCH_PrimitivePolygon | undefined>;`
|
|
2444
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitivePolygon | Array<string> | Array<ISCH_PrimitivePolygon>): Promise<boolean>;`
|
|
2445
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitivePolygon | undefined>;`
|
|
2446
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitivePolygon>>;`
|
|
2447
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitivePolygon>>;`
|
|
2448
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2449
|
+
- **modify**: `function modify( primitiveId: string | ISCH_PrimitivePolygon, property: { line?: undefined | number[]; color?: undefined | null | string; fillColor?: undefined | null | string; lineWidth?: undefined | null | number; lineType?: | undefined | null | ESCH_PrimitiveLineType.SOLID | ESCH_PrimitiveLineType.DASHED | ESCH_PrimitiveLineType.DOTTED | ESCH_PrimitiveLineType.DOT_DASHED; }, ): Promise<ISCH_PrimitivePolygon | undefined>;`
|
|
2450
|
+
|
|
2451
|
+
---
|
|
2452
|
+
|
|
2453
|
+
## SCH_PrimitiveRectangle
|
|
2454
|
+
|
|
2455
|
+
Schematic & symbol / rectangle primitive class
|
|
2456
|
+
|
|
2457
|
+
```typescript
|
|
2458
|
+
class SCH_PrimitiveRectangle implements ISCH_PrimitiveAPI
|
|
2459
|
+
```
|
|
2460
|
+
|
|
2461
|
+
- **create**: `function create( topLeftX: number, topLeftY: number, width: number, height: number, cornerRadius?: number, rotation?: number, color?: string | null, fillColor?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, fillStyle?: ESCH_PrimitiveFillStyle | null, ): Promise<ISCH_PrimitiveRectangle | undefined>;`
|
|
2462
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveRectangle | Array<string> | Array<ISCH_PrimitiveRectangle>): Promise<boolean>;`
|
|
2463
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveRectangle | undefined>;`
|
|
2464
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveRectangle>>;`
|
|
2465
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveRectangle>>;`
|
|
2466
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2467
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2468
|
+
|
|
2469
|
+
---
|
|
2470
|
+
|
|
2471
|
+
## SCH_PrimitiveText
|
|
2472
|
+
|
|
2473
|
+
Schematic & symbol / text primitive class
|
|
2474
|
+
|
|
2475
|
+
```typescript
|
|
2476
|
+
class SCH_PrimitiveText implements ISCH_PrimitiveAPI
|
|
2477
|
+
```
|
|
2478
|
+
|
|
2479
|
+
- **create**: `function create( x: number, y: number, content: string, rotation?: number, textColor?: string | null, fontName?: string | null, fontSize?: number | null, bold?: boolean, italic?: boolean, underLine?: boolean, alignMode?: ESCH_PrimitiveTextAlignMode, ): Promise<ISCH_PrimitiveText | undefined>;`
|
|
2480
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveText | Array<string> | Array<ISCH_PrimitiveText>): Promise<boolean>;`
|
|
2481
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveText | undefined>;`
|
|
2482
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveText>>;`
|
|
2483
|
+
- **getall**: `function getAll(): Promise<Array<ISCH_PrimitiveText>>;`
|
|
2484
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(): Promise<Array<string>>;`
|
|
2485
|
+
- **modify**: *(签名过长,请查看详细文档)*
|
|
2486
|
+
|
|
2487
|
+
---
|
|
2488
|
+
|
|
2489
|
+
## SCH_PrimitiveWire
|
|
2490
|
+
|
|
2491
|
+
Schematic & symbol / wire primitive class
|
|
2492
|
+
|
|
2493
|
+
```typescript
|
|
2494
|
+
class SCH_PrimitiveWire implements ISCH_PrimitiveAPI
|
|
2495
|
+
```
|
|
2496
|
+
|
|
2497
|
+
- **create**: `function create( line: Array<number> | Array<Array<number>>, net?: string, color?: string | null, lineWidth?: number | null, lineType?: ESCH_PrimitiveLineType | null, ): Promise<ISCH_PrimitiveWire | undefined>;`
|
|
2498
|
+
- **delete**: `function delete(primitiveIds: string | ISCH_PrimitiveWire | Array<string> | Array<ISCH_PrimitiveWire>): Promise<boolean>;`
|
|
2499
|
+
- **get**: `function get(primitiveIds: string): Promise<ISCH_PrimitiveWire | undefined>;`
|
|
2500
|
+
- **get_1**: `function get(primitiveIds: Array<string>): Promise<Array<ISCH_PrimitiveWire>>;`
|
|
2501
|
+
- **getall**: `function getAll(net?: string | Array<string>): Promise<Array<ISCH_PrimitiveWire>>;`
|
|
2502
|
+
- **getallprimitiveid**: `function getAllPrimitiveId(net?: string | Array<string>): Promise<Array<string>>;`
|
|
2503
|
+
- **modify**: `function modify( primitiveId: string | ISCH_PrimitiveWire, property: { line?: undefined | number[] | number[][]; net?: undefined | string; color?: undefined | null | string; lineWidth?: undefined | null | number; lineType?: | undefined | null | ESCH_PrimitiveLineType.SOLID | ESCH_PrimitiveLineType.DASHED | ESCH_PrimitiveLineType.DOTTED | ESCH_PrimitiveLineType.DOT_DASHED; }, ): Promise<ISCH_PrimitiveWire | undefined>;`
|
|
2504
|
+
|
|
2505
|
+
---
|
|
2506
|
+
|
|
2507
|
+
## SCH_SelectControl
|
|
2508
|
+
|
|
2509
|
+
Schematic & symbol / selection control class
|
|
2510
|
+
|
|
2511
|
+
```typescript
|
|
2512
|
+
class SCH_SelectControl
|
|
2513
|
+
```
|
|
2514
|
+
|
|
2515
|
+
- **clearselected**: `function clearSelected(): boolean;`
|
|
2516
|
+
- **docrossprobeselect**: `function doCrossProbeSelect( components?: Array<string>, pins?: Array<string>, nets?: Array<string>, highlight?: boolean, select?: boolean, ): boolean;`
|
|
2517
|
+
- **doselectprimitives**: `function doSelectPrimitives(primitiveIds: string | Array<string>): Promise<boolean>;`
|
|
2518
|
+
- **getallselectedprimitives**: `function getAllSelectedPrimitives(): Promise<Array<ISCH_Primitive>>;`
|
|
2519
|
+
- **getallselectedprimitives_primitiveid**: `function getAllSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;`
|
|
2520
|
+
- **getcurrentmouseposition**: `function getCurrentMousePosition(): Promise<{ x: number; y: number } | undefined>;`
|
|
2521
|
+
- **getselectedprimitives**: `function getSelectedPrimitives(): Promise<Array<object>>;`
|
|
2522
|
+
- **getselectedprimitives_primitiveid**: `function getSelectedPrimitives_PrimitiveId(): Promise<Array<string>>;`
|
|
2523
|
+
|
|
2524
|
+
---
|
|
2525
|
+
|
|
2526
|
+
## SCH_SimulationEngine
|
|
2527
|
+
|
|
2528
|
+
Schematic & symbol / simulation engine class
|
|
2529
|
+
|
|
2530
|
+
```typescript
|
|
2531
|
+
class SCH_SimulationEngine
|
|
2532
|
+
```
|
|
2533
|
+
|
|
2534
|
+
- **pushdata**: `function pushData( eventType: ESCH_DynamicSimulationEnginePushEventType | ESCH_SpiceSimulationEnginePushEventType, props: Record<string, any>, ): void;`
|
|
2535
|
+
|
|
2536
|
+
---
|
|
2537
|
+
|
|
2538
|
+
## SCH_Utils
|
|
2539
|
+
|
|
2540
|
+
Schematic & symbol / utility class
|
|
2541
|
+
|
|
2542
|
+
```typescript
|
|
2543
|
+
class SCH_Utils
|
|
2544
|
+
```
|
|
2545
|
+
|
|
2546
|
+
- **splitlines**: `function splitLines( lines: Array<number | Array<number>>, ): Array<Array<number | Array<number>>> | undefined;`
|
|
2547
|
+
|
|
2548
|
+
---
|
|
2549
|
+
|
|
2550
|
+
## SYS_ClientUrl
|
|
2551
|
+
|
|
2552
|
+
System / external request class
|
|
2553
|
+
|
|
2554
|
+
```typescript
|
|
2555
|
+
class SYS_ClientUrl
|
|
2556
|
+
```
|
|
2557
|
+
|
|
2558
|
+
- **request**: `function request( url: string, method?: 'GET' | 'POST' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH', data?: string | Blob | FormData | URLSearchParams, options?: { headers?: undefined | { [key: string]: any }; integrity?: undefined | string }, succeedCallFn?: (data: Response) => void | Promise<void>, ): Promise<Response>;`
|
|
2559
|
+
|
|
2560
|
+
---
|
|
2561
|
+
|
|
2562
|
+
## SYS_Dialog
|
|
2563
|
+
|
|
2564
|
+
System / dialog class
|
|
2565
|
+
|
|
2566
|
+
```typescript
|
|
2567
|
+
class SYS_Dialog
|
|
2568
|
+
```
|
|
2569
|
+
|
|
2570
|
+
- **createdesignportal**: `function createDesignPortal(): IDesignPortal;`
|
|
2571
|
+
- **showconfirmationmessage**: `function showConfirmationMessage( content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void, ): void;`
|
|
2572
|
+
- **showinformationmessage**: `function showInformationMessage(content: string, title?: string, buttonTitle?: string): void;`
|
|
2573
|
+
- **showinputdialog**: *(签名过长,请查看详细文档)*
|
|
2574
|
+
- **showselectdialog**: `function showSelectDialog( options: Array<string> | Array<{ value: string; displayContent: string }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: string, multiple?: false, callbackFn?: (value: string) => void | Promise<void>, ): void;`
|
|
2575
|
+
- **showselectdialog_1**: `function showSelectDialog( options: Array<string> | Array<{ value: string; displayContent: string }>, beforeContent?: string, afterContent?: string, title?: string, defaultOption?: Array<string>, multiple?: true, callbackFn?: (value: Array<string>) => void | Promise<void>, ): void;`
|
|
2576
|
+
|
|
2577
|
+
---
|
|
2578
|
+
|
|
2579
|
+
## SYS_Environment
|
|
2580
|
+
|
|
2581
|
+
System / runtime environment class
|
|
2582
|
+
|
|
2583
|
+
```typescript
|
|
2584
|
+
class SYS_Environment
|
|
2585
|
+
```
|
|
2586
|
+
|
|
2587
|
+
- **geteditorcomplieddate**: `function getEditorCompliedDate(): string;`
|
|
2588
|
+
- **geteditorcurrentversion**: `function getEditorCurrentVersion(onlySemantic?: boolean): string;`
|
|
2589
|
+
- **getuserinfo**: `function getUserInfo(): { username?: undefined | string; nickname?: undefined | string; avatar?: undefined | string; uuid?: undefined | string; customerCode?: undefined | string; };`
|
|
2590
|
+
- **isclient**: `function isClient(): boolean;`
|
|
2591
|
+
- **iseasyedaproedition**: `function isEasyEDAProEdition(): boolean;`
|
|
2592
|
+
- **ishalfofflinemode**: `function isHalfOfflineMode(): boolean;`
|
|
2593
|
+
- **isjlcedaproedition**: `function isJLCEDAProEdition(): boolean;`
|
|
2594
|
+
- **isofflinemode**: `function isOfflineMode(): boolean;`
|
|
2595
|
+
- **isonlinemode**: `function isOnlineMode(): boolean;`
|
|
2596
|
+
- **isproprivateedition**: `function isProPrivateEdition(): boolean;`
|
|
2597
|
+
- **isweb**: `function isWeb(): boolean;`
|
|
2598
|
+
|
|
2599
|
+
---
|
|
2600
|
+
|
|
2601
|
+
## SYS_FileManager
|
|
2602
|
+
|
|
2603
|
+
System / file manager class
|
|
2604
|
+
|
|
2605
|
+
```typescript
|
|
2606
|
+
class SYS_FileManager
|
|
2607
|
+
```
|
|
2608
|
+
|
|
2609
|
+
- **extractlibinfo**: `function extractLibInfo(data: File | Array<File>): Promise<any>;`
|
|
2610
|
+
- **extractprojectinfo**: `function extractProjectInfo(data: File): Promise<any>;`
|
|
2611
|
+
- **getcbbfilebycbbuuid**: `function getCbbFileByCbbUuid( cbbUuid: string, libraryUuid?: string, props?: { fileName?: undefined | string; password?: undefined | string; fileType?: undefined | 'epro' | 'epro2'; templateSchematicUuid?: undefined | string; templatePcbUuid?: undefined | string; }, ): Promise<File | undefined>;`
|
|
2612
|
+
- **getdevicefilebydeviceuuid**: `function getDeviceFileByDeviceUuid( deviceUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2', ): Promise<File | undefined>;`
|
|
2613
|
+
- **getdocumentfile**: `function getDocumentFile( fileName?: string, password?: string, fileType?: 'epro' | 'epro2', ): Promise<File | undefined>;`
|
|
2614
|
+
- **getdocumentfootprintsources**: `function getDocumentFootprintSources(): Promise< Array<{ footprintUuid: string; documentSource: string }> >;`
|
|
2615
|
+
- **getdocumentsource**: `function getDocumentSource(): Promise<string | undefined>;`
|
|
2616
|
+
- **getfootprintfilebyfootprintuuid**: `function getFootprintFileByFootprintUuid( footprintUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2', ): Promise<File | undefined>;`
|
|
2617
|
+
- **getpanellibraryfilebypanellibraryuuid**: `function getPanelLibraryFileByPanelLibraryUuid( panelLibraryUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2', ): Promise<File | undefined>;`
|
|
2618
|
+
- **getprojectfile**: `function getProjectFile( fileName?: string, password?: string, fileType?: 'epro' | 'epro2', ): Promise<File | undefined>;`
|
|
2619
|
+
- **getprojectfilebyprojectuuid**: `function getProjectFileByProjectUuid( projectUuid: string, fileName?: string, password?: string, fileType?: 'epro' | 'epro2', ): Promise<File | undefined>;`
|
|
2620
|
+
- **getschematicfile**: `function getSchematicFile( fileName?: string, password?: string, fileType?: 'epro' | 'epro2', ): Promise<File | undefined>;`
|
|
2621
|
+
- **getsymbolfilebysymboluuid**: `function getSymbolFileBySymbolUuid( symbolUuid: string | Array<string>, libraryUuid?: string, fileType?: 'elibz' | 'elibz2', ): Promise<File | undefined>;`
|
|
2622
|
+
- **importprojectbyprojectfile**: *(签名过长,请查看详细文档)*
|
|
2623
|
+
- **importprojectbyprojectfile_1**: *(签名过长,请查看详细文档)*
|
|
2624
|
+
- **setdocumentsource**: `function setDocumentSource(source: string): Promise<boolean>;`
|
|
2625
|
+
|
|
2626
|
+
---
|
|
2627
|
+
|
|
2628
|
+
## SYS_FileSystem
|
|
2629
|
+
|
|
2630
|
+
System / file system interaction class
|
|
2631
|
+
|
|
2632
|
+
```typescript
|
|
2633
|
+
class SYS_FileSystem
|
|
2634
|
+
```
|
|
2635
|
+
|
|
2636
|
+
- **createdirectoryinfilesystem**: `function createDirectoryInFileSystem(folderPath: string): Promise<boolean>;`
|
|
2637
|
+
- **createobjecturl**: `function createObjectURL(blob: Blob | File): string;`
|
|
2638
|
+
- **deletefileinfilesystem**: `function deleteFileInFileSystem(uri: string, force?: boolean): Promise<boolean>;`
|
|
2639
|
+
- **existspathinfilesystem**: `function existsPathInFileSystem(uri: string): Promise<boolean>;`
|
|
2640
|
+
- **getdocumentspath**: `function getDocumentsPath(): Promise<string>;`
|
|
2641
|
+
- **getedapath**: `function getEdaPath(): Promise<string>;`
|
|
2642
|
+
- **getextensionfile**: `function getExtensionFile(uri: string): Promise<File | undefined>;`
|
|
2643
|
+
- **getlibrariespaths**: `function getLibrariesPaths(): Promise<Array<string>>;`
|
|
2644
|
+
- **getprojectspaths**: `function getProjectsPaths(): Promise<Array<string>>;`
|
|
2645
|
+
- **listfilesoffilesystem**: `function listFilesOfFileSystem( folderPath: string, recursive?: boolean, ): Promise<Array<ISYS_FileSystemFileList>>;`
|
|
2646
|
+
- **openreadfiledialog**: `function openReadFileDialog( filenameExtensions?: string | Array<string>, multiFiles?: true, ): Promise<Array<File> | undefined>;`
|
|
2647
|
+
- **openreadfiledialog_1**: `function openReadFileDialog( filenameExtensions?: string | Array<string>, multiFiles?: false, ): Promise<File | undefined>;`
|
|
2648
|
+
- **openreadfolderdialog**: `function openReadFolderDialog(): Promise<Array<{ relativePath: string; file: File }>>;`
|
|
2649
|
+
- **readfilefromfilesystem**: `function readFileFromFileSystem(uri: string): Promise<File | undefined>;`
|
|
2650
|
+
- **revokeobjecturl**: `function revokeObjectURL(url: string): void;`
|
|
2651
|
+
- **savefile**: `function saveFile(fileData: File | Blob, fileName?: string): Promise<void>;`
|
|
2652
|
+
- **savefiletofilesystem**: `function saveFileToFileSystem( uri: string, fileData: File | Blob, fileName?: string, force?: boolean, ): Promise<boolean>;`
|
|
2653
|
+
|
|
2654
|
+
---
|
|
2655
|
+
|
|
2656
|
+
## SYS_FontManager
|
|
2657
|
+
|
|
2658
|
+
System / font manager class
|
|
2659
|
+
|
|
2660
|
+
```typescript
|
|
2661
|
+
class SYS_FontManager
|
|
2662
|
+
```
|
|
2663
|
+
|
|
2664
|
+
- **addfont**: `function addFont(fontName: string): Promise<boolean>;`
|
|
2665
|
+
- **deletefont**: `function deleteFont(fontName: string): Promise<boolean>;`
|
|
2666
|
+
- **getfontslist**: `function getFontsList(): Promise<Array<string>>;`
|
|
2667
|
+
|
|
2668
|
+
---
|
|
2669
|
+
|
|
2670
|
+
## SYS_FormatConversion
|
|
2671
|
+
|
|
2672
|
+
System / format conversion (Chameleon) class
|
|
2673
|
+
|
|
2674
|
+
```typescript
|
|
2675
|
+
class SYS_FormatConversion
|
|
2676
|
+
```
|
|
2677
|
+
|
|
2678
|
+
- **convertaltiumdesignerlibrariestoeasyedamultifiles**: `function convertAltiumDesignerLibrariesToEasyEDAMultiFiles( file: File | Array<File>, ): Promise<Array<File>>;`
|
|
2679
|
+
- **convertaltiumdesignerlibrariestoeasyedasinglefile**: `function convertAltiumDesignerLibrariesToEasyEDASingleFile( file: File | Array<File>, ): Promise<File | undefined>;`
|
|
2680
|
+
- **convertdisalibrariestoeasyedamultifiles**: `function convertDisaLibrariesToEasyEDAMultiFiles(file: File | Array<File>): Promise<Array<File>>;`
|
|
2681
|
+
- **convertdisalibrariestoeasyedasinglefile**: `function convertDisaLibrariesToEasyEDASingleFile( file: File | Array<File>, ): Promise<File | undefined>;`
|
|
2682
|
+
|
|
2683
|
+
---
|
|
2684
|
+
|
|
2685
|
+
## SYS_HeaderMenu
|
|
2686
|
+
|
|
2687
|
+
System / header menu class
|
|
2688
|
+
|
|
2689
|
+
```typescript
|
|
2690
|
+
class SYS_HeaderMenu
|
|
2691
|
+
```
|
|
2692
|
+
|
|
2693
|
+
- **insertheadermenus**: `function insertHeaderMenus(headerMenus: ISYS_HeaderMenus): Promise<void>;`
|
|
2694
|
+
- **insertsystemheadermenuitem**: `function insertSystemHeaderMenuItem( env: ESYS_HeaderMenuEnvironment, id: Array<string>, props: { title: string; registerFn?: undefined | string; menuItems?: undefined | (null | ISYS_HeaderMenuSub2MenuItem | ISYS_HeaderMenuSub1MenuItem)[]; insertDividerBefore?: undefined | false | true; insertDividerAfter?: undefined | false | true; insertBefore?: undefined | string; crossDividerWhenInsert?: undefined | false | true; }, ): Promise<string | undefined>;`
|
|
2695
|
+
- **removeheadermenus**: `function removeHeaderMenus(): void;`
|
|
2696
|
+
- **removesystemheadermenuitem**: `function removeSystemHeaderMenuItem( id: Array<string>, props?: { removeTheBeforeDivider?: undefined | false | true; removeTheAfterDivider?: undefined | false | true; }, ): Promise<boolean>;`
|
|
2697
|
+
- **replaceheadermenus**: `function replaceHeaderMenus(headerMenus: ISYS_HeaderMenus): Promise<void>;`
|
|
2698
|
+
|
|
2699
|
+
---
|
|
2700
|
+
|
|
2701
|
+
## SYS_I18n
|
|
2702
|
+
|
|
2703
|
+
System / multilingual class
|
|
2704
|
+
|
|
2705
|
+
```typescript
|
|
2706
|
+
class SYS_I18n
|
|
2707
|
+
```
|
|
2708
|
+
|
|
2709
|
+
- **addlanguagechangedeventlistener**: `function addLanguageChangedEventListener( id: string, callFn: (newLanguage: string, lastLanguage: string) => void | Promise<void>, onlyOnce: boolean, ): void;`
|
|
2710
|
+
- **getallsupportedlanguages**: `function getAllSupportedLanguages(): Array<string>;`
|
|
2711
|
+
- **getcurrentlanguage**: `function getCurrentLanguage(): Promise<string>;`
|
|
2712
|
+
- **importmultilingual**: `function importMultilingual(language: string, source: ISYS_LanguageKeyValuePairs): boolean;`
|
|
2713
|
+
- **importmultilinguallanguage**: `function importMultilingualLanguage( namespace: string, language: string, source: ISYS_LanguageKeyValuePairs, ): boolean;`
|
|
2714
|
+
- **importmultilingualnamespace**: `function importMultilingualNamespace( namespace: string, source: ISYS_MultilingualLanguagesData, ): boolean;`
|
|
2715
|
+
- **iseventlisteneralreadyexist**: `function isEventListenerAlreadyExist(id: string): boolean;`
|
|
2716
|
+
- **islanguagesupported**: `function isLanguageSupported(language: string): boolean;`
|
|
2717
|
+
- **removeeventlistener**: `function removeEventListener(id: string): boolean;`
|
|
2718
|
+
- **text**: `function text(tag: string, namespace?: string, language?: string, ...args: Array<any>): string;`
|
|
2719
|
+
|
|
2720
|
+
---
|
|
2721
|
+
|
|
2722
|
+
## SYS_IFrame
|
|
2723
|
+
|
|
2724
|
+
System / iframe window class
|
|
2725
|
+
|
|
2726
|
+
```typescript
|
|
2727
|
+
class SYS_IFrame
|
|
2728
|
+
```
|
|
2729
|
+
|
|
2730
|
+
- **closeiframe**: `function closeIFrame(id?: string): Promise<boolean>;`
|
|
2731
|
+
- **hideiframe**: `function hideIFrame(id?: string): Promise<boolean>;`
|
|
2732
|
+
- **isiframealreadyexist**: `function isIFrameAlreadyExist(id: string): Promise<boolean>;`
|
|
2733
|
+
- **openiframe**: *(签名过长,请查看详细文档)*
|
|
2734
|
+
- **showiframe**: `function showIFrame(id?: string): Promise<boolean>;`
|
|
2735
|
+
|
|
2736
|
+
---
|
|
2737
|
+
|
|
2738
|
+
## SYS_LoadingAndProgressBar
|
|
2739
|
+
|
|
2740
|
+
System / loading and progress bar class
|
|
2741
|
+
|
|
2742
|
+
```typescript
|
|
2743
|
+
class SYS_LoadingAndProgressBar
|
|
2744
|
+
```
|
|
2745
|
+
|
|
2746
|
+
- **destroyloading**: `function destroyLoading(): void;`
|
|
2747
|
+
- **destroyprogressbar**: `function destroyProgressBar(): void;`
|
|
2748
|
+
- **showloading**: `function showLoading(): void;`
|
|
2749
|
+
- **showprogressbar**: `function showProgressBar(progress?: number, title?: string): void;`
|
|
2750
|
+
|
|
2751
|
+
---
|
|
2752
|
+
|
|
2753
|
+
## SYS_Log
|
|
2754
|
+
|
|
2755
|
+
System / log class
|
|
2756
|
+
|
|
2757
|
+
```typescript
|
|
2758
|
+
class SYS_Log
|
|
2759
|
+
```
|
|
2760
|
+
|
|
2761
|
+
- **add**: `function add(message: string, type?: ESYS_LogType): void;`
|
|
2762
|
+
- **clear**: `function clear(): void;`
|
|
2763
|
+
- **export**: `function export(types?: ESYS_LogType | Array<ESYS_LogType>): void;`
|
|
2764
|
+
- **find**: `function find( message: | string | Array< | string | { text: string; attr?: | undefined | { id?: undefined | string; path?: undefined | string; sheet?: undefined | string; pcbid?: undefined | string; type?: undefined | string; }; } >, types?: ESYS_LogType | Array<ESYS_LogType>, ): Promise<Array<ISYS_LogLine>>;`
|
|
2765
|
+
- **sort**: `function sort(types?: ESYS_LogType | Array<ESYS_LogType>): Promise<Array<ISYS_LogLine>>;`
|
|
2766
|
+
|
|
2767
|
+
---
|
|
2768
|
+
|
|
2769
|
+
## SYS_Math
|
|
2770
|
+
|
|
2771
|
+
System / math class
|
|
2772
|
+
|
|
2773
|
+
```typescript
|
|
2774
|
+
class SYS_Math
|
|
2775
|
+
```
|
|
2776
|
+
|
|
2777
|
+
- **bboxintersects**: `function bboxIntersects(bbox1: ISYS_MathBBox, bbox2: ISYS_MathBBox): boolean;`
|
|
2778
|
+
- **calculatearea**: `function calculateArea(polygon: TSYS_MathPolygonInput): number;`
|
|
2779
|
+
- **calculateperimeter**: `function calculatePerimeter(polygon: TSYS_MathPolygonInput): number;`
|
|
2780
|
+
- **contains**: `function contains(polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput): boolean;`
|
|
2781
|
+
- **containspoint**: `function containsPoint(polygon: TSYS_MathPolygonInput, point: ISYS_MathPoint): boolean;`
|
|
2782
|
+
- **distancetopoint**: `function distanceToPoint(polygon: TSYS_MathPolygonInput, point: ISYS_MathPoint): number;`
|
|
2783
|
+
- **getbbox**: `function getBBox(polygon: TSYS_MathPolygonInput): ISYS_MathBBox;`
|
|
2784
|
+
- **getcentroid**: `function getCentroid(polygon: TSYS_MathPolygonInput): ISYS_MathPoint;`
|
|
2785
|
+
- **intersection**: `function intersection( polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput, ): TSYS_MathPolygonGroup;`
|
|
2786
|
+
- **intersects**: `function intersects(polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput): boolean;`
|
|
2787
|
+
- **rotate**: `function rotate( polygon: TSYS_MathPolygonInput, angle: number, centerX?: number, centerY?: number, ): Array<ISYS_MathPoint>;`
|
|
2788
|
+
- **scale**: `function scale( polygon: TSYS_MathPolygonInput, scaleX: number, scaleY?: number, centerX?: number, centerY?: number, ): Array<ISYS_MathPoint>;`
|
|
2789
|
+
- **subtract**: `function subtract( polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput, ): TSYS_MathPolygonGroup;`
|
|
2790
|
+
- **translate**: `function translate(polygon: TSYS_MathPolygonInput, dx: number, dy: number): Array<ISYS_MathPoint>;`
|
|
2791
|
+
- **union**: `function union( polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput, ): TSYS_MathPolygonGroup;`
|
|
2792
|
+
- **xor**: `function xor( polygon1: TSYS_MathPolygonInput, polygon2: TSYS_MathPolygonInput, ): TSYS_MathPolygonGroup;`
|
|
2793
|
+
|
|
2794
|
+
---
|
|
2795
|
+
|
|
2796
|
+
## SYS_Message
|
|
2797
|
+
|
|
2798
|
+
System / message notification class
|
|
2799
|
+
|
|
2800
|
+
```typescript
|
|
2801
|
+
class SYS_Message
|
|
2802
|
+
```
|
|
2803
|
+
|
|
2804
|
+
- **removefollowmousetip**: `function removeFollowMouseTip(tip?: string): Promise<void>;`
|
|
2805
|
+
- **showfollowmousetip**: `function showFollowMouseTip(tip: string, msTimeout?: number): Promise<void>;`
|
|
2806
|
+
- **showtoastmessage**: `function showToastMessage( message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string, ): void;`
|
|
2807
|
+
|
|
2808
|
+
---
|
|
2809
|
+
|
|
2810
|
+
## SYS_MessageBox
|
|
2811
|
+
|
|
2812
|
+
System / message box class
|
|
2813
|
+
|
|
2814
|
+
```typescript
|
|
2815
|
+
class SYS_MessageBox
|
|
2816
|
+
```
|
|
2817
|
+
|
|
2818
|
+
- **showconfirmationmessage**: `function showConfirmationMessage( content: string, title?: string, mainButtonTitle?: string, buttonTitle?: string, callbackFn?: (mainButtonClicked: boolean) => void, ): void;`
|
|
2819
|
+
- **showinformationmessage**: `function showInformationMessage(content: string, title?: string, buttonTitle?: string): void;`
|
|
2820
|
+
|
|
2821
|
+
---
|
|
2822
|
+
|
|
2823
|
+
## SYS_MessageBus
|
|
2824
|
+
|
|
2825
|
+
System / message bus class
|
|
2826
|
+
|
|
2827
|
+
```typescript
|
|
2828
|
+
class SYS_MessageBus
|
|
2829
|
+
```
|
|
2830
|
+
|
|
2831
|
+
- **createprivatemessagebus**: `function createPrivateMessageBus(): void;`
|
|
2832
|
+
- **publish**: `function publish(topic: string, message: any): void;`
|
|
2833
|
+
- **publishpublic**: `function publishPublic(topic: string, message: any): void;`
|
|
2834
|
+
- **pull**: `function pull(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;`
|
|
2835
|
+
- **pullasync**: `function pullAsync(topic: string): Promise<any>;`
|
|
2836
|
+
- **pullasyncpublic**: `function pullAsyncPublic(topic: string): Promise<any>;`
|
|
2837
|
+
- **pullpublic**: `function pullPublic(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;`
|
|
2838
|
+
- **push**: `function push(topic: string, message: any): void;`
|
|
2839
|
+
- **pushpublic**: `function pushPublic(topic: string, message: any): void;`
|
|
2840
|
+
- **removeprivatemessagebus**: `function removePrivateMessageBus(): void;`
|
|
2841
|
+
- **rpccall**: `function rpcCall(topic: string, message?: any, timeout?: number): Promise<any>;`
|
|
2842
|
+
- **rpccallpublic**: `function rpcCallPublic(topic: string, message?: any, timeout?: number): Promise<any>;`
|
|
2843
|
+
- **rpcservice**: `function rpcService(topic: string, callbackFn: (...args: Array<any>) => any | Promise<any>): void;`
|
|
2844
|
+
- **rpcservicepublic**: `function rpcServicePublic( topic: string, callbackFn: (...args: Array<any>) => any | Promise<any>, ): void;`
|
|
2845
|
+
- **subscribe**: `function subscribe(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;`
|
|
2846
|
+
- **subscribeonce**: `function subscribeOnce(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;`
|
|
2847
|
+
- **subscribeoncepublic**: `function subscribeOncePublic( topic: string, callbackFn: (message: any) => void, ): ISYS_MessageBusTask;`
|
|
2848
|
+
- **subscribepublic**: `function subscribePublic(topic: string, callbackFn: (message: any) => void): ISYS_MessageBusTask;`
|
|
2849
|
+
|
|
2850
|
+
---
|
|
2851
|
+
|
|
2852
|
+
## SYS_PanelControl
|
|
2853
|
+
|
|
2854
|
+
System / panel control class
|
|
2855
|
+
|
|
2856
|
+
```typescript
|
|
2857
|
+
class SYS_PanelControl
|
|
2858
|
+
```
|
|
2859
|
+
|
|
2860
|
+
- **closebottompanel**: `function closeBottomPanel(): void;`
|
|
2861
|
+
- **closeleftpanel**: `function closeLeftPanel(): void;`
|
|
2862
|
+
- **closerightpanel**: `function closeRightPanel(): void;`
|
|
2863
|
+
- **isbottompanellocked**: `function isBottomPanelLocked(): Promise<boolean>;`
|
|
2864
|
+
- **isleftpanellocked**: `function isLeftPanelLocked(): Promise<boolean>;`
|
|
2865
|
+
- **isrightpanellocked**: `function isRightPanelLocked(): Promise<boolean>;`
|
|
2866
|
+
- **openbottompanel**: `function openBottomPanel(tab?: ESYS_BottomPanelTab): void;`
|
|
2867
|
+
- **openleftpanel**: `function openLeftPanel(tab?: ESYS_LeftPanelTab): void;`
|
|
2868
|
+
- **openrightpanel**: `function openRightPanel(tab?: ESYS_RightPanelTab): void;`
|
|
2869
|
+
- **togglebottompanellockstate**: `function toggleBottomPanelLockState(state?: boolean): void;`
|
|
2870
|
+
- **toggleleftpanellockstate**: `function toggleLeftPanelLockState(state?: boolean): void;`
|
|
2871
|
+
- **togglerightpanellockstate**: `function toggleRightPanelLockState(state?: boolean): void;`
|
|
2872
|
+
|
|
2873
|
+
---
|
|
2874
|
+
|
|
2875
|
+
## SYS_RightClickMenu
|
|
2876
|
+
|
|
2877
|
+
System / right-click menu class
|
|
2878
|
+
|
|
2879
|
+
```typescript
|
|
2880
|
+
class SYS_RightClickMenu
|
|
2881
|
+
```
|
|
2882
|
+
|
|
2883
|
+
- **changemenu**: `function changeMenu( menuId: string, menuItems: Array<ISYS_RightClickMenuItem | null>, ): Promise<void>;`
|
|
2884
|
+
|
|
2885
|
+
---
|
|
2886
|
+
|
|
2887
|
+
## SYS_Setting
|
|
2888
|
+
|
|
2889
|
+
System / settings class
|
|
2890
|
+
|
|
2891
|
+
```typescript
|
|
2892
|
+
class SYS_Setting
|
|
2893
|
+
```
|
|
2894
|
+
|
|
2895
|
+
- **restoredefault**: `function restoreDefault(): Promise<boolean>;`
|
|
2896
|
+
|
|
2897
|
+
---
|
|
2898
|
+
|
|
2899
|
+
## SYS_ShortcutKey
|
|
2900
|
+
|
|
2901
|
+
System / shortcut key class
|
|
2902
|
+
|
|
2903
|
+
```typescript
|
|
2904
|
+
class SYS_ShortcutKey
|
|
2905
|
+
```
|
|
2906
|
+
|
|
2907
|
+
- **get**: `function get(id: string): ISYS_ShortcutKeyDataWithUserDefinedShortcutKey | undefined;`
|
|
2908
|
+
- **getall**: `function getAll(): Record<string, ISYS_ShortcutKeyDataWithUserDefinedShortcutKey>;`
|
|
2909
|
+
- **getshortcutkeys**: `function getShortcutKeys( includeSystem?: boolean, ): Promise< Array<{ shortcutKey: TSYS_ShortcutKeys; title: string; documentType: ESYS_ShortcutKeyEffectiveEditorRange[]; scene: ESYS_ShortcutKeyEffectiveEditorScene[]; }> >;`
|
|
2910
|
+
- **register**: `function register(id: string, props: ISYS_ShortcutKeyDataWithCallFn): boolean;`
|
|
2911
|
+
- **registershortcutkey**: `function registerShortcutKey( shortcutKey: TSYS_ShortcutKeys, title: string, callbackFn: (shortcutKey: TSYS_ShortcutKeys) => void | Promise<void>, documentType?: Array<ESYS_ShortcutKeyEffectiveEditorRange>, scene?: Array<ESYS_ShortcutKeyEffectiveEditorScene>, ): Promise<boolean>;`
|
|
2912
|
+
- **unregister**: `function unregister(id: string): boolean;`
|
|
2913
|
+
- **unregistershortcutkey**: `function unregisterShortcutKey(shortcutKey: TSYS_ShortcutKeys): Promise<boolean>;`
|
|
2914
|
+
|
|
2915
|
+
---
|
|
2916
|
+
|
|
2917
|
+
## SYS_Storage
|
|
2918
|
+
|
|
2919
|
+
System / storage class
|
|
2920
|
+
|
|
2921
|
+
```typescript
|
|
2922
|
+
class SYS_Storage
|
|
2923
|
+
```
|
|
2924
|
+
|
|
2925
|
+
- **clearextensionalluserconfigs**: `function clearExtensionAllUserConfigs(): Promise<boolean>;`
|
|
2926
|
+
- **deleteextensionuserconfig**: `function deleteExtensionUserConfig(key: string): Promise<boolean>;`
|
|
2927
|
+
- **getextensionalluserconfigs**: `function getExtensionAllUserConfigs(): Record<string, any>;`
|
|
2928
|
+
- **getextensionuserconfig**: `function getExtensionUserConfig(key: string): any | undefined;`
|
|
2929
|
+
- **setextensionalluserconfigs**: `function setExtensionAllUserConfigs(configs: Record<string, any>): Promise<boolean>;`
|
|
2930
|
+
- **setextensionuserconfig**: `function setExtensionUserConfig(key: string, value: any): Promise<boolean>;`
|
|
2931
|
+
|
|
2932
|
+
---
|
|
2933
|
+
|
|
2934
|
+
## SYS_Timer
|
|
2935
|
+
|
|
2936
|
+
System / timer class
|
|
2937
|
+
|
|
2938
|
+
```typescript
|
|
2939
|
+
class SYS_Timer
|
|
2940
|
+
```
|
|
2941
|
+
|
|
2942
|
+
- **clearintervaltimer**: `function clearIntervalTimer(id: string): boolean;`
|
|
2943
|
+
- **cleartimeouttimer**: `function clearTimeoutTimer(id: string): boolean;`
|
|
2944
|
+
- **setintervaltimer**: `function setIntervalTimer( id: string, timeout: number, callFn: (...args: any) => void, ...args: any ): boolean;`
|
|
2945
|
+
- **settimeouttimer**: `function setTimeoutTimer( id: string, timeout: number, callFn: (...args: any) => void, ...args: any ): boolean;`
|
|
2946
|
+
|
|
2947
|
+
---
|
|
2948
|
+
|
|
2949
|
+
## SYS_ToastMessage
|
|
2950
|
+
|
|
2951
|
+
System / toast message class
|
|
2952
|
+
|
|
2953
|
+
```typescript
|
|
2954
|
+
class SYS_ToastMessage
|
|
2955
|
+
```
|
|
2956
|
+
|
|
2957
|
+
- **showmessage**: `function showMessage( message: string, messageType?: ESYS_ToastMessageType, timer?: number, bottomPanel?: ESYS_BottomPanelTab, buttonTitle?: string, buttonCallbackFn?: string, ): void;`
|
|
2958
|
+
|
|
2959
|
+
---
|
|
2960
|
+
|
|
2961
|
+
## SYS_Tool
|
|
2962
|
+
|
|
2963
|
+
System / tool class
|
|
2964
|
+
|
|
2965
|
+
```typescript
|
|
2966
|
+
class SYS_Tool
|
|
2967
|
+
```
|
|
2968
|
+
|
|
2969
|
+
- **netlistcomparison**: `function netlistComparison( netlist1: string | { projectUuid: string; documentUuid: string } | File, netlist2: string | { projectUuid: string; documentUuid: string } | File, ): Promise< Array<{ type: 'Net' | 'Component'; object: string; netlist1Name: string[]; netlist2Name: string[]; }> >;`
|
|
2970
|
+
- **pcbcomparison**: `function pcbComparison( pcb1: string | { projectUuid: string; pcbUuid: string } | File, pcb2: string | { projectUuid: string; pcbUuid: string } | File, options?: { valUnit?: | undefined | ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.INCH | ESYS_Unit.MIL; deviation?: undefined | number; comparisonSize?: undefined | number; }, ): Promise<ISYS_PcbComparisonResponse>;`
|
|
2971
|
+
|
|
2972
|
+
---
|
|
2973
|
+
|
|
2974
|
+
## SYS_Unit
|
|
2975
|
+
|
|
2976
|
+
System / unit class
|
|
2977
|
+
|
|
2978
|
+
```typescript
|
|
2979
|
+
class SYS_Unit
|
|
2980
|
+
```
|
|
2981
|
+
|
|
2982
|
+
- **getfrontenddataunit**: `function getFrontendDataUnit(): Promise<ESYS_Unit | undefined>;`
|
|
2983
|
+
- **inchtomil**: `function inchToMil(inch: number, numberOfDecimals?: number): number;`
|
|
2984
|
+
- **inchtomm**: `function inchToMm(inch: number, numberOfDecimals?: number): number;`
|
|
2985
|
+
- **miltoinch**: `function milToInch(mil: number, numberOfDecimals?: number): number;`
|
|
2986
|
+
- **miltomm**: `function milToMm(mil: number, numberOfDecimals?: number): number;`
|
|
2987
|
+
- **mmtoinch**: `function mmToInch(mm: number, numberOfDecimals?: number): number;`
|
|
2988
|
+
- **mmtomil**: `function mmToMil(mm: number, numberOfDecimals?: number): number;`
|
|
2989
|
+
|
|
2990
|
+
---
|
|
2991
|
+
|
|
2992
|
+
## SYS_WebSocket
|
|
2993
|
+
|
|
2994
|
+
System / WebSocket class
|
|
2995
|
+
|
|
2996
|
+
```typescript
|
|
2997
|
+
class SYS_WebSocket
|
|
2998
|
+
```
|
|
2999
|
+
|
|
3000
|
+
- **close**: `function close(id: string, code?: number, reason?: string, extensionUuid?: string): void;`
|
|
3001
|
+
- **register**: `function register( id: string, serviceUri: string, receiveMessageCallFn?: (event: MessageEvent<any>) => void | Promise<void>, connectedCallFn?: () => void | Promise<void>, protocols?: string | Array<string>, ): void;`
|
|
3002
|
+
- **send**: `function send(id: string, data: string | Blob | BufferSource, extensionUuid?: string): void;`
|
|
3003
|
+
|
|
3004
|
+
---
|
|
3005
|
+
|
|
3006
|
+
## SYS_Window
|
|
3007
|
+
|
|
3008
|
+
System / window class
|
|
3009
|
+
|
|
3010
|
+
```typescript
|
|
3011
|
+
class SYS_Window
|
|
3012
|
+
```
|
|
3013
|
+
|
|
3014
|
+
- **addeventlistener**: `function addEventListener( type: ESYS_WindowEventType, listener: (ev: any) => any, options?: { capture?: undefined | false | true; once?: undefined | false | true; passive?: undefined | false | true; signal?: undefined | AbortSignal; }, ): ISYS_WindowEventListenerRemovableObject | undefined;`
|
|
3015
|
+
- **getcurrenttheme**: `function getCurrentTheme(): Promise<ESYS_Theme>;`
|
|
3016
|
+
- **geturlanchor**: `function getUrlAnchor(): string;`
|
|
3017
|
+
- **geturlparam**: `function getUrlParam(key: string): string | null;`
|
|
3018
|
+
- **getviewportsize**: `function getViewportSize(): { width: number; height: number };`
|
|
3019
|
+
- **hidestartpagequickstartitems**: `function hideStartPageQuickStartItems(items: Array<ESYS_StartPageQuickStartItem>): Promise<boolean>;`
|
|
3020
|
+
- **hidestartpagesupportfloatbaritems**: `function hideStartPageSupportFloatBarItems(): Promise<boolean>;`
|
|
3021
|
+
- **open**: `function open(url: string, target?: ESYS_WindowOpenTarget): void;`
|
|
3022
|
+
- **openui**: `function openUI(uiName: string, args?: Record<string, any>): Promise<void>;`
|
|
3023
|
+
- **removeeventlistener**: `function removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;`
|
|
3024
|
+
- **urlpushstate**: `function urlPushState(url: string): void;`
|
|
3025
|
+
- **urlreplacestate**: `function urlReplaceState(url: string): void;`
|
|
3026
|
+
|
|
3027
|
+
---
|
|
3028
|
+
|