matplotlib.pyplot.text#

matplotlib.pyplot.text(x,y,s,fontdict=None,**kwargs)[source]#

Add text to the Axes.

Add the texts to the Axes at locationx,y in data coordinates,with a defaulthorizontalalignment on theleft andverticalalignment at thebaseline. SeeText alignment.

Parameters:
x, yfloat

The position to place the text. By default, this is in datacoordinates. The coordinate system can be changed using thetransform parameter.

sstr

The text.

fontdictdict, default: None

Discouraged

The use offontdict is discouraged. Parameters should be passed asindividual keyword arguments or using dictionary-unpackingtext(...,**fontdict).

A dictionary to override the default text properties. If fontdictis None, the defaults are determined byrcParams.

Returns:
Text

The createdText instance.

Other Parameters:
**kwargsText properties.

Other miscellaneous text parameters.

Property

Description

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

animated

bool

antialiased

bool

backgroundcolor

color

bbox

dict with properties forpatches.FancyBboxPatch

clip_box

unknown

clip_on

unknown

clip_path

unknown

color orc

color

figure

Figure orSubFigure

fontfamily orfamily orfontname

{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

fontproperties orfont orfont_properties

font_manager.FontProperties orstr orpathlib.Path

fontsize orsize

float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

fontstretch orstretch

{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}

fontstyle orstyle

{'normal', 'italic', 'oblique'}

fontvariant orvariant

{'normal', 'small-caps'}

fontweight orweight

{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}

gid

str

horizontalalignment orha

{'left', 'center', 'right'}

in_layout

bool

label

object

linespacing

float (multiple of font size)

math_fontfamily

str

mouseover

bool

multialignment orma

{'left', 'right', 'center'}

parse_math

bool

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

(float, float)

rasterized

bool

rotation

float or {'vertical', 'horizontal'}

rotation_mode

{None, 'default', 'anchor'}

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

text

object

transform

Transform

transform_rotates_text

bool

url

str

usetex

bool, default:rcParams["text.usetex"] (default:False)

verticalalignment orva

{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

visible

bool

wrap

bool

x

float

y

float

zorder

float

Notes

Note

This is thepyplot wrapper foraxes.Axes.text.

Examples

Individual keyword arguments can be used to override any givenparameter:

>>>text(x,y,s,fontsize=12)

The default transform specifies that text is in data coords,alternatively, you can specify text in axis coords ((0, 0) islower-left and (1, 1) is upper-right). The example below placestext in the center of the Axes:

>>>text(0.5,0.5,'matplotlib',horizontalalignment='center',...verticalalignment='center',transform=ax.transAxes)

You can put a rectangular box around the text instance (e.g., toset a background color) by using the keywordbbox.bbox isa dictionary ofRectangleproperties. For example:

>>>text(x,y,s,bbox=dict(facecolor='red',alpha=0.5))

Examples usingmatplotlib.pyplot.text#

Close event

Close event

transforms.offset_copy

transforms.offset_copy

Text and mathtext using pyplot

Text and mathtext using pyplot

Anscombe's quartet

Anscombe's quartet

Figure size in different units

Figure size in different units

Auto-wrap text

Auto-wrap text

Text rotation mode

Text rotation mode

Styling text boxes

Styling text boxes

Controlling style of text and labels using a dictionary

Controlling style of text and labels using a dictionary

Pyplot tutorial

Pyplot tutorial

Path effects guide

Path effects guide