altair.Chart#

class altair.Chart(data=Undefined, encoding=Undefined, mark=Undefined, width=Undefined, height=Undefined, **kwargs)#

Create a basic Altair/Vega-Lite chart.

Although it is possible to set all Chart properties as constructor attributes, it is more idiomatic to use methods such as mark_point(), encode(), transform_filter(), properties(), etc. See Altair’s documentation for details and examples: http://altair-viz.github.io/.

Parameters:
dataData

An object describing the data source

markAnyMark

A MarkDef or CompositeMarkDef object, or a string describing the mark type (one of “arc”, “area”, “bar”, “circle”, “geoshape”, “image”, “line”, “point”, “rule”, “rect”, “square”, “text”, “tick”, “trail”, “boxplot”, “errorband”, and “errorbar”).

encodingFacetedEncoding

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

autosizeanyOf(AutosizeType, AutoSizeParams)

Sets 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. “fit” is only supported for single and layered views that don’t use rangeStep. Default value: pad

backgroundstring

CSS color property to use as the background of visualization.

Default value: none (transparent)

configConfig

Vega-Lite configuration object. This property can only be defined at the top-level of a specification.

descriptionstring

Description of this mark for commenting purpose.

heightfloat

The height of a visualization.

namestring

Name of the visualization for later reference.

paddingPadding

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

projectionProjection

An object defining properties of geographic projection. Works with “geoshape” marks and “point” or “line” marks that have a channel (one or more of “X”, “X2”, “Y”, “Y2”) with type “latitude”, or “longitude”.

selectionMapping(required=[])

A key-value mapping between selection names and definitions.

titleanyOf(string, TitleParams)

Title for the plot.

transformList(Transform)

An array of data transformations such as filter and new field calculation.

widthfloat

The width of a visualization.

__init__(data=Undefined, encoding=Undefined, mark=Undefined, width=Undefined, height=Undefined, **kwargs)#

Methods

__init__([data, encoding, mark, width, height])

add_params(*params)

Add one or more parameters to the chart.

add_selection(*params)

'add_selection' is deprecated.

configure([arc, area, aria, autosize, axis, ...])

Refer to Config Config schema wrapper.

configure_arc([align, angle, aria, ...])

Refer to RectConfig RectConfig schema wrapper.

configure_area([align, angle, aria, ...])

Refer to AreaConfig AreaConfig schema wrapper.

configure_axis([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisBand([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisBottom([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisDiscrete([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisLeft([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisPoint([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisQuantitative([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisRight([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisTemporal([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisTop([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisX([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisXBand([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisXDiscrete([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisXPoint([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisXQuantitative([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisXTemporal([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisY([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisYBand([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisYDiscrete([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisYPoint([aria, bandPosition, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisYQuantitative([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_axisYTemporal([aria, ...])

Refer to AxisConfig AxisConfig schema wrapper.

configure_bar([align, angle, aria, ...])

Refer to BarConfig BarConfig schema wrapper.

configure_boxplot([box, extent, median, ...])

Refer to BoxPlotConfig BoxPlotConfig schema wrapper.

configure_circle([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_concat([columns, spacing])

Refer to CompositionConfig CompositionConfig schema wrapper.

configure_errorband([band, borders, extent, ...])

Refer to ErrorBandConfig ErrorBandConfig schema wrapper.

configure_errorbar([extent, rule, size, ...])

Refer to ErrorBarConfig ErrorBarConfig schema wrapper.

configure_facet([columns, spacing])

Refer to CompositionConfig CompositionConfig schema wrapper.

configure_geoshape([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_header([format, formatType, ...])

Refer to HeaderConfig HeaderConfig schema wrapper.

configure_headerColumn([format, formatType, ...])

Refer to HeaderConfig HeaderConfig schema wrapper.

configure_headerFacet([format, formatType, ...])

Refer to HeaderConfig HeaderConfig schema wrapper.

configure_headerRow([format, formatType, ...])

Refer to HeaderConfig HeaderConfig schema wrapper.

configure_image([align, angle, aria, ...])

Refer to RectConfig RectConfig schema wrapper.

configure_legend([aria, clipHeight, ...])

Refer to LegendConfig LegendConfig schema wrapper.

configure_line([align, angle, aria, ...])

Refer to LineConfig LineConfig schema wrapper.

configure_mark([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_point([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_projection([center, clipAngle, ...])

Refer to ProjectionConfig ProjectionConfig schema wrapper.

configure_range([category, diverging, ...])

Refer to RangeConfig RangeConfig schema wrapper.

configure_rect([align, angle, aria, ...])

Refer to RectConfig RectConfig schema wrapper.

configure_rule([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_scale([bandPaddingInner, ...])

Refer to ScaleConfig ScaleConfig schema wrapper.

configure_selection([interval, point])

Refer to SelectionConfig SelectionConfig schema wrapper.

configure_square([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_text([align, angle, aria, ...])

Refer to MarkConfig MarkConfig schema wrapper.

configure_tick([align, angle, aria, ...])

Refer to TickConfig TickConfig schema wrapper.

configure_title([align, anchor, angle, ...])

Refer to TitleConfig TitleConfig schema wrapper.

configure_tooltipFormat([...])

Refer to FormatConfig FormatConfig schema wrapper.

configure_trail([align, angle, aria, ...])

Refer to LineConfig LineConfig schema wrapper.

configure_view([clip, continuousHeight, ...])

Refer to ViewConfig ViewConfig schema wrapper.

copy([deep, ignore])

Return a copy of the object.

display([renderer, theme, actions])

Display chart in Jupyter notebook or JupyterLab.

encode(*args[, angle, color, column, ...])

Map properties of the data to visual properties of the chart (see FacetedEncoding).

facet([facet, row, column, data, columns])

Create a facet chart from the current chart.

from_dict(dct[, validate])

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.

mark_arc([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'arc' (see MarkDef).

mark_area([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'area' (see MarkDef).

mark_bar([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'bar' (see MarkDef).

mark_boxplot([box, clip, color, extent, ...])

Set the chart's mark to 'boxplot' (see BoxPlotDef).

mark_circle([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'circle' (see MarkDef).

mark_errorband([band, borders, clip, color, ...])

Set the chart's mark to 'errorband' (see ErrorBandDef).

mark_errorbar([clip, color, extent, ...])

Set the chart's mark to 'errorbar' (see ErrorBarDef).

mark_geoshape([align, angle, aria, ...])

Set the chart's mark to 'geoshape' (see MarkDef).

mark_image([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'image' (see MarkDef).

mark_line([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'line' (see MarkDef).

mark_point([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'point' (see MarkDef).

mark_rect([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'rect' (see MarkDef).

mark_rule([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'rule' (see MarkDef).

mark_square([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'square' (see MarkDef).

mark_text([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'text' (see MarkDef).

mark_tick([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'tick' (see MarkDef).

mark_trail([align, angle, aria, ariaRole, ...])

Set the chart's mark to 'trail' (see MarkDef).

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 AxisResolveMap schema wrapper.

resolve_legend([angle, color, fill, ...])

Refer to LegendResolveMap LegendResolveMap schema wrapper.

resolve_references([schema])

Resolve references in the context of this object's schema or root schema.

resolve_scale([angle, color, fill, ...])

Refer to ScaleResolveMap ScaleResolveMap schema wrapper.

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.

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 or SelectionLookupTransform to the chart.

transform_pivot(pivot, value[, groupby, ...])

Add a PivotTransform to the chart.

transform_quantile(quantile[, as_, groupby, ...])

Add a QuantileTransform to the chart.

transform_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 schema.

transformed_data([row_limit, exclude])

Evaluate a Chart'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

data

On this page