altair.YOffsetDatum#

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

YOffsetDatum schema 包装器。

参数：

bandPositionfloat

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

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

数据域中的常量值。

scaledict, Scale, None

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

如果为 null，比例尺将被禁用，数据值将直接编码。

默认值：如果未定义，将应用默认的比例尺属性。

另请参阅：scale 文档。

titlestr, Text, Sequence[str], None

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

默认值：派生自字段名称和转换函数（aggregate、bin 和 timeUnit）。如果字段有聚合函数，函数将作为标题的一部分显示（例如，“利润总和”）。如果字段经过分箱处理或应用了时间单位，应用的函数将显示在括号中（例如，“利润（已分箱）”、“交易日期（年月）”）。否则，标题仅为字段名称。

注意:

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

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

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

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

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

默认值

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

如果满足以下条件，默认类型为 "quantitative"：(1) 编码字段包含 bin 或 aggregate（"argmin" 和 "argmax" 除外），(2) 编码通道是 latitude 或 longitude 通道，或者 (3) 如果指定的比例尺类型是定量比例尺。
如果满足以下条件，默认类型为 "temporal"：(1) 编码字段包含 timeUnit，或者 (2) 指定的比例尺类型是时间或 utc 比例尺。
如果满足以下条件，默认类型为 "ordinal"：(1) 编码字段包含自定义排序顺序，(2) 指定的比例尺类型是 ordinal/point/band 比例尺，或者 (3) 编码通道是 order。

对于数据域中的常量值（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, scale=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

`__init__`(datum[, bandPosition, scale, ...])
`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`	数据域中的常量值。
`scale`	Scale schema 包装器。
`title`	TitleParams schema 包装器。
`type`	Type schema 包装器。