altair.UnitSpecWithFrame#
- class altair.UnitSpecWithFrame(mark=Undefined, data=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, params=Undefined, projection=Undefined, title=Undefined, transform=Undefined, view=Undefined, width=Undefined, **kwds)#
UnitSpecWithFrame schema wrapper
Mapping(required=[mark])
- Attributes
- mark
AnyMark A string describing the mark type (one of
"bar","circle","square","tick","line","area","point","rule","geoshape", and"text") or a mark definition object.- dataanyOf(
Data, None) An object describing the data source. Set to
nullto ignore the parent’s data source. If no data is set, it is derived from the parent.- descriptionstring
Description of this mark for commenting purpose.
- encoding
Encoding A key-value mapping between encoding channels and definition of fields.
- heightanyOf(float, string,
Step) 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.
- namestring
Name of the visualization for later reference.
- paramsList(anyOf(
VariableParameter,SelectionParameter)) An array of parameters that may either be simple variables, or more complex selections that map user input to data queries.
- projection
Projection An object defining properties of geographic projection, which will be applied to
shapepath for"geoshape"marks and tolatitudeand"longitude"channels for other marks.- titleanyOf(
Text,TitleParams) Title for the plot.
- transformList(
Transform) An array of data transformations such as filter and new field calculation.
- view
ViewBackground An object defining the view background’s fill and stroke.
Default value: none (transparent)
- widthanyOf(float, string,
Step) 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.
- mark
- __init__(mark=Undefined, data=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, params=Undefined, projection=Undefined, title=Undefined, transform=Undefined, view=Undefined, width=Undefined, **kwds)#
Methods
__init__([mark, data, description, ...])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