matplotlib.gridspec.GridSpecBase

class matplotlib.gridspec.GridSpecBase(nrows, ncols, height_ratios=None, width_ratios=None) [source]

Bases: object

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

Параметры:

Параметры:	`nrows, ncolsint` Количество строк и столбцов сетки. `width_ratiosarray-like of length ncols, optional` Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину `width_ratios[i] / sum(width_ratios)`. Если не указано, все столбцы будут иметь одинаковую ширину. `height_ratiosarray-like of length nrows, optional` Определяет относительные высоты строк. Каждая строка получает относительную высоту `height_ratios[i] / sum(height_ratios)`. Если не указано, все строки будут иметь одинаковую высоту.

nrows, ncolsint: Количество строк и столбцов сетки.
width_ratiosarray-like of length ncols, optional: Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину.
height_ratiosarray-like of length nrows, optional: Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту.

__dict__ = mappingproxy({'__module__': 'matplotlib.gridspec', '__doc__': '\n A base class of GridSpec that specifies the geometry of the grid\n that a subplot will be placed.\n ', '__init__': <function GridSpecBase.__init__>, '__repr__': <function GridSpecBase.__repr__>, 'nrows': <property object>, 'ncols': <property object>, 'get_geometry': <function GridSpecBase.get_geometry>, 'get_subplot_params': <function GridSpecBase.get_subplot_params>, 'new_subplotspec': <function GridSpecBase.new_subplotspec>, 'set_width_ratios': <function GridSpecBase.set_width_ratios>, 'get_width_ratios': <function GridSpecBase.get_width_ratios>, 'set_height_ratios': <function GridSpecBase.set_height_ratios>, 'get_height_ratios': <function GridSpecBase.get_height_ratios>, 'get_grid_positions': <function GridSpecBase.get_grid_positions>, '__getitem__': <function GridSpecBase.__getitem__>, 'subplots': <function GridSpecBase.subplots>, '__dict__': <attribute '__dict__' of 'GridSpecBase' objects>, '__weakref__': <attribute '__weakref__' of 'GridSpecBase' objects>})

__getitem__(self, key) [source]: Создаёт и возвращает экземпляр SubplotSpec.

__init__(self, nrows, ncols, height_ratios=None, width_ratios=None) [source]

Параметры:

Параметры:	`nrows, ncolsint` Количество строк и столбцов сетки. `width_ratiosarray-like of length ncols, optional` Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину `width_ratios[i] / sum(width_ratios)`. Если не указано, все столбцы будут иметь одинаковую ширину. `height_ratiosarray-like of length nrows, optional` Определяет относительные высоты строк. Каждая строка получает относительную высоту `height_ratios[i] / sum(height_ratios)`. Если не указано, все строки будут иметь одинаковую высоту.

nrows, ncolsint: Количество строк и столбцов сетки.
width_ratiosarray-like of length ncols, optional: Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину.
height_ratiosarray-like of length nrows, optional: Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту.

__module__ = 'matplotlib.gridspec'

__repr__(self) [source]: Возвращает repr(self).

__weakref__: список слабых ссылок на объект (если определён)

get_geometry(self) [source]: Возвращает кортеж, содержащий количество строк и столбцов в сетке.

get_grid_positions(self, fig, raw=False) [source]

Возвращает позиции ячеек сетки в координатах фигуры.

Параметры:

Параметры:	`figFigure` Фигура, к которой должна быть применена сетка. Параметры подграфика (отступы и расстояние между подграфиками) берутся из fig. `rawbool, default: False` Если True, параметры подграфиков фигуры не учитываются. Сетка охватывает диапазон [0, 1] в обоих направлениях без отступов, и нет пробела между ячейками сетки. Это используется для constrained_layout.
Возвращает:	`bottoms, tops, lefts, rightsarray` Нижние, верхние, левые, правые позиции ячеек сетки в координатах фигуры.

figFigure: Фигура, к которой должна быть применена сетка. Параметры подграфика (отступы и расстояние между подграфиками) берутся из fig.
rawbool, default: False: Если True, параметры подграфиков фигуры не учитываются. Сетка охватывает диапазон [0, 1] в обоих направлениях без отступов, и нет пробела между ячейками сетки. Это используется для constrained_layout.

Возвращает:

bottoms, tops, lefts, rightsarray: Нижние, верхние, левые, правые позиции ячеек сетки в координатах фигуры.

get_height_ratios(self) [source]

Возвращает коэффициенты высот.

Это None, если коэффициенты высот явно не заданы.

get_subplot_params(self, figure=None) [source]

get_width_ratios(self) [source]

Возвращает коэффициенты ширины.

Это None, если коэффициенты ширины явно не заданы.

property ncols: Количество столбцов в сетке.

new_subplotspec(self, loc, rowspan=1, colspan=1) [source]

Создаёт и возвращает экземпляр SubplotSpec.

Параметры:	`loc(int, int)` Позиция подграфика в сетке, как `(row_index, column_index)`. `rowspan, colspanint, default: 1` Количество строк и столбцов, которые подграфик должен охватывать в сетке.

property nrows: Количество строк в сетке.

set_height_ratios(self, height_ratios) [source]

Устанавливает относительные высоты строк.

height_ratios должен иметь длину nrows. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios).

set_width_ratios(self, width_ratios) [source]

Устанавливает относительные ширины столбцов.

width_ratios должен иметь длину ncols. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios).

END_OF_DOCUMENT_MARKER

subplots(self, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None) [source]

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

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

Параметры:

Параметры:	`sharex, shareybool or {'none', 'all', 'row', 'col'}, default: False` Управляет совместным использованием свойств между осями x (sharex) или y (sharey): True или 'all': оси x или y будут общими для всех подграфиков. False или 'none': каждая ось x или y каждого подграфика будет независимой. 'row': каждая строка подграфиков будет использовать общую ось x или y. 'col': каждый столбец подграфиков будет использовать общую ось x или y. Когда подграфики имеют общую ось x в столбце, метки делений по оси x отображаются только для подграфика снизу. Аналогично, когда подграфики имеют общую ось y в строке, метки делений по оси y отображаются только для подграфика в первом столбце. Чтобы включить метки делений для других подграфиков, используйте `tick_params`. `squeezebool, optional, default: True` Если True, дополнительные измерения сжимаются из возвращаемого массива объектов Axes: если построен только один подграфик (nrows=ncols=1), возвращается единственный объект Axes как скаляр. для подграфиков Nx1 или 1xM, возвращаемый объект — одномерный numpy-массив объектов Axes. для NxM подграфиков с N>1 и M>1, возвращается двумерный массив. Если False, никакого сжатия не происходит: возвращаемый объект Axes всегда является двумерным массивом, содержащим объекты Axes, даже если он оказывается 1x1. `subplot_kwdict, optional` Словарь с ключевыми словами, передаваемыми в вызов `add_subplot`, используемый для создания каждого подграфика.
Возвращает:	`axAxes object or array of Axes objects.` ax может быть как одиночным объектом `Axes`, так и массивом объектов Axes, если было создано более одного подграфика. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

sharex, shareybool or {'none', 'all', 'row', 'col'}, default: False

Управляет совместным использованием свойств между осями x (sharex) или y (sharey):

True или 'all': оси x или y будут общими для всех подграфиков.
False или 'none': каждая ось x или y каждого подграфика будет независимой.
'row': каждая строка подграфиков будет использовать общую ось x или y.
'col': каждый столбец подграфиков будет использовать общую ось x или y.

Когда подграфики имеют общую ось x в столбце, метки делений по оси x отображаются только для подграфика снизу. Аналогично, когда подграфики имеют общую ось y в строке, метки делений по оси y отображаются только для подграфика в первом столбце. Чтобы включить метки делений для других подграфиков, используйте tick_params.

squeezebool, optional, default: True

Если True, дополнительные измерения сжимаются из возвращаемого массива объектов Axes:
- если построен только один подграфик (nrows=ncols=1), возвращается единственный объект Axes как скаляр.
- для подграфиков Nx1 или 1xM, возвращаемый объект — одномерный numpy-массив объектов Axes.
- для NxM подграфиков с N>1 и M>1, возвращается двумерный массив.
Если False, никакого сжатия не происходит: возвращаемый объект Axes всегда является двумерным массивом, содержащим объекты Axes, даже если он оказывается 1x1.

subplot_kwdict, optional

Словарь с ключевыми словами, передаваемыми в вызов add_subplot, используемый для создания каждого подграфика.

Возвращает:

axAxes object or array of Axes objects.: ax может быть как одиночным объектом Axes, так и массивом объектов Axes, если было создано более одного подграфика. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

См. также