altair.ColorDatum#

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

ColorDatum 模式包装器。

参数:
bandPositionfloat

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

conditiondict, ConditionalValueDefGradientstringnullExprRef, ConditionalParameterValueDefGradientstringnullExprRef, ConditionalPredicateValueDefGradientstringnullExprRef, Sequence[dict, ConditionalValueDefGradientstringnullExprRef, ConditionalParameterValueDefGradientstringnullExprRef, ConditionalPredicateValueDefGradientstringnullExprRef]

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

注意:字段定义的 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) 如果字段不是名义类型,并且字段编码没有指定 aggregateargminargmax 除外)、bin、比例尺类型、自定义 sort 顺序或 timeUnit;或 (2) 如果您希望对具有 bintimeUnit 的字段使用有序比例尺。

默认值

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

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

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

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

  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" 的唯一值计数。聚合输出的 "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])

在对象的模式或根模式上下文中解析引用。

to_dict([validate, ignore, context])

返回对象的字典表示。

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

将此对象的 JSON 表示作为字符串发出。

validate(instance[, schema])

在根模式上下文中根据类模式验证实例。

validate_property(name, value[, schema])

在根模式上下文中根据属性模式验证属性。

属性

bandPosition

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

condition

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

datum

数据域中的常量值。

title

TitleParams 模式包装器。

type

Type 模式包装器。