Заголовок
Свойство title добавляет к графику заголовок. Как шкалы, оси и легенды, заголовок можно задать на верхнем уровне спецификации или внутри группового примитива.
Свойства заголовка
Свойства, задающие заголовок.
| Свойство | Тип | Описание |
|---|---|---|
| text | String | String[ ] | Обязательно. Текст заголовка. Начиная с версии ≥ 5.7, массив строк задаёт заголовок из нескольких строк. |
| orient | String | Положение заголовка и подзаголовка относительно графика: top (по умолчанию), bottom, left или right. |
| align | String | Выравнивание текста заголовка и подзаголовка по горизонтали. Если задано, заменяет автоматическое выравнивание, зависящее от anchor. |
| anchor | String | Положение привязки заголовка и подзаголовка: start, middle (по умолчанию) или end. Например, при orient: "top" эти значения соответствуют выравниванию по левому краю, по центру и по правому краю. |
| angle | Number | Угол поворота текста заголовка и подзаголовка в градусах. |
| baseline | String | Вертикальная базовая линия текста заголовка и подзаголовка: alphabetic (по умолчанию), top, middle, bottom, line-top или line-bottom. Значения line-top и line-bottom ≥ 5.10 похожи на top и bottom, но рассчитываются относительно lineHeight, а не только fontSize. |
| color | Color | Цвет текста заголовка. |
| dx | Number | Смещение заголовка и подзаголовка по горизонтали, добавляемое к координате x. ≥ 5.2 |
| dy | Number | Смещение заголовка и подзаголовка по вертикали, добавляемое к координате y. ≥ 5.2 |
| encode | Object | Необязательные правила кодирования примитивов для собственного оформления заголовка. Начиная с версии ≥ 5.7, поддерживаются блоки для group, title и subtitle. См. «Пользовательское кодирование заголовка». Прежний единый блок кодирования только для текста заголовка устарел; используйте вложенные блоки. |
| font | String | Название шрифта заголовка. |
| fontSize | Number | Размер шрифта заголовка в пикселях. |
| fontStyle | String | Начертание заголовка, например normal или italic. ≥ 5.0 |
| fontWeight | String | Number | Насыщенность шрифта заголовка. |
| frame | String | Система отсчёта для положения привязки: "bounds" (по умолчанию, относительно всей ограничивающей рамки) или "group" (относительно ширины или высоты группы). |
| interactive | Boolean | Логический флаг: должен ли заголовок реагировать на события ввода, например наведение мыши. Устарело: используйте пользовательский блок encode. |
| limit | Number | Максимальная длина текста заголовка и подзаголовка в пикселях. |
| lineHeight | Number | Высота строки в пикселях для многострочного заголовка или текста с базовой линией "line-top" или "line-bottom". ≥ 5.7 |
| name | String | Имя примитива, применяемое к тексту заголовка. Устарело: используйте пользовательский блок encode. |
| offset | Number | Value | Смещение заголовка в пикселях по перпендикуляру к краю графика. |
| style | String | String[ ] | Стиль примитива, применяемый к тексту заголовка. Если не задан, используется стиль "group-title". Устарело: используйте пользовательский блок encode. |
| subtitle | String | String[ ] | Необязательный подзаголовок под основным текстом. Массив строк задаёт несколько строк текста. ≥ 5.7 |
| subtitleColor | Color | Цвет текста подзаголовка. ≥ 5.7 |
| subtitleFont | String | Название шрифта подзаголовка. ≥ 5.7 |
| subtitleFontSize | Number | Размер шрифта подзаголовка в пикселях. ≥ 5.7 |
| subtitleFontStyle | String | Начертание подзаголовка, например normal или italic. ≥ 5.7 |
| subtitleFontWeight | String | Number | Насыщенность шрифта подзаголовка. ≥ 5.7 |
| subtitleLineHeight | Number | Высота строки многострочного подзаголовка в пикселях. ≥ 5.7 |
| subtitlePadding | Number | Отступ между заголовком и подзаголовком в пикселях. ≥ 5.7 |
| zindex | Number | Целочисленный индекс слоя группы заголовка относительно групп осей, примитивов и легенд. По умолчанию 0. |
Свойства доступности ≥ 5.11
Свойства доступности задают атрибуты ARIA (Accessible Rich Internet Applications) при отрисовке SVG через Vega.
| Свойство | Тип | Описание |
|---|---|---|
| aria | Boolean | Логический флаг (по умолчанию true): включать ли атрибуты ARIA (только для SVG). При false для группы SVG устанавливается aria-hidden, и заголовок исключается из дерева доступности ARIA. |
Темы и конфигурация
При создании тем значения по умолчанию для многих свойств заголовка можно задать в объекте конфигурации.
Пользовательское кодирование заголовка
Помимо перечисленных параметров оформления, свойство encode позволяет настроить примитивы всех элементов заголовка. Доступны следующие элементы:
group— групповой примитив заголовка;title— текстовый примитив заголовка;subtitle— текстовый примитив подзаголовка.
Для каждого элемента можно задать правила визуального кодирования, сгруппированные в объекты enter, update, exit и другие, как описано в разделе «Примитивы». Свойства примитивов оформляются с помощью обычных ссылок на значения.
Каждый блок encode также может содержать строковое свойство name с уникальным именем набора примитивов, логическое свойство interactive для обработки событий ввода и свойство style — строку или массив — для применения значений по умолчанию. Если не указано иное, элементы заголовка используют стиль "group-title", а элементы подзаголовка — "group-subtitle".
В примере показано, как задать цвет и шрифт для заголовка и подзаголовка, а также включить интерактивность подзаголовка:
"title": {
"text": "Текст заголовка",
"subtitle": "Текст подзаголовка",
"encode": {
"title": {
"enter": {
"fill": {"value": "purple"}
}
},
"subtitle": {
"interactive": true,
"update": {
"fontStyle": {"value": "italic"}
},
"hover": {
"fontStyle": {"value": "normal"}
}
}
}
}