altair.FacetEncodingFieldDef#

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

FacetEncodingFieldDef 模式封装器。

参数：
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 (无)

另请参阅：聚合文档。

aligndict, LayoutAlign, RowColLayoutAlign, Literal[‘all’, ‘each’, ‘none’]

应用于网格行和列的对齐方式。支持的字符串值包括 "all"、"each" 和 "none"。

  • 对于 "none"，将使用流式布局，其中相邻的子视图只是一个接一个地放置。

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

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

或者，可以使用 {"row": string, "column": string} 形式的对象值，为行和列提供不同的对齐方式。

默认值： "all"。

bandPositionfloat

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

binbool, dict, BinParams, None

用于对 quantitative（定量）字段进行分箱的标志，定义分箱参数的对象，或者指示 x 或 y 通道的数据在导入到 Vega-Lite 之前已经分箱（"binned"）。

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

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

默认值： false

另请参阅：分箱文档。

boundsLiteral[‘full’, ‘flush’]

用于确定子图范围的边界计算方法。为 full（默认）或 flush 之一。

  • 如果设置为 full，将使用计算出的完整边界（包括轴、标题和图例）。

  • 如果设置为 flush，将仅使用子视图指定的宽度和高度值。flush 设置在尝试将没有轴或图例的子图放置到统一的网格结构中时非常有用。

默认值： "full"

centerbool, dict, RowColboolean

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

可以使用 {"row": boolean, "column": boolean} 形式的对象值，为行和列提供不同的居中值。

默认值： false

columnsfloat

视图组合布局中包含的列数。

默认值: undefined – 将假定无限数量的列（单行）。这等同于 hconcat（用于 concat）和使用 column 通道（用于 facet 和 repeat）。

注意:

  1. 此属性仅适用于

  • 通用（可换行）的 concat 操作符（非 hconcat/vconcat）

  • 具有单个字段/重复定义的 facet 和 repeat 操作符（不含行/列嵌套）

2) 将 columns 设置为 1 等同于 vconcat（用于 concat）和使用 row 通道（用于 facet 和 repeat）。

fieldstr, dict, Field, FieldName, RepeatRef

必需。 定义从哪个字段提取数据值的字符串，或定义来自 repeat 操作符的迭代值的对象。

另请参阅：字段文档。

注意：1) 点（.）和方括号（[ 和 ]）可用于访问嵌套对象（例如，"field": "foo.bar" 和 "field": "foo['bar']"）。如果字段名包含点或方括号但不是嵌套结构，可以使用 \\ 转义点和方括号（例如，"a\\.b" 和 "a\\[0\\]"）。有关转义的更多详细信息，请参阅字段文档。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。

spacingdict, float, RowColnumber

组合操作符的子视图之间的像素间距。可以使用 {"row": number, "column": number} 形式的对象，为行和列设置不同的间距值。

默认值: 取决于视图组合配置的 "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 (无)

另请参阅：时间单位文档。

titlestr, Text, Sequence[str], None

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

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

注意:

1) 你可以通过在config中提供 fieldTitle 属性或通过编译函数的 options 提供 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）完全相同。

另请参阅：类型文档。

__init__(shorthand=Undefined, aggregate=Undefined, align=Undefined, bandPosition=Undefined, bin=Undefined, bounds=Undefined, center=Undefined, columns=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])

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

to_dict([validate, ignore, context])

返回对象的字典表示。

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

将此对象的 JSON 表示形式作为字符串发出。

validate(instance[, schema])

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

validate_property(name, value[, schema])

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