altair.Order

class altair.Order(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=Undefined, sort=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)

Order 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 (None)

另请参阅： aggregate 文档。

bandPositionfloat

堆叠、分箱、时间单位或条带比例尺上的条带的相对位置。例如，如果设置为 0，标记将位于条带的开头；如果设置为 0.5，则位于条带的中间。

binbool, dict, Literal[‘binned’], BinParams, None

用于将 quantitative 字段分箱的标志，定义分箱参数的对象，或指示 x 或 y 通道的数据在导入 Vega-Lite 之前已分箱（"binned"）。

• 如果为 true，将应用默认的分箱参数。

• 如果为 "binned"，则表示 x（或 y）通道的数据已经分箱。您可以将分箱开始字段映射到 x（或 y），将分箱结束字段映射到 x2（或 y2）。比例尺和坐标轴将类似于 Vega-Lite 中的分箱进行格式化。要根据分箱步长调整坐标轴刻度，您还可以设置坐标轴的 tickMinStep 属性。

默认值： false

另请参阅： bin 文档。

fieldstr, dict, Field, FieldName, RepeatRef

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

另请参阅： field 文档。

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

sortSortOrder, Literal[‘ascending’, ‘descending’]

排序顺序。可以是 "ascending"（默认）或 "descending" 之一。

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 (None)

另请参阅： timeUnit 文档。

titlestr, Text, Sequence[str], None

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

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

注意:

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

2) 如果同时定义了字段定义的 title 和坐标轴、头部或图例的 title，将使用坐标轴/头部/图例的标题。

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

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

如后所述，Vega-Lite 在许多情况下会自动推断数据类型。但是，如果满足以下条件，字段需要指定类型：（1）字段不是 nominal 且字段编码没有指定的 aggregate（argmin 和 argmax 除外）、bin、比例尺类型、自定义 sort 顺序或 timeUnit，或者（2）如果您希望对具有 bin 或 timeUnit 的字段使用有序比例尺。

默认值

1) 对于数据 field，"nominal" 是默认数据类型，除非字段编码包含满足以下条件的 aggregate、channel、bin、比例尺类型、sort 或 timeUnit

• "quantitative" 是默认类型，如果 (1) 编码字段包含 bin 或 aggregate（"argmin" 和 "argmax" 除外），(2) 编码通道是 latitude 或 longitude 通道，或 (3) 如果指定的比例尺类型是 定量比例尺。

• "temporal" 是默认类型，如果 (1) 编码字段包含 timeUnit，或 (2) 指定的比例尺类型是时间或 utc 比例尺

• "ordinal" 是默认类型，如果 (1) 编码字段包含 自定义排序顺序，(2) 指定的比例尺类型是有序/点/条带比例尺，或 (3) 编码通道是 order。

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

• "quantitative"，如果 datum 是数字

• "nominal"，如果 datum 是字符串

• "temporal"，如果 datum 是 日期时间对象

注意

• 数据 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" 的去重计数。聚合输出的 "type" 是 "quantitative"。

• 辅助通道（例如，x2、y2、xError、yError）没有 type，因为它们必须与其主通道（例如，x、y）具有完全相同的类型。

另请参阅： type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=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 或 root schema 的上下文中解析引用。
to_dict([validate, ignore, context])	返回对象的字典表示。
to_json([validate, indent, sort_keys, ...])	将此对象的 JSON 表示作为字符串发出。
validate(instance[, schema])	在 root schema 的上下文中根据类 schema 验证实例。
validate_property(name, value[, schema])	在 root schema 的上下文中根据属性 schema 验证属性。

属性

aggregate	Aggregate schema 包装器。
bandPosition	堆叠、分箱、时间单位或条带比例尺上的条带的相对位置。
bin	BinParams schema 包装器。
field	Field schema 包装器。
sort	Sort schema 包装器。
timeUnit	TimeUnit schema 包装器。
title	TitleParams schema 包装器。
type	Type schema 包装器。