altair.Href

altair.Href(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, format=Undefined, formatType=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)

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

Параметры

shorthand — str, dict, Sequence[str], RepeatRef

Сокращённая запись поля, агрегатной функции и типа.

aggregate — dict, Aggregate, ArgmaxDef, ArgminDef, NonArgAggregateOp, Literal['average', 'count', 'distinct', 'max', 'mean', 'median', 'min', 'missing', 'product', 'q1', 'q3', 'ci0', 'ci1', 'stderr', 'stdev', 'stdevp', 'sum', 'valid', 'values', 'variance', 'variancep', 'exponential', 'exponentialb']

Функция агрегирования поля, например "mean", "sum", "median", "min", "max", "count".

По умолчанию: undefined (None).

См. агрегирование.

bandPosition — float

Относительное положение внутри полосы шкалы, интервала группировки, единицы времени или сегмента накопления. Значение 0 помещает примитив в начало полосы, 0.5 — в середину.

bin — bool, dict, Literal['binned'], BinParams, None

Флаг группировки количественного поля по интервалам, объект её параметров либо "binned", означающее, что данные канала x или y уже сгруппированы до передачи Vega-Lite.

• true использует параметры группировки по умолчанию.
• При "binned" поле начала интервала связывается с x или y, конца — с x2 или y2. Шкала и ось оформляются как при группировке средствами Vega-Lite. Чтобы деления учитывали шаг интервалов, можно задать свойство оси tickMinStep.

По умолчанию: false. См. Bin.

condition — dict, ConditionalValueDefstringExprRef, ConditionalParameterValueDefstringExprRef, ConditionalPredicateValueDefstringExprRef, Sequence[dict, ConditionalValueDefstringExprRef, ConditionalParameterValueDefstringExprRef, ConditionalPredicateValueDefstringExprRef]

Одно или несколько определений визуального значения с параметром или проверяемым предикатом.

Примечание: condition в определении поля может содержать только условные определения значений: в одном канале Vega-Lite допускает не более одного закодированного поля.

field — str, dict, Field, FieldName, RepeatRef

Обязательное поле. Строка с именем поля, из которого берётся значение, или объект значений, перебираемых оператором repeat.

Примечания:

1. Точки и скобки позволяют обращаться к вложенным объектам: "field": "foo.bar" или "field": "foo['bar']". Если точка или скобки входят в обычное имя, экранируйте их обратной косой чертой: "a\\.b", "a\\[0\\]". Подробнее см. поля.
2. При aggregate: "count" свойство field не требуется.

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.

timeUnit — dict, TimeUnit, MultiTimeUnit, BinnedTimeUnit, SingleTimeUnit, TimeUnitParams, UtcMultiTimeUnit, UtcSingleTimeUnit, LocalMultiTimeUnit, LocalSingleTimeUnit, Literal['binnedyear', 'binnedyearquarter', 'binnedyearquartermonth', 'binnedyearmonth', 'binnedyearmonthdate', 'binnedyearmonthdatehours', 'binnedyearmonthdatehoursminutes', 'binnedyearmonthdatehoursminutesseconds', 'binnedyearweek', 'binnedyearweekday', 'binnedyearweekdayhours', 'binnedyearweekdayhoursminutes', 'binnedyearweekdayhoursminutesseconds', 'binnedyeardayofyear', 'binnedutcyear', 'binnedutcyearquarter', 'binnedutcyearquartermonth', 'binnedutcyearmonth', 'binnedutcyearmonthdate', 'binnedutcyearmonthdatehours', 'binnedutcyearmonthdatehoursminutes', 'binnedutcyearmonthdatehoursminutesseconds', 'binnedutcyearweek', 'binnedutcyearweekday', 'binnedutcyearweekdayhours', 'binnedutcyearweekdayhoursminutes', 'binnedutcyearweekdayhoursminutesseconds', 'binnedutcyeardayofyear', 'utcyear', 'utcquarter', 'utcmonth', 'utcweek', 'utcday', 'utcdayofyear', 'utcdate', 'utchours', 'utcminutes', 'utcseconds', 'utcmilliseconds', 'year', 'quarter', 'month', 'week', 'day', 'dayofyear', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'utcyearquarter', 'utcyearquartermonth', 'utcyearmonth', 'utcyearmonthdate', 'utcyearmonthdatehours', 'utcyearmonthdatehoursminutes', 'utcyearmonthdatehoursminutesseconds', 'utcyearweek', 'utcyearweekday', 'utcyearweekdayhours', 'utcyearweekdayhoursminutes', 'utcyearweekdayhoursminutesseconds', 'utcyeardayofyear', 'utcquartermonth', 'utcmonthdate', 'utcmonthdatehours', 'utcmonthdatehoursminutes', 'utcmonthdatehoursminutesseconds', 'utcweekday', 'utcweekdayhours', 'utcweekdayhoursminutes', 'utcweekdayhoursminutesseconds', 'utcdayhours', 'utcdayhoursminutes', 'utcdayhoursminutesseconds', 'utchoursminutes', 'utchoursminutesseconds', 'utcminutesseconds', 'utcsecondsmilliseconds', 'yearquarter', 'yearquartermonth', 'yearmonth', 'yearmonthdate', 'yearmonthdatehours', 'yearmonthdatehoursminutes', 'yearmonthdatehoursminutesseconds', 'yearweek', 'yearweekday', 'yearweekdayhours', 'yearweekdayhoursminutes', 'yearweekdayhoursminutesseconds', 'yeardayofyear', 'quartermonth', 'monthdate', 'monthdatehours', 'monthdatehoursminutes', 'monthdatehoursminutesseconds', 'weekday', 'weekdayhours', 'weekdayhoursminutes', 'weekdayhoursminutesseconds', 'dayhours', 'dayhoursminutes', 'dayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']

Единица времени, например year, yearmonth, month, hours, для временного поля либо временного поля, рассматриваемого как порядковое.

По умолчанию: undefined (None). См. TimeUnit.

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

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

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

Примечания:

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

type — StandardType, Literal['quantitative', 'ordinal', 'temporal', 'nominal']

Тип измерения поля или константы datum: "quantitative", "temporal", "ordinal", "nominal"; для Geoshape также "geojson".

Vega-Lite часто выводит тип автоматически. Явный тип нужен, если поле не номинальное и в кодировании не заданы aggregate (кроме argmin, argmax), bin, тип шкалы, собственный sort или timeUnit; также он нужен для порядковой шкалы поля с bin или timeUnit.

По умолчанию для поля: nominal, кроме следующих случаев:

• quantitative: есть bin или агрегирование, кроме argmin/argmax; канал — latitude или longitude; либо указан количественный тип шкалы.
• temporal: есть timeUnit либо шкала типа time или utc.
• ordinal: есть собственный порядок sort, шкала ordinal/point/band либо канал order.

Для константы datum: число — quantitative, строка — nominal, объект даты и времени — temporal.

Примечания:

• Тип описывает смысл данных, а не примитивный тип числа или строки. Числа могут означать количественные, порядковые или номинальные значения.
• Временные значения могут быть строками даты/времени, например "2015-03-07 12:32:17", "17:01", "2015-03-16", "2015", или числовой временной меткой, например 1552199579097.
• С bin используйте quantitative для линейной шкалы интервалов или ordinal для порядковой.
• С timeUnit используйте temporal для временной шкалы (по умолчанию) или ordinal для порядковой.
• С aggregate тип относится к результату: число различных категорий {"aggregate": "distinct", "field": "cat"} имеет тип quantitative.
• Вторичные каналы x2, y2, xError, yError не имеют собственного type: тип совпадает с основным каналом x или y.

См. типы данных.

Конструктор

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, format=Undefined, formatType=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)

Методы