altair.TextDatum#
- class altair.TextDatum(datum, bandPosition=Undefined, condition=Undefined, format=Undefined, formatType=Undefined, title=Undefined, type=Undefined, **kwds)#
TextDatum 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"格式类型一起使用时，这是指南（坐标轴、图例、标题）和文本标记的标签文本格式模式。有关更多示例，请参阅格式文档。
与自定义 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 函数的选项中的 fieldTitle 函数来定制默认的字段标题格式。
2) 如果同时定义了字段定义的
title和坐标轴、标题或图例的title，则将使用坐标轴/标题/图例的标题。- type
Type, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’, ‘geojson’] 编码字段或常量值（
datum）的测量类型（"quantitative"、"temporal"、"ordinal"或"nominal"）。它也可以是"geojson"类型，用于编码“geoshape”。在许多情况下，Vega-Lite 会自动推断数据类型，如下文所述。但是，在以下情况中，字段需要指定类型：(1) 字段不是名义型，且字段编码没有指定
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, condition=Undefined, format=Undefined, formatType=Undefined, title=Undefined, type=Undefined, **kwds)#
方法
__init__(datum[, bandPosition, condition, ...])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])在 rootschema 的上下文中，根据类 schema 验证实例。
validate_property(name, value[, schema])在 rootschema 的上下文中，根据属性 schema 验证属性。
属性
bandPosition在堆叠、分箱、时间单位或带状刻度的带状上的相对位置。
condition一个或多个值定义，带有[参数或测试谓词](https://vega.github.io/vega-lite/docs/condition.html)。
datum数据域中的常量值。
format当与默认的 "number" 和 "time" 格式类型一起使用时，这是指南（坐标轴、图例、标题）和文本标记的标签文本格式模式。
formatType标签的格式类型。
titleTitleParams schema 包装器。
typeType schema 包装器。