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.

Parameters:
markdict, Mark, AnyMark, BoxPlot, MarkDef, ErrorBar, ErrorBand, BoxPlotDef, ErrorBarDef, ErrorBandDef, CompositeMark, CompositeMarkDef, Literal[‘arc’, ‘area’, ‘bar’, ‘image’, ‘line’, ‘point’, ‘rect’, ‘rule’, ‘text’, ‘tick’, ‘trail’, ‘circle’, ‘square’, ‘geoshape’, ‘boxplot’, ‘errorband’, ‘errorbar’]

A string describing the mark type (one of "bar", "circle", "square", "tick", "line", "area", "point", "rule", "geoshape", and "text") or a mark definition object.

datadict, None, Data, UrlData, Generator, NamedData, DataSource, InlineData, SphereGenerator, SequenceGenerator, GraticuleGenerator

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.

descriptionstr

Description of this mark for commenting purpose.

encodingdict, Encoding

A key-value mapping between encoding channels and definition of fields.

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 and config.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.

paramsSequence[dict, SelectionParameter]

An array of parameters that may either be simple variables, or more complex selections that map user input to data queries.

projectiondict, Projection

An object defining properties of geographic projection, which will be applied to shape path for "geoshape" marks and to latitude and "longitude" channels for other marks.

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.

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 and config.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.

__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])

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.
On this page