Spec-Zone.ru › Matplotlib 3.2

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]

Bases: matplotlib.patches.Rectangle

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

Параметры:
xy2-tuple

Положение левого нижнего угла ячейки.

widthfloat

Ширина ячейки.

heightfloat

Высота ячейки.

edgecolorcolor

Цвет границы ячейки.

facecolorcolor

Цвет заливки ячейки.

fillbool

Заполнена ли ячейка фоном.

textstr

Текст ячейки.

loc{'left', 'center', 'right'}, default: 'right'

Выравнивание текста внутри ячейки.

fontpropertiesdict

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

Параметры:
xy(float, float)

Координаты нижнего и левого углов прямоугольника

widthfloat

Ширина прямоугольника

heightfloat

Высота прямоугольника

anglefloat, optional

Поворот против часовой стрелки на градусы относительно xy (по умолчанию 0,0)

fillbool, optional

Заливать ли прямоугольник (по умолчанию True)

Примечания

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

Свойство Описание
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha float или None
animated bool
antialiased или aa неизвестно
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path Patch или (Path, Transform) или None
color цвет
contains вызываемый объект
edgecolor или ec цвет или None или 'auto'
facecolor или fc цвет или None
figure Figure
fill bool
gid строка
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle {'miter', 'round', 'bevel'}
label объект
linestyle или ls {'-', '--', '-.', ':', '', (смещение, последовательность вкл/выкл), ...}
linewidth или lw число с плавающей точкой или None
path_effects AbstractPathEffect
picker None или bool или число с плавающей точкой или вызываемый объект
rasterized bool или None
sketch_params (масштаб: float, длина: float, случайность: float)
snap bool или None
transform Transform
url строка
visible bool
zorder число с плавающей точкой
PAD = 0.1

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

auto_set_font_size(self, renderer) [source]

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

draw(self, renderer) [source]

Отображение на заданном 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, к которому принадлежит элемент.

Параметры:
figFigure
set_fontsize(self, size) [source]

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

set_text_props(self, **kwargs) [source]

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

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

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

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

Параметры:
tTransform
class matplotlib.table.CustomCell(*args, visible_edges, **kwargs) [source]

Bases: matplotlib.table.Cell

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

Параметры:
xy(float, float)

Координаты нижней и левой границ прямоугольника

widthfloat

Ширина прямоугольника

heightfloat

Высота прямоугольника

anglefloat, optional

Угол поворота против часовой стрелки относительно xy (по умолчанию 0.0)

fillbool, optional

Заполнять ли прямоугольник (по умолчанию True)

Примечания

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

Свойство Описание
agg_filter функция фильтра, которая принимает массив (m, n, 3) с плавающей запятой и значение dpi, и возвращает массив (m, n, 3)
alpha число с плавающей запятой или None
animated bool
antialiased или aa неизвестно
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on bool
clip_path Patch или (Path, Transform) или None
color цвет
contains вызываемая функция
edgecolor или ec цвет или None или 'auto'
facecolor или fc цвет или None
figure Figure
fill bool
gid строка
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle {'miter', 'round', 'bevel'}
label объект
linestyle или ls {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения), ...}
linewidth или lw число с плавающей запятой или None
path_effects AbstractPathEffect
picker None или bool или число с плавающей запятой или вызываемая функция
rasterized bool или None
sketch_params (масштаб: число, длина: число, случайность: число)
snap bool или None
transform Transform
url строка
visible bool
zorder число с плавающей запятой
get_path(self) [source]

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

property visible_edges

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

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

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

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

Bases: matplotlib.artist.Artist

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

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

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

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

Параметры:
axmatplotlib.axes.Axes

The Axes для отображения таблицы.

locstr

Позиция ячейки относительно ax. Должна быть одна из codes.

bboxBbox or None

Прямоугольник для рисования таблицы. Если это не None, это переопределяет loc.

Другие параметры:
**kwargs

Artist свойства.

AXESPAD = 0.02

Отступ между осями и краем таблицы в единицах осей.

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

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

Параметры:
rowint

Индекс строки.

colint

Индекс столбца.

*args, **kwargs

Все остальные параметры передаются в Cell.

Возвращает:
cellCustomCell

Созданная ячейка.

auto_set_column_width(self, col) [source]

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

Параметры:
colint 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}

Возможные значения для размещения таблицы относительно осей.

contains(self, mouseevent) [source]

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

Параметры:
mouseeventmatplotlib.backend_bases.MouseEvent
Возвращает:
containsbool

Есть ли какие-либо значения в радиусе.

detailsdict

Словарь, специфичный для артефакта, содержащий подробности контекста события, такие как точки, содержащиеся в радиусе выбора. См. подклассы отдельных артефактов для получения подробностей.

См. также

set_contains, get_contains
draw(self, renderer) [source]

Рисует элемент артефакта с помощью указанного рендерера.

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

Параметры:
rendererRendererBase subclass.
property edges

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

Примечания

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

Для изменения существующих ячеек нужно явно установить их границы:

for c in tab.get_celld().values():
    c.visible_edges = 'horizontal'
get_celld(self) [source]

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

Примечания

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

cell = table[row, col]
get_children(self) [source]

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

get_window_extent(self, renderer) [source]

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

scale(self, xscale, yscale) [source]

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

set_fontsize(self, size) [source]

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

Параметры:
sizefloat

Примечания

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

Можно отключить это поведение с помощью 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.

Параметры:
cellText2D list of str, optional

Текстовые значения для ячеек таблицы.

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

cellColours2D list of colors, optional

Цвета фона ячеек.

cellLoc{'left', 'center', 'right'}, default: 'right'

Выравнивание текста в ячейках.

colWidthslist of float, optional

Ширина столбцов в единицах осей. Если не указано, все столбцы будут иметь ширину 1 / ncols.

rowLabelslist of str, optional

Текст ячеек заголовков строк.

rowColourslist of colors, optional

Цвета ячеек заголовков строк.

rowLoc{'left', 'center', 'right'}, optional, default: 'left'

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

colLabelslist of str, optional

Текст ячеек заголовков столбцов.

colColourslist of colors, optional

Цвета ячеек заголовков столбцов.

colLoc{'left', 'center', 'right'}, optional, default: 'left'

Выравнивание текста ячеек заголовков столбцов.

locstr, optional

Положение ячейки относительно ax. Должно быть одним из codes.

bboxBbox, optional

Прямоугольник для отрисовки таблицы. Если не равно None, переопределяет loc.

edgessubstring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'}

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

Возвращает:
tableTable

Созданная таблица.

Другие параметры:
**kwargs

Свойства Table.

Свойство Описание
agg_filter функция фильтра, которая принимает массив (m, n, 3) с плавающей запятой и значение dpi, и возвращает массив (m, n, 3)
alpha число с плавающей точкой или None
animated булево значение
clip_box Bbox
clip_on булево значение
clip_path фигура или (путь, преобразование) или None
contains вызываемая функция
figure Figure
fontsize число с плавающей точкой
gid строка
in_layout булево значение
label объект
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей точкой или вызываемая функция
rasterized булево значение или None
sketch_params (масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap булево значение или None
transform Transform
url строка
visible булево значение
zorder число с плавающей точкой

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.2.2/api/table_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API