Параметры каналов

Некоторые каналы кодирования принимают дополнительные параметры: свойства осей и шкал, заголовки, параметры группировки по интервалам, агрегирования, сортировки и многое другое.

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

X и Y

Каналы X и Y принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

axisanyOf(Axis, null)

Объект свойств линий сетки, делений и подписей оси. При null ось канала удаляется.

По умолчанию: стандартные свойства оси, если значение не задано.

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

fieldField

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

Примечания:

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

Объект свойств операции заполнения пропущенных значений Impute. Поле другого канала положения используется как key, а поле канала color, если задано, — как groupby.

См. Impute.

scaleanyOf(Scale, null)

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

stackanyOf(StackOffset, null, boolean)

Тип смещения при накоплении. Применяется только к каналам x, y, theta, radius с непрерывной областью данных. Например, stack для y настраивает накопление вертикальных столбцов.

По умолчанию: zero, если одновременно: примитив — bar, area или arc; канал меры x или y имеет линейную шкалу; хотя бы один канал, кроме положения, связан с неагрегированным полем, отличным от x и y. Иначе — null. См. Stack.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Color, Fill и Stroke

Каналы Color, Fill и Stroke принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

conditionanyOf(ConditionalValueDef<(Gradient|string|null|ExprRef)>, array(ConditionalValueDef<(Gradient|string|null|ExprRef)>))

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

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

fieldField

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

Примечания:

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

Объект свойств легенды. При null легенда канала удаляется.

По умолчанию: стандартные свойства легенды, если значение не задано.

scaleanyOf(Scale, null)

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Shape

Канал Shape принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

conditionanyOf(ConditionalValueDef<(string|null|ExprRef)>, array(ConditionalValueDef<(string|null|ExprRef)>))

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

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

fieldField

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

Примечания:

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

Объект свойств легенды. При null легенда канала удаляется.

По умолчанию: стандартные свойства легенды, если значение не задано.

scaleanyOf(Scale, null)

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Order

Канал Order принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

fieldField

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

Примечания:

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

Порядок сортировки: "ascending" (по умолчанию) или "descending".

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Angle, FillOpacity, Opacity, Size, StrokeOpacity и StrokeWidth

Каналы Angle, FillOpacity, Opacity, Size, StrokeOpacity и StrokeWidth принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

conditionanyOf(ConditionalValueDef<(number|ExprRef)>, array(ConditionalValueDef<(number|ExprRef)>))

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

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

fieldField

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

Примечания:

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

Объект свойств легенды. При null легенда канала удаляется.

По умолчанию: стандартные свойства легенды, если значение не задано.

scaleanyOf(Scale, null)

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

StrokeDash

Канал StrokeDash принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

conditionanyOf(ConditionalValueDef<(number[]|ExprRef)>, array(ConditionalValueDef<(number[]|ExprRef)>))

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

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

fieldField

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

Примечания:

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

Объект свойств легенды. При null легенда канала удаляется.

По умолчанию: стандартные свойства легенды, если значение не задано.

scaleanyOf(Scale, null)

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Row и Column

Каналы Row, Column и Facet принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

alignLayoutAlign

Выравнивание панелей разбиения по строкам и столбцам. Значения: "all", "each", "none".

  • none — последовательное размещение соседних панелей без общей сетки.
  • each — выравнивание в сетку, но строки и столбцы могут иметь разные размеры.
  • all — выравнивание в сетку с одинаковыми размерами строк и столбцов, определяемыми максимальным размером. Строковое значение применяется к обоим направлениям.

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

centerboolean

Центрировать ли панели разбиения относительно соответствующих строк и столбцов.

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

fieldField

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

Примечания:

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

Объект свойств заголовка панели разбиения.

sortanyOf(SortArray, SortOrder, EncodingSortField, null)

Порядок сортировки поля. Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей:

По умолчанию: "ascending". Для row и column значение null не поддерживается.

spacingnumber

Расстояние между панелями разбиения в пикселях.

По умолчанию: свойство spacing конфигурации композиции, обычно 20.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Facet

Канал Facet принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

alignanyOf(LayoutAlign, RowCol<LayoutAlign>)

Выравнивание строк и столбцов сетки: "all", "each", "none".

  • none — последовательное размещение соседних представлений.
  • each — сетка с возможными различиями размеров строк и столбцов.
  • all — сетка с одинаковыми размерами строк и столбцов по максимальному размеру; строка задаёт оба направления.

Объект {"row": string, "column": string} позволяет задать разные правила для строк и столбцов.

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

bandPositionnumber

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

binanyOf(boolean, BinParams, null)

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

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

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

bounds['full', 'flush']

Способ вычисления границ панели: full (по умолчанию) или flush.

  • full учитывает все границы, включая оси, заголовок и легенду.
  • flush учитывает только заданную ширину и высоту представления. Подходит для равномерной сетки панелей без осей и легенд.

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

centeranyOf(boolean, RowCol<boolean>)

Центрировать ли представления относительно строк и столбцов. Объект {"row": boolean, "column": boolean} задаёт разные значения по направлениям.

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

columnsnumber

Число столбцов композиции.

По умолчанию: undefined, то есть неограниченное число столбцов в одной строке. Для concat это эквивалент hconcat, для facet и repeat — использование канала column.

Примечания:

  1. Свойство применяется только к переносимому concat, а не hconcat/vconcat, и к facet/repeat с одним полем или определением повторения без вложенного разбиения по строкам и столбцам.
  2. Значение 1 эквивалентно vconcat для concat и каналу row для facet/repeat.
fieldField

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

Примечания:

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

Объект свойств заголовка панели разбиения.

sortanyOf(SortArray, SortOrder, EncodingSortField, null)

Порядок сортировки поля. Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей:

По умолчанию: "ascending". Для row и column значение null не поддерживается.

spacinganyOf(number, RowCol<number>)

Расстояние между представлениями композиции в пикселях. Объект {"row": number, "column": number} позволяет задать его отдельно для строк и столбцов.

По умолчанию: свойство spacing конфигурации композиции, обычно 20.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Text

Канал Text принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

conditionanyOf(ConditionalValueDef<(Text|ExprRef)>, array(ConditionalValueDef<(Text|ExprRef)>))

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

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

fieldField

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

Примечания:

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

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

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

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

formatTypestring

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

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

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Href, Tooltip, Url

Каналы Href, Tooltip и Url принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

conditionanyOf(ConditionalValueDef<(string|ExprRef)>, array(ConditionalValueDef<(string|ExprRef)>))

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

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

fieldField

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

Примечания:

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

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

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

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

formatTypestring

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

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

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Detail

Канал Detail принимает следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

fieldField

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

Примечания:

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

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Latitude и Longitude

Каналы Latitude и Longitude принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binnull

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

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

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

fieldField

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

Примечания:

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

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Radius и Theta

Каналы Radius и Theta принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binanyOf(boolean, BinParams, string, null)

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

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

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

fieldField

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

Примечания:

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

Объект свойств шкалы канала. Шкала преобразует значения области данных — числа, даты, строки — в визуальные значения: пиксели, цвета, размеры.

При null шкала отключается, и значение данных кодируется непосредственно.

По умолчанию: стандартные свойства шкалы, если значение не задано.

sortSort

Порядок сортировки закодированного поля.

Для непрерывных полей (quantitative, temporal) — "ascending" или "descending".

Для дискретных полей доступны:

  • "ascending" или "descending" — естественный порядок значений JavaScript.
  • Имя канала, например "x", "y", с необязательным минусом для убывания. Запись "sort": "-x" равнозначна "sort": {"encoding": "x", "order": "descending"}.
  • Определение сортировки по другому полю.
  • Массив желаемого порядка. Неуказанные значения следуют после перечисленных в исходном порядке. Для дискретного времени допустимы объекты DateTime. Для единиц "month" и "day" можно использовать английские названия месяцев и дней без учёта регистра либо трёхбуквенные сокращения, например "Mon", "Tue".
  • null — без сортировки.

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

Примечание: null и сортировка по другому каналу не поддерживаются для row и column. См. Sort.

stackanyOf(StackOffset, null, boolean)

Тип смещения при накоплении. Применяется только к каналам x, y, theta, radius с непрерывной областью данных. Например, stack для y настраивает накопление вертикальных столбцов.

По умолчанию: zero, если одновременно: примитив — bar, area или arc; канал меры x или y имеет линейную шкалу; хотя бы один канал, кроме положения, связан с неагрегированным полем, отличным от x и y. Иначе — null. См. Stack.

timeUnitanyOf(TimeUnit, BinnedTimeUnit, TimeUnitParams)

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

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

titleanyOf(Text, null)

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

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

Примечания:

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

Тип измерения поля или константы 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.

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

Latitude2, Longitude2, Radius2, Theta2, X2, Y2, XError, YError, XError2 и YError2

Каналы Latitude2, Longitude2, Radius2, Theta2, X2, Y2, XError, YError, XError2 и YError2 принимают следующие параметры:

Нажмите, чтобы показать таблицу
СвойствоТипОписание
aggregateAggregate

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

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

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

bandPositionnumber

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

binnull

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

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

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

fieldField

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

Примечания:

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

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

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

titleanyOf(Text, null)

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

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

Примечания:

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