Arrows3DFormat

The 3D plot arrows properties.

Example

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

    -- Display instantaneous current arrows
    
surfaceCurrents = app.Views[1].Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1])
surfaceCurrents.Quantity.ComplexComponent = pf.Enums.ComplexComponentEnum.Instantaneous
surfaceCurrents.Quantity.InstantaneousPhase = 240
surfaceCurrents.Arrows.Visible = true
surfaceCurrents.Arrows.FixedSize = true
surfaceCurrents.Arrows.Colour = "ByMagnitude"

Usage locations (object properties)

The following objects have properties using the Arrows3DFormat object:

Property List

Colour
The colour of the instantaneous arrows. (Read/Write MagnitudeColour)
FixedSize
Specifies whether the instantaneous arrows should be drawn at a fixed size. (Read/Write boolean)
Size
The size (%) of the instantaneous arrows in the range [0,280]. (Read/Write number)
Visible
Specifies whether the instantaneous arrows must be shown or hidden. (Read/Write boolean)

Property Details

Colour
The colour of the instantaneous arrows.
Type
MagnitudeColour
Access
Read/Write
FixedSize
Specifies whether the instantaneous arrows should be drawn at a fixed size.
Type
boolean
Access
Read/Write
Size
The size (%) of the instantaneous arrows in the range [0,280].
Type
number
Access
Read/Write
Visible
Specifies whether the instantaneous arrows must be shown or hidden.
Type
boolean
Access
Read/Write