altair.SecondaryFieldDef#

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

SecondaryFieldDef schema 包装器。

这是 secondary channel 的字段定义，它与另一个 primary channel 共享同一比例尺。例如，x2、xError 和 xError2 与 x 共享同一比例尺。

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

field、aggregate 和 type 的简写形式

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 scale 的条带上的相对位置。例如，如果设置为 0，标记将位于条带的起始位置；如果设置为 0.5，则位于条带的中间位置。

binNone

一个标志，用于对 quantitative 字段进行分箱，或一个定义分箱参数的对象，或指示 x 或 y channel 的数据在导入 Vega-Lite 之前已经过分箱处理（"binned"）。

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

  • 如果为 "binned"，这表示 x（或 y）channel 的数据已经过分箱处理。可以将分箱起始字段映射到 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’]

temporal 字段的时间单位（例如，year、yearmonth、month、hours），或转换为 ordinal 类型的 temporal 字段。

默认值： 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 函数的 options 中的 fieldTitle 函数来自定义默认的字段标题格式。

2) 如果同时定义了字段定义的 title 和 axis、header 或 legend 的 title，将使用 axis/header/legend 的标题。

__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])

在此对象的 schema 或 root 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 验证属性。