TraceLegendFormat
The trace legend properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) cartesianGraph = app.CartesianGraphs:Add() trace = cartesianGraph.Traces:Add(app.Models[1].Configurations[1].NearFields[1]) -- Set 'TraceLegendFormat' properties trace.Legend.AutoTextEnabled = false trace.Legend.Text = "My custom trace legend"
Usage locations (object properties)
The following objects have properties using the TraceLegendFormat object:
- CharacteristicModeTrace(.Legend)
- CustomDataSmithTrace(.Legend)
- CustomDataTrace(.Legend)
- MathTrace(.Legend)
- SpiceProbeTrace(.Legend)
- FarFieldPowerIntegralTrace(.Legend)
- NearFieldPowerIntegralTrace(.Legend)
- TRCoefficientTrace(.Legend)
- LoadSmithTrace(.Legend)
- ExcitationSmithTrace(.Legend)
- SARTrace(.Legend)
- WireCurrentsTrace(.Legend)
- SParameterTrace(.Legend)
- PowerTrace(.Legend)
- LoadTrace(.Legend)
- ExcitationTrace(.Legend)
- FarFieldTrace(.Legend)
- NearFieldTrace(.Legend)
- ReceivingAntennaTrace(.Legend)
- NetworkTrace(.Legend)
- ResultTrace(.Legend)
Property List
- AutoTextEnabled
- Specifies whether the automatic legend text must be used in the legend. (Read/Write boolean)
- LegendEntryVisible
- Specifies whether the trace entry must be visible in the legend. (Read/Write boolean)
- Text
- The text used for the trace in the legend. (Read/Write string)
- UseTraceLabelText
- Specifies whether the trace label text must be used in the legend. (Read/Write boolean)
Property Details
- AutoTextEnabled
- Specifies whether the automatic legend text must be used in the legend.
- Type
- boolean
- Access
- Read/Write
- LegendEntryVisible
- Specifies whether the trace entry must be visible in the legend.
- Type
- boolean
- Access
- Read/Write
- Text
- The text used for the trace in the legend.
- Type
- string
- Access
- Read/Write
- UseTraceLabelText
- Specifies whether the trace label text must be used in the legend.
- Type
- boolean
- Access
- Read/Write