CustomData3DFormat

The custom data 3D plot visualisation properties.

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)
customDataPlot.Quantity.Type = "TotalEField"
app.Views[1]:ZoomToExtents()

    -- SetProperties the custom data plot visualisation
    
customDataPlot.Visualisation.Opacity = 50
customDataPlot.Visualisation.AutoExtruded = false
customDataPlot.Visualisation.Extrusion = 50
customDataPlot.Visualisation.GridVisible = true

Usage locations (object properties)

The following objects have properties using the CustomData3DFormat object:

Property List

AutoExtruded
Specifies whether auto extrusion is enabled or disabled for the plot. (Read/Write boolean)
AutoSizingEnabled
Specifies whether auto size is enabled or disabled for the plot. (Read/Write boolean)
Extrusion
The amount (%) the plot should be extruded in range [0,100]. (Read/Write number)
FlatShaded
Specifies whether discrete colours (flat shading) should be enabled or disabled for the plot. (Read/Write boolean)
GridVisible
Specifies whether the plot grid must be shown or hidden. (Read/Write boolean)
Opacity
Specify the plot opacity % in the range [0, 100]. (Read/Write number)
Size
The custom size (m) of the plot. AutoSizingEnabled needs to be disabled for this property to take affect. (Read/Write number)
SizeFactor
The amount (%) the plot should be scaled in range [0,600]. (Read/Write number)
SurfaceVisible
Specifies whether the plot surface must be shown or hidden. (Read/Write boolean)

Property Details

AutoExtruded
Specifies whether auto extrusion is enabled or disabled for the plot.
Type
boolean
Access
Read/Write
AutoSizingEnabled
Specifies whether auto size is enabled or disabled for the plot.
Type
boolean
Access
Read/Write
Extrusion
The amount (%) the plot should be extruded in range [0,100].
Type
number
Access
Read/Write
FlatShaded
Specifies whether discrete colours (flat shading) should be enabled or disabled for the plot.
Type
boolean
Access
Read/Write
GridVisible
Specifies whether the plot grid must be shown or hidden.
Type
boolean
Access
Read/Write
Opacity
Specify the plot opacity % in the range [0, 100].
Type
number
Access
Read/Write
Size
The custom size (m) of the plot. AutoSizingEnabled needs to be disabled for this property to take affect.
Type
number
Access
Read/Write
SizeFactor
The amount (%) the plot should be scaled in range [0,600].
Type
number
Access
Read/Write
SurfaceVisible
Specifies whether the plot surface must be shown or hidden.
Type
boolean
Access
Read/Write