altair.Fill#

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

填充(Fill)模式包装器。

参数:
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

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

binbool, dict, BinParams, None

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

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

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

默认值: false

另请参阅: bin 文档。

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

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

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

fieldstr, dict, Field, FieldName, RepeatRef

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

另请参阅: field 文档。

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

legenddict, Legend, None

定义图例属性的对象。如果为 null,将移除该编码通道的图例。

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

另请参阅: legend 文档。

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""descending" – 按值在 JavaScript 中的自然顺序排序。

  • 指定按编码通道名称排序的字符串(例如,"x""y"),可选择带有用于降序排序的减号前缀(例如,"-x" 表示按 x 字段降序排序)。此通道字符串是按编码排序定义的简写形式。例如,"sort": "-x" 等同于 "sort": {"encoding": "x", "order": "descending"}

  • 按另一个字段排序的排序字段定义

  • 指定首选顺序的字段值数组。在这种情况下,排序顺序将遵循数组中的值,后跟按原始顺序排列的任何未指定值。对于离散时间字段,排序数组中的值可以是日期时间定义对象。此外,对于时间单位 "month""day",值可以是月份或日期的名称(不区分大小写)或它们的 3 个字母缩写(例如,"Mon""Tue")。

  • null 表示不排序。

默认值: "ascending"

注意: rowcolumn 不支持 null 和按另一个通道排序。

另请参阅: sort 文档。

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中提供 fieldTitle 属性或通过编译函数的选项提供 fieldTitle 函数来自定义默认的字段标题格式。

2) 如果同时定义了字段定义的 title 和坐标轴、头部或图例的 title,将使用坐标轴/头部/图例的标题。

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

编码字段或常量值(datum)的测量类型("quantitative" 定量、"temporal" 时间、"ordinal" 有序或 "nominal" 名义)。它也可以是 "geojson" 类型,用于编码 ‘geoshape’

正如以下所述,Vega-Lite 在许多情况下会自动推断数据类型。然而,在以下情况下,字段需要指定类型:(1) 字段不是名义类型,且字段编码没有指定 aggregateargminargmax 除外)、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" 的去重计数。聚合输出的 "type""quantitative"

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

另请参阅: type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, condition=Undefined, field=Undefined, legend=Undefined, scale=Undefined, sort=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])

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

to_dict([validate, ignore, context])

返回对象的字典表示。

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

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

validate(instance[, schema])

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

validate_property(name, value[, schema])

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

属性

aggregate

聚合模式包装器。

bandPosition

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

bin

BinParams 模式包装器。

condition

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

field

字段模式包装器。

legend

图例模式包装器。

scale

比例尺模式包装器。

sort

排序模式包装器。

timeUnit

TimeUnit 模式包装器。

title

TitleParams 模式包装器。

type

类型模式包装器。