altair.ShapeDatum#

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

ShapeDatum schema 包装器。

参数:
bandPositionfloat

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

conditiondict, ConditionalValueDefstringnullExprRef, ConditionalParameterValueDefstringnullExprRef, ConditionalPredicateValueDefstringnullExprRef, Sequence[dict, ConditionalValueDefstringnullExprRef, ConditionalParameterValueDefstringnullExprRef, ConditionalPredicateValueDefstringnullExprRef]

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

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

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

数据领域中的一个常数值。

titlestr, Text, Sequence[str], None

字段的标题。如果为 null,则会移除标题。

默认值:派生自字段名称和转换函数(aggregatebintimeUnit)。如果字段具有聚合函数,函数会作为标题的一部分显示(例如,"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")。对于编码‘geoshape’,它也可以是 "geojson" 类型。

如以下所述,Vega-Lite 在许多情况下会自动推断数据类型。但是,在以下情况下,字段需要指定类型:(1) 字段不是名义型,且字段编码未指定 aggregate(除了 argminargmax)、bin、比例尺类型、自定义 sort 顺序或 timeUnit;或者 (2) 如果您希望对具有 bintimeUnit 的字段使用有序比例尺。

默认值

1) 对于数据 field,除非字段编码具有满足以下条件的 aggregatechannelbin、比例尺类型、sorttimeUnit,否则 "nominal" 是默认数据类型:

  • "quantitative" 是默认类型,如果 (1) 编码字段包含 binaggregate(除了 "argmin""argmax"),(2) 编码通道是 latitudelongitude 通道,或者 (3) 指定的比例尺类型是定量比例尺

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

  • "ordinal" 是默认类型,如果 (1) 编码字段包含自定义排序顺序,(2) 指定的比例尺类型是有序/点/条带比例尺,或者 (3) 编码通道是 order`。

  1. 对于数据领域中的常数值(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"`。

  • 次要通道(例如,x2y2xErroryError)没有 type,因为它们的类型必须与其主要通道(例如,xy)完全相同。

另请参阅: type 文档。

__init__(datum, bandPosition=Undefined, condition=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])

在根 schema 的上下文中,根据类 schema 验证实例。

validate_property(name, value[, schema])

在根 schema 的上下文中,根据属性 schema 验证属性。

属性

bandPosition

在堆叠、分箱、时间单位或条带比例尺的条带上的相对位置。

condition

一个或多个值定义,带[有参数或测试谓词](https://vega.github.io/vega-lite/docs/condition.html)。

datum

数据领域中的一个常数值。

title

TitleParams schema 包装器。

type

Type schema 包装器。