Plot3DLegendFormat
The 3D plot legend 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 farField.Legend.AutoTextEnabled = false farField.Legend.Text = "My custom legend title"
Usage locations (object properties)
The following objects have properties using the Plot3DLegendFormat object:
Property List
- AutoTextEnabled
- Specifies if the auto text of the legend on the 3D view at the specified position should be enabled. (Read/Write boolean)
- LinearRange
- The 3D plot legend linear range properties. (Read/Write Legend3DLinearRangeFormat)
- LogarithmicRange
- The 3D plot legend logarithmic range properties. (Read/Write Legend3DLogarithmicRangeFormat)
- Position
- The Result3DPlot legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. TopLeft, BottomLeft, etc. (Read/Write ViewLegendPositionEnum)
- Text
- The text of the legend on the 3D view at the specified position. LegendAutoTextEnabled must be disabled for this setting to take affect. (Read/Write string)
- UnitIncluded
- Specifies if the unit should be included in the legend on the 3D view at the specified position. (Read/Write boolean)
Property Details
- AutoTextEnabled
- Specifies if the auto text of the legend on the 3D view at the specified position should be enabled.
- Type
- boolean
- Access
- Read/Write
- LinearRange
- The 3D plot legend linear range properties.
- Type
- Legend3DLinearRangeFormat
- Access
- Read/Write
- LogarithmicRange
- The 3D plot legend logarithmic range properties.
- Type
- Legend3DLogarithmicRangeFormat
- Access
- Read/Write
- Position
- The Result3DPlot legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. TopLeft, BottomLeft, etc.
- Type
- ViewLegendPositionEnum
- Access
- Read/Write
- Text
- The text of the legend on the 3D view at the specified position. LegendAutoTextEnabled must be disabled for this setting to take affect.
- Type
- string
- Access
- Read/Write
- UnitIncluded
- Specifies if the unit should be included in the legend on the 3D view at the specified position.
- Type
- boolean
- Access
- Read/Write