altair.Config#

class altair.Config(arc=Undefined, area=Undefined, aria=Undefined, autosize=Undefined, axis=Undefined, axisBand=Undefined, axisBottom=Undefined, axisDiscrete=Undefined, axisLeft=Undefined, axisPoint=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTemporal=Undefined, axisTop=Undefined, axisX=Undefined, axisXBand=Undefined, axisXDiscrete=Undefined, axisXPoint=Undefined, axisXQuantitative=Undefined, axisXTemporal=Undefined, axisY=Undefined, axisYBand=Undefined, axisYDiscrete=Undefined, axisYPoint=Undefined, axisYQuantitative=Undefined, axisYTemporal=Undefined, background=Undefined, bar=Undefined, boxplot=Undefined, circle=Undefined, concat=Undefined, countTitle=Undefined, customFormatTypes=Undefined, errorband=Undefined, errorbar=Undefined, facet=Undefined, fieldTitle=Undefined, font=Undefined, geoshape=Undefined, header=Undefined, headerColumn=Undefined, headerFacet=Undefined, headerRow=Undefined, image=Undefined, legend=Undefined, line=Undefined, lineBreak=Undefined, locale=Undefined, mark=Undefined, normalizedNumberFormat=Undefined, normalizedNumberFormatType=Undefined, numberFormat=Undefined, numberFormatType=Undefined, padding=Undefined, params=Undefined, point=Undefined, projection=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, selection=Undefined, square=Undefined, style=Undefined, text=Undefined, tick=Undefined, timeFormat=Undefined, timeFormatType=Undefined, title=Undefined, trail=Undefined, view=Undefined, **kwds)#

Config schema wrapper

Mapping(required=[])

Parameters:
arcRectConfig

Arc-specific Config

areaAreaConfig

Area-Specific Config

ariaboolean

A boolean flag indicating if ARIA default attributes should be included for marks and guides (SVG output only). If false, the "aria-hidden" attribute will be set for all guides, removing them from the ARIA accessibility tree and Vega-Lite will not generate default descriptions for marks.

Default value: true.

autosizeanyOf(AutosizeType, AutoSizeParams)

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

axisAxisConfig

Axis configuration, which determines default properties for all x and y axes. For a full list of axis configuration options, please see the corresponding section of the axis documentation.

axisBandAxisConfig

Config for axes with “band” scales.

axisBottomAxisConfig

Config for x-axis along the bottom edge of the chart.

axisDiscreteAxisConfig

Config for axes with “point” or “band” scales.

axisLeftAxisConfig

Config for y-axis along the left edge of the chart.

axisPointAxisConfig

Config for axes with “point” scales.

axisQuantitativeAxisConfig

Config for quantitative axes.

axisRightAxisConfig

Config for y-axis along the right edge of the chart.

axisTemporalAxisConfig

Config for temporal axes.

axisTopAxisConfig

Config for x-axis along the top edge of the chart.

axisXAxisConfig

X-axis specific config.

axisXBandAxisConfig

Config for x-axes with “band” scales.

axisXDiscreteAxisConfig

Config for x-axes with “point” or “band” scales.

axisXPointAxisConfig

Config for x-axes with “point” scales.

axisXQuantitativeAxisConfig

Config for x-quantitative axes.

axisXTemporalAxisConfig

Config for x-temporal axes.

axisYAxisConfig

Y-axis specific config.

axisYBandAxisConfig

Config for y-axes with “band” scales.

axisYDiscreteAxisConfig

Config for y-axes with “point” or “band” scales.

axisYPointAxisConfig

Config for y-axes with “point” scales.

axisYQuantitativeAxisConfig

Config for y-quantitative axes.

axisYTemporalAxisConfig

Config for y-temporal axes.

backgroundanyOf(Color, ExprRef)

CSS color property to use as the background of the entire view.

Default value: "white"

barBarConfig

Bar-Specific Config

boxplotBoxPlotConfig

Box Config

circleMarkConfig

Circle-Specific Config

concatCompositionConfig

Default configuration for all concatenation and repeat view composition operators ( concat, hconcat, vconcat, and repeat )

countTitlestring

Default axis and legend title for count fields.

Default value: 'Count of Records.

customFormatTypesboolean

Allow the formatType property for text marks and guides to accept a custom formatter function registered as a Vega expression.

errorbandErrorBandConfig

ErrorBand Config

errorbarErrorBarConfig

ErrorBar Config

facetCompositionConfig

Default configuration for the facet view composition operator

fieldTitleenum(‘verbal’, ‘functional’, ‘plain’)

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., “Sum of field”, “Year-month of date”, “field (binned)”).

  • "function" - displays function using parentheses and capitalized texts (e.g., “SUM(field)”, “YEARMONTH(date)”, “BIN(field)”).

  • "plain" - displays only the field name without functions (e.g., “field”, “date”, “field”).

fontstring

Default font for all text marks, titles, and labels.

geoshapeMarkConfig

Geoshape-Specific Config

headerHeaderConfig

Header configuration, which determines default properties for all headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerColumnHeaderConfig

Header configuration, which determines default properties for column headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerFacetHeaderConfig

Header configuration, which determines default properties for non-row/column facet headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

headerRowHeaderConfig

Header configuration, which determines default properties for row headers.

For a full list of header configuration options, please see the corresponding section of in the header documentation.

imageRectConfig

Image-specific Config

legendLegendConfig

Legend configuration, which determines default properties for all legends. For a full list of legend configuration options, please see the corresponding section of in the legend documentation.

lineLineConfig

Line-Specific Config

lineBreakanyOf(string, ExprRef)

A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property provides a global default for text marks, which is overridden by mark or style config settings, and by the lineBreak mark encoding channel. If signal-valued, either string or regular expression (regexp) values are valid.

localeLocale

Locale definitions for string parsing and formatting of number and date values. The locale object should contain number and/or time properties with locale definitions. Locale definitions provided in the config block may be overridden by the View constructor locale option.

markMarkConfig

Mark Config

normalizedNumberFormatstring

If normalizedNumberFormatType is not specified, D3 number format for axis labels, text marks, and tooltips of normalized stacked fields (fields with stack: "normalize" ). For example "s" for SI units. Use D3’s number format pattern.

If config.normalizedNumberFormatType is specified and config.customFormatTypes is true, this value will be passed as format alongside datum.value to the config.numberFormatType function. Default value: %

normalizedNumberFormatTypestring

Custom format type for config.normalizedNumberFormat.

Default value: undefined – This is equilvalent to call D3-format, which is exposed as format in Vega-Expression. Note: You must also set customFormatTypes to true to use this feature.

numberFormatstring

If numberFormatType is not specified, D3 number format for guide labels, text marks, and tooltips of non-normalized fields (fields without stack: "normalize" ). For example "s" for SI units. Use D3’s number format pattern.

If config.numberFormatType is specified and config.customFormatTypes is true, this value will be passed as format alongside datum.value to the config.numberFormatType function.

numberFormatTypestring

Custom format type for config.numberFormat.

Default value: undefined – This is equilvalent to call D3-format, which is exposed as format in Vega-Expression. Note: You must also set customFormatTypes to true to use this feature.

paddinganyOf(Padding, ExprRef)

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

paramsList(TopLevelParameter)

Dynamic variables or selections that parameterize a visualization.

pointMarkConfig

Point-Specific Config

projectionProjectionConfig

Projection configuration, which determines default properties for all projections. For a full list of projection configuration options, please see the corresponding section of the projection documentation.

rangeRangeConfig

An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the corresponding section of the scale documentation.

rectRectConfig

Rect-Specific Config

ruleMarkConfig

Rule-Specific Config

scaleScaleConfig

Scale configuration determines default properties for all scales. For a full list of scale configuration options, please see the corresponding section of the scale documentation.

selectionSelectionConfig

An object hash for defining default properties for each type of selections.

squareMarkConfig

Square-Specific Config

styleStyleConfigIndex

An object hash that defines key-value mappings to determine default properties for marks with a given style. The keys represent styles names; the values have to be valid mark configuration objects.

textMarkConfig

Text-Specific Config

tickTickConfig

Tick-Specific Config

timeFormatstring

Default time format for raw time values (without time units) in text marks, legend labels and header labels.

Default value: "%b %d, %Y" Note: Axes automatically determine the format for each label automatically so this config does not affect axes.

timeFormatTypestring

Custom format type for config.timeFormat.

Default value: undefined – This is equilvalent to call D3-time-format, which is exposed as timeFormat in Vega-Expression. Note: You must also set customFormatTypes to true and there must not be a timeUnit defined to use this feature.

titleTitleConfig

Title configuration, which determines default properties for all titles. For a full list of title configuration options, please see the corresponding section of the title documentation.

trailLineConfig

Trail-Specific Config

viewViewConfig

Default properties for single view plots.

__init__(arc=Undefined, area=Undefined, aria=Undefined, autosize=Undefined, axis=Undefined, axisBand=Undefined, axisBottom=Undefined, axisDiscrete=Undefined, axisLeft=Undefined, axisPoint=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTemporal=Undefined, axisTop=Undefined, axisX=Undefined, axisXBand=Undefined, axisXDiscrete=Undefined, axisXPoint=Undefined, axisXQuantitative=Undefined, axisXTemporal=Undefined, axisY=Undefined, axisYBand=Undefined, axisYDiscrete=Undefined, axisYPoint=Undefined, axisYQuantitative=Undefined, axisYTemporal=Undefined, background=Undefined, bar=Undefined, boxplot=Undefined, circle=Undefined, concat=Undefined, countTitle=Undefined, customFormatTypes=Undefined, errorband=Undefined, errorbar=Undefined, facet=Undefined, fieldTitle=Undefined, font=Undefined, geoshape=Undefined, header=Undefined, headerColumn=Undefined, headerFacet=Undefined, headerRow=Undefined, image=Undefined, legend=Undefined, line=Undefined, lineBreak=Undefined, locale=Undefined, mark=Undefined, normalizedNumberFormat=Undefined, normalizedNumberFormatType=Undefined, numberFormat=Undefined, numberFormatType=Undefined, padding=Undefined, params=Undefined, point=Undefined, projection=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, selection=Undefined, square=Undefined, style=Undefined, text=Undefined, tick=Undefined, timeFormat=Undefined, timeFormatType=Undefined, title=Undefined, trail=Undefined, view=Undefined, **kwds)#

Methods

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

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