Spec-Zone.ru › Matplotlib 3.6

matplotlib.collections

Inheritance diagram of matplotlib.collections

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

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

classmatplotlib.collections.AsteriskPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)[source]
END_OF_DOCUMENT_MARKER

Основания: RegularPolyCollection

Отображает набор правильных звездочек с numsides точками.

Параметры:
numsidesint

Количество сторон многоугольника.

rotationfloat

Поворот многоугольника в радианах.

sizesкортеж float

Площадь окружности, описанной вокруг многоугольника, в пунктах^2.

**kwargs

Передается Collection.

Примеры

См. Демонстрацию Lasso для полного примера:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )
add_callback(func)[source]

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

Параметры:
funcвызываемый

Функция обратного вызова. Она должна иметь следующую сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

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

Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback
autoscale()[source]

Автоматическое масштабирование пределов скаляра на экземпляре нормы с использованием текущего массива

autoscale_None()[source]

Автоматическое масштабирование пределов скаляра на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None

propertyaxes

Экземпляр Axes, в котором находится элемент управления, или None.

propertycallbacksSM[source]
changed()[source]

Вызовите эту функцию всякий раз, когда изменяется отображение карты, чтобы уведомить всех слушателей обратного вызова callbacksSM о сигнале 'changed'.

colorbar

Последняя связанная с этим отображением карты цветовая шкала. Может быть None.

contains(mouseevent)[source]

Проверка, произошла ли мышь в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразование x с использованием типа единиц оси x.

Если элемент управления не содержится в оси или у оси x нет единиц, возвращается x.

convert_yunits(y)[source]

Преобразование y с использованием типа единиц оси y.

Если элемент управления не содержится в оси или у оси y нет единиц, возвращается y.

draw(renderer)[source]

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

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

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

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск объектов элементов управления.

Рекурсивно находит все Artist экземпляры, содержащиеся в элементе управления.

Параметры:
match

Критерий фильтрации для совпадений. Это может быть

  • None: Возвращает все объекты, содержащиеся в элементе управления.
  • Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы управления, для которых функция возвращает True.
  • Экземпляр класса: например, Line2D. Результат будет содержать только элементы управления этого класса или его подклассов (проверка isinstance).
include_selfbool

Включить self в список, который будет проверен на соответствие.

Возвращает:
список Artist
format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

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

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

См. также

get_cursor_data
get_agg_filter()[source]

Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]

Возвращает значение альфа-канала, используемое для смешивания - не поддерживается во всех бэкендах.

get_animated()[source]

Возвращает, анимирован ли элемент.

get_array()[source]

Возвращает массив значений, отображаемых в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива.

get_capstyle()[source]
get_children()[source]

Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]

Возвращает значения (мин, макс), которые отображаются на пределы цветовой карты.

get_clip_box()[source]

Возвращает область обрезки.

get_clip_on()[source]

Возвращает, использует ли элемент обрезку.

get_clip_path()[source]

Возвращает путь обрезки.

get_cmap()[source]

Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

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

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

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

Единственный текущий случай использования - отображение значения z AxesImage в строке состояния окна графика во время перемещения мыши.

Parameters:
eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data
get_dashes()[source]

Псевдоним для get_linestyle.

get_datalim(transData)[source]
get_ec()[source]

Псевдоним для get_edgecolor.

get_edgecolor()[source]
get_edgecolors()[source]

Псевдоним для get_edgecolor.

get_facecolor()[source]
get_facecolors()[source]

Псевдоним для get_facecolor.

get_fc()[source]

Псевдоним для get_facecolor.

get_figure()[source]

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

get_fill()[source]

Возвращает значение, указывающее, заливается ли область.

get_gid()[source]

Возвращает идентификатор группы.

get_hatch()[source]

Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает логическое значение, True указывающее, включен ли элемент в вычисления макета.

Например, Руководство по ограничению макета, Figure.tight_layout(), и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]
get_label()[source]

Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]
get_linestyles()[source]

Псевдоним для get_linestyle.

get_linewidth()[source]
get_linewidths()[source]

Псевдоним для get_linewidth.

get_ls()[source]

Псевдоним для get_linestyle.

get_lw()[source]

Псевдоним для get_linewidth.

get_mouseover()[source]

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

get_numsides()[source]
get_offset_transform()[source]

Возвращает экземпляр Transform, используемый для смещения этого элемента.

get_offsets()[source]

Возвращает смещения для коллекции.

get_path_effects()[source]
get_paths()[source]
get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick
get_pickradius()[source]
get_rasterized()[source]

Возвращает, должен ли элемент быть растрирован.

get_rotation()[source]
get_sizes()[source]

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:
массив

Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает:
кортеж или None

Кортеж из 3 элементов:

  • масштаб: Амплитуда колебания перпендикулярно исходной линии.
  • длина: Длина колебания вдоль линии.
  • случайность: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Подобно Artist.get_window_extent, но включает любое обрезание.

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

рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

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

Охватывающая рамка (в пикселях координат фигуры).

get_transOffset()[source]

Псевдоним для get_offset_transform.

get_transform()[source]

Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]

Возвращает обрезной путь с применённой неаффинной частью его преобразования и оставшейся аффинной частью преобразования.

get_transforms()[source]
get_url()[source]

Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. См. Ссылки для примера.

get_visible()[source]

Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область отрисовки элемента в пространстве экрана.

Ширина и высота области отрисовки неотрицательны.

Подклассы должны переопределять для включения в вычисление "объёмной" области отрисовки. По умолчанию возвращает пустую область отрисовки в координатах 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область отрисовки элемента изменится. Область отрисовки может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()[source]

Возвращает порядок отрисовки элемента.

have_units()[source]

Возвращает, установлены ли единицы измерения на любой оси.

is_transform_set()[source]

Возвращает, установлен ли у элемента явно трансформирование.

Это True после вызова set_transform.

свойствоmouseover

Возвращает, запрашивается ли у этого элемента пользовательская информация контекста при перемещении курсора мыши над ним.

свойствоnorm
pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback
pick(mouseevent)[source]

Обрабатывает событие выделения.

Каждый дочерний элемент вызовет событие выделения, если mouseevent находится над элементом и у элемента установлен picker.

См. также

set_picker, get_picker, pickable
pickable()[source]

Возвращает, можно ли выделить элемент.

См. также

set_picker, get_picker, pick
properties()[source]

Возвращает словарь всех свойств элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект будет виден только после повторной отрисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установить сразу несколько свойств.

Поддерживаемые свойства:

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

массивоподобный объект, скаляр или None

animated

bool

antialiased или aa или antialiaseds

bool или список bool

array

массивоподобный объект или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

Bbox

clip_on

bool

clip_path

Объект Patch или (Path, Transform) или None

cmap

Colormap или str или None

color

цвет или список кортежей rgba

edgecolor или ec или edgecolors

цвет или список цветов или 'face'

facecolor или facecolors или fc

цвет или список цветов

figure

Figure

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или dashes или linestyles или ls

строка или кортеж или список таковых

linewidth или linewidths или lw

число с плавающей точкой или список чисел с плавающей точкой

mouseover

bool

norm

Normalize или строка или None

offset_transform или transOffset

неизвестно

offsets

(N, 2) или (2,) массивоподобный объект

path_effects

AbstractPathEffect

paths

неизвестно

picker

None или bool или float или вызываемый объект

pickradius

неизвестно

rasterized

bool

sizes

ndarray или None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

строка

urls

список строк или None

visible

bool

zorder

число с плавающей точкой

set_aa(aa)[source]

Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:
filter_funcвызываемый объект

Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

Установить значение альфа для смешивания — не поддерживается во всех бэкендах.

Параметры:
alphaмассив или скаляр или None

Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычной отрисовки фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на художнике. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с помощью blitting.

Параметры:
bbool
set_antialiased(aa)[source]

Установить состояние антиалиасинга для отрисовки.

Параметры:
aabool или список bool
set_antialiaseds(aa)[source]

Псевдоним для set_antialiased.

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры:
Aмассив или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Установить стиль обрезки CapStyle для коллекции (для всех ее элементов).

Параметры:
csCapStyle или {'butt', 'projecting', 'round'}
set_clim(vmin=None, vmax=None)[source]

Установить пределы нормализации для масштабирования изображения.

Параметры:
vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) как единственный позиционный аргумент.

set_clip_box(clipbox)[source]

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

Параметры:
clipboxBbox
set_clip_on(b)[source]

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

Если False, художники будут видимы за пределами осей, что может привести к неожиданным результатам.

Параметры:
bbool
set_clip_path(path, transform=None)[source]

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

Параметры:
pathPatch или Path или TransformedPath или None

Область обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданная область обрезки удаляется.

transformTransform, необязательно

Используется только если path является Path. В этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

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

По техническим причинам (поддержка set), в качестве единственного позиционного параметра также принимается кортеж (path, transform).

set_cmap(cmap)[source]

Установить цветовую карту для данных яркости.

Параметры:
cmapColormap или str или None
set_color(c)[source]

Установить цвета обводки и заливки.

Параметры:
cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor

Для задания цвета обводки или заливки отдельно.

set_dashes(ls)[source]

Псевдоним для set_linestyle.

set_ec(c)[source]

Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(а) обводки коллекции.

Параметры:
cцвет или список цветов или 'face'

Цвет(а) обводки коллекции. Если последовательность, фигуры будут циклически использовать её значения. Если 'face', цвет обводки будет соответствовать цвету заливки.

set_edgecolors(c)[source]

Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет(а) заливки коллекции. c может быть цветом (все фигуры имеют один и тот же цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать значения из последовательности.

Если c равно 'none', фигура не будет закрашиваться.

Параметры:
cцвет или список цветов
set_facecolors(c)[source]

Псевдоним для set_facecolor.

set_fc(c)[source]

Псевдоним для set_facecolor.

set_figure(fig)[source]

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

Параметры:
figFigure
set_gid(gid)[source]

Установить идентификатор (группы) для объекта.

Параметры:
gidstr
set_hatch(hatch)[source]

Установить шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

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

Штриховка поддерживается только в задних планах PostScript, PDF, SVG и Agg.

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

Параметры:
hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)[source]

Установить, включать ли объект в расчёты макета, например, в Руководстве по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layoutbool
set_joinstyle(js)[source]

Установить JoinStyle для набора (для всех его элементов).

Параметры:
jsJoinStyle или {'miter', 'round', 'bevel'}
set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:
sобъект

s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль линии (стили) для набора.

стиль_линии

описание

'-' или 'solid'

сплошная линия

'--' или 'dashed'

пунктирная линия

'-.' или 'dashdot'

штрихпунктирная линия

':' или 'dotted'

точечная линия

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

(offset, onoffseq),

где onoffseq - кортеж чётной длины "вкл." и "выкл." чернил в пунктах.

Параметры:
lsстрока или кортеж/список

Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Смотрите Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]

Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить ширину(ы) линии(й) для набора. lw может быть скалярным значением или последовательностью; если это последовательность, заплатки будут циклически проходить через последовательность.

Параметры:
lwвещественное число или список вещественных чисел
set_linewidths(lw)[source]

Псевдоним для set_linewidth.

set_ls(ls)[source]

Псевдоним для set_linestyle.

set_lw(lw)[source]

Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установите, запрашивается ли у этого элемента информация о контексте пользовательского интерфейса при перемещении курсора мыши над ним.

Параметры:
mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2
set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:
normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

Установить преобразование смещения элемента.

Параметры:
offset_transformTransform
set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:
offsets(N, 2) или (2,) массив-подобный объект
set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры:
path_effectsAbstractPathEffect
set_paths(paths)[source]
set_picker(picker)[source]

Определите поведение выбора для элемента.

Параметры:
pickerNone или bool или float или вызываемый объект

Может принимать одно из следующих значений:

  • None: Выбор отключён для этого элемента (по умолчанию).
  • Булево значение: если True, выбор будет включён и элемент сгенерирует событие выбора, если курсор мыши находится над ним.
  • Число с плавающей точкой: если picker является числом, оно интерпретируется как толерантность с точностью до нескольких знаков и элемент сгенерирует событие, если его данные находятся в пределах толерантности от события мыши. Для некоторых элементов, таких как линии и коллекции патчей, элемент может предоставить дополнительные данные для события выбора, например, индексы данных, находящихся в пределах толерантности от события выбора
  • Вызываемый объект: если picker является вызываемым объектом, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если курсор мыши находится над элементом, возвращается hit=True и props — словарь свойств, которые необходимо добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

Установить радиус выбора, используемый для проверок попадания.

Параметры:
pickradiusfloat

Радиус выбора, в пунктах.

set_rasterized(rasterized)[source]

Принудительно задать растровое (битовое) отображение для выходных данных векторной графики.

Растровое отображение не поддерживается всеми элементами. Если вы попытаетесь включить это для элемента, который его не поддерживает, команда не окажет никакого влияния, и будет выведено предупреждение.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры:
rasterizedbool
set_sizes(sizes, dpi=72.0)[source]

Установить размеры каждого элемента коллекции.

Параметры:
sizesмассив NumPy или None

Размер, который нужно задать для каждого элемента коллекции. Значение — «площадь» элемента.

dpifloat, по умолчанию: 72

Разрешение холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:
scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None или не указан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебания вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, на который длина уменьшается или увеличивается (по умолчанию 16.0).

Бэкенд PGF использует это значение как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed даёт одинаковую случайную форму.

set_snap(snap)[source]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, результирующее изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением на обеих смежных позициях пикселей. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что результирующее изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:
snapbool или None

Возможные значения:

  • True: Привязка вершин к ближайшему центру пикселя.
  • False: Не изменять позиции вершин.
  • None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
set_transOffset(offset_transform)[source]

Псевдоним для set_offset_transform.

set_transform(t)[source]

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

Параметры:
tTransform
set_url(url)[source]

Установить URL для художника.

Параметры:
urlstr
set_urls(urls)[source]
Параметры:
urlsсписок строк или None

Примечания

URL в настоящее время реализованы только бэкендом SVG. Они игнорируются всеми другими бэкендами.

set_visible(b)[source]

Установить видимость художника.

Параметры:
bbool
set_zorder(level)[source]

Установить z-порядок художника. Художники с более низкими значениями zorder рисуются первыми.

Параметры:
levelfloat
propertystale

Является ли художник 'stale' и нуждается ли он в перерисовке для соответствия внутреннего состояния художника выводу.

propertysticky_edges

x и y списки приклеенных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный случай использования — гистограммы, где обычно не ожидается отступ на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «упирается» в приклеенные края и не может их пересекать. Например, если верхний предел данных равен 1.0, верхний предел просмотра, вычисленный с помощью простого добавления отступа, равен 1.2, но есть приклеенный край в 1.1, то фактический верхний предел просмотра будет равен 1.1.

К этому атрибуту нельзя обращаться; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)[source]

Возвращает нормированный массив rgba, соответствующий x.

В нормальном случае x — это одномерная или двумерная последовательность скаляров, и соответствующий массив ndarray значений rgba будет возвращён, основанный на нормировании и цветовой карте, установленных для этого ScalarMappable.

Существует один особый случай для обработки изображений, которые уже являются rgb или rgba, например, таких, которые были считаны из файла изображения. Если x — это массив ndarray с 3 измерениями, и последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакого отображения не будет произведено. Массив может быть uint8 или он может быть с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с пропусками, маска будет проигнорирована. Если последнее измерение равно 3, аргумент alpha (по умолчанию 1) будет использован для заполнения прозрачности. Если последнее измерение равно 4, аргумент alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes равно False (по умолчанию), массив rgba будет плавающей точкой в диапазоне 0-1; если он равен True, возвращаемый массив rgba будет uint8 в диапазоне от 0 до 255.

Если norm равно False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры:
propsdict
update_from(other)[source]

Копирование свойств из other в себя.

update_scalarmappable()[source]

Обновить цвета из массива скалярного отображения, если таковой имеется.

Присвоить цвета границам и граням на основе массива и/или цветов, которые были непосредственно заданы, соответственно.

zorder=0
classmatplotlib.collections.BrokenBarHCollection(xranges, yrange, **kwargs)[source]

Bases: PolyCollection

Коллекция горизонтальных полос, охватывающих yrange с последовательностью xranges.

Параметры:
xrangesсписок (float, float)

Последовательность пар (позиция левого края, ширина) для каждой полосы.

yrange(float, float)

Общие (нижний край, высота) для всех полос.

**kwargs

Передаются в Collection.

add_callback(func)[source]

Добавление функции обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры:
funcвызываемая функция

Функция обратного вызова. Она должна иметь подпись:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

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

Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback
autoscale()[source]

Автоматическое масштабирование пределов скалярной шкалы на экземпляре нормы с использованием текущего массива

autoscale_None()[source]

Автоматическое масштабирование пределов скалярной шкалы на экземпляре нормы с использованием текущего массива, изменяя только пределы, равные None

propertyaxes

Экземпляр Axes, в котором находится художник, или None.

propertycallbacksSM[source]
changed()[source]

Вызовите эту функцию всякий раз, когда изменяется отображаемое значение, чтобы уведомить всех слушателей callbackSM о сигнале 'changed'.

colorbar

Последняя цветовая шкала, связанная с этим отображаемым значением. Может быть None.

contains(mouseevent)[source]

Проверка, произошел ли сдвиг мыши в коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразование x с использованием типа единиц оси x.

Если художник не содержится в Axes или ось x не имеет единиц, возвращается сам x.

convert_yunits(y)[source]

Преобразование y с использованием типа единиц оси y.

Если художник не содержится в Axes или ось y не имеет единиц, возвращается сам y.

draw(renderer)[source]

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

Это не имеет эффекта, если художник не виден (Artist.get_visible возвращает False).

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

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск объектов художников.

Рекурсивно находит все экземпляры Artist, содержащиеся в художнике.

Параметры:
match

Критерий фильтра для совпадений. Это может быть

  • None: Возвращает все объекты, содержащиеся в художнике.
  • Функция с подписью def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
  • Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (isinstance проверка).
include_selfbool

Включать self в список для проверки на соответствие.

Возвращает:
список Artist
format_cursor_data(data)[source]

Возвращает строковое представление данных data.

Примечание

Этот метод предназначен для переопределения подклассами элементов графического интерфейса. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

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

См. также

get_cursor_data
get_agg_filter()[source]

Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]

Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается во всех бэкендах.

get_animated()[source]

Возвращает, анимирован ли элемент.

get_array()[source]

Возвращает массив значений, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[source]
get_children()[source]

Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]

Возвращает значения (мин, макс), которые сопоставляются с пределами цветовой карты.

get_clip_box()[source]

Возвращает область обрезки.

get_clip_on()[source]

Возвращает, использует ли элемент обрезку.

get_clip_path()[source]

Возвращает путь обрезки.

get_cmap()[source]

Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные указателя для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов графического интерфейса. Пользователю Matplotlib, скорее всего, не придётся вызывать этот метод самостоятельно.

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

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

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры:
eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data
get_dashes()[source]

Псевдоним для get_linestyle.

get_datalim(transData)[source]
get_ec()[source]

Псевдоним для get_edgecolor.

get_edgecolor()[source]
get_edgecolors()[source]

Псевдоним для get_edgecolor.

get_facecolor()[source]
get_facecolors()[source]

Псевдоним для get_facecolor.

get_fc()[source]

Псевдоним для get_facecolor.

get_figure()[source]

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

get_fill()[source]

Возвращает значение, указывающее, закрашен ли объект.

get_gid()[source]

Возвращает идентификатор группы.

get_hatch()[source]

Возвращает текущий шаблон штриховки.

get_in_layout()[source]

Возвращает логическое значение, True если элемент включён в расчёт макета.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]
get_label()[source]

Возвращает метку, используемую для данного элемента в легенде.

get_linestyle()[source]
get_linestyles()[source]

Псевдоним для get_linestyle.

get_linewidth()[source]
get_linewidths()[source]

Псевдоним для get_linewidth.

get_ls()[source]

Псевдоним для get_linestyle.

get_lw()[source]

Псевдоним для get_linewidth.

get_mouseover()[source]

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

get_offset_transform()[source]

Возвращает экземпляр Transform, используемый этим элементом для смещения.

get_offsets()[source]

Возвращает смещения для коллекции.

get_path_effects()[source]
get_paths()[source]
get_picker()[source]

Возвращает поведение выбора объекта.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick
get_pickradius()[source]
get_rasterized()[source]

Возвращает, должен ли объект быть растрированным.

get_sizes()[source]

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:
массив

Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры размытия для объекта.

Возвращает:
кортеж или None

Кортеж из 3 элементов:

  • масштаб: Амплитуда колебаний перпендикулярно исходной линии.
  • длина: Длина колебаний вдоль линии.
  • случайность: Коэффициент масштабирования, с которым длина укорачивается или увеличивается.

Возвращает None, если параметры размытия не были установлены.

get_snap()[source]

Возвращает настройку привязки.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

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

renderer, который будет использоваться для отрисовки фигур (например, fig.canvas.get_renderer())

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

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

get_transOffset()[source]

Псевдоним для get_offset_transform.

get_transform()[source]

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]

Возвращает обрезку пути с применённой частью преобразования, не относящейся к аффинной, и оставшейся аффинной частью её преобразования.

get_transforms()[source]
get_url()[source]

Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному для каждого элемента коллекции.

Список содержит None для элементов без URL. Пример см. в Ссылках.

get_visible()[source]

Возвращает видимость.

get_window_extent(renderer=None)[source]

Получить область отображения объекта в пространстве отображения.

Ширина и высота области отображения неотрицательны.

Подклассы должны переопределять для включения в вычисление "плотной" области отображения. По умолчанию возвращает пустую область отображения в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновятся, если область отображения объекта изменится. Область отображения может изменяться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера фигуры или используемой области (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но сохранятся неправильно.

END_OF_DOCUMENT_MARKER
get_zorder()[source]

Возвращает значение zorder элемента.

have_units()[source]

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

is_transform_set()[source]

Возвращает значение, указывающее, установлен ли преобразование для элемента.

Возвращает True после вызова set_transform.

свойствоmouseover

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

свойствоnorm
pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback
pick(mouseevent)[source]

Обрабатывает событие выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом и у элемента установлен picker.

См. также

set_picker, get_picker, pickable
pickable()[source]

Возвращает значение, указывающее, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick
properties()[source]

Возвращает словарь со всеми свойствами элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей используйте relim.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к оси с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по его идентификатору наблюдателя.

См. также

add_callback
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

массивоподобный объект, скаляр или None

animated

булево значение

antialiased или aa или antialiaseds

булево значение или список булевых значений

array

массивоподобный объект или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clim

(vmin: число с плавающей точкой, vmax: число с плавающей точкой)

clip_box

Bbox

clip_on

булево значение

clip_path

Объект Patch или (Path, Transform) или None

cmap

Colormap или строка или None

color

цвет или список кортежей RGBA

edgecolor или ec или edgecolors

цвет или список цветов или 'face'

facecolor или facecolors или fc

цвет или список цветов

figure

Figure

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

булево значение

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или dashes или linestyles или ls

строка или кортеж или список

linewidth или linewidths или lw

число с плавающей точкой или список чисел с плавающей точкой

mouseover

булево значение

norm

Normalize или строка или None

offset_transform или transOffset

неизвестно

offsets

(N, 2) или (2,) массивоподобный объект

path_effects

AbstractPathEffect

paths

список массивоподобных объектов

picker

None или булево значение или число с плавающей точкой или вызываемая функция

pickradius

неизвестно

rasterized

булево значение

sizes

массив NumPy или None

sketch_params

(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)

snap

булево значение или None

transform

Transform

url

строка

urls

список строк или None

verts

список массивоподобных объектов

verts_and_codes

неизвестно

visible

булево значение

zorder

число с плавающей точкой

set_aa(aa)[source]

Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:
filter_funccallable

Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

Установить значение альфа-канала для смешивания - не поддерживается во всех бэкендах.

Параметры:
alphaмассив-подобный объект или скаляр или None

Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и значения NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли художник для использования в анимации.

Если True, художник исключается из обычной отрисовки фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на художнике. Этот подход используется для ускорения анимации с помощью кеширования.

См. также matplotlib.animation и Более быстрое отображение с помощью кеширования.

Параметры:
bbool
set_antialiased(aa)[source]

Установить состояние антиалиасинга для отрисовки.

Параметры:
aabool или список bool
set_antialiaseds(aa)[source]

Псевдоним для set_antialiased.

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры:
Aмассив-подобный объект или None

Значения, которые отображаются в цвета.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Установить стиль окончания CapStyle для коллекции (для всех ее элементов).

Параметры:
csCapStyle или {'butt', 'projecting', 'round'}
set_clim(vmin=None, vmax=None)[source]

Установить пределы нормирования для масштабирования изображения.

Параметры:
vmin, vmaxfloat

Пределы.

Пределы также можно передать как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[source]

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

Параметры:
clipboxBbox
set_clip_on(b)[source]

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

Если False, художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры:
bbool
set_clip_path(path, transform=None)[source]

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

Параметры:
pathPatch или Path или TransformedPath или None

Путь обрезки. Если задан объект Path, необходимо также указать transform. Если None, то ранее установленный путь обрезки будет удалён.

transformTransform, необязательно

Используется только если path является объектом Path. В этом случае заданный объект Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path является объектом Rectangle, этот метод установит рамку обрезки соответствующему прямоугольнику и задаст путь обрезки в значение None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.

set_cmap(cmap)[source]

Установить палитру цветов для данных яркости.

Параметры:
cmapColormap или str или None
set_color(c)[source]

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

Параметры:
cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor

Для установки цвета границы или заливки индивидуально.

set_dashes(ls)[source]

Псевдоним для set_linestyle.

set_ec(c)[source]

Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установить цвет(а) границы коллекции.

Параметры:
cцвет или список цветов или 'face'

Цвет(а) границы коллекции. Если последовательность, фигуры будут циклически использовать значения из неё. Если 'face', цвет границы будет совпадать с цветом заливки.

set_edgecolors(c)[source]

Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установить цвет заливки(ок) коллекции. c может быть цветом (все фигуры имеют одинаковый цвет) или последовательностью цветов; если это последовательность, фигуры будут циклически использовать значения из неё.

Если c равно 'none', фигура не будет заливаться.

Параметры:
cцвет или список цветов
set_facecolors(c)[source]

Псевдоним для set_facecolor.

set_fc(c)[source]

Псевдоним для set_facecolor.

set_figure(fig)[source]

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

Параметры:
figFigure
set_gid(gid)[source]

Установить идентификатор (группы) для объекта.

Параметры:
gidstr
set_hatch(hatch)[source]

Установить шаблон штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

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

Штриховка поддерживается только задними планами PostScript, PDF, SVG и Agg.

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

Параметры:
hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)[source]

Установить, будет ли объект включён в вычисления макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layoutbool
set_joinstyle(js)[source]

Установить стиль соединения JoinStyle для набора (для всех его элементов).

Параметры:
jsJoinStyle или {'miter', 'round', 'bevel'}
set_label(s)[source]

Установить метку, которая будет отображаться в легенде.

Параметры:
sобъект

s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установить стиль(и) линии для набора.

linestyle

описание

'-' или 'solid'

сплошная линия

'--' или 'dashed'

пунктирная линия

'-.' или 'dashdot'

штрих-пунктирная линия

':' или 'dotted'

точковая линия

В качестве альтернативы можно указать кортеж с отступами, имеющий следующий вид:

(offset, onoffseq),

где onoffseq - кортеж чётной длины, содержащий значения включения и выключения чернил в точках.

Параметры:
lsстрока или кортеж или список кортежей

Допустимые значения отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. См. Line2D.set_linestyle для полного описания.

set_linestyles(ls)[source]

Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установить толщину(ы) линии для набора. lw может быть скалярным значением или последовательностью; если это последовательность, фигуры будут циклически перебирать последовательность.

Параметры:
lwчисло или список чисел
set_linewidths(lw)[source]

Псевдоним для set_linewidth.

set_ls(ls)[source]

Псевдоним для set_linestyle.

set_lw(lw)[source]

Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установите, запрашивается ли у этого объекта информация о пользовательском контексте, когда курсор мыши находится над ним.

Параметры:
mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2
set_norm(norm)[source]

Установите экземпляр нормализации.

Параметры:
normNormalize или str или None

Примечания

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

set_offset_transform(offset_transform)[source]

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

Параметры:
offset_transformTransform
set_offsets(offsets)[source]

Установите смещения для коллекции.

Параметры:
offsets(N, 2) или (2,) array-like
set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры:
path_effectsAbstractPathEffect
set_paths(verts, closed=True)[source]

Установите вершины многоугольников.

Параметры:
vertsсписок array-like

Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как 2D массив-подобный с формой (M, 2).

closedbool, по умолчанию: True

Закрывать ли многоугольник, добавив соединение CLOSEPOLY в конце.

set_picker(picker)[source]

Определите поведение выбора объекта.

Параметры:
pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

  • None: Выбор отключен для этого объекта (по умолчанию).
  • Булево значение: Если True, то выбор будет включен, и объект будет генерировать событие выбора, если событие мыши находится над объектом.
  • Число с плавающей точкой: Если значение picker — число, оно интерпретируется как толеранс ошибки в пунктах, и объект будет генерировать событие, если его данные находятся в пределах ошибки от события мыши. Для некоторых объектов, например, линий и коллекций патчей, объект может предоставить дополнительные данные событию выбора, например, индексы данных, находящихся в пределах ошибки от события выбора.
  • Функция: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    для определения проверки попадания. Если событие мыши находится над объектом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_pickradius(pickradius)[source]

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

Параметры:
pickradiusfloat

Радиус выбора в пунктах.

set_rasterized(rasterized)[source]

Принудительно выполнить растровое (битовое) рисование для выходных данных векторной графики.

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

Это настройка игнорируется для выходных данных на основе пикселей.

См. также Растровое изображение для векторной графики.

Параметры:
rasterizedbool
set_sizes(sizes, dpi=72.0)[source]

Установите размеры каждого члена коллекции.

Параметры:
sizesndarray или None

Размер для установки для каждого элемента коллекции. Значение равно 'площади' элемента.

dpifloat, по умолчанию: 72

Разрешение холста.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры:
scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен None, или не задан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Коэффициент масштабирования, с которым длина сжимается или расширяется (по умолчанию 16.0)

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

set_snap(snap)[source]

Установить поведение привязки.

Привязка выравнивает позиции с пиксельной сеткой, что приводит к более чётким изображениям. Например, если чёрная линия шириной 1 пиксель была определена в позиции между двумя пикселями, полученное изображение будет содержать интерполированное значение этой линии в пиксельной сетке, что будет серым значением в обоих соседних позициях пикселей. В противоположность этому, привязка переместит линию к ближайшему целочисленному значению пикселя, так что полученное изображение действительно будет содержать чёрную линию шириной 1 пиксель.

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры:
snapbool или None

Возможные значения:

  • True: Привязка вершин к ближайшему центру пикселя.
  • False: Не изменять позиции вершин.
  • None: (автоматически) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.
set_transOffset(offset_transform)[source]

Псевдоним для set_offset_transform.

set_transform(t)[source]

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

Параметры:
tTransform
set_url(url)[source]

Установить URL для художника.

Параметры:
urlstr
set_urls(urls)[source]
Параметры:
urlsсписок str или None

Примечания

URL в настоящее время реализованы только бэкэндом SVG. Они игнорируются всеми другими бэкендами.

set_verts(verts, closed=True)[source]

Установить вершины многоугольников.

Параметры:
vertsсписок массивоподобных объектов

Последовательность многоугольников [verts0, verts1, ...] где каждый элемент verts_i определяет вершины многоугольника i как двумерный массивоподобный объект формы (M, 2).

closedbool, по умолчанию: True

Закрывать ли многоугольник, добавляя соединение CLOSEPOLY в конце.

set_verts_and_codes(verts, codes)[source]

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

set_visible(b)[source]

Установить видимость объекта.

Параметры:
bbool
set_zorder(level)[source]

Установить z-порядок объекта. Объекты с меньшими значениями z-порядка рисуются первыми.

Параметры:
levelfloat
classmethodspan_where(x, ymin, ymax, where, **kwargs)[source]

Возвращает BrokenBarHCollection, который рисует горизонтальные полосы в областях в x, где where равно True. Полосы имеют диапазон по оси y от ymin до ymax

kwargs передаются в коллекцию.

propertystale

Является ли художник «недействительным» и нуждается ли он в перерисовке, чтобы вывод соответствовал внутреннему состоянию художника.

свойствоsticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то не будет добавлен отступ — предел просмотра «прилипает» к краю. Типичный пример использования — гистограммы, где обычно не требуется отступ на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересекать. Например, если верхний предел данных равен 1,0, а верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но есть прилипающий край в 1,1, то фактический верхний предел просмотра будет равен 1,1.

К этому атрибуту нельзя присваивать значения; однако списки x и y можно изменять по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)
to_rgba(x, alpha=None, bytes=False, norm=True)[source]

Возвращает нормализованный массив rgba, соответствующий x.

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

Существует один особый случай для обработки изображений, которые уже находятся в формате rgb или rgba, например, прочитанных из файла изображения. Если x является массивом ndarray с тремя измерениями, а последнее измерение равно 3 или 4, то он будет обрабатываться как массив rgb или rgba, и никакой обработки не будет выполняться. Массив может быть uint8 или с плавающей точкой со значениями в диапазоне 0-1; в противном случае будет поднято исключение ValueError. Если это массив с маской, маска будет проигнорирована. Если последнее измерение равно 3, значение параметра alpha (по умолчанию 1) будет использоваться для заполнения прозрачности. Если последнее измерение равно 4, параметр alpha игнорируется; он не заменяет существующую прозрачность. Будет поднято исключение ValueError, если третье измерение отличается от 3 или 4.

В любом случае, если bytes имеет значение False (по умолчанию), массив rgba будет представлять собой числа с плавающей точкой в диапазоне 0-1; если он имеет значение True, возвращаемый массив rgba будет иметь тип uint8 в диапазоне от 0 до 255.

Если norm имеет значение False, нормализация входных данных не выполняется, и предполагается, что они находятся в диапазоне (0-1).

update(props)[source]

Обновляет свойства этого элемента управления из словаря props.

Параметры:
propsdict
update_from(other)[source]

Копирует свойства из other в self.

update_scalarmappable()[source]

Обновляет цвета из массива скалярной карты, если таковой имеется.

Назначает цвета границам и граням на основе массива и/или непосредственно заданных цветов, как требуется.

zorder=0
классmatplotlib.collections.CircleCollection(sizes, **kwargs)[source]

Bases: _CollectionWithSizes

Коллекция окружностей, нарисованных с помощью сплайнов.

Параметры:
sizesfloat или массив-подобный объект

Площадь каждой окружности в пунктах^2.

**kwargs

Передаётся в Collection.

add_callback(func)[source]

Добавление функции обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры:
funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращаемые значения:
int

Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор можно использовать для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback
autoscale()[source]

Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива

autoscale_None()[source]

Автомасштабирование пределов скаляра на экземпляре нормы с использованием текущего массива, изменяя только пределы, которые равны None

propertyaxes

Экземпляр Axes, в котором находится элемент, или None.

propertycallbacksSM[source]
changed()[source]

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

colorbar

Последняя цветовая шкала, связанная с этим ScalarMappable. Может быть None.

contains(mouseevent)[source]

Проверка, произошёл ли сдвиг мыши внутри коллекции.

Возвращает bool, dict(ind=itemlist), где каждый элемент в itemlist содержит событие.

convert_xunits(x)[source]

Преобразование x с помощью типа единицы измерения оси x.

Если элемент не содержится в оси или у оси x нет единиц измерения, возвращается x сам.

convert_yunits(y)[source]

Преобразование y с помощью типа единицы измерения оси y.

Если элемент не содержится в оси или у оси y нет единиц измерения, возвращается y сам.

draw(renderer)[source]

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

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

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

Примечания

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

findobj(match=None, include_self=True)[source]

Поиск элементов-объектов.

Рекурсивный поиск всех Artist элементов, содержащихся в элементе.

Параметры:
match

Критерий фильтрации совпадений. Может быть

  • None: Возвращение всех объектов, содержащихся в элементе.
  • Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы, для которых функция возвращает True.
  • Экземпляр класса: например, Line2D. Результат будет содержать только элементы этого класса или его подклассов (проверка isinstance).
include_selfbool

Включение self в список для проверки соответствия.

Возвращаемые значения:
список Artist
format_cursor_data(data)[source]

Возвращение строкового представления data.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Пользователь Matplotlib, скорее всего, не будет вызывать этот метод самостоятельно.

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

См. также

get_cursor_data
get_agg_filter()[source]

Возвращает функцию фильтра, используемую для фильтрации agg.

get_alpha()[source]

Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается на всех бэкендах.

get_animated()[source]

Возвращает значение, указывающее, является ли элемент анимированным.

get_array()[source]

Возвращает массив значений, сопоставленных с цветами.

Базовый класс ScalarMappable не делает предположений о размерности и форме массива.

get_capstyle()[source]
get_children()[source]

Возвращает список дочерних элементов Artist этого элемента Artist.

get_clim()[source]

Возвращает значения (минимум, максимум), которые сопоставляются с пределами цветовой карты.

get_clip_box()[source]

Возвращает область обрезки.

get_clip_on()[source]

Возвращает значение, указывающее, использует ли элемент обрезку.

get_clip_path()[source]

Возвращает путь обрезки.

get_cmap()[source]

Возвращает экземпляр Colormap.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения в подклассах элементов. Как конечный пользователь Matplotlib, вы, скорее всего, не вызываете этот метод самостоятельно.

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

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

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении указателя мыши.

Параметры:
eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data
get_dashes()[source]

Псевдоним для get_linestyle.

get_datalim(transData)[source]
get_ec()[source]

Псевдоним для get_edgecolor.

get_edgecolor()[source]
get_edgecolors()[source]

Псевдоним для get_edgecolor.

get_facecolor()[source]
get_facecolors()[source]

Псевдоним для get_facecolor.

END_OF_DOCUMENT_MARKER
get_fc()[source]

Псевдоним для get_facecolor.

get_figure()[source]

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

get_fill()[source]

Возвращает, закрашен ли элемент.

get_gid()[source]

Возвращает идентификатор группы.

get_hatch()[source]

Возвращает текущий узор штриховки.

get_in_layout()[source]

Возвращает флаг, True если элемент включён в расчёт макета.

Например, Руководство по ограниченной компоновке, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_joinstyle()[source]
get_label()[source]

Возвращает метку, используемую для этого элемента в легенде.

get_linestyle()[source]
get_linestyles()[source]

Псевдоним для get_linestyle.

get_linewidth()[source]
get_linewidths()[source]

Псевдоним для get_linewidth.

get_ls()[source]

Псевдоним для get_linestyle.

get_lw()[source]

Псевдоним для get_linewidth.

get_mouseover()[source]

Возвращает, запрашивает ли этот элемент пользовательские данные контекста при перемещении курсора мыши.

get_offset_transform()[source]

Возвращает экземпляр Transform, используемый этим элементом смещения.

get_offsets()[source]

Возвращает смещения для коллекции.

get_path_effects()[source]
get_paths()[source]
get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick
get_pickradius()[source]
get_rasterized()[source]

Возвращает, должен ли объект быть растрированным.

get_sizes()[source]

Возвращает размеры ('площади') элементов в коллекции.

Возвращает:
массив

Площадь каждого элемента.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает:
кортеж или None

Кортеж из 3 элементов:

  • масштаб: Амплитуда колебаний перпендикулярно исходной линии.
  • длина: Длина колебаний вдоль линии.
  • случайность: Коэффициент масштабирования, с которым длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает значение параметра snap.

Подробности см. в set_snap.

get_tightbbox(renderer=None)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

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

рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())

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

Охватывающая область (в пикселях координат фигуры).

get_transOffset()[source]

Псевдоним для get_offset_transform.

get_transform()[source]

Возвращает экземпляр Transform, используемый этим объектом.

get_transformed_clip_path_and_affine()[source]

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

get_transforms()[source]
get_url()[source]

Возвращает URL.

get_urls()[source]

Возвращает список URL, по одному на каждый элемент коллекции.

Список содержит None для элементов без URL. Пример см. в Гиперссылки.

get_visible()[source]

Возвращает видимость.

get_window_extent(renderer=None)[source]

Получает область объекта в пространстве отображения.

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

Подклассы должны переопределять для включения в вычисление области "плотно". По умолчанию возвращается пустая область в 0, 0.

Будьте осторожны при использовании этой функции, результаты не обновятся, если область отображения объекта изменится. Область может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемой области (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()[source]

Возвращает z-порядок объекта.

have_units()[source]

Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

Возвращает, установлен ли преобразование объекта.

Это True после вызова set_transform.

свойствоmouseover

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

свойствоnorm
pchanged()[source]

Вызывает все зарегистрированные обратные вызовы.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback
pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и для элемента установлен picker.

См. также

set_picker, get_picker, pickable
pickable()[source]

Возвращает, является ли элемент выбираемым.

См. также

set_picker, get_picker, pick
properties()[source]

Возвращает словарь всех свойств элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Используйте relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаляет обратный вызов по идентификатору наблюдателя.

См. также

add_callback
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство

Описание

agg_filter

Функция фильтра, которая принимает массив (m, n, 3) с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

массив-подобный объект или скаляр или None

animated

bool

antialiased или aa или antialiaseds

bool или список bool

array

массив-подобный объект или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

Bbox

clip_on

bool

clip_path

Объект Patch или (Path, Transform) или None

cmap

Colormap или строка или None

color

цвет или список кортежей rgba

edgecolor или ec или edgecolors

цвет или список цветов или 'face'

facecolor или facecolors или fc

цвет или список цветов

figure

Figure

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или dashes или linestyles или ls

строка или кортеж или список

linewidth или linewidths или lw

число с плавающей точкой или список чисел с плавающей точкой

mouseover

bool

norm

Normalize или строка или None

offset_transform или transOffset

неизвестно

offsets

(N, 2) или (2,) массив-подобный объект

path_effects

AbstractPathEffect

paths

неизвестно

picker

None или bool или число с плавающей точкой или вызываемая функция

pickradius

неизвестно

rasterized

bool

sizes

массив NumPy или None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

строка

urls

список строк или None

visible

bool

zorder

число с плавающей точкой

set_aa(aa)[source]

Псевдоним для set_antialiased.

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Параметры:
filter_funccallable

Функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, глубина) и значение dpi и возвращает массив чисел с плавающей точкой (m, n, глубина) и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

Установить значение альфа-канала, используемое для смешивания. Не поддерживается во всех бэкэндах.

Параметры:
alphaмассив-подобный объект или скаляр или None

Все значения должны быть в диапазоне от 0 до 1 включительно. Маскированные значения и NaN не поддерживаются.

set_animated(b)[source]

Установить, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist на объекте. Этот подход используется для ускорения анимаций с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с помощью blitting.

Параметры:
bbool
set_antialiased(aa)[source]

Установить состояние сглаживания для рендеринга.

Параметры:
aabool или список bool
set_antialiaseds(aa)[source]

Псевдоним для set_antialiased.

set_array(A)[source]

Установить массив значений из массивоподобного объекта A.

Параметры:
Aмассив-подобный объект или None

Значения, которые сопоставляются с цветами.

Базовый класс ScalarMappable не делает никаких предположений о размерности и форме массива значений A.

set_capstyle(cs)[source]

Установить стиль окончания отрезков CapStyle для коллекции (для всех её элементов).

Параметры:
csCapStyle или {'butt', 'projecting', 'round'}
set_clim(vmin=None, vmax=None)[source]

Установить пределы нормы для масштабирования изображения.

Параметры:
vmin, vmaxfloat

Пределы.

Пределы также могут быть переданы как кортеж (vmin, vmax) в качестве единственного позиционного аргумента.

set_clip_box(clipbox)[source]

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

Параметры:
clipboxBbox
set_clip_on(b)[source]

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

Когда False, объекты будут видны за пределами Axes, что может привести к неожиданным результатам.

Параметры:
bbool
set_clip_path(path, transform=None)[source]

Установите область обрезки для элемента.

Параметры:
pathPatch или Path или TransformedPath или None

Область обрезки. Если задан Path, необходимо также указать transform. Если None, то ранее установленная область обрезки будет удалена.

transformTransform, необязательно

Используется только если path — Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки соответствующего прямоугольника и установит область обрезки в None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) как единственный позиционный параметр.

set_cmap(cmap)[source]

Установите палитру цветов для данных яркости.

Параметры:
cmapColormap или строка или None
set_color(c)[source]

Установите цвет обводки и заливки.

Параметры:
cцвет или список кортежей RGBA

См. также

Collection.set_facecolor, Collection.set_edgecolor

Для установки цвета обводки или заливки отдельно.

set_dashes(ls)[source]

Псевдоним для set_linestyle.

set_ec(c)[source]

Псевдоним для set_edgecolor.

set_edgecolor(c)[source]

Установите цвет(ы) обводки коллекции.

Параметры:
cцвет или список цветов или 'face'

Цвет(ы) обводки коллекции. Если последовательность, элементы последовательно циклически применяются. Если 'face', используется цвет заливки.

set_edgecolors(c)[source]

Псевдоним для set_edgecolor.

set_facecolor(c)[source]

Установите цвет(ы) заливки коллекции. c может быть цветом (все области имеют одинаковый цвет) или последовательностью цветов; если это последовательность, области будут циклически использовать цвета из последовательности.

Если c равно 'none', область не будет закрашена.

Параметры:
cцвет или список цветов
set_facecolors(c)[source]

Псевдоним для set_facecolor.

set_fc(c)[source]

Псевдоним для set_facecolor.

set_figure(fig)[source]

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

Параметры:
figFigure
set_gid(gid)[source]

Установите идентификатор (группы) для элемента.

Параметры:
gidстрока
set_hatch(hatch)[source]

Установите узор штриховки.

hatch может быть одним из:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

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

Штриховка поддерживается только в бэкендах PostScript, PDF, SVG и Agg.

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

Параметры:
hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_in_layout(in_layout)[source]

Установите, будет ли элемент включен в вычисления макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры:
in_layoutbool
set_joinstyle(js)[source]

Установите стиль соединения JoinStyle для набора (для всех его элементов).

Параметры:
jsJoinStyle или {'miter', 'round', 'bevel'}
set_label(s)[source]

Установите метку, которая будет отображаться в легенде.

Параметры:
sобъект

s будет преобразован в строку с помощью вызова str.

set_linestyle(ls)[source]

Установите стиль(и) линии для набора.

linestyle

описание

'-' или 'solid'

сплошная линия

'--' или 'dashed'

пунктирная линия

'-.' или 'dashdot'

штрихпунктирная линия

':' или 'dotted'

штриховая линия

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

(offset, onoffseq),

где onoffseq - это кортеж чётной длины, представляющий чередование включения и выключения чернил в пунктах.

Параметры:
lsстрока или кортеж или список таких кортежей

Допустимые значения для отдельных стилей линий включают {'-', '--', '-.', ':', '', (смещение, последовательность включения-выключения)}. Полное описание см. в Line2D.set_linestyle.

set_linestyles(ls)[source]

Псевдоним для set_linestyle.

set_linewidth(lw)[source]

Установите ширину линии(ей) для набора. lw может быть скаляром или последовательностью; если это последовательность, фигуры будут циклически проходить по последовательности.

Параметры:
lwчисловой или список чисел
set_linewidths(lw)[source]

Псевдоним для set_linewidth.

set_ls(ls)[source]

Псевдоним для set_linestyle.

set_lw(lw)[source]

Псевдоним для set_linewidth.

set_mouseover(mouseover)[source]

Установить, запрашивается ли у этого объекта информация о контексте, когда курсор мыши перемещается по нему.

Параметры:
mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2
set_norm(norm)[source]

Установить экземпляр нормализации.

Параметры:
normNormalize или str или None

Примечания

Если для этой нормализации используются какие-либо цветовые шкалы, установка нормализации mappable сбросит нормализацию, локали и форматирование цветовой шкалы по умолчанию.

set_offset_transform(offset_transform)[source]

Установить трансформирование смещения объекта.

Параметры:
offset_transformTransform
set_offsets(offsets)[source]

Установить смещения для коллекции.

Параметры:
offsets(N, 2) или (2,) массив-подобный объект
set_path_effects(path_effects)[source]

Установить эффекты для траекторий.

Параметры:
path_effectsAbstractPathEffect
set_paths(paths)[source]
set_picker(picker)[source]

Определите поведение выбора для объекта.

Параметры:
pickerNone или bool или float или вызываемый объект

Это может быть одно из следующего:

  • None: Выбор отключён для данного объекта (по умолчанию).
  • Булево значение: Если True, выбор будет включён, и объект будет генерировать событие выбора, если указатель мыши находится над ним.
  • Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск в точках, и объект будет генерировать событие, если его данные находятся в пределах допуска от события мыши. Для некоторых объектов, таких как линии и коллекции патчей, объект может предоставить дополнительные данные событию выбора, например, индексы данных в пределах допуска от события выбора
  • Функция: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли объект под событие мыши:

    hit, props = picker(artist, mouseevent)
    

    чтобы определить проверку попадания. Если курсор мыши над объектом, вернуть hit=True и props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_pickradius(

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.6.0/api/collections_api.html

Spec-Zone.ru

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