altair.FieldOrDatumDefWithConditionDatumDefGradientstringnull#

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

FieldOrDatumDefWithConditionDatumDefGradientstringnull schema 包装器。

参数:
bandPositionfloat

在堆叠、分箱、时间单位或 band scale 的 band 上的相对位置。例如,如果设置为 0,标记将定位在 band 的起始位置;如果设置为 0.5,则定位在 band 的中间。

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)。如果字段具有 aggregate 函数,该函数将作为标题的一部分显示(例如,“Sum of Profit”)。如果字段已分箱或应用了时间单位,则应用的函数会显示在括号中(例如,“Profit (binned)”,“Transaction Date (year-month)”)。否则,标题仅为字段名称。

注意:

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

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

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

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

Vega-Lite 在许多情况下会自动推断数据类型,如下所述。但是,在以下情况下,字段需要指定 type:(1) 字段不是 nominal,并且字段编码没有指定 aggregateargminargmax 除外)、bin、scale type、自定义 sort order 或 timeUnit;或者 (2) 如果您希望对带有 bintimeUnit 的字段使用 ordinal scale。

默认值

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

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

  • 如果 (1) 编码字段包含 timeUnit,或者 (2) 指定的 scale type 是 time 或 utc scale,则默认类型为 "temporal"

  • 如果 (1) 编码字段包含 自定义 sort order,(2) 指定的 scale type 是 ordinal/point/band scale,或者 (3) 编码通道是 order,则默认类型为 "ordinal"

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

  • 如果 datum 是 number,则为 "quantitative"

  • 如果 datum 是 string,则为 "nominal"

  • 如果 datum 是 date time object,则为 "temporal"

注意

  • 数据 type 描述的是数据的语义,而不是原始数据类型(number、string 等)。相同的原始数据类型可以具有不同的测量类型。例如,数值数据可以表示 quantitative、ordinal 或 nominal 数据。

  • temporal 字段的数据值可以是 date-time string(例如,“2015-03-07 12:32:17”,“17:01”,“2015-03-16”。“2015”)或 timestamp number(例如,1552199579097)。

  • bin 一起使用时,type 属性可以是 "quantitative"(用于 linear bin scale)或 “ordinal”(用于 ordinal bin scale)

  • timeUnit 一起使用时,type 属性可以是 "temporal"(默认,用于 temporal scale)或 “ordinal”(用于 ordinal scale)

  • aggregate 一起使用时,type 属性指的是聚合后的数据类型。例如,我们可以使用 {"aggregate": "distinct", "field": "cat"} 计算 categorical field "cat" 的 count distinct。aggregate 输出的 "type""quantitative"

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

另请参阅:type 文档。

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

在 rootschema 的上下文中针对类 schema 验证实例。

validate_property(name, value[, schema])

在 rootschema 的上下文中针对属性 schema 验证属性。