altair.theme.ThemeConfig#
- class altair.theme.ThemeConfig#
Top-Level Configuration
TypedDictfor creating a consistent theme.- Parameters:
- align
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".- autosize
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
CSS color property to use as the background of the entire view.
Default value:
"white"- bounds
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. Theflushsetting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.
Default value:
"full"- center
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- config
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- description
Description of this mark for commenting purpose.
- height
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.continuousHeightfor a plot with a continuous y-field andconfig.view.discreteHeightotherwise.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.
- name
Name of the visualization for later reference.
- 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- params
An array of parameters that may either be simple variables, or more complex selections that map user input to data queries.
- projection
An object defining properties of geographic projection, which will be applied to
shapepath for"geoshape"marks and tolatitudeand"longitude"channels for other marks.- resolve
Scale, axis, and legend resolutions for view composition specifications.
- spacing
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 (20by default)- title
Title for the plot.
- usermeta
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.
- view
An object defining the view background’s fill and stroke.
Default value: none (transparent)
- width
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.continuousWidthfor a plot with a continuous x-field andconfig.view.discreteWidthotherwise.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.
- __init__(*args, **kwargs)#
Methods
__init__(*args, **kwargs)clear()copy()fromkeys(iterable[, value])Create a new dictionary with keys from iterable and values set to value.
get(key[, default])Return the value for key if key is in the dictionary, else default.
items()keys()pop(key[, default])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()Attributes
alignautosizebackgroundboundscenterconfigdescriptionheightnamepaddingparamsprojectionresolvespacingtitleusermetaviewwidth