CartesianSurfaceGraphCollection

A collection of Cartesian surface graphs.

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])

    -- Export all graphs in the 'CartesianSurfaceGraphCollection'

for index, graph in pairs(app.CartesianSurfaceGraphs) do
    graph:Maximise()
    graph:ExportImage("temp_Graph"..index, "pdf")
end

Usage locations

The CartesianSurfaceGraphCollection object can be accessed from the following locations:

Property List

Count
The number of CartesianSurfaceGraph items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add ()
Adds a new Cartesian surface graph to the collection. (Returns a CartesianSurfaceGraph object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CartesianSurfaceGraph at the given index. (Returns a CartesianSurfaceGraph object.)
Item (label string)
Returns the CartesianSurfaceGraph with the given label. (Returns a CartesianSurfaceGraph object.)
Items ()
Returns a table of CartesianSurfaceGraph. (Returns a List of CartesianSurfaceGraph object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the CartesianSurfaceGraph at the given index in the collection. (Read CartesianSurfaceGraph)
[string]
Returns the CartesianSurfaceGraph with the given name in the collection. (Read CartesianSurfaceGraph)

Property Details

Count
The number of CartesianSurfaceGraph items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add ()
Adds a new Cartesian surface graph to the collection.
Return
CartesianSurfaceGraph
The new Cartesian surface graph.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CartesianSurfaceGraph.
Return
boolean
The success of the check.
Item (index number)
Returns the CartesianSurfaceGraph at the given index.
Input Parameters
index(number)
The index of the CartesianSurfaceGraph.
Return
CartesianSurfaceGraph
The CartesianSurfaceGraph at the given index.
Item (label string)
Returns the CartesianSurfaceGraph with the given label.
Input Parameters
label(string)
The label of the CartesianSurfaceGraph.
Return
CartesianSurfaceGraph
The CartesianSurfaceGraph with the given label.
Items ()
Returns a table of CartesianSurfaceGraph.
Return
List of CartesianSurfaceGraph
A table of CartesianSurfaceGraph.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for CartesianSurfaceGraph.