`SchematicViewWindow`

A schematic view window.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Obtain a 'Schematic' object

application.MainWindow.MdiArea:CreateGeneralNetworkSchematicView()
schematic = application.MainWindow.MdiArea:Item(1)

    -- Close the schematic

application.MainWindow.MdiArea:CloseWindow(schematic)

Inheritance

The SchematicViewWindow object is derived from the Object object.

Property List

Height: The height of the window. (Read/Write number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)
Width: The width of the window. (Read/Write number)

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.)
PanDown (): Pans the view down.
PanLeft (): Pans the view left.
PanRight (): Pans the view right.
PanUp (): Pans the view up.
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.
ZoomIn (): Zooms the view in.
ZoomOut (): Zooms the view out.
ZoomToExtents (): Zooms to the extents of the schematic.

Static Function List

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

Property Details

Height

The height of the window.

Type: number
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Width

The width of the window.

Type: number
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.

PanDown ()

Pans the view down.

PanLeft ()

Pans the view left.

PanRight ()

Pans the view right.

PanUp ()

Pans the view up.

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.

ZoomIn ()

Zooms the view in.

ZoomOut ()

Zooms the view out.

ZoomToExtents ()

Zooms to the extents of the schematic.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.