Result3DPlot

A 3D plot of result.

Example

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

    -- Get the first 3D view from the collection of Views in the application
    
view = app.Views[1]

    -- Add far field, near field and surface current 3D plots to the 3D view
    
farFieldPlot = view.Plots:Add(app.Models[1].Configurations[1].FarFields[1])
nearFieldPlot = view.Plots:Add(app.Models[1].Configurations[1].NearFields[1])
surfaceCurrentPlot = view.Plots:Add(app.Models[1].Configurations[1].SurfaceCurrents[1])

    -- Hide the near field plot

nearFieldPlot.Visible = false

    -- Set the legend position for the surface currents plot

surfaceCurrentPlot.Legend.Position = pf.Enums.ViewLegendPositionEnum.TopRight

    -- Change the legend scaling range for the far field

farFieldPlot.Legend.LinearRange.FixedRangeMax = 2
farFieldPlot.Legend.LinearRange.FixedRangeMin = -3
farFieldPlot.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Fixed

Inheritance

The Result3DPlot object is derived from the ResultPlot object.

The following objects are derived (specialisations) from the Result3DPlot object:

Property List

AxisNames
The names of all the axes on the ResultPlot. (Read only List of string)
DataSource
The object that is the data source for this plot. (Read/Write ResultData)
Label
The object label. (Read/Write string)
Legend
The 3D plot legend properties. (Read only Plot3DLegendFormat)
Visible
Specifies whether the plot must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the plot.
Store ()
Stores a copy of the plot. (Returns a Result3DPlot object.)

Property Details

AxisNames
The names of all the axes on the ResultPlot.
Access
Read only
DataSource
The object that is the data source for this plot.
Type
ResultData
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Legend
The 3D plot legend properties.
Type
Plot3DLegendFormat
Access
Read only
Visible
Specifies whether the plot must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the plot.
Store ()
Stores a copy of the plot.
Return
Result3DPlot
The new plot associated with the stored data.