`CustomData3DPlot`

A custom data 3D result.

Example

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

    -- Retrieve the custom math script and plot it on the 3D view
    
customData = app.MathScripts["CustomMath1"]
customDataPlot = app.Views[1].Plots:Add(customData)
app.Views[1]:ZoomToExtents()

    -- SetProperties the custom data plot
    
customDataPlot.Quantity.Type = "TotalEField"
customDataPlot:SetFixedAxisValue("Z position", 0.2, "m") 
customDataPlot.Visualisation.Opacity = 50

Inheritance

The CustomData3DPlot object is derived from the Result3DPlot object.

Property List

AxisNames: The names of all the axes on the ResultPlot. (Read only List of string)
Contours: The custom data 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)
Label: The object label. (Read/Write string)
Legend: The 3D plot legend properties. (Read only Plot3DLegendFormat)
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 custom data 3D plot quantity properties. (Read only CustomDataQuantity)
Type: The object type string. (Read only string)
Visible: Specifies whether the plot must be shown or hidden. (Read/Write boolean)
Visualisation: The custom data visualisation properties. (Read only CustomData3DFormat)

Method List

Delete (): Delete the plot.
Duplicate (): Duplicate the plot. (Returns a Result3DPlot object.)
GetAxisUnit (axis string): Returns the SI unit for 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

AxisNames

The names of all the axes on the ResultPlot.

Access: Read only

Contours

The custom data 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

Label

The object label.

Type: string
Access: Read/Write

Legend

The 3D plot legend properties.

Type: Plot3DLegendFormat
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 custom data 3D plot quantity properties.

Type: CustomDataQuantity
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 custom data visualisation properties.

Type: CustomData3DFormat
Access: Read only

Method Details

Delete ()

Delete the plot.

Duplicate ()

Duplicate the plot.

Return

Result3DPlot: The duplicated plot.

GetAxisUnit (axis string)

Returns the SI unit for 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 fixed 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 ()

Stores a copy of the plot.

Return

Result3DPlot: The new plot associated with the stored data.