`SchematicScene`

Inheritance

The SchematicScene object is derived from the Object object.

Usage locations

The SchematicScene object can be accessed from the following locations:

Collection lists
- SchematicView object has collection Scene.
Properties
- SchematicViewItem object has property SchematicSceneReference.
- AnnotationViewItem object has property SchematicSceneReference.
- ComponentViewItem object has property SchematicSceneReference.
- NetViewItem object has property SchematicSceneReference.
- TerminalViewItem object has property SchematicSceneReference.

Property List

Count: The number of SchematicViewItem items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

Path: (Read only string)
Schematic: (Read/Write Schematic)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number): Returns the SchematicViewItem for the given index in the collection. (Returns a SchematicViewItem object.)
Item (label string): Returns the SchematicViewItem for the given label in the collection. (Returns a SchematicViewItem object.)
Items (): Returns a table of SchematicViewItem items. (Returns a UnsupportedType(List of SchematicViewItem) object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of SchematicViewItem items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

Path

Type: string
Access: Read only

Schematic

Type: Schematic
Access: Read/Write

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Item (index number)

Returns the SchematicViewItem for the given index in the collection.

Input Parameters

index(number): The index of the SchematicViewItem.

Return

SchematicViewItem: The item in the collection

Item (label string)

Returns the SchematicViewItem for the given label in the collection.

Input Parameters

label(string): The label of the SchematicViewItem.

Return

SchematicViewItem: The item in the collection

Items ()

Returns a table of SchematicViewItem items.

Return

UnsupportedType(List of SchematicViewItem): The list of items in the collection

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.