`CartesianSurfaceGraph`

A Cartesian surface graph where results can be plotted.

Example

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

    -- Create a surface graph with a trace 
    
graph = app.CartesianSurfaceGraphs:Add()
farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1])

    -- Export an image at a specific aspect ratio
    
graph:Restore()
graph:SetSize(800,400)
graph:ExportImage("temp_FarFieldGraph", "png", 1000, 500)

Inheritance

The CartesianSurfaceGraph object is derived from the SurfaceGraph object.

Usage locations

The CartesianSurfaceGraph object can be accessed from the following locations:

Methods
- CartesianSurfaceGraph object has method Duplicate().
- SurfaceGraph object has method Duplicate().
- CartesianSurfaceGraphCollection collection has method Items().
- CartesianSurfaceGraphCollection collection has method Item(number).
- CartesianSurfaceGraphCollection collection has method Item(string).
- CartesianSurfaceGraphCollection collection has method Add().

Property List

Footer: The surface graph footer properties. (Read only SurfaceGraphTextBox)
GreyscaleEnabled: Set the graph's colour scheme to greyscale. (Read/Write boolean)
Grid: The Cartesian surface graph grid properties. (Read only CartesianSurfaceGraphGrid)
Height: The height of the window. (Read only number)
HorizontalAxis: The Cartesian surface graph horizontal axis properties. (Read only HorizontalSurfaceGraphAxis)
Legend: The surface graph legend properties. (Read only SurfaceGraphLegend)
LockedAspectRatio: Links the horizontal and vertical graph axes so as to keep a one-to-one aspect. Specified by the LockedAspectRatioEnum, e.g. Auto, On or Off. (Read/Write LockedAspectRatioEnum)
Title: The surface graph title properties. (Read only SurfaceGraphTextBox)
Type: The object type string. (Read only string)
VerticalAxis: The Cartesian surface graph vertical axis properties. (Read only VerticalSurfaceGraphAxis)
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.
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.)
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.
SetProperties (properties table): 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.
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

Grid

The Cartesian surface graph grid properties.

Type: CartesianSurfaceGraphGrid
Access: Read only

Height

The height of the window.

Type: number
Access: Read only

HorizontalAxis

The Cartesian surface graph horizontal axis properties.

Type: HorizontalSurfaceGraphAxis
Access: Read only

Legend

The surface graph legend properties.

Type: SurfaceGraphLegend
Access: Read only

LockedAspectRatio

Links the horizontal and vertical graph axes so as to keep a one-to-one aspect. Specified by the LockedAspectRatioEnum, e.g. Auto, On or Off.

Type: LockedAspectRatioEnum
Access: Read/Write

Title

The surface graph title properties.

Type: SurfaceGraphTextBox
Access: Read only

Type

The object type string.

Type: string
Access: Read only

VerticalAxis

The Cartesian surface graph vertical axis properties.

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

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 properties table.

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.

SetProperties (properties table)

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(table): A table of properties defining the new state of the object.

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.