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/.- Attributes
- dataData
An object describing the data source
- markAnyMark
- A string describing the mark type (one of “bar”, “circle”, “square”, “tick”,
“line”, * “area”, “point”, “rule”, “geoshape”, and “text”) or a MarkDef object.
- 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_parameter(*params)Add one or more parameters to the chart.
add_selection(*params)configure([arc, area, aria, autosize, axis, ...])Config schema wrapper
configure_arc([align, angle, aria, ...])RectConfig schema wrapper
configure_area([align, angle, aria, ...])AreaConfig schema wrapper
configure_axis([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisBand([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisBottom([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisDiscrete([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisLeft([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisPoint([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisQuantitative([aria, ...])AxisConfig schema wrapper
configure_axisRight([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisTemporal([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisTop([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisX([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisXBand([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisXDiscrete([aria, ...])AxisConfig schema wrapper
configure_axisXPoint([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisXQuantitative([aria, ...])AxisConfig schema wrapper
configure_axisXTemporal([aria, ...])AxisConfig schema wrapper
configure_axisY([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisYBand([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisYDiscrete([aria, ...])AxisConfig schema wrapper
configure_axisYPoint([aria, bandPosition, ...])AxisConfig schema wrapper
configure_axisYQuantitative([aria, ...])AxisConfig schema wrapper
configure_axisYTemporal([aria, ...])AxisConfig schema wrapper
configure_bar([align, angle, aria, ...])BarConfig schema wrapper
configure_boxplot([box, extent, median, ...])BoxPlotConfig schema wrapper
configure_circle([align, angle, aria, ...])MarkConfig schema wrapper
configure_concat([columns, spacing])CompositionConfig schema wrapper
configure_errorband([band, borders, extent, ...])ErrorBandConfig schema wrapper
configure_errorbar([extent, rule, size, ...])ErrorBarConfig schema wrapper
configure_facet([columns, spacing])CompositionConfig schema wrapper
configure_geoshape([align, angle, aria, ...])MarkConfig schema wrapper
configure_header([format, formatType, ...])HeaderConfig schema wrapper
configure_headerColumn([format, formatType, ...])HeaderConfig schema wrapper
configure_headerFacet([format, formatType, ...])HeaderConfig schema wrapper
configure_headerRow([format, formatType, ...])HeaderConfig schema wrapper
configure_image([align, angle, aria, ...])RectConfig schema wrapper
configure_legend([aria, clipHeight, ...])LegendConfig schema wrapper
configure_line([align, angle, aria, ...])LineConfig schema wrapper
configure_mark([align, angle, aria, ...])MarkConfig schema wrapper
configure_point([align, angle, aria, ...])MarkConfig schema wrapper
configure_projection([center, clipAngle, ...])ProjectionConfig schema wrapper
configure_range([category, diverging, ...])RangeConfig schema wrapper
configure_rect([align, angle, aria, ...])RectConfig schema wrapper
configure_rule([align, angle, aria, ...])MarkConfig schema wrapper
configure_scale([bandPaddingInner, ...])ScaleConfig schema wrapper
configure_selection([interval, point])SelectionConfig schema wrapper
configure_square([align, angle, aria, ...])MarkConfig schema wrapper
configure_text([align, angle, aria, ...])MarkConfig schema wrapper
configure_tick([align, angle, aria, ...])TickConfig schema wrapper
configure_title([align, anchor, angle, ...])TitleConfig schema wrapper
configure_trail([align, angle, aria, ...])LineConfig schema wrapper
configure_view([clip, continuousHeight, ...])ViewConfig schema wrapper
copy([deep, ignore])Return a copy of the object
display([renderer, theme, actions])Display chart in Jupyter notebook or JupyterLab
encode([angle, color, column, description, ...])FacetedEncoding schema wrapper
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'
mark_area([align, angle, aria, ariaRole, ...])Set the chart's mark to 'area'
mark_bar([align, angle, aria, ariaRole, ...])Set the chart's mark to 'bar'
mark_boxplot([box, clip, color, extent, ...])Set the chart's mark to 'boxplot'
mark_circle([align, angle, aria, ariaRole, ...])Set the chart's mark to 'circle'
mark_errorband([band, borders, clip, color, ...])Set the chart's mark to 'errorband'
mark_errorbar([clip, color, extent, ...])Set the chart's mark to 'errorbar'
mark_geoshape([align, angle, aria, ...])Set the chart's mark to 'geoshape'
mark_image([align, angle, aria, ariaRole, ...])Set the chart's mark to 'image'
mark_line([align, angle, aria, ariaRole, ...])Set the chart's mark to 'line'
mark_point([align, angle, aria, ariaRole, ...])Set the chart's mark to 'point'
mark_rect([align, angle, aria, ariaRole, ...])Set the chart's mark to 'rect'
mark_rule([align, angle, aria, ariaRole, ...])Set the chart's mark to 'rule'
mark_square([align, angle, aria, ariaRole, ...])Set the chart's mark to 'square'
mark_text([align, angle, aria, ariaRole, ...])Set the chart's mark to 'text'
mark_tick([align, angle, aria, ariaRole, ...])Set the chart's mark to 'tick'
mark_trail([align, angle, aria, ariaRole, ...])Set the chart's mark to 'trail'
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])AxisResolveMap schema wrapper
resolve_legend([angle, color, fill, ...])LegendResolveMap schema wrapper
resolve_references([schema])Resolve references in the context of this object's schema or root schema.
resolve_scale([angle, color, fill, ...])ScaleResolveMap schema wrapper
save(fp[, format, ...])Save a chart to file in a variety of formats
serve([ip, port, n_retries, files, ...])Open a browser window and display a rendering of the chart
show([embed_opt, open_browser])Show the chart in an external browser window.
to_dict(*args, **kwargs)Convert the chart to a dictionary suitable for JSON export.
to_html([base_url, output_div, ...])to_json([validate, ignore, context, indent, ...])Emit the JSON representation for this object as a string.
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_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 pivot transform to the chart.
transform_quantile(quantile[, as_, groupby, ...])Add a quantile transform 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
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