SurfacePlotLegendLogarithmicRangeFormat

The surface plot legend logarithmic range properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
graph = app.CartesianSurfaceGraphs:Add()
farFieldPlot = graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1])
    
    -- SetProperties legend logarithmic range

farFieldPlot.Legend.LogarithmicRange.Type = pf.Enums.LogScaleRangeTypeEnum.Auto

Usage locations

The SurfacePlotLegendLogarithmicRangeFormat object can be accessed from the following locations:

Property List

DynamicRangeMax
Specify the log scale maximum value in dB for the dynamic range of the plot legend. (Read/Write number)
FixedRangeMax
Specify the log scale maximum value in dB for the fixed range of the plot legend. (Read/Write number)
FixedRangeMin
Specify the log scale minimum value in dB for the fixed range of the plot legend. (Read/Write number)
Type
Method by which the log scale range limits should be determined, specified by LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed. (Read/Write LogScaleRangeTypeEnum)

Property Details

DynamicRangeMax
Specify the log scale maximum value in dB for the dynamic range of the plot legend.
Type
number
Access
Read/Write
FixedRangeMax
Specify the log scale maximum value in dB for the fixed range of the plot legend.
Type
number
Access
Read/Write
FixedRangeMin
Specify the log scale minimum value in dB for the fixed range of the plot legend.
Type
number
Access
Read/Write
Type
Method by which the log scale range limits should be determined, specified by LogScaleRangeTypeEnum, e.g. Auto, Max or Fixed.
Type
LogScaleRangeTypeEnum
Access
Read/Write