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

顶级单位规范架构包装器。

Parameters:
datadict, 数据, UrlData, 生成器, 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, 颜色, 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, 行列布尔值

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

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

默认值： false

configdict, 配置

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

datasetsdict, 数据集

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

descriptionstr

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

encodingdict, FacetedEncoding

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

heightdict, float, 步骤, Literal[‘container’]

可视化的高度。

  • 对于具有连续y轴字段的绘图，height应该是一个数字。

  • 对于具有离散y字段或没有y字段的图，height可以是表示固定高度的数字，也可以是以{step: number}形式定义每个离散步骤的高度的对象。(没有y字段相当于只有一个离散步骤。)

  • 要启用高度的响应式大小，应该设置为 "container"。

默认值： 基于 config.view.continuousHeight 用于具有连续 y 字段的图表，而 config.view.discreteHeight 则用于其他情况。

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

另见： height 文档。

namestr

供以后参考的可视化名称。

paddingdict, float, ExprRef, 填充

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

默认值: 5

paramsSequence[dict, TopLevelParameter, VariableParameter, TopLevelSelectionParameter]

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

projectiondict, 投影

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

resolvedict, 解决

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

spacingdict, float, RowColnumber

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

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

titlestr, dict, 文本, Sequence[str], TitleParams

图表的标题。

transformSequence[dict, 变换, 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, 步骤, Literal[‘container’]

可视化的宽度。

  • 对于具有连续x轴的图，宽度应该是一个数字。

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

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

默认值： 基于 config.view.continuousWidth 用于具有连续 x 字段的图表，其他情况下使用 config.view.discreteWidth。

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

另请参见： width 文档。

$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__([数据, 标记, 对齐, 自动调整大小, ...])

copy([深度, 忽略])

返回对象的副本。

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

在rootschema的上下文中验证实例是否符合类模式。

validate_property(name, value[, schema])

在根架构的上下文中，根据属性架构验证一个属性。