- matplotlib.pyplot.annotate(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[source]#
Annotate the point xy with text text.
In the simplest form, the text is placed at xy.
Optionally, the text can be displayed in another position xytext. An arrow pointing from the text to the annotated point xy can then be added by defining arrowprops.
The text of the annotation.
- xy(float, float)
The point (x, y) to annotate. The coordinate system is determined by xycoords.
- xytext(float, float), default: xy
The position (x, y) to place the text at. The coordinate system is determined by textcoords.
- xycoordssingle or two-tuple of str or
Transformor callable, default: 'data'
The coordinate system that xy is given in. The following types of values are supported:
One of the following strings:
Points from the lower left of the figure
Pixels from the lower left of the figure
Fraction of figure from lower left
Points from the lower left of the subfigure
Pixels from the lower left of the subfigure
Fraction of subfigure from lower left
Points from lower left corner of axes
Pixels from lower left corner of axes
Fraction of axes from lower left
Use the coordinate system of the object being annotated (default)
(theta, r) if not native 'data' coordinates
Note that 'subfigure pixels' and 'figure pixels' are the same for the parent figure, so users who want code that is usable in a subfigure can use 'subfigure pixels'.
Artist: xy is interpreted as a fraction of the artist's
Bbox. E.g. (0, 0) would be the lower left corner of the bounding box and (0.5, 1) would be the center top of the bounding box.
Transformto transform xy to screen coordinates.
A function with one of the following signatures:
def transform(renderer) -> Bbox def transform(renderer) -> Transform
where renderer is a
The result of the function is interpreted like the
A tuple (xcoords, ycoords) specifying separate coordinate systems for x and y. xcoords and ycoords must each be of one of the above described types.
See Advanced annotation for more details.
- textcoordssingle or two-tuple of str or
Transformor callable, default: value of xycoords
The coordinate system that xytext is given in.
All xycoords values are valid as well as the following strings:
Offset (in points) from the xy value
Offset (in pixels) from the xy value
- arrowpropsdict, optional
The properties used to draw a
FancyArrowPatcharrow between the positions xy and xytext. Defaults to None, i.e. no arrow is drawn.
For historical reasons there are two different ways to specify arrows, "simple" and "fancy":
If arrowprops does not contain the key 'arrowstyle' the allowed keys are:
The width of the arrow in points
The width of the base of the arrow head in points
The length of the arrow head in points
Fraction of total length to shrink from both ends
Any key to
The arrow is attached to the edge of the text box, the exact position (corners or centers) depending on where it's pointing to.
This is used if 'arrowstyle' is provided in the arrowprops.
Valid keys are the following
the arrow style
the connection style
see below; default is (0.5, 0.5)
default is bounding box of the text
default is None
default is 2 points
default is 2 points
default is text size (in points)
default is 1.
any key for
The exact starting point position of the arrow is defined by relpos. It's a tuple of relative coordinates of the text box, where (0, 0) is the lower left corner and (1, 1) is the upper right corner. Values <0 and >1 are supported and specify points outside the text box. By default (0.5, 0.5), so the starting point is centered in the text box.
- annotation_clipbool or None, default: None
Whether to clip (i.e. not draw) the annotation when the annotation point xy is outside the axes area.
If True, the annotation will be clipped when xy is outside the axes.
If False, the annotation will always be drawn.
If None, the annotation will be clipped when xy is outside the axes and xycoords is 'data'.
Additional kwargs are passed to