altair.TopLevelLayerSpec

class altair.TopLevelLayerSpec(layer=Undefined, autosize=Undefined, background=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)

TopLevelLayerSpec 模式封装器。

参数：

layerSequence[dict, UnitSpec, LayerSpec]

要分层显示的图层或单一视图规范。

注意：layer 中的规范不能使用 row 和 column 通道，因为不允许对分面规范进行分层。相反，请使用分面操作符并将图层放置在分面内部。

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 color 属性。

默认值："white"

configdict, Config

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

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

描述数据源的对象。设置为 null 将忽略父级的数据源。如果没有设置数据，则从父级派生。

datasetsdict, Datasets

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

descriptionstr

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

encodingdict, SharedEncoding

编码通道与底层图层中字段定义之间的共享键值映射。

heightdict, float, Step, Literal[‘container’]

可视化的高度。

• 对于具有连续 y 字段的图表，高度应为数字。

• 对于具有离散 y 字段或无 y 字段的图表，高度可以是表示固定高度的数字，也可以是 {step: number} 形式的对象，用于定义每个离散步长的高度。（无 y 字段相当于有一个离散步长。）

• 要启用高度的响应式大小调整，应将其设置为 "container"。

默认值：对于具有连续 y 字段的图表，基于 config.view.continuousHeight；否则基于 config.view.discreteHeight。

注意：对于使用行和列通道的图表，这表示单个视图的高度，不能使用 "container" 选项。

另请参阅：height 文档。

namestr

可视化名称，用于后续引用。

paddingdict, float, ExprRef, Padding

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

默认值：5

paramsSequence[dict, TopLevelParameter, VariableParameter, TopLevelSelectionParameter]

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

projectiondict, Projection

定义底层图层共享的地理投影属性的对象。

resolvedict, Resolve

用于视图组合规范的比例、轴和图例分辨率。

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 完全忽略，可用于自定义元数据。

viewdict, ViewBackground

定义视图背景填充和描边的对象。

默认值：无 (透明)

widthdict, float, Step, Literal[‘container’]

可视化的宽度。

• 对于具有连续 x 字段的图表，宽度应为数字。

• 对于具有离散 x 字段或无 x 字段的图表，宽度可以是表示固定宽度的数字，也可以是 {step: number} 形式的对象，用于定义每个离散步长的宽度。（无 x 字段相当于有一个离散步长。）

• 要启用宽度的响应式大小调整，应将其设置为 "container"。

默认值：对于具有连续 x 字段的图表，基于 config.view.continuousWidth；否则基于 config.view.discreteWidth。

注意：对于使用行和列通道的图表，这表示单个视图的宽度，不能使用 "container" 选项。

另请参阅：width 文档。

$schemastr

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

__init__(layer=Undefined, autosize=Undefined, background=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)

方法

__init__([layer, autosize, background, ...])
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])	在 rootschema 的上下文中根据类 schema 验证实例。
validate_property(name, value[, schema])	在 rootschema 的上下文中根据属性 schema 验证属性。