altair API reference

228 public APIs from altair (vega/altair) — 97 classes, 55 functions, 76 methods. Signatures extracted by static analysis of the actual source.

Repository: vega/altair

Kind	Count
Classes	97
Functions	55
Methods	76

API list

classaltair.datasets._cache.CsvCache

`csv`_, `gzip`_ -based, lazy metadata lookup.

methodaltair.datasets._cache.CsvCache.rotated() -> Mapping[str, Sequence[Any]]

Columnar view.

classaltair.datasets._cache.DatasetCache

Opt-out caching of remote dataset requests.

methodaltair.datasets._cache.DatasetCache.clear() -> None

Delete all previously cached datasets.

methodaltair.datasets._cache.DatasetCache.download_all() -> None

Download any missing datasets for latest version.

methodaltair.datasets._cache.DatasetCache.is_empty() -> bool

Cache is active, but no files are stored in ``self.path``.

methodaltair.datasets._cache.DatasetCache.path() -> Path

Returns path to datasets cache.

classaltair.datasets._cache.SchemaCache

`json`_, `gzip`_ -based, lazy schema lookup.

methodaltair.datasets._cache.SchemaCache.by_dtype(name:_Dataset, *dtypes:type[DType]) -> list[str]

Return column names specified in ``name``'s schema.

methodaltair.datasets._loader.Loader.cache() -> DatasetCache

Caching of remote dataset requests.

methodaltair.datasets._loader.Loader.url(name:Dataset | LiteralString, suffix:Extension | None=None) -> str

Return the address of a remote dataset.

classaltair.datasets._reader.Reader

Modular file reader, targeting remote & local tabular resources.

classaltair.datasets._readimpl.BaseImpl

A function wrapped with dataset support constraints.

methodaltair.datasets._readimpl.BaseImpl.unwrap_or_skip(meta:Items) -> Callable[..., R] | type[AltairDatasetsError] | Skip

Indicate an action to take for a dataset.

classaltair.datasets._readimpl.Skip

Falsy sentinel.

classaltair.datasets._typing.Metadata

Full schema for ``metadata.parquet``.

funcaltair.datasets.url(name:Dataset | LiteralString, suffix:Extension | None=None) -> str

Return the address of a remote dataset.

classaltair.expr.core.DatumType

An object to assist in building Vega-Lite Expressions.

classaltair.expr.core.Expression

Expression.

classaltair.jupyter.jupyter_chart.Params

Traitlet class storing a JupyterChart's params.

classaltair.jupyter.jupyter_chart.Selections

Traitlet class storing a JupyterChart's selections.

funcaltair.jupyter.jupyter_chart.collect_transform_params(chart:TopLevelSpec) -> set[str]

Collect the names of params that are defined by transforms.

funcaltair.theme.register(name:LiteralString, *enable:bool) -> Callable[[Plugin[ThemeConfig]], Plugin[ThemeConfig]]

Decorator for registering a theme function.

funcaltair.theme.unregister(name:LiteralString) -> Plugin[ThemeConfig]

Remove and return a previously registered theme.

methodaltair.utils._dfi_types.Column.describe_categorical() -> Any

If the dtype is categorical, there are two options.

methodaltair.utils._dfi_types.DataFrame.column_names() -> Iterable[str]

Return an iterator yielding the column names.

methodaltair.utils._dfi_types.DataFrame.get_chunks(n_chunks:int | None=None) -> Iterable[DataFrame]

Return an iterator yielding the chunks.

methodaltair.utils._dfi_types.DataFrame.get_column_by_name(name:str) -> Column

Return the column whose name is the indicated name.

classaltair.utils._dfi_types.DtypeKind

Integer enum for data types.

funcaltair.utils._transformed_data.get_facet_mapping(group:dict[str, Any], scope:Scope=()) -> FacetMapping

Create mapping from facet definitions to source datasets.

func

altair.utils._transformed_data.get_from_facet_mapping(scoped_dataset:tuple[str, Scope], facet_mapping:FacetMapping) -> tuple[str, Scope]

Apply facet mapping to a scoped dataset.

funcaltair.utils._transformed_data.get_group_mark_for_scope(vega_spec:dict[str, Any], scope:Scope) -> dict[str, Any] | None

Get the group mark at a particular scope.

funcaltair.utils._transformed_data.name_views(chart:ChartType, i:int=0, exclude:Iterable[str] | None=None) -> list[str]

Name unnamed chart views.

func

altair.utils._vegafusion_data.compile_to_vegafusion_chart_state(vegalite_spec:dict[str, Any], local_tz:str) -> ChartState

Compile a Vega-Lite spec to a VegaFusion ChartState.

funcaltair.utils._vegafusion_data.get_inline_table_names(vega_spec:dict[str, Any]) -> set[str]

Get a set of the inline datasets names in the provided Vega spec.

funcaltair.utils._vegafusion_data.get_inline_tables(vega_spec:dict[str, Any]) -> dict[str, DataFrameLike]

Get the inline tables referenced by a Vega specification.

funcaltair.utils._vegafusion_data.using_vegafusion() -> bool

Check whether the vegafusion data transformer is enabled.

funcaltair.utils.core.merge_props_geom(feat:dict[str, Any]) -> dict[str, Any]

Merge properties with geometry.

funcaltair.utils.core.sanitize_geo_interface(geo:MutableMapping[Any, Any]) -> dict[str, Any]

Sanitize a geo_interface to prepare it for serialization.

funcaltair.utils.core.sanitize_narwhals_dataframe(data:nw.DataFrame[TIntoDataFrame]) -> nw.DataFrame[TIntoDataFrame]

Sanitize narwhals.DataFrame for JSON serialization.

funcaltair.utils.core.sanitize_pandas_dataframe(df:_PandasDataFrameT) -> _PandasDataFrameT

Sanitize a DataFrame to prepare it for serialization.

funcaltair.utils.core.to_eager_narwhals_dataframe(data:IntoDataFrame) -> nw.DataFrame[Any]

Wrap `data` in `narwhals.DataFrame`.

funcaltair.utils.core.use_signature(tp:Callable[P, Any]) -> _MethodSignatureCopier[P]

Use the signature and doc of ``tp`` for the decorated method ``cb``.

funcaltair.utils.core.use_signature_func(tp:Callable[P, Any]) -> _FunctionSignatureCopier[P]

Use the signature and doc of ``tp`` for the decorated function ``cb``.

classaltair.utils.data.MaxRowsError

Raised when a data model has too many rows.

funcaltair.utils.data.to_values(data:DataType) -> ToValuesReturnType

Replace a DataFrame by a data model with values.

classaltair.utils.display.Displayable

A base display class for VegaLite v1/v2.

funcaltair.utils.display.json_renderer_base(spec:dict[str, Any], str_repr:str, **options) -> DefaultRendererReturnType

A renderer that returns a MIME type of application/json.

funcaltair.utils.mimebundle.preprocess_embed_options(embed_options:dict) -> dict

Preprocess embed options to a form compatible with Vega Embed.

classaltair.utils.plugin_registry.PluginEnabler

Context manager for enabling plugins.

classaltair.utils.plugin_registry.PluginRegistry

A registry for plugins.

methodaltair.utils.plugin_registry.PluginRegistry.active() -> str

Return the name of the currently active plugin.

methodaltair.utils.plugin_registry.PluginRegistry.enable(name:str | None=None, **options:Any) -> PluginEnabler[PluginT, R]

Enable a plugin by name.

methodaltair.utils.plugin_registry.PluginRegistry.get() -> partial[R] | Plugin[R] | None

Return the currently active plugin.

methodaltair.utils.plugin_registry.PluginRegistry.options() -> dict[str, Any]

Return the current options dictionary.

methodaltair.utils.plugin_registry.PluginRegistry.register(name:str, value:PluginT | None) -> PluginT | None

funcaltair.utils.save.set_inspect_format_argument(format:str | None, fp:str | Path | IO[Any], inline:bool) -> str

Inspect the format argument in the save function.

classaltair.utils.schemapi.ConditionLike

Represents the wrapped state of a conditional encoding or property.

classaltair.utils.schemapi.SchemaBase

Base class for schema wrappers.

methodaltair.utils.schemapi.SchemaBase.copy(deep:bool | Iterable[Any]=True, ignore:list[str] | None=None) -> Self

Return a copy of the object.

methodaltair.utils.schemapi.SchemaBase.from_dict(dct:dict[str, Any], validate:bool=True) -> TSchemaBase

Construct class from a dictionary representation.

methodaltair.utils.schemapi.SchemaBase.from_json(json_string:str, validate:bool=True, **kwargs:Any) -> ChartType

Instantiate the object from a valid JSON string.

method

altair.utils.schemapi.SchemaBase.to_dict(validate:bool=True, *ignore:list[str] | None=None, *context:dict[str, Any] | None=None) -> dict[str, Any]

Return a dictionary representation of the object.

classaltair.utils.schemapi.UndefinedType

A singleton object for marking undefined parameters.

funcaltair.utils.schemapi.is_undefined(obj:Any) -> TypeIs[UndefinedType]

Type-safe singleton check for `UndefinedType`.

funcaltair.utils.schemapi.with_property_setters(cls:type[TSchemaBase]) -> type[TSchemaBase]

Decorator to add property setters to a Schema class.

classaltair.utils.selection.IntervalSelection

Represents the state of an alt.selection_interval().

classaltair.vegalite.v6.api.ChainedWhen

Utility class for ``when-then-otherwise`` conditions.

methodaltair.vegalite.v6.api.ChainedWhen.then(statement:_StatementType, **kwds:Any) -> Then[_Conditions]

Attach a statement to this predicate.

classaltair.vegalite.v6.api.Chart

Create a basic Altair/Vega-Lite chart.

methodaltair.vegalite.v6.api.Chart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.Chart.add_selection(*params) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.Chart.from_dict(dct:dict[str, Any], validate:bool=True) -> _TSchemaBase

Construct a ``Chart`` from a dictionary representation.

methodaltair.vegalite.v6.api.Chart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.Chart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> DataFrameLike | None

Evaluate a Chart's transforms.

classaltair.vegalite.v6.api.ConcatChart

A chart with horizontally-concatenated facets.

methodaltair.vegalite.v6.api.ConcatChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.ConcatChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.ConcatChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.ConcatChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> list[DataFrameLike]

Evaluate a ConcatChart's transforms.

classaltair.vegalite.v6.api.FacetChart

A Chart with layers within a single panel.

methodaltair.vegalite.v6.api.FacetChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.FacetChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.FacetChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.FacetChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> DataFrameLike | None

Evaluate a FacetChart's transforms.

classaltair.vegalite.v6.api.FacetMapping

FacetMapping schema wrapper.

classaltair.vegalite.v6.api.HConcatChart

A chart with horizontally-concatenated facets.

methodaltair.vegalite.v6.api.HConcatChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.HConcatChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.HConcatChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.HConcatChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> list[DataFrameLike]

Evaluate an HConcatChart's transforms.

classaltair.vegalite.v6.api.LayerChart

A Chart with layers within a single panel.

methodaltair.vegalite.v6.api.LayerChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.LayerChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.LayerChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.LayerChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> list[DataFrameLike]

Evaluate a LayerChart's transforms.

classaltair.vegalite.v6.api.Parameter

A Parameter object.

methodaltair.vegalite.v6.api.Parameter.ref() -> dict[str, Any]

'ref' is deprecated.

classaltair.vegalite.v6.api.RepeatChart

A chart repeated across rows and columns with small changes.

methodaltair.vegalite.v6.api.RepeatChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.RepeatChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.RepeatChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.RepeatChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> DataFrameLike | None

Evaluate a RepeatChart's transforms.

classaltair.vegalite.v6.api.Then

Utility class for ``when-then-otherwise`` conditions.

classaltair.vegalite.v6.api.TopLevelMixin

Mixin for top-level chart objects such as Chart, LayeredChart, etc.

methodaltair.vegalite.v6.api.TopLevelMixin.properties(**kwargs:Any) -> Self

Set top-level properties of the Chart.

method

altair.vegalite.v6.api.TopLevelMixin.serve(ip='127.0.0.1', port=8888, n_retries=50, files=None, jupyter_warning=True, open_browser=True, http_server=None, **kwargs) -> None

'serve' is deprecated.

methodaltair.vegalite.v6.api.TopLevelMixin.show() -> None

Display the chart using the active renderer.

methodaltair.vegalite.v6.api.TopLevelMixin.transform_extent(extent:str | FieldName, param:str | ParameterName) -> Self

Add a :class:`ExtentTransform` to the spec.

method

altair.vegalite.v6.api.TopLevelMixin.transform_flatten(flatten:list[str | FieldName], as_:Optional[list[str | FieldName]]=Undefined) -> Self

Add a :class:`FlattenTransform` to the schema.

method

altair.vegalite.v6.api.TopLevelMixin.transform_fold(fold:list[str | FieldName], as_:Optional[list[str | FieldName]]=Undefined) -> Self

Add a :class:`FoldTransform` to the spec.

methodaltair.vegalite.v6.api.TopLevelMixin.transform_sample(sample:int=1000) -> Self

Add a :class:`SampleTransform` to the schema.

classaltair.vegalite.v6.api.VConcatChart

A chart with vertically-concatenated facets.

methodaltair.vegalite.v6.api.VConcatChart.add_params(*params:Parameter) -> Self

Add one or more parameters to the chart.

methodaltair.vegalite.v6.api.VConcatChart.add_selection(*selections) -> Self

'add_selection' is deprecated.

methodaltair.vegalite.v6.api.VConcatChart.interactive(name:str | None=None, bind_x:bool=True, bind_y:bool=True) -> Self

Make chart axes scales interactive.

method

altair.vegalite.v6.api.VConcatChart.transformed_data(row_limit:int | None=None, exclude:Iterable[str] | None=None) -> list[DataFrameLike]

Evaluate a VConcatChart's transforms.

classaltair.vegalite.v6.api.When

Utility class for ``when-then-otherwise`` conditions.

func

altair.vegalite.v6.api.binding(input:str, *autocomplete:Optional[str]=Undefined, *debounce:Optional[float]=Undefined, *element:Optional[str]=Undefined, *name:Optional[str]=Undefined, *placeholder:Optional[str]=Undefined) -> BindInput

A generic binding.

funcaltair.vegalite.v6.api.binding_checkbox(**kwargs:Any) -> BindCheckbox

A checkbox binding.

funcaltair.vegalite.v6.api.binding_radio(**kwargs:Any) -> BindRadioSelect

A radio button binding.

funcaltair.vegalite.v6.api.binding_range(**kwargs:Any) -> BindRange

A range binding.

funcaltair.vegalite.v6.api.binding_select(**kwargs:Any) -> BindRadioSelect

A select binding.

funcaltair.vegalite.v6.api.concat(*charts:ConcatType, **kwargs:Any) -> ConcatChart

Concatenate charts horizontally.

funcaltair.vegalite.v6.api.graticule(**kwds:Any) -> GraticuleGenerator

Graticule generator.

funcaltair.vegalite.v6.api.hconcat(*charts:ConcatType, **kwargs:Any) -> HConcatChart

Concatenate charts horizontally.

funcaltair.vegalite.v6.api.is_chart_type(obj:Any) -> TypeIs[ChartType]

Return `True` if the object is an Altair chart.

funcaltair.vegalite.v6.api.layer(*charts:LayerType, **kwargs:Any) -> LayerChart | FacetChart

Layer multiple charts.

funcaltair.vegalite.v6.api.repeat(repeater:Literal['row', 'column', 'repeat', 'layer']='repeat') -> RepeatRef

Tie a channel to the row or column within a repeated chart.

funcaltair.vegalite.v6.api.selection_multi(**kwargs:Any) -> Parameter

'selection_multi' is deprecated.

funcaltair.vegalite.v6.api.selection_single(**kwargs:Any) -> Parameter

'selection_single' is deprecated.

func

altair.vegalite.v6.api.sequence(start:Optional[float], stop:Optional[float | None]=None, step:Optional[float]=Undefined, as_:Optional[str]=Undefined, **kwds:Any) -> SequenceGenerator

Sequence generator.

funcaltair.vegalite.v6.api.sphere() -> SphereGenerator

Sphere generator.

funcaltair.vegalite.v6.api.value(value:Any, **kwargs:Any) -> _Value

Specify a value for use in an encoding.

funcaltair.vegalite.v6.api.vconcat(*charts:ConcatType, **kwargs:Any) -> VConcatChart

Concatenate charts vertically.

funcaltair.vegalite.v6.compiler.vl_convert_compiler(vegalite_spec:dict) -> dict

Vega-Lite to Vega compiler that uses vl-convert.

classaltair.vegalite.v6.display.VegaLite

An IPython/Jupyter display class for rendering VegaLite 6.

funcaltair.vegalite.v6.display.vegalite(spec:dict, validate:bool=True) -> None

Render and optionally validate a VegaLite 6 spec.

classaltair.vegalite.v6.schema._config.AreaConfigKwds

:class:`altair.AreaConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.AutoSizeParamsKwds

:class:`altair.AutoSizeParams` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.AxisConfigKwds

:class:`altair.AxisConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.AxisResolveMapKwds

:class:`altair.AxisResolveMap` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BarConfigKwds

:class:`altair.BarConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BindCheckboxKwds

:class:`altair.BindCheckbox` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BindDirectKwds

:class:`altair.BindDirect` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BindInputKwds

:class:`altair.BindInput` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BindRadioSelectKwds

:class:`altair.BindRadioSelect` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BindRangeKwds

:class:`altair.BindRange` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BoxPlotConfigKwds

:class:`altair.BoxPlotConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.BrushConfigKwds

:class:`altair.BrushConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ConfigKwds

:class:`altair.Config` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.DateTimeKwds

:class:`altair.DateTime` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.DerivedStreamKwds

:class:`altair.DerivedStream` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ErrorBandConfigKwds

:class:`altair.ErrorBandConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ErrorBarConfigKwds

:class:`altair.ErrorBarConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.FormatConfigKwds

:class:`altair.FormatConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.GeoJsonFeatureKwds

:class:`altair.GeoJsonFeature` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.GradientStopKwds

:class:`altair.GradientStop` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.HeaderConfigKwds

:class:`altair.HeaderConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LegendConfigKwds

:class:`altair.LegendConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LegendResolveMapKwds

:class:`altair.LegendResolveMap` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LineConfigKwds

:class:`altair.LineConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LineStringKwds

:class:`altair.LineString` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LinearGradientKwds

:class:`altair.LinearGradient` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.LocaleKwds

:class:`altair.Locale` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.MarkConfigKwds

:class:`altair.MarkConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.MergedStreamKwds

:class:`altair.MergedStream` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.MultiLineStringKwds

:class:`altair.MultiLineString` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.MultiPointKwds

:class:`altair.MultiPoint` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.MultiPolygonKwds

:class:`altair.MultiPolygon` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.NumberLocaleKwds

:class:`altair.NumberLocale` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.OverlayMarkDefKwds

:class:`altair.OverlayMarkDef` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.PointKwds

:class:`altair.Point` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.PolygonKwds

:class:`altair.Polygon` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ProjectionConfigKwds

:class:`altair.ProjectionConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ProjectionKwds

:class:`altair.Projection` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.RadialGradientKwds

:class:`altair.RadialGradient` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.RangeConfigKwds

:class:`altair.RangeConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.RectConfigKwds

:class:`altair.RectConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ResolveKwds

:class:`altair.Resolve` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ScaleConfigKwds

:class:`altair.ScaleConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ScaleResolveMapKwds

:class:`altair.ScaleResolveMap` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.SelectionConfigKwds

:class:`altair.SelectionConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.StepKwds

:class:`altair.Step` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.StyleConfigIndexKwds

:class:`altair.StyleConfigIndex` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TickConfigKwds

:class:`altair.TickConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TimeIntervalStepKwds

:class:`altair.TimeIntervalStep` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TimeLocaleKwds

:class:`altair.TimeLocale` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TitleConfigKwds

:class:`altair.TitleConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TitleParamsKwds

:class:`altair.TitleParams` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.TooltipContentKwds

:class:`altair.TooltipContent` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ViewBackgroundKwds

:class:`altair.ViewBackground` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._config.ViewConfigKwds

:class:`altair.ViewConfig` ``TypedDict`` wrapper.

classaltair.vegalite.v6.schema._typing.RowColKwds

A `Generic`_ two-item ``dict``.

classaltair.vegalite.v6.schema._typing.Value

A `Generic`_ single item ``dict``.

funcaltair.vegalite.v6.schema._typing.is_color_hex(obj:Any) -> TypeIs[ColorHex]

Return ``True`` if the object is a hexadecimal color code.

classaltair.vegalite.v6.schema.mixins.ConfigMethodMixin

A mixin class that defines config methods.

classaltair.vegalite.v6.schema.mixins.MarkMethodMixin

A mixin class that defines mark methods.

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_arc(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_area(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_bar(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_boxplot(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_circle(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_errorbar(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_geoshape(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_image(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_line(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_point(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_rect(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_rule(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_square(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_text(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_tick(**kwds:Any) -> Self

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

methodaltair.vegalite.v6.schema.mixins.MarkMethodMixin.mark_trail(**kwds:Any) -> Self

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

classaltair.vegalite.v6.theme.VegaTheme

Implementation of a builtin vega theme.

funcsphinxext.altairgallery.populate_examples(**kwds:Any) -> list[dict[str, Any]]

Iterate through Altair examples and extract code.

func

sphinxext.altairgallery.save_example_pngs(examples:list[dict[str, Any]], image_dir:Path, make_thumbnails:bool=True) -> None

Save example pngs and (optionally) thumbnails.

classsphinxext.code_ref.PyScriptDirective

Placeholder for non-theme related directive.

classsphinxext.code_ref.ThemeDirective

Theme preview directive.

classsphinxext.schematable.AltairObjectTableDirective

Directive for building a table of attribute descriptions.

funcsphinxext.schematable.add_class_def(node:nodes.paragraph, classDef:str) -> nodes.paragraph

Add reference on classDef to node.

funcsphinxext.schematable.add_text(node:nodes.paragraph, text:str) -> nodes.paragraph

Add text with inline code to node.

funcsphinxext.schematable.build_row(item:tuple[str, dict[str, Any]], rootschema:dict[str, Any] | None) -> nodes.row

Return nodes.row with property description.

func

sphinxext.schematable.prepare_table_header(titles:Sequence[str], widths:Sequence[float]) -> tuple[nodes.table, nodes.tbody]

Build docutil empty table.

funcsphinxext.schematable.type_description(schema:dict[str, Any]) -> str

Return a concise type description for the given schema.

funcsphinxext.utils.create_generic_image(filename:Path, shape:tuple[float, float]=(200, 300), gradient:bool=True) -> None

Create a generic image.

funcsphinxext.utils.dict_hash(dct:dict[Any, Any]) -> Any

Return a hash of the contents of a dictionary.

funcsphinxext.utils.get_docstring_and_rest(filename:str | Path) -> tuple[str, str | None, str, int, bool]

Separate ``filename`` content between docstring and the rest.

About this data

These signatures were extracted from the public source of vega/altair using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries