altair.Theta#

class altair.Theta(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=Undefined, scale=Undefined, sort=Undefined, stack=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

Theta schema 包装器。

参数
shorthandstr, dict, Sequence[str], RepeatRef

字段、聚合和类型的简写

aggregatedict, Aggregate, ArgmaxDef, ArgminDef, NonArgAggregateOp, Literal[‘average’, ‘count’, ‘distinct’, ‘max’, ‘mean’, ‘median’, ‘min’, ‘missing’, ‘product’, ‘q1’, ‘q3’, ‘ci0’, ‘ci1’, ‘stderr’, ‘stdev’, ‘stdevp’, ‘sum’, ‘valid’, ‘values’, ‘variance’, ‘variancep’, ‘exponential’, ‘exponentialb’]

字段的聚合函数(例如,"mean""sum""median""min""max""count")。

默认值: undefined (None)

另请参阅: aggregate 文档。

bandPositionfloat

堆叠、分箱、时间单位或频带(band)刻度的相对位置。例如,如果设置为0,则标记将定位在频带的开头,如果设置为0.5,则定位在频带的中间。

binbool, dict, Literal[‘binned’], BinParams, None

用于对定量字段进行分箱(binning)的标志,或定义分箱参数的对象,或指示xy通道的数据在导入 Vega-Lite 之前已分箱("binned")。

  • 如果为 true,将应用默认的分箱参数

  • 如果为"binned",这表示x(或y)通道的数据已经分箱。您可以将分箱开始字段映射到x(或y),并将分箱结束字段映射到x2(或y2)。刻度和轴的格式将类似于 Vega-Lite 中的分箱。要根据分箱步长调整轴刻度,您还可以设置轴的tickMinStep 属性。

默认值: false

另请参阅: bin 文档。

fieldstr, dict, Field, FieldName, RepeatRef

必需。 定义要从中提取数据值的字段名称的字符串,或定义来自 repeat 操作符的迭代值的对象。

另请参阅: field 文档。

注意: 1) 点(.)和方括号([])可用于访问嵌套对象(例如,"field": "foo.bar""field": "foo['bar']")。如果字段名包含点或方括号但未嵌套,您可以使用 \\ 转义点和方括号(例如,"a\\.b""a\\[0\\]")。有关转义的更多详细信息,请参见field 文档。 2) 如果 aggregatecount,则 field 不是必需的。

scaledict, Scale, None

一个对象,定义通道刻度的属性,该函数将数据域中的值(数字、日期、字符串等)转换为编码通道的视觉值(像素、颜色、大小)。

如果为 null,刻度将被禁用,数据值将被直接编码

默认值: 如果未定义,将应用默认的刻度属性

另请参阅: scale 文档。

sortdict, Sort, Sequence[str], Sequence[bool], Sequence[float], SortArray, SortOrder, AllSortString, SortByChannel, SortByEncoding, EncodingSortField, SortByChannelDesc, Sequence[dict, DateTime], Literal[‘-x’, ‘-y’, ‘-color’, ‘-fill’, ‘-stroke’, ‘-strokeWidth’, ‘-size’, ‘-shape’, ‘-fillOpacity’, ‘-strokeOpacity’, ‘-opacity’, ‘-text’, ‘ascending’, ‘descending’, ‘x’, ‘y’, ‘color’, ‘fill’, ‘stroke’, ‘strokeWidth’, ‘size’, ‘shape’, ‘fillOpacity’, ‘strokeOpacity’, ‘opacity’, ‘text’], None

编码字段的排序顺序。

对于连续字段(定量或时间),sort 可以是 "ascending""descending"

对于离散字段,sort 可以是以下值之一

默认值: "ascending"

注意: null 和按另一个通道排序不适用于 rowcolumn

另请参阅: sort 文档。

stackbool, StackOffset, Literal[‘zero’, ‘center’, ‘normalize’], None

如果字段应该堆叠,则堆叠偏移类型。 stack 仅适用于具有连续域的 xythetaradius 通道。例如,ystack 可用于自定义垂直条形图的堆叠。

stack 可以是以下值之一

默认值: 对于满足以下所有条件的图表,默认值为zero:(1)标记为barareaarc;(2)堆叠测量通道(x 或 y)具有线性刻度;(3)至少有一个非位置通道映射到未聚合的字段,且该字段与 x 和 y 不同。否则,默认为 null

另请参阅: stack 文档。

timeUnitdict, TimeUnit, MultiTimeUnit, BinnedTimeUnit, SingleTimeUnit, TimeUnitParams, UtcMultiTimeUnit, UtcSingleTimeUnit, LocalMultiTimeUnit, LocalSingleTimeUnit, Literal[‘binnedutcyear’, ‘binnedutcyearquarter’, ‘binnedutcyearquartermonth’, ‘binnedutcyearmonth’, ‘binnedutcyearmonthdate’, ‘binnedutcyearmonthdatehours’, ‘binnedutcyearmonthdatehoursminutes’, ‘binnedutcyearmonthdatehoursminutesseconds’, ‘binnedutcyearweek’, ‘binnedutcyearweekday’, ‘binnedutcyearweekdayhours’, ‘binnedutcyearweekdayhoursminutes’, ‘binnedutcyearweekdayhoursminutesseconds’, ‘binnedutcyeardayofyear’, ‘binnedyear’, ‘binnedyearquarter’, ‘binnedyearquartermonth’, ‘binnedyearmonth’, ‘binnedyearmonthdate’, ‘binnedyearmonthdatehours’, ‘binnedyearmonthdatehoursminutes’, ‘binnedyearmonthdatehoursminutesseconds’, ‘binnedyearweek’, ‘binnedyearweekday’, ‘binnedyearweekdayhours’, ‘binnedyearweekdayhoursminutes’, ‘binnedyearweekdayhoursminutesseconds’, ‘binnedyeardayofyear’, ‘utcyear’, ‘utcquarter’, ‘utcmonth’, ‘utcweek’, ‘utcday’, ‘utcdayofyear’, ‘utcdate’, ‘utchours’, ‘utcminutes’, ‘utcseconds’, ‘utcmilliseconds’, ‘year’, ‘quarter’, ‘month’, ‘week’, ‘day’, ‘dayofyear’, ‘date’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’, ‘utcyearquarter’, ‘utcyearquartermonth’, ‘utcyearmonth’, ‘utcyearmonthdate’, ‘utcyearmonthdatehours’, ‘utcyearmonthdatehoursminutes’, ‘utcyearmonthdatehoursminutesseconds’, ‘utcyearweek’, ‘utcyearweekday’, ‘utcyearweekdayhours’, ‘utcyearweekdayhoursminutes’, ‘utcyearweekdayhoursminutesseconds’, ‘utcyeardayofyear’, ‘utcquartermonth’, ‘utcmonthdate’, ‘utcmonthdatehours’, ‘utcmonthdatehoursminutes’, ‘utcmonthdatehoursminutesseconds’, ‘utcweekday’, ‘utcweekdayhours’, ‘utcweekdayhoursminutes’, ‘utcweekdayhoursminutesseconds’, ‘utcdayhours’, ‘utcdayhoursminutes’, ‘utcdayhoursminutesseconds’, ‘utchoursminutes’, ‘utchoursminutesseconds’, ‘utcminutesseconds’, ‘utcsecondsmilliseconds’, ‘yearquarter’, ‘yearquartermonth’, ‘yearmonth’, ‘yearmonthdate’, ‘yearmonthdatehours’, ‘yearmonthdatehoursminutes’, ‘yearmonthdatehoursminutesseconds’, ‘yearweek’, ‘yearweekday’, ‘yearweekdayhours’, ‘yearweekdayhoursminutes’, ‘yearweekdayhoursminutesseconds’, ‘yeardayofyear’, ‘quartermonth’, ‘monthdate’, ‘monthdatehours’, ‘monthdatehoursminutes’, ‘monthdatehoursminutesseconds’, ‘weekday’, ‘weekdayhours’, ‘weekdayhoursminutes’, ‘weekdayhoursminutesseconds’, ‘dayhours’, ‘dayhoursminutes’, ‘dayhoursminutesseconds’, ‘hoursminutes’, ‘hoursminutesseconds’, ‘minutesseconds’, ‘secondsmilliseconds’]

时间单位(例如,yearyearmonthmonthhours),用于时间字段或强制转换为有序类型的时间字段

默认值: undefined (None)

另请参阅: timeUnit 文档。

titlestr, Text, Sequence[str], None

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

默认值: 源自字段名称和转换函数(aggregatebintimeUnit)。如果字段具有聚合函数,则该函数将作为标题的一部分显示(例如,"Sum of Profit")。如果字段经过分箱或应用了时间单位,则应用的函数将显示在括号中(例如,"Profit (binned)""Transaction Date (year-month)")。否则,标题仅为字段名称。

注意:

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

2) 如果字段定义中的 title 以及轴、表头或图例中的 title 都已定义,将使用轴/表头/图例的标题。

typeStandardType, Literal[‘quantitative’, ‘ordinal’, ‘temporal’, ‘nominal’]

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

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

默认值

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

  • "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__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=Undefined, scale=Undefined, sort=Undefined, stack=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

__init__([shorthand, aggregate, ...])

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 验证属性。

属性

aggregate

聚合 schema 包装器。

bandPosition

堆叠、分箱、时间单位或带状刻度上的相对位置。

bin

BinParams schema 包装器。

field

Field schema 包装器。

scale

Scale schema 包装器。

sort

Sort schema 包装器。

stack

如果字段需要堆叠,则表示堆叠偏移的类型。

timeUnit

TimeUnit schema 包装器。

title

TitleParams schema 包装器。

type

Type schema 包装器。