diff --git a/README.md b/README.md index baf460408..3ca11f1a3 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ points = alt.Chart(source).mark_point().encode( x='Horsepower', y='Miles_per_Gallon', color=alt.condition(brush, 'Origin', alt.value('lightgray')) -).add_selection( +).add_params( brush ) @@ -211,23 +211,8 @@ visualization. ## Development install -Vega-Altair requires the following dependencies: - -* [pandas](https://pandas.pydata.org/) -* [traitlets](https://github.com/ipython/traitlets) -* [IPython](https://github.com/ipython/ipython) - -If you have cloned the repository, run the following command from the root of the repository: - -``` -pip install -e .[dev] -``` - -If you do not wish to clone the repository, you can install using: - -``` -pip install git+https://github.com/altair-viz/altair -``` +Instructions on how to install Vega-Altair for development can be found in +[the documentation](https://altair-viz.github.io/getting_started/installation.html). ## Testing diff --git a/altair/examples/us_population_over_time.py b/altair/examples/us_population_over_time.py index 52e5290a0..db7403663 100644 --- a/altair/examples/us_population_over_time.py +++ b/altair/examples/us_population_over_time.py @@ -15,7 +15,7 @@ name="Year", fields=["year"], bind=alt.binding_range(min=1900, max=2000, step=10, name="Year"), - init={"year": 2000}, + value={"year": 2000}, ) alt.Chart(source).mark_bar().encode( diff --git a/altair/sphinxext/altairgallery.py b/altair/sphinxext/altairgallery.py index eae1a3247..06e2e1b32 100644 --- a/altair/sphinxext/altairgallery.py +++ b/altair/sphinxext/altairgallery.py @@ -97,6 +97,7 @@ EXAMPLE_TEMPLATE = jinja2.Template( """ +:orphan: :html_theme.sidebar_secondary.remove: .. This document is auto-generated by the altair-gallery extension. Do not modify directly. diff --git a/altair/sphinxext/schematable.py b/altair/sphinxext/schematable.py index 5892604c2..decedaae7 100644 --- a/altair/sphinxext/schematable.py +++ b/altair/sphinxext/schematable.py @@ -1,13 +1,18 @@ import importlib import re +import sys import warnings +from os.path import abspath, dirname -from docutils import nodes, utils +from docutils import nodes, utils, frontend from docutils.parsers.rst import Directive from docutils.parsers.rst.directives import flag -from recommonmark.parser import CommonMarkParser +from myst_parser.docutils_ import Parser from sphinx import addnodes +sys.path.insert(0, abspath(dirname(dirname(dirname(__file__))))) +from tools.schemapi.utils import fix_docstring_issues # noqa: E402 + def type_description(schema): """Return a concise type description for the given schema""" @@ -121,11 +126,14 @@ def build_row(item): row += nodes.entry("", par_type, classes=["vl-type-def"]) # Description - md_parser = CommonMarkParser() + md_parser = Parser() # str_descr = "***Required.*** " if required else "" str_descr = "" str_descr += propschema.get("description", " ") - doc_descr = utils.new_document("schema_description") + str_descr = fix_docstring_issues(str_descr) + document_settings = frontend.get_default_settings() + document_settings.setdefault("raw_enabled", True) + doc_descr = utils.new_document("schema_description", document_settings) md_parser.parse(str_descr, doc_descr) # row += nodes.entry('', *doc_descr.children, classes="vl-decsr") diff --git a/altair/vega/v5/schema/core.py b/altair/vega/v5/schema/core.py index 5ab5104f2..29714f972 100644 --- a/altair/vega/v5/schema/core.py +++ b/altair/vega/v5/schema/core.py @@ -107,8 +107,7 @@ class axis(VegaSchema): labelAngle : oneOf(float, :class:`numberValue`) - labelBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic', 'line-top', - 'line-bottom'), :class:`baselineValue`) + labelBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic', 'line-top', 'line-bottom'), :class:`baselineValue`) labelBound : oneOf(boolean, float, :class:`signalRef`) @@ -124,9 +123,7 @@ class axis(VegaSchema): labelFontStyle : oneOf(string, :class:`stringValue`) - labelFontWeight : oneOf(enum(None, 'normal', 'bold', 'lighter', 'bolder', '100', '200', - '300', '400', '500', '600', '700', '800', '900', 100, 200, 300, 400, 500, 600, 700, 800, - 900), :class:`fontWeightValue`) + labelFontWeight : oneOf(enum(None, 'normal', 'bold', 'lighter', 'bolder', '100', '200', '300', '400', '500', '600', '700', '800', '900', 100, 200, 300, 400, 500, 600, 700, 800, 900), :class:`fontWeightValue`) labelLimit : oneOf(float, :class:`numberValue`) @@ -188,8 +185,7 @@ class axis(VegaSchema): titleAngle : oneOf(float, :class:`numberValue`) - titleBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic', 'line-top', - 'line-bottom'), :class:`baselineValue`) + titleBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic', 'line-top', 'line-bottom'), :class:`baselineValue`) titleColor : oneOf(None, string, :class:`colorValue`) @@ -199,9 +195,7 @@ class axis(VegaSchema): titleFontStyle : oneOf(string, :class:`stringValue`) - titleFontWeight : oneOf(enum(None, 'normal', 'bold', 'lighter', 'bolder', '100', '200', - '300', '400', '500', '600', '700', '800', '900', 100, 200, 300, 400, 500, 600, 700, 800, - 900), :class:`fontWeightValue`) + titleFontWeight : oneOf(enum(None, 'normal', 'bold', 'lighter', 'bolder', '100', '200', '300', '400', '500', '600', '700', '800', '900', 100, 200, 300, 400, 500, 600, 700, 800, 900), :class:`fontWeightValue`) titleLimit : oneOf(float, :class:`numberValue`) @@ -1268,8 +1262,7 @@ class facet(VegaSchema): Attributes ---------- - facet : oneOf(Mapping(required=[name, data, field]), Mapping(required=[name, data, - groupby])) + facet : oneOf(Mapping(required=[name, data, field]), Mapping(required=[name, data, groupby])) data : string @@ -1465,11 +1458,9 @@ class projection(VegaSchema): clipAngle : :class:`numberOrSignal` - clipExtent : oneOf(List(oneOf(List(:class:`numberOrSignal`), :class:`signalRef`)), - :class:`signalRef`) + clipExtent : oneOf(List(oneOf(List(:class:`numberOrSignal`), :class:`signalRef`)), :class:`signalRef`) - extent : oneOf(List(oneOf(List(:class:`numberOrSignal`), :class:`signalRef`)), - :class:`signalRef`) + extent : oneOf(List(oneOf(List(:class:`numberOrSignal`), :class:`signalRef`)), :class:`signalRef`) fit : oneOf(Mapping(required=[]), List(Any)) @@ -1803,8 +1794,7 @@ class crossfilterTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) query : oneOf(List(Any), :class:`signalRef`) @@ -1926,8 +1916,7 @@ class stackTransform(VegaSchema): field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) offset : anyOf(enum('zero', 'center', 'normalize'), :class:`signalRef`) @@ -1962,9 +1951,7 @@ class forceTransform(VegaSchema): alphaTarget : anyOf(float, :class:`signalRef`) - forces : List(oneOf(Mapping(required=[force]), Mapping(required=[force]), - Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), - Mapping(required=[force]))) + forces : List(oneOf(Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]))) iterations : anyOf(float, :class:`signalRef`) @@ -2047,8 +2034,7 @@ class geojsonTransform(VegaSchema): type : enum('geojson') - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) geojson : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) @@ -2099,8 +2085,7 @@ class geopointTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) projection : string @@ -2242,8 +2227,7 @@ class isocontourTransform(VegaSchema): thresholds : oneOf(List(anyOf(float, :class:`signalRef`)), :class:`signalRef`) - translate : oneOf(List(anyOf(float, :class:`signalRef`, :class:`expr`, - :class:`paramField`)), :class:`signalRef`) + translate : oneOf(List(anyOf(float, :class:`signalRef`, :class:`expr`, :class:`paramField`)), :class:`signalRef`) zero : anyOf(boolean, :class:`signalRef`) @@ -2283,8 +2267,7 @@ class kde2dTransform(VegaSchema): counts : anyOf(boolean, :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) signal : string @@ -2315,8 +2298,7 @@ class nestTransform(VegaSchema): generate : anyOf(boolean, :class:`signalRef`) - keys : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + keys : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) signal : string @@ -2485,8 +2467,7 @@ class treemapTransform(VegaSchema): field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - method : anyOf(enum('squarify', 'resquarify', 'binary', 'dice', 'slice', 'slicedice'), - :class:`signalRef`) + method : anyOf(enum('squarify', 'resquarify', 'binary', 'dice', 'slice', 'slicedice'), :class:`signalRef`) padding : anyOf(float, :class:`signalRef`) @@ -2592,8 +2573,7 @@ class loessTransform(VegaSchema): bandwidth : anyOf(float, :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) signal : string @@ -2624,8 +2604,7 @@ class regressionTransform(VegaSchema): extent : oneOf(List(anyOf(float, :class:`signalRef`)), :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) method : anyOf(string, :class:`signalRef`) @@ -2661,18 +2640,13 @@ class aggregateTransform(VegaSchema): drop : anyOf(boolean, :class:`signalRef`) - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', - 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', - 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), - :class:`signalRef`)), :class:`signalRef`) + ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`)), :class:`signalRef`) signal : string @@ -2826,9 +2800,7 @@ class densityTransform(VegaSchema): type : enum('density') - distribution : oneOf(Mapping(required=[function]), Mapping(required=[function]), - Mapping(required=[function]), Mapping(required=[function, field]), - Mapping(required=[function])) + distribution : oneOf(Mapping(required=[function]), Mapping(required=[function]), Mapping(required=[function]), Mapping(required=[function, field]), Mapping(required=[function])) extent : oneOf(List(anyOf(float, :class:`signalRef`)), :class:`signalRef`) @@ -2866,8 +2838,7 @@ class dotbinTransform(VegaSchema): type : enum('dotbin') - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) signal : string @@ -2936,8 +2907,7 @@ class flattenTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) type : enum('flatten') @@ -2963,8 +2933,7 @@ class foldTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) type : enum('fold') @@ -3019,8 +2988,7 @@ class imputeTransform(VegaSchema): type : enum('impute') - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) keyvals : oneOf(List(Any), :class:`signalRef`) @@ -3050,18 +3018,13 @@ class joinaggregateTransform(VegaSchema): type : enum('joinaggregate') - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', - 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', - 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), - :class:`signalRef`)), :class:`signalRef`) + ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`)), :class:`signalRef`) signal : string @@ -3096,8 +3059,7 @@ class kdeTransform(VegaSchema): extent : oneOf(List(anyOf(float, :class:`signalRef`)), :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) maxsteps : anyOf(float, :class:`signalRef`) @@ -3131,8 +3093,7 @@ class lookupTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) @@ -3142,8 +3103,7 @@ class lookupTransform(VegaSchema): signal : string - values : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + values : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) as : oneOf(List(anyOf(string, :class:`signalRef`)), :class:`signalRef`) @@ -3172,16 +3132,13 @@ class pivotTransform(VegaSchema): value : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) limit : anyOf(float, :class:`signalRef`) - op : anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', - 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', - 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`) + op : anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`) signal : string @@ -3204,8 +3161,7 @@ class projectTransform(VegaSchema): type : enum('project') - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) signal : string @@ -3230,8 +3186,7 @@ class quantileTransform(VegaSchema): type : enum('quantile') - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) probs : oneOf(List(anyOf(float, :class:`signalRef`)), :class:`signalRef`) @@ -3324,9 +3279,7 @@ class timeunitTransform(VegaSchema): timezone : anyOf(enum('local', 'utc'), :class:`signalRef`) - units : oneOf(List(anyOf(enum('year', 'quarter', 'month', 'week', 'date', 'day', - 'dayofyear', 'hours', 'minutes', 'seconds', 'milliseconds'), :class:`signalRef`)), - :class:`signalRef`) + units : oneOf(List(anyOf(enum('year', 'quarter', 'month', 'week', 'date', 'day', 'dayofyear', 'hours', 'minutes', 'seconds', 'milliseconds'), :class:`signalRef`)), :class:`signalRef`) as : oneOf(List(anyOf(string, :class:`signalRef`)), :class:`signalRef`) @@ -3351,22 +3304,15 @@ class windowTransform(VegaSchema): type : enum('window') - fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), - :class:`signalRef`) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), :class:`signalRef`) frame : oneOf(List(anyOf(float, :class:`signalRef`, None)), :class:`signalRef`) - groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), - :class:`signalRef`) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), :class:`signalRef`) ignorePeers : anyOf(boolean, :class:`signalRef`) - ops : oneOf(List(anyOf(enum('row_number', 'rank', 'dense_rank', 'percent_rank', 'cume_dist', - 'ntile', 'lag', 'lead', 'first_value', 'last_value', 'nth_value', 'prev_value', - 'next_value', 'values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', 'mean', - 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', - 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`)), - :class:`signalRef`) + ops : oneOf(List(anyOf(enum('row_number', 'rank', 'dense_rank', 'percent_rank', 'cume_dist', 'ntile', 'lag', 'lead', 'first_value', 'last_value', 'nth_value', 'prev_value', 'next_value', 'values', 'count', '__count__', 'missing', 'valid', 'sum', 'product', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'min', 'max', 'argmin', 'argmax'), :class:`signalRef`)), :class:`signalRef`) params : oneOf(List(anyOf(float, :class:`signalRef`, None)), :class:`signalRef`) diff --git a/altair/vegalite/v3/api.py b/altair/vegalite/v3/api.py index 6473d41e6..7f681edd1 100644 --- a/altair/vegalite/v3/api.py +++ b/altair/vegalite/v3/api.py @@ -1641,7 +1641,7 @@ class Chart( 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` + layered views that don't use `rangeStep`. Default value: `pad` background : string CSS color property to use as the background of visualization. diff --git a/altair/vegalite/v3/schema/channels.py b/altair/vegalite/v3/schema/channels.py index 26432fa41..a5e101e4e 100644 --- a/altair/vegalite/v3/schema/channels.py +++ b/altair/vegalite/v3/schema/channels.py @@ -131,8 +131,7 @@ class Color(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -200,8 +199,9 @@ class Color(FieldChannelMixin, core.StringFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -299,8 +299,7 @@ class ColorValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -389,8 +388,9 @@ class Column(FieldChannelMixin, core.FacetFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -684,8 +684,9 @@ class Facet(FieldChannelMixin, core.FacetFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -810,8 +811,7 @@ class Fill(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -879,8 +879,9 @@ class Fill(FieldChannelMixin, core.StringFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -978,8 +979,7 @@ class FillValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -1032,8 +1032,7 @@ class FillOpacity(FieldChannelMixin, core.NumericFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -1101,8 +1100,9 @@ class FillOpacity(FieldChannelMixin, core.NumericFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -1200,8 +1200,7 @@ class FillOpacityValue(ValueChannelMixin, core.NumericValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -1394,8 +1393,7 @@ class HrefValue(ValueChannelMixin, core.TextValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, - List(:class:`ConditionalValueDef`)) + condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : :class:`Value` A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -2121,8 +2119,7 @@ class Opacity(FieldChannelMixin, core.NumericFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -2190,8 +2187,9 @@ class Opacity(FieldChannelMixin, core.NumericFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2289,8 +2287,7 @@ class OpacityValue(ValueChannelMixin, core.NumericValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -2533,8 +2530,9 @@ class Row(FieldChannelMixin, core.FacetFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2659,8 +2657,7 @@ class Shape(FieldChannelMixin, core.ShapeFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -2728,8 +2725,9 @@ class Shape(FieldChannelMixin, core.ShapeFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2827,8 +2825,7 @@ class ShapeValue(ValueChannelMixin, core.ShapeValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, - :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -2881,8 +2878,7 @@ class Size(FieldChannelMixin, core.NumericFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -2950,8 +2946,9 @@ class Size(FieldChannelMixin, core.NumericFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -3049,8 +3046,7 @@ class SizeValue(ValueChannelMixin, core.NumericValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -3103,8 +3099,7 @@ class Stroke(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -3172,8 +3167,9 @@ class Stroke(FieldChannelMixin, core.StringFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -3271,8 +3267,7 @@ class StrokeValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -3325,8 +3320,7 @@ class StrokeOpacity(FieldChannelMixin, core.NumericFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -3394,8 +3388,9 @@ class StrokeOpacity(FieldChannelMixin, core.NumericFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -3494,8 +3489,7 @@ class StrokeOpacityValue(ValueChannelMixin, core.NumericValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -3548,8 +3542,7 @@ class StrokeWidth(FieldChannelMixin, core.NumericFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -3617,8 +3610,9 @@ class StrokeWidth(FieldChannelMixin, core.NumericFieldDefWithCondition): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -3716,8 +3710,7 @@ class StrokeWidthValue(ValueChannelMixin, core.NumericValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -3910,8 +3903,7 @@ class TextValue(ValueChannelMixin, core.TextValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, - List(:class:`ConditionalValueDef`)) + condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : :class:`Value` A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -4104,8 +4096,7 @@ class TooltipValue(ValueChannelMixin, core.TextValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, - List(:class:`ConditionalValueDef`)) + condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : :class:`Value` A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -4227,8 +4218,9 @@ class X(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4255,8 +4247,8 @@ class X(FieldChannelMixin, core.PositionFieldDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -4830,8 +4822,9 @@ class Y(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4858,8 +4851,8 @@ class Y(FieldChannelMixin, core.PositionFieldDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. diff --git a/altair/vegalite/v3/schema/core.py b/altair/vegalite/v3/schema/core.py index 7c101a7cc..cd2fab010 100644 --- a/altair/vegalite/v3/schema/core.py +++ b/altair/vegalite/v3/schema/core.py @@ -2014,8 +2014,9 @@ class ConditionalPredicateMarkPropFieldDef(ConditionalMarkPropFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2205,8 +2206,9 @@ class ConditionalPredicateMarkPropFieldDefTypeForShape(ConditionalMarkPropFieldD `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2419,8 +2421,9 @@ class ConditionalSelectionMarkPropFieldDef(ConditionalMarkPropFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2612,8 +2615,9 @@ class ConditionalSelectionMarkPropFieldDefTypeForShape(ConditionalMarkPropFieldD `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -3571,8 +3575,7 @@ class Encoding(VegaLiteSchema): *Note:* When using ``fill`` channel, ``color`` channel will be ignored. To customize both fill and stroke, please use ``fill`` and ``stroke`` channels (not ``fill`` and ``color`` ). - fillOpacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + fillOpacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Fill opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config @@ -3595,8 +3598,7 @@ class Encoding(VegaLiteSchema): longitude2 : anyOf(:class:`SecondaryFieldDef`, :class:`NumberValueDef`) Longitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - opacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + opacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config @@ -3625,14 +3627,14 @@ class Encoding(VegaLiteSchema): * plotting shapes: ``"circle"``, ``"square"``, ``"cross"``, ``"diamond"``, - ``"triangle-up"``, ``"triangle-down"``, ``"triangle-right"``, or - ``"triangle-left"``. + ``"triangle-up"``, ``"triangle-down"``, ``"triangle-right"``, or + ``"triangle-left"``. * the line symbol ``"stroke"`` * centered directional shapes ``"arrow"``, ``"wedge"``, or ``"triangle"`` * a custom `SVG path string - `__ (For correct - sizing, custom shape paths should be defined within a square bounding box with - coordinates ranging from -1 to 1 along both the x and y dimensions.) + `__ (For correct + sizing, custom shape paths should be defined within a square bounding box with + coordinates ranging from -1 to 1 along both the x and y dimensions.) #. For ``geoshape`` marks it should be a field definition of the geojson data @@ -3658,15 +3660,13 @@ class Encoding(VegaLiteSchema): *Note:* When using ``stroke`` channel, ``color`` channel will be ignored. To customize both stroke and fill, please use ``stroke`` and ``fill`` channels (not ``stroke`` and ``color`` ). - strokeOpacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + strokeOpacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Stroke opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config `__ 's ``strokeOpacity`` property. - strokeWidth : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + strokeWidth : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Stroke width of the marks. **Default value:** If undefined, the default stroke width depends on `mark config @@ -3674,8 +3674,7 @@ class Encoding(VegaLiteSchema): property. text : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`) Text of the ``text`` mark. - tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, - List(:class:`TextFieldDef`), None) + tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, List(:class:`TextFieldDef`), None) The tooltip text to show upon mouse hover. x : anyOf(:class:`PositionFieldDef`, :class:`XValueDef`) X coordinates of the marks, or width of horizontal ``"bar"`` and ``"area"`` without @@ -4106,8 +4105,9 @@ class FacetFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4214,8 +4214,7 @@ class FacetedEncoding(VegaLiteSchema): *Note:* When using ``fill`` channel, ``color`` channel will be ignored. To customize both fill and stroke, please use ``fill`` and ``stroke`` channels (not ``fill`` and ``color`` ). - fillOpacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + fillOpacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Fill opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config @@ -4238,8 +4237,7 @@ class FacetedEncoding(VegaLiteSchema): longitude2 : anyOf(:class:`SecondaryFieldDef`, :class:`NumberValueDef`) Longitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - opacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + opacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config @@ -4270,14 +4268,14 @@ class FacetedEncoding(VegaLiteSchema): * plotting shapes: ``"circle"``, ``"square"``, ``"cross"``, ``"diamond"``, - ``"triangle-up"``, ``"triangle-down"``, ``"triangle-right"``, or - ``"triangle-left"``. + ``"triangle-up"``, ``"triangle-down"``, ``"triangle-right"``, or + ``"triangle-left"``. * the line symbol ``"stroke"`` * centered directional shapes ``"arrow"``, ``"wedge"``, or ``"triangle"`` * a custom `SVG path string - `__ (For correct - sizing, custom shape paths should be defined within a square bounding box with - coordinates ranging from -1 to 1 along both the x and y dimensions.) + `__ (For correct + sizing, custom shape paths should be defined within a square bounding box with + coordinates ranging from -1 to 1 along both the x and y dimensions.) #. For ``geoshape`` marks it should be a field definition of the geojson data @@ -4303,15 +4301,13 @@ class FacetedEncoding(VegaLiteSchema): *Note:* When using ``stroke`` channel, ``color`` channel will be ignored. To customize both stroke and fill, please use ``stroke`` and ``fill`` channels (not ``stroke`` and ``color`` ). - strokeOpacity : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + strokeOpacity : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Stroke opacity of the marks. **Default value:** If undefined, the default opacity depends on `mark config `__ 's ``strokeOpacity`` property. - strokeWidth : anyOf(:class:`NumericFieldDefWithCondition`, - :class:`NumericValueDefWithCondition`) + strokeWidth : anyOf(:class:`NumericFieldDefWithCondition`, :class:`NumericValueDefWithCondition`) Stroke width of the marks. **Default value:** If undefined, the default stroke width depends on `mark config @@ -4319,8 +4315,7 @@ class FacetedEncoding(VegaLiteSchema): property. text : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`) Text of the ``text`` mark. - tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, - List(:class:`TextFieldDef`), None) + tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, List(:class:`TextFieldDef`), None) The tooltip text to show upon mouse hover. x : anyOf(:class:`PositionFieldDef`, :class:`XValueDef`) X coordinates of the marks, or width of horizontal ``"bar"`` and ``"area"`` without @@ -4460,8 +4455,7 @@ class FieldDefWithConditionMarkPropFieldDefTypeForShapestringnull(VegaLiteSchema **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -4529,8 +4523,9 @@ class FieldDefWithConditionMarkPropFieldDefTypeForShapestringnull(VegaLiteSchema `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4663,8 +4658,7 @@ class FieldDefWithConditionMarkPropFieldDefnumber(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -4732,8 +4726,9 @@ class FieldDefWithConditionMarkPropFieldDefnumber(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4862,8 +4857,7 @@ class FieldDefWithConditionMarkPropFieldDefstringnull(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -4931,8 +4925,9 @@ class FieldDefWithConditionMarkPropFieldDefstringnull(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -8175,8 +8170,7 @@ class NumericFieldDefWithCondition(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -8244,8 +8238,9 @@ class NumericFieldDefWithCondition(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -8307,8 +8302,7 @@ class NumericValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -8999,8 +8993,9 @@ class PositionFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -9027,8 +9022,8 @@ class PositionFieldDef(VegaLiteSchema): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -9928,8 +9923,7 @@ class Scale(VegaLiteSchema): ``symlog`` scales. **Default value:** ``1`` - domain : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - enum('unaggregated'), :class:`SelectionDomain`) + domain : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), enum('unaggregated'), :class:`SelectionDomain`) Customized domain values. For *quantitative* fields, ``domain`` can take the form of a two-element array with @@ -11087,8 +11081,7 @@ class ShapeFieldDefWithCondition(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -11156,8 +11149,9 @@ class ShapeFieldDefWithCondition(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -11219,8 +11213,7 @@ class ShapeValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, - :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -12323,8 +12316,7 @@ class StringFieldDefWithCondition(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -12392,8 +12384,9 @@ class StringFieldDefWithCondition(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -12519,8 +12512,7 @@ class StringFieldDefWithConditionTypeForShape(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -12588,8 +12580,9 @@ class StringFieldDefWithConditionTypeForShape(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -12653,8 +12646,7 @@ class StringValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -12676,8 +12668,7 @@ class StringValueDefWithConditionTypeForShape(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, - :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -13350,8 +13341,7 @@ class TextValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, - List(:class:`ConditionalValueDef`)) + condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : :class:`Value` A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -15662,8 +15652,7 @@ class ValueDefWithConditionMarkPropFieldDefTypeForShapestringnull(VegaLiteSchema Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, - :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDefTypeForShape`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -15687,8 +15676,7 @@ class ValueDefWithConditionMarkPropFieldDefnumber(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, - List(:class:`ConditionalNumberValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalNumberValueDef`, List(:class:`ConditionalNumberValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : float A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -15711,8 +15699,7 @@ class ValueDefWithConditionMarkPropFieldDefstringnull(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, - List(:class:`ConditionalStringValueDef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalStringValueDef`, List(:class:`ConditionalStringValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -15735,8 +15722,7 @@ class ValueDefWithConditionTextFieldDefValue(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, - List(:class:`ConditionalValueDef`)) + condition : anyOf(:class:`ConditionalTextFieldDef`, :class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : :class:`Value` A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values diff --git a/altair/vegalite/v4/api.py b/altair/vegalite/v4/api.py index 84162e114..ad2f26d6e 100644 --- a/altair/vegalite/v4/api.py +++ b/altair/vegalite/v4/api.py @@ -1924,7 +1924,7 @@ class Chart( 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` + layered views that don't use `rangeStep`. Default value: `pad` background : string CSS color property to use as the background of visualization. diff --git a/altair/vegalite/v4/schema/channels.py b/altair/vegalite/v4/schema/channels.py index 1a6dda19d..28c29f70d 100644 --- a/altair/vegalite/v4/schema/channels.py +++ b/altair/vegalite/v4/schema/channels.py @@ -143,8 +143,7 @@ class Angle(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -209,8 +208,9 @@ class Angle(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -340,16 +340,14 @@ class AngleDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefnum For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -423,8 +421,7 @@ class AngleValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -490,8 +487,7 @@ class Color(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -556,8 +552,9 @@ class Color(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -687,16 +684,14 @@ class ColorDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGra For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -770,9 +765,7 @@ class ColorValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -885,8 +878,9 @@ class Column(FieldChannelMixin, core.RowColumnEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -1049,8 +1043,7 @@ class Description(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -1216,9 +1209,7 @@ class DescriptionValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -1526,8 +1517,9 @@ class Facet(FieldChannelMixin, core.FacetEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -1694,8 +1686,7 @@ class Fill(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefG **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -1760,8 +1751,9 @@ class Fill(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefG `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -1891,16 +1883,14 @@ class FillDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGrad For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -1974,9 +1964,7 @@ class FillValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDatu Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -2042,8 +2030,7 @@ class FillOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -2108,8 +2095,9 @@ class FillOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -2239,16 +2227,14 @@ class FillOpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatum For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -2323,8 +2309,7 @@ class FillOpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFiel Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -2390,8 +2375,7 @@ class Href(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -2557,9 +2541,7 @@ class HrefValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -2915,8 +2897,7 @@ class LatitudeDatum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -3129,8 +3110,7 @@ class Latitude2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -3398,8 +3378,7 @@ class LongitudeDatum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -3612,8 +3591,7 @@ class Longitude2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -3753,8 +3731,7 @@ class Opacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldD **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -3819,8 +3796,9 @@ class Opacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldD `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -3950,16 +3928,14 @@ class OpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefn For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -4034,8 +4010,7 @@ class OpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrD Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -4226,8 +4201,7 @@ class OrderValue(ValueChannelMixin, core.OrderValueDef): A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient definition `__ for color, values between ``0`` to ``1`` for opacity). - condition : anyOf(:class:`ConditionalValueDefnumber`, - List(:class:`ConditionalValueDefnumber`)) + condition : anyOf(:class:`ConditionalValueDefnumber`, List(:class:`ConditionalValueDefnumber`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -4341,8 +4315,9 @@ class Radius(FieldChannelMixin, core.PositionFieldDefBase): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -4495,8 +4470,7 @@ class RadiusDatum(DatumChannelMixin, core.PositionDatumDefBase): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -4748,8 +4722,7 @@ class Radius2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -4936,8 +4909,9 @@ class Row(FieldChannelMixin, core.RowColumnEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -5100,8 +5074,7 @@ class Shape(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -5166,8 +5139,9 @@ class Shape(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -5297,16 +5271,14 @@ class ShapeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefstr For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -5380,9 +5352,7 @@ class ShapeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -5448,8 +5418,7 @@ class Size(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefn **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -5514,8 +5483,9 @@ class Size(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefn `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -5645,16 +5615,14 @@ class SizeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefnumb For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -5728,8 +5696,7 @@ class SizeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDatu Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -5795,8 +5762,7 @@ class Stroke(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDe **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -5861,8 +5827,9 @@ class Stroke(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDe `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -5992,16 +5959,14 @@ class StrokeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGr For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -6075,9 +6040,7 @@ class StrokeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDa Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -6143,8 +6106,7 @@ class StrokeDash(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFie **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -6209,8 +6171,9 @@ class StrokeDash(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFie `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -6340,16 +6303,14 @@ class StrokeDashDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumD For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -6424,9 +6385,7 @@ class StrokeDashValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropField Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(List(float), :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -6492,8 +6451,7 @@ class StrokeOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkProp **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -6558,8 +6516,9 @@ class StrokeOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkProp `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -6690,16 +6649,14 @@ class StrokeOpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDat For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -6774,8 +6731,7 @@ class StrokeOpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFi Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -6841,8 +6797,7 @@ class StrokeWidth(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -6907,8 +6862,9 @@ class StrokeWidth(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -7038,16 +6994,14 @@ class StrokeWidthDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatum For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -7122,8 +7076,7 @@ class StrokeWidthValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFiel Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -7189,8 +7142,7 @@ class Text(FieldChannelMixin, core.FieldOrDatumDefWithConditionStringFieldDefTex **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -7369,16 +7321,14 @@ class TextDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionStringDatumD For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. format : anyOf(string, :class:`Dictunknown`) When used with the default ``"number"`` and ``"time"`` format type, the text @@ -7491,8 +7441,7 @@ class TextValue(ValueChannelMixin, core.ValueDefWithConditionStringFieldDefText) Attributes ---------- - condition : anyOf(:class:`ConditionalStringFieldDef`, - :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalStringFieldDef`, :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Text`, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -7605,8 +7554,9 @@ class Theta(FieldChannelMixin, core.PositionFieldDefBase): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -7759,8 +7709,7 @@ class ThetaDatum(DatumChannelMixin, core.PositionDatumDefBase): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -8012,8 +7961,7 @@ class Theta2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -8153,8 +8101,7 @@ class Tooltip(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -8320,9 +8267,7 @@ class TooltipValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -8388,8 +8333,7 @@ class Url(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -8555,9 +8499,7 @@ class UrlValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -8687,8 +8629,9 @@ class X(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -8850,8 +8793,7 @@ class XDatum(DatumChannelMixin, core.PositionDatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -9112,8 +9054,7 @@ class X2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -9573,8 +9514,9 @@ class Y(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -9736,8 +9678,7 @@ class YDatum(DatumChannelMixin, core.PositionDatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -9998,8 +9939,7 @@ class Y2Datum(DatumChannelMixin, core.DatumDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or diff --git a/altair/vegalite/v4/schema/core.py b/altair/vegalite/v4/schema/core.py index acb88bed8..a19a99bdf 100644 --- a/altair/vegalite/v4/schema/core.py +++ b/altair/vegalite/v4/schema/core.py @@ -583,8 +583,7 @@ class Axis(VegaLiteSchema): binned; otherwise, ``false``. gridCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) gridDash : anyOf(List(float), :class:`ExprRef`, :class:`ConditionalAxisNumberArray`) @@ -598,13 +597,11 @@ class Axis(VegaLiteSchema): labelAngle : anyOf(float, :class:`ExprRef`) - labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, - :class:`ConditionalAxisLabelBaseline`) + labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, :class:`ConditionalAxisLabelBaseline`) labelBound : anyOf(anyOf(float, boolean), :class:`ExprRef`) - labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) labelExpr : string `Vega expression `__ for customizing @@ -629,11 +626,9 @@ class Axis(VegaLiteSchema): labelFontSize : anyOf(float, :class:`ExprRef`, :class:`ConditionalAxisNumber`) - labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontStyle`) + labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontStyle`) - labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontWeight`) + labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontWeight`) labelLimit : anyOf(float, :class:`ExprRef`) @@ -695,8 +690,7 @@ class Axis(VegaLiteSchema): tickCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) tickCount : anyOf(float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) A desired number of ticks, for axes visualizing quantitative scales. The resulting @@ -787,8 +781,7 @@ class Axis(VegaLiteSchema): translate : anyOf(float, :class:`ExprRef`) - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible axis tick values. zindex : float A non-negative integer indicating the z-index of the axis. If zindex is 0, axes @@ -925,8 +918,7 @@ class AxisConfig(VegaLiteSchema): binned; otherwise, ``false``. gridCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) gridDash : anyOf(List(float), :class:`ExprRef`, :class:`ConditionalAxisNumberArray`) @@ -940,13 +932,11 @@ class AxisConfig(VegaLiteSchema): labelAngle : anyOf(float, :class:`ExprRef`) - labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, - :class:`ConditionalAxisLabelBaseline`) + labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, :class:`ConditionalAxisLabelBaseline`) labelBound : anyOf(anyOf(float, boolean), :class:`ExprRef`) - labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) labelExpr : string `Vega expression `__ for customizing @@ -971,11 +961,9 @@ class AxisConfig(VegaLiteSchema): labelFontSize : anyOf(float, :class:`ExprRef`, :class:`ConditionalAxisNumber`) - labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontStyle`) + labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontStyle`) - labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontWeight`) + labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontWeight`) labelLimit : anyOf(float, :class:`ExprRef`) @@ -1037,8 +1025,7 @@ class AxisConfig(VegaLiteSchema): tickCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) tickCount : anyOf(float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) A desired number of ticks, for axes visualizing quantitative scales. The resulting @@ -1129,8 +1116,7 @@ class AxisConfig(VegaLiteSchema): translate : anyOf(float, :class:`ExprRef`) - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible axis tick values. zindex : float A non-negative integer indicating the z-index of the axis. If zindex is 0, axes @@ -3820,8 +3806,7 @@ class Encoding(VegaLiteSchema): encoding if conflicting encodings are specified. 2) See the scale documentation for more information about customizing `color scheme `__. - description : anyOf(:class:`StringFieldDefWithCondition`, - :class:`StringValueDefWithCondition`) + description : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`) A text description of this mark for ARIA accessibility (SVG output only). For SVG output the ``"aria-label"`` attribute will be set to this description. detail : anyOf(:class:`FieldDefWithoutScale`, List(:class:`FieldDefWithoutScale`)) @@ -3938,8 +3923,7 @@ class Encoding(VegaLiteSchema): theta2 : :class:`Position2Def` The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise. - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -4460,8 +4444,9 @@ class FacetEncodingFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -4655,8 +4640,9 @@ class FacetFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -4825,8 +4811,7 @@ class FacetFieldDefFieldName(VegaLiteSchema): if ``aggregate`` is ``count``. header : :class:`Header` An object defining properties of a facet's header. - sort : anyOf(:class:`SortArray`, :class:`SortOrder`, :class:`EncodingSortFieldFieldName`, - None) + sort : anyOf(:class:`SortArray`, :class:`SortOrder`, :class:`EncodingSortFieldFieldName`, None) Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -4840,8 +4825,9 @@ class FacetFieldDefFieldName(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -5011,8 +4997,7 @@ class FacetedEncoding(VegaLiteSchema): `__. column : :class:`RowColumnEncodingFieldDef` A field definition for the horizontal facet of trellis plots. - description : anyOf(:class:`StringFieldDefWithCondition`, - :class:`StringValueDefWithCondition`) + description : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`) A text description of this mark for ARIA accessibility (SVG output only). For SVG output the ``"aria-label"`` attribute will be set to this description. detail : anyOf(:class:`FieldDefWithoutScale`, List(:class:`FieldDefWithoutScale`)) @@ -5135,8 +5120,7 @@ class FacetedEncoding(VegaLiteSchema): theta2 : :class:`Position2Def` The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise. - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -5434,8 +5418,7 @@ class FieldOrDatumDefWithConditionStringFieldDefstring(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -6858,8 +6841,7 @@ class Legend(VegaLiteSchema): **Default value:** ``"gradient"`` for non-binned quantitative fields and temporal fields; ``"symbol"`` otherwise. - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible legend values. zindex : float A non-negative integer indicating the z-index of the legend. If zindex is 0, legend @@ -8162,8 +8144,7 @@ class MarkConfigExprOrSignalRef(VegaLiteSchema): Default relative band position for a time unit. If set to ``0``, the marks will be positioned at the beginning of the time unit band step. If set to ``0.5``, the marks will be positioned in the middle of the time unit band step. - tooltip : anyOf(float, string, boolean, :class:`TooltipContent`, :class:`ExprOrSignalRef`, - None) + tooltip : anyOf(float, string, boolean, :class:`TooltipContent`, :class:`ExprOrSignalRef`, None) The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from. @@ -8685,16 +8666,14 @@ class FieldOrDatumDefWithConditionDatumDefGradientstringnull(ColorDef, MarkPropD For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -8813,8 +8792,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull(ColorDef, M **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -8879,8 +8857,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull(ColorDef, M `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -9544,16 +9523,14 @@ class FieldOrDatumDefWithConditionDatumDefnumberArray(MarkPropDefnumberArray, Nu For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -9672,8 +9649,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray(MarkPropDefnumberA **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -9738,8 +9714,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray(MarkPropDefnumberA `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -9889,16 +9866,14 @@ class FieldOrDatumDefWithConditionDatumDefnumber(MarkPropDefnumber, NumericMarkP For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -10015,8 +9990,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumber(MarkPropDefnumber, Nume **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -10081,8 +10055,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumber(MarkPropDefnumber, Nume `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -10389,8 +10364,7 @@ class OrderValueDef(VegaLiteSchema): A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient definition `__ for color, values between ``0`` to ``1`` for opacity). - condition : anyOf(:class:`ConditionalValueDefnumber`, - List(:class:`ConditionalValueDefnumber`)) + condition : anyOf(:class:`ConditionalValueDefnumber`, List(:class:`ConditionalValueDefnumber`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -10868,8 +10842,7 @@ class DatumDef(LatLongDef, Position2Def): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -10954,8 +10927,7 @@ class PositionDatumDefBase(PolarDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -11100,8 +11072,7 @@ class PositionDatumDef(PositionDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -11329,8 +11300,9 @@ class PositionFieldDef(PositionDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -11561,8 +11533,9 @@ class PositionFieldDefBase(PolarDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -11930,8 +11903,7 @@ class FieldRangePredicate(Predicate): field : :class:`FieldName` Field to be tested. - range : anyOf(List(anyOf(float, :class:`DateTime`, None, :class:`ExprRef`)), - :class:`ExprRef`) + range : anyOf(List(anyOf(float, :class:`DateTime`, None, :class:`ExprRef`)), :class:`ExprRef`) An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data. timeUnit : anyOf(:class:`TimeUnit`, :class:`TimeUnitParams`) @@ -12862,8 +12834,9 @@ class RowColumnEncodingFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -13016,9 +12989,7 @@ class Scale(VegaLiteSchema): ``symlog`` scales. **Default value:** ``1`` - domain : anyOf(List(anyOf(None, string, float, boolean, :class:`DateTime`, - :class:`ExprRef`)), string, :class:`SelectionExtent`, :class:`DomainUnionWith`, - :class:`ExprRef`) + domain : anyOf(List(anyOf(None, string, float, boolean, :class:`DateTime`, :class:`ExprRef`)), string, :class:`SelectionExtent`, :class:`DomainUnionWith`, :class:`ExprRef`) Customized domain values in the form of constant values or dynamic values driven by a selection. @@ -13065,8 +13036,7 @@ class Scale(VegaLiteSchema): property is only intended for use with scales having continuous domains. exponent : anyOf(float, :class:`ExprRef`) The exponent of the ``pow`` scale. - interpolate : anyOf(:class:`ScaleInterpolateEnum`, :class:`ExprRef`, - :class:`ScaleInterpolateParams`) + interpolate : anyOf(:class:`ScaleInterpolateEnum`, :class:`ExprRef`, :class:`ScaleInterpolateParams`) The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in HCL space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include @@ -13079,8 +13049,7 @@ class Scale(VegaLiteSchema): * **Default value:** ``hcl`` - nice : anyOf(boolean, float, :class:`TimeInterval`, :class:`TimeIntervalStep`, - :class:`ExprRef`) + nice : anyOf(boolean, float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be @@ -13138,8 +13107,7 @@ class Scale(VegaLiteSchema): `__ 's ``bandPaddingOuter`` for band scales and ``pointPadding`` for point scales. By default, Vega-Lite sets outer padding such that *width/height = number of unique values * step*. - range : anyOf(:class:`RangeEnum`, List(anyOf(float, string, List(float), :class:`ExprRef`)), - Mapping(required=[field])) + range : anyOf(:class:`RangeEnum`, List(anyOf(float, string, List(float), :class:`ExprRef`)), Mapping(required=[field])) The range of the scale. One of: @@ -14248,16 +14216,14 @@ class FieldOrDatumDefWithConditionDatumDefstringnull(MarkPropDefstringnullTypeFo For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. type : :class:`Type` The type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or @@ -14376,8 +14342,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull(MarkPro **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -14442,8 +14407,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull(MarkPro `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). - ``null`` indicating no sort. @@ -14628,8 +14594,7 @@ class SharedEncoding(VegaLiteSchema): theta2 : Mapping(required=[]) - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -16125,8 +16090,7 @@ class StringFieldDefWithCondition(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -16292,9 +16256,7 @@ class StringValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -16466,16 +16428,14 @@ class FieldOrDatumDefWithConditionStringDatumDefText(TextDef): For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to ``0``, the marks will be positioned at the beginning of the band. If set to ``0.5``, the marks will be positioned in the middle of the band. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. format : anyOf(string, :class:`Dictunknown`) When used with the default ``"number"`` and ``"time"`` format type, the text @@ -16634,8 +16594,7 @@ class FieldOrDatumDefWithConditionStringFieldDefText(TextDef): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a selection or a test predicate `__. @@ -19350,9 +19309,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull(ColorDef, M Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19375,9 +19332,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull(MarkPro Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19400,8 +19355,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefnumber(MarkPropDefnumber, Nume Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19423,9 +19377,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray(MarkPropDefnumberA Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(List(float), :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19448,9 +19400,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefstringnull(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19472,8 +19422,7 @@ class ValueDefWithConditionStringFieldDefText(TextDef): Attributes ---------- - condition : anyOf(:class:`ConditionalStringFieldDef`, - :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalStringFieldDef`, :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(:class:`Text`, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient diff --git a/altair/vegalite/v5/api.py b/altair/vegalite/v5/api.py index 468aac790..6b12593cc 100644 --- a/altair/vegalite/v5/api.py +++ b/altair/vegalite/v5/api.py @@ -2099,7 +2099,7 @@ class Chart( 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` + layered views that don't use `rangeStep`. Default value: `pad` background : string CSS color property to use as the background of visualization. @@ -2117,8 +2117,8 @@ class Chart( 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` + "bottom": 5}` to specify padding for each side of the visualization. Default + value: `5` projection : Projection 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"`, diff --git a/altair/vegalite/v5/schema/channels.py b/altair/vegalite/v5/schema/channels.py index 602a492ba..09c0f1fb4 100644 --- a/altair/vegalite/v5/schema/channels.py +++ b/altair/vegalite/v5/schema/channels.py @@ -136,8 +136,7 @@ class Angle(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -207,8 +206,9 @@ class Angle(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -344,16 +344,14 @@ class AngleDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefnum Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -461,8 +459,7 @@ class AngleValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -521,8 +518,7 @@ class Color(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -592,8 +588,9 @@ class Color(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -729,16 +726,14 @@ class ColorDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGra Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -846,9 +841,7 @@ class ColorValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -959,8 +952,9 @@ class Column(FieldChannelMixin, core.RowColumnEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -1130,8 +1124,7 @@ class Description(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -1306,9 +1299,7 @@ class DescriptionValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -1623,8 +1614,9 @@ class Facet(FieldChannelMixin, core.FacetEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -1796,8 +1788,7 @@ class Fill(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefG **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -1867,8 +1858,9 @@ class Fill(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefG `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2004,16 +1996,14 @@ class FillDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGrad Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -2121,9 +2111,7 @@ class FillValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDatu Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -2182,8 +2170,7 @@ class FillOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -2253,8 +2240,9 @@ class FillOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -2390,16 +2378,14 @@ class FillOpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatum Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -2507,8 +2493,7 @@ class FillOpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFiel Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -2567,8 +2552,7 @@ class Href(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -2743,9 +2727,7 @@ class HrefValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -3106,8 +3088,7 @@ class LatitudeDatum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -3318,8 +3299,7 @@ class Latitude2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -3619,8 +3599,7 @@ class LongitudeDatum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -3831,8 +3810,7 @@ class Longitude2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -3998,8 +3976,7 @@ class Opacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldD **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -4069,8 +4046,9 @@ class Opacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldD `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4206,16 +4184,14 @@ class OpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefn Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -4323,8 +4299,7 @@ class OpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrD Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -4520,8 +4495,7 @@ class OrderValue(ValueChannelMixin, core.OrderValueDef): A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient definition `__ for color, values between ``0`` to ``1`` for opacity). - condition : anyOf(:class:`ConditionalValueDefnumber`, - List(:class:`ConditionalValueDefnumber`)) + condition : anyOf(:class:`ConditionalValueDefnumber`, List(:class:`ConditionalValueDefnumber`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -4633,8 +4607,9 @@ class Radius(FieldChannelMixin, core.PositionFieldDefBase): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4662,8 +4637,8 @@ class Radius(FieldChannelMixin, core.PositionFieldDefBase): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -4798,8 +4773,7 @@ class RadiusDatum(DatumChannelMixin, core.PositionDatumDefBase): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -4831,8 +4805,8 @@ class RadiusDatum(DatumChannelMixin, core.PositionDatumDefBase): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -5076,8 +5050,7 @@ class Radius2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -5295,8 +5268,9 @@ class Row(FieldChannelMixin, core.RowColumnEncodingFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -5466,8 +5440,7 @@ class Shape(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -5537,8 +5510,9 @@ class Shape(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDef `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -5674,16 +5648,14 @@ class ShapeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefstr Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -5791,9 +5763,7 @@ class ShapeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDat Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -5852,8 +5822,7 @@ class Size(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefn **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -5923,8 +5892,9 @@ class Size(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDefn `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -6060,16 +6030,14 @@ class SizeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefnumb Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -6177,8 +6145,7 @@ class SizeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDatu Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -6237,8 +6204,7 @@ class Stroke(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDe **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -6308,8 +6274,9 @@ class Stroke(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFieldDe `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -6445,16 +6412,14 @@ class StrokeDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumDefGr Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -6562,9 +6527,7 @@ class StrokeValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFieldOrDa Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -6623,8 +6586,7 @@ class StrokeDash(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFie **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -6694,8 +6656,9 @@ class StrokeDash(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFie `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -6831,16 +6794,14 @@ class StrokeDashDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatumD Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -6948,9 +6909,7 @@ class StrokeDashValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropField Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(List(float), :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -7009,8 +6968,7 @@ class StrokeOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkProp **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -7080,8 +7038,9 @@ class StrokeOpacity(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkProp `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -7217,16 +7176,14 @@ class StrokeOpacityDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDat Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -7334,8 +7291,7 @@ class StrokeOpacityValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFi Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -7394,8 +7350,7 @@ class StrokeWidth(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -7465,8 +7420,9 @@ class StrokeWidth(FieldChannelMixin, core.FieldOrDatumDefWithConditionMarkPropFi `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -7602,16 +7558,14 @@ class StrokeWidthDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionDatum Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -7719,8 +7673,7 @@ class StrokeWidthValue(ValueChannelMixin, core.ValueDefWithConditionMarkPropFiel Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -7779,8 +7732,7 @@ class Text(FieldChannelMixin, core.FieldOrDatumDefWithConditionStringFieldDefTex **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -7961,16 +7913,14 @@ class TextDatum(DatumChannelMixin, core.FieldOrDatumDefWithConditionStringDatumD Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. format : anyOf(string, :class:`Dict`) When used with the default ``"number"`` and ``"time"`` format type, the text @@ -8113,8 +8063,7 @@ class TextValue(ValueChannelMixin, core.ValueDefWithConditionStringFieldDefText) Attributes ---------- - condition : anyOf(:class:`ConditionalStringFieldDef`, - :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalStringFieldDef`, :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Text`, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -8225,8 +8174,9 @@ class Theta(FieldChannelMixin, core.PositionFieldDefBase): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -8254,8 +8204,8 @@ class Theta(FieldChannelMixin, core.PositionFieldDefBase): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -8389,8 +8339,7 @@ class ThetaDatum(DatumChannelMixin, core.PositionDatumDefBase): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -8422,8 +8371,8 @@ class ThetaDatum(DatumChannelMixin, core.PositionDatumDefBase): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -8667,8 +8616,7 @@ class Theta2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -8834,8 +8782,7 @@ class Tooltip(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -9010,9 +8957,7 @@ class TooltipValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -9071,8 +9016,7 @@ class Url(FieldChannelMixin, core.StringFieldDefWithCondition): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -9247,9 +9191,7 @@ class UrlValue(ValueChannelMixin, core.StringValueDefWithCondition): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -9377,8 +9319,9 @@ class X(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -9406,8 +9349,8 @@ class X(FieldChannelMixin, core.PositionFieldDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -9551,8 +9494,7 @@ class XDatum(DatumChannelMixin, core.PositionDatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -9592,8 +9534,8 @@ class XDatum(DatumChannelMixin, core.PositionDatumDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -9836,8 +9778,7 @@ class X2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -10299,8 +10240,9 @@ class XOffset(FieldChannelMixin, core.ScaleFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -10433,8 +10375,7 @@ class XOffsetDatum(DatumChannelMixin, core.ScaleDatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -10683,8 +10624,9 @@ class Y(FieldChannelMixin, core.PositionFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -10712,8 +10654,8 @@ class Y(FieldChannelMixin, core.PositionFieldDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -10857,8 +10799,7 @@ class YDatum(DatumChannelMixin, core.PositionDatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -10898,8 +10839,8 @@ class YDatum(DatumChannelMixin, core.PositionDatumDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -11142,8 +11083,7 @@ class Y2Datum(DatumChannelMixin, core.DatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -11605,8 +11545,9 @@ class YOffset(FieldChannelMixin, core.ScaleFieldDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -11739,8 +11680,7 @@ class YOffsetDatum(DatumChannelMixin, core.ScaleDatumDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that diff --git a/altair/vegalite/v5/schema/core.py b/altair/vegalite/v5/schema/core.py index a63d8cda4..af0d74832 100644 --- a/altair/vegalite/v5/schema/core.py +++ b/altair/vegalite/v5/schema/core.py @@ -613,8 +613,7 @@ class Axis(VegaLiteSchema): binned; otherwise, ``false``. gridCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) gridDash : anyOf(List(float), :class:`ExprRef`, :class:`ConditionalAxisNumberArray`) @@ -628,13 +627,11 @@ class Axis(VegaLiteSchema): labelAngle : anyOf(float, :class:`ExprRef`) - labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, - :class:`ConditionalAxisLabelBaseline`) + labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, :class:`ConditionalAxisLabelBaseline`) labelBound : anyOf(anyOf(float, boolean), :class:`ExprRef`) - labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) labelExpr : string `Vega expression `__ for customizing @@ -659,11 +656,9 @@ class Axis(VegaLiteSchema): labelFontSize : anyOf(float, :class:`ExprRef`, :class:`ConditionalAxisNumber`) - labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontStyle`) + labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontStyle`) - labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontWeight`) + labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontWeight`) labelLimit : anyOf(float, :class:`ExprRef`) @@ -727,8 +722,7 @@ class Axis(VegaLiteSchema): tickCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) tickCount : anyOf(float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) A desired number of ticks, for axes visualizing quantitative scales. The resulting @@ -827,8 +821,7 @@ class Axis(VegaLiteSchema): translate : anyOf(float, :class:`ExprRef`) - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible axis tick values. zindex : float A non-negative integer indicating the z-index of the axis. If zindex is 0, axes @@ -971,8 +964,7 @@ class AxisConfig(VegaLiteSchema): binned; otherwise, ``false``. gridCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + gridColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) gridDash : anyOf(List(float), :class:`ExprRef`, :class:`ConditionalAxisNumberArray`) @@ -986,13 +978,11 @@ class AxisConfig(VegaLiteSchema): labelAngle : anyOf(float, :class:`ExprRef`) - labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, - :class:`ConditionalAxisLabelBaseline`) + labelBaseline : anyOf(:class:`TextBaseline`, :class:`ExprRef`, :class:`ConditionalAxisLabelBaseline`) labelBound : anyOf(anyOf(float, boolean), :class:`ExprRef`) - labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + labelColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) labelExpr : string `Vega expression `__ for customizing @@ -1017,11 +1007,9 @@ class AxisConfig(VegaLiteSchema): labelFontSize : anyOf(float, :class:`ExprRef`, :class:`ConditionalAxisNumber`) - labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontStyle`) + labelFontStyle : anyOf(:class:`FontStyle`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontStyle`) - labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, - :class:`ConditionalAxisLabelFontWeight`) + labelFontWeight : anyOf(:class:`FontWeight`, :class:`ExprRef`, :class:`ConditionalAxisLabelFontWeight`) labelLimit : anyOf(float, :class:`ExprRef`) @@ -1085,8 +1073,7 @@ class AxisConfig(VegaLiteSchema): tickCap : anyOf(:class:`StrokeCap`, :class:`ExprRef`) - tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, - :class:`ConditionalAxisColor`) + tickColor : anyOf(anyOf(None, :class:`Color`), :class:`ExprRef`, :class:`ConditionalAxisColor`) tickCount : anyOf(float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) A desired number of ticks, for axes visualizing quantitative scales. The resulting @@ -1185,8 +1172,7 @@ class AxisConfig(VegaLiteSchema): translate : anyOf(float, :class:`ExprRef`) - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible axis tick values. zindex : float A non-negative integer indicating the z-index of the axis. If zindex is 0, axes @@ -3994,8 +3980,7 @@ class Encoding(VegaLiteSchema): encoding if conflicting encodings are specified. 2) See the scale documentation for more information about customizing `color scheme `__. - description : anyOf(:class:`StringFieldDefWithCondition`, - :class:`StringValueDefWithCondition`) + description : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`) A text description of this mark for ARIA accessibility (SVG output only). For SVG output the ``"aria-label"`` attribute will be set to this description. detail : anyOf(:class:`FieldDefWithoutScale`, List(:class:`FieldDefWithoutScale`)) @@ -4121,8 +4106,7 @@ class Encoding(VegaLiteSchema): theta2 : :class:`Position2Def` The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise. - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -4627,8 +4611,9 @@ class FacetEncodingFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4831,8 +4816,9 @@ class FacetFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -4995,8 +4981,7 @@ class FacetedEncoding(VegaLiteSchema): `__. column : :class:`RowColumnEncodingFieldDef` A field definition for the horizontal facet of trellis plots. - description : anyOf(:class:`StringFieldDefWithCondition`, - :class:`StringValueDefWithCondition`) + description : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`) A text description of this mark for ARIA accessibility (SVG output only). For SVG output the ``"aria-label"`` attribute will be set to this description. detail : anyOf(:class:`FieldDefWithoutScale`, List(:class:`FieldDefWithoutScale`)) @@ -5128,8 +5113,7 @@ class FacetedEncoding(VegaLiteSchema): theta2 : :class:`Position2Def` The end angle of arc marks in radians. A value of 0 indicates up or “north”, increasing values proceed clockwise. - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -5432,8 +5416,7 @@ class FieldOrDatumDefWithConditionStringFieldDefstring(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -7019,8 +7002,7 @@ class Legend(VegaLiteSchema): **Default value:** ``"gradient"`` for non-binned quantitative fields and temporal fields; ``"symbol"`` otherwise. - values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), - :class:`ExprRef`) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`ExprRef`) Explicitly set the visible legend values. zindex : float A non-negative integer indicating the z-index of the legend. If zindex is 0, legend @@ -8644,16 +8626,14 @@ class FieldOrDatumDefWithConditionDatumDefGradientstringnull(ColorDef, MarkPropD Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -8799,8 +8779,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull(ColorDef, M **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -8870,8 +8849,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefGradientstringnull(ColorDef, M `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -9170,16 +9150,14 @@ class FieldOrDatumDefWithConditionDatumDefnumberArray(MarkPropDefnumberArray, Nu Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -9324,8 +9302,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray(MarkPropDefnumberA **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -9395,8 +9372,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumberArray(MarkPropDefnumberA `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -9551,16 +9529,14 @@ class FieldOrDatumDefWithConditionDatumDefnumber(MarkPropDefnumber, NumericMarkP Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -9705,8 +9681,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumber(MarkPropDefnumber, Nume **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, - List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -9776,8 +9751,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefnumber(MarkPropDefnumber, Nume `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -10093,8 +10069,7 @@ class OrderValueDef(VegaLiteSchema): A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient definition `__ for color, values between ``0`` to ``1`` for opacity). - condition : anyOf(:class:`ConditionalValueDefnumber`, - List(:class:`ConditionalValueDefnumber`)) + condition : anyOf(:class:`ConditionalValueDefnumber`, List(:class:`ConditionalValueDefnumber`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -10791,8 +10766,7 @@ class DatumDef(LatLongDef, Position2Def): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -10903,8 +10877,7 @@ class PositionDatumDefBase(PolarDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -10936,8 +10909,8 @@ class PositionDatumDefBase(PolarDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -11079,8 +11052,7 @@ class PositionDatumDef(PositionDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. impute : anyOf(:class:`ImputeParams`, None) An object defining the properties of the Impute Operation to be applied. The field @@ -11120,8 +11092,8 @@ class PositionDatumDef(PositionDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -11344,8 +11316,9 @@ class PositionFieldDef(PositionDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -11373,8 +11346,8 @@ class PositionFieldDef(PositionDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -11591,8 +11564,9 @@ class PositionFieldDefBase(PolarDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -11620,8 +11594,8 @@ class PositionFieldDefBase(PolarDef): stacked bar and area charts `__. :raw-html:`
` - - ``"center"`` - stacking with center baseline (for `streamgraph - `__ ). + * ``"center"`` - stacking with center baseline (for `streamgraph + `__ ). * ``null`` or ``false`` - No-stacking. This will produce layered `bar `__ and area chart. @@ -11978,8 +11952,7 @@ class FieldRangePredicate(Predicate): field : :class:`FieldName` Field to be tested. - range : anyOf(List(anyOf(float, :class:`DateTime`, None, :class:`ExprRef`)), - :class:`ExprRef`) + range : anyOf(List(anyOf(float, :class:`DateTime`, None, :class:`ExprRef`)), :class:`ExprRef`) An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data. timeUnit : anyOf(:class:`TimeUnit`, :class:`TimeUnitParams`) @@ -12923,8 +12896,9 @@ class RowColumnEncodingFieldDef(VegaLiteSchema): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -13093,9 +13067,7 @@ class Scale(VegaLiteSchema): ``symlog`` scales. **Default value:** ``1`` - domain : anyOf(List(anyOf(None, string, float, boolean, :class:`DateTime`, - :class:`ExprRef`)), string, :class:`ParameterExtent`, :class:`DomainUnionWith`, - :class:`ExprRef`) + domain : anyOf(List(anyOf(None, string, float, boolean, :class:`DateTime`, :class:`ExprRef`)), string, :class:`ParameterExtent`, :class:`DomainUnionWith`, :class:`ExprRef`) Customized domain values in the form of constant values or dynamic values driven by a parameter. @@ -13142,8 +13114,7 @@ class Scale(VegaLiteSchema): property is only intended for use with scales having continuous domains. exponent : anyOf(float, :class:`ExprRef`) The exponent of the ``pow`` scale. - interpolate : anyOf(:class:`ScaleInterpolateEnum`, :class:`ExprRef`, - :class:`ScaleInterpolateParams`) + interpolate : anyOf(:class:`ScaleInterpolateEnum`, :class:`ExprRef`, :class:`ScaleInterpolateParams`) The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in HCL space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include @@ -13156,8 +13127,7 @@ class Scale(VegaLiteSchema): * **Default value:** ``hcl`` - nice : anyOf(boolean, float, :class:`TimeInterval`, :class:`TimeIntervalStep`, - :class:`ExprRef`) + nice : anyOf(boolean, float, :class:`TimeInterval`, :class:`TimeIntervalStep`, :class:`ExprRef`) Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be @@ -13216,8 +13186,7 @@ class Scale(VegaLiteSchema): `__ 's ``bandPaddingOuter`` for band scales and ``pointPadding`` for point scales. By default, Vega-Lite sets outer padding such that *width/height = number of unique values * step*. - range : anyOf(:class:`RangeEnum`, List(anyOf(float, string, List(float), :class:`ExprRef`)), - :class:`FieldRange`) + range : anyOf(:class:`RangeEnum`, List(anyOf(float, string, List(float), :class:`ExprRef`)), :class:`FieldRange`) The range of the scale. One of: @@ -13540,8 +13509,7 @@ class ScaleDatumDef(OffsetDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that @@ -13749,8 +13717,9 @@ class ScaleFieldDef(OffsetDef): `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -14243,8 +14212,7 @@ class SelectionParameter(VegaLiteSchema): JavaScript identifiers: they should contain only alphanumeric characters (or "$", or "_") and may not start with a digit. Reserved keywords that may not be used as parameter names are "datum", "event", "item", and "parent". - select : anyOf(:class:`SelectionType`, :class:`PointSelectionConfig`, - :class:`IntervalSelectionConfig`) + select : anyOf(:class:`SelectionType`, :class:`PointSelectionConfig`, :class:`IntervalSelectionConfig`) Determines the default event processing and data query for the selection. Vega-Lite currently supports two selection types: @@ -14268,8 +14236,7 @@ class SelectionParameter(VegaLiteSchema): **See also:** `bind `__ documentation. - value : anyOf(:class:`SelectionInit`, List(:class:`SelectionInitMapping`), - :class:`SelectionInitIntervalMapping`) + value : anyOf(:class:`SelectionInit`, List(:class:`SelectionInitMapping`), :class:`SelectionInitIntervalMapping`) Initialize the selection with a mapping between `projected channels or field names `__ and initial values. @@ -14440,16 +14407,14 @@ class FieldOrDatumDefWithConditionDatumDefstringnull(MarkPropDefstringnullTypeFo Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. title : anyOf(:class:`Text`, None) A title for the field. If ``null``, the title will be removed. @@ -14594,8 +14559,7 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull(MarkPro **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -14665,8 +14629,9 @@ class FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapestringnull(MarkPro `__. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be - `date-time definition objects `__. In addition, for time units - ``"month"`` and ``"day"``, the values can be the month or day names (case + `date-time definition objects + `__. In addition, for time + units ``"month"`` and ``"day"``, the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., ``"Mon"``, ``"Tue"`` ). * ``null`` indicating no sort. @@ -14867,8 +14832,7 @@ class SharedEncoding(VegaLiteSchema): theta2 : Mapping(required=[]) - tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, - List(:class:`StringFieldDef`), None) + tooltip : anyOf(:class:`StringFieldDefWithCondition`, :class:`StringValueDefWithCondition`, List(:class:`StringFieldDef`), None) The tooltip text to show upon mouse hover. Specifying ``tooltip`` encoding overrides `the tooltip property in the mark definition `__. @@ -16227,8 +16191,7 @@ class StringFieldDefWithCondition(VegaLiteSchema): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefstringExprRef`, - List(:class:`ConditionalValueDefstringExprRef`)) + condition : anyOf(:class:`ConditionalValueDefstringExprRef`, List(:class:`ConditionalValueDefstringExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -16404,9 +16367,7 @@ class StringValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -16571,16 +16532,14 @@ class FieldOrDatumDefWithConditionStringDatumDefText(TextDef): Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to ``0``, and at the middle of the band if set to ``0.5``. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. **Note:** A field definition's ``condition`` property can only contain `conditional value definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, - :class:`RepeatRef`) + datum : anyOf(:class:`PrimitiveValue`, :class:`DateTime`, :class:`ExprRef`, :class:`RepeatRef`) A constant value in data domain. format : anyOf(string, :class:`Dict`) When used with the default ``"number"`` and ``"time"`` format type, the text @@ -16761,8 +16720,7 @@ class FieldOrDatumDefWithConditionStringFieldDefText(TextDef): **See also:** `bin `__ documentation. - condition : anyOf(:class:`ConditionalValueDefTextExprRef`, - List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) One or more value definition(s) with `a parameter or a test predicate `__. @@ -17691,8 +17649,7 @@ class TopLevelSelectionParameter(VegaLiteSchema): JavaScript identifiers: they should contain only alphanumeric characters (or "$", or "_") and may not start with a digit. Reserved keywords that may not be used as parameter names are "datum", "event", "item", and "parent". - select : anyOf(:class:`SelectionType`, :class:`PointSelectionConfig`, - :class:`IntervalSelectionConfig`) + select : anyOf(:class:`SelectionType`, :class:`PointSelectionConfig`, :class:`IntervalSelectionConfig`) Determines the default event processing and data query for the selection. Vega-Lite currently supports two selection types: @@ -17716,8 +17673,7 @@ class TopLevelSelectionParameter(VegaLiteSchema): **See also:** `bind `__ documentation. - value : anyOf(:class:`SelectionInit`, List(:class:`SelectionInitMapping`), - :class:`SelectionInitIntervalMapping`) + value : anyOf(:class:`SelectionInit`, List(:class:`SelectionInitMapping`), :class:`SelectionInitIntervalMapping`) Initialize the selection with a mapping between `projected channels or field names `__ and initial values. @@ -19599,9 +19555,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefGradientstringnull(ColorDef, M Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefGradientstringnullExprRef`, - List(:class:`ConditionalValueDefGradientstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefGradientstringnullExprRef`, List(:class:`ConditionalValueDefGradientstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Gradient`, string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19624,9 +19578,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefTypeForShapestringnull(MarkPro Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDefTypeForShape`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19649,8 +19601,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefnumber(MarkPropDefnumber, Nume Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberExprRef`, List(:class:`ConditionalValueDefnumberExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(float, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19672,9 +19623,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefnumberArray(MarkPropDefnumberA Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefnumberArrayExprRef`, - List(:class:`ConditionalValueDefnumberArrayExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefnumberArrayExprRef`, List(:class:`ConditionalValueDefnumberArrayExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(List(float), :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19697,9 +19646,7 @@ class ValueDefWithConditionMarkPropFieldOrDatumDefstringnull(VegaLiteSchema): Attributes ---------- - condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, - :class:`ConditionalValueDefstringnullExprRef`, - List(:class:`ConditionalValueDefstringnullExprRef`)) + condition : anyOf(:class:`ConditionalMarkPropFieldOrDatumDef`, :class:`ConditionalValueDefstringnullExprRef`, List(:class:`ConditionalValueDefstringnullExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(string, None, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient @@ -19721,8 +19668,7 @@ class ValueDefWithConditionStringFieldDefText(TextDef): Attributes ---------- - condition : anyOf(:class:`ConditionalStringFieldDef`, - :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) + condition : anyOf(:class:`ConditionalStringFieldDef`, :class:`ConditionalValueDefTextExprRef`, List(:class:`ConditionalValueDefTextExprRef`)) A field definition or one or more value definition(s) with a parameter predicate. value : anyOf(:class:`Text`, :class:`ExprRef`) A constant value in visual domain (e.g., ``"red"`` / ``"#0099ff"`` / `gradient diff --git a/doc/getting_started/installation.rst b/doc/getting_started/installation.rst index 1e31f2e6c..8fead3a6d 100644 --- a/doc/getting_started/installation.rst +++ b/doc/getting_started/installation.rst @@ -25,6 +25,7 @@ with the above installation commands: - python 3.6 or newer - entrypoints_ +- jinja2 - jsonschema_ - NumPy_ - Pandas_ @@ -33,14 +34,19 @@ with the above installation commands: To run Altair's full test suite and build Altair's documentation requires a few additional dependencies: +- black - flake8 - pytest -- jinja2 - sphinx - m2r - docutils - vega_datasets_ - ipython +- myst-parser +- numpydoc +- pillow +- pydata-sphinx-theme +- geopandas Development Install =================== diff --git a/doc/releases/changes.rst b/doc/releases/changes.rst index 8b20967bd..96172f954 100644 --- a/doc/releases/changes.rst +++ b/doc/releases/changes.rst @@ -111,7 +111,7 @@ Enhancements - New pivot transform: (see :ref:`user-guide-pivot-transform`) -- Image mark (see :ref:`user-guide-image-mark`) +- Image mark (see :ref:`user-guide-image-marks`) - New default ``html`` renderer, directly compatible with Jupyter Notebook and JupyterLab without the need for frontend extensions, as well as tools like diff --git a/doc/requirements.txt b/doc/requirements.txt index 0f89d39b7..efefc068c 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,4 +4,4 @@ numpydoc pillow mistune<=0.8.4 pydata-sphinx-theme -geopandas +geopandas \ No newline at end of file diff --git a/doc/user_guide/API.rst b/doc/user_guide/API.rst index 573a1f697..a1092ebc4 100644 --- a/doc/user_guide/API.rst +++ b/doc/user_guide/API.rst @@ -210,7 +210,6 @@ Low-Level Schema Wrappers BrushConfig CalculateTransform Categorical - Color ColorDef ColorName ColorScheme @@ -508,7 +507,6 @@ Low-Level Schema Wrappers StrokeJoin StyleConfigIndex SymbolShape - Text TextBaseline TextDef TextDirection diff --git a/doc/user_guide/compound_charts.rst b/doc/user_guide/compound_charts.rst index 1229a19a9..9ca757db6 100644 --- a/doc/user_guide/compound_charts.rst +++ b/doc/user_guide/compound_charts.rst @@ -362,7 +362,7 @@ layered chart with a hover selection: .. altair-plot:: - hover = alt.selection_point(on='mouseover', nearest=True, empty='none') + hover = alt.selection_point(on='mouseover', nearest=True, empty=False) base = alt.Chart(iris).encode( x='petalLength:Q', diff --git a/doc/user_guide/interactions.rst b/doc/user_guide/interactions.rst index 035f30e56..e8c1b9054 100644 --- a/doc/user_guide/interactions.rst +++ b/doc/user_guide/interactions.rst @@ -312,7 +312,7 @@ empty selection contains none of the points: .. altair-plot:: - interval_x = alt.selection_interval(encodings=['x'], empty='none') + interval_x = alt.selection_interval(encodings=['x'], empty=False) make_example(interval_x) A special case of an interval selection is when the interval is bound to the @@ -366,7 +366,7 @@ by hovering over them with your mouse: .. altair-plot:: - point_mouseover = alt.selection_point(on='mouseover', toggle=False, empty='none') + point_mouseover = alt.selection_point(on='mouseover', toggle=False, empty=False) make_example(point_mouseover) Composing Multiple Selections @@ -728,7 +728,7 @@ Some possible use cases for the above interactivity are not currently supported x=alt.X('value:Q', title=''), y='Horsepower', color='Origin', - ).add_selection( + ).add_params( selection ).transform_filter( selection diff --git a/doc/user_guide/marks/geoshape.rst b/doc/user_guide/marks/geoshape.rst index d5ff2c230..08119d101 100644 --- a/doc/user_guide/marks/geoshape.rst +++ b/doc/user_guide/marks/geoshape.rst @@ -170,10 +170,12 @@ Points can be drawn when they are defined as ``Points`` within a GeoDataFrame us We first assign the centroids of Polygons as Point geometry and plot these: .. altair-plot:: - + + # .copy() to prevent changing the original `gdf_sel` variable + # derive centroid in a projected CRS (in meters) and visualize in a geographic CRS (in degrees). gdf_centroid = gpd.GeoDataFrame( - data=gdf_sel.copy(), # .copy() to prevent changing the original `gdf_sel` variable - geometry=gdf_sel.geometry.centroid + data=gdf_sel.copy(), + geometry=gdf_sel.geometry.to_crs(epsg=3857).centroid.to_crs(epsg=4326) ) alt.Chart(gdf_centroid).mark_geoshape() @@ -393,8 +395,7 @@ This method will maximize the similarity of values in a class while maximizing t distance between the classes (`natural breaks`). The method is also known as the Fisher-Jenks algorithm and is similar to k-Means in 1D: -- By using the external Python package ``jenskpy`` we can derive these `optimum` breaks -as such: +- By using the external Python package ``jenskpy`` we can derive these `optimum` breaks as such: .. code:: python diff --git a/doc/user_guide/marks/line.rst b/doc/user_guide/marks/line.rst index effab9fba..a56fe9353 100644 --- a/doc/user_guide/marks/line.rst +++ b/doc/user_guide/marks/line.rst @@ -115,7 +115,7 @@ We can further apply selection to highlight a certain line on hover. source = data.stocks() highlight = alt.selection( - type="single", on="mouseover", fields=["symbol"], nearest=True + type="point", on="mouseover", fields=["symbol"], nearest=True ) base = alt.Chart(source).encode( @@ -126,7 +126,7 @@ We can further apply selection to highlight a certain line on hover. points = base.mark_circle().encode( opacity=alt.value(0) - ).add_selection( + ).add_params( highlight ).properties( width=600 diff --git a/doc/user_guide/transform/pivot.rst b/doc/user_guide/transform/pivot.rst index be725d63b..cfa80b49a 100644 --- a/doc/user_guide/transform/pivot.rst +++ b/doc/user_guide/transform/pivot.rst @@ -50,7 +50,7 @@ values on multiple lines: base = alt.Chart(source).encode(x='date:T') columns = sorted(source.symbol.unique()) selection = alt.selection_point( - fields=['date'], nearest=True, on='mouseover', empty='none', clear='mouseout' + fields=['date'], nearest=True, on='mouseover', empty=False, clear='mouseout' ) lines = base.mark_line().encode(y='price:Q', color='symbol:N') diff --git a/pyproject.toml b/pyproject.toml index c297a2156..714d8c21c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,5 +17,7 @@ exclude = ''' ''' [build-system] -requires = ["setuptools >= 40.6.0", "wheel"] +# Reason for setuptools version restriction to <64 can be found at +# https://github.com/altair-viz/altair/pull/2758#issuecomment-1358091909 +requires = ["setuptools >= 40.6.0, <64", "wheel"] build-backend = "setuptools.build_meta" diff --git a/requirements_dev.txt b/requirements_dev.txt index 5383e908c..407aeda4b 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -7,4 +7,4 @@ sphinx mistune<2.0.0 # necessary for m2r v0.2 m2r vega_datasets -recommonmark +myst-parser \ No newline at end of file diff --git a/tools/generate_api_docs.py b/tools/generate_api_docs.py index a70c3aa73..b454d56d1 100644 --- a/tools/generate_api_docs.py +++ b/tools/generate_api_docs.py @@ -97,7 +97,14 @@ def api_functions(): def lowlevel_wrappers(): - return sorted(iter_objects(alt.schema.core, restrict_to_subclass=alt.SchemaBase)) + objects = sorted(iter_objects(alt.schema.core, restrict_to_subclass=alt.SchemaBase)) + # The names of these two classes are also used for classes in alt.channels. Due to + # how imports are set up, these channel classes overwrite the two low-level classes + # in the top-level Altair namespace. Therefore, they cannot be imported as e.g. + # altair.Color (which gives you the Channel class) and therefore Sphinx won't + # be able to produce a documentation page. + objects = [o for o in objects if o not in ("Color", "Text")] + return objects def write_api_file(): diff --git a/tools/schemapi/utils.py b/tools/schemapi/utils.py index d0b149f3f..ba5cbfbae 100644 --- a/tools/schemapi/utils.py +++ b/tools/schemapi/utils.py @@ -428,12 +428,21 @@ def indent_docstring(lines, indent_level, width=100, lstrip=True): drop_whitespace=True, ) for line in stripped.split("\n"): - if line == "": + line_stripped = line.lstrip() + line_stripped = fix_docstring_issues(line_stripped) + if line_stripped == "": final_lines.append("") - elif line.startswith("* "): - final_lines.extend(list_wrapper.wrap(line[2:])) + elif line_stripped.startswith("* "): + final_lines.extend(list_wrapper.wrap(line_stripped[2:])) + # Matches lines where an attribute is mentioned followed by the accepted + # types (lines starting with a character sequence that + # does not contain white spaces or '*' followed by ' : '). + # It therefore matches 'condition : anyOf(...' but not '**Notes** : ...' + # These lines should not be wrapped at all but appear on one line + elif re.match(r"[^\s*]+ : ", line_stripped): + final_lines.append(indent * " " + line_stripped) else: - final_lines.extend(wrapper.wrap(line.lstrip())) + final_lines.extend(wrapper.wrap(line_stripped)) # If this is the last line, put in an indent elif i + 1 == len(lines): @@ -453,3 +462,30 @@ def indent_docstring(lines, indent_level, width=100, lstrip=True): if lstrip: wrapped = wrapped.lstrip() return wrapped + + +def fix_docstring_issues(docstring): + # All lists should start with '*' followed by a whitespace. Fixes the ones + # which either do not have a whitespace or/and start with '-' by first replacing + # "-" with "*" and then adding a whitespace where necessary + docstring = re.sub( + r"^-(?=[ `\"a-z])", + "*", + docstring, + flags=re.MULTILINE, + ) + # Now add a whitespace where an asterisk is followed by one of the characters + # in the square brackets of the regex pattern + docstring = re.sub( + r"^\*(?=[`\"a-z])", + "* ", + docstring, + flags=re.MULTILINE, + ) + + # Links to the vega-lite documentation cannot be relative but instead need to + # contain the full URL. + docstring = docstring.replace( + "types#datetime", "https://vega.github.io/vega-lite/docs/datetime.html" + ) + return docstring