altair.FieldOrDatumDefWithConditionStringDatumDefText#

class altair.FieldOrDatumDefWithConditionStringDatumDefText(bandPosition=Undefined, condition=Undefined, datum=Undefined, format=Undefined, formatType=Undefined, title=Undefined, type=Undefined, **kwds)#

FieldOrDatumDefWithConditionStringDatumDefText schema 封装器。

参数:
bandPositionfloat

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

conditiondict, ConditionalValueDefTextExprRef, ConditionalParameterValueDefTextExprRef, ConditionalPredicateValueDefTextExprRef, Sequence[dict, ConditionalValueDefTextExprRef, ConditionalParameterValueDefTextExprRef, ConditionalPredicateValueDefTextExprRef]

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

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

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

数据域中的一个常量值。

formatstr, dict, Dict

与默认的 "number" 和 "time" 格式类型一起使用时，这是指南（轴、图例、头部）和文本标记标签的文本格式模式。

  • 如果格式类型为 "number"（例如，对于定量字段），这是 D3 的数字格式模式。

  • 如果格式类型为 "time"（例如，对于时间字段），这是 D3 的时间格式模式。

更多示例请参阅格式文档。

与自定义 formatType 一起使用时，此值将作为 format 与 datum.value 一起传递给注册的函数。

默认值：对于数字格式，派生自numberFormat 配置；对于时间格式，派生自timeFormat 配置。

formatTypestr

标签的格式类型。可选值为 "number"、"time"，或已注册的自定义格式类型。

默认值

  • 对于时间字段以及带有 timeUnit 的有序和名义字段，默认为 "time"。

  • 对于定量字段以及不带 timeUnit 的有序和名义字段，默认为 "number"。

titlestr, Text, Sequence[str], None

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

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

注意:

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

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

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

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

正如以下讨论的，Vega-Lite 在许多情况下会自动推断数据类型。但是，在以下情况下，字段需要指定类型：(1) 字段不是名义型，并且字段编码没有指定 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。

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

  • 如果数据是数字，则为 "quantitative"。

  • 如果数据是字符串，则为 "nominal"。

  • 如果数据是日期时间对象，则为 "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__(bandPosition=Undefined, condition=Undefined, datum=Undefined, format=Undefined, formatType=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

__init__([bandPosition, condition, datum, ...])

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 验证属性。