`CustomDataSurfacePlot`

A custom data surface plot 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 a Cartesian graph
    
customData = app.MathScripts["CustomMath1"]
graph = app.CartesianSurfaceGraphs:Add()
customDataPlot = graph.Plots:Add(customData)

    -- SetProperties the custom data surface plot
    
customDataPlot.Quantity.Type = "TotalEField"
customDataPlot.HorizontalIndependentAxis = "Z position"
customDataPlot:SetFixedAxisValue("Frequency", 1.7, "GHz")

Inheritance

The CustomDataSurfacePlot 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 IndependentAxes 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: The object label. (Read/Write string)
Legend: The surface plot legend properties. (Read only SurfacePlotLegendFormat)
Quantity: The custom data surface plot quantity properties. (Read only CustomDataQuantity)
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.
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

DiscretePlotEnabled

Specifies whether the discrete plot property is enabled or disabled for this surface plot.

Type: boolean
Access: Read/Write

FixedAxes

The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxes 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

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

Quantity

The custom data surface plot quantity properties.

Type: CustomDataQuantity
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

Type

The object type string.

Type: string
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.

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.

SwitchIndependentAxes ()

Switches the horizontal and vertical independent axes.