mpl.legend.TextArea¶
-
class
mpl.legend.TextArea(s, textprops=None, multilinebaseline=None, minimumdescent=True)[source]¶ The TextArea is contains a single Text instance. The text is placed at (0,0) with baseline+left alignment. The width and height of the TextArea instance is the width and height of the its child text.
-
__init__(s, textprops=None, multilinebaseline=None, minimumdescent=True)[source]¶ Parameters: s : str
a string to be displayed.
textprops : ~matplotlib.font_manager.FontProperties, optional
multilinebaseline : bool, optional
If True, baseline for multiline text is adjusted so that it is (approximatedly) center-aligned with singleline text.
minimumdescent : bool, optional
If True, the box has a minimum descent of “p”.
-
Methods¶
__init__(s[, textprops, multilinebaseline, ...]) |
|
||
add_callback(func) |
Adds a callback function that will be called whenever one of the Artist‘s properties changes. |
||
contains(mouseevent) |
|||
convert_xunits(x) |
For artists in an axes, if the xaxis has units support, | ||
convert_yunits(y) |
For artists in an axes, if the yaxis has units support, | ||
draw(renderer) |
Draw the children | ||
findobj([match, include_self]) |
Find artist objects. | ||
format_cursor_data(data) |
Return cursor data string formatted. | ||
get_agg_filter() |
return filter function to be used for agg filter | ||
get_alpha() |
Return the alpha value used for blending - not supported on all | ||
get_animated() |
Return the artist’s animated state | ||
get_axes() |
Return the Axes instance the artist resides in, or None. |
||
get_children() |
Return a list of artists it contains. | ||
get_clip_box() |
Return artist clipbox | ||
get_clip_on() |
Return whether artist uses clipping | ||
get_clip_path() |
Return artist clip path | ||
get_contains() |
Return the _contains test used by the artist, or None for default. | ||
get_cursor_data(event) |
Get the cursor data for a given event. | ||
get_extent(renderer) |
|||
get_extent_offsets(renderer) |
|||
get_figure() |
Return the Figure instance the artist belongs to. |
||
get_gid() |
Returns the group id | ||
get_label() |
Get the label used for this artist in the legend. | ||
get_minimumdescent() |
get minimumdescent. | ||
get_multilinebaseline() |
get multilinebaseline . | ||
get_offset() |
return offset of the container. | ||
get_path_effects() |
|||
get_picker() |
Return the picker object used by this artist | ||
get_rasterized() |
return True if the artist is to be rasterized | ||
get_sketch_params() |
Returns the sketch parameters for the artist. | ||
get_snap() |
Returns the snap setting which may be: | ||
get_text() |
get text | ||
get_transform() |
Return the Transform instance used by this artist. |
||
get_transformed_clip_path_and_affine() |
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation. | ||
get_url() |
Returns the url | ||
get_visible() |
Return the artist’s visiblity | ||
get_visible_children() |
Return a list of visible artists it contains. | ||
get_window_extent(renderer) |
get the bounding box in display space. | ||
get_zorder() |
Return the Artist‘s zorder. |
||
have_units() |
Return True if units are set on the x or y axes | ||
hitlist(event) |
List the children of the artist which contain the mouse event event. | ||
is_figure_set() |
Returns True if the artist is assigned to a Figure. |
||
is_transform_set() |
Returns True if Artist has a transform explicitly set. |
||
pchanged() |
Fire an event when property changed, calling all of the registered callbacks. | ||
pick(mouseevent) |
call signature: | ||
pickable() |
Return True if Artist is pickable. |
||
properties() |
return a dictionary mapping property name -> value for all Artist props | ||
remove() |
Remove the artist from the figure if possible. | ||
remove_callback(oid) |
Remove a callback based on its id. | ||
set(**kwargs) |
A property batch setter. | ||
set_agg_filter(filter_func) |
set agg_filter fuction. | ||
set_alpha(alpha) |
Set the alpha value used for blending - not supported on all backends. | ||
set_animated(b) |
Set the artist’s animation state. | ||
set_axes(axes) |
Set the Axes instance in which the artist resides, if any. |
||
set_clip_box(clipbox) |
Set the artist’s clip Bbox. |
||
set_clip_on(b) |
Set whether artist uses clipping. | ||
set_clip_path(path[, transform]) |
Set the artist’s clip path, which may be: | ||
set_contains(picker) |
Replace the contains test used by this artist. | ||
set_figure(fig) |
Set the figure | ||
set_gid(gid) |
Sets the (group) id for the artist | ||
set_height(height) |
Set the height | ||
set_label(s) |
Set the label to s for auto legend. | ||
set_minimumdescent(t) |
Set minimumdescent . | ||
set_multilinebaseline(t) |
Set multilinebaseline . | ||
set_offset(xy) |
set offset of the container. | ||
set_path_effects(path_effects) |
set path_effects, which should be a list of instances of | ||
set_picker(picker) |
Set the epsilon for picking used by this artist | ||
set_rasterized(rasterized) |
Force rasterized (bitmap) drawing in vector backend output. | ||
set_sketch_params([scale, length, randomness]) |
Sets the sketch parameters. | ||
set_snap(snap) |
Sets the snap setting which may be: | ||
set_text(s) |
set text | ||
set_transform(t) |
set_transform is ignored. | ||
set_url(url) |
Sets the url for the artist | ||
set_visible(b) |
Set the artist’s visiblity. | ||
set_width(width) |
Set the width | ||
set_zorder(level) |
Set the zorder for the artist. | ||
update(props) |
Update the properties of this Artist from the dictionary prop. |
||
update_from(other) |
Copy properties from other to self. |