altair.theme.HeaderConfigKwds

class altair.theme.HeaderConfigKwds

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

Параметры

format

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

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

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

formatType

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

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

labelAlign

Горизонтальное выравнивание подписей заголовка: "left", "center" или "right".

labelAnchor

Положение точки привязки подписей: "start", "middle" или "end". При расположении подписей сверху эти значения соответствуют выравниванию слева, по центру и справа.

labelAngle

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

По умолчанию: 0 для заголовков столбцов, -90 для заголовков строк.

labelBaseline

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

labelColor

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

labelExpr

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

labelFont

Шрифт подписи заголовка.

labelFontSize

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

labelFontStyle

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

labelFontWeight

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

labelLimit

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

По умолчанию: 0, без ограничения.

labelLineHeight

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

labelOrient

Расположение подписи заголовка: "top", "bottom", "left" или "right".

labelPadding

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

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

labels

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

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

orient

Сокращённая настройка для одновременного задания labelOrient и titleOrient.

title

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

titleAlign

Горизонтальное выравнивание названия заголовка фасета относительно точки привязки.

titleAnchor

Положение точки привязки названия: "start", "middle" или "end". При расположении сверху эти значения соответствуют выравниванию слева, по центру и справа.

titleAngle

Угол поворота названия заголовка фасета.

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

titleBaseline

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

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

titleColor

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

titleFont

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

titleFontSize

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

titleFontStyle

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

titleFontWeight

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

titleLimit

Максимальная длина названия заголовка фасета в пикселях. Более длинный текст автоматически сокращается.

По умолчанию: 0, без ограничения.

titleLineHeight

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

titleOrient

Расположение названия заголовка фасета: "top", "bottom", "left" или "right".

titlePadding

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

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

Конструктор

__init__(*args, **kwargs)

Методы

Метод Описание
__init__
clear() Удалить все элементы словаря.
copy() Вернуть поверхностную копию словаря.
fromkeys(type, iterable, value) Создать словарь с ключами из итерируемого объекта и значениями, равными value.
get(key, default) Вернуть значение ключа, если он есть в словаре; иначе default.
items() Вернуть представление элементов словаря с операциями, подобными операциям над множествами.
keys() Вернуть представление ключей словаря с операциями, подобными операциям над множествами.
pop Удалить указанный ключ и вернуть соответствующее значение: D.pop(k[,d]) → v.
popitem() Удалить и вернуть пару (ключ, значение) в виде кортежа из двух элементов.
setdefault(key, default) Добавить ключ со значением default, если ключ отсутствует в словаре.
update Обновить словарь D из отображения или итерируемого объекта E и именованных аргументов F: D.update([E, ]**F) → None.
values() Вернуть представление значений словаря.

Атрибуты

Атрибут
format
formatType
labelAlign
labelAnchor
labelAngle
labelBaseline
labelColor
labelExpr
labelFont
labelFontSize
labelFontStyle
labelFontWeight
labelLimit
labelLineHeight
labelOrient
labelPadding
labels
orient
title
titleAlign
titleAnchor
titleAngle
titleBaseline
titleColor
titleFont
titleFontSize
titleFontStyle
titleFontWeight
titleLimit
titleLineHeight
titleOrient
titlePadding