Inherits: SymbolInstance < DesignItem < ScriptObject
This object provides you with access to the information about an instance of a symbol in a design. This is the copy of the Symbol as used by each Gate of a Component. In a PCB design, components always have one symbol instance.
Properties
| Name | Type | Get/Set | Brief |
|---|---|---|---|
| Angle | float | Yes/No | The rotation angle of this instance in degrees. |
| Areas | Array[Area] | Yes/No | The list of areas belonging to this instance. |
| BondPads | Array[BondPad] | Yes/No | The list of bond pads belonging to this instance. |
| Callouts | Array[Callout] | Yes/No | The list of callouts belonging to this instance. |
| Copper | Array[Copper] | Yes/No | The list of copper shapes belonging to this instance. |
| DocShapes | Array[DocShape] | Yes/No | The list of documentation shapes belonging to this instance. |
| IsDocSymbol | bool | Yes/No | True if this instance is a Doc Symbol, False if not. |
| IsPlaced | bool | Yes/No | Whether this symbol instance has been placed on the design. |
| Mirrored | bool | Yes/Yes | Whether this instance is mirrored. |
| MountingHoles | Array[MountingHole] | Yes/No | The list of mounting holes belonging to this instance. |
| Name | str | Yes/No | The name of the symbol this is an instance of. |
| Pads | Array[Pad] | Yes/No | The list of pads belonging to this instance. |
| Page | Variant[Page, none] | Yes/No | The page of the symbol instance. |
| PinCount | int | Yes/No | The number of pins on this instance. |
| Position | Point | Yes/Yes | No description provided. |
| Symbol | Symbol | Yes/No | The symbol that this is an instance of. |
| Text | Array[Text] | Yes/No | The list of text items belonging to this instance. |
Methods
| Name | Returns | Arguments |
|---|---|---|
| AddAttributePositionAt | AttributePosition | attributeName : strpos : Pointlayer : Variant[Layer, none] |
| DeleteAttributePosition | bool | attributeName : strlayer : Variant[Layer, none] |
| Place | none | position : Pointpage : Variant[Page, none] |
| Unplace | none |
Property Details
Angle
Type: float
The rotation angle of this instance in degrees.
Areas
Type: Array[Area]
The list of areas belonging to this instance.
BondPads
Type: Array[BondPad]
The list of bond pads belonging to this instance.
Callouts
Type: Array[Callout]
The list of callouts belonging to this instance.
Copper
Type: Array[Copper]
The list of copper shapes belonging to this instance.
DocShapes
Type: Array[DocShape]
The list of documentation shapes belonging to this instance.
IsDocSymbol
Type: bool
True if this instance is a Doc Symbol, False if not.
IsPlaced
Type: bool
Whether this symbol instance has been placed on the design.
Mirrored
Type: bool
Whether this instance is mirrored.
MountingHoles
Type: Array[MountingHole]
The list of mounting holes belonging to this instance.
Name
Type: str
The name of the symbol this is an instance of.
Pads
Type: Array[Pad]
The list of pads belonging to this instance.
Page
Type: Variant[Page, none]
The page of the symbol instance.
PinCount
Type: int
The number of pins on this instance.
Position
Type: Point
Symbol
Type: Symbol
The symbol that this is an instance of.
Text
Type: Array[Text]
The list of text items belonging to this instance.
Method Details
AddAttributePositionAt
Add a new attribute position to this instance.
Returns AttributePosition: The created attribute position.
Arguments:
attributeName:str- Name of the new attribute position.pos:Point- The point to place his attribute position on.layer: Variant[Layer,none] - The layer to place the new attribute position on.
DeleteAttributePosition
Delete an attribute position from this instance.
Returns bool: Whether the deletion was successful.
Arguments:
attributeName:str- Name of the attribute position to delete.layer: Variant[Layer,none] - The layer from which to delete the attribute position.
Place
Place this symbol instance from the component bin on the design.
Licences required: Scripting Advanced Features.
Arguments:
position:Pointpage: Variant[Page,none]
Unplace
Licences required: Scripting Advanced Features.