Schematic

A schematic view window.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Obtain a 'Schematic' object

app.Schematics:ShowNetworkSchematic()
schematic = app.Schematics[1]

    -- Close the schematic
    
schematic:Close()    

Property List

Height
The height of the schematic view window. (Read only number)
Type
The object type string. (Read only string)
Width
The width of the schematic view window. (Read only number)
WindowActive
True if this window is the active window. (Read only boolean)
XPosition
The X position of the schematic view window. (Read only number)
YPosition
The Y position of the schematic view window. (Read only number)

Collection List

Symbols
The collection of schematic symbols on the schematic view. (SchematicSymbolCollection of SchematicSymbol.)

Method List

Close ()
Close the schematic view window.
ExportImage (filename string, fileformat string)
Export the schematic view window image at its same size to a specified file.
ExportImage (filename string, fileformat string, imagewidth number, imageheight number)
Export the schematic view window image at the given size to a specified file.
Maximise ()
Maximise the schematic view window.
Minimise ()
Minimise the schematic view window.
Restore ()
Restore the schematic view window.
SetPosition (xposition number, yposition number)
Sets the view position. Note that the view is restored when this function is called.
SetSize (windowwidth number, windowheight number)
Sets the schematic view window size. Note that the view is restored when this function is called.
Show ()
Shows the schematic view window.
ZoomToExtents ()
Zoom the content of the schematic view window to its extent.

Property Details

Height
The height of the schematic view window.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only
Width
The width of the schematic view window.
Type
number
Access
Read only
WindowActive
True if this window is the active window.
Type
boolean
Access
Read only
XPosition
The X position of the schematic view window.
Type
number
Access
Read only
YPosition
The Y position of the schematic view window.
Type
number
Access
Read only

Collection Details

Symbols
The collection of schematic symbols on the schematic view.
Type
SchematicSymbolCollection

Method Details

Close ()
Close the schematic view window.
ExportImage (filename string, fileformat string)
Export the schematic view window image at its same size to a specified file.
Input Parameters
filename(string)
The name of the image file without its extension.
fileformat(string)
The image file format, e.g. jpg, png, pdf, etc.
ExportImage (filename string, fileformat string, imagewidth number, imageheight number)
Export the schematic view window image at the given size to a specified file.
Input Parameters
filename(string)
The name of the image file without its extension.
fileformat(string)
The image file format, e.g. jpg, png, pdf, etc.
imagewidth(number)
The export width in pixels.
imageheight(number)
The export height in pixels.
Maximise ()
Maximise the schematic view window.
Minimise ()
Minimise the schematic view window.
Restore ()
Restore the schematic view window.
SetPosition (xposition number, yposition number)
Sets the view position. Note that the view is restored when this function is called.
Input Parameters
xposition(number)
The schematic view window X position.
yposition(number)
The schematic view window Y position.
SetSize (windowwidth number, windowheight number)
Sets the schematic view window size. Note that the view is restored when this function is called.
Input Parameters
windowwidth(number)
The schematic view window width in pixels.
windowheight(number)
The schematic view window height in pixels.
Show ()
Shows the schematic view window.
ZoomToExtents ()
Zoom the content of the schematic view window to its extent.