SurfaceGraphAxisTitle

The graph axis title properties.

Example

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

    -- Edit 'SurfaceGraphAxisTitle' properties

graph.HorizontalAxis.Title.Caption = "Frequency measured in Gigahertz"
graph.HorizontalAxis.Title.CaptionIncludesUnit = false

Usage locations (object properties)

The following objects have properties using the SurfaceGraphAxisTitle object:

Property List

AutoCaptionEnabled
Specifies whether the automatic caption text of the graph axis must be used. (Read/Write boolean)
Caption
The caption of the graph axis. (Read/Write string)
CaptionIncludesUnit
Include the unit in the axis caption. (Read/Write boolean)
Font
The font format for the graph axis title. (Read only SurfaceGraphFontFormat)
Frame
The frame format for the graph axis title. (Read only SurfaceGraphFrameFormat)

Property Details

AutoCaptionEnabled
Specifies whether the automatic caption text of the graph axis must be used.
Type
boolean
Access
Read/Write
Caption
The caption of the graph axis.
Type
string
Access
Read/Write
CaptionIncludesUnit
Include the unit in the axis caption.
Type
boolean
Access
Read/Write
Font
The font format for the graph axis title.
Type
SurfaceGraphFontFormat
Access
Read only
Frame
The frame format for the graph axis title.
Type
SurfaceGraphFrameFormat
Access
Read only