This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
AnnotationsToPlotArray.py
102 lines (78 loc) · 2.96 KB
/
AnnotationsToPlotArray.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
from .Annotation import Annotation
class AnnotationsToPlotArray(list[Annotation]):
"""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.
Notes
-----
This object can be accessed by:
.. code-block:: python
import annotationToolset
session.viewports[name].annotationsToPlot
"""
def bringForward(self, index: str):
"""This method brings the Annotation object one position forward in the
AnnotationsToPlotArray sequence.
Parameters
----------
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray
sequence.
"""
pass
def bringToFront(self, index: str):
"""This method brings the Annotation object to the beginning of the AnnotationsToPlotArray
sequence.
Parameters
----------
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray
sequence.
"""
pass
def moveAfter(self, index: str, other: str):
"""This method moves the Annotation object after another object in the same
AnnotationsToPlotArray sequence.
Parameters
----------
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.
"""
pass
def moveBefore(self, index: str, other: str):
"""This method moves the Annotation object before another object in the same
AnnotationsToPlotArray sequence.
Parameters
----------
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.
"""
pass
def sendBackward(self, index: str):
"""This method sends the Annotation object one position backward in the
AnnotationsToPlotArray sequence.
Parameters
----------
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray
sequence.
"""
pass
def sendToBack(self, index: str):
"""This method sends the Annotation object to the end of the AnnotationsToPlotArray
sequence.
Parameters
----------
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray
sequence.
"""
pass