altair.X2Datum#

class altair.X2Datum(datum, bandPosition=Undefined, title=Undefined, type=Undefined, **kwds)#

X2Datum schema 包装器。

参数:

bandPositionfloat

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

datumstr, bool, dict, float, ExprRef, DateTime, RepeatRef, PrimitiveValue, None

数据域中的一个常数值。

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 都已定义，将使用轴/标题/图例的标题。

typeType, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’, ‘geojson’]

编码字段或常量值（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：

如果 (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__(datum, bandPosition=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

`__init__`(datum[, bandPosition, title, type])
`copy`([deep, ignore])	返回对象的副本。
`from_dict`(dct[, validate])	从字典表示形式构建类。
`from_json`(json_string[, validate])	从有效的 JSON 字符串实例化对象。
`resolve_references`([schema])	在此对象的 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 验证属性。

属性

`bandPosition`	在堆叠、分箱、时间单位或带状刻度的带上的相对位置。
`datum`	数据域中的一个常数值。
`title`	TitleParams schema 包装器。
`type`	Type schema 包装器。