Contours3DFormat

The 3D plot contours properties.

Example

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

    -- Show contour lines on a near field plot
    
nearField = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1])
nearField.Contours.Visible = true
nearField.Contours.Colour = "ByMagnitude"
nearField.Contours.Count = 5

Usage locations (object properties)

The following objects have properties using the Contours3DFormat object:

Property List

Colour
The colour of the contour lines. (Read/Write MagnitudeColour)
Count
Specify the number of contours to show for the plot in the range [0,100]. This value depends on Type to be set to the “SpecifyByCount” ContourTypeEnum. (Read/Write number)
Type
Method used to plot the contours specified by the ContourTypeEnum, e.g. SpecifyByCount or SpecifyByValue. (Read/Write ContourTypeEnum)
Values
The list of contour values used to plot the contours when ContourSpecifiedByType is set to SpecifyByValue. The format of the values is according to the ContourValuesType. (Read/Write List of Expression)
ValuesType
The type of the values of the contours when the ContourSpecifiedByType is set to SpecifyByValue. (Read/Write ContourValueTypeEnum)
Visible
Specifies whether the plot contours must be shown or hidden. (Read/Write boolean)

Property Details

Colour
The colour of the contour lines.
Type
MagnitudeColour
Access
Read/Write
Count
Specify the number of contours to show for the plot in the range [0,100]. This value depends on Type to be set to the “SpecifyByCount” ContourTypeEnum.
Type
number
Access
Read/Write
Type
Method used to plot the contours specified by the ContourTypeEnum, e.g. SpecifyByCount or SpecifyByValue.
Type
ContourTypeEnum
Access
Read/Write
Values
The list of contour values used to plot the contours when ContourSpecifiedByType is set to SpecifyByValue. The format of the values is according to the ContourValuesType.
Access
Read/Write
ValuesType
The type of the values of the contours when the ContourSpecifiedByType is set to SpecifyByValue.
Type
ContourValueTypeEnum
Access
Read/Write
Visible
Specifies whether the plot contours must be shown or hidden.
Type
boolean
Access
Read/Write