NearField3DPlot
A near field 3D result.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Example_Expanded.fek]]) firstActive3DView = app.Views[1] -- Add near field to the Plots collection of the 3D view nearFieldPlot = firstActive3DView.Plots:Add(app.Models[1].Configurations[1].NearFields[1]) -- Adjust plot type and axis values nearFieldPlot.PlotType = nearFieldPlot.PlotTypesAvailable[3] printlist(nearFieldPlot.FixedAxes) printlist(nearFieldPlot:GetFixedAxisAvailableValues("Y position")) nearFieldPlot:SetFixedAxisValue("Y position", 2, "mm")
Inheritance
The NearField3DPlot object is derived from the Result3DPlot object.
Property List
- Arrows
- The near field plot arrows properties. (Read only Arrows3DFormat)
- AxisNames
- The names of all the axes on the ResultPlot. (Read only List of string)
- Contours
- The near field plot contours properties. (Read only Contours3DFormat)
- DataSource
- The object that is the data source for this plot. (Read/Write ResultData)
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType 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)
- IsoSurface
- The near field isosurface properties. (Read only IsoSurface3DFormat)
- Label
- The object label. (Read/Write string)
- Legend
- The 3D plot legend properties. (Read only Plot3DLegendFormat)
- LocalCoordAxes
- The near field local coordinate axis properties. (Read only Axes3DFormat)
- PlotType
- The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface. (Read/Write string)
- PlotTypesAvailable
- The list of available plot types. (Read only List of string)
- Quantity
- The near field plot quantity properties. (Read only NearFieldQuantity)
- RequestPoints
- The near field request points properties. (Read only RequestPoints3DFormat)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the plot must be shown or hidden. (Read/Write boolean)
- Visualisation
- The near field visualisation properties. (Read only NearField3DFormat)
Method List
- Delete ()
- Delete the plot.
- Duplicate ()
- Duplicate the plot. (Returns a Result3DPlot object.)
- ExportIsoSurfaceToSTL (filename string)
- Export a near field isosurface to an STL file.
- 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 fixed 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 ()
- Stores a copy of the plot. (Returns a Result3DPlot object.)
Property Details
- Arrows
- The near field plot arrows properties.
- Type
- Arrows3DFormat
- Access
- Read only
- AxisNames
- The names of all the axes on the ResultPlot.
- Access
- Read only
- Contours
- The near field plot contours properties.
- Type
- Contours3DFormat
- Access
- Read only
- DataSource
- The object that is the data source for this plot.
- Type
- ResultData
- Access
- Read/Write
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType 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
- Read only
- IsoSurface
- The near field isosurface properties.
- Type
- IsoSurface3DFormat
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Legend
- The 3D plot legend properties.
- Type
- Plot3DLegendFormat
- Access
- Read only
- LocalCoordAxes
- The near field local coordinate axis properties.
- Type
- Axes3DFormat
- Access
- Read only
- PlotType
- The type of plot to be displayed, e.g., 3D Surface, Phi cut, Theta cut, XY surface.
- Type
- string
- Access
- Read/Write
- PlotTypesAvailable
- The list of available plot types.
- Access
- Read only
- Quantity
- The near field plot quantity properties.
- Type
- NearFieldQuantity
- Access
- Read only
- RequestPoints
- The near field request points properties.
- Type
- RequestPoints3DFormat
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the plot must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
- Visualisation
- The near field visualisation properties.
- Type
- NearField3DFormat
- Access
- Read only
Method Details
- Delete ()
- Delete the plot.
- Duplicate ()
- Duplicate the plot.
- Return
- Result3DPlot
- The duplicated plot.
- ExportIsoSurfaceToSTL (filename string)
- Export a near field isosurface to an STL file.
- Input Parameters
- filename(string)
- STL filename.
- GetAxisUnit (axis string)
- Returns the SI unit of the specified axis.
- GetFixedAxisAvailableValues (axis string)
- Returns the list of available values for the specified fixed axis.
- GetFixedAxisValue (axis string)
- Returns the current value for the specified fixed axis.
- 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.
- 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.
- Input Parameters
- properties(table)
- A table of properties defining the new state of the object.
- Store ()
- Stores a copy of the plot.
- Return
- Result3DPlot
- The new plot associated with the stored data.