altair.TopLevelVConcatSpec#
- class altair.TopLevelVConcatSpec(vconcat=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, name=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, **kwds)#
TopLevelVConcatSpec schema wrapper
TopLevelVConcatSpec
, Dict[required=[vconcat]]- Parameters:
- vconcatSequence[
ConcatSpecGenericSpec
, Dict[required=[concat]],FacetSpec
, Dict[required=[facet, spec]],FacetedUnitSpec
, Dict[required=[mark]],HConcatSpecGenericSpec
, Dict[required=[hconcat]],LayerRepeatSpec
, Dict[required=[repeat, spec]],NonLayerRepeatSpec
, Dict[required=[repeat, spec]],RepeatSpec
,LayerSpec
, Dict[required=[layer]],NonNormalizedSpec
,VConcatSpecGenericSpec
, Dict[required=[vconcat]]] A list of views to be concatenated and put into a column.
- autosize
AutoSizeParams
, Dict,AutosizeType
, 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
- background
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’],Color
,HexColor
, str, str,ExprRef
, Dict[required=[expr]] CSS color property to use as the background of the entire view.
Default value:
"white"
- boundsLiteral[‘full’, ‘flush’]
The bounds calculation method to use for determining the extent of a sub-plot. One of
full
(the default) orflush
.If set to
full
, the entire calculated bounds (including axes, title, and legend) will be used.If set to
flush
, only the specified width and height values for the sub-view will be used. Theflush
setting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.
Default value:
"full"
- centerbool
Boolean flag indicating if subviews should be centered relative to their respective rows or columns.
Default value:
false
- config
Config
, Dict Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- data
DataSource
,InlineData
, Dict[required=[values]],NamedData
, Dict[required=[name]],UrlData
, Dict[required=[url]],Data
,Generator
,GraticuleGenerator
, Dict[required=[graticule]],SequenceGenerator
, Dict[required=[sequence]],SphereGenerator
, Dict[required=[sphere]], 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.- datasets
Datasets
, Dict 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.
- namestr
Name of the visualization for later reference.
- padding
ExprRef
, Dict[required=[expr]],Padding
, Dict, float 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[
TopLevelParameter
,TopLevelSelectionParameter
, Dict[required=[name, select]],VariableParameter
, Dict[required=[name]]] Dynamic variables or selections that parameterize a visualization.
- resolve
Resolve
, Dict Scale, axis, and legend resolutions for view composition specifications.
- spacingfloat
The spacing in pixels between sub-views of the concat operator.
Default value :
10
- title
Text
, Sequence[str], str,TitleParams
, Dict[required=[text]] Title for the plot.
- transformSequence[
AggregateTransform
, Dict[required=[aggregate]],BinTransform
, Dict[required=[bin, field, as]],CalculateTransform
, Dict[required=[calculate, as]],DensityTransform
, Dict[required=[density]],ExtentTransform
, Dict[required=[extent, param]],FilterTransform
, Dict[required=[filter]],FlattenTransform
, Dict[required=[flatten]],FoldTransform
, Dict[required=[fold]],ImputeTransform
, Dict[required=[impute, key]],JoinAggregateTransform
, Dict[required=[joinaggregate]],LoessTransform
, Dict[required=[loess, on]],LookupTransform
, Dict[required=[lookup, from]],PivotTransform
, Dict[required=[pivot, value]],QuantileTransform
, Dict[required=[quantile]],RegressionTransform
, Dict[required=[regression, on]],SampleTransform
, Dict[required=[sample]],StackTransform
, Dict[required=[stack, groupby, as]],TimeUnitTransform
, Dict[required=[timeUnit, field, as]],Transform
,WindowTransform
, Dict[required=[window]]] An array of data transformations such as filter and new field calculation.
- usermeta
Dict
, 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.
- $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.
- vconcatSequence[
- __init__(vconcat=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, name=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, spacing=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, **kwds)#
Methods
__init__
([vconcat, autosize, background, ...])copy
([deep, ignore])Return a copy of the object
from_dict
(dct[, validate, _wrapper_classes])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