RequestPoints3DFormat

The 3D plot request points properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])    
nearFieldPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1])

    -- Adjust 'RequestPoints3DFormat' of the plot 

nearFieldPlot.RequestPoints.DisplayType = pf.Enums.RequestPointsDisplayTypeEnum.On
nearFieldPlot.RequestPoints.VisualisationType = pf.Enums.RequestsVisualisationTypeEnum.Lines

Usage locations (object properties)

The following objects have properties using the RequestPoints3DFormat object:

Property List

Colour
The colour of the request points. (Read/Write Colour)
DisplayType
Control the request points display specified by the RequestPointsDisplayTypeEnum, e.g. Auto, On or Off. (Read/Write RequestPointsDisplayTypeEnum)
MarkerSize
Specify the marker size for request points in the range [0.0, 2.0]. (Read/Write number)
VisualisationType
How the request points should be visualised specified by the RequestPointsVisualisationTypeEnum, e.g. Points, Lines or Surface. (Read/Write RequestsVisualisationTypeEnum)

Property Details

Colour
The colour of the request points.
Type
Colour
Access
Read/Write
DisplayType
Control the request points display specified by the RequestPointsDisplayTypeEnum, e.g. Auto, On or Off.
Type
RequestPointsDisplayTypeEnum
Access
Read/Write
MarkerSize
Specify the marker size for request points in the range [0.0, 2.0].
Type
number
Access
Read/Write
VisualisationType
How the request points should be visualised specified by the RequestPointsVisualisationTypeEnum, e.g. Points, Lines or Surface.
Type
RequestsVisualisationTypeEnum
Access
Read/Write