altair.Facet#

class altair.Facet(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)#

Facet 模式包装器。

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

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 字段进行分箱的标志,一个定义分箱参数的对象,或指示 xy 通道的数据在导入 Vega-Lite 之前已分箱("binned")。

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

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

默认值: false

另请参阅: bin 文档。

boundsLiteral[‘full’, ‘flush’]

用于确定子图范围的边界计算方法。可选值为 full(默认值)或 flush

  • 如果设置为 full,将使用整个计算的边界(包括轴、标题和图例)。

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

默认值: "full"

centerbool, dict, RowColboolean

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

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

默认值: false

columnsfloat

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

默认值undefined – 将假定无限多列(单行)。这等同于 hconcat(对于 concat)和使用 column 通道(对于 facetrepeat`)。

注意:

  1. 此属性仅适用于

  • 一般的(可换行)concat 运算符(非 hconcat/vconcat`)

  • 带有单个字段/重复定义(无行/列嵌套)的 facetrepeat 运算符

2) 将 columns 设置为 1 等同于 vconcat(对于 concat)和使用 row 通道(对于 facetrepeat`)。

fieldstr, dict, Field, FieldName, RepeatRef

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

另请参阅: field 文档。

注意: 1) 点号(.)和方括号([])可用于访问嵌套对象(例如,"field": "foo.bar""field": "foo['bar']")。如果字段名包含点号或方括号但未嵌套,可以使用 \\ 进行转义(例如,"a\\.b""a\\[0\\]")。有关转义的更多详细信息,请参阅field 文档。 2) 如果 aggregatecount,则无需 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"`,值可以是月份或日期的名称(不区分大小写)或其三个字母的缩写(例如,"Mon""Tue"`)。

  • null 表示不排序。

默认值: "ascending"

注意: null 不支持用于 rowcolumn`。

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

时间字段的时间单位(例如,yearyearmonthmonthhours)。或被转换为有序类型的时间字段

默认值: undefined (None)

另请参阅: timeUnit 文档。

titlestr, Text, Sequence[str], None

字段的标题。如果为 null,则移除标题。

默认值: 根据字段名称和转换函数(aggregatebintimeUnit)派生。如果字段有聚合函数,该函数将作为标题的一部分显示(例如,"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(除了 argminargmax`)、bin`、比例尺类型、自定义 sort 顺序或 timeUnit,或者 (2) 如果希望将有序比例尺用于带有 bintimeUnit 的字段。

默认值

1) 对于数据 field`,"nominal" 是默认数据类型,除非字段编码包含满足以下条件的 aggregate`、channel`、bin`、比例尺类型、sorttimeUnit`:

  • "quantitative" 是默认类型,如果 (1) 编码字段包含 binaggregate(除了 "argmin""argmax"`),(2) 编码通道是 latitudelongitude 通道,或者 (3) 如果指定的比例尺类型是定量比例尺

  • "temporal" 是默认类型,如果 (1) 编码字段包含 timeUnit,或者 (2) 指定的比例尺类型是时间或 utc 比例尺。

  • "ordinal" 是默认类型,如果 (1) 编码字段包含自定义排序顺序,(2) 指定的比例尺类型是有序/点/带状比例尺,或者 (3) 编码通道是 order`。

  1. 对于数据域中的常数值(datum`)

  • 如果数据是数字,则为 "quantitative"

  • 如果数据是字符串,则为 "nominal"

  • 如果数据是日期时间对象,则为 "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, 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])

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

属性

aggregate

Aggregate 模式包装器。

align

Align 模式包装器。

bandPosition

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

bin

BinParams 模式包装器。

bounds

用于确定子图范围的边界计算方法。

center

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

columns

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

field

Field 模式包装器。

header

Header 模式包装器。

sort

Sort 模式包装器。

spacing

组合运算符的子视图之间的像素间距。

timeUnit

TimeUnit 模式包装器。

title

TitleParams 模式包装器。

type

Type 模式包装器。