ResultSurfacePlot

A result surface plot.

Example

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

        -- Add a far field surface plot to a new surface graph
    
graph = app.CartesianSurfaceGraphs:Add()
farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1])

    -- Hide the far field plot

farFieldPlot.Visible = false

Inheritance

The ResultSurfacePlot object is derived from the ResultPlot object.

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

Usage locations

The ResultSurfacePlot object can be accessed from the following locations:

Property List

AxisNames
The names of all the axes on the ResultPlot. (Read only List of string)
DataSource
The source of the surface plot. (Read/Write ResultData)
HorizontalIndependentAxis
The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
IndependentAxesAvailable
The list of available independent axes. (Read only List of string)
Label
The object label. (Read/Write string)
Legend
The surface plot legend properties. (Read only SurfacePlotLegendFormat)
Sampling
The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat)
VerticalIndependentAxis
The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
Visible
Specifies whether the surface plot must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the surface plot.
SwitchIndependentAxes ()
Switches the horizontal and vertical independent axes.

Property Details

AxisNames
The names of all the axes on the ResultPlot.
Access
Read only
DataSource
The source of the surface plot.
Type
ResultData
Access
Read/Write
HorizontalIndependentAxis
The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
Type
string
Access
Read/Write
IndependentAxesAvailable
The list of available independent axes.
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Legend
The surface plot legend properties.
Type
SurfacePlotLegendFormat
Access
Read only
Sampling
The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled.
Type
SurfacePlotSamplingFormat
Access
Read only
VerticalIndependentAxis
The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
Type
string
Access
Read/Write
Visible
Specifies whether the surface plot must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the surface plot.
SwitchIndependentAxes ()
Switches the horizontal and vertical independent axes.