altair.LayerChart#
- class altair.LayerChart(layer=Undefined, autosize=Undefined, background=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)#
A Chart with layers within a single panel
- __init__(layer=Undefined, autosize=Undefined, background=Undefined, config=Undefined, data=Undefined, datasets=Undefined, description=Undefined, encoding=Undefined, height=Undefined, name=Undefined, padding=Undefined, params=Undefined, projection=Undefined, resolve=Undefined, title=Undefined, transform=Undefined, usermeta=Undefined, view=Undefined, width=Undefined, **kwds)#
Refer to
TopLevelLayerSpec
- Parameters:
- layerSequence[dict,
UnitSpec
,LayerSpec
] Layer or single view specifications to be layered.
Note : Specifications inside
layer
cannot userow
andcolumn
channels as layering facet specifications is not allowed. Instead, use the facet operator and place a layer inside a facet.- autosizedict,
AutosizeType
,AutoSizeParams
, 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
- backgroundstr, dict,
Color
,ExprRef
,HexColor
,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’] CSS color property to use as the background of the entire view.
Default value:
"white"
- configdict,
Config
Vega-Lite configuration object. This property can only be defined at the top-level of a specification.
- 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.- datasetsdict,
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.- descriptionstr
Description of this mark for commenting purpose.
- encodingdict,
SharedEncoding
A shared key-value mapping between encoding channels and definition of fields in the underlying layers.
- heightstr, dict, float,
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.continuousHeight
for a plot with a continuous y-field andconfig.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.
- paddingdict, float,
ExprRef
,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
- paramsSequence[dict,
TopLevelParameter
,VariableParameter
,TopLevelSelectionParameter
] Dynamic variables or selections that parameterize a visualization.
- projectiondict,
Projection
An object defining properties of the geographic projection shared by underlying layers.
- resolvedict,
Resolve
Scale, axis, and legend resolutions for view composition specifications.
- 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.
- usermetadict,
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.
- viewdict,
ViewBackground
An object defining the view background’s fill and stroke.
Default value: none (transparent)
- widthstr, dict, float,
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.continuousWidth
for a plot with a continuous x-field andconfig.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.
- $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.
- layerSequence[dict,
Methods
__init__
([layer, autosize, background, ...])Refer to
TopLevelLayerSpec
add_layers
(*layers)add_params
(*params)Add one or more parameters to the chart.
add_selection
(*selections)'add_selection' is deprecated.
configure
([arc, area, aria, autosize, axis, ...])Refer to
Config
configure_arc
([align, angle, aria, ...])Refer to
RectConfig
configure_area
([align, angle, aria, ...])Refer to
AreaConfig
configure_axis
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisBand
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisBottom
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisDiscrete
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisLeft
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisPoint
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisQuantitative
([aria, ...])Refer to
AxisConfig
configure_axisRight
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisTemporal
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisTop
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisX
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisXBand
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisXDiscrete
([aria, ...])Refer to
AxisConfig
configure_axisXPoint
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisXQuantitative
([aria, ...])Refer to
AxisConfig
configure_axisXTemporal
([aria, ...])Refer to
AxisConfig
configure_axisY
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisYBand
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisYDiscrete
([aria, ...])Refer to
AxisConfig
configure_axisYPoint
([aria, bandPosition, ...])Refer to
AxisConfig
configure_axisYQuantitative
([aria, ...])Refer to
AxisConfig
configure_axisYTemporal
([aria, ...])Refer to
AxisConfig
configure_bar
([align, angle, aria, ...])Refer to
BarConfig
configure_boxplot
([box, extent, median, ...])Refer to
BoxPlotConfig
configure_circle
([align, angle, aria, ...])Refer to
MarkConfig
configure_concat
([columns, spacing])Refer to
CompositionConfig
configure_errorband
([band, borders, extent, ...])Refer to
ErrorBandConfig
configure_errorbar
([extent, rule, size, ...])Refer to
ErrorBarConfig
configure_facet
([columns, spacing])Refer to
CompositionConfig
configure_geoshape
([align, angle, aria, ...])Refer to
MarkConfig
configure_header
([format, formatType, ...])Refer to
HeaderConfig
configure_headerColumn
([format, formatType, ...])Refer to
HeaderConfig
configure_headerFacet
([format, formatType, ...])Refer to
HeaderConfig
configure_headerRow
([format, formatType, ...])Refer to
HeaderConfig
configure_image
([align, angle, aria, ...])Refer to
RectConfig
configure_legend
([aria, clipHeight, ...])Refer to
LegendConfig
configure_line
([align, angle, aria, ...])Refer to
LineConfig
configure_mark
([align, angle, aria, ...])Refer to
MarkConfig
configure_point
([align, angle, aria, ...])Refer to
MarkConfig
configure_projection
([center, clipAngle, ...])Refer to
ProjectionConfig
configure_range
([category, diverging, ...])Refer to
RangeConfig
configure_rect
([align, angle, aria, ...])Refer to
RectConfig
configure_rule
([align, angle, aria, ...])Refer to
MarkConfig
configure_scale
([bandPaddingInner, ...])Refer to
ScaleConfig
configure_selection
([interval, point])Refer to
SelectionConfig
configure_square
([align, angle, aria, ...])Refer to
MarkConfig
configure_text
([align, angle, aria, ...])Refer to
MarkConfig
configure_tick
([align, angle, aria, ...])Refer to
TickConfig
configure_title
([align, anchor, angle, ...])Refer to
TitleConfig
configure_tooltipFormat
([...])Refer to
FormatConfig
configure_trail
([align, angle, aria, ...])Refer to
LineConfig
configure_view
([clip, continuousHeight, ...])Refer to
ViewConfig
copy
([deep, ignore])Return a copy of the object
display
([renderer, theme, actions])Display chart in Jupyter notebook or JupyterLab
facet
([facet, row, column, data, columns])Create a facet chart from the current chart.
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
interactive
([name, bind_x, bind_y])Make chart axes scales interactive
open_editor
(*[, fullscreen])Opens the chart specification in the Vega chart editor using the default browser.
project
([type, center, clipAngle, ...])Add a geographic projection to the chart.
properties
(**kwargs)Set top-level properties of the Chart.
repeat
([repeat, row, column, layer, columns])Return a RepeatChart built from the chart
resolve_axis
([x, y])Refer to
AxisResolveMap
resolve_legend
([angle, color, fill, ...])Refer to
LegendResolveMap
resolve_references
([schema])Resolve references in the context of this object's schema or root schema.
resolve_scale
([angle, color, fill, ...])Refer to
ScaleResolveMap
save
(fp[, format, ...])Save a chart to file in a variety of formats
serve
([ip, port, n_retries, files, ...])'serve' is deprecated.
show
()Display the chart using the active renderer
to_dict
([validate, format, ignore, context])Convert the chart to a dictionary suitable for JSON export
to_html
([base_url, output_div, ...])Embed a Vega/Vega-Lite spec into an HTML page
to_json
([validate, indent, sort_keys, ...])Convert a chart to a JSON string
to_url
(*[, fullscreen])Convert a chart to a URL that opens the chart specification in the Vega chart editor The chart specification (including any inline data) is encoded in the URL.
transform_aggregate
([aggregate, groupby])Add an
AggregateTransform
to the schema.transform_bin
([as_, field, bin])Add a
BinTransform
to the schema.transform_calculate
([as_, calculate])Add a
CalculateTransform
to the schema.transform_density
(density[, as_, bandwidth, ...])Add a
DensityTransform
to the spec.transform_extent
(extent, param)Add a
ExtentTransform
to the spec.transform_filter
(filter, **kwargs)Add a
FilterTransform
to the schema.transform_flatten
(flatten[, as_])Add a
FlattenTransform
to the schema.transform_fold
(fold[, as_])Add a
FoldTransform
to the spec.transform_impute
(impute, key[, frame, ...])Add an
ImputeTransform
to the schema.transform_joinaggregate
([joinaggregate, groupby])Add a
JoinAggregateTransform
to the schema.transform_loess
(on, loess[, as_, bandwidth, ...])Add a
LoessTransform
to the spec.transform_lookup
([lookup, from_, as_, default])Add a
DataLookupTransform
orSelectionLookupTransform
to the charttransform_pivot
(pivot, value[, groupby, ...])Add a
PivotTransform
to the chart.transform_quantile
(quantile[, as_, groupby, ...])Add a
QuantileTransform
to the charttransform_regression
(on, regression[, as_, ...])Add a
RegressionTransform
to the chart.transform_sample
([sample])Add a
SampleTransform
to the schema.transform_stack
(as_, stack, groupby[, ...])Add a
StackTransform
to the schema.transform_timeunit
([as_, field, timeUnit])Add a
TimeUnitTransform
to the schema.transform_window
([window, frame, groupby, ...])Add a
WindowTransform
to the schematransformed_data
([row_limit, exclude])Evaluate a LayerChart's transforms
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
Attributes
encode
Refer to _encode_signature :2: (WARNING/2) Title underline too short. Refer to
_encode_signature
----------