altair.theme.LegendConfigKwds

class altair.theme.LegendConfigKwds

Обёртка TypedDict для altair.LegendConfig.

Параметры

aria

Включать ли атрибуты ARIA (только SVG). При false группе SVG задаётся атрибут aria-hidden, исключающий легенду из дерева доступности ARIA.

По умолчанию: true.

clipHeight

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

columnPadding

Горизонтальный промежуток между элементами символьной легенды в пикселях.

По умолчанию: 10.

columns

Число столбцов для элементов символьной легенды. Значение 0 или меньше задаёт одну строку с отдельным столбцом для каждого элемента.

cornerRadius

Радиус скругления углов всей легенды.

description

Текстовое описание легенды для доступности ARIA (только SVG). При aria: true используется как атрибут aria-label в выводе SVG. Если не задано, создаётся автоматически.

direction

Направление легенды: "vertical" или "horizontal".

По умолчанию:

• сверху и снизу — "horizontal";
• слева и справа — "vertical";
• в углах — "horizontal" для градиентной легенды и "vertical" для символьной.

disable

По умолчанию отключать легенду.

fillColor

Цвет заливки фона всей легенды.

gradientDirection

Стандартное направление градиентной легенды: "horizontal" или "vertical".

По умолчанию: "vertical".

gradientHorizontalMaxLength

Максимальная длина горизонтальной градиентной легенды, если config.legend.gradientLength не задан.

По умолчанию: 200.

gradientHorizontalMinLength

Минимальная длина горизонтальной градиентной легенды, если config.legend.gradientLength не задан.

По умолчанию: 100.

gradientLabelLimit

Максимальная длина подписей цветового градиента в пикселях.

gradientLabelOffset

Вертикальное смещение подписей цветового градиента в пикселях.

По умолчанию: 2.

gradientLength

Длина основной оси цветового градиента в пикселях: высота вертикального или ширина горизонтального градиента.

По умолчанию: 200.

gradientOpacity

Непрозрачность цветового градиента.

gradientStrokeColor

Цвет обводки градиента: шестнадцатеричный код или обычное название цвета.

По умолчанию: "lightGray".

gradientStrokeWidth

Толщина обводки градиента в пикселях.

По умолчанию: 0.

gradientThickness

Толщина цветового градиента в пикселях: ширина вертикального или высота горизонтального градиента.

По умолчанию: 16.

gradientVerticalMaxLength

Максимальная длина вертикальной градиентной легенды, если config.legend.gradientLength не задан.

По умолчанию: 200.

gradientVerticalMinLength

Минимальная длина вертикальной градиентной легенды, если config.legend.gradientLength не задан.

По умолчанию: 100.

gridAlign

Выравнивание строк и столбцов символьной легенды: "all", "each" или none. Подробнее см. размещение в сетке.

По умолчанию: "each".

labelAlign

Выравнивание подписи легенды: left, center или right.

labelBaseline

Базовая линия подписи легенды: "top", "middle", "bottom" или "alphabetic".

По умолчанию: "middle".

labelColor

Цвет подписи легенды: шестнадцатеричный код или обычное название цвета.

labelFont

Шрифт подписи легенды.

labelFontSize

Размер шрифта подписи легенды.

По умолчанию: 10.

labelFontStyle

Начертание шрифта подписи легенды.

labelFontWeight

Насыщенность шрифта подписи легенды.

labelLimit

Максимальная ширина подписей делений легенды в пикселях.

По умолчанию: 160.

labelOffset

Смещение подписи легенды.

По умолчанию: 4.

labelOpacity

Непрозрачность подписей.

labelOverlap

Стратегия устранения перекрытия подписей градиентной легенды. При false подписи не удаляются. При true или "parity" удаляется каждая вторая. При "greedy" подписи просматриваются последовательно и удаляются, если перекрывают последнюю видимую; это часто лучше подходит для логарифмических шкал.

По умолчанию: "greedy" для логарифмических шкал, иначе true.

labelPadding

Отступ между легендой и её подписями в пикселях.

labelSeparation

Минимальный промежуток между ограничивающими прямоугольниками подписей, при котором они считаются неперекрывающимися; по умолчанию 0. Игнорируется, если устранение перекрытия через labelOverlap отключено.

layout

legendX

Пользовательская координата x легенды с orient: "none".

legendY

Пользовательская координата y легенды с orient: "none".

offset

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

По умолчанию: 18.

orient

Расположение легенды в сцене: "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right" или "none".

По умолчанию: "right".

padding

Отступ между границей и содержимым группы легенды.

По умолчанию: 0.

rowPadding

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

По умолчанию: 2.

strokeColor

Цвет обводки границы всей легенды.

strokeDash

Рисунок штрихов обводки границы всей легенды.

strokeWidth

Толщина обводки границы всей легенды.

symbolBaseFillColor

Стандартная заливка символов легенды. Применяется только при отсутствии цветового кодирования шкалы fill для легенды.

По умолчанию: "transparent".

symbolBaseStrokeColor

Стандартная обводка символов легенды. Применяется только при отсутствии цветового кодирования шкалы fill для легенды.

По умолчанию: "gray".

symbolDash

Массив чередующихся длин штрихов и пробелов для пунктирной обводки символов.

symbolDashOffset

Начальное смещение рисунка штрихов обводки символов в пикселях.

symbolDirection

Стандартное направление символьной легенды: "horizontal" или "vertical".

По умолчанию: "vertical".

symbolFillColor

Цвет символа легенды.

symbolLimit

Максимальное допустимое число элементов символьной легенды. Дополнительные элементы исключаются.

symbolOffset

Горизонтальное смещение символов легенды в пикселях.

По умолчанию: 0.

symbolOpacity

Непрозрачность символов легенды.

symbolSize

Размер символа легенды в пикселях.

По умолчанию: 100.

symbolStrokeColor

Цвет обводки символов легенды.

symbolStrokeWidth

Толщина обводки символа.

По умолчанию: 1.5.

symbolType

Форма символа: circle (по умолчанию), square, cross, diamond, triangle-up, triangle-down, triangle-right, triangle-left, линейный символ stroke или направленные формы с центром в начале координат: arrow, wedge, triangle. Также допустима пользовательская строка контура SVG. Для правильного масштабирования её координаты должны находиться в квадрате от -1 до 1 по обеим осям.

По умолчанию: "circle".

tickCount

Желаемое число значений делений количественной легенды.

title

Значение null отключает заголовок оси, легенды или фасета.

titleAlign

Горизонтальное выравнивание заголовков легенды.

По умолчанию: "left".

titleAnchor

Положение точки привязки заголовков легенды.

titleBaseline

Вертикальная базовая линия заголовка легенды: "alphabetic" (стандартный вариант), "top", "middle", "bottom", "line-top" или "line-bottom". Последние два значения похожи на "top" и "bottom", но рассчитываются относительно lineHeight, а не только fontSize.

По умолчанию: "top".

titleColor

Цвет заголовка легенды: шестнадцатеричный код или обычное название цвета.

titleFont

Шрифт заголовка легенды.

titleFontSize

Размер шрифта заголовка легенды.

titleFontStyle

Начертание шрифта заголовка легенды.

titleFontWeight

Насыщенность шрифта заголовка легенды: строка, например "bold" или "normal", либо число 100, 200, 300, …, 900. Значению "normal" соответствует 400, а "bold" — 700.

titleLimit

Максимальная ширина заголовка легенды в пикселях.

По умолчанию: 180.

titleLineHeight

Высота строки в пикселях для многострочного заголовка или текста с базовой линией "line-top" или "line-bottom".

titleOpacity

Непрозрачность заголовка легенды.

titleOrient

Расположение заголовка легенды.

titlePadding

Отступ между заголовком и легендой в пикселях.

По умолчанию: 5.

unselectedOpacity

Непрозрачность невыбранных элементов легенды.

По умолчанию: 0.35.

zindex

Целочисленный z-index, определяющий порядок слоя группы легенды относительно осей, примитивов и других легенд.

Конструктор

__init__(*args, **kwargs)

Методы

Атрибуты