altair.XError#

class altair.XError(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=Undefined, timeUnit=Undefined, title=Undefined, **kwds)#

XError 模式包装器。

一个次级通道的字段定义，该通道与另一个主通道共享比例尺。例如，x2、xError 和 xError2 与 x 共享相同的比例尺。

参数:

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，将定位在带状区域的中间。

binNone

用于对 quantitative 字段进行分箱的标志，定义分箱参数的对象，或者指示 x 或 y 通道的数据在导入到 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) 如果 aggregate 是 count，则 field 不是必需的。

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’]

时间单位（例如，year、yearmonth、month、hours），用于时间字段。或被转换为有序时间字段的时间字段。

默认值： undefined (None)

另请参阅： timeUnit 文档。

titlestr, Text, Sequence[str], None

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

默认值：派生自字段名和转换函数（aggregate、bin 和 timeUnit）。如果字段具有聚合函数，则函数将作为标题的一部分显示（例如，"Sum of Profit"）。如果字段已分箱或应用了时间单位，则应用函数将显示在括号中（例如，"Profit (binned)"、"Transaction Date (year-month)"）。否则，标题就是字段名。

注意:

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

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

__init__(shorthand=Undefined, aggregate=Undefined, bandPosition=Undefined, bin=Undefined, field=Undefined, timeUnit=Undefined, title=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 模式包装器。
`field`	Field 模式包装器。
`timeUnit`	TimeUnit 模式包装器。
`title`	TitleParams 模式包装器。