altair.RowColumnEncodingFieldDef#

class altair.RowColumnEncodingFieldDef(shorthand=Undefined, aggregate=Undefined, align=Undefined, bandPosition=Undefined, bin=Undefined, center=Undefined, field=Undefined, header=Undefined, sort=Undefined, spacing=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

RowColumnEncodingFieldDef 模式包装器。

参数：
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 文档。

alignLayoutAlign, Literal[‘all’, ‘each’, ‘none’]

应用于行/列分面子图的对齐方式。支持的字符串值为 "all"、"each" 和 "none"。

  • 对于 "none"，将使用流式布局，其中相邻的子视图简单地依次放置。

  • 对于 "each"，子视图将被对齐到整洁的网格结构中，但每行或每列的大小可能不同。

  • 对于 "all"，子视图将被对齐，并且每行或每列的大小将根据观察到的最大尺寸相同。此属性的字符串值将应用于网格的行和列。

默认值： "all"。

bandPositionfloat

堆叠、分箱、时间单位或带状比例尺上带的相对位置。例如，如果设置为 0，标记将位于带的开头；如果设置为 0.5，标记将位于带的中间。

binbool, dict, BinParams, None

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

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

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

默认值： false

另请参阅： bin 文档。

centerbool

布尔标志，指示分面子视图是否应相对于其各自的行或列居中。

默认值： false

fieldstr, dict, Field, FieldName, RepeatRef

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

另请参阅： field 文档。

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

headerdict, Header, None

定义分面头属性的对象。

sortdict, Sequence[str], Sequence[bool], Sequence[float], SortArray, SortOrder, EncodingSortField, Sequence[dict, DateTime], Literal[‘ascending’, ‘descending’], None

编码字段的排序顺序。

对于连续字段（定量或时间型），sort 可以是 "ascending"（升序）或 "descending"（降序）。

对于离散字段，sort 可以是以下之一：

  • "ascending"（升序）或 "descending"（降序）– 用于按 JavaScript 中的值的自然顺序排序。

  • 一个排序字段定义，用于按另一个字段排序。

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

  • null 表示不排序。

默认值： "ascending"

注意： row 和 column 不支持 null。

spacingfloat

分面子视图之间的像素间距。

默认值：取决于视图合成配置的"spacing"属性（默认为20）

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，则将使用坐标轴/标题/图例的标题。

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

编码字段或常数值（datum）的测量类型（"quantitative" 定量型、"temporal" 时间型、"ordinal" 有序型或 "nominal" 名义型）。对于编码‘geoshape’，也可以是"geojson"类型。

Vega-Lite 在许多情况下会自动推断数据类型，如下所述。但是，如果字段满足以下条件之一，则需要指定类型：（1）字段不是名义型，并且字段编码没有指定 aggregate（argmin 和 argmax 除外）、bin、比例尺类型、自定义 sort 顺序或 timeUnit；或（2）如果您希望对带有 bin 或 timeUnit 的字段使用有序比例尺。

默认值

1) 对于数据field，除非字段编码具有满足以下条件的 aggregate、channel、bin、比例尺类型、sort 或 timeUnit，否则默认数据类型为 "nominal"。

  • 如果满足以下条件，则 "quantitative"（定量型）为默认类型：(1) 编码字段包含 bin 或 aggregate（"argmin" 和 "argmax" 除外）；(2) 编码通道是 latitude 或 longitude 通道；或 (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"（定量型）。

  • 辅助通道（例如，x2、y2、xError、yError）没有 type 属性，因为它们的类型必须与其主通道（例如，x、y）完全相同。

另请参阅： type 文档。

__init__(shorthand=Undefined, aggregate=Undefined, align=Undefined, bandPosition=Undefined, bin=Undefined, center=Undefined, field=Undefined, header=Undefined, sort=Undefined, spacing=Undefined, timeUnit=Undefined, title=Undefined, type=Undefined, **kwds)#

方法

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

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。