altair.Legend

altair.Legend(aria=Undefined, clipHeight=Undefined, columnPadding=Undefined, columns=Undefined, cornerRadius=Undefined, description=Undefined, direction=Undefined, fillColor=Undefined, format=Undefined, formatType=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, gridAlign=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, legendX=Undefined, legendY=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, strokeColor=Undefined, symbolDash=Undefined, symbolDashOffset=Undefined, symbolFillColor=Undefined, symbolLimit=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, tickCount=Undefined, tickMinStep=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOpacity=Undefined, titleOrient=Undefined, titlePadding=Undefined, type=Undefined, values=Undefined, zindex=Undefined, **kwds)

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

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

Параметры

aria — bool, dict, ExprRef

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

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

clipHeight — dict, float, ExprRef

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

columnPadding — dict, float, ExprRef

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

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

columns — dict, float, ExprRef

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

cornerRadius — dict, float, ExprRef

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

description — str, dict, ExprRef

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

direction — Orientation, Literal['horizontal', 'vertical']

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

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

  • сверху и снизу — "horizontal";
  • слева и справа — "vertical";
  • в углах — "horizontal" для градиентной легенды и "vertical" для символьной.
fillColor — 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'], None

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

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.

gradientLength — dict, float, ExprRef

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

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

gradientOpacity — dict, float, ExprRef

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

gradientStrokeColor — 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'], None

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

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

gradientStrokeWidth — dict, float, ExprRef

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

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

gradientThickness — dict, float, ExprRef

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

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

gridAlign — dict, ExprRef, LayoutAlign, Literal['all', 'each', 'none']

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

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

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

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

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

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

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

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'], None

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

labelExpr — str

Выражение Vega для настройки подписей.

Примечание: текст и значение подписи доступны через свойства label и value объекта datum, лежащего в основе легенды.

labelFont — str, dict, ExprRef

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

labelFontSize — dict, float, ExprRef

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

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

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

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

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

labelOffset — dict, float, ExprRef

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

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

labelOpacity — dict, float, ExprRef

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

labelOverlap — bool, dict, ExprRef, LabelOverlap, Literal['greedy', 'parity']

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

Значение по умолчанию: true.

labelPadding — dict, float, ExprRef

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

labelSeparation — dict, float, ExprRef

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

legendX — dict, float, ExprRef

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

legendY — dict, float, ExprRef

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

offset — dict, float, ExprRef

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

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

orient — LegendOrient, Literal['none', 'left', 'right', 'top', 'bottom', 'top-left', 'top-right', 'bottom-left', 'bottom-right']

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

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

padding — dict, float, ExprRef

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

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

rowPadding — dict, float, ExprRef

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

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

strokeColor — 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'], None

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

symbolDash — dict, Sequence[float], ExprRef

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

symbolDashOffset — dict, float, ExprRef

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

symbolFillColor — 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'], None

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

symbolLimit — dict, float, ExprRef

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

symbolOffset — dict, float, ExprRef

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

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

symbolOpacity — dict, float, ExprRef

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

symbolSize — dict, float, ExprRef

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

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

symbolStrokeColor — 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'], None

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

symbolStrokeWidth — dict, float, ExprRef

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

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

symbolType — str, dict, ExprRef, SymbolShape

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

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

tickCount — dict, float, ExprRef, TickCount, TimeInterval, TimeIntervalStep, Literal['millisecond', 'second', 'minute', 'hour', 'day', 'week', 'month', 'year']

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

tickMinStep — dict, float, ExprRef

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

Значение по умолчанию: undefined.

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']

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

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

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

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

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

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

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

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'], None

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

titleFont — str, dict, ExprRef

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

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

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

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

titleLineHeight — dict, float, ExprRef

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

titleOpacity — dict, float, ExprRef

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

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

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

titlePadding — dict, float, ExprRef

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

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

type — Literal['symbol', 'gradient']

Тип легенды: "symbol" для дискретной легенды и "gradient" для непрерывного цветового градиента.

Значение по умолчанию: "gradient" для количественных полей без разбиения на интервалы и временных полей; в остальных случаях "symbol".

values — dict, Sequence[str], Sequence[bool], Sequence[float], ExprRef, Sequence[dict, DateTime]

Явно заданные значения, отображаемые в легенде.

zindex — float

Неотрицательное целое число, задающее z-индекс легенды. При zindex = 0 легенда рисуется позади всех элементов диаграммы. Для размещения перед ними используйте zindex = 1.

Конструктор

__init__(aria=Undefined, clipHeight=Undefined, columnPadding=Undefined, columns=Undefined, cornerRadius=Undefined, description=Undefined, direction=Undefined, fillColor=Undefined, format=Undefined, formatType=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, gridAlign=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelExpr=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, labelOpacity=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, legendX=Undefined, legendY=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, strokeColor=Undefined, symbolDash=Undefined, symbolDashOffset=Undefined, symbolFillColor=Undefined, symbolLimit=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, tickCount=Undefined, tickMinStep=Undefined, title=Undefined, titleAlign=Undefined, titleAnchor=Undefined, titleBaseline=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleLineHeight=Undefined, titleOpacity=Undefined, titleOrient=Undefined, titlePadding=Undefined, type=Undefined, values=Undefined, zindex=Undefined, **kwds)

Методы

Метод Описание
__init__
copy(deep, ignore) Возвращает копию объекта.
from_dict(dct, validate) Создаёт экземпляр класса из представления в виде словаря.
from_json(json_string, validate, **kwargs) Создаёт экземпляр объекта из корректной строки JSON.
resolve_references(schema) Разрешает ссылки в контексте схемы объекта или корневой схемы.
to_dict(validate, ignore, context) Возвращает представление объекта в виде словаря.
to_json(validate, indent, sort_keys, ignore, …) Возвращает представление объекта в строке JSON.
validate(instance, schema) Проверяет экземпляр по схеме класса в контексте корневой схемы.
validate_property(name, value, schema) Проверяет свойство по его схеме в контексте корневой схемы.