PolarGraphCollection
A collection of Polar graphs.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) -- Create graphs graph1 = app.PolarGraphs:Add() graph1.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) graph2 = graph1:Duplicate() -- Export all graphs in the 'PolarGraphCollection' for index, graph in pairs(app.PolarGraphs) do graph:Maximise() graph:ExportImage("temp_Graph"..index, "pdf") end
Usage locations
The PolarGraphCollection object can be accessed from the following locations:
- Collection lists
- Application object has collection PolarGraphs.
Property List
Method List
- Add ()
- Adds a new Polar graph to the collection. (Returns a PolarGraph object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the PolarGraph at the given index. (Returns a PolarGraph object.)
- Item (label string)
- Returns the PolarGraph with the given label. (Returns a PolarGraph object.)
- Items ()
- Returns a table of PolarGraph. (Returns a List of PolarGraph 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 PolarGraph at the given index in the collection. (Read PolarGraph)
- [string]
- Returns the PolarGraph with the given name in the collection. (Read PolarGraph)
Property Details
Method Details
- Add ()
- Adds a new Polar graph to the collection.
- Return
- PolarGraph
- The new Polar graph.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the PolarGraph at the given index.
- Input Parameters
- index(number)
- The index of the PolarGraph.
- Return
- PolarGraph
- The PolarGraph at the given index.
- Item (label string)
- Returns the PolarGraph with the given label.
- Input Parameters
- label(string)
- The label of the PolarGraph.
- Return
- PolarGraph
- The PolarGraph with the given label.
- Items ()
- Returns a table of PolarGraph.
- Return
- List of PolarGraph
- A table of PolarGraph.
- 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.