altair.TopLevelUnitSpec#

class altair.TopLevelUnitSpec(data=Undefined, mark=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)#

TopLevelUnitSpec 模式封装。

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

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

markdict, Mark, AnyMark, BoxPlot, MarkDef, ErrorBar, ErrorBand, BoxPlotDef, ErrorBarDef, ErrorBandDef, CompositeMark, CompositeMarkDef, Literal[‘arc’, ‘area’, ‘bar’, ‘image’, ‘line’, ‘point’, ‘rect’, ‘rule’, ‘text’, ‘tick’, ‘trail’, ‘circle’, ‘square’, ‘geoshape’, ‘boxplot’, ‘errorband’, ‘errorbar’]

描述标记类型（"bar"、"circle"、"square"、"tick"、"line"、"area"、"point"、"rule"、"geoshape" 和 "text" 之一）的字符串或标记定义对象。

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

configdict, Config

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

datasetsdict, Datasets

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

descriptionstr

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

encodingdict, FacetedEncoding

编码通道与字段定义之间的键值映射。

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

可视化的高度。

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

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

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

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

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

另请参阅： 高度文档。

namestr

可视化名称，以便后续引用。

paddingdict, float, ExprRef, Padding

默认的可视化内边距（像素），从可视化画布边缘到数据矩形。如果是数字，则指定所有边的内边距。如果是一个对象，其值应采用 {"left": 5, "top": 5, "right": 5, "bottom": 5} 格式，用于指定可视化各边的内边距。

默认值： 5

paramsSequence[dict, TopLevelParameter, VariableParameter, TopLevelSelectionParameter]

参数数组，可以是简单变量，也可以是将用户输入映射到数据查询的更复杂选择。

projectiondict, Projection

定义地理投影属性的对象，这些属性将应用于 "geoshape" 标记的 shape 路径以及其他标记的 latitude 和 "longitude" 通道。

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

viewdict, ViewBackground

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

默认值： 无（透明）

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

可视化宽度。

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

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

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

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

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

另请参阅： 宽度文档。

$schemastr

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

__init__(data=Undefined, mark=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)#

方法

__init__([data, mark, align, autosize, ...])

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

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