SurfaceGraph

A surface graph where results can be plotted.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])

    -- Add a Cartesian surface graph and a surface plot 
    
graph = app.CartesianSurfaceGraphs:Add()
farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1])

    -- Change properties of the graph 

graph.Grid.Minor.Visible = true

Inheritance

The SurfaceGraph object is derived from the Window object.

The following objects are derived (specialisations) from the SurfaceGraph object:

Property List

Footer
The surface graph footer properties. (Read only SurfaceGraphTextBox)
GreyscaleEnabled
Set the graph's colour scheme to greyscale. (Read/Write boolean)
Height
The height of the window. (Read only number)
Legend
The surface graph legend properties. (Read only SurfaceGraphLegend)
Title
The surface graph title properties. (Read only SurfaceGraphTextBox)
Width
The width of the window. (Read only number)
WindowActive
True if this window is the active window. (Read only boolean)
WindowTitle
The title of the window. (Read/Write string)
XPosition
The X position of the window. (Read only number)
YPosition
The Y position of the window. (Read only number)

Collection List

Plots
The collection of surface plots on the graph. (ResultSurfacePlotCollection of ResultSurfacePlot.)

Method List

BlockGraphRedraws ()
Disables graph redraws for performance purposes. When all the changes to the graph are complete, call UnblockGraphRedraws to re-enable graph updates.
Close ()
Close the window.
Duplicate ()
Duplicate the surface graph. (Returns a CartesianSurfaceGraph object.)
ExportImage (filename string, fileformat string)
Export the window image at its same size to a specified file.
ExportImage (filename string, fileformat string, imagewidth number, imageheight number)
Export the window image at the given size to a specified file.
Maximise ()
Maximise the window.
Minimise ()
Minimise the window.
Restore ()
Restore the window.
SetPosition (xposition number, yposition number)
Sets the view position. Note that the view is restored when this function is called.
SetSize (imagewidth number, imageheight number)
Sets the view size. Note that the view is restored when this function is called.
Show ()
Shows the view.
UnblockGraphRedraws ()
Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for performance purposes. The graph is redrawn when this method is called and normals redraws will occur on changes.
ZoomToExtents ()
Zoom the content of the window to its extent.

Property Details

Footer
The surface graph footer properties.
Type
SurfaceGraphTextBox
Access
Read only
GreyscaleEnabled
Set the graph's colour scheme to greyscale.
Type
boolean
Access
Read/Write
Height
The height of the window.
Type
number
Access
Read only
Legend
The surface graph legend properties.
Type
SurfaceGraphLegend
Access
Read only
Title
The surface graph title properties.
Type
SurfaceGraphTextBox
Access
Read only
Width
The width of the window.
Type
number
Access
Read only
WindowActive
True if this window is the active window.
Type
boolean
Access
Read only
WindowTitle
The title of the window.
Type
string
Access
Read/Write
XPosition
The X position of the window.
Type
number
Access
Read only
YPosition
The Y position of the window.
Type
number
Access
Read only

Collection Details

Plots
The collection of surface plots on the graph.
Type
ResultSurfacePlotCollection

Method Details

BlockGraphRedraws ()
Disables graph redraws for performance purposes. When all the changes to the graph are complete, call UnblockGraphRedraws to re-enable graph updates.
Close ()
Close the window.
Duplicate ()
Duplicate the surface graph.
Return
CartesianSurfaceGraph
The duplicated surface graph.
ExportImage (filename string, fileformat string)
Export the 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 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 window.
Minimise ()
Minimise the window.
Restore ()
Restore the 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 view X position.
yposition(number)
The view Y position.
SetSize (imagewidth number, imageheight number)
Sets the view size. Note that the view is restored when this function is called.
Input Parameters
imagewidth(number)
The view width in pixels.
imageheight(number)
The view height in pixels.
Show ()
Shows the view.
UnblockGraphRedraws ()
Enables graph redraws. This method is used in conjunction with BlockGraphRedraws for performance purposes. The graph is redrawn when this method is called and normals redraws will occur on changes.
ZoomToExtents ()
Zoom the content of the window to its extent.