altair.Size#

class altair.Size(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, legend=Undefined, scale=Undefined, sort=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

Size schema 包装器。

参数:

shorthandstr, dict, Sequence[str], RepeatRef

field、aggregate 和 type 的简写

aggregatedict, 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 (无)

另见： aggregate 文档。

bandPositionfloat

在堆叠、分箱、时间单位或带宽尺度上的相对位置。例如，如果设置为 0，标记将定位在带宽的起始处；如果设置为 0.5，则位于带宽的中间。

binbool, dict, BinParams, None

一个标志，用于对 quantitative（定量）字段进行分箱处理；定义分箱参数的对象；或指示 x 或 y 通道的数据在导入 Vega-Lite 之前已进行分箱处理 ("binned")。

如果为 true，将应用默认的分箱参数。
如果为 "binned"，表示 x（或 y）通道的数据已进行分箱处理。你可以将分箱起始字段映射到 x（或 y），将分箱结束字段映射到 x2（或 y2）。刻度和坐标轴的格式将类似于 Vega-Lite 中的分箱。要根据分箱步长调整坐标轴刻度，还可以设置坐标轴的 tickMinStep 属性。

默认值： false

另见： bin 文档。

conditiondict, ConditionalValueDefnumberExprRef, ConditionalParameterValueDefnumberExprRef, ConditionalPredicateValueDefnumberExprRef, Sequence[dict, ConditionalValueDefnumberExprRef, ConditionalParameterValueDefnumberExprRef, ConditionalPredicateValueDefnumberExprRef]

一个或多个带参数或测试谓词的值定义。

注意： 字段定义的 condition 属性只能包含条件值定义，因为 Vega-Lite 每个编码通道最多只允许一个编码字段。

fieldstr, dict, Field, FieldName, RepeatRef

必需。 定义从中提取数据值的字段名称的字符串，或定义来自 repeat 操作符的迭代值的对象。

另见： field 文档。

注意： 1) 点 (.) 和方括号 ([ 和 ]) 可用于访问嵌套对象（例如，"field": "foo.bar" 和 "field": "foo['bar']"）。如果字段名称包含点或方括号但不是嵌套的，可以使用 \\ 对点和方括号进行转义（例如，"a\\.b" 和 "a\\[0\\]"）。有关转义的更多详细信息，请参阅field 文档。2) 如果 aggregate 为 count，则不需要 field。

legenddict, Legend, None

定义图例属性的对象。如果为 null，将移除该编码通道的图例。

默认值： 如果未定义，则应用默认的图例属性。

另见： legend 文档。

scaledict, Scale, None

定义通道刻度属性的对象，刻度是将数据域中的值（数字、日期、字符串等）转换为编码通道视觉值（像素、颜色、大小）的函数。

如果为 null，刻度将被禁用，数据值将直接编码。

默认值： 如果未定义，则应用默认的刻度属性。

另见： scale 文档。

sortdict, Sort, Sequence[str], Sequence[bool], Sequence[float], SortArray, SortOrder, AllSortString, SortByChannel, SortByEncoding, EncodingSortField, SortByChannelDesc, Sequence[dict, DateTime], Literal[‘-x’, ‘-y’, ‘-color’, ‘-fill’, ‘-stroke’, ‘-strokeWidth’, ‘-size’, ‘-shape’, ‘-fillOpacity’, ‘-strokeOpacity’, ‘-opacity’, ‘-text’, ‘ascending’, ‘descending’, ‘x’, ‘y’, ‘color’, ‘fill’, ‘stroke’, ‘strokeWidth’, ‘size’, ‘shape’, ‘fillOpacity’, ‘strokeOpacity’, ‘opacity’, ‘text’], None

编码字段的排序顺序。

对于连续字段（定量或时间），sort 可以是 "ascending"（升序）或 "descending"（降序）。

对于离散字段，sort 可以是以下之一：

"ascending"（升序）或 "descending"（降序）—— 根据值在 JavaScript 中的自然顺序进行排序。
指定要排序的编码通道名称的字符串（例如 "x" 或 "y"），可以选择加上减号前缀表示降序（例如 "-x" 按 x 字段降序排序）。此通道字符串是sort-by-encoding 定义的缩写形式。例如，"sort": "-x" 等价于 "sort": {"encoding": "x", "order": "descending"}。
用于按另一个字段排序的排序字段定义。
一个指定字段值优先顺序的数组。在这种情况下，排序顺序将遵循数组中的值，然后是任何未指定值的原始顺序。对于离散时间字段，排序数组中的值可以是日期时间定义对象。此外，对于时间单位 "month" 和 "day"，值可以是月份或日期的名称（不区分大小写）或其 3 个字母的缩写（例如 "Mon"、"Tue"）。
null 表示不进行排序。

默认值： "ascending"

注意： null 和按另一个通道排序对于 row 和 column 不支持。

另见： sort 文档。

timeUnitdict, TimeUnit, MultiTimeUnit, BinnedTimeUnit, SingleTimeUnit, TimeUnitParams, UtcMultiTimeUnit, UtcSingleTimeUnit, LocalMultiTimeUnit, LocalSingleTimeUnit, Literal[‘binnedutcyear’, ‘binnedutcyearquarter’, ‘binnedutcyearquartermonth’, ‘binnedutcyearmonth’, ‘binnedutcyearmonthdate’, ‘binnedutcyearmonthdatehours’, ‘binnedutcyearmonthdatehoursminutes’, ‘binnedutcyearmonthdatehoursminutesseconds’, ‘binnedutcyearweek’, ‘binnedutcyearweekday’, ‘binnedutcyearweekdayhours’, ‘binnedutcyearweekdayhoursminutes’, ‘binnedutcyearweekdayhoursminutesseconds’, ‘binnedutcyeardayofyear’, ‘binnedyear’, ‘binnedyearquarter’, ‘binnedyearquartermonth’, ‘binnedyearmonth’, ‘binnedyearmonthdate’, ‘binnedyearmonthdatehours’, ‘binnedyearmonthdatehoursminutes’, ‘binnedyearmonthdatehoursminutesseconds’, ‘binnedyearweek’, ‘binnedyearweekday’, ‘binnedyearweekdayhours’, ‘binnedyearweekdayhoursminutes’, ‘binnedyearweekdayhoursminutesseconds’, ‘binnedyeardayofyear’, ‘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 (无)

另见： timeUnit 文档。

titlestr, Text, Sequence[str], None

字段的标题。如果为 null，将移除标题。

默认值： 从字段名称和转换函数（aggregate、bin 和 timeUnit）派生。如果字段具有聚合函数，函数将作为标题的一部分显示（例如，"Sum of Profit"）。如果字段进行了分箱或应用了时间单位，应用的函数将显示在括号中（例如，"Profit (binned)"，"Transaction Date (year-month)"）。否则，标题就是字段名称。

注意:

1) 您可以通过在 config 中提供 fieldTitle 属性或通过 compile 函数的选项提供 fieldTitle 函数来定制默认的字段标题格式。

2) 如果同时定义了字段定义的 title 以及轴、标题或图例的 title，则将使用轴/标题/图例的标题。

typeStandardType, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’]

编码字段或常量值（datum）的测量类型（"quantitative"（定量）、"temporal"（时间）、"ordinal"（有序）或 "nominal"（名义））。它也可以是 "geojson" 类型，用于编码 ‘geoshape’。

在许多情况下，Vega-Lite 会自动推断数据类型，如下文所述。但是，字段类型在以下情况下是必需的：(1) 该字段不是名义类型，且字段编码没有指定 aggregate（argmin 和 argmax 除外）、bin、刻度类型、自定义 sort 顺序或 timeUnit；或 (2) 如果您希望对带有 bin 或 timeUnit 的字段使用有序刻度。

默认值

1) 对于数据 field，除非字段编码具有满足以下条件的 aggregate、channel、bin、刻度类型、sort 或 timeUnit，否则 "nominal"（名义）是默认数据类型：

如果 (1) 编码字段包含 bin 或 aggregate（"argmin" 和 "argmax" 除外），(2) 编码通道是 latitude（纬度）或 longitude（经度）通道，或 (3) 指定的刻度类型是定量刻度，则 "quantitative"（定量）是默认类型。
如果 (1) 编码字段包含 timeUnit，或 (2) 指定的刻度类型是时间刻度或 utc 刻度，则 "temporal"（时间）是默认类型。
如果 (1) 编码字段包含自定义排序顺序，(2) 指定的刻度类型是有序/点/带宽刻度，或 (3) 编码通道是 order（顺序），则 "ordinal"（有序）是默认类型。

对于数据域中的常量值（datum）

如果 datum 是数字，则为 "quantitative"（定量）
如果 datum 是字符串，则为 "nominal"（名义）
如果 datum 是日期时间对象，则为 "temporal"（时间）

注意

数据 type 描述的是数据的语义，而不是基本数据类型（数字、字符串等）。相同基本数据类型可以有不同的测量类型。例如，数字数据可以表示定量、有序或名义数据。
时间字段的数据值可以是日期时间字符串（例如 "2015-03-07 12:32:17"、"17:01"、"2015-03-16"、"2015"）或时间戳数字（例如 1552199579097）。
与 bin 一起使用时，type 属性可以是 "quantitative"（定量，用于线性分箱刻度）或“ordinal”（有序，用于有序分箱刻度）。
与 timeUnit 一起使用时，type 属性可以是 "temporal"（时间，默认，用于时间刻度）或“ordinal”（有序，用于有序刻度）。
与 aggregate 一起使用时，type 属性指聚合后的数据类型。例如，我们可以使用 {"aggregate": "distinct", "field": "cat"} 计算分类字段 "cat" 的 distinct（唯一值）计数。聚合输出的 "type" 是 "quantitative"（定量）。
次要通道（例如 x2、y2、xError、yError）没有 type 属性，因为它们必须与其主要通道（例如 x、y）具有完全相同的类型。

另见： type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, legend=Undefined, scale=Undefined, sort=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

`__init__`([shorthand, aggregate, ...])
`copy`([deep, ignore])	返回对象的副本。
`from_dict`(dct[, validate])	从字典表示构建类。
`from_json`(json_string[, validate])	从有效的 JSON 字符串实例化对象。
`resolve_references`([schema])	在对象自身或根 schema 的上下文中解析引用。
`to_dict`([validate, ignore, context])	返回对象的字典表示。
`to_json`([validate, indent, sort_keys, ...])	将此对象的 JSON 表示形式作为字符串发出。
`validate`(instance[, schema])	在根 schema 的上下文中，根据类 schema 验证实例。
`validate_property`(name, value[, schema])	在根 schema 的上下文中，根据属性 schema 验证属性。

属性

`aggregate`	Aggregate schema 包装器。
`bandPosition`	在堆叠、分箱、时间单位或带宽尺度上的相对位置。
`bin`	BinParams schema 包装器。
`condition`	一个或多个带[参数或测试谓词](https://vega.github.io/vega-lite/docs/condition.html)的值定义。
`field`	Field schema 包装器。
`legend`	Legend schema 包装器。
`scale`	Scale schema 包装器。
`sort`	Sort schema 包装器。
`timeUnit`	TimeUnit schema 包装器。
`title`	TitleParams schema 包装器。
`type`	Type schema 包装器。