matplotlib.table

Этот модуль предоставляет функциональность для добавления таблицы к графику.

Используйте функцию-фабрику table для создания готовой таблицы из текстов. Если вам нужен больший контроль, используйте класс Table и его методы.

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

Благодарим Джона Гилла за предоставление класса и таблицы.

class matplotlib.table.Cell(xy, width, height, edgecolor='k', facecolor='w', fill=True, text='', loc=None, fontproperties=None) [source]

Базируется на matplotlib.patches.Rectangle

Ячейка — это Rectangle с некоторыми связанными Text.

Параметры:

xy : 2-tuple Положение нижнего левого угла ячейки. width : float Ширина ячейки. height : float Высота ячейки. edgecolor : color spec Цвет границы ячейки. facecolor : color spec Цвет заливки ячейки. fill : bool Заполнена ли ячейка фоном. text : str Текст ячейки. loc : {'left', 'center', 'right'}, default: 'right' Выравнивание текста в ячейке. fontproperties : dict Словарь, определяющий свойства шрифта текста. Поддерживаемые ключи и значения — это ключевые аргументы, принимаемые FontProperties.

PAD = 0.1

Отступ между текстом и прямоугольником.

auto_set_font_size(self, renderer) [source]

Уменьшение размера шрифта до тех пор, пока текст не поместится в ширину ячейки.

draw(self, renderer) [source]

Отображение Patch в заданном renderer.

get_fontsize(self) [source]

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

get_required_width(self, renderer) [source]

Возвращает минимальную необходимую ширину ячейки.

get_text(self) [source]

Возвращает экземпляр Text ячейки.

get_text_bounds(self, renderer) [source]

Возвращает границы текста как (x, y, ширина, высота) в координатах таблицы.

set_figure(self, fig) [source]

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

Параметры:	fig : Figure

set_fontsize(self, size) [source]

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

set_text_props(self, **kwargs) [source]

Обновление свойств текста.

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

Свойство	Описание
agg_filter	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3)
alpha	float
animated	bool
backgroundcolor	цвет
bbox	словарь со свойствами для patches.FancyBboxPatch
clip_box	Bbox
clip_on	bool
clip_path	[(Path, Transform) | Patch | None]
color или c	цвет
contains	вызываемый объект
figure	Figure
fontfamily или family	{имя_шрифта, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties или font_properties	font_manager.FontProperties
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	{'center', 'right', 'left'}
in_layout	bool
label	объект
linespacing	float (кратное размеру шрифта)
multialignment или ma	{'left', 'right', 'center'}
path_effects	AbstractPathEffect
picker	None или bool или float или вызываемый объект
position	(float, float)
rasterized	bool или None
rotation	{угол в градусах, 'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(масштаб: float, длина: float, случайность: float)
snap	bool или None
text	объект
transform	Transform
url	строка
usetex	bool или None
verticalalignment или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible	bool
wrap	bool
x	float
y	float
zorder	float

set_transform(self, trans) [source]

Установить преобразование художника.

Параметры:	t : Transform

class matplotlib.table.CustomCell(*args, visible_edges, **kwargs) [source]

Базы: matplotlib.table.Cell

Подкласс Cell с настраиваемой видимостью границ.

get_path(self) [source]

Возвращает Path для visible_edges.

visible_edges

Границы ячейки, которые будут нарисованы линией.

Чтение этого свойства возвращает подстроку 'BRTL' (низ, справа, верх, слева).

При установке этого свойства можно использовать подстроку 'BRTL' или одно из {'open', 'closed', 'horizontal', 'vertical'}.

class matplotlib.table.Table(ax, loc=None, bbox=None, **kwargs) [source]

Базовые классы: matplotlib.artist.Artist

Таблица ячеек.

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

Для простой таблицы у вас будет полная сетка ячеек с индексами от (0, 0) до (num_rows-1, num_cols-1), в которой ячейка (0, 0) расположена вверху слева. Однако вы также можете добавлять ячейки с отрицательными индексами. Вам не обязательно добавлять ячейку в каждую позицию сетки, поэтому вы можете создавать таблицы, имеющие пустые места.

Примечание: Обычно вы не будете создавать пустую таблицу с нуля. Вместо этого используйте table для создания таблицы из данных.

Параметры:	ax : matplotlib.axes.Axes Axes для построения таблицы. loc : str Позиция ячейки относительно ax. Это должно быть одно из значений codes. bbox : Bbox or None Границы для отрисовки таблицы. Если это не None, это переопределяет loc.
Другие параметры:	**kwargs Artist свойства.

AXESPAD = 0.02

Граница между областью Axes и краем таблицы в единицах Axes.

FONTSIZE = 10

add_cell(self, row, col, *args, **kwargs) [source]

Создать ячейку и добавить её в таблицу.

Параметры:	row : int Индекс строки. col : int Индекс столбца. *args, **kwargs Все остальные параметры передаются в Cell.
Возвращает:	cell : CustomCell Созданная ячейка.

auto_set_column_width(self, col) [source]

Автоматически установить ширину заданных столбцов до оптимальных размеров.

Параметры:	col : int or sequence of ints Индексы столбцов для автоматического масштабирования.

auto_set_font_size(self, value=True) [source]

Автоматически установить размер шрифта.

codes = {'best': 0, 'bottom': 17, 'bottom left': 12, 'bottom right': 13, 'center': 9, 'center left': 5, 'center right': 6, 'left': 15, 'lower center': 7, 'lower left': 3, 'lower right': 4, 'right': 14, 'top': 16, 'top left': 11, 'top right': 10, 'upper center': 8, 'upper left': 2, 'upper right': 1}

Возможные значения, где разместить таблицу относительно Axes.

contains(self, mouseevent) [source]

Проверить, содержит ли графический элемент событие мыши.

Параметры:	mouseevent : matplotlib.backend_bases.MouseEvent
Возвращает:	contains : bool Содержатся ли какие-либо значения в радиусе. details : dict Специфический для графического элемента словарь сведений о контексте события, например, какие точки находятся в радиусе выбора. Подробности см. в отдельных подклассах Artist.

См. также

set_contains, get_contains

draw(self, renderer) [source]

Отрисовывает графический элемент с помощью заданного средства отрисовки.

Этот метод будет переопределен в подклассах Artist. Как правило, он реализован так, чтобы не оказывать никакого влияния, если графический элемент не видим (Artist.get_visible имеет значение False).

Параметры:	renderer : RendererBase subclass.

edges

Значение по умолчанию для visible_edges для вновь добавленных ячеек с помощью add_cell.

Примечания

Эта настройка в настоящее время влияет только на вновь созданные ячейки с помощью add_cell.

Чтобы изменить существующие ячейки, необходимо явно задать их границы:

for c in tab.get_celld().values():
    c.visible_edges = 'horizontal'

get_celld(self) [source]

Возвращает словарь ячеек в таблице, сопоставляющий (строка, столбец) с Cell.

Примечания

Вы также можете напрямую обращаться к отдельным ячейкам через объект Table:

cell = table[row, col]

get_child_artists(self)

[Устарело] Возвращает графические элементы, содержащиеся в таблице.

Примечания

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

get_children(self) [source]

Возвращает графические элементы, содержащиеся в таблице.

get_window_extent(self, renderer) [source]

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

scale(self, xscale, yscale) [source]

Масштабирует ширину столбцов на xscale и высоту строк на yscale.

set_fontsize(self, size) [source]

Установить размер шрифта текста ячейки в пунктах.

Параметры:	size : float

Примечания

Пока автоматический размер шрифта не отключен, значение будет ограничено так, чтобы текст помещался в ячейку по горизонтали.

Вы можете отключить это поведение с помощью auto_set_font_size.

>>> the_table.auto_set_font_size(False)
>>> the_table.set_fontsize(20)

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

matplotlib.table.table(ax, cellText=None, cellColours=None, cellLoc='right', colWidths=None, rowLabels=None, rowColours=None, rowLoc='left', colLabels=None, colColours=None, colLoc='center', loc='bottom', bbox=None, edges='closed', **kwargs) [source]

Добавление таблицы к Axes.

Необходимо указать хотя бы один из параметров cellText или cellColours. Эти параметры должны быть двумерными списками, где внешние списки определяют строки, а внутренние — значения столбцов для каждой строки. Количество элементов в каждой строке должно быть одинаковым.

Таблица может иметь заголовки строк и столбцов, которые настраиваются с помощью параметров rowLabels, rowColours, rowLoc и colLabels, colColours, colLoc соответственно.

Для более тонкого управления таблицами используйте класс Table и добавьте его в оси с помощью Axes.add_table.

Параметры:	cellText : 2D list of str, optional Тексты для ячеек таблицы. Примечание: Переводы строк в строках в настоящее время не учитываются и могут привести к выходу текста за границы ячейки. cellColours : 2D list of matplotlib color specs, optional Цвета фона ячеек. cellLoc : {'left', 'center', 'right'}, default: 'right' Выравнивание текста внутри ячеек. colWidths : list of float, optional Ширина столбцов в единицах осей. Если не указано, все столбцы будут иметь ширину 1 / ncols. rowLabels : list of str, optional Текст ячеек заголовка строк. rowColours : list of matplotlib color specs, optional Цвета ячеек заголовка строк. rowLoc : {'left', 'center', 'right'}, optional, default: 'left' Выравнивание текста в ячейках заголовка строк. colLabels : list of str, optional Текст ячеек заголовка столбцов. colColours : list of matplotlib color specs, optional Цвета ячеек заголовка столбцов. rowLoc : {'left', 'center', 'right'}, optional, default: 'left' Выравнивание текста в ячейках заголовка столбцов. loc : str, optional Положение ячейки относительно ax. Должно быть одним из codes. bbox : Bbox, optional Прямоугольник для отрисовки таблицы. Если не None, переопределяет loc. edges : substring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'} Границы ячеек для отрисовки линией. См. также visible_edges.
Возвращаемое значение:	table : Table Созданная таблица.
Другие параметры:	**kwargs Свойства Table. Свойство Описание agg_filter Функция фильтрации, которая принимает массив (m, n, 3) float и значение dpi, и возвращает массив (m, n, 3) alpha вещественное число animated логическое значение clip_box Bbox clip_on логическое значение clip_path [(Path, Transform) | Patch | None] contains вызываемая функция figure Figure fontsize вещественное число gid строка in_layout логическое значение label объект path_effects AbstractPathEffect picker None или bool или float или вызываемая функция rasterized bool или None sketch_params (масштаб: float, длина: float, случайность: float) snap bool или None transform Transform url строка visible логическое значение zorder вещественное число