AnnoManager class resource descriptions
-
amOn
-
This boolean resource specifies whether the base plot should draw the
annotation View object along with the other objects
comprising the plot.
Default: True
-
amViewId
-
You can use this resource to retrieve the id of the View
object controlled by the AnnoManager. Note that this
resource can be set only when the AnnoManager object
is created.
Default: <dynamic>
-
amResizeNotify
-
If this boolean resource is True, the PlotManager
sets the height and width of the annotation item whenever the size of
the base plot's viewport changes. Height is adjusted based on the
ratio of the new viewport height to the old height. Width is adjusted
based on the ratio of the new viewport width to the old width.
Default: False
-
amTrackData
-
When amTrackData is set False, the PlotManager
locates the annotation View object in NDC
space using the PlotManager Location
Control Model resources amZone, amSide,
amParallelPosF, amOthogonalPosF and
amJust. If amTrackData is True, the annotation is
positioned relative to the data coordinate space of the
base plot. In this case, the
PlotManager determines the base position of the
annotation item from the values of the resources amDataXF and
amDataYF. The resources amZone, amSide,
amParallelPosF, and amOthogonalPosF are ignored.
However, the resource amJust still determines the
justification point of the annotation with respect to its base
location.
Default: False
-
amZone
-
If amTrackData is False, amZone specifies the
PlotManager zone assigned to the annotation.
amZone is one of the resources you must set in order to
control the location of the annotation in a manner consistent with the
rules of the PlotManager Location
Control Model. If amZone is set to 0, the annotation is
located relative to the center of the PlotManager
viewport; otherwise, it is located relative to one side of the zone's
interior boundary, which is the bounding box of the previous zone.
Default: 0
-
amSide
-
If amTrackData is False, this resource of type NhlTPosition determines which of the
zone's interior sides to use as a base for establishing the coordinate
system within which the annotation is placed. The PlotManager Location
Control Model requires this resource to allow control of the
annotation in a manner consistent with other annotations. Its
value determines the origin of the coordinate system and the direction
of the positional resources, amParallelPosF and
amOrthogonalPosF. It also constrains the value of
amJust appropriately. There are four settings, which behave
as follows, unless amZone is set to one of the special zones
(0 or 1):
- NhlTOP
- The PlotManager locates the annotation relative
to a line paralleling the top viewport boundary.
amOrthogonalPosF increases in the direction of increasing NDC
Y-Axis values and is constrained to positive values.
amParallelPosF increases in the direction of increasing NDC
X-Axis values. amJust is constrained to NhlBOTTOMRIGHT,
NhlBOTTOMCENTER, or NhlBOTTOMLEFT.
- NhlBOTTOM
- The PlotManager locates the annotation relative
to a line paralleling the bottom viewport boundary.
amOrthogonalPosF increases in the direction of decreasing NDC
Y-Axis values and is constrained to positive values.
amParallelPosF increases in the direction of increasing NDC
X-Axis values. amJust is constrained to NhlTOPRIGHT,
NhlTOPCENTER, or NhlTOPLEFT.
- NhlRIGHT
- The PlotManager locates the annotation relative
to a line paralleling the right viewport boundary.
amOrthogonalPosF increases in the direction of increasing NDC
X-Axis values and is constrained to positive values.
amParallelPosF increases in the direction of increasing NDC
Y-Axis values. amJust is constrained to NhlTOPLEFT,
NhlCENTERLEFT, or NhlBOTTOMLEFT.
- NhlLEFT
- The PlotManager locates the annotation item
relative to a line paralleling the left viewport boundary.
amOrthogonalPosF increases in the direction of decreasing NDC
X-Axis values and is constrained to positive values.
amParallelPosF increases in the direction of increasing NDC
Y-Axis values. amJust is constrained to NhlTOPRIGHT,
NhlCENTERRIGHT, or NhlBOTTOMRIGHT.
If amZone is set to 0, the
PlotManager locates the annotation item relative to
the viewport center. If amZone is 1, the annotation
is located relative to the viewport boundary itself, and the direction
of the amOrthogonalPosF is opposite to the specification
given above. Also if the amZone is either 0 or 1,
amJust is not constrained, and amOrthogonalPosF may
take on negative values.
Default: Bottom
-
amParallelPosF
-
If amTrackData is False, amParallelPosF specifies
the coordinate of the base location of the annotation parallel to
the current amSide and directed toward increasing NDC
values. The PlotManager Location
Control Model requires this resource to allow control of the
annotation in a manner consistent with other annotations.
Default: 0.0
-
amOrthogonalPosF
-
If amTrackData is False and amZone is not equal to
one, amOrthogonalPosF sets the coordinate of the base
location of the annotation orthogonal to the current amSide
and directed away from the center of the PlotManager
viewport. If amZone is equal to one, the direction
is from the viewport side specified by amSide
toward the viewport center. The PlotManager
Location Control Model requires this resource to allow control of
the annotation in a manner consistent with other annotations.
Default: 0.0
-
amJust
-
This resource of type NhlTJustification, after
constraint to an appropriate value based on amSide, sets the
justification point of the annotation with respect to its base
location. The PlotManager
Location Control Model requires this resource to allow control of
the annotation in a manner consistent with other annotations. Note
that amJust still has an effect when amTrackData is
True. Normally, amJust is constrained based on the value of
amSide. However, if amZone is 0 or 1, or
amTrackData is True, the PlotManager does
not constrain amJust.
Note in addition that the position of the justification point is
determined from the viewport of the annotation View
object only. That is to say, while it is possible that
View object's bounding box might be larger than its
viewport, any extent outside the viewport is not considered when
determining the justification point. This means that that there is the
possibility of overlap if a View object has elements
extending outside its own viewport along the edge closest to the
PlotManager Plot viewport.
Default: CenterCenter
-
amDataXF
-
When amTrackData is True, amDataXF sets the X coordinate
of the annotation item's base location.
Default: 0.0
-
amDataYF
-
When amTrackData is True, amDataYF sets the Y coordinate
of the annotation item's base location.
Default: 0.0
Reference Manual Control Panel
NG4.1 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?
$Revision: 1.11 $ $Date: 1999/04/09 17:22:15 $