# NearFieldSurfacePlot

A near field surface plot.

## Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
nearFieldData = app.Models[1].Configurations[1].NearFields[1]

-- Add the near field data to a Cartesian surface graph

-- Configure the plot axes

nearFieldPlot.HorizontalIndependentAxis = "Frequency"
nearFieldPlot.VerticalIndependentAxis = "Z position"
nearFieldPlot:SetFixedAxisValue("Y position", 9, "mm")

-- Configure the plot quantity

nearFieldPlot.Quantity.Type = pf.Enums.NearFieldQuantityTypeEnum.EField


## Inheritance

The NearFieldSurfacePlot object is derived from the ResultSurfacePlot object.

## 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)
DiscretePlotEnabled
Specifies whether the discrete plot property is enabled or disabled for this surface plot. (Read/Write boolean)
FixedAxes
The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string)
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
Legend
The surface plot legend properties. (Read only SurfacePlotLegendFormat)
PlotType
The type of plot to be displayed, e.g., X+ surface, Y- surface, Z+ surface. (Read/Write string)
PlotTypesAvailable
The list of available plot types. (Read only List of string)
Quantity
The near field surface plot quantity properties. (Read only NearFieldQuantity)
Sampling
The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only SurfacePlotSamplingFormat)
Type
The object type string. (Read only string)
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.
GetAxisUnit (axis string)
Returns the SI unit of the specified axis. (Returns a string object.)
GetFixedAxisAvailableValues (axis string)
Returns the list of available values for the specified axis. (Returns a List of string object.)
GetFixedAxisValue (axis string)
Returns the current value for the specified fixed axis. (Returns a string object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetFixedAxisValue (axis string, numvalue number, unit string)
Set the fixed axis to the specified value.
SetFixedAxisValue (axis string, strvalue string)
Set the fixed axis to the specified value.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Store ()
Store a copy of the surface plot.
SwitchIndependentAxes ()
Switches the horizontal and vertical independent axes.

## Property Details

AxisNames
The names of all the axes on the ResultPlot.
Access
DataSource
The source of the surface plot.
Type
ResultData
Access
DiscretePlotEnabled
Specifies whether the discrete plot property is enabled or disabled for this surface plot.
Type
boolean
Access
FixedAxes
The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods.
Access
HorizontalIndependentAxis
The horizontal independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
Type
string
Access
IndependentAxesAvailable
The list of available independent axes.
Access
Label
The object label.
Type
string
Access
Legend
The surface plot legend properties.
Type
SurfacePlotLegendFormat
Access
PlotType
The type of plot to be displayed, e.g., X+ surface, Y- surface, Z+ surface.
Type
string
Access
PlotTypesAvailable
The list of available plot types.
Access
Quantity
The near field surface plot quantity properties.
Type
NearFieldQuantity
Access
Sampling
The continuous surface plot sampling settings. These settings only apply to traces when the independent axis is continuously sampled.
Type
SurfacePlotSamplingFormat
Access
Type
The object type string.
Type
string
Access
VerticalIndependentAxis
The vertical independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.
Type
string
Access
Visible
Specifies whether the surface plot must be shown or hidden.
Type
boolean
Access

## Method Details

Delete ()
Delete the surface plot.
GetAxisUnit (axis string)
Returns the SI unit of the specified axis.
Input Parameters
axis(string)
The axis.
Return
string
The SI unit string.
GetFixedAxisAvailableValues (axis string)
Returns the list of available values for the specified axis.
Input Parameters
axis(string)
The fixed axis.
Return
List of string
The axis values.
GetFixedAxisValue (axis string)
Returns the current value for the specified fixed axis.
Input Parameters
axis(string)
The fixed axis.
Return
string
The axis value.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetFixedAxisValue (axis string, numvalue number, unit string)
Set the fixed axis to the specified value.
Input Parameters
axis(string)
The fixed axis.
numvalue(number)
The axis value.
unit(string)
The given value's unit. Provide an empty string if it has no unit.
SetFixedAxisValue (axis string, strvalue string)
Set the fixed axis to the specified value.
Input Parameters
axis(string)
The fixed axis.
strvalue(string)
The axis value.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.
Store ()
Store a copy of the surface plot.
SwitchIndependentAxes ()
Switches the horizontal and vertical independent axes.