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 schema wrapper.
- Parameters:
- layerSequence[dict,
UnitSpec
,LayerSpec
] Layer or single view specifications to be layered.
Note: Specifications inside
layer
cannot userow
andcolumn
channels as layering facet specifications is not allowed. Instead, use the facet operator and place a layer inside a facet.- autosizedict,
AutosizeType
,AutoSizeParams
, Literal[‘pad’, ‘none’, ‘fit’, ‘fit-x’, ‘fit-y’] How the visualization size should be determined. If a string, should be one of
"pad"
,"fit"
or"none"
. Object values can additionally specify parameters for content sizing and automatic resizing.Default value:
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 property to use as the background of the entire view.
Default value:
"white"
- configdict,
Config
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- datadict,
Data
,UrlData
,Generator
,NamedData
,DataSource
,InlineData
,SphereGenerator
,SequenceGenerator
,GraticuleGenerator
, None An object describing the data source. Set to
null
to ignore the parent’s data source. If no data is set, it is derived from the parent.- datasetsdict,
Datasets
A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a
data
property.- descriptionstr
Description of this mark for commenting purpose.
- encodingdict,
SharedEncoding
A shared key-value mapping between encoding channels and definition of fields in the underlying layers.
- heightdict, float,
Step
, Literal[‘container’] The height of a visualization.
For a plot with a continuous y-field, height should be a number.
For a plot with either a discrete y-field or no y-field, height can be either a number indicating a fixed height or an object in the form of
{step: number}
defining the height per discrete step. (No y-field is equivalent to having one discrete step.)To enable responsive sizing on height, it should be set to
"container"
.
Default value: Based on
config.view.continuousHeight
for a plot with a continuous y-field andconfig.view.discreteHeight
otherwise.Note: For plots with row and column channels, this represents the height of a single view and the
"container"
option cannot be used.See also: height documentation.
- namestr
Name of the visualization for later reference.
- paddingdict, float,
ExprRef
,Padding
The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides. If an object, the value should have the format
{"left": 5, "top": 5, "right": 5, "bottom": 5}
to specify padding for each side of the visualization.Default value:
5
- paramsSequence[dict,
TopLevelParameter
,VariableParameter
,TopLevelSelectionParameter
] Dynamic variables or selections that parameterize a visualization.
- projectiondict,
Projection
An object defining properties of the geographic projection shared by underlying layers.
- resolvedict,
Resolve
Scale, axis, and legend resolutions for view composition specifications.
- titlestr, dict,
Text
, Sequence[str],TitleParams
Title for the plot.
- transformSequence[dict,
Transform
,BinTransform
,FoldTransform
,LoessTransform
,PivotTransform
,StackTransform
,ExtentTransform
,FilterTransform
,ImputeTransform
,LookupTransform
,SampleTransform
,WindowTransform
,DensityTransform
,FlattenTransform
,QuantileTransform
,TimeUnitTransform
,AggregateTransform
,CalculateTransform
,RegressionTransform
,JoinAggregateTransform
] An array of data transformations such as filter and new field calculation.
- usermetadict,
Dict
Optional metadata that will be passed to Vega. This object is completely ignored by Vega and Vega-Lite and can be used for custom metadata.
- viewdict,
ViewBackground
An object defining the view background’s fill and stroke.
Default value: none (transparent)
- widthdict, float,
Step
, Literal[‘container’] The width of a visualization.
For a plot with a continuous x-field, width should be a number.
For a plot with either a discrete x-field or no x-field, width can be either a number indicating a fixed width or an object in the form of
{step: number}
defining the width per discrete step. (No x-field is equivalent to having one discrete step.)To enable responsive sizing on width, it should be set to
"container"
.
Default value: Based on
config.view.continuousWidth
for a plot with a continuous x-field andconfig.view.discreteWidth
otherwise.Note: For plots with row and column channels, this represents the width of a single view and the
"container"
option cannot be used.See also: width documentation.
- $schemastr
URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use
https://vega.github.io/schema/vega-lite/v5.json
. Setting the$schema
property allows automatic validation and autocomplete in editors that support JSON schema.
- layerSequence[dict,
- __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)#
Methods
__init__
([layer, autosize, background, ...])copy
([deep, ignore])Return a copy of the object.
from_dict
(dct[, validate])Construct class from a dictionary representation.
from_json
(json_string[, validate])Instantiate the object from a valid JSON string.
resolve_references
([schema])Resolve references in the context of this object's schema or root schema.
to_dict
([validate, ignore, context])Return a dictionary representation of the object.
to_json
([validate, indent, sort_keys, ...])Emit the JSON representation for this object as a string.
validate
(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property
(name, value[, schema])Validate a property against property schema in the context of the rootschema.