altair.Scale
altair.Scale(align=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainRaw=Undefined, exponent=Undefined, interpolate=Undefined, nice=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, range=Undefined, rangeMax=Undefined, rangeMin=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, zero=Undefined, **kwds)
Обёртка схемы Scale.
Параметры
align—dict, float, ExprRefВыравнивание шагов внутри выходного диапазона шкалы.
Значение должно находиться в диапазоне
[0,1]. При0.5шаги центрируются внутри диапазона. Значения0и1сдвигают полосы к одному краю, например для размещения рядом с осью.Значение по умолчанию:
0.5.base—dict, float, ExprRefОснование логарифма шкалы
log; по умолчанию10.bins—dict, Sequence[float], ScaleBins, ScaleBinParamsГраницы интервалов можно передать шкале явным массивом или объектом спецификации интервалов. Допустимы:
- Массив значений границ, например
[0, 5, 10, 15, 20]. Должен включать начальную и конечную границы. Эти пять значений задают четыре интервала:[0-5),[5-10),[10-15),[15-20]. Элементами массива могут быть ссылки на сигналы. - Объект спецификации интервалов с размером шага
stepи необязательными границамиstartиstop. - Массив границ интервалов входной области шкалы. Если задан, оси и легенды используют эти границы при выборе делений и текстовых подписей.
- Массив значений границ, например
clamp—bool, dict, ExprRefПри значении
trueзначения за пределами входной области ограничиваются минимальным или максимальным значением выходного диапазона.Значение по умолчанию: определяется свойством
clampнастроек шкал; по умолчаниюtrue.constant—dict, float, ExprRefКонстанта, определяющая наклон функции symlog вблизи нуля. Используется только для шкал
symlog.Значение по умолчанию:
1.domain—dict, ExprRef, Literal['unaggregated'], DomainUnionWith, ParameterExtent, Sequence[str, bool, dict, float, ExprRef, DateTime, None]Пользовательские значения входной области: постоянные или динамические, определяемые параметром.
- Постоянный
domainдля количественных полей может иметь вид:- массива из двух элементов с минимумом и максимумом; для расходящейся шкалы его можно сочетать с
domainMid; - массива более чем из двух элементов для кусочной количественной шкалы;
- строки
"unaggregated"для агрегированного входного поля, чтобы область включала исходные значения до агрегирования.
- массива из двух элементов с минимумом и максимумом; для расходящейся шкалы его можно сочетать с
- Постоянный
domainвременных полей может быть массивом из минимума и максимума в виде временных меток или объектов DateTime. - Постоянный
domainпорядковых и номинальных полей может быть массивом допустимых входных значений. - Для объединения постоянной области со значениями поля используйте объект со свойством
unionWith. Например,domain: {unionWith: [0, 100]}для количественной шкалы всегда включает[0, 100], но также включает значения поля за этими пределами. - Можно задать объект, определяющий поле или канал кодирования параметра, который интерактивно определяет входную область шкалы.
- Постоянный
domainMax—dict, float, ExprRef, DateTimeМаксимальное значение входной области шкалы, переопределяющее свойство
domain. Предназначено только для шкал с непрерывной входной областью.domainMid—dict, float, ExprRefДобавляет одну промежуточную точку во входную область из двух элементов. Значение должно находиться между минимумом и максимумом области. Полезно для задания середины расходящихся цветовых шкал. Свойство
domainMidпредназначено только для шкал, поддерживающих непрерывные кусочные входные области.domainMin—dict, float, ExprRef, DateTimeМинимальное значение входной области шкалы, переопределяющее свойство
domain. Предназначено только для шкал с непрерывной входной областью.domainRaw—dict, ExprRefВыражение, возвращающее массив исходных значений. Если результат не
null, напрямую переопределяет свойствоdomain. Полезно для интерактивного перемещения или масштабирования шкалы. Сначала область шкалы может определяться данными, а затем изменяться в ответ на действия пользователя путём заданияrawDomain.exponent—dict, float, ExprRefПоказатель степени шкалы
pow.interpolate—dict, ExprRef, ScaleInterpolateEnum, ScaleInterpolateParams, Literal['rgb', 'lab', 'hcl', 'hsl', 'hsl-long', 'hcl-long', 'cubehelix', 'cubehelix-long']Метод интерполяции выходных значений. По умолчанию используется общий интерполятор чисел, дат, строк и цветов (в пространстве HCL). Для цветовых диапазонов позволяет интерполяцию в других цветовых пространствах:
rgb,hsl,hsl-long,lab,hcl,hcl-long,cubehelixиcubehelix-long. Варианты с-longиспользуют более длинные пути в полярных пространствах. Можно задать объект со строковым свойствомtypeи необязательным числовымgamma, применимым к интерполяторам rgb и cubehelix. Дополнительные сведения см. в документации d3-interpolate.- Значение по умолчанию:
hcl.
- Значение по умолчанию:
nice—bool, dict, float, ExprRef, TimeInterval, TimeIntervalStep, Literal['millisecond', 'second', 'minute', 'hour', 'day', 'week', 'month', 'year']Расширяет входную область до удобных округлённых границ. Обычно изменяет область шкалы, расширяя её границы до ближайшего округлённого значения. Полезно для области, вычисленной по данным с неудобными границами: например,
[0.201479…, 0.996679…]может стать[0.2, 1.0].Для количественных шкал, например линейной,
niceможет быть логическим значением или числом. Число задаёт желаемое количество делений, позволяя управлять шагом расширения границ и гарантируя, что деления точно покрывают область.Для временных полей со шкалами
timeиutcможно задать строку с интервалом:"millisecond","second","minute","hour","day","week","month"или"year". Можно также задать объект вида{"interval": "month", "step": 3}с числом шагов интервала. В этом примере границы привязываются к кварталам: январь, апрель, июль, октябрь.Значение по умолчанию:
trueдля количественных полей без разбиения на интервалы и без явно заданных границ области; иначеfalse.padding—dict, float, ExprRefДля непрерывных шкал расширяет входную область, чтобы обеспечить указанное число пикселей на каждом конце выходного диапазона. Для правильной работы диапазон должен выражаться в пикселях. Отступы учитываются до всех остальных корректировок, включая
zero,nice,domainMinиdomainMax.Для полосовых шкал — сокращённая запись одинакового значения
paddingInnerиpaddingOuter.Для точечных шкал — синоним
paddingOuter.Значение по умолчанию: для непрерывных шкал определяется свойством
continuousPaddingнастроек шкал. Для полосовых и точечных см.paddingInnerиpaddingOuter. По умолчанию Vega-Lite выбирает отступы так, чтобы ширина/высота = число уникальных значений × шаг.paddingInner—dict, float, ExprRefВнутренний промежуток в каждом шаге полосовой шкалы как доля размера шага. Значение должно находиться в диапазоне
[0,1].Для точечной шкалы свойство недопустимо: у неё нет внутренней ширины полос, а есть только шаги между точками.
Значение по умолчанию: определяется свойством
bandPaddingInnerнастроек шкал.paddingOuter—dict, float, ExprRefВнешние отступы на концах выходного диапазона полосовой или точечной шкалы как доля размера шага. Значение должно находиться в диапазоне
[0,1].Значение по умолчанию: определяется свойством
bandPaddingOuterнастроек шкал для полосовых шкал иpointPaddingдля точечных. По умолчанию Vega-Lite выбирает внешние отступы так, чтобы ширина/высота = число уникальных значений × шаг.range—dict, RangeEnum, FieldRange, Sequence[str, dict, float, Sequence[float], ExprRef], Literal['width', 'height', 'symbol', 'category', 'ordinal', 'ramp', 'diverging', 'heatmap']Выходной диапазон шкалы. Один из вариантов:
- Строка с именем предопределённого диапазона, например
"symbol"или"diverging". - Для непрерывных шкал — массив из минимума и максимума либо более длинный массив для кусочной шкалы.
- Для дискретных и дискретизирующих шкал — массив желаемых выходных значений или объект со свойством
field, указывающим поле этих значений. Например, если полеcolorсодержит имена цветов CSS, можно задатьrange: {field: "color"}.
Примечания:
- Для цветовых шкал вместо
rangeможно указать цветовую схемуscheme. - Явно заданный
rangeканалов x и y игнорируется. Диапазон настраивается через соответствующий размер представления:widthиheight.
- Строка с именем предопределённого диапазона, например
rangeMax—str, dict, float, ExprRefМаксимальное значение выходного диапазона шкалы, переопределяющее свойство
rangeили диапазон по умолчанию. Предназначено только для шкал с непрерывным выходным диапазоном.rangeMin—str, dict, float, ExprRefМинимальное значение выходного диапазона шкалы, переопределяющее свойство
rangeили диапазон по умолчанию. Предназначено только для шкал с непрерывным выходным диапазоном.reverse—bool, dict, ExprRefПри значении
trueменяет порядок выходных значений шкалы на обратный. Значение по умолчанию:false.round—bool, dict, ExprRefПри значении
trueокругляет числовые выходные значения до целых. Это может быть полезно для привязки к пиксельной сетке.Значение по умолчанию:
false.scheme—dict, ExprRef, Cyclical, Diverging, Categorical, ColorScheme, SchemeParams, SequentialMultiHue, SequentialSingleHue, Literal['accent', 'category10', 'category20', 'category20b', 'category20c', 'dark2', 'paired', 'pastel1', 'pastel2', 'set1', 'set2', 'set3', 'tableau10', 'tableau20', 'observable10', 'blueorange', 'blueorange-3', 'blueorange-4', 'blueorange-5', 'blueorange-6', 'blueorange-7', 'blueorange-8', 'blueorange-9', 'blueorange-10', 'blueorange-11', 'brownbluegreen', 'brownbluegreen-3', 'brownbluegreen-4', 'brownbluegreen-5', 'brownbluegreen-6', 'brownbluegreen-7', 'brownbluegreen-8', 'brownbluegreen-9', 'brownbluegreen-10', 'brownbluegreen-11', 'purplegreen', 'purplegreen-3', 'purplegreen-4', 'purplegreen-5', 'purplegreen-6', 'purplegreen-7', 'purplegreen-8', 'purplegreen-9', 'purplegreen-10', 'purplegreen-11', 'pinkyellowgreen', 'pinkyellowgreen-3', 'pinkyellowgreen-4', 'pinkyellowgreen-5', 'pinkyellowgreen-6', 'pinkyellowgreen-7', 'pinkyellowgreen-8', 'pinkyellowgreen-9', 'pinkyellowgreen-10', 'pinkyellowgreen-11', 'purpleorange', 'purpleorange-3', 'purpleorange-4', 'purpleorange-5', 'purpleorange-6', 'purpleorange-7', 'purpleorange-8', 'purpleorange-9', 'purpleorange-10', 'purpleorange-11', 'redblue', 'redblue-3', 'redblue-4', 'redblue-5', 'redblue-6', 'redblue-7', 'redblue-8', 'redblue-9', 'redblue-10', 'redblue-11', 'redgrey', 'redgrey-3', 'redgrey-4', 'redgrey-5', 'redgrey-6', 'redgrey-7', 'redgrey-8', 'redgrey-9', 'redgrey-10', 'redgrey-11', 'redyellowblue', 'redyellowblue-3', 'redyellowblue-4', 'redyellowblue-5', 'redyellowblue-6', 'redyellowblue-7', 'redyellowblue-8', 'redyellowblue-9', 'redyellowblue-10', 'redyellowblue-11', 'redyellowgreen', 'redyellowgreen-3', 'redyellowgreen-4', 'redyellowgreen-5', 'redyellowgreen-6', 'redyellowgreen-7', 'redyellowgreen-8', 'redyellowgreen-9', 'redyellowgreen-10', 'redyellowgreen-11', 'spectral', 'spectral-3', 'spectral-4', 'spectral-5', 'spectral-6', 'spectral-7', 'spectral-8', 'spectral-9', 'spectral-10', 'spectral-11', 'blues', 'tealblues', 'teals', 'greens', 'browns', 'greys', 'purples', 'warmgreys', 'reds', 'oranges', 'rainbow', 'sinebow', 'turbo', 'viridis', 'inferno', 'magma', 'plasma', 'cividis', 'bluegreen', 'bluegreen-3', 'bluegreen-4', 'bluegreen-5', 'bluegreen-6', 'bluegreen-7', 'bluegreen-8', 'bluegreen-9', 'bluepurple', 'bluepurple-3', 'bluepurple-4', 'bluepurple-5', 'bluepurple-6', 'bluepurple-7', 'bluepurple-8', 'bluepurple-9', 'goldgreen', 'goldgreen-3', 'goldgreen-4', 'goldgreen-5', 'goldgreen-6', 'goldgreen-7', 'goldgreen-8', 'goldgreen-9', 'goldorange', 'goldorange-3', 'goldorange-4', 'goldorange-5', 'goldorange-6', 'goldorange-7', 'goldorange-8', 'goldorange-9', 'goldred', 'goldred-3', 'goldred-4', 'goldred-5', 'goldred-6', 'goldred-7', 'goldred-8', 'goldred-9', 'greenblue', 'greenblue-3', 'greenblue-4', 'greenblue-5', 'greenblue-6', 'greenblue-7', 'greenblue-8', 'greenblue-9', 'orangered', 'orangered-3', 'orangered-4', 'orangered-5', 'orangered-6', 'orangered-7', 'orangered-8', 'orangered-9', 'purplebluegreen', 'purplebluegreen-3', 'purplebluegreen-4', 'purplebluegreen-5', 'purplebluegreen-6', 'purplebluegreen-7', 'purplebluegreen-8', 'purplebluegreen-9', 'purpleblue', 'purpleblue-3', 'purpleblue-4', 'purpleblue-5', 'purpleblue-6', 'purpleblue-7', 'purpleblue-8', 'purpleblue-9', 'purplered', 'purplered-3', 'purplered-4', 'purplered-5', 'purplered-6', 'purplered-7', 'purplered-8', 'purplered-9', 'redpurple', 'redpurple-3', 'redpurple-4', 'redpurple-5', 'redpurple-6', 'redpurple-7', 'redpurple-8', 'redpurple-9', 'yellowgreenblue', 'yellowgreenblue-3', 'yellowgreenblue-4', 'yellowgreenblue-5', 'yellowgreenblue-6', 'yellowgreenblue-7', 'yellowgreenblue-8', 'yellowgreenblue-9', 'yellowgreen', 'yellowgreen-3', 'yellowgreen-4', 'yellowgreen-5', 'yellowgreen-6', 'yellowgreen-7', 'yellowgreen-8', 'yellowgreen-9', 'yelloworangebrown', 'yelloworangebrown-3', 'yelloworangebrown-4', 'yelloworangebrown-5', 'yelloworangebrown-6', 'yelloworangebrown-7', 'yelloworangebrown-8', 'yelloworangebrown-9', 'yelloworangered', 'yelloworangered-3', 'yelloworangered-4', 'yelloworangered-5', 'yelloworangered-6', 'yelloworangered-7', 'yelloworangered-8', 'yelloworangered-9', 'darkblue', 'darkblue-3', 'darkblue-4', 'darkblue-5', 'darkblue-6', 'darkblue-7', 'darkblue-8', 'darkblue-9', 'darkgold', 'darkgold-3', 'darkgold-4', 'darkgold-5', 'darkgold-6', 'darkgold-7', 'darkgold-8', 'darkgold-9', 'darkgreen', 'darkgreen-3', 'darkgreen-4', 'darkgreen-5', 'darkgreen-6', 'darkgreen-7', 'darkgreen-8', 'darkgreen-9', 'darkmulti', 'darkmulti-3', 'darkmulti-4', 'darkmulti-5', 'darkmulti-6', 'darkmulti-7', 'darkmulti-8', 'darkmulti-9', 'darkred', 'darkred-3', 'darkred-4', 'darkred-5', 'darkred-6', 'darkred-7', 'darkred-8', 'darkred-9', 'lightgreyred', 'lightgreyred-3', 'lightgreyred-4', 'lightgreyred-5', 'lightgreyred-6', 'lightgreyred-7', 'lightgreyred-8', 'lightgreyred-9', 'lightgreyteal', 'lightgreyteal-3', 'lightgreyteal-4', 'lightgreyteal-5', 'lightgreyteal-6', 'lightgreyteal-7', 'lightgreyteal-8', 'lightgreyteal-9', 'lightmulti', 'lightmulti-3', 'lightmulti-4', 'lightmulti-5', 'lightmulti-6', 'lightmulti-7', 'lightmulti-8', 'lightmulti-9', 'lightorange', 'lightorange-3', 'lightorange-4', 'lightorange-5', 'lightorange-6', 'lightorange-7', 'lightorange-8', 'lightorange-9', 'lighttealblue', 'lighttealblue-3', 'lighttealblue-4', 'lighttealblue-5', 'lighttealblue-6', 'lighttealblue-7', 'lighttealblue-8', 'lighttealblue-9']Строка с именем цветовой схемы, например
"category10"или"blues", либо объект параметров схемы.Дискретные цветовые схемы применимы к дискретным и дискретизирующим шкалам. Непрерывные схемы предназначены для цветовых шкал.
Для пользовательской схемы задайте список значений как выходной диапазон шкалы.
Полный список поддерживаемых схем см. в справочнике цветовых схем Vega.
type—ScaleType, Literal['linear', 'log', 'pow', 'sqrt', 'symlog', 'identity', 'sequential', 'time', 'utc', 'quantile', 'quantize', 'threshold', 'bin-ordinal', 'ordinal', 'point', 'band']Тип шкалы. Vega-Lite поддерживает следующие категории:
- Непрерывные шкалы сопоставляют непрерывную входную область непрерывному выходному диапазону:
"linear","pow","sqrt","symlog","log","time"и"utc". - Дискретные шкалы сопоставляют дискретную входную область дискретному диапазону (
"ordinal") либо непрерывному ("band"и"point"). - Дискретизирующие шкалы сопоставляют непрерывную входную область дискретному диапазону:
"bin-ordinal","quantile","quantize"и"threshold".
Значение по умолчанию: см. таблицу типов шкал.
- Непрерывные шкалы сопоставляют непрерывную входную область непрерывному выходному диапазону:
zero—bool, dict, ExprRefПри значении
trueгарантирует включение нуля во входную область шкалы.Значение по умолчанию:
trueдля каналов x и y, если количественное поле не разбито на интервалы и пользовательскийdomainне задан; иначеfalse.Примечание: шкалы
log,timeиutcне поддерживаютzero.
Конструктор
__init__(align=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainRaw=Undefined, exponent=Undefined, interpolate=Undefined, nice=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, range=Undefined, rangeMax=Undefined, rangeMin=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, zero=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) |
Проверяет свойство по его схеме в контексте корневой схемы. |