altair.TopLevelFacetSpec#

class altair.TopLevelFacetSpec(data=Undefined, facet=Undefined, spec=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, columns=Undefined, config=Undefined, datasets=Undefined, description=Undefined, name=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, **kwds)#

TopLevelFacetSpec schema 包装器。

参数:
datadict, Data, UrlData, Generator, NamedData, DataSource, InlineData, SphereGenerator, SequenceGenerator, GraticuleGenerator, None

描述数据源的对象。设置为 null 可忽略父级的数据源。如果未设置数据,则从父级派生。

facetdict, FacetMapping, FacetFieldDef

如何对数据进行分面的定义。以下之一:1)用于按一个字段对图表进行分面的字段定义 2)将行和列通道映射到其字段定义的对象

specdict, LayerSpec, UnitSpecWithFrame

对进行分面的视图的规范。

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

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

  • 对于 "none",将使用流式布局,其中相邻子视图简单地一个接一个地放置。

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

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

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

默认值: "all"

autosizedict, AutosizeType, AutoSizeParams, Literal[‘pad’, ‘none’, ‘fit’, ‘fit-x’, ‘fit-y’]

如何确定可视化大小。如果为字符串,应为 "pad""fit""none" 之一。对象值还可以指定内容大小和自动调整大小的参数。

默认值: pad

backgroundstr, dict, Color, ExprRef, HexColor, ColorName, Literal[‘black’, ‘silver’, ‘gray’, ‘white’, ‘maroon’, ‘red’, ‘purple’, ‘fuchsia’, ‘green’, ‘lime’, ‘olive’, ‘yellow’, ‘navy’, ‘blue’, ‘teal’, ‘aqua’, ‘orange’, ‘aliceblue’, ‘antiquewhite’, ‘aquamarine’, ‘azure’, ‘beige’, ‘bisque’, ‘blanchedalmond’, ‘blueviolet’, ‘brown’, ‘burlywood’, ‘cadetblue’, ‘chartreuse’, ‘chocolate’, ‘coral’, ‘cornflowerblue’, ‘cornsilk’, ‘crimson’, ‘cyan’, ‘darkblue’, ‘darkcyan’, ‘darkgoldenrod’, ‘darkgray’, ‘darkgreen’, ‘darkgrey’, ‘darkkhaki’, ‘darkmagenta’, ‘darkolivegreen’, ‘darkorange’, ‘darkorchid’, ‘darkred’, ‘darksalmon’, ‘darkseagreen’, ‘darkslateblue’, ‘darkslategray’, ‘darkslategrey’, ‘darkturquoise’, ‘darkviolet’, ‘deeppink’, ‘deepskyblue’, ‘dimgray’, ‘dimgrey’, ‘dodgerblue’, ‘firebrick’, ‘floralwhite’, ‘forestgreen’, ‘gainsboro’, ‘ghostwhite’, ‘gold’, ‘goldenrod’, ‘greenyellow’, ‘grey’, ‘honeydew’, ‘hotpink’, ‘indianred’, ‘indigo’, ‘ivory’, ‘khaki’, ‘lavender’, ‘lavenderblush’, ‘lawngreen’, ‘lemonchiffon’, ‘lightblue’, ‘lightcoral’, ‘lightcyan’, ‘lightgoldenrodyellow’, ‘lightgray’, ‘lightgreen’, ‘lightgrey’, ‘lightpink’, ‘lightsalmon’, ‘lightseagreen’, ‘lightskyblue’, ‘lightslategray’, ‘lightslategrey’, ‘lightsteelblue’, ‘lightyellow’, ‘limegreen’, ‘linen’, ‘magenta’, ‘mediumaquamarine’, ‘mediumblue’, ‘mediumorchid’, ‘mediumpurple’, ‘mediumseagreen’, ‘mediumslateblue’, ‘mediumspringgreen’, ‘mediumturquoise’, ‘mediumvioletred’, ‘midnightblue’, ‘mintcream’, ‘mistyrose’, ‘moccasin’, ‘navajowhite’, ‘oldlace’, ‘olivedrab’, ‘orangered’, ‘orchid’, ‘palegoldenrod’, ‘palegreen’, ‘paleturquoise’, ‘palevioletred’, ‘papayawhip’, ‘peachpuff’, ‘peru’, ‘pink’, ‘plum’, ‘powderblue’, ‘rosybrown’, ‘royalblue’, ‘saddlebrown’, ‘salmon’, ‘sandybrown’, ‘seagreen’, ‘seashell’, ‘sienna’, ‘skyblue’, ‘slateblue’, ‘slategray’, ‘slategrey’, ‘snow’, ‘springgreen’, ‘steelblue’, ‘tan’, ‘thistle’, ‘tomato’, ‘turquoise’, ‘violet’, ‘wheat’, ‘whitesmoke’, ‘yellowgreen’, ‘rebeccapurple’]

用于整个视图背景的 CSS 颜色属性。

默认值: "white"

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)。

configdict, Config

Vega-Lite 配置对象。此属性只能在规范的顶层定义。

datasetsdict, Datasets

用于命名数据集的全局数据存储。这是名称到内联数据集的映射。它可以是对象或原始值数组,也可以是字符串。原始值数组作为具有 data 属性的对象被摄取。

descriptionstr

此标记的描述,用于注释目的。

namestr

可视化名称,以便以后引用。

paddingdict, float, ExprRef, Padding

默认的可视化填充,以像素为单位,从可视化画布边缘到数据矩形。如果是一个数字,则指定所有边的填充。如果是一个对象,则值应具有 {"left": 5, "top": 5, "right": 5, "bottom": 5} 格式,以指定可视化各边的填充。

默认值: 5

paramsSequence[dict, TopLevelParameter, VariableParameter, TopLevelSelectionParameter]

参数化可视化的动态变量或选择。

resolvedict, Resolve

视图组合规范的刻度、轴和图例解析。

spacingdict, float, RowColnumber

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

默认值: 取决于视图组合配置"spacing" 属性(默认为 20

titlestr, dict, Text, Sequence[str], TitleParams

图表标题。

transformSequence[dict, Transform, BinTransform, FoldTransform, LoessTransform, PivotTransform, StackTransform, ExtentTransform, FilterTransform, ImputeTransform, LookupTransform, SampleTransform, WindowTransform, DensityTransform, FlattenTransform, QuantileTransform, TimeUnitTransform, AggregateTransform, CalculateTransform, RegressionTransform, JoinAggregateTransform]

数据转换数组,例如过滤和新字段计算。

usermetadict, Dict

将传递给 Vega 的可选元数据。Vega 和 Vega-Lite 完全忽略此对象,可用于自定义元数据。

$schemastr

Vega-Lite 规范的JSON schema URL。除非您有理由更改此项,否则请使用 https://vega.github.io/schema/vega-lite/v5.json。设置 $schema 属性可在支持 JSON schema 的编辑器中进行自动验证和自动完成。

__init__(data=Undefined, facet=Undefined, spec=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, columns=Undefined, config=Undefined, datasets=Undefined, description=Undefined, name=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, **kwds)#

方法

__init__([data, facet, spec, 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 验证属性。