ILayerStackDocument interface
No description yet.
public interface ILayerStackDocument
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Stackup | ILsmSdkStackup | get |
Stackup
No description yet.
ILsmSdkStackup GetState_Stackup();
Type: ILsmSdkStackup · Access: read-only
The accessors are extension methods of ILayerStackDocumentHelper (using PCB;).
Methods
| Method | Returns | Description |
|---|---|---|
| ApplyToPcb | void | |
| CloseDialog | void | |
| ComputeImpedance | void | |
| GetTransmissionLineImageBase64 | string | |
| LoadFromFile | void | |
| LoadFromPcb | void | |
| LoadFromVault | void | |
| SaveToFile | void | |
| SaveToVault | void | |
| SerializeToString | string | |
| ShowDialog | void |
ApplyToPcb
No description yet.
void ApplyToPcb(string argBoardPath);
| Parameter | Type | Passing |
|---|---|---|
argBoardPath | string | value |
Returns: nothing (void)
CloseDialog
No description yet.
void CloseDialog();
Returns: nothing (void)
ComputeImpedance
No description yet.
void ComputeImpedance();
Returns: nothing (void)
GetTransmissionLineImageBase64
No description yet.
string GetTransmissionLineImageBase64(string argProfileGuid, string argLayerGuid, string argStackGuid, int argWidth, int argHeight);
| Parameter | Type | Passing |
|---|---|---|
argProfileGuid | string | value |
argLayerGuid | string | value |
argStackGuid | string | value |
argWidth | int | value |
argHeight | int | value |
Returns: string
LoadFromFile
No description yet.
void LoadFromFile(string argPath, TLayerStackDocumentFormat argFormat);
void LoadFromFile(string argPath, int argFormat);
| Parameter | Type | Passing |
|---|---|---|
argPath | string | value |
argFormat | TLayerStackDocumentFormat | value |
Returns: nothing (void)
The first overload is an extension method of ILayerStackDocumentHelper (using PCB;) with typed parameters; the second is declared by the interface.
LoadFromPcb
No description yet.
void LoadFromPcb(string argBoardPath);
| Parameter | Type | Passing |
|---|---|---|
argBoardPath | string | value |
Returns: nothing (void)
LoadFromVault
No description yet.
void LoadFromVault(string argVaultGUID, string argRevisionGuid);
| Parameter | Type | Passing |
|---|---|---|
argVaultGUID | string | value |
argRevisionGuid | string | value |
Returns: nothing (void)
SaveToFile
No description yet.
void SaveToFile(string argPath, TLayerStackDocumentFormat argFormat);
void SaveToFile(string argPath, int argFormat);
| Parameter | Type | Passing |
|---|---|---|
argPath | string | value |
argFormat | TLayerStackDocumentFormat | value |
Returns: nothing (void)
The first overload is an extension method of ILayerStackDocumentHelper (using PCB;) with typed parameters; the second is declared by the interface.
SaveToVault
No description yet.
void SaveToVault(string argVaultGUID, string argFolderGUID, string argItemGUID, string argRevisionGuid);
| Parameter | Type | Passing |
|---|---|---|
argVaultGUID | string | value |
argFolderGUID | string | value |
argItemGUID | string | value |
argRevisionGuid | string | value |
Returns: nothing (void)
SerializeToString
No description yet.
string SerializeToString(TLayerStackDocumentFormat argFormat);
string SerializeToString(int argFormat);
| Parameter | Type | Passing |
|---|---|---|
argFormat | TLayerStackDocumentFormat | value |
Returns: string
The first overload is an extension method of ILayerStackDocumentHelper (using PCB;) with typed parameters; the second is declared by the interface.
ShowDialog
No description yet.
void ShowDialog();
Returns: nothing (void)
Returned by
ILayerStackManager.CreateDocument, ILayerStackManager.OpenDocumentFromPcb