altair.TopLevelNormalizedConcatSpecGenericSpec
- class altair.TopLevelNormalizedConcatSpecGenericSpec(concat=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, columns=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)
-
TopLevelNormalizedConcatSpecGenericSpec schema wrapper
Mapping(required=[concat])
- Attributes
-
- concatList(
NormalizedSpec
) -
A list of views to be concatenated.
- alignanyOf(
LayoutAlign
,RowColLayoutAlign
) -
The alignment to apply to grid rows and columns. The supported string values are
"all"
,"each"
, and"none"
.-
For
"none"
, a flow layout will be used, in which adjacent subviews are simply placed one after the other. - For"each"
, subviews will be aligned into a clean grid structure, but each row or column may be of variable size. - For"all"
, subviews will be aligned and each row or column will be sized identically based on the maximum observed size. String values for this property will be applied to both grid rows and columns.
Alternatively, an object value of the form
{"row": string, "column": string}
can be used to supply different alignments for rows and columns.Default value:
"all"
. -
- autosizeanyOf(
AutosizeType
,AutoSizeParams
) -
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
- backgroundanyOf(
Color
,ExprRef
) -
CSS color property to use as the background of the entire view.
Default value:
"white"
- boundsenum(‘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 toflush
, 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"
-
- centeranyOf(boolean,
RowColboolean
) -
Boolean flag indicating if subviews should be centered relative to their respective rows or columns.
An object value of the form
{"row": boolean, "column": boolean}
can be used to supply different centering values for rows and columns.Default value:
false
- columnsfloat
-
The number of columns to include in the view composition layout.
Default value :
undefined
– An infinite number of columns (a single row) will be assumed. This is equivalent tohconcat
(forconcat
) and to using thecolumn
channel (forfacet
andrepeat
).Note :
1) This property is only for: - the general (wrappable)
concat
operator (nothconcat
/vconcat
) - thefacet
andrepeat
operator with one field/repetition definition (without row/column nesting)2) Setting the
columns
to1
is equivalent tovconcat
(forconcat
) and to using therow
channel (forfacet
andrepeat
). - config
Config
-
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- dataanyOf(
Data
, 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
-
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. - descriptionstring
-
Description of this mark for commenting purpose.
- namestring
-
Name of the visualization for later reference.
- paddinganyOf(
Padding
,ExprRef
) -
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
- paramsList(
Parameter
) -
Dynamic variables that parameterize a visualization.
- resolve
Resolve
-
Scale, axis, and legend resolutions for view composition specifications.
- spacinganyOf(float,
RowColnumber
) -
The spacing in pixels between sub-views of the composition operator. An object of the form
{"row": number, "column": number}
can be used to set different spacing values for rows and columns.Default value : Depends on
"spacing"
property of the view composition configuration (20
by default) - titleanyOf(
Text
,TitleParams
) -
Title for the plot.
- transformList(
Transform
) -
An array of data transformations such as filter and new field calculation.
- usermeta
Dictunknown
-
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.
- $schemastring
-
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/v4.json
. Setting the$schema
property allows automatic validation and autocomplete in editors that support JSON schema.
- concatList(
- __init__(concat=Undefined, align=Undefined, autosize=Undefined, background=Undefined, bounds=Undefined, center=Undefined, columns=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__
([concat, align, autosize, ...])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, ignore, context, indent, ...])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