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
The TraceLegendFormat object can be accessed from the following locations:
- Properties
- CharacteristicModeTrace object has property Legend.
- CustomDataSmithTrace object has property Legend.
- CustomDataTrace object has property Legend.
- MathTrace object has property Legend.
- SpiceProbeTrace object has property Legend.
- FarFieldPowerIntegralTrace object has property Legend.
- NearFieldPowerIntegralTrace object has property Legend.
- TRCoefficientTrace object has property Legend.
- LoadSmithTrace object has property Legend.
- ExcitationSmithTrace object has property Legend.
- SARTrace object has property Legend.
- WireCurrentsTrace object has property Legend.
- SParameterTrace object has property Legend.
- PowerTrace object has property Legend.
- LoadTrace object has property Legend.
- ExcitationTrace object has property Legend.
- FarFieldTrace object has property Legend.
- NearFieldTrace object has property Legend.
- ReceivingAntennaTrace object has property Legend.
- NetworkTrace object has property Legend.
- ResultTrace object has property 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