GraphAnnotation
A 2D graph annotation.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) app.Views[1]:Close() -- Add a Cartesian graph to the application's collection and obtain -- the arrow collection graph = app.CartesianGraphs:Add() farFieldTrace = graph.Traces:Add(app.Models[1].Configurations[1].FarFields[1]) graph:ZoomToExtents() annotations = graph.Annotations annotation1 = annotations:AddGlobalMaximum(farFieldTrace) annotation2 = annotation1:Duplicate() annotation1:Delete()
Inheritance
The following objects are derived (specialisations) from the GraphAnnotation object:
Usage locations
The GraphAnnotation object can be accessed from the following locations:
- Methods
- WidthAnnotation object has method Duplicate().
- SimpleAnnotation object has method Duplicate().
- ImplicitPointsAnnotation object has method Duplicate().
- BeamwidthAnnotation object has method Duplicate().
- BandwidthAnnotation object has method Duplicate().
- GraphAnnotation object has method Duplicate().
- ResultAnnotationCollection collection has method Items().
- ResultAnnotationCollection collection has method Item(number).
- ResultAnnotationCollection collection has method Item(string).
- ResultAnnotationCollection collection has method AddGlobalMaximum(ResultTrace).
- ResultAnnotationCollection collection has method AddGlobalMinimum(ResultTrace).
- ResultAnnotationCollection collection has method AddFirstLocalMaximum(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddFirstLocalMaximumToLeft(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddFirstLocalMaximumToRight(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMaximum(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMaximumToLeft(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMaximumToRight(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddFirstLocalMinimum(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddFirstLocalMinimumToLeft(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddFirstLocalMinimumToRight(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMinimum(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMinimumToLeft(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddGreatestLocalMinimumToRight(ResultTrace, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddValueAtHorizontalPosition(ResultTrace, number).
- ResultAnnotationCollection collection has method AddIndependentValue(ResultTrace, number, number).
- ResultAnnotationCollection collection has method AddBandwidthAnnotation(ResultTrace, AnnotationBandwidthTypeEnum, number).
- ResultAnnotationCollection collection has method AddBandwidth3dBAnnotation(ResultTrace, AnnotationBandwidthTypeEnum).
- ResultAnnotationCollection collection has method AddBandwidth10dBAnnotation(ResultTrace, AnnotationBandwidthTypeEnum).
- ResultAnnotationCollection collection has method AddBandwidth15dBAnnotation(ResultTrace, AnnotationBandwidthTypeEnum).
- ResultAnnotationCollection collection has method AddBeamwidthAnnotation(ResultTrace, AnnotationBeamwidthTypeEnum, AnnotationRelativeTypeEnum).
- ResultAnnotationCollection collection has method AddHalfPowerBeamwidthAnnotation(ResultTrace).
- ResultAnnotationCollection collection has method AddFirstNullBeamwidthAnnotation(ResultTrace).
- ResultAnnotationCollection collection has method AddNullToNullBeamwidthAnnotation(ResultTrace).
- ResultAnnotationCollection collection has method AddDerivedWidthAnnotation(ResultTrace, AnnotationRelativeTypeEnum, AnnotationWidthDefinitionTypeEnum, number).
- ResultAnnotationCollection collection has method AddSideLobeLevelAnnotation(ResultTrace).
- ResultAnnotationCollection collection has method AddDeltaAnnotation(ResultTrace).
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)
- 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)
Method List
- Delete ()
- Delete the annotation.
- Duplicate ()
- Duplicate the annotation. (Returns a GraphAnnotation object.)
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
- 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
Method Details
- Delete ()
- Delete the annotation.
- Duplicate ()
- Duplicate the annotation.
- Return
- GraphAnnotation
- The new annotation.