ImplicitPointsAnnotation

A 2D graph implicit points annotation.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
app.Views[1]:Close()

    -- Add a Cartesian graph and far field trace
graph = app.CartesianGraphs:Add()
farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1])

    -- Configure the far field trace
farFieldTrace.IndependentAxis = farFieldTrace.IndependentAxesAvailable[3]
farFieldTrace:SetFixedAxisValue("Frequency", 7.85, "GHz")
farFieldTrace.Quantity.Component =
    pf.Enums.FarFieldQuantityComponentEnum.Theta
farFieldTrace:SetFixedAxisValue("Phi", 40, "deg")

    -- Zoom to extents
graph:ZoomToExtents()

    -- Add annotations
annotations = graph.Annotations
annotation1 = annotations:AddDerivedWidthAnnotation(farFieldTrace,
        pf.Enums.AnnotationRelativeTypeEnum.RelativeToGlobalMax,
        pf.Enums.AnnotationWidthDefinitionTypeEnum.Scale, 0.5)

Inheritance

The ImplicitPointsAnnotation object is derived from the GraphAnnotation object.

Property List

AnnotationRelativeType
For annotations that are relative to other graph positions, this values sets what it is relative to. (Read/Write AnnotationRelativeTypeEnum)
AutoTextEnabled
Toggle between auto text and custom annotation text. (Read/Write boolean)
Label
The object label. (Read/Write string)
Offset
The offset level. (Read/Write number)
OffsetType
The annotation offset type. (Read/Write AnnotationWidthDefinitionTypeEnum)
OffsetX
Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed automatically. (Read/Write number)
OffsetY
Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be placed automatically. (Read/Write number)
Text
The annotation text. (Read/Write string)
Trace
The ResultTrace of the annotation. (Read/Write ResultTrace)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the annotation.
Duplicate ()
Duplicate the annotation. (Returns a GraphAnnotation object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
GetValues ()
Get table of values associated with the annotation. (Returns a Map of string:Expression object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Property Details

AnnotationRelativeType
For annotations that are relative to other graph positions, this values sets what it is relative to.
Type
AnnotationRelativeTypeEnum
Access
Read/Write
AutoTextEnabled
Toggle between auto text and custom annotation text.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Offset
The offset level.
Type
number
Access
Read/Write
OffsetType
The annotation offset type.
Type
AnnotationWidthDefinitionTypeEnum
Access
Read/Write
OffsetX
Annotation text box offset (pixels) in the x-direction. A positive value moves the annotation to the right, a negative value moves it to the left. If both the OffsetX and OffsetY is zero, it will be placed automatically.
Type
number
Access
Read/Write
OffsetY
Annotation text box offset (pixels) in the y-direction. A positive value moves the annotation to the bottom, a negative value moves it to the top. If both the OffsetX and OffsetY is zero, it will be placed automatically.
Type
number
Access
Read/Write
Text
The annotation text.
Type
string
Access
Read/Write
Trace
The ResultTrace of the annotation.
Type
ResultTrace
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the annotation.
Duplicate ()
Duplicate the annotation.
Return
GraphAnnotation
The new annotation.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
GetValues ()
Get table of values associated with the annotation.
Return
Map of string:Expression
Table of key-value pairs.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.