altair.Header

altair.Header(format=Undefined, formatType=Undefined, labelAlign=Undefined, labelAnchor=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOrient=Undefined, labelPadding=Undefined, labels=Undefined, orient=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

Обёртка схемы Header.

Заголовки каналов строк и столбцов фасетных диаграмм.

Параметры

format — str, dict, Dict, Format, TimeFormatSpecifier

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

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

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

formatType — str

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

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

labelAlign — dict, Align, ExprRef, Literal['left', 'center', 'right']

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

labelAnchor — TitleAnchor, Literal[None, 'start', 'middle', 'end']

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

labelAngle — float

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

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

labelBaseline — dict, ExprRef, Baseline, TextBaseline, Literal['alphabetic', 'line-bottom', 'line-top', 'top', 'middle', 'bottom']

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

labelColor — str, dict, Color, ExprRef, HexColor, ColorName, Literal['black', 'silver', 'gray', 'white', 'maroon', 'red', 'purple', 'fuchsia', 'green', 'lime', 'olive', 'yellow', 'navy', 'blue', 'teal', 'aqua', 'orange', 'aliceblue', 'antiquewhite', 'aquamarine', 'azure', 'beige', 'bisque', 'blanchedalmond', 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey', 'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick', 'floralwhite', 'forestgreen', 'gainsboro', 'ghostwhite', 'gold', 'goldenrod', 'greenyellow', 'grey', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgray', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow', 'limegreen', 'linen', 'magenta', 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple', 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen', 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream', 'mistyrose', 'moccasin', 'navajowhite', 'oldlace', 'olivedrab', 'orangered', 'orchid', 'palegoldenrod', 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip', 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown', 'seagreen', 'seashell', 'sienna', 'skyblue', 'slateblue', 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'whitesmoke', 'yellowgreen', 'rebeccapurple']

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

labelExpr — str

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

labelFont — str, dict, ExprRef

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

labelFontSize — dict, float, ExprRef

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

labelFontStyle — str, dict, ExprRef, FontStyle

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

labelFontWeight — dict, ExprRef, FontWeight, Literal['normal', 'bold', 'lighter', 'bolder', 100, 200, 300, 400, 500, 600, 700, 800, 900]

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

labelLimit — dict, float, ExprRef

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

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

labelLineHeight — dict, float, ExprRef

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

labelOrient — Orient, Literal['left', 'right', 'top', 'bottom']

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

labelPadding — dict, float, ExprRef

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

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

labels — bool

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

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

orient — Orient, Literal['left', 'right', 'top', 'bottom']

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

title — str, Text, Sequence[str], None

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

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

Примечания:

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

titleAlign — dict, Align, ExprRef, Literal['left', 'center', 'right']

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

titleAnchor — TitleAnchor, Literal[None, 'start', 'middle', 'end']

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

titleAngle — float

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

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

titleBaseline — dict, ExprRef, Baseline, TextBaseline, Literal['alphabetic', 'line-bottom', 'line-top', 'top', 'middle', 'bottom']

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

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

titleColor — str, dict, Color, ExprRef, HexColor, ColorName, Literal['black', 'silver', 'gray', 'white', 'maroon', 'red', 'purple', 'fuchsia', 'green', 'lime', 'olive', 'yellow', 'navy', 'blue', 'teal', 'aqua', 'orange', 'aliceblue', 'antiquewhite', 'aquamarine', 'azure', 'beige', 'bisque', 'blanchedalmond', 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey', 'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick', 'floralwhite', 'forestgreen', 'gainsboro', 'ghostwhite', 'gold', 'goldenrod', 'greenyellow', 'grey', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgray', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow', 'limegreen', 'linen', 'magenta', 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple', 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen', 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream', 'mistyrose', 'moccasin', 'navajowhite', 'oldlace', 'olivedrab', 'orangered', 'orchid', 'palegoldenrod', 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip', 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown', 'seagreen', 'seashell', 'sienna', 'skyblue', 'slateblue', 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'whitesmoke', 'yellowgreen', 'rebeccapurple']

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

titleFont — str, dict, ExprRef

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

titleFontSize — dict, float, ExprRef

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

titleFontStyle — str, dict, ExprRef, FontStyle

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

titleFontWeight — dict, ExprRef, FontWeight, Literal['normal', 'bold', 'lighter', 'bolder', 100, 200, 300, 400, 500, 600, 700, 800, 900]

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

titleLimit — dict, float, ExprRef

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

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

titleLineHeight — dict, float, ExprRef

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

titleOrient — Orient, Literal['left', 'right', 'top', 'bottom']

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

titlePadding — dict, float, ExprRef

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

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

Конструктор

__init__(format=Undefined, formatType=Undefined, labelAlign=Undefined, labelAnchor=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelLineHeight=Undefined, labelOrient=Undefined, labelPadding=Undefined, labels=Undefined, orient=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleAngle=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOrient=Undefined, titlePadding=Undefined, **kwds)

Методы