MeshLegendFormat

The mesh legend properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
sConf = app.Models["startup"].Configurations[1]
view = app.Views[1]

    -- Show a legend at the top right corner with a custom title
    
view.MeshRendering.Legend.Position = pf.Enums.ViewLegendPositionEnum.TopRight
view.MeshRendering.Legend.AutoTextEnabled = false
view.MeshRendering.Legend.Text = "Custom legend title"

Usage locations (object properties)

The following objects have properties using the MeshLegendFormat object:

Property List

AutoTextEnabled
Specifies if the auto text of the mesh legend on the 3D view at the specified position should be enabled. (Read/Write boolean)
Position
The mesh legend position on the 3D view, specified by the ViewLegendPositionEnum, e.g. TopLeft, BottomLeft, etc. (Read/Write ViewLegendPositionEnum)
Text
The text of the mesh legend on the 3D view at the specified position. LegendAutoTextEnabled must be disabled for this setting to take affect. (Read/Write string)

Property Details

AutoTextEnabled
Specifies if the auto text of the mesh legend on the 3D view at the specified position should be enabled.
Type
boolean
Access
Read/Write
Position
The mesh 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 mesh legend on the 3D view at the specified position. LegendAutoTextEnabled must be disabled for this setting to take affect.
Type
string
Access
Read/Write