yampex.textbox.TextBoxMaker(object) class documentation
Part of yampex.textbox
(View In Hierarchy)
I make one or more text boxes for a subplot Axes object or
an entire Figure.
Construct an instance with a Matplotlib Axes object and, to
add the textbox to a subplot instead of the whole figure, two more args:
The number of columns and rows in the subplot.
Any keywords you supply to my constructor are used in the textbox, with the exception of m.
| Parameters | DPI | The dots per inch of the figure the text box will be going into. |
| m | The margin between the text box and the edge of the figure. If a float, relative to figure or subplot dimensions. If an int, in pixels; requires fDims to be supplied. (Default: 0.02) | |
| fDims | A 2-sequence containing the figure dimensions in pixels. | |
| alpha | The alpha (opacity) of the text box background. (Default: 0.8) | |
| backgroundcolor | The background color of the text box. (Default: white) |
| Instance Variable | tList | A list of the Matplotlib text objects I have created. |
| Method | __init__ | Undocumented |
| Method | conformLocation | Undocumented |
| Method | get_XY | Returns a 2-list with the center position of the annotation, as a fraction of my axes or figure dimensions. |
| Method | __call__ | Undocumented |
| Method | remove | Removes my text object from the figure, catching the exception raised if it's not there. |