matplotlib.text

Классы для включения текста в рисунок.

classmatplotlib.text.Text(x=0, y=0, text='', *, color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, transform_rotates_text=False, parse_math=None, **kwargs)[source]

Bases: Artist

Обработчик хранения и отрисовки текста в координатах окна или данных.

Создает экземпляр Text в точке x, y со строкой text.

Текст выравнивается относительно точки привязки (x, y) в соответствии с horizontalalignment (по умолчанию: 'слева') и verticalalignment (по умолчанию: 'вниз'). См. также Выравнивание текста.

Хотя Text принимает ключевое слово 'label', по умолчанию оно не добавляется к элементам легенды.

Допустимы следующие ключевые параметры:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	логическое значение
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family	{ШРИФТ, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	число с плавающей точкой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне от 0 до 1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне от 0 до 1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment` или ha	{'left', 'center', 'right'}
`in_layout`	логическое значение
`label`	объект
`linespacing`	вещественное число (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	логическое значение
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	логическое значение
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемый объект
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	логическое значение
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	логическое значение или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	логическое значение
`url`	строка
`usetex`	логическое значение или None
`verticalalignment` или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`visible`	логическое значение
`wrap`	логическое значение
`x`	число с плавающей точкой
`y`	число с плавающей точкой

zorder

вещественное число

contains(mouseevent)[source]: Возвращает значение, определяющее, произошло ли событие мыши внутри прямоугольной области текста.

draw(renderer)[source]

Отрисовывает элемент (и его дочерние элементы) с помощью данного рендерера.

Это не оказывает никакого влияния, если элемент невидим (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах элементов.

get_bbox_patch()[source]: Возвращает объект Patch для области, или None, если объект patches.FancyBboxPatch не создан.

get_c()[source]: Псевдоним для get_color.

get_color()[source]: Возвращает цвет текста.

get_family()[source]: Псевдоним для get_fontfamily.

get_font()[source]: Псевдоним для get_fontproperties.

get_font_properties()[source]: Псевдоним для get_fontproperties.

get_fontfamily()[source]

Возвращает список шрифтов, используемых для поиска шрифта.

См. также

font_manager.FontProperties.get_family

get_fontname()[source]

Возвращает имя шрифта в виде строки.

См. также

font_manager.FontProperties.get_name

get_fontproperties()[source]: Возвращает font_manager.FontProperties.

get_fontsize()[source]

Возвращает размер шрифта как целое число.

См. также

font_manager.FontProperties.get_size_in_points

get_fontstyle()[source]

Возвращает стиль шрифта в виде строки.

См. также

font_manager.FontProperties.get_style

get_fontvariant()[source]

Возвращает вариант шрифта в виде строки.

См. также

font_manager.FontProperties.get_variant

get_fontweight()[source]

Возвращает толщину шрифта в виде строки или числа.

См. также

font_manager.FontProperties.get_weight

get_ha()[source]: Псевдоним для get_horizontalalignment.

get_horizontalalignment()[source]: Возвращает выравнивание по горизонтали в виде строки. Будет 'left', 'center' или 'right'.

get_math_fontfamily()[source]

Возвращает имя семейства шрифтов для математического текста, отрисованного Matplotlib.

Значение по умолчанию равно rcParams["mathtext.fontset"] (по умолчанию: 'dejavusans').

См. также

set_math_fontfamily

get_name()[source]: Псевдоним для get_fontname.

get_parse_math()[source]: Возвращает, включена ли обработка mathtext для этого Text.

get_position()[source]: Возвращает позицию текста (x, y).

get_prop_tup(renderer=None)[source]

[Устарело] Возвращает хешируемую кортеж свойств.

Не предназначен для чтения человеком, но полезен для бэкэндов, которые хотят кэшировать производственную информацию о тексте (например, макеты) и должны знать, изменился ли текст.

Примечания

Устарело начиная с версии 3.5.

get_rotation()[source]: Возвращает угол наклона текста в градусах в диапазоне от 0 до 360.

get_rotation_mode()[source]: Возвращает режим поворота текста.

get_size()[source]: Псевдоним для get_fontsize.

get_stretch()[source]

Возвращает расширение шрифта в виде строки или числа.

См. также

font_manager.FontProperties.get_stretch

get_style()[source]: Псевдоним для get_fontstyle.

get_text()[source]: Возвращает строку текста.

get_transform_rotates_text()[source]: Возвращает, влияют ли повороты преобразования на направление текста.

get_unitless_position()[source]: Возвращает безразмерную позицию текста (x, y).

get_usetex()[source]: Возвращает, использует ли этот объект Text TeX для отрисовки.

get_va()[source]: Псевдоним для get_verticalalignment.

get_variant()[source]: Псевдоним для get_fontvariant.

get_verticalalignment()[source]: Возвращает вертикальное выравнивание в виде строки. Будет одним из 'top', 'center', 'bottom', 'baseline' или 'center_baseline'.

get_weight()[source]: Псевдоним для get_fontweight.

get_window_extent(renderer=None, dpi=None)[source]

Возвращает Bbox прямоугольник, ограничивающий текст, в единицах отображения.

Помимо внутреннего использования, это полезно для задания нажатых областей в файле png на веб-странице.

Параметры:

rendererRenderer, необязательно: Для вычисления ограничивающей рамки требуется рендерер. Если элемент уже нарисован, рендерер кэшируется; таким образом, передавать этот аргумент необходимо только при вызове get_window_extent до первого рисования. На практике обычно проще сначала вызвать отрисовку, например, вызвав draw_without_rendering или plt.show().
dpifloat, необязательно: Значение dpi для вычисления прямоугольника, по умолчанию self.figure.dpi (не dpi рендерера); необходимо установить, например, для сопоставления областей с изображением фигуры, сохранённой с пользовательским значением dpi.

get_wrap()[source]: Возвращает, можно ли переносить текст.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (m, n, 3) чисел с плавающей запятой и значение dpi, и возвращает массив (m, n, 3) и два смещения от левого нижнего угла изображения
`alpha`	скаляр или None
`animated`	булево значение
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color`	цвет
`figure`	`Figure`
`fontfamily`	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties`	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize`	число с плавающей запятой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch`	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle`	{'normal', 'italic', 'oblique'}
`fontvariant`	{'normal', 'small-caps'}
`fontweight`	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment`	{'left', 'center', 'right'}
`in_layout`	булево значение
`label`	объект
`linespacing`	число с плавающей запятой (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	булево значение
`multialignment`	{'left', 'right', 'center'}
`parse_math`	булево значение
`path_effects`	`AbstractPathEffect`
`picker`	None или булево значение или число с плавающей запятой или вызываемый объект
`position`	(число с плавающей запятой, число с плавающей запятой)
`rasterized`	булево значение
`rotation`	число с плавающей запятой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: число с плавающей запятой, длина: число с плавающей запятой, случайность: число с плавающей запятой)
`snap`	булево значение или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	булево значение
`url`	строка
`usetex`	булево значение или None
`verticalalignment`	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`visible`	булево значение
`wrap`	булево значение
`x`	число с плавающей запятой
`y`	число с плавающей запятой

zorder

вещественное число

set_backgroundcolor(color)[source]

Установить цвет фона текста, обновив bbox.

Параметры:

colorцвет

См. также

set_bbox: Изменить положение области ограничивающей рамки

set_bbox(rectprops)[source]

Отобразить область ограничивающей рамки вокруг self.

Параметры:

rectpropsсловарь свойств для patches.FancyBboxPatch: По умолчанию boxstyle - 'square'. Масштаб мутации patches.FancyBboxPatch устанавливается равным размеру шрифта.

Примеры

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c(color)[source]: Псевдоним для set_color.

set_clip_box(clipbox)[source]

Установить область обрезки элемента Bbox.

Параметры:

clipboxBbox

set_clip_on(b)[source]

Установить, использовать ли обрезку для элемента.

При значении False элементы будут видимы за пределами осей, что может привести к непредвиденным результатам.

Параметры:

bbool

set_clip_path(path, transform=None)[source]

Установить траекторию обрезки элемента.

Параметры:

pathPatch или Path или TransformedPath или None: Траектория обрезки. Если задана Path, transform должен быть также задан. Если None, ранее заданная траектория обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданная Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки соответствующим прямоугольником и установит траекторию обрезки на None.

По техническим причинам (поддержка set), в качестве единственного позиционного параметра также принимается кортеж (path, transform).

set_color(color)[source]

Установить цвет текста.

Параметры:

colorцвет

set_family(fontname)[source]: Псевдоним для set_fontfamily.

set_font(fp)[source]: Псевдоним для set_fontproperties.

set_font_properties(fp)[source]: Псевдоним для set_fontproperties.

set_fontfamily(fontname)[source]

Установите семейство шрифтов. Может быть одной строкой или списком строк в порядке убывания приоритета. Каждая строка может быть либо именем реального шрифта, либо общим именем класса шрифта. Если это последнее, имена конкретных шрифтов будут найдены в соответствующих параметрах rc.

Если экземпляр Text создан с fontfamily=None, то шрифт устанавливается в rcParams["font.family"] (по умолчанию: ['sans-serif']), и то же самое происходит при вызове set_fontfamily() для существующего экземпляра Text.

Параметры:

fontname{имя_шрифта, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontname(fontname)[source]

Псевдоним для set_family.

Односторонний псевдоним: получение отличается.

Параметры:

fontname{имя_шрифта, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontproperties(fp)[source]

Установите свойства шрифта, которые управляют текстом.

Параметры:

fpfont_manager.FontProperties или str или pathlib.Path: Если строка, она интерпретируется как шаблон fontconfig, разобранный FontProperties. Если путь, он интерпретируется как абсолютный путь к файлу шрифта.

set_fontsize(fontsize)[source]

Установите размер шрифта.

Параметры:

fontsizeчисло или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}: Если число, размер шрифта в пунктах. Строковые значения обозначают размеры, относительные к размеру шрифта по умолчанию.

См. также

font_manager.FontProperties.set_size

set_fontstretch(stretch)[source]

Установите сжатие шрифта (горизонтальное сжатие или расширение).

Параметры:

stretch{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}

См. также

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)[source]

Установите стиль шрифта.

Параметры:

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

См. также

font_manager.FontProperties.set_style

set_fontvariant(variant)[source]

Установите вариант шрифта.

Параметры:

variant{'normal', 'small-caps'}

См. также

font_manager.FontProperties.set_variant

set_fontweight(weight)[source]

Установите начертание шрифта.

Параметры:

weight{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}

См. также

font_manager.FontProperties.set_weight

set_ha(align)[source]: Псевдоним для set_horizontalalignment.

set_horizontalalignment(align)[source]

Установите горизонтальное выравнивание относительно точки якорной точки.

См. также Выравнивание текста.

Параметры:

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

set_linespacing(spacing)[source]

Установите межстрочный интервал как кратное размеру шрифта.

По умолчанию межстрочный интервал равен 1,2.

Параметры:

spacingчисло (кратное размеру шрифта)

set_ma(align)[source]: Псевдоним для set_multialignment.

set_math_fontfamily(fontfamily)[source]

Установите семейство шрифтов для математического текста, рендерящегося Matplotlib.

Это влияет только на собственный математический рендер Matplotlib. Это не имеет эффекта при рендеринге с помощью TeX (usetex=True).

Параметры:

fontfamilyстрока

Имя семейства шрифтов.

Доступные семейства шрифтов определены в файле matplotlibrc.template.

См. также

get_math_fontfamily

set_multialignment(align)[source]

Установите выравнивание текста для многострочных текстов.

Макет области отображения всех строк определяется свойствами horizontalalignment и verticalalignment. Это свойство управляет выравниванием строк текста в этой области.

Параметры:

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

set_name(fontname)[source]: Псевдоним для set_fontname.

set_parse_math(parse_math)[source]

Переопределяющий переключатель для отключения обработки mathtext для этого Text.

Параметры:

parse_mathлогическое значение: Если False, этот Text никогда не будет использовать mathtext. Если True, mathtext будет использоваться, если есть чётное количество неуправляемых знаков доллара.

set_position(xy)[source]

Установите позицию текста (x, y).

Параметры:

xy(число с плавающей точкой, число с плавающей точкой)

set_rotation(s)[source]

Установите поворот текста.

Параметры:

sчисло с плавающей точкой или {'vertical', 'horizontal'}: Угол поворота в градусах в математически положительном направлении (против часовой стрелки). 'horizontal' равно 0, 'vertical' равно 90.

set_rotation_mode(m)[source]

Установите режим поворота текста.

Параметры:

m{None, 'default', 'anchor'}: Если None или "default", текст сначала повернётся, затем будет выровнен в соответствии с их горизонтальным и вертикальным выравниванием. Если "anchor", выравнивание происходит до поворота.

set_size(fontsize)[source]: Псевдоним для set_fontsize.

set_stretch(stretch)[source]: Псевдоним для set_fontstretch.

set_style(fontstyle)[source]: Псевдоним для set_fontstyle.

set_text(s)[source]

Установите строку текста s.

Она может содержать новые строки (\n) или математические выражения в формате LaTeX.

Параметры:

sобъект: Любой объект преобразуется в его str представление, за исключением None, который преобразуется в пустую строку.

set_transform_rotates_text(t)[source]

Определяет, влияют ли повороты преобразования на направление текста.

Параметры:

tbool

set_usetex(usetex)[source]

Параметры:

usetexbool или None: Определяет, использовать ли TeX для рендеринга. None означает использовать rcParams["text.usetex"] (по умолчанию False).

set_va(align)[source]: Псевдоним для set_verticalalignment.

set_variant(variant)[source]: Псевдоним для set_fontvariant.

set_verticalalignment(align)[source]

Устанавливает вертикальное выравнивание относительно точки привязки.

См. также Выравнивание текста.

Параметры:

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

set_weight(weight)[source]: Псевдоним для set_fontweight.

set_wrap(wrap)[source]

Установить возможность переносить текст на несколько строк.

Параметры:

wrapbool

Примечания

Перенос не работает вместе с savefig(..., bbox_inches='tight') (который также используется внутренне %matplotlib inline в IPython/Jupyter). Параметр 'tight' перемасштабирует холст для размещения всего содержимого и выполняется перед переносом строк.

set_x(x)[source]

Установить координату x текста.

Параметры:

xfloat

set_y(y)[source]

Установить координату y текста.

Параметры:

yfloat

update(kwargs)[source]

Обновить свойства этого элемента из словаря props.

Параметры:

propsdict

update_bbox_position_size(renderer)[source]

Обновить положение и размер области.

Этот метод следует использовать, когда требуется обновить положение и размер области перед фактическим отображением области.

update_from(other)[source]: Копировать свойства из other в self.

zorder=3

classmatplotlib.text.Annotation(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[source]

Базы: Text, _AnnotationBase

Объект Annotation представляет собой Text, который может ссылаться на определённую позицию xy. Дополнительно может быть нарисована стрелка, указывающая от текста к xy.

Атрибуты:

xy: Анотируемая позиция.
xycoords: Система координат для xy.
arrow_patch: FancyArrowPatch для рисования стрелки от xytext к xy.

Анотирует точку xy текстом text.

В самом простом случае текст размещается в точке xy.

Дополнительно, текст может быть отображён в другой позиции xytext. Стрелка, указывающая от текста к анотируемой точке xy, может быть добавлена с помощью параметра arrowprops.

Параметры:

textstr

Текст аннотации.

xy(float, float)

Точка (x, y) для аннотации. Система координат определяется параметром xycoords.

xytext(float, float), по умолчанию: xy

Позиция (x, y) для размещения текста. Система координат определяется параметром textcoords.

xycoordsstr или Artist или Transform или вызываемый объект или (float, float), по умолчанию: 'data'

Система координат, в которой задано значение xy. Поддерживаются следующие типы значений:

Одна из следующих строк:

Значение	Описание
'figure points'	Точки от левого нижнего угла фигуры
'figure pixels'	Пиксели от левого нижнего угла фигуры
'figure fraction'	Доля фигуры от левого нижнего угла
'subfigure points'	Точки от левого нижнего угла подрисунка
'subfigure pixels'	Пиксели от левого нижнего угла подрисунка
'subfigure fraction'	Доля подрисунка от левого нижнего угла
'axes points'	Точки от левого нижнего угла области графика
'axes pixels'	Пиксели от левого нижнего угла области графика
'axes fraction'	Доля области графика от левого нижнего угла
'data'	Используйте систему координат объекта, который анотируется (по умолчанию)
'polar'	(theta, r), если координаты не являются "data"

Обратите внимание, что 'subfigure pixels' и 'figure pixels' одинаковы для родительской фигуры, поэтому пользователи, которые хотят использовать код в подрисунке, могут использовать 'subfigure pixels'.

Объект Artist: xy интерпретируется как доля Bbox объекта. Например, (0, 0) – это нижний левый угол области, а (0.5, 1) – центр верхней части области.
Объект Transform для преобразования xy в экранные координаты.
Функция с одним из следующих сигнатур:
```
def transform(renderer) -> Bbox
def transform(renderer) -> Transform
```
где renderer – подкласс RendererBase.

Результат функции интерпретируется так же, как и в случаях с объектами Artist и Transform.
Кортеж (xcoords, ycoords), задающий отдельные системы координат для x и y. xcoords и ycoords должны быть одного из перечисленных типов.

Подробнее см. Расширенные аннотации.

textcoordsstr или Artist или Transform или вызываемый объект или (float, float), по умолчанию: значение xycoords

Система координат, в которой задано значение xytext.

Все значения xycoords являются допустимыми, а также следующие строки:

Значение	Описание
'offset points'	Смещение (в пунктах) от значения xy
'offset pixels'	Смещение (в пикселях) от значения xy

arrowpropsdict, необязательно

Свойства, используемые для рисования стрелки FancyArrowPatch между позициями xy и xytext. По умолчанию None, т.е. стрелка не рисуется.

По историческим причинам есть два способа задания стрелок: "простые" и "сложные":

Простая стрелка:

Если arrowprops не содержит ключ 'arrowstyle', допустимы следующие ключи:

Ключ	Описание
width	Ширина стрелки в пунктах
headwidth	Ширина основания головки стрелки в пунктах
headlength	Длина головки стрелки в пунктах
shrink	Доля длины, которая будет обрезана с обоих концов
?	Любой ключ для `matplotlib.patches.FancyArrowPatch`

Стрелка прикрепляется к краю текстовой области, точное положение (углы или центры) зависит от того, куда она направлена.

Сложная стрелка:

Используется, если в arrowprops указан ключ 'arrowstyle'.

Допустимы следующие параметры FancyArrowPatch:

Ключ	Описание
arrowstyle	стиль стрелки
connectionstyle	стиль соединения
relpos	см. ниже; по умолчанию (0.5, 0.5)
patchA	по умолчанию – область текста
patchB	по умолчанию – None
shrinkA	по умолчанию – 2 пункта
shrinkB	по умолчанию – 2 пункта
mutation_scale	по умолчанию – размер текста (в пунктах)
mutation_aspect	по умолчанию – 1.
?	любой ключ для `matplotlib.patches.PathPatch`

Точное начальное положение стрелки определяется параметром relpos. Это кортеж относительных координат текстовой области, где (0, 0) – нижний левый угол, а (1, 1) – верхний правый угол. Поддерживаются значения <0 и >1, задающие точки за пределами текстовой области. По умолчанию (0.5, 0.5) начальная точка находится в центре текстовой области.

annotation_clipbool или None, по умолчанию: None

Указывает, обрезать ли аннотацию (т.е. не рисовать), когда точка аннотации xy находится вне области графика.

Если True, аннотация будет обрезана, когда xy находится вне области графика.
Если False, аннотация всегда будет нарисована.
Если None, аннотация будет обрезана, когда xy находится вне области графика и xycoords равняется 'data'.

**kwargs

Дополнительные ключевые параметры передаются в Text.

Возвращаемое значение:

Annotation

См. также

Расширенные аннотации

propertyanncoords: Система координат для использования с Annotation.xyann.

contains(event)[source]: Возвращает значение, указывающее, произошла ли событие мыши внутри прямоугольника, описывающего текст.

draw(renderer)[source]

Отображает элемент (и его дочерние элементы) с помощью заданного рендерера.

Это не имеет эффекта, если элемент не виден (Artist.get_visible возвращает False).

Параметры:

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах элементов.

get_anncoords()[source]

Возвращает систему координат для использования с Annotation.xyann.

См. также xycoords в Annotation.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки рисунков (т.е. fig.canvas.get_renderer())

Возвращает:

Bbox: Охватывающая прямоугольную область (в пикселях изображения).

get_window_extent(renderer=None)[source]

Возвращает Bbox, ограничивающую текст, в единицах отображения.

Помимо внутреннего использования, это полезно для указания нажимаемых областей в файле png на веб-странице.

Параметры:

rendererРендерер, необязательно: Для вычисления прямоугольной области нужен рендерер. Если элемент уже отрисован, рендерер кэшируется; таким образом, этот аргумент необходимо передавать только при вызове get_window_extent до первого вывода. На практике обычно проще сначала вызвать отрисовку, например, вызвав draw_without_rendering или plt.show().
dpifloat, необязательно: Значение dpi для вычисления прямоугольной области, по умолчанию self.figure.dpi (не dpi рендерера); следует устанавливать, например, для согласования областей с рисунком, сохраненным с пользовательским значением dpi.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, anncoords=<UNSET>, annotation_clip=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`anncoords`	неизвестно
`annotation_clip`	bool или None
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`color` или c	цвет
`figure`	неизвестно
`fontfamily` или family	{ШРИФТ, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	число с плавающей точкой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment` или ha	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	bool
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	bool
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	строка
`usetex`	bool или None
`verticalalignment` или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`visible`	bool

`wrap`	bool
`x`	float
`y`	float
`zorder`	float

set_anncoords(coords)[source]

Установите систему координат для использования с Annotation.xyann.

См. также xycoords в Annotation.

set_figure(fig)[source]

Установите экземпляр Figure, к которому принадлежит элемент.

Параметры:

figFigure

update_positions(renderer)[source]: Обновите пиксельные позиции текста аннотации и области стрелки.

свойствоxyann

Позиция текста.

См. также xytext в Annotation.

свойствоxycoords

классmatplotlib.text.OffsetFrom(artist, ref_coord, unit='points')[source]

Базы: object

Вспомогательный вызываемый класс для работы с Annotation.

Параметры:

artistArtist или BboxBase или Transform

Объект, для которого вычисляется смещение.

ref_coord(float, float)

Если artist является Artist или BboxBase, это значения, представляющие расположение начала смещения в долях рамки artist.

Если artist — это преобразование, начало смещения — это результат применения преобразования к этому значению.

unit{'points', 'pixels'}, по умолчанию: 'points'

Единицы измерения на экране (пиксели или точки), которые будут использоваться для входного смещения.

get_unit()[source]: Возвращает единицу измерения для входных данных преобразования, используемого для __call__.

set_unit(unit)[source]

Установите единицы измерения для входных данных преобразования, используемого для __call__.

Параметры:

unit{'points', 'pixels'}