ResultArrow

A 2D results arrow.

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:AddArrow(30, 40, 50, 50)
arrow1.LineColour = pf.Enums.ColourEnum.Red
arrow1.LineStyle = pf.Enums.LineStyleEnum.DashLine
arrow1.LineWeight = 4

arrow2 = arrow1:Duplicate()

arrow1:Delete()

Property List

EndPositionX
The X coordinate end position of the arrow. (Read/Write number)
EndPositionY
The Y coordinate end position of the arrow. (Read/Write number)
LineColour
The line colour. See ColourEnum. (Read/Write string)
LineStyle
The line style. See LineStyleEnum. (Read/Write string)
LineWeight
The line weight. (Read/Write number)
StartPositionX
The X coordinate start position of the arrow. (Read/Write number)
StartPositionY
The Y coordinate start position of the arrow. (Read/Write number)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the arrow.
Duplicate ()
Duplicate the arrow. (Returns a ResultArrow object.)
Lower ()
Lower the arrow.
Raise ()
Raise the arrow.

Property Details

EndPositionX
The X coordinate end position of the arrow.
Type
number
Access
Read/Write
EndPositionY
The Y coordinate end position of the arrow.
Type
number
Access
Read/Write
LineColour
The line colour. See ColourEnum.
Type
string
Access
Read/Write
LineStyle
The line style. See LineStyleEnum.
Type
string
Access
Read/Write
LineWeight
The line weight.
Type
number
Access
Read/Write
StartPositionX
The X coordinate start position of the arrow.
Type
number
Access
Read/Write
StartPositionY
The Y coordinate start position of the arrow.
Type
number
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the arrow.
Duplicate ()
Duplicate the arrow.
Return
ResultArrow
The duplicated arrow.
Lower ()
Lower the arrow.
Raise ()
Raise the arrow.