ResultArrowCollection

A collection of 2D graph text boxes.

Example

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

    -- Add a Cartesian graph to the application's collection and obtain
    -- the arrow collection

graph = app.CartesianGraphs:Add()
arrows = graph.Arrows

arrow1 = arrows:AddLine(20, 40, 40, 50)
arrow2 = arrows:AddArrow(25, 40, 45, 50)
arrow3 = arrows:AddDoubleHeadArrow(30, 40, 50, 50)

Usage locations

The ResultArrowCollection object can be accessed from the following locations:

Property List

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

Method List

AddArrow (startposX number, startposY number, endposX number, endposY number)
Adds a arrow to a graph. (Returns a ResultArrow object.)
AddDoubleHeadArrow (startposX number, startposY number, endposX number, endposY number)
Adds a arrow to a graph. (Returns a ResultArrow object.)
AddLine (startposX number, startposY number, endposX number, endposY number)
Adds a line to a graph. (Returns a ResultArrow object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the ResultArrow at the given index. (Returns a ResultArrow object.)
Item (label string)
Returns the ResultArrow with the given label. (Returns a ResultArrow object.)
Items ()
Returns a table of ResultArrow. (Returns a List of ResultArrow 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 ResultArrow at the given index in the collection. (Read ResultArrow)
[string]
Returns the ResultArrow with the given name in the collection. (Read ResultArrow)

Property Details

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

Method Details

AddArrow (startposX number, startposY number, endposX number, endposY number)
Adds a arrow to a graph.
Input Parameters
startposX(number)
The start x-position of the added arrow.
startposY(number)
The start y-position of the added arrow.
endposX(number)
The end x-position of the added arrow.
endposY(number)
The end y-position of the added arrow.
Return
ResultArrow
The arrow on the graph.
AddDoubleHeadArrow (startposX number, startposY number, endposX number, endposY number)
Adds a arrow to a graph.
Input Parameters
startposX(number)
The start x-position of the added arrow.
startposY(number)
The start y-position of the added arrow.
endposX(number)
The end x-position of the added arrow.
endposY(number)
The end y-position of the added arrow.
Return
ResultArrow
The arrow on the graph.
AddLine (startposX number, startposY number, endposX number, endposY number)
Adds a line to a graph.
Input Parameters
startposX(number)
The start x-position of the added line.
startposY(number)
The start y-position of the added line.
endposX(number)
The end x-position of the added line.
endposY(number)
The end y-position of the added line.
Return
ResultArrow
The line on the graph.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the ResultArrow.
Return
boolean
The success of the check.
Item (index number)
Returns the ResultArrow at the given index.
Input Parameters
index(number)
The index of the ResultArrow.
Return
ResultArrow
The ResultArrow at the given index.
Item (label string)
Returns the ResultArrow with the given label.
Input Parameters
label(string)
The label of the ResultArrow.
Return
ResultArrow
The ResultArrow with the given label.
Items ()
Returns a table of ResultArrow.
Return
List of ResultArrow
A table of ResultArrow.
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 ResultArrow.