`View3DLegendRangeFormat`

The view 3D legend range properties.

Example

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

    -- SetProperties the view's legend range properties using 'View3DLegendRangeFormat'
    
resultView.Legend.Rounded = false

Usage locations

The View3DLegendRangeFormat object can be accessed from the following locations:

Properties
- View object has property Legend.

Property List

Rounded: Round off legend range and step size. (Read/Write boolean)
ScaledToCommonQuantity: Scale legend range to visible results of the same quantity. (Read/Write boolean)
ScaledToPeakInstantaneousValues: Scale legend range to peak instantaneous values. (Read/Write boolean)
ScaledToSelectedDimensions: Scale legend range to request slice dimensions. (Read/Write boolean)
ScaledToSelectedFrequency: Scale legend range to selected frequency. (Read/Write boolean)
ScaledToSelectedTimeStep: Scale legend range to selected time step. (Read/Write boolean)
ScaledToVectorMagnitude: Scale legend range to vector magnitude. (Read/Write boolean)

Property Details

Rounded

Round off legend range and step size.

Type: boolean
Access: Read/Write

ScaledToCommonQuantity

Scale legend range to visible results of the same quantity.

Type: boolean
Access: Read/Write

ScaledToPeakInstantaneousValues

Scale legend range to peak instantaneous values.

Type: boolean
Access: Read/Write

ScaledToSelectedDimensions

Scale legend range to request slice dimensions.

Type: boolean
Access: Read/Write

ScaledToSelectedFrequency

Scale legend range to selected frequency.

Type: boolean
Access: Read/Write

ScaledToSelectedTimeStep

Scale legend range to selected time step.

Type: boolean
Access: Read/Write

ScaledToVectorMagnitude

Scale legend range to vector magnitude.

Type: boolean
Access: Read/Write