Legend3DLinearRangeFormat

The 3D plot legend linear range properties.

Example

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

farField.Legend.LinearRange.Type = pf.Enums.LinearScaleRangeTypeEnum.Fixed
farField.Legend.LinearRange.FixedRangeMin = 0.8
farField.Legend.LinearRange.FixedRangeMax = 3.2

Usage locations (object properties)

The following objects have properties using the Legend3DLinearRangeFormat object:

Property List

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

Property Details

FixedRangeMax
Specify the linear scale maximum value for the fixed range of the plot legend.
Type
number
Access
Read/Write
FixedRangeMin
Specify the linear scale minimum value for the fixed range of the plot legend.
Type
number
Access
Read/Write
Type
Method by which the linear scale range limits should be determined, specified by the LinearScaleRangeTypeEnum, e.g. Auto or Fixed.
Type
LinearScaleRangeTypeEnum
Access
Read/Write