altair.theme.AxisConfigKwds

class altair.theme.AxisConfigKwds

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

Параметры

aria

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

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

bandPosition

Доля интерполяции, задающая положение делений оси для шкал band. При 0 деления находятся у левого края полосы, при 0.5 — в её середине.

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

description

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

disable

По умолчанию отключать ось.

domain

Включать ли базовую линию оси.

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

domainCap

Форма концов базовой линии оси: "butt", "round" или "square".

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

domainColor

Цвет базовой линии оси.

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

domainDash

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

domainDashOffset

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

domainOpacity

Непрозрачность базовой линии оси.

domainWidth

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

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

format

Спецификатор формата чисел и дат в подписях осей, легенд, заголовков панелей и текстовых примитивах.

• Для formatType: "number", например количественных полей, используется строка шаблона числового формата D3.
• Для formatType: "time", например временных полей, задаётся строка фиксированного формата времени D3 или объект динамического формата. Динамический формат зависит от детализации входной даты: границы года, месяца, дня, часа и т. д.
• Для собственного formatType значение передаётся зарегистрированной функции как format вместе с datum.value.

По умолчанию: выводится из numberFormat для чисел и timeFormat для времени в конфигурации форматирования.

formatType

Тип форматирования подписей: "number", "time" или зарегистрированный собственный тип.

По умолчанию: time для временных полей и порядковых/номинальных полей с timeUnit; number для количественных полей и порядковых/номинальных полей без timeUnit.

grid

Включать ли линии сетки в ось.

По умолчанию: true для непрерывных шкал без разбиения на интервалы, иначе false.

gridCap

Форма концов линий сетки: "butt", "round" или "square".

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

gridColor

Цвет линий сетки.

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

gridDash

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

gridDashOffset

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

gridOpacity

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

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

gridWidth

Толщина линий сетки в пикселях.

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

labelAlign

Горизонтальное выравнивание подписей делений оси, переопределяющее стандартную настройку для текущего расположения оси.

labelAngle

Угол поворота подписей оси.

По умолчанию: -90 для номинальных и порядковых полей, иначе 0.

labelBaseline

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

labelBound

Скрывать ли подписи за пределами диапазона оси. При false анализ выхода за границы не выполняется. При true скрываются подписи, выходящие более чем на 1 пиксель. Число задаёт допуск в пикселях — максимальный выход ограничивающего прямоугольника подписи за диапазон.

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

labelColor

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

labelExpr

Выражение Vega для настройки подписей. Текст и значение доступны через свойства label и value объекта datum, используемого осью.

labelFlush

Выравнивать ли первую и последнюю подписи по краям диапазона шкалы. У горизонтальной оси первая выравнивается слева, последняя справа; у вертикальной используются нижняя и верхняя базовые линии текста. Число также задаёт дополнительное смещение в пикселях. Например, 2 выравнивает крайние подписи и сдвигает их на 2 пикселя наружу от центра оси. Это помогает визуально связать подписи с соответствующими делениями.

По умолчанию: true для оси непрерывной шкалы x, иначе false.

labelFlushOffset

Дополнительное смещение выровненных по краям подписей в пикселях. Например, 2 сдвигает их на 2 пикселя наружу от центра оси, помогая визуально связать с соответствующими делениями.

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

labelFont

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

labelFontSize

Размер шрифта подписи в пикселях.

labelFontStyle

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

labelFontWeight

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

labelLimit

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

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

labelLineHeight

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

labelOffset

Дополнительное смещение подписей в пикселях, сверх tickOffset.

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

labelOpacity

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

labelOverlap

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

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

labelPadding

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

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

labelSeparation

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

labels

Включать ли подписи в ось.

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

maxExtent

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

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

minExtent

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

По умолчанию: 30 для оси y, undefined для оси x.

offset

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

По умолчанию: определяется свойством offset конфигурации оси, стандартное значение которого — 0.

orient

Расположение оси: "top", "bottom", "left" или "right". Позволяет уточнить тип, например разместить ось y у правого края диаграммы.

По умолчанию: "bottom" для осей x, "left" для осей y.

position

Положение точки привязки оси в пикселях. Для осей x сверху или снизу задаёт координату x группы оси; для осей y слева или справа — координату y.

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

style

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

По умолчанию: отсутствует. Указанный стиль дополняет стандартные настройки. Например, ось x со style: "foo" использует config.axisX и config.style.foo, причём foo имеет больший приоритет.

tickBand

Для полосовых шкал размещать деления и сетку в центре полосы ("center", по умолчанию) или на её границах ("extent"), обозначая интервалы.

tickCap

Форма концов линий делений: "butt", "round" или "square".

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

tickColor

Цвет делений оси.

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

tickCount

Желаемое число делений количественной оси. Фактическое число может отличаться, чтобы значения были удобными — кратными 2, 5 или 10 — и входили в диапазон шкалы.

Для шкал "time" и "utc" можно указать временной интервал: "millisecond", "second", "minute", "hour", "day", "week", "month" или "year". Объект вида {"interval": "month", "step": 3} также задаёт число шагов: в этом примере деления создаются на границах кварталов — в январе, апреле, июле и октябре.

По умолчанию: ceil(width/40) для x и ceil(height/40) для y.

tickDash

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

tickDashOffset

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

tickExtra

Добавлять ли дополнительное деление в начальном положении оси. Полезно для полосовых шкал с делениями на границах полос вместо центров. Используется вместе с bandPosition: 1 и padding: 0 оси.

tickMinStep

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

tickOffset

Смещение делений, подписей и линий сетки в пикселях.

tickOpacity

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

tickRound

Округлять ли пиксельные координаты до ближайшего целого.

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

tickSize

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

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

tickWidth

Толщина делений в пикселях.

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

ticks

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

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

title

Заголовок поля. При null удаляется.

По умолчанию: формируется из имени поля и преобразования (aggregate, bin, timeUnit). Агрегирование включается в заголовок, например "Sum of Profit"; группировка по интервалам и единицы времени — в скобках: "Profit (binned)", "Transaction Date (year-month)". Без преобразования используется имя поля.

Примечания:

1. Формат заголовка можно настроить свойством fieldTitle конфигурации или функцией fieldTitle в параметрах компиляции.
2. Если заголовок задан и у поля, и у оси, заголовка панели или легенды, используется заголовок оси, панели или легенды.

titleAlign

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

titleAnchor

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

titleAngle

Угол заголовка оси в градусах.

titleBaseline

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

titleColor

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

titleFont

Шрифт заголовка, например "Helvetica Neue".

titleFontSize

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

titleFontStyle

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

titleFontWeight

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

titleLimit

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

titleLineHeight

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

titleOpacity

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

titlePadding

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

titleX

Координата x заголовка относительно группы оси.

titleY

Координата y заголовка относительно группы оси.

translate

Смещение системы координат при размещении оси. По умолчанию обе координаты сдвигаются на 0.5 пикселя, чтобы линии обводки совпадали с пиксельной сеткой. Для векторной графики такое смещение может быть нежелательно; тогда translate можно изменить, например на ноль.

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

values

Явно заданные видимые значения делений оси.

zindex

Неотрицательный целочисленный z-index оси. При 0 ось отрисовывается за всеми элементами диаграммы. Значение 1 или больше помещает её перед ними.

По умолчанию: 0, позади примитивов.

Конструктор

__init__(*args, **kwargs)

Методы

Атрибуты