CartesianGraphCollection

A collection of Cartesian graphs.

Example

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

    -- Create graphs 
    
farFieldGraph = app.CartesianGraphs:Add()
farFieldGraph.Traces:Add(app.Models[1].Configurations[1].FarFields[1])
nearFieldGraph = app.CartesianGraphs:Add()
nearFieldGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1])

    -- Export all graphs in the 'CartesianGraphCollection'

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

Usage locations

The CartesianGraphCollection object can be accessed from the following locations:

Property List

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

Method List

Add ()
Adds a new Cartesian graph to the collection. (Returns a CartesianGraph object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CartesianGraph at the given index. (Returns a CartesianGraph object.)
Item (label string)
Returns the CartesianGraph with the given label. (Returns a CartesianGraph object.)
Items ()
Returns a table of CartesianGraph. (Returns a List of CartesianGraph 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 CartesianGraph at the given index in the collection. (Read CartesianGraph)
[string]
Returns the CartesianGraph with the given name in the collection. (Read CartesianGraph)

Property Details

Count
The number of CartesianGraph 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 graph to the collection.
Return
CartesianGraph
The new Cartesian graph.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CartesianGraph.
Return
boolean
The success of the check.
Item (index number)
Returns the CartesianGraph at the given index.
Input Parameters
index(number)
The index of the CartesianGraph.
Return
CartesianGraph
The CartesianGraph at the given index.
Item (label string)
Returns the CartesianGraph with the given label.
Input Parameters
label(string)
The label of the CartesianGraph.
Return
CartesianGraph
The CartesianGraph with the given label.
Items ()
Returns a table of CartesianGraph.
Return
List of CartesianGraph
A table of CartesianGraph.
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 CartesianGraph.