Spec-Zone.ru › Matplotlib 3.4

matplotlib.table

Рисование таблиц.

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

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

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

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

Bases: matplotlib.patches.Rectangle

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

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

Параметры:
xy2-кортеж

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

widthfloat

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

heightfloat

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

edgecolorцвет

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

facecolorцвет

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

fillbool

Заливать ли фон ячейки.

textstr

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

loc{'left', 'center', 'right'}, по умолчанию: 'right'

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

fontpropertiesdict

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

visible_edgesстрока, по умолчанию: 'closed'

Границы ячейки, которые будут нарисованы линией: подстрока 'BRTL' (низ,право,верх,лево) или одна из 'open' (никаких границ не нарисованы), 'closed' (все границы нарисованы), 'horizontal' (нижняя и верхняя), 'vertical' (правая и левая).

PAD = 0.1

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

auto_set_font_size(renderer)[source]

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

draw(renderer)[source]

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

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

Параметры:
rendererRendererBase подкласс.

Примечания

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

get_fontsize()[source]

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

get_path()[source]

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

get_required_width(renderer)[source]

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

get_text()[source]

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

get_text_bounds(renderer)[source]

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

set_figure(fig)[source]

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

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

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

set_text_props(**kwargs)[source]
END_OF_DOCUMENT_MARKER

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

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

Свойство Описание
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 или 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 {'center', 'right', 'left'}
in_layout булево значение
label объект
linespacing число с плавающей точкой (кратное размеру шрифта)
math_fontfamily строка
multialignment или ma {'left', 'right', 'center'}
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей точкой или вызываемая функция
position (число с плавающей точкой, число с плавающей точкой)
rasterized булево значение
rotation число с плавающей точкой или {'vertical', 'horizontal'}
rotation_mode {None, 'default', 'anchor'}
sketch_params (scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
snap булево значение или None
text объект
transform Transform
transform_rotates_text булево значение
url строка
usetex булево значение или None
verticalalignment или va {'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible булево значение
wrap булево значение
x число с плавающей точкой
y число с плавающей точкой
zorder число с плавающей точкой
set_transform(trans)[source]

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

Параметры:
tTransform
свойство visible_edges

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

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

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

matplotlib.table.CustomCell

псевдоним matplotlib.table.Cell

класс matplotlib.table.Table(ax, loc=None, bbox=None, **kwargs)[source]

Основания: matplotlib.artist.Artist

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

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

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

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

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

Ось Axes для построения таблицы.

locstr

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

bboxBbox или None

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

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

Свойства Artist.

AXESPAD = 0.02

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

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

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

Параметры:
rowint

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

colint

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

*args, **kwargs

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

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

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

auto_set_column_width(col)[source]

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

Параметры:
colint или последовательность целых чисел

Индексы столбцов для автоматической настройки размеров.

auto_set_font_size(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(mouseevent)[source]

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

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

Признак того, находятся ли какие-либо значения в радиусе.

detailsdict

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

draw(renderer)[source]

Выводит объект графического элемента (и его потомки) с помощью заданного рендерера.

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

Параметры:
rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах графического элемента.

свойство edges

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

Примечания

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

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

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

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

Примечания

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

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

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

get_window_extent(renderer)[source]

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

scale(xscale, yscale)[source]

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

set_fontsize(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'}, default: 'left'

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

colLabelslist of str, optional

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

colColourslist of colors, optional

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

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

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

locstr, optional

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

bboxBbox, optional

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

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

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

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

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

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

Свойства Table.

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

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

Spec-Zone.ru

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