altair.Encoding
altair.Encoding(angle=Undefined, color=Undefined, description=Undefined, detail=Undefined, fill=Undefined, fillOpacity=Undefined, href=Undefined, key=Undefined, latitude=Undefined, latitude2=Undefined, longitude=Undefined, longitude2=Undefined, opacity=Undefined, order=Undefined, radius=Undefined, radius2=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeDash=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, time=Undefined, tooltip=Undefined, url=Undefined, x=Undefined, x2=Undefined, xError=Undefined, xError2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, yOffset=Undefined, **kwds)
Обёртка схемы Encoding.
Параметры
angle—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberУгол поворота точечных и текстовых меток.
color—dict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnullЦвет меток — заливка или обводка в зависимости от свойства
filledопределения метки. По умолчаниюcolorзадаёт заливку для"area","bar","tick","text","trail","circle"и"square", а для"line"и"point"— обводку.Значение по умолчанию: если не задано, зависит от свойства
colorнастроек меток.Примечания:
- Чтобы отдельно управлять цветами заливки и обводки, используйте каналы
fillиstroke. Они имеют приоритет надcolorи могут переопределить его при конфликте. - Дополнительные сведения о настройке цветовой схемы приведены в документации шкал.
- Чтобы отдельно управлять цветами заливки и обводки, используйте каналы
description—dict, StringFieldDefWithCondition, StringValueDefWithConditionТекстовое описание метки для доступности ARIA (только для вывода SVG). В SVG это описание записывается в атрибут
"aria-label".detail—dict, FieldDefWithoutScale, Sequence[dict, FieldDefWithoutScale]Дополнительная детализация для группировки данных в агрегированных представлениях и метках линий, следов и областей без сопоставления данных конкретному визуальному каналу.
fill—dict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnullЦвет заливки меток. Значение по умолчанию: если не задано, зависит от свойства
colorнастроек меток.Примечание: кодирование
fillимеет приоритет надcolorи может переопределить его при конфликте.fillOpacity—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberНепрозрачность заливки меток.
Значение по умолчанию: если не задано, зависит от свойства
fillOpacityнастроек меток.href—dict, StringFieldDefWithCondition, StringValueDefWithConditionURL, который открывается при щелчке мышью.
key—dict, FieldDefWithoutScaleПоле данных, используемое как уникальный ключ привязки. При обновлении данных визуализации значение ключа сопоставляет записи данных существующим экземплярам меток. Канал ключа сохраняет соответствие объектов при анимированных переходах с динамическими данными.
latitude—dict, DatumDef, LatLongDef, LatLongFieldDefШирота меток в географической проекции.
latitude2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefВторая координата широты для интервальных меток
"area","bar","rect"и"rule"в географической проекции.longitude—dict, DatumDef, LatLongDef, LatLongFieldDefДолгота меток в географической проекции.
longitude2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefВторая координата долготы для интервальных меток
"area","bar","rect"и"rule"в географической проекции.opacity—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberНепрозрачность меток.
Значение по умолчанию: если не задано, зависит от свойства
opacityнастроек меток.order—dict, OrderOnlyDef, OrderFieldDef, OrderValueDef, Sequence[dict, OrderFieldDef]Порядок меток.
- Для меток с накоплением канал
orderзадаёт порядок накопления. - Для линий и следов задаёт порядок точек данных в линии. Полезен для точечной диаграммы с соединёнными точками. Значение
{"value": null}сохраняет исходный порядок данных в источниках. - В остальных случаях задаёт порядок слоёв меток.
Примечание: в агрегированных диаграммах поле
orderнужно агрегировать, чтобы не создавать дополнительные группы агрегирования.- Для меток с накоплением канал
radius—dict, PolarDef, PositionValueDef, PositionDatumDefBase, PositionFieldDefBaseВнешний радиус дуговых меток в пикселях.
radius2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefВнутренний радиус дуговых меток в пикселях.
shape—dict, ShapeDef, FieldOrDatumDefWithConditionDatumDefstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull, ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnullФорма метки.
- Для меток
pointподдерживаются:- формы
"circle","square","cross","diamond","triangle-up","triangle-down","triangle-right"и"triangle-left"; - линейный символ
"stroke"; - центрированные направленные формы
"arrow","wedge"и"triangle"; - пользовательская строка контура SVG. Для правильного масштабирования контур должен вписываться в квадрат с координатами от -1 до 1 по обеим осям.
- формы
- Для меток
geoshapeдолжно быть определением поля с данными GeoJSON.
Значение по умолчанию: если не задано, зависит от свойства
shapeнастроек точечных меток; если и оно не задано, используется"circle".- Для меток
size—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberРазмер метки.
- Для
"point","square"и"circle"— размер символа, то есть площадь метки в пикселях. - Для
"bar"и"tick"— размер столбца или штриха. - Для
"text"— размер шрифта текста. - Для
"line","area"и"rect"не поддерживается. Для линии переменного размера используйте"trail".
- Для
stroke—dict, ColorDef, FieldOrDatumDefWithConditionDatumDefGradientstringnull, FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull, ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnullЦвет обводки меток. Значение по умолчанию: если не задано, зависит от свойства
colorнастроек меток.Примечание: кодирование
strokeимеет приоритет надcolorи может переопределить его при конфликте.strokeDash—dict, NumericArrayMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumberArray, FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray, ValueDefWithConditionMarkPropFieldOrDatumDefnumberArrayШтриховой узор обводки меток.
Значение по умолчанию:
[1,0](сплошная линия).strokeOpacity—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberНепрозрачность обводки меток.
Значение по умолчанию: если не задано, зависит от свойства
strokeOpacityнастроек меток.strokeWidth—dict, NumericMarkPropDef, FieldOrDatumDefWithConditionDatumDefnumber, FieldOrDatumDefWithConditionMarkPropFieldDefnumber, ValueDefWithConditionMarkPropFieldOrDatumDefnumberТолщина обводки меток.
Значение по умолчанию: если не задано, зависит от свойства
strokeWidthнастроек меток.text—dict, TextDef, ValueDefWithConditionStringFieldDefText, FieldOrDatumDefWithConditionStringDatumDefText, FieldOrDatumDefWithConditionStringFieldDefTextТекст метки
text.theta—dict, PolarDef, PositionValueDef, PositionDatumDefBase, PositionFieldDefBaseДля arc — угловая длина дуги в радианах, если
theta2не задан, иначе начальный угол. Ноль направлен вверх, или на север; положительные значения идут по часовой стрелке. Для text — угол в полярных координатах, в радианах.theta2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefКонечный угол дуги в радианах. Ноль направлен вверх, или на север; положительные значения идут по часовой стрелке.
time—dict, TimeDeftooltip—dict, StringFieldDefWithCondition, StringValueDefWithCondition, Sequence[dict, StringFieldDef], NoneТекст всплывающей подсказки при наведении мыши. Кодирование
tooltipпереопределяет свойствоtooltipопределения метки.Подробное описание всплывающих подсказок в Vega-Lite см. в документации
tooltip.url—dict, StringFieldDefWithCondition, StringValueDefWithConditionURL метки изображения.
x—dict, PositionDef, PositionDatumDef, PositionFieldDef, PositionValueDefКоордината x примитива или ширина горизонтальных bar и area, если не заданы
x2илиwidth. Значение может быть числом или строкой"width", обозначающей ширину диаграммы.x2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefВторая координата x для area, bar, rect и rule с диапазоном. Значение может быть числом или строкой
"width", обозначающей ширину диаграммы.xError—dict, ValueDefnumber, SecondaryFieldDefПогрешность координат x для меток
"errorbar"и"errorband", заданных через значения погрешностей.xError2—dict, ValueDefnumber, SecondaryFieldDefВторичная погрешность координат x для меток
"errorbar"и"errorband", заданных через значения погрешностей.xOffset—dict, OffsetDef, ScaleDatumDef, ScaleFieldDef, ValueDefnumberСмещение положения меток по оси x.
y—dict, PositionDef, PositionDatumDef, PositionFieldDef, PositionValueDefКоордината y примитива или высота вертикальных bar и area, если не заданы
y2илиheight. Значение может быть числом или строкой"height", обозначающей высоту диаграммы.y2—dict, DatumDef, Position2Def, PositionValueDef, SecondaryFieldDefВторая координата y для area, bar, rect и rule с диапазоном. Значение может быть числом или строкой
"height", обозначающей высоту диаграммы.yError—dict, ValueDefnumber, SecondaryFieldDefПогрешность координат y для меток
"errorbar"и"errorband", заданных через значения погрешностей.yError2—dict, ValueDefnumber, SecondaryFieldDefВторичная погрешность координат y для меток
"errorbar"и"errorband", заданных через значения погрешностей.yOffset—dict, OffsetDef, ScaleDatumDef, ScaleFieldDef, ValueDefnumberСмещение положения меток по оси y.
Конструктор
__init__(angle=Undefined, color=Undefined, description=Undefined, detail=Undefined, fill=Undefined, fillOpacity=Undefined, href=Undefined, key=Undefined, latitude=Undefined, latitude2=Undefined, longitude=Undefined, longitude2=Undefined, opacity=Undefined, order=Undefined, radius=Undefined, radius2=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeDash=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, theta=Undefined, theta2=Undefined, time=Undefined, tooltip=Undefined, url=Undefined, x=Undefined, x2=Undefined, xError=Undefined, xError2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yError=Undefined, yError2=Undefined, yOffset=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) |
Проверяет свойство по его схеме в контексте корневой схемы. |