Spec-Zone.ru › Matplotlib 3.3

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]

Наследуется от matplotlib.patches.Rectangle

Ячейка представляет собой Rectangle с некоторыми ассоциированными Text.

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

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

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

widthfloat

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

heightfloat

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

edgecolorcolor

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

facecolorcolor

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

fillbool

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

textstr

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

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

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

fontpropertiesdict

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

visible_edgesstr, default: 'closed'

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

PAD = 0.1

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

auto_set_font_size(self, renderer) [source]

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

draw(self, renderer) [source]

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

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

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

Примечания

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

get_fontsize(self) [source]

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

get_path(self) [source]

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

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]

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

END_OF_DOCUMENT_MARKER
set_text_props(self, **kwargs) [source]

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

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

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

Установить преобразование объекта.

Параметры:
tTransform
property visible_edges

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

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

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

matplotlib.table.CustomCell

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

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 для создания таблицы из данных.

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

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.

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

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

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

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

draw(self, renderer) [source]

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

Это не оказывает влияния, если объект не отображается (Artist.get_visible возвращает False).

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

Примечания

Этот метод переопределяется в подклассах объекта `Artist`.

property 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_children(self) [source]

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

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'}, 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 float или 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 или вызываемый объект
rasterized bool или None
sketch_params (scale: float, length: float, randomness: float)
snap bool или None
transform Transform
url str
visible bool
zorder float

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

Spec-Zone.ru

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