AnnotationsToPlotArray object

The AnnotationsToPlotArray object is a sequence that stores references to plotted annotations. By adding annotations to and removing annotations from this sequence, you can control which annotations are displayed in a particular viewport.

The following topics are discussed:

Access
bringForward(...)
bringToFront(...)
moveAfter(...)
moveBefore(...)
sendBackward(...)
sendToBack(...)
Members

Access

import annotationToolset
session.viewports[name].annotationsToPlot

bringForward(...)

This method brings the Annotation object one position forward in the AnnotationsToPlotArray sequence.

Required arguments

index: An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

Optional arguments

None.

Return value

None.

Exceptions

None.

bringToFront(...)

This method brings the Annotation object to the beginning of the AnnotationsToPlotArray sequence.

Required arguments

index: An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

Optional arguments

None.

Return value

None.

Exceptions

None.

moveAfter(...)

This method moves the Annotation object after another object in the same AnnotationsToPlotArray sequence.

Required arguments

index: An Integer specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
other: An Integer specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence after which this object will be moved.

Optional arguments

None.

Return value

None.

Exceptions

None.

moveBefore(...)

This method moves the Annotation object before another object in the same AnnotationsToPlotArray sequence.

Required arguments

index: An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
other: An Int specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence before which this object will be moved.

Optional arguments

None.

Return value

None.

Exceptions

None.

sendBackward(...)

This method sends the Annotation object one position backward in the AnnotationsToPlotArray sequence.

Required arguments

index: An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

Optional arguments

None.

Return value

None.

Exceptions

None.

sendToBack(...)

This method sends the Annotation object to the end of the AnnotationsToPlotArray sequence.

Required arguments

index: An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

Optional arguments

None.

Return value

None.

Exceptions

None.

Members

The AnnotationsToPlotArray object has no members.