altair.FieldOrDatumDefWithConditionStringDatumDefText#

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

FieldOrDatumDefWithConditionStringDatumDefText 架构包装。

Parameters:
bandPositionfloat

堆叠、分箱、时间单位或带缩放的相对位置。例如，如果设置为 0，标记将位于带的开始处，如果设置为 0.5，则位于带的中间。

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

一个或多个值定义与 a parameter or a test predicate。

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

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

数据域中的一个常量值。

formatstr, dict, Dict

当与默认的 "number" 和 "time" 格式类型一起使用时，文本 格式化模式适用于引导（坐标轴、图例、标题）的标签和文本标记。

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

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

查看格式文档以获取更多示例。

当与 custom formatType 一起使用时，这个值将作为 format 与 datum.value 一起传递给注册的函数。

默认值： 来源于 numberFormat 配置的数字 格式和来自 timeFormat 配置的时间 格式。

formatTypestr

标签的格式类型。可以是 "number"， "time"，或一个 注册的自定义格式类型。

默认值：

  • "time" 用于时间字段以及带有 timeUnit 的序数和名义字段。

  • "number" 用于定量字段以及没有 timeUnit 的顺序和名义字段。

titlestr, 文本, Sequence[str], None

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

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

注意:

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

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

type类型, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’, ‘geojson’]

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

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) 如果指定的比例类型是 a quantitative scale。

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

  • "ordinal" 是默认类型，如果 (1) 编码字段包含一个 自定义排序顺序，(2) 指定的刻度类型是序数/点/带状刻度，或 (3) 编码通道是 order。

  1. 对于数据域中的常量值 (datum)：

  • "quantitative" 如果数据是一个数字

  • "nominal" 如果数据是一个字符串

  • "temporal" 如果数据是 a date time object

注意：

  • 数据 type 描述数据的语义而不是原始数据类型（数字、字符串等）。相同的原始数据类型可以具有不同的测量类型。例如，数值数据可以表示定量、顺序或名义数据。

  • 时间字段的数据值可以是日期时间字符串（例如，"2015-03-07 12:32:17"， "17:01"， "2015-03-16". "2015"）或时间戳数字（例如， 1552199579097）。

  • 当与 bin 一起使用时，type 属性可以是 "quantitative"（用于线性分箱尺度）或 “ordinal”（用于序数分箱尺度）。

  • 当与 timeUnit 一起使用时，type 属性可以是 "temporal"（默认，适用于使用时间尺度）或 “ordinal”（适用于使用序数尺度）。

  • 使用aggregate时，type属性指的是聚合后的数据类型。例如，我们可以计算分类字段"cat"的distinct计数，使用{"aggregate": "distinct", "field": "cat"}。聚合输出的"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([深度, 忽略])

返回对象的副本。

from_dict(dct[, validate])

从字典表示构造类。

from_json(json_string[, validate])

从有效的 JSON 字符串实例化对象。

resolve_references([schema])

解析此对象的架构或根架构中的引用。

to_dict([validate, ignore, context])

返回对象的字典表示。

to_json([validate, indent, sort_keys, ...])

以字符串形式输出该对象的 JSON 表示。

validate(instance[, schema])

在rootschema的上下文中验证实例是否符合类模式。

validate_property(name, value[, schema])

在根架构的上下文中，根据属性架构验证一个属性。