From cf19282342d5de4e7932a0b6966e4cf12dc6883c Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Tue, 31 Jul 2018 14:18:41 -0700 Subject: [PATCH 1/6] DOC: use autosummary to clean up API docs --- doc/.gitignore | 5 +- doc/conf.py | 6 +- doc/user_guide/API.rst | 406 +++++++++++++++++++++++++++-------------- 3 files changed, 274 insertions(+), 143 deletions(-) diff --git a/doc/.gitignore b/doc/.gitignore index 22a4938e3..c3db69fed 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -2,4 +2,7 @@ _build # gallery is auto-generated; don't version-control it gallery -_images \ No newline at end of file +_images + +# generated class documentation +user_guide/generated diff --git a/doc/conf.py b/doc/conf.py index db3621c6f..8f5e90ba7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -43,9 +43,13 @@ altair_plot_links = {'editor': True, 'source': False, 'export': False} -autodoc_default_flags = ['members'] +autodoc_default_flags = ['members', 'inherited-members'] + autodoc_member_order = 'groupwise' +# generate autosummary even if no references +autosummary_generate = True + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/user_guide/API.rst b/doc/user_guide/API.rst index 3675a9866..0ab274cad 100644 --- a/doc/user_guide/API.rst +++ b/doc/user_guide/API.rst @@ -11,150 +11,274 @@ full guidelines on their use. Top-Level Objects ----------------- +.. currentmodule:: altair -.. autoclass:: altair.Chart - :members: - :inherited-members: +.. autosummary:: + :toctree: generated/ + :nosignatures: -.. autoclass:: altair.LayerChart - :members: - :inherited-members: - -.. autoclass:: altair.HConcatChart - :members: - :inherited-members: - -.. autoclass:: altair.VConcatChart - :members: - :inherited-members: - -.. autoclass:: altair.FacetChart - :members: - :inherited-members: - -.. autoclass:: altair.RepeatChart - :members: - :inherited-members: + Chart + LayerChart + HConcatChart + VConcatChart + FacetChart + RepeatChart Encoding Channels ----------------- - -.. autoclass:: altair.Color - :members: - :inherited-members: - -.. autoclass:: altair.ColorValue - :members: - :inherited-members: - -.. autoclass:: altair.Column - :members: - :inherited-members: - -.. autoclass:: altair.Detail - :members: - :inherited-members: - -.. autoclass:: altair.Href - :members: - :inherited-members: - -.. autoclass:: altair.HrefValue - :members: - :inherited-members: - -.. autoclass:: altair.Opacity - :members: - :inherited-members: - -.. autoclass:: altair.OpacityValue - :members: - :inherited-members: - -.. autoclass:: altair.Order - :members: - :inherited-members: - -.. autoclass:: altair.Row - :members: - :inherited-members: - -.. autoclass:: altair.Shape - :members: - :inherited-members: - -.. autoclass:: altair.ShapeValue - :members: - :inherited-members: - -.. autoclass:: altair.Size - :members: - :inherited-members: - -.. autoclass:: altair.SizeValue - :members: - :inherited-members: - -.. autoclass:: altair.Text - :members: - :inherited-members: - -.. autoclass:: altair.TextValue - :members: - :inherited-members: - -.. autoclass:: altair.Tooltip - :members: - :inherited-members: - -.. autoclass:: altair.TooltipValue - :members: - :inherited-members: - -.. autoclass:: altair.X - :members: - :inherited-members: - -.. autoclass:: altair.XValue - :members: - :inherited-members: - -.. autoclass:: altair.X2 - :members: - :inherited-members: - -.. autoclass:: altair.X2Value - :members: - :inherited-members: - -.. autoclass:: altair.Y - :members: - :inherited-members: - -.. autoclass:: altair.YValue - :members: - :inherited-members: - -.. autoclass:: altair.Y2 - :members: - :inherited-members: - -.. autoclass:: altair.Y2Value - :members: - :inherited-members: - - -Other Objects +.. currentmodule:: altair + +.. autosummary:: + :toctree: generated/ + :nosignatures: + + Color + ColorValue + Column + Detail + Fill + FillValue + Href + HrefValue + Key + Latitude + Latitude2 + Longitude + Longitude2 + Opacity + OpacityValue + Order + Row + Shape + ShapeValue + Size + SizeValue + Stroke + StrokeValue + Text + TextValue + Tooltip + TooltipValue + X + XValue + X2 + X2Value + Y + YValue + Y2 + Y2Value + +API Functions ------------- - -.. automodule:: altair - :members: - :imported-members: - :exclude-members: Chart,LayerChart,FacetChart,HConcatChart,VConcatChart,FacetChart,RepeatChart - -Vega Expressions ----------------- - -.. automodule:: altair.expr - :members: - :imported-members: +.. currentmodule:: altair + +.. autosummary:: + :toctree: generated/ + :nosignatures: + + layer + vconcat + hconcat + repeat + value + selection + selection_interval + selection_multi + selection_single + binding + binding_checkbox + binding_radio + binding_range + binding_select + condition + topo_feature + +Low-Level Schema Wrappers +------------------------- +.. currentmodule:: altair + +.. autosummary:: + :toctree: generated/ + :nosignatures: + + Aggregate + AggregateOp + AggregateTransform + AggregatedFieldDef + Anchor + AnyMark + AreaConfig + AutoSizeParams + AutosizeType + Axis + AxisConfig + AxisOrient + AxisResolveMap + BarConfig + BasicType + BinParams + BinTransform + BrushConfig + CalculateTransform + CompositeUnitSpec + CompositeUnitSpecAlias + ConditionalFieldDef + ConditionalMarkPropFieldDef + ConditionalPredicateFieldDef + ConditionalPredicateMarkPropFieldDef + ConditionalPredicateTextFieldDef + ConditionalPredicateValueDef + ConditionalSelectionFieldDef + ConditionalSelectionMarkPropFieldDef + ConditionalSelectionTextFieldDef + ConditionalSelectionValueDef + ConditionalTextFieldDef + ConditionalValueDef + Config + CsvDataFormat + Data + DataFormat + Datasets + DateTime + Day + DictInlineDataset + Encoding + EncodingWithFacet + FacetFieldDef + FacetMapping + FacetSpec + FacetedCompositeUnitSpecAlias + FieldDef + FieldDefWithCondition + FieldEqualPredicate + FieldOneOfPredicate + FieldRangePredicate + FilterTransform + FontStyle + FontWeight + FontWeightNumber + FontWeightString + GeoType + HConcatSpec + Header + HorizontalAlign + InlineData + InlineDataset + Interpolate + IntervalSelection + IntervalSelectionConfig + JsonDataFormat + LayerSpec + Legend + LegendConfig + LegendOrient + LegendResolveMap + LineConfig + LocalMultiTimeUnit + LocalSingleTimeUnit + LogicalAndPredicate + LogicalNotPredicate + LogicalOperandPredicate + LogicalOrPredicate + LookupData + LookupTransform + Mark + MarkConfig + MarkDef + MarkPropFieldDefWithCondition + MarkPropValueDefWithCondition + MarkProperties + Month + MultiSelection + MultiSelectionConfig + MultiTimeUnit + NamedData + NiceTime + OrderFieldDef + Orient + Padding + PositionFieldDef + Predicate + Projection + ProjectionConfig + ProjectionType + RangeConfig + RangeConfigValue + Repeat + RepeatRef + RepeatSpec + Resolve + ResolveMode + Root + Scale + ScaleConfig + ScaleInterpolate + ScaleInterpolateParams + ScaleResolveMap + ScaleType + SchemaBase + SchemeParams + SelectionAnd + SelectionConfig + SelectionDef + SelectionDomain + SelectionNot + SelectionOperand + SelectionOr + SelectionPredicate + SelectionResolution + SingleDefChannel + SingleSelection + SingleSelectionConfig + SingleTimeUnit + SortField + SortOrder + Spec + StackOffset + StyleConfigIndex + TextConfig + TextFieldDef + TextFieldDefWithCondition + TextValueDefWithCondition + TickConfig + TimeUnit + TimeUnitTransform + TitleOrient + TitleParams + TopLevelFacetSpec + TopLevelFacetedUnitSpec + TopLevelHConcatSpec + TopLevelLayerSpec + TopLevelRepeatSpec + TopLevelSpec + TopLevelVConcatSpec + TopoDataFormat + Transform + Type + Undefined + UrlData + UtcMultiTimeUnit + UtcSingleTimeUnit + VConcatSpec + ValueDef + ValueDefWithCondition + VegaLiteSchema + VerticalAlign + VgAxisConfig + VgBinding + VgCheckboxBinding + VgComparatorOrder + VgEventStream + VgGenericBinding + VgMarkConfig + VgProjectionType + VgRadioBinding + VgRangeBinding + VgScheme + VgSelectBinding + VgTitleConfig + ViewConfig + WindowFieldDef + WindowOnlyOp + WindowSortField + WindowTransform From b3b16ed0ac003c7dadb59b3322fee34cf99b9ec2 Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Tue, 31 Jul 2018 14:52:50 -0700 Subject: [PATCH 2/6] MAINT: add clean options to doc/Makefile --- doc/Makefile | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/Makefile b/doc/Makefile index cf7888ca8..445ee7ee4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -53,6 +53,14 @@ help: clean: rm -rf $(BUILDDIR)/* +.PHONY: clean-generated +clean-generated: + rm -rf user_guide/generated/ + +.PHONY: clean-images +clean-images: + rm -rf _images + .PHONY: html html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html From cdf606411aac3c77c470212440e6fc64265fe0d6 Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Tue, 31 Jul 2018 15:09:28 -0700 Subject: [PATCH 3/6] Fix some doc build errors --- altair/vegalite/v2/api.py | 4 ++-- doc/user_guide/API.rst | 22 ++++++++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/altair/vegalite/v2/api.py b/altair/vegalite/v2/api.py index 81f8a0c20..2d46d218b 100644 --- a/altair/vegalite/v2/api.py +++ b/altair/vegalite/v2/api.py @@ -544,8 +544,8 @@ def project(self, type='mercator', center=Undefined, clipAngle=Undefined, clipEx Available projection types are ['albers', 'albersUsa', 'azimuthalEqualArea', 'azimuthalEquidistant', - 'conicConformal', 'conicEqualArea', 'conicEquidistant', 'equirectangular', - 'gnomonic', 'mercator', 'orthographic', 'stereographic', 'transverseMercator'] + 'conicConformal', 'conicEqualArea', 'conicEquidistant', 'equirectangular', + 'gnomonic', 'mercator', 'orthographic', 'stereographic', 'transverseMercator'] Attributes ---------- diff --git a/doc/user_guide/API.rst b/doc/user_guide/API.rst index 0ab274cad..154cecac1 100644 --- a/doc/user_guide/API.rst +++ b/doc/user_guide/API.rst @@ -115,6 +115,7 @@ Low-Level Schema Wrappers AxisOrient AxisResolveMap BarConfig + Baseline BasicType BinParams BinTransform @@ -136,13 +137,17 @@ Low-Level Schema Wrappers ConditionalValueDef Config CsvDataFormat + Cursor Data DataFormat Datasets DateTime Day DictInlineDataset + Dir + DsvDataFormat Encoding + EncodingSortField EncodingWithFacet FacetFieldDef FacetMapping @@ -151,6 +156,10 @@ Low-Level Schema Wrappers FieldDef FieldDefWithCondition FieldEqualPredicate + FieldGTEPredicate + FieldGTPredicate + FieldLTEPredicate + FieldLTPredicate FieldOneOfPredicate FieldRangePredicate FilterTransform @@ -161,6 +170,7 @@ Low-Level Schema Wrappers GeoType HConcatSpec Header + HeaderConfig HorizontalAlign InlineData InlineDataset @@ -187,7 +197,6 @@ Low-Level Schema Wrappers MarkDef MarkPropFieldDefWithCondition MarkPropValueDefWithCondition - MarkProperties Month MultiSelection MultiSelectionConfig @@ -196,7 +205,9 @@ Low-Level Schema Wrappers NiceTime OrderFieldDef Orient + OverlayMarkDef Padding + Parse PositionFieldDef Predicate Projection @@ -210,6 +221,9 @@ Low-Level Schema Wrappers Resolve ResolveMode Root + RowColVgLayoutAlign + RowColboolean + RowColnumber Scale ScaleConfig ScaleInterpolate @@ -231,11 +245,15 @@ Low-Level Schema Wrappers SingleSelection SingleSelectionConfig SingleTimeUnit + Sort SortField SortOrder Spec StackOffset + StrokeCap + StrokeJoin StyleConfigIndex + TextBaseline TextConfig TextFieldDef TextFieldDefWithCondition @@ -270,6 +288,7 @@ Low-Level Schema Wrappers VgComparatorOrder VgEventStream VgGenericBinding + VgLayoutAlign VgMarkConfig VgProjectionType VgRadioBinding @@ -280,5 +299,4 @@ Low-Level Schema Wrappers ViewConfig WindowFieldDef WindowOnlyOp - WindowSortField WindowTransform From d4086ebc90ce7321bffbbe4ff92e622e34ab72bc Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Wed, 1 Aug 2018 08:18:21 -0700 Subject: [PATCH 4/6] DOC: fix name collisions in generated API docs --- doc/user_guide/API.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/user_guide/API.rst b/doc/user_guide/API.rst index 154cecac1..6cc1f4497 100644 --- a/doc/user_guide/API.rst +++ b/doc/user_guide/API.rst @@ -14,7 +14,7 @@ Top-Level Objects .. currentmodule:: altair .. autosummary:: - :toctree: generated/ + :toctree: generated/toplevel/ :nosignatures: Chart @@ -29,7 +29,7 @@ Encoding Channels .. currentmodule:: altair .. autosummary:: - :toctree: generated/ + :toctree: generated/channels/ :nosignatures: Color @@ -73,7 +73,7 @@ API Functions .. currentmodule:: altair .. autosummary:: - :toctree: generated/ + :toctree: generated/api/ :nosignatures: layer @@ -98,7 +98,7 @@ Low-Level Schema Wrappers .. currentmodule:: altair .. autosummary:: - :toctree: generated/ + :toctree: generated/core/ :nosignatures: Aggregate From 13a9b26e1f6fe171f2c49d7e6281b394d69eaea5 Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Wed, 1 Aug 2018 09:00:31 -0700 Subject: [PATCH 5/6] DOC: fix links and cross-references in generated docstrings --- altair/vega/v2/schema/core.py | 419 ++--- altair/vega/v3/schema/core.py | 808 ++++----- altair/vega/v4/schema/core.py | 877 +++++----- altair/vegalite/v1/schema/channels.py | 172 +- altair/vegalite/v1/schema/core.py | 232 +-- altair/vegalite/v2/schema/channels.py | 833 ++++----- altair/vegalite/v2/schema/core.py | 2231 +++++++++++++------------ tools/generate_schema_wrapper.py | 2 + tools/schemapi/utils.py | 6 +- 9 files changed, 2859 insertions(+), 2721 deletions(-) diff --git a/altair/vega/v2/schema/core.py b/altair/vega/v2/schema/core.py index 394f40fe3..f54154eeb 100644 --- a/altair/vega/v2/schema/core.py +++ b/altair/vega/v2/schema/core.py @@ -22,7 +22,7 @@ def _default_wrapper_classes(cls): class Root(VegaSchema): """Root schema wrapper - allOf(container, Mapping(required=[])) + allOf(:class:`container`, Mapping(required=[])) """ _schema = load_schema() _rootschema = _schema @@ -154,7 +154,7 @@ class mark(VegaSchema): type : enum('rect', 'symbol', 'path', 'arc', 'area', 'line', 'rule', 'image', 'text', 'group') - delay : numberValue + delay : :class:`numberValue` ease : enum('linear-in', 'linear-out', 'linear-in-out', 'linear-out-in', 'quad-in', 'quad-out', 'quad-in-out', 'quad-out-in', 'cubic-in', 'cubic-out', 'cubic-in-out', @@ -190,13 +190,13 @@ class container(VegaSchema): Attributes ---------- - axes : List(axis) + axes : List(:class:`axis`) - legends : List(legend) + legends : List(:class:`legend`) - marks : List(oneOf(groupMark, visualMark)) + marks : List(oneOf(:class:`groupMark`, :class:`visualMark`)) - scales : List(scale) + scales : List(:class:`scale`) scene : Mapping(required=[]) @@ -213,7 +213,7 @@ def __init__(self, axes=Undefined, legends=Undefined, marks=Undefined, scales=Un class groupMark(VegaSchema): """groupMark schema wrapper - allOf(Mapping(required=[type]), mark, container) + allOf(Mapping(required=[type]), :class:`mark`, :class:`container`) """ _schema = {'$ref': '#/defs/groupMark'} _rootschema = Root._schema @@ -230,7 +230,7 @@ def __init__(self, type=Undefined, axes=Undefined, delay=Undefined, ease=Undefin class visualMark(VegaSchema): """visualMark schema wrapper - allOf(not Mapping(required=[]), mark) + allOf(not Mapping(required=[]), :class:`mark`) """ _schema = {'$ref': '#/defs/visualMark'} _rootschema = Root._schema @@ -299,103 +299,107 @@ class propset(VegaSchema): Attributes ---------- - align : oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, - oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) + align : oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, + allOf(:class:`stringModifiers`, oneOf(:class:`signal`, Mapping(required=[value]), + Mapping(required=[field]), Mapping(required=[band]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band])))) - angle : numberValue + angle : :class:`numberValue` - baseline : oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, - oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) + baseline : oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, + allOf(:class:`stringModifiers`, oneOf(:class:`signal`, Mapping(required=[value]), + Mapping(required=[field]), Mapping(required=[band]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band])))) - clip : booleanValue + clip : :class:`booleanValue` - cursor : stringValue + cursor : :class:`stringValue` - dx : numberValue + dx : :class:`numberValue` - dy : numberValue + dy : :class:`numberValue` - endAngle : numberValue + endAngle : :class:`numberValue` - fill : colorValue + fill : :class:`colorValue` - fillOpacity : numberValue + fillOpacity : :class:`numberValue` - font : stringValue + font : :class:`stringValue` - fontSize : numberValue + fontSize : :class:`numberValue` - fontStyle : stringValue + fontStyle : :class:`stringValue` - fontWeight : stringValue + fontWeight : :class:`stringValue` - height : numberValue + height : :class:`numberValue` - innerRadius : numberValue + innerRadius : :class:`numberValue` - interpolate : oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, - oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) + interpolate : oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, + allOf(:class:`stringModifiers`, oneOf(:class:`signal`, Mapping(required=[value]), + Mapping(required=[field]), Mapping(required=[band]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band])))) - opacity : numberValue + opacity : :class:`numberValue` - orient : oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, - oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) + orient : oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, + allOf(:class:`stringModifiers`, oneOf(:class:`signal`, Mapping(required=[value]), + Mapping(required=[field]), Mapping(required=[band]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band])))) - outerRadius : numberValue + outerRadius : :class:`numberValue` - path : stringValue + path : :class:`stringValue` - radius : numberValue + radius : :class:`numberValue` - shape : anyOf(oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, - oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))), - stringValue) + shape : anyOf(oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, + allOf(:class:`stringModifiers`, oneOf(:class:`signal`, Mapping(required=[value]), + Mapping(required=[field]), Mapping(required=[band]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band])))), :class:`stringValue`) - size : numberValue + size : :class:`numberValue` - startAngle : numberValue + startAngle : :class:`numberValue` - stroke : colorValue + stroke : :class:`colorValue` - strokeDash : arrayValue + strokeDash : :class:`arrayValue` - strokeDashOffset : numberValue + strokeDashOffset : :class:`numberValue` - strokeOpacity : numberValue + strokeOpacity : :class:`numberValue` - strokeWidth : numberValue + strokeWidth : :class:`numberValue` - tension : numberValue + tension : :class:`numberValue` - text : stringValue + text : :class:`stringValue` - theta : numberValue + theta : :class:`numberValue` - url : stringValue + url : :class:`stringValue` - width : numberValue + width : :class:`numberValue` - x : numberValue + x : :class:`numberValue` - x2 : numberValue + x2 : :class:`numberValue` - xc : numberValue + xc : :class:`numberValue` - y : numberValue + y : :class:`numberValue` - y2 : numberValue + y2 : :class:`numberValue` - yc : numberValue + yc : :class:`numberValue` """ _schema = {'$ref': '#/defs/propset'} @@ -438,9 +442,9 @@ class signal(VegaSchema): init : Mapping(required=[]) - scale : scopedScale + scale : :class:`scopedScale` - streams : streams + streams : :class:`streams` verbose : boolean @@ -457,7 +461,7 @@ def __init__(self, name=Undefined, expr=Undefined, init=Undefined, scale=Undefin class spec(VegaSchema): """spec schema wrapper - allOf(container, Mapping(required=[])) + allOf(:class:`container`, Mapping(required=[])) """ _schema = {'$ref': '#/defs/spec'} _rootschema = Root._schema @@ -495,7 +499,7 @@ class aggregateTransform(VegaSchema): type : enum('aggregate') - groupby : List(oneOf(string, signal)) + groupby : List(oneOf(string, :class:`signal`)) A list of fields to split the data into groups. summarize : oneOf(Mapping(required=[]), List(Mapping(required=[field, ops]))) @@ -516,28 +520,28 @@ class binTransform(VegaSchema): Attributes ---------- - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The name of the field to bin values from. type : enum('bin') - base : oneOf(float, signal) + base : oneOf(float, :class:`signal`) The number base to use for automatic bin determination. - div : oneOf(List(float), signal) + div : oneOf(List(float), :class:`signal`) An array of scale factors indicating allowable subdivisions. - max : oneOf(float, signal) + max : oneOf(float, :class:`signal`) The maximum bin value to consider. - maxbins : oneOf(float, signal) + maxbins : oneOf(float, :class:`signal`) The maximum number of allowable bins. - min : oneOf(float, signal) + min : oneOf(float, :class:`signal`) The minimum bin value to consider. - minstep : oneOf(float, signal) + minstep : oneOf(float, :class:`signal`) A minimum allowable step size (particularly useful for integer values). output : Mapping(required=[]) Rename the output data fields - step : oneOf(float, signal) + step : oneOf(float, :class:`signal`) An exact step size to use between bins. If provided, options such as maxbins will be ignored. - steps : oneOf(List(float), signal) + steps : oneOf(List(float), :class:`signal`) An array of allowable step sizes to choose from. """ _schema = {'$ref': '#/defs/binTransform'} @@ -562,7 +566,7 @@ class crossTransform(VegaSchema): type : enum('cross') - diagonal : oneOf(boolean, signal) + diagonal : oneOf(boolean, :class:`signal`) If false, items along the "diagonal" of the cross-product (those elements with the same index in their respective array) will not be included in the output. filter : string @@ -592,15 +596,15 @@ class countpatternTransform(VegaSchema): type : enum('countpattern') - case : oneOf(enum('lower', 'upper', 'none'), signal) + case : oneOf(enum('lower', 'upper', 'none'), :class:`signal`) Text case transformation to apply. - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The field containing the text to analyze. output : Mapping(required=[]) Rename the output data fields - pattern : oneOf(string, signal) + pattern : oneOf(string, :class:`signal`) A regexp pattern for matching words in text. - stopwords : oneOf(string, signal) + stopwords : oneOf(string, :class:`signal`) A regexp pattern for matching stopwords to omit. """ _schema = {'$ref': '#/defs/countpatternTransform'} @@ -626,17 +630,17 @@ class linkpathTransform(VegaSchema): output : Mapping(required=[]) Rename the output data fields shape : oneOf(enum('line', 'curve', 'cornerX', 'cornerY', 'cornerR', 'diagonalX', - 'diagonalY', 'diagonalR'), signal) + 'diagonalY', 'diagonalR'), :class:`signal`) The path shape to use - sourceX : oneOf(string, signal) + sourceX : oneOf(string, :class:`signal`) The data field that references the source x-coordinate for this link. - sourceY : oneOf(string, signal) + sourceY : oneOf(string, :class:`signal`) The data field that references the source y-coordinate for this link. - targetX : oneOf(string, signal) + targetX : oneOf(string, :class:`signal`) The data field that references the target x-coordinate for this link. - targetY : oneOf(string, signal) + targetY : oneOf(string, :class:`signal`) The data field that references the target y-coordinate for this link. - tension : oneOf(float, signal) + tension : oneOf(float, :class:`signal`) A tension parameter for the "tightness" of "curve"-shaped links. """ _schema = {'$ref': '#/defs/linkpathTransform'} @@ -660,11 +664,11 @@ class facetTransform(VegaSchema): type : enum('facet') - groupby : List(oneOf(string, signal)) + groupby : List(oneOf(string, :class:`signal`)) A list of fields to split the data into groups. summarize : oneOf(Mapping(required=[]), List(Mapping(required=[field, ops]))) - transform : transform + transform : :class:`transform` """ _schema = {'$ref': '#/defs/facetTransform'} @@ -706,7 +710,7 @@ class foldTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(string, signal)), signal) + fields : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) type : enum('fold') @@ -733,35 +737,35 @@ class forceTransform(VegaSchema): The name of the link (edge) data set. type : enum('force') - active : signal + active : :class:`signal` A signal representing the active node. - alpha : oneOf(float, signal) + alpha : oneOf(float, :class:`signal`) A "temperature" parameter that determines how much node positions are adjusted at each step. - charge : oneOf(float, string, signal) + charge : oneOf(float, string, :class:`signal`) The strength of the charge each node exerts. - chargeDistance : oneOf(float, signal) + chargeDistance : oneOf(float, :class:`signal`) The maximum distance over which charge forces are applied. fixed : string The name of a datasource containing the IDs of nodes with fixed positions. - friction : oneOf(float, signal) + friction : oneOf(float, :class:`signal`) The strength of the friction force used to stabilize the layout. - gravity : oneOf(float, signal) + gravity : oneOf(float, :class:`signal`) The strength of the pseudo-gravity force that pulls nodes towards the center of the layout area. - interactive : oneOf(boolean, signal) + interactive : oneOf(boolean, :class:`signal`) Enables an interactive force-directed layout. - iterations : oneOf(float, signal) + iterations : oneOf(float, :class:`signal`) The number of iterations to run the force directed layout. - linkDistance : oneOf(float, string, signal) + linkDistance : oneOf(float, string, :class:`signal`) Determines the length of edges, in pixels. - linkStrength : oneOf(float, string, signal) + linkStrength : oneOf(float, string, :class:`signal`) Determines the tension of edges (the spring constant). output : Mapping(required=[]) Rename the output data fields - size : oneOf(List(oneOf(float, signal)), signal) + size : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The dimensions [width, height] of this force layout. - theta : oneOf(float, signal) + theta : oneOf(float, :class:`signal`) The theta parameter for the Barnes-Hut algorithm, which is used to compute charge forces between nodes. """ @@ -813,29 +817,29 @@ class geoTransform(VegaSchema): Attributes ---------- - lat : oneOf(string, signal) + lat : oneOf(string, :class:`signal`) The input latitude values. - lon : oneOf(string, signal) + lon : oneOf(string, :class:`signal`) The input longitude values. type : enum('geo') - center : oneOf(List(oneOf(float, signal)), signal) + center : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The center of the projection. - clipAngle : oneOf(float, signal) + clipAngle : oneOf(float, :class:`signal`) The clip angle of the projection. - clipExtent : oneOf(float, signal) + clipExtent : oneOf(float, :class:`signal`) The clip extent of the projection. output : Mapping(required=[]) Rename the output data fields - precision : oneOf(float, signal) + precision : oneOf(float, :class:`signal`) The desired precision of the projection. - projection : oneOf(string, signal) + projection : oneOf(string, :class:`signal`) The type of cartographic projection to use. - rotate : oneOf(float, signal) + rotate : oneOf(float, :class:`signal`) The rotation of the projection. - scale : oneOf(float, signal) + scale : oneOf(float, :class:`signal`) The scale of the projection. - translate : oneOf(List(oneOf(float, signal)), signal) + translate : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The translation of the projection. """ _schema = {'$ref': '#/defs/geoTransform'} @@ -861,25 +865,25 @@ class geopathTransform(VegaSchema): type : enum('geopath') - center : oneOf(List(oneOf(float, signal)), signal) + center : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The center of the projection. - clipAngle : oneOf(float, signal) + clipAngle : oneOf(float, :class:`signal`) The clip angle of the projection. - clipExtent : oneOf(float, signal) + clipExtent : oneOf(float, :class:`signal`) The clip extent of the projection. - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The data field containing GeoJSON Feature data. output : Mapping(required=[]) Rename the output data fields - precision : oneOf(float, signal) + precision : oneOf(float, :class:`signal`) The desired precision of the projection. - projection : oneOf(string, signal) + projection : oneOf(string, :class:`signal`) The type of cartographic projection to use. - rotate : oneOf(float, signal) + rotate : oneOf(float, :class:`signal`) The rotation of the projection. - scale : oneOf(float, signal) + scale : oneOf(float, :class:`signal`) The scale of the projection. - translate : oneOf(List(oneOf(float, signal)), signal) + translate : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The translation of the projection. """ _schema = {'$ref': '#/defs/geopathTransform'} @@ -904,23 +908,23 @@ class hierarchyTransform(VegaSchema): type : enum('hierarchy') - children : oneOf(string, signal) + children : oneOf(string, :class:`signal`) The data field for the children node array - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The value for the area of each leaf-level node for partition layouts. - mode : oneOf(enum('tidy', 'cluster', 'partition'), signal) + mode : oneOf(enum('tidy', 'cluster', 'partition'), :class:`signal`) The layout algorithm mode to use. - nodesize : oneOf(List(oneOf(float, signal)), signal) + nodesize : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) Sets a fixed x,y size for each node (overrides the size parameter) - orient : oneOf(enum('cartesian', 'radial'), signal) + orient : oneOf(enum('cartesian', 'radial'), :class:`signal`) The layout orientation to use. output : Mapping(required=[]) Rename the output data fields - parent : oneOf(string, signal) + parent : oneOf(string, :class:`signal`) The data field for the parent node - size : oneOf(List(oneOf(float, signal)), signal) + size : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The dimensions of the tree layout - sort : oneOf(List(oneOf(string, signal)), signal) + sort : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to use as sort criteria for sibling nodes. """ _schema = {'$ref': '#/defs/hierarchyTransform'} @@ -943,17 +947,17 @@ class imputeTransform(VegaSchema): Attributes ---------- - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The data field to impute. - groupby : oneOf(List(oneOf(string, signal)), signal) + groupby : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to group the data into series. - orderby : oneOf(List(oneOf(string, signal)), signal) + orderby : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to determine ordering within series. type : enum('impute') - method : oneOf(enum('value', 'mean', 'median', 'min', 'max'), signal) + method : oneOf(enum('value', 'mean', 'median', 'min', 'max'), :class:`signal`) The imputation method to use. - value : oneOf(float, string, boolean, None, signal) + value : oneOf(float, string, boolean, None, :class:`signal`) The value to use for missing data if the method is 'value'. """ _schema = {'$ref': '#/defs/imputeTransform'} @@ -974,7 +978,7 @@ class lookupTransform(VegaSchema): Attributes ---------- - keys : List(oneOf(string, signal)) + keys : List(oneOf(string, :class:`signal`)) One or more fields in the primary data set to match against the secondary data set. on : string The name of the secondary data set on which to lookup values. @@ -982,7 +986,7 @@ class lookupTransform(VegaSchema): default : Mapping(required=[]) The default value to use if a lookup match fails. - onKey : oneOf(string, signal) + onKey : oneOf(string, :class:`signal`) The key field to lookup, or null for index-based lookup. as : List(string) The names of the fields in which to store looked-up values. @@ -1007,16 +1011,16 @@ class pieTransform(VegaSchema): type : enum('pie') - endAngle : oneOf(float, signal) + endAngle : oneOf(float, :class:`signal`) - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The data values to encode as angular spans. If this property is omitted, all pie slices will have equal spans. output : Mapping(required=[]) Rename the output data fields - sort : oneOf(boolean, signal) + sort : oneOf(boolean, :class:`signal`) If true, will sort the data prior to computing angles. - startAngle : oneOf(float, signal) + startAngle : oneOf(float, :class:`signal`) """ _schema = {'$ref': '#/defs/pieTransform'} @@ -1039,10 +1043,10 @@ class rankTransform(VegaSchema): type : enum('rank') - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) A key field to used to rank tuples. If undefined, tuples will be ranked in their observed order. - normalize : oneOf(boolean, signal) + normalize : oneOf(boolean, :class:`signal`) If true, values of the output field will lie in the range [0, 1]. output : Mapping(required=[]) Rename the output data fields @@ -1085,17 +1089,17 @@ class stackTransform(VegaSchema): Attributes ---------- - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The data field that determines the thickness/height of stacks. - groupby : oneOf(List(oneOf(string, signal)), signal) + groupby : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to split the data into groups (stacks). type : enum('stack') - offset : oneOf(enum('zero', 'center', 'normalize'), signal) + offset : oneOf(enum('zero', 'center', 'normalize'), :class:`signal`) The baseline offset output : Mapping(required=[]) Rename the output data fields - sortby : oneOf(List(oneOf(string, signal)), signal) + sortby : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to determine the sort order of stacks. """ _schema = {'$ref': '#/defs/stackTransform'} @@ -1115,7 +1119,7 @@ class treeifyTransform(VegaSchema): Attributes ---------- - groupby : oneOf(List(oneOf(string, signal)), signal) + groupby : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) An ordered list of fields by which to group tuples into a tree. type : enum('treeify') @@ -1139,27 +1143,27 @@ class treemapTransform(VegaSchema): type : enum('treemap') - children : oneOf(string, signal) + children : oneOf(string, :class:`signal`) The data field for the children node array - field : oneOf(string, signal) + field : oneOf(string, :class:`signal`) The values to use to determine the area of each leaf-level treemap cell. - mode : oneOf(enum('squarify', 'slice', 'dice', 'slice-dice'), signal) + mode : oneOf(enum('squarify', 'slice', 'dice', 'slice-dice'), :class:`signal`) The treemap layout algorithm to use. output : Mapping(required=[]) Rename the output data fields - padding : oneOf(float, List(oneOf(float, signal)), signal) + padding : oneOf(float, List(oneOf(float, :class:`signal`)), :class:`signal`) he padding (in pixels) to provide around internal nodes in the treemap. - parent : oneOf(string, signal) + parent : oneOf(string, :class:`signal`) The data field for the parent node - ratio : oneOf(float, signal) + ratio : oneOf(float, :class:`signal`) The target aspect ratio for the layout to optimize. - round : oneOf(boolean, signal) + round : oneOf(boolean, :class:`signal`) If true, treemap cell dimensions will be rounded to integer pixels. - size : oneOf(List(oneOf(float, signal)), signal) + size : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The dimensions of the treemap layout - sort : oneOf(List(oneOf(string, signal)), signal) + sort : oneOf(List(oneOf(string, :class:`signal`)), :class:`signal`) A list of fields to use as sort criteria for sibling nodes. - sticky : oneOf(boolean, signal) + sticky : oneOf(boolean, :class:`signal`) If true, repeated runs of the treemap will use cached partition boundaries. """ _schema = {'$ref': '#/defs/treemapTransform'} @@ -1184,13 +1188,14 @@ class voronoiTransform(VegaSchema): type : enum('voronoi') - clipExtent : oneOf(List(oneOf(List(oneOf(float, signal)), signal)), signal) + clipExtent : oneOf(List(oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`)), + :class:`signal`) The min and max points at which to clip the voronoi diagram. output : Mapping(required=[]) Rename the output data fields - x : oneOf(string, signal) + x : oneOf(string, :class:`signal`) The input x coordinates. - y : oneOf(string, signal) + y : oneOf(string, :class:`signal`) The input y coordinates. """ _schema = {'$ref': '#/defs/voronoiTransform'} @@ -1212,33 +1217,36 @@ class wordcloudTransform(VegaSchema): type : enum('wordcloud') - font : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), signal) + font : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), + :class:`signal`) The font face to use for a word. - fontScale : oneOf(None, List(oneOf(float, signal))) + fontScale : oneOf(None, List(oneOf(float, :class:`signal`))) The minimum and maximum scaled font sizes, or null to prevent scaling. fontSize : oneOf(float, oneOf(Mapping(required=[field]), Mapping(required=[value])), string, - signal) + :class:`signal`) The font size to use for a word. fontStyle : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), - signal) + :class:`signal`) The font style to use for a word. fontWeight : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), - signal) + :class:`signal`) The font weight to use for a word. output : Mapping(required=[]) Rename the output data fields - padding : oneOf(float, oneOf(Mapping(required=[field]), Mapping(required=[value])), signal) + padding : oneOf(float, oneOf(Mapping(required=[field]), Mapping(required=[value])), + :class:`signal`) The padding around each word. rotate : oneOf(float, string, oneOf(Mapping(required=[field]), Mapping(required=[value])), - signal) + :class:`signal`) The field or number to set the roration angle (in degrees). - size : oneOf(List(oneOf(float, signal)), signal) + size : oneOf(List(oneOf(float, :class:`signal`)), :class:`signal`) The dimensions of the wordcloud layout spiral : oneOf(enum('archimedean', 'rectangular'), oneOf(Mapping(required=[field]), - Mapping(required=[value])), signal) + Mapping(required=[value])), :class:`signal`) The type of spiral used for positioning words, either 'archimedean' or 'rectangular'. - text : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), signal) + text : oneOf(string, oneOf(Mapping(required=[field]), Mapping(required=[value])), + :class:`signal`) The field containing the text to use for each word. """ _schema = {'$ref': '#/defs/wordcloudTransform'} @@ -1257,11 +1265,14 @@ def __init__(self, type=Undefined, font=Undefined, fontScale=Undefined, fontSize class transform(VegaSchema): """transform schema wrapper - List(oneOf(aggregateTransform, binTransform, crossTransform, countpatternTransform, - linkpathTransform, facetTransform, filterTransform, foldTransform, forceTransform, - formulaTransform, geoTransform, geopathTransform, hierarchyTransform, imputeTransform, - lookupTransform, pieTransform, rankTransform, sortTransform, stackTransform, - treeifyTransform, treemapTransform, voronoiTransform, wordcloudTransform)) + List(oneOf(:class:`aggregateTransform`, :class:`binTransform`, :class:`crossTransform`, + :class:`countpatternTransform`, :class:`linkpathTransform`, :class:`facetTransform`, + :class:`filterTransform`, :class:`foldTransform`, :class:`forceTransform`, + :class:`formulaTransform`, :class:`geoTransform`, :class:`geopathTransform`, + :class:`hierarchyTransform`, :class:`imputeTransform`, :class:`lookupTransform`, + :class:`pieTransform`, :class:`rankTransform`, :class:`sortTransform`, + :class:`stackTransform`, :class:`treeifyTransform`, :class:`treemapTransform`, + :class:`voronoiTransform`, :class:`wordcloudTransform`)) """ _schema = {'$ref': '#/defs/transform'} _rootschema = Root._schema @@ -1290,7 +1301,7 @@ def __init__(self, name=Undefined, domain=Undefined, domainMax=Undefined, domain class operand(VegaSchema): """operand schema wrapper - oneOf(Mapping(required=[value]), Mapping(required=[arg]), signal, + oneOf(Mapping(required=[value]), Mapping(required=[arg]), :class:`signal`, Mapping(required=[predicate])) """ _schema = {'$ref': '#/refs/operand'} @@ -1303,7 +1314,7 @@ def __init__(self, *args, **kwds): class field(VegaSchema): """field schema wrapper - oneOf(string, oneOf(signal, Mapping(required=[datum]), Mapping(required=[group]), + oneOf(string, oneOf(:class:`signal`, Mapping(required=[datum]), Mapping(required=[group]), Mapping(required=[parent]))) """ _schema = {'$ref': '#/refs/field'} @@ -1316,7 +1327,7 @@ def __init__(self, *args, **kwds): class scale(VegaSchema): """scale schema wrapper - oneOf(field, Mapping(required=[name])) + oneOf(:class:`field`, Mapping(required=[name])) """ _schema = {'$ref': '#/refs/scale'} _rootschema = Root._schema @@ -1333,7 +1344,7 @@ class stringModifiers(VegaSchema): Attributes ---------- - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/stringModifiers'} @@ -1355,7 +1366,7 @@ class numberModifiers(VegaSchema): offset : float - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/numberModifiers'} @@ -1368,10 +1379,10 @@ def __init__(self, mult=Undefined, offset=Undefined, scale=Undefined, **kwds): class value(VegaSchema): """value schema wrapper - oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]))))), - allOf(stringModifiers, oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band])))) + oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]))))), allOf(:class:`stringModifiers`, oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) """ _schema = {'$ref': '#/refs/value'} _rootschema = Root._schema @@ -1383,10 +1394,10 @@ def __init__(self, *args, **kwds): class numberValue(VegaSchema): """numberValue schema wrapper - oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(numberModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]))))), - allOf(numberModifiers, oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band])))) + oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, allOf(:class:`numberModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]))))), allOf(:class:`numberModifiers`, oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) """ _schema = {'$ref': '#/refs/numberValue'} _rootschema = Root._schema @@ -1398,11 +1409,11 @@ def __init__(self, *args, **kwds): class stringValue(VegaSchema): """stringValue schema wrapper - oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]), - Mapping(required=[template]))))), allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]), - Mapping(required=[template])))) + oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]), Mapping(required=[template]))))), allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]), Mapping(required=[template])))) """ _schema = {'$ref': '#/refs/stringValue'} _rootschema = Root._schema @@ -1414,10 +1425,10 @@ def __init__(self, *args, **kwds): class booleanValue(VegaSchema): """booleanValue schema wrapper - oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]))))), - allOf(stringModifiers, oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band])))) + oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]))))), allOf(:class:`stringModifiers`, oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) """ _schema = {'$ref': '#/refs/booleanValue'} _rootschema = Root._schema @@ -1429,10 +1440,10 @@ def __init__(self, *args, **kwds): class arrayValue(VegaSchema): """arrayValue schema wrapper - oneOf(Mapping(required=[rule]), List(allOf(rule, allOf(stringModifiers, oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band]))))), - allOf(stringModifiers, oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[band])))) + oneOf(Mapping(required=[rule]), List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[band]))))), allOf(:class:`stringModifiers`, oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[band])))) """ _schema = {'$ref': '#/refs/arrayValue'} _rootschema = Root._schema @@ -1444,7 +1455,7 @@ def __init__(self, *args, **kwds): class colorValue(VegaSchema): """colorValue schema wrapper - oneOf(stringValue, Mapping(required=[r, g, b]), Mapping(required=[h, s, l]), + oneOf(:class:`stringValue`, Mapping(required=[r, g, b]), Mapping(required=[h, s, l]), Mapping(required=[l, a, b]), Mapping(required=[h, c, l])) """ _schema = {'$ref': '#/refs/colorValue'} diff --git a/altair/vega/v3/schema/core.py b/altair/vega/v3/schema/core.py index c113cf909..d464445a7 100644 --- a/altair/vega/v3/schema/core.py +++ b/altair/vega/v3/schema/core.py @@ -22,7 +22,7 @@ def _default_wrapper_classes(cls): class Root(VegaSchema): """Root schema wrapper - allOf(scope, Mapping(required=[])) + allOf(:class:`scope`, Mapping(required=[])) """ _schema = load_schema() _rootschema = _schema @@ -67,7 +67,7 @@ class axis(VegaSchema): encode : Mapping(required=[]) - format : stringOrSignal + format : :class:`stringOrSignal` grid : boolean @@ -85,25 +85,25 @@ class axis(VegaSchema): labels : boolean - maxExtent : oneOf(float, numberValue) + maxExtent : oneOf(float, :class:`numberValue`) - minExtent : oneOf(float, numberValue) + minExtent : oneOf(float, :class:`numberValue`) - offset : oneOf(float, numberValue) + offset : oneOf(float, :class:`numberValue`) - position : oneOf(float, numberValue) + position : oneOf(float, :class:`numberValue`) - tickCount : tickCount + tickCount : :class:`tickCount` tickSize : float ticks : boolean - title : stringOrSignal + title : :class:`stringOrSignal` - titlePadding : oneOf(float, numberValue) + titlePadding : oneOf(float, :class:`numberValue`) - values : oneOf(List(Mapping(required=[])), signal) + values : oneOf(List(Mapping(required=[])), :class:`signal`) zindex : float @@ -205,111 +205,111 @@ class encodeEntry(VegaSchema): Attributes ---------- - align : oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset]))))), allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset])))) + align : oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset])))) - angle : numberValue + angle : :class:`numberValue` - baseline : oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset]))))), allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset])))) + baseline : oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset])))) - clip : booleanValue + clip : :class:`booleanValue` - cursor : stringValue + cursor : :class:`stringValue` - dir : stringValue + dir : :class:`stringValue` - dx : numberValue + dx : :class:`numberValue` - dy : numberValue + dy : :class:`numberValue` - ellipsis : stringValue + ellipsis : :class:`stringValue` - endAngle : numberValue + endAngle : :class:`numberValue` - fill : colorValue + fill : :class:`colorValue` - fillOpacity : numberValue + fillOpacity : :class:`numberValue` - font : stringValue + font : :class:`stringValue` - fontSize : numberValue + fontSize : :class:`numberValue` - fontStyle : stringValue + fontStyle : :class:`stringValue` - fontWeight : fontWeightValue + fontWeight : :class:`fontWeightValue` - height : numberValue + height : :class:`numberValue` - innerRadius : numberValue + innerRadius : :class:`numberValue` - interpolate : stringValue + interpolate : :class:`stringValue` - limit : numberValue + limit : :class:`numberValue` - opacity : numberValue + opacity : :class:`numberValue` - orient : oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset]))))), allOf(stringModifiers, anyOf(oneOf(signal, - Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), - Mapping(required=[scale, value]), Mapping(required=[scale, band]), - Mapping(required=[offset])))) + orient : oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, + anyOf(oneOf(:class:`signal`, Mapping(required=[value]), Mapping(required=[field]), + Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, + band]), Mapping(required=[offset])))) - outerRadius : numberValue + outerRadius : :class:`numberValue` - path : stringValue + path : :class:`stringValue` - radius : numberValue + radius : :class:`numberValue` - shape : anyOf(string, stringValue) + shape : anyOf(string, :class:`stringValue`) - size : numberValue + size : :class:`numberValue` - startAngle : numberValue + startAngle : :class:`numberValue` - stroke : colorValue + stroke : :class:`colorValue` - strokeDash : arrayValue + strokeDash : :class:`arrayValue` - strokeDashOffset : numberValue + strokeDashOffset : :class:`numberValue` - strokeOpacity : numberValue + strokeOpacity : :class:`numberValue` - strokeWidth : numberValue + strokeWidth : :class:`numberValue` - tension : numberValue + tension : :class:`numberValue` - text : stringValue + text : :class:`stringValue` - theta : numberValue + theta : :class:`numberValue` - url : stringValue + url : :class:`stringValue` - width : numberValue + width : :class:`numberValue` - x : numberValue + x : :class:`numberValue` - x2 : numberValue + x2 : :class:`numberValue` - xc : numberValue + xc : :class:`numberValue` - y : numberValue + y : :class:`numberValue` - y2 : numberValue + y2 : :class:`numberValue` - yc : numberValue + yc : :class:`numberValue` """ _schema = {'$ref': '#/defs/encodeEntry'} @@ -356,7 +356,7 @@ def __init__(self, **kwds): class layout(VegaSchema): """layout schema wrapper - oneOf(Mapping(required=[]), signal) + oneOf(Mapping(required=[]), :class:`signal`) """ _schema = {'$ref': '#/defs/layout'} _rootschema = Root._schema @@ -377,7 +377,7 @@ class guideEncode(VegaSchema): name : string - style : style + style : :class:`style` """ _schema = {'$ref': '#/defs/guideEncode'} @@ -412,27 +412,27 @@ class mark(VegaSchema): Attributes ---------- - type : marktype + type : :class:`marktype` - clip : markclip + clip : :class:`markclip` - encode : encode + encode : :class:`encode` - interactive : booleanOrSignal + interactive : :class:`booleanOrSignal` key : string name : string - on : onMarkTrigger + on : :class:`onMarkTrigger` role : string - sort : compare + sort : :class:`compare` - style : style + style : :class:`style` - transform : List(transformMark) + transform : List(:class:`transformMark`) """ _schema = {'$ref': '#/defs/mark'} @@ -449,7 +449,7 @@ def __init__(self, type=Undefined, clip=Undefined, encode=Undefined, interactive class markGroup(VegaSchema): """markGroup schema wrapper - allOf(Mapping(required=[type]), mark, scope, Mapping(required=[])) + allOf(Mapping(required=[type]), :class:`mark`, :class:`scope`, Mapping(required=[])) """ _schema = {'$ref': '#/defs/markGroup'} _rootschema = Root._schema @@ -470,7 +470,7 @@ def __init__(self, type=Undefined, axes=Undefined, clip=Undefined, data=Undefine class markVisual(VegaSchema): """markVisual schema wrapper - allOf(not Mapping(required=[]), mark, Mapping(required=[])) + allOf(not Mapping(required=[]), :class:`mark`, Mapping(required=[])) """ _schema = {'$ref': '#/defs/markVisual'} _rootschema = Root._schema @@ -486,7 +486,7 @@ def __init__(self, type=Undefined, clip=Undefined, encode=Undefined, interactive class listener(VegaSchema): """listener schema wrapper - oneOf(signal, Mapping(required=[scale]), stream) + oneOf(:class:`signal`, Mapping(required=[scale]), :class:`stream`) """ _schema = {'$ref': '#/defs/listener'} _rootschema = Root._schema @@ -554,31 +554,32 @@ class projection(VegaSchema): name : string - center : oneOf(signal, List(numberOrSignal)) + center : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - clipAngle : numberOrSignal + clipAngle : :class:`numberOrSignal` - clipExtent : oneOf(signal, List(oneOf(signal, List(numberOrSignal)))) + clipExtent : oneOf(:class:`signal`, List(oneOf(:class:`signal`, + List(:class:`numberOrSignal`)))) - extent : oneOf(signal, List(oneOf(signal, List(numberOrSignal)))) + extent : oneOf(:class:`signal`, List(oneOf(:class:`signal`, List(:class:`numberOrSignal`)))) fit : oneOf(Mapping(required=[]), List(Mapping(required=[]))) - parallels : oneOf(signal, List(numberOrSignal)) + parallels : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - pointRadius : numberOrSignal + pointRadius : :class:`numberOrSignal` - precision : numberOrSignal + precision : :class:`numberOrSignal` - rotate : oneOf(signal, List(numberOrSignal)) + rotate : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - scale : numberOrSignal + scale : :class:`numberOrSignal` - size : oneOf(signal, List(numberOrSignal)) + size : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - translate : oneOf(signal, List(numberOrSignal)) + translate : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - type : stringOrSignal + type : :class:`stringOrSignal` """ _schema = {'$ref': '#/defs/projection'} @@ -622,25 +623,25 @@ class scope(VegaSchema): Attributes ---------- - axes : List(axis) + axes : List(:class:`axis`) - data : List(data) + data : List(:class:`data`) - encode : encode + encode : :class:`encode` - layout : layout + layout : :class:`layout` - legends : List(legend) + legends : List(:class:`legend`) - marks : List(oneOf(markGroup, markVisual)) + marks : List(oneOf(:class:`markGroup`, :class:`markVisual`)) - projections : List(projection) + projections : List(:class:`projection`) - scales : List(scale) + scales : List(:class:`scale`) - signals : List(signal) + signals : List(:class:`signal`) - title : title + title : :class:`title` """ _schema = {'$ref': '#/defs/scope'} @@ -657,7 +658,7 @@ def __init__(self, axes=Undefined, data=Undefined, encode=Undefined, layout=Unde class signal(VegaSchema): """signal schema wrapper - oneOf(signalPush, signalNew) + oneOf(:class:`signalPush`, :class:`signalNew`) """ _schema = {'$ref': '#/defs/signal'} _rootschema = Root._schema @@ -686,17 +687,17 @@ class signalNew(VegaSchema): Attributes ---------- - name : signalName + name : :class:`signalName` - bind : bind + bind : :class:`bind` description : string - on : onEvents + on : :class:`onEvents` react : boolean - update : exprString + update : :class:`exprString` value : Mapping(required=[]) @@ -718,13 +719,13 @@ class signalPush(VegaSchema): Attributes ---------- - name : signalName + name : :class:`signalName` push : enum('outer') description : string - on : onEvents + on : :class:`onEvents` """ _schema = {'$ref': '#/defs/signalPush'} @@ -742,13 +743,13 @@ class streamParams(VegaSchema): Attributes ---------- - between : List(stream) + between : List(:class:`stream`) consume : boolean debounce : float - filter : oneOf(exprString, List(exprString)) + filter : oneOf(:class:`exprString`, List(:class:`exprString`)) markname : string @@ -790,7 +791,7 @@ def __init__(self, type=Undefined, source=Undefined, **kwds): class stream(VegaSchema): """stream schema wrapper - allOf(streamParams, oneOf(streamEvents, Mapping(required=[stream]), + allOf(:class:`streamParams`, oneOf(:class:`streamEvents`, Mapping(required=[stream]), Mapping(required=[merge]))) """ _schema = {'$ref': '#/defs/stream'} @@ -829,15 +830,20 @@ def __init__(self, *args, **kwds): class transform(VegaSchema): """transform schema wrapper - oneOf(aggregateTransform, binTransform, collectTransform, countpatternTransform, - crossTransform, densityTransform, extentTransform, filterTransform, flattenTransform, - foldTransform, formulaTransform, imputeTransform, joinaggregateTransform, lookupTransform, - pivotTransform, projectTransform, sampleTransform, sequenceTransform, windowTransform, - identifierTransform, linkpathTransform, pieTransform, stackTransform, contourTransform, - geojsonTransform, geopathTransform, geopointTransform, geoshapeTransform, - graticuleTransform, forceTransform, nestTransform, packTransform, partitionTransform, - stratifyTransform, treeTransform, treelinksTransform, treemapTransform, voronoiTransform, - wordcloudTransform, crossfilterTransform, resolvefilterTransform) + oneOf(:class:`aggregateTransform`, :class:`binTransform`, :class:`collectTransform`, + :class:`countpatternTransform`, :class:`crossTransform`, :class:`densityTransform`, + :class:`extentTransform`, :class:`filterTransform`, :class:`flattenTransform`, + :class:`foldTransform`, :class:`formulaTransform`, :class:`imputeTransform`, + :class:`joinaggregateTransform`, :class:`lookupTransform`, :class:`pivotTransform`, + :class:`projectTransform`, :class:`sampleTransform`, :class:`sequenceTransform`, + :class:`windowTransform`, :class:`identifierTransform`, :class:`linkpathTransform`, + :class:`pieTransform`, :class:`stackTransform`, :class:`contourTransform`, + :class:`geojsonTransform`, :class:`geopathTransform`, :class:`geopointTransform`, + :class:`geoshapeTransform`, :class:`graticuleTransform`, :class:`forceTransform`, + :class:`nestTransform`, :class:`packTransform`, :class:`partitionTransform`, + :class:`stratifyTransform`, :class:`treeTransform`, :class:`treelinksTransform`, + :class:`treemapTransform`, :class:`voronoiTransform`, :class:`wordcloudTransform`, + :class:`crossfilterTransform`, :class:`resolvefilterTransform`) """ _schema = {'$ref': '#/defs/transform'} _rootschema = Root._schema @@ -849,12 +855,15 @@ def __init__(self, *args, **kwds): class transformMark(VegaSchema): """transformMark schema wrapper - oneOf(binTransform, collectTransform, extentTransform, formulaTransform, - joinaggregateTransform, lookupTransform, sampleTransform, windowTransform, - identifierTransform, linkpathTransform, pieTransform, stackTransform, geojsonTransform, - geopathTransform, geopointTransform, geoshapeTransform, forceTransform, packTransform, - partitionTransform, stratifyTransform, treeTransform, treemapTransform, voronoiTransform, - wordcloudTransform, crossfilterTransform, resolvefilterTransform) + oneOf(:class:`binTransform`, :class:`collectTransform`, :class:`extentTransform`, + :class:`formulaTransform`, :class:`joinaggregateTransform`, :class:`lookupTransform`, + :class:`sampleTransform`, :class:`windowTransform`, :class:`identifierTransform`, + :class:`linkpathTransform`, :class:`pieTransform`, :class:`stackTransform`, + :class:`geojsonTransform`, :class:`geopathTransform`, :class:`geopointTransform`, + :class:`geoshapeTransform`, :class:`forceTransform`, :class:`packTransform`, + :class:`partitionTransform`, :class:`stratifyTransform`, :class:`treeTransform`, + :class:`treemapTransform`, :class:`voronoiTransform`, :class:`wordcloudTransform`, + :class:`crossfilterTransform`, :class:`resolvefilterTransform`) """ _schema = {'$ref': '#/defs/transformMark'} _rootschema = Root._schema @@ -873,23 +882,26 @@ class aggregateTransform(VegaSchema): type : enum('aggregate') - cross : anyOf(boolean, signal) + cross : anyOf(boolean, :class:`signal`) - drop : anyOf(boolean, signal) + drop : anyOf(boolean, :class:`signal`) - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', - 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal)), signal) + 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/aggregateTransform'} @@ -910,33 +922,33 @@ class binTransform(VegaSchema): Attributes ---------- - extent : oneOf(List(anyOf(float, signal)), signal) + extent : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('bin') - anchor : anyOf(float, signal) + anchor : anyOf(float, :class:`signal`) - base : anyOf(float, signal) + base : anyOf(float, :class:`signal`) - divide : oneOf(List(anyOf(float, signal)), signal) + divide : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - maxbins : anyOf(float, signal) + maxbins : anyOf(float, :class:`signal`) - minstep : anyOf(float, signal) + minstep : anyOf(float, :class:`signal`) - name : anyOf(string, signal) + name : anyOf(string, :class:`signal`) - nice : anyOf(boolean, signal) + nice : anyOf(boolean, :class:`signal`) signal : string - step : anyOf(float, signal) + step : anyOf(float, :class:`signal`) - steps : oneOf(List(anyOf(float, signal)), signal) + steps : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/binTransform'} @@ -963,7 +975,7 @@ class collectTransform(VegaSchema): signal : string - sort : compare + sort : :class:`compare` """ _schema = {'$ref': '#/defs/collectTransform'} @@ -981,19 +993,19 @@ class countpatternTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('countpattern') - case : anyOf(enum('upper', 'lower', 'mixed'), signal) + case : anyOf(enum('upper', 'lower', 'mixed'), :class:`signal`) - pattern : anyOf(string, signal) + pattern : anyOf(string, :class:`signal`) signal : string - stopwords : anyOf(string, signal) + stopwords : anyOf(string, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/countpatternTransform'} @@ -1015,11 +1027,11 @@ class crossTransform(VegaSchema): type : enum('cross') - filter : exprString + filter : :class:`exprString` signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/crossTransform'} @@ -1042,15 +1054,15 @@ class densityTransform(VegaSchema): distribution : oneOf(Mapping(required=[function]), Mapping(required=[function]), Mapping(required=[function, field]), Mapping(required=[function])) - extent : oneOf(List(anyOf(float, signal)), signal) + extent : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - method : anyOf(string, signal) + method : anyOf(string, :class:`signal`) signal : string - steps : anyOf(float, signal) + steps : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/densityTransform'} @@ -1070,7 +1082,7 @@ class extentTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('extent') @@ -1092,7 +1104,7 @@ class filterTransform(VegaSchema): Attributes ---------- - expr : exprString + expr : :class:`exprString` type : enum('filter') @@ -1114,13 +1126,14 @@ class flattenTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) type : enum('flatten') signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/flattenTransform'} @@ -1138,13 +1151,14 @@ class foldTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) type : enum('fold') signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/foldTransform'} @@ -1162,15 +1176,15 @@ class formulaTransform(VegaSchema): Attributes ---------- - expr : exprString + expr : :class:`exprString` type : enum('formula') - initonly : anyOf(boolean, signal) + initonly : anyOf(boolean, :class:`signal`) signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/formulaTransform'} @@ -1189,17 +1203,18 @@ class imputeTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('impute') - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - keyvals : oneOf(List(Mapping(required=[])), signal) + keyvals : oneOf(List(Mapping(required=[])), :class:`signal`) - method : anyOf(enum('value', 'mean', 'median', 'max', 'min'), signal) + method : anyOf(enum('value', 'mean', 'median', 'max', 'min'), :class:`signal`) signal : string @@ -1226,19 +1241,22 @@ class joinaggregateTransform(VegaSchema): type : enum('joinaggregate') - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', - 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal)), signal) + 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/joinaggregateTransform'} @@ -1258,9 +1276,10 @@ class lookupTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('lookup') @@ -1268,9 +1287,10 @@ class lookupTransform(VegaSchema): signal : string - values : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + values : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) from : string @@ -1292,21 +1312,22 @@ class pivotTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('pivot') - value : oneOf(scaleField, paramField, expr) + value : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - limit : anyOf(float, signal) + limit : anyOf(float, :class:`signal`) op : anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', - 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal) + 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`) signal : string @@ -1330,11 +1351,12 @@ class projectTransform(VegaSchema): type : enum('project') - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/projectTransform'} @@ -1356,7 +1378,7 @@ class sampleTransform(VegaSchema): signal : string - size : anyOf(float, signal) + size : anyOf(float, :class:`signal`) """ _schema = {'$ref': '#/defs/sampleTransform'} @@ -1374,15 +1396,15 @@ class sequenceTransform(VegaSchema): Attributes ---------- - start : anyOf(float, signal) + start : anyOf(float, :class:`signal`) - stop : anyOf(float, signal) + stop : anyOf(float, :class:`signal`) type : enum('sequence') signal : string - step : anyOf(float, signal) + step : anyOf(float, :class:`signal`) """ _schema = {'$ref': '#/defs/sequenceTransform'} @@ -1404,27 +1426,29 @@ class windowTransform(VegaSchema): type : enum('window') - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - frame : oneOf(List(anyOf(float, signal, None)), signal) + frame : oneOf(List(anyOf(float, :class:`signal`, None)), :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - ignorePeers : anyOf(boolean, signal) + ignorePeers : anyOf(boolean, :class:`signal`) ops : oneOf(List(anyOf(enum('row_number', 'rank', 'dense_rank', 'percent_rank', 'cume_dist', 'ntile', 'lag', 'lead', 'first_value', 'last_value', 'nth_value', 'values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', - 'min', 'max'), signal)), signal) + 'min', 'max'), :class:`signal`)), :class:`signal`) - params : oneOf(List(anyOf(float, signal, None)), signal) + params : oneOf(List(anyOf(float, :class:`signal`, None)), :class:`signal`) signal : string - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/windowTransform'} @@ -1450,7 +1474,7 @@ class identifierTransform(VegaSchema): signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/identifierTransform'} @@ -1470,21 +1494,21 @@ class linkpathTransform(VegaSchema): type : enum('linkpath') - orient : anyOf(enum('horizontal', 'vertical', 'radial'), signal) + orient : anyOf(enum('horizontal', 'vertical', 'radial'), :class:`signal`) - shape : anyOf(enum('line', 'arc', 'curve', 'diagonal', 'orthogonal'), signal) + shape : anyOf(enum('line', 'arc', 'curve', 'diagonal', 'orthogonal'), :class:`signal`) signal : string - sourceX : oneOf(scaleField, paramField, expr) + sourceX : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - sourceY : oneOf(scaleField, paramField, expr) + sourceY : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - targetX : oneOf(scaleField, paramField, expr) + targetX : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - targetY : oneOf(scaleField, paramField, expr) + targetY : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/linkpathTransform'} @@ -1507,17 +1531,17 @@ class pieTransform(VegaSchema): type : enum('pie') - endAngle : anyOf(float, signal) + endAngle : anyOf(float, :class:`signal`) - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string - sort : anyOf(boolean, signal) + sort : anyOf(boolean, :class:`signal`) - startAngle : anyOf(float, signal) + startAngle : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/pieTransform'} @@ -1539,17 +1563,18 @@ class stackTransform(VegaSchema): type : enum('stack') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - offset : anyOf(enum('zero', 'center', 'normalize'), signal) + offset : anyOf(enum('zero', 'center', 'normalize'), :class:`signal`) signal : string - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/stackTransform'} @@ -1569,29 +1594,29 @@ class contourTransform(VegaSchema): Attributes ---------- - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) type : enum('contour') - bandwidth : anyOf(float, signal) + bandwidth : anyOf(float, :class:`signal`) - cellSize : anyOf(float, signal) + cellSize : anyOf(float, :class:`signal`) - count : anyOf(float, signal) + count : anyOf(float, :class:`signal`) - nice : anyOf(boolean, signal) + nice : anyOf(boolean, :class:`signal`) signal : string - smooth : anyOf(boolean, signal) + smooth : anyOf(boolean, :class:`signal`) - thresholds : oneOf(List(anyOf(float, signal)), signal) + thresholds : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - values : oneOf(List(anyOf(float, signal)), signal) + values : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - x : oneOf(scaleField, paramField, expr) + x : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - y : oneOf(scaleField, paramField, expr) + y : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) """ _schema = {'$ref': '#/defs/contourTransform'} @@ -1616,9 +1641,10 @@ class geojsonTransform(VegaSchema): type : enum('geojson') - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - geojson : oneOf(scaleField, paramField, expr) + geojson : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string @@ -1641,15 +1667,15 @@ class geopathTransform(VegaSchema): type : enum('geopath') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - pointRadius : anyOf(float, signal, expr, paramField) + pointRadius : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) projection : string signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/geopathTransform'} @@ -1669,7 +1695,8 @@ class geopointTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) projection : string @@ -1677,7 +1704,7 @@ class geopointTransform(VegaSchema): signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/geopointTransform'} @@ -1698,15 +1725,15 @@ class geoshapeTransform(VegaSchema): type : enum('geoshape') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - pointRadius : anyOf(float, signal, expr, paramField) + pointRadius : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) projection : string signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/geoshapeTransform'} @@ -1728,21 +1755,21 @@ class graticuleTransform(VegaSchema): type : enum('graticule') - extent : oneOf(List(Mapping(required=[])), signal) + extent : oneOf(List(Mapping(required=[])), :class:`signal`) - extentMajor : oneOf(List(Mapping(required=[])), signal) + extentMajor : oneOf(List(Mapping(required=[])), :class:`signal`) - extentMinor : oneOf(List(Mapping(required=[])), signal) + extentMinor : oneOf(List(Mapping(required=[])), :class:`signal`) - precision : anyOf(float, signal) + precision : anyOf(float, :class:`signal`) signal : string - step : oneOf(List(anyOf(float, signal)), signal) + step : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - stepMajor : oneOf(List(anyOf(float, signal)), signal) + stepMajor : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - stepMinor : oneOf(List(anyOf(float, signal)), signal) + stepMinor : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/graticuleTransform'} @@ -1767,27 +1794,27 @@ class forceTransform(VegaSchema): type : enum('force') - alpha : anyOf(float, signal) + alpha : anyOf(float, :class:`signal`) - alphaMin : anyOf(float, signal) + alphaMin : anyOf(float, :class:`signal`) - alphaTarget : anyOf(float, signal) + alphaTarget : anyOf(float, :class:`signal`) forces : List(oneOf(Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]))) - iterations : anyOf(float, signal) + iterations : anyOf(float, :class:`signal`) - restart : anyOf(boolean, signal) + restart : anyOf(boolean, :class:`signal`) signal : string - static : anyOf(boolean, signal) + static : anyOf(boolean, :class:`signal`) - velocityDecay : anyOf(float, signal) + velocityDecay : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/forceTransform'} @@ -1812,11 +1839,12 @@ class nestTransform(VegaSchema): type : enum('nest') - generate : anyOf(boolean, signal) + generate : anyOf(boolean, :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - keys : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + keys : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) signal : string @@ -1840,19 +1868,19 @@ class packTransform(VegaSchema): type : enum('pack') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - radius : oneOf(scaleField, paramField, expr) + radius : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/packTransform'} @@ -1874,19 +1902,19 @@ class partitionTransform(VegaSchema): type : enum('partition') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - round : anyOf(boolean, signal) + round : anyOf(boolean, :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/partitionTransform'} @@ -1906,9 +1934,9 @@ class stratifyTransform(VegaSchema): Attributes ---------- - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - parentKey : oneOf(scaleField, paramField, expr) + parentKey : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('stratify') @@ -1933,19 +1961,19 @@ class treeTransform(VegaSchema): type : enum('tree') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - method : anyOf(enum('tidy', 'cluster'), signal) + method : anyOf(enum('tidy', 'cluster'), :class:`signal`) - nodeSize : oneOf(List(anyOf(float, signal)), signal) + nodeSize : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/treeTransform'} @@ -1967,7 +1995,7 @@ class treelinksTransform(VegaSchema): type : enum('treelinks') - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string @@ -1989,36 +2017,36 @@ class treemapTransform(VegaSchema): type : enum('treemap') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) method : anyOf(enum('squarify', 'resquarify', 'binary', 'dice', 'slice', 'slicedice'), - signal) + :class:`signal`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - paddingBottom : anyOf(float, signal) + paddingBottom : anyOf(float, :class:`signal`) - paddingInner : anyOf(float, signal) + paddingInner : anyOf(float, :class:`signal`) - paddingLeft : anyOf(float, signal) + paddingLeft : anyOf(float, :class:`signal`) - paddingOuter : anyOf(float, signal) + paddingOuter : anyOf(float, :class:`signal`) - paddingRight : anyOf(float, signal) + paddingRight : anyOf(float, :class:`signal`) - paddingTop : anyOf(float, signal) + paddingTop : anyOf(float, :class:`signal`) - ratio : anyOf(float, signal) + ratio : anyOf(float, :class:`signal`) - round : anyOf(boolean, signal) + round : anyOf(boolean, :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/treemapTransform'} @@ -2046,17 +2074,17 @@ class voronoiTransform(VegaSchema): type : enum('voronoi') - x : oneOf(scaleField, paramField, expr) + x : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - y : oneOf(scaleField, paramField, expr) + y : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - extent : oneOf(List(Mapping(required=[])), signal) + extent : oneOf(List(Mapping(required=[])), :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/voronoiTransform'} @@ -2078,29 +2106,29 @@ class wordcloudTransform(VegaSchema): type : enum('wordcloud') - font : anyOf(string, signal, expr, paramField) + font : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - fontSize : anyOf(float, signal, expr, paramField) + fontSize : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) - fontSizeRange : oneOf(List(anyOf(float, signal)), signal, None) + fontSizeRange : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`, None) - fontStyle : anyOf(string, signal, expr, paramField) + fontStyle : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - fontWeight : anyOf(string, signal, expr, paramField) + fontWeight : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - padding : anyOf(float, signal, expr, paramField) + padding : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) - rotate : anyOf(float, signal, expr, paramField) + rotate : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - spiral : anyOf(string, signal) + spiral : anyOf(string, :class:`signal`) - text : oneOf(scaleField, paramField, expr) + text : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/wordcloudTransform'} @@ -2124,9 +2152,10 @@ class crossfilterTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - query : oneOf(List(Mapping(required=[])), signal) + query : oneOf(List(Mapping(required=[])), :class:`signal`) type : enum('crossfilter') @@ -2151,7 +2180,7 @@ class resolvefilterTransform(VegaSchema): filter : Mapping(required=[]) - ignore : anyOf(float, signal) + ignore : anyOf(float, :class:`signal`) type : enum('resolvefilter') @@ -2170,7 +2199,7 @@ class tickCount(VegaSchema): """tickCount schema wrapper oneOf(float, enum('millisecond', 'second', 'minute', 'hour', 'day', 'week', 'month', - 'year'), Mapping(required=[interval]), signal) + 'year'), Mapping(required=[interval]), :class:`signal`) """ _schema = {'$ref': '#/refs/tickCount'} _rootschema = Root._schema @@ -2212,7 +2241,7 @@ def __init__(self, field=Undefined, **kwds): class field(VegaSchema): """field schema wrapper - oneOf(string, oneOf(signal, Mapping(required=[datum]), Mapping(required=[group]), + oneOf(string, oneOf(:class:`signal`, Mapping(required=[datum]), Mapping(required=[group]), Mapping(required=[parent]))) """ _schema = {'$ref': '#/refs/field'} @@ -2225,7 +2254,7 @@ def __init__(self, *args, **kwds): class scale(VegaSchema): """scale schema wrapper - oneOf(string, oneOf(signal, Mapping(required=[datum]), Mapping(required=[group]), + oneOf(string, oneOf(:class:`signal`, Mapping(required=[datum]), Mapping(required=[group]), Mapping(required=[parent]))) """ _schema = {'$ref': '#/refs/scale'} @@ -2243,7 +2272,7 @@ class stringModifiers(VegaSchema): Attributes ---------- - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/stringModifiers'} @@ -2263,17 +2292,17 @@ class numberModifiers(VegaSchema): band : anyOf(float, boolean) - exponent : oneOf(float, numberValue) + exponent : oneOf(float, :class:`numberValue`) extra : boolean - mult : oneOf(float, numberValue) + mult : oneOf(float, :class:`numberValue`) - offset : oneOf(float, numberValue) + offset : oneOf(float, :class:`numberValue`) round : boolean - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/numberModifiers'} @@ -2288,12 +2317,13 @@ def __init__(self, band=Undefined, exponent=Undefined, extra=Undefined, mult=Und class value(VegaSchema): """value schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/value'} _rootschema = Root._schema @@ -2305,12 +2335,13 @@ def __init__(self, *args, **kwds): class numberValue(VegaSchema): """numberValue schema wrapper - oneOf(List(allOf(rule, allOf(numberModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(numberModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`numberModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`numberModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/numberValue'} _rootschema = Root._schema @@ -2322,12 +2353,13 @@ def __init__(self, *args, **kwds): class stringValue(VegaSchema): """stringValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/stringValue'} _rootschema = Root._schema @@ -2339,12 +2371,13 @@ def __init__(self, *args, **kwds): class booleanValue(VegaSchema): """booleanValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/booleanValue'} _rootschema = Root._schema @@ -2356,12 +2389,13 @@ def __init__(self, *args, **kwds): class arrayValue(VegaSchema): """arrayValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/arrayValue'} _rootschema = Root._schema @@ -2373,12 +2407,13 @@ def __init__(self, *args, **kwds): class nullableStringValue(VegaSchema): """nullableStringValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/nullableStringValue'} _rootschema = Root._schema @@ -2390,12 +2425,13 @@ def __init__(self, *args, **kwds): class fontWeightValue(VegaSchema): """fontWeightValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/fontWeightValue'} _rootschema = Root._schema @@ -2412,11 +2448,11 @@ class colorRGB(VegaSchema): Attributes ---------- - b : numberValue + b : :class:`numberValue` - g : numberValue + g : :class:`numberValue` - r : numberValue + r : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorRGB'} @@ -2434,11 +2470,11 @@ class colorHSL(VegaSchema): Attributes ---------- - h : numberValue + h : :class:`numberValue` - l : numberValue + l : :class:`numberValue` - s : numberValue + s : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorHSL'} @@ -2456,11 +2492,11 @@ class colorLAB(VegaSchema): Attributes ---------- - a : numberValue + a : :class:`numberValue` - b : numberValue + b : :class:`numberValue` - l : numberValue + l : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorLAB'} @@ -2478,11 +2514,11 @@ class colorHCL(VegaSchema): Attributes ---------- - c : numberValue + c : :class:`numberValue` - h : numberValue + h : :class:`numberValue` - l : numberValue + l : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorHCL'} @@ -2495,7 +2531,7 @@ def __init__(self, c=Undefined, h=Undefined, l=Undefined, **kwds): class colorValue(VegaSchema): """colorValue schema wrapper - oneOf(nullableStringValue, Mapping(required=[gradient]), Mapping(required=[color])) + oneOf(:class:`nullableStringValue`, Mapping(required=[gradient]), Mapping(required=[color])) """ _schema = {'$ref': '#/refs/colorValue'} _rootschema = Root._schema @@ -2588,7 +2624,7 @@ def __init__(self, facet=Undefined, data=Undefined, **kwds): class markclip(VegaSchema): """markclip schema wrapper - oneOf(booleanOrSignal, Mapping(required=[path]), Mapping(required=[sphere])) + oneOf(:class:`booleanOrSignal`, Mapping(required=[path]), Mapping(required=[sphere])) """ _schema = {'$ref': '#/refs/markclip'} _rootschema = Root._schema @@ -2624,7 +2660,7 @@ def __init__(self, *args): class sortOrder(VegaSchema): """sortOrder schema wrapper - oneOf(enum('ascending', 'descending'), signal) + oneOf(enum('ascending', 'descending'), :class:`signal`) """ _schema = {'$ref': '#/refs/sortOrder'} _rootschema = Root._schema @@ -2636,7 +2672,7 @@ def __init__(self, *args, **kwds): class scaleField(VegaSchema): """scaleField schema wrapper - oneOf(string, signal) + oneOf(string, :class:`signal`) """ _schema = {'$ref': '#/refs/scaleField'} _rootschema = Root._schema @@ -2648,7 +2684,7 @@ def __init__(self, *args, **kwds): class scaleInterpolate(VegaSchema): """scaleInterpolate schema wrapper - oneOf(string, signal, Mapping(required=[type])) + oneOf(string, :class:`signal`, Mapping(required=[type])) """ _schema = {'$ref': '#/refs/scaleInterpolate'} _rootschema = Root._schema @@ -2703,7 +2739,7 @@ def __init__(self, signal=Undefined, **kwds): class booleanOrSignal(VegaSchema): """booleanOrSignal schema wrapper - oneOf(boolean, signal) + oneOf(boolean, :class:`signal`) """ _schema = {'$ref': '#/refs/booleanOrSignal'} _rootschema = Root._schema @@ -2715,7 +2751,7 @@ def __init__(self, *args, **kwds): class numberOrSignal(VegaSchema): """numberOrSignal schema wrapper - oneOf(float, signal) + oneOf(float, :class:`signal`) """ _schema = {'$ref': '#/refs/numberOrSignal'} _rootschema = Root._schema @@ -2727,7 +2763,7 @@ def __init__(self, *args, **kwds): class stringOrSignal(VegaSchema): """stringOrSignal schema wrapper - oneOf(string, signal) + oneOf(string, :class:`signal`) """ _schema = {'$ref': '#/refs/stringOrSignal'} _rootschema = Root._schema diff --git a/altair/vega/v4/schema/core.py b/altair/vega/v4/schema/core.py index b0504765d..be931a916 100644 --- a/altair/vega/v4/schema/core.py +++ b/altair/vega/v4/schema/core.py @@ -22,7 +22,7 @@ def _default_wrapper_classes(cls): class Root(VegaSchema): """Root schema wrapper - allOf(scope, Mapping(required=[])) + allOf(:class:`scope`, Mapping(required=[])) """ _schema = load_schema() _rootschema = _schema @@ -63,111 +63,111 @@ class axis(VegaSchema): scale : string - bandPosition : oneOf(float, numberValue) + bandPosition : oneOf(float, :class:`numberValue`) domain : boolean - domainColor : oneOf(None, string, colorValue) + domainColor : oneOf(None, string, :class:`colorValue`) - domainWidth : oneOf(float, numberValue) + domainWidth : oneOf(float, :class:`numberValue`) encode : Mapping(required=[]) - format : stringOrSignal + format : :class:`stringOrSignal` grid : boolean - gridColor : oneOf(None, string, colorValue) + gridColor : oneOf(None, string, :class:`colorValue`) - gridDash : oneOf(List(float), arrayValue) + gridDash : oneOf(List(float), :class:`arrayValue`) - gridOpacity : oneOf(float, numberValue) + gridOpacity : oneOf(float, :class:`numberValue`) gridScale : string - gridWidth : oneOf(float, numberValue) + gridWidth : oneOf(float, :class:`numberValue`) - labelAlign : oneOf(enum('left', 'right', 'center'), alignValue) + labelAlign : oneOf(enum('left', 'right', 'center'), :class:`alignValue`) - labelAngle : oneOf(float, numberValue) + labelAngle : oneOf(float, :class:`numberValue`) - labelBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic'), baselineValue) + labelBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic'), :class:`baselineValue`) labelBound : oneOf(boolean, float) - labelColor : oneOf(None, string, colorValue) + labelColor : oneOf(None, string, :class:`colorValue`) labelFlush : oneOf(boolean, float) labelFlushOffset : float - labelFont : oneOf(string, stringValue) + labelFont : oneOf(string, :class:`stringValue`) - labelFontSize : oneOf(float, numberValue) + labelFontSize : oneOf(float, :class:`numberValue`) 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), fontWeightValue) + 900), :class:`fontWeightValue`) - labelLimit : oneOf(float, numberValue) + labelLimit : oneOf(float, :class:`numberValue`) - labelOverlap : labelOverlap + labelOverlap : :class:`labelOverlap` - labelPadding : oneOf(float, numberValue) + labelPadding : oneOf(float, :class:`numberValue`) labels : boolean - maxExtent : oneOf(float, numberValue) + maxExtent : oneOf(float, :class:`numberValue`) - minExtent : oneOf(float, numberValue) + minExtent : oneOf(float, :class:`numberValue`) - offset : oneOf(float, numberValue) + offset : oneOf(float, :class:`numberValue`) - position : oneOf(float, numberValue) + position : oneOf(float, :class:`numberValue`) - tickColor : oneOf(None, string, colorValue) + tickColor : oneOf(None, string, :class:`colorValue`) - tickCount : tickCount + tickCount : :class:`tickCount` - tickExtra : numberOrSignal + tickExtra : :class:`numberOrSignal` - tickOffset : oneOf(float, numberValue) + tickOffset : oneOf(float, :class:`numberValue`) - tickRound : oneOf(boolean, booleanValue) + tickRound : oneOf(boolean, :class:`booleanValue`) - tickSize : oneOf(float, numberValue) + tickSize : oneOf(float, :class:`numberValue`) - tickWidth : oneOf(float, numberValue) + tickWidth : oneOf(float, :class:`numberValue`) ticks : boolean - title : stringOrSignal + title : :class:`stringOrSignal` - titleAlign : oneOf(enum('left', 'right', 'center'), alignValue) + titleAlign : oneOf(enum('left', 'right', 'center'), :class:`alignValue`) - titleAngle : oneOf(float, numberValue) + titleAngle : oneOf(float, :class:`numberValue`) - titleBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic'), baselineValue) + titleBaseline : oneOf(enum('top', 'middle', 'bottom', 'alphabetic'), :class:`baselineValue`) - titleColor : oneOf(None, string, colorValue) + titleColor : oneOf(None, string, :class:`colorValue`) - titleFont : oneOf(string, stringValue) + titleFont : oneOf(string, :class:`stringValue`) - titleFontSize : oneOf(float, numberValue) + titleFontSize : oneOf(float, :class:`numberValue`) 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), fontWeightValue) + 900), :class:`fontWeightValue`) - titleLimit : oneOf(float, numberValue) + titleLimit : oneOf(float, :class:`numberValue`) - titlePadding : oneOf(float, numberValue) + titlePadding : oneOf(float, :class:`numberValue`) - titleX : oneOf(float, numberValue) + titleX : oneOf(float, :class:`numberValue`) - titleY : oneOf(float, numberValue) + titleY : oneOf(float, :class:`numberValue`) - values : arrayOrSignal + values : :class:`arrayOrSignal` zindex : float @@ -289,93 +289,93 @@ class encodeEntry(VegaSchema): Attributes ---------- - align : alignValue + align : :class:`alignValue` - angle : numberValue + angle : :class:`numberValue` - baseline : baselineValue + baseline : :class:`baselineValue` - clip : booleanValue + clip : :class:`booleanValue` - cursor : stringValue + cursor : :class:`stringValue` - dir : stringValue + dir : :class:`stringValue` - dx : numberValue + dx : :class:`numberValue` - dy : numberValue + dy : :class:`numberValue` - ellipsis : stringValue + ellipsis : :class:`stringValue` - endAngle : numberValue + endAngle : :class:`numberValue` - fill : colorValue + fill : :class:`colorValue` - fillOpacity : numberValue + fillOpacity : :class:`numberValue` - font : stringValue + font : :class:`stringValue` - fontSize : numberValue + fontSize : :class:`numberValue` - fontStyle : stringValue + fontStyle : :class:`stringValue` - fontWeight : fontWeightValue + fontWeight : :class:`fontWeightValue` - height : numberValue + height : :class:`numberValue` - innerRadius : numberValue + innerRadius : :class:`numberValue` - interpolate : stringValue + interpolate : :class:`stringValue` - limit : numberValue + limit : :class:`numberValue` - opacity : numberValue + opacity : :class:`numberValue` - orient : orientValue + orient : :class:`orientValue` - outerRadius : numberValue + outerRadius : :class:`numberValue` - path : stringValue + path : :class:`stringValue` - radius : numberValue + radius : :class:`numberValue` - shape : stringValue + shape : :class:`stringValue` - size : numberValue + size : :class:`numberValue` - startAngle : numberValue + startAngle : :class:`numberValue` - stroke : colorValue + stroke : :class:`colorValue` - strokeDash : arrayValue + strokeDash : :class:`arrayValue` - strokeDashOffset : numberValue + strokeDashOffset : :class:`numberValue` - strokeOpacity : numberValue + strokeOpacity : :class:`numberValue` - strokeWidth : numberValue + strokeWidth : :class:`numberValue` - tension : numberValue + tension : :class:`numberValue` - text : stringValue + text : :class:`stringValue` - theta : numberValue + theta : :class:`numberValue` - url : stringValue + url : :class:`stringValue` - width : numberValue + width : :class:`numberValue` - x : numberValue + x : :class:`numberValue` - x2 : numberValue + x2 : :class:`numberValue` - xc : numberValue + xc : :class:`numberValue` - y : numberValue + y : :class:`numberValue` - y2 : numberValue + y2 : :class:`numberValue` - yc : numberValue + yc : :class:`numberValue` """ _schema = {'$ref': '#/defs/encodeEntry'} @@ -422,7 +422,7 @@ def __init__(self, **kwds): class layout(VegaSchema): """layout schema wrapper - oneOf(Mapping(required=[]), signal) + oneOf(Mapping(required=[]), :class:`signal`) """ _schema = {'$ref': '#/defs/layout'} _rootschema = Root._schema @@ -443,7 +443,7 @@ class guideEncode(VegaSchema): name : string - style : style + style : :class:`style` """ _schema = {'$ref': '#/defs/guideEncode'} @@ -478,27 +478,27 @@ class mark(VegaSchema): Attributes ---------- - type : marktype + type : :class:`marktype` - clip : markclip + clip : :class:`markclip` - encode : encode + encode : :class:`encode` - interactive : booleanOrSignal + interactive : :class:`booleanOrSignal` key : string name : string - on : onMarkTrigger + on : :class:`onMarkTrigger` role : string - sort : compare + sort : :class:`compare` - style : style + style : :class:`style` - transform : List(transformMark) + transform : List(:class:`transformMark`) """ _schema = {'$ref': '#/defs/mark'} @@ -515,7 +515,7 @@ def __init__(self, type=Undefined, clip=Undefined, encode=Undefined, interactive class markGroup(VegaSchema): """markGroup schema wrapper - allOf(Mapping(required=[type]), mark, scope, Mapping(required=[])) + allOf(Mapping(required=[type]), :class:`mark`, :class:`scope`, Mapping(required=[])) """ _schema = {'$ref': '#/defs/markGroup'} _rootschema = Root._schema @@ -536,7 +536,7 @@ def __init__(self, type=Undefined, axes=Undefined, clip=Undefined, data=Undefine class markVisual(VegaSchema): """markVisual schema wrapper - allOf(not Mapping(required=[]), mark, Mapping(required=[])) + allOf(not Mapping(required=[]), :class:`mark`, Mapping(required=[])) """ _schema = {'$ref': '#/defs/markVisual'} _rootschema = Root._schema @@ -552,7 +552,7 @@ def __init__(self, type=Undefined, clip=Undefined, encode=Undefined, interactive class listener(VegaSchema): """listener schema wrapper - oneOf(signal, Mapping(required=[scale]), stream) + oneOf(:class:`signal`, Mapping(required=[scale]), :class:`stream`) """ _schema = {'$ref': '#/defs/listener'} _rootschema = Root._schema @@ -620,31 +620,32 @@ class projection(VegaSchema): name : string - center : oneOf(signal, List(numberOrSignal)) + center : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - clipAngle : numberOrSignal + clipAngle : :class:`numberOrSignal` - clipExtent : oneOf(signal, List(oneOf(signal, List(numberOrSignal)))) + clipExtent : oneOf(:class:`signal`, List(oneOf(:class:`signal`, + List(:class:`numberOrSignal`)))) - extent : oneOf(signal, List(oneOf(signal, List(numberOrSignal)))) + extent : oneOf(:class:`signal`, List(oneOf(:class:`signal`, List(:class:`numberOrSignal`)))) fit : oneOf(Mapping(required=[]), List(Mapping(required=[]))) - parallels : oneOf(signal, List(numberOrSignal)) + parallels : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - pointRadius : numberOrSignal + pointRadius : :class:`numberOrSignal` - precision : numberOrSignal + precision : :class:`numberOrSignal` - rotate : oneOf(signal, List(numberOrSignal)) + rotate : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - scale : numberOrSignal + scale : :class:`numberOrSignal` - size : oneOf(signal, List(numberOrSignal)) + size : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - translate : oneOf(signal, List(numberOrSignal)) + translate : oneOf(:class:`signal`, List(:class:`numberOrSignal`)) - type : stringOrSignal + type : :class:`stringOrSignal` """ _schema = {'$ref': '#/defs/projection'} @@ -688,25 +689,25 @@ class scope(VegaSchema): Attributes ---------- - axes : List(axis) + axes : List(:class:`axis`) - data : List(data) + data : List(:class:`data`) - encode : encode + encode : :class:`encode` - layout : layout + layout : :class:`layout` - legends : List(legend) + legends : List(:class:`legend`) - marks : List(oneOf(markGroup, markVisual)) + marks : List(oneOf(:class:`markGroup`, :class:`markVisual`)) - projections : List(projection) + projections : List(:class:`projection`) - scales : List(scale) + scales : List(:class:`scale`) - signals : List(signal) + signals : List(:class:`signal`) - title : title + title : :class:`title` """ _schema = {'$ref': '#/defs/scope'} @@ -723,7 +724,7 @@ def __init__(self, axes=Undefined, data=Undefined, encode=Undefined, layout=Unde class signal(VegaSchema): """signal schema wrapper - oneOf(signalPush, signalNew) + oneOf(:class:`signalPush`, :class:`signalNew`) """ _schema = {'$ref': '#/defs/signal'} _rootschema = Root._schema @@ -752,17 +753,17 @@ class signalNew(VegaSchema): Attributes ---------- - name : signalName + name : :class:`signalName` - bind : bind + bind : :class:`bind` description : string - on : onEvents + on : :class:`onEvents` react : boolean - update : exprString + update : :class:`exprString` value : Mapping(required=[]) @@ -784,13 +785,13 @@ class signalPush(VegaSchema): Attributes ---------- - name : signalName + name : :class:`signalName` push : enum('outer') description : string - on : onEvents + on : :class:`onEvents` """ _schema = {'$ref': '#/defs/signalPush'} @@ -808,13 +809,13 @@ class streamParams(VegaSchema): Attributes ---------- - between : List(stream) + between : List(:class:`stream`) consume : boolean debounce : float - filter : oneOf(exprString, List(exprString)) + filter : oneOf(:class:`exprString`, List(:class:`exprString`)) markname : string @@ -856,7 +857,7 @@ def __init__(self, type=Undefined, source=Undefined, **kwds): class stream(VegaSchema): """stream schema wrapper - allOf(streamParams, oneOf(streamEvents, Mapping(required=[stream]), + allOf(:class:`streamParams`, oneOf(:class:`streamEvents`, Mapping(required=[stream]), Mapping(required=[merge]))) """ _schema = {'$ref': '#/defs/stream'} @@ -895,15 +896,20 @@ def __init__(self, *args, **kwds): class transform(VegaSchema): """transform schema wrapper - oneOf(aggregateTransform, binTransform, collectTransform, countpatternTransform, - crossTransform, densityTransform, extentTransform, filterTransform, flattenTransform, - foldTransform, formulaTransform, imputeTransform, joinaggregateTransform, lookupTransform, - pivotTransform, projectTransform, sampleTransform, sequenceTransform, windowTransform, - identifierTransform, linkpathTransform, pieTransform, stackTransform, contourTransform, - geojsonTransform, geopathTransform, geopointTransform, geoshapeTransform, - graticuleTransform, forceTransform, nestTransform, packTransform, partitionTransform, - stratifyTransform, treeTransform, treelinksTransform, treemapTransform, voronoiTransform, - wordcloudTransform, crossfilterTransform, resolvefilterTransform) + oneOf(:class:`aggregateTransform`, :class:`binTransform`, :class:`collectTransform`, + :class:`countpatternTransform`, :class:`crossTransform`, :class:`densityTransform`, + :class:`extentTransform`, :class:`filterTransform`, :class:`flattenTransform`, + :class:`foldTransform`, :class:`formulaTransform`, :class:`imputeTransform`, + :class:`joinaggregateTransform`, :class:`lookupTransform`, :class:`pivotTransform`, + :class:`projectTransform`, :class:`sampleTransform`, :class:`sequenceTransform`, + :class:`windowTransform`, :class:`identifierTransform`, :class:`linkpathTransform`, + :class:`pieTransform`, :class:`stackTransform`, :class:`contourTransform`, + :class:`geojsonTransform`, :class:`geopathTransform`, :class:`geopointTransform`, + :class:`geoshapeTransform`, :class:`graticuleTransform`, :class:`forceTransform`, + :class:`nestTransform`, :class:`packTransform`, :class:`partitionTransform`, + :class:`stratifyTransform`, :class:`treeTransform`, :class:`treelinksTransform`, + :class:`treemapTransform`, :class:`voronoiTransform`, :class:`wordcloudTransform`, + :class:`crossfilterTransform`, :class:`resolvefilterTransform`) """ _schema = {'$ref': '#/defs/transform'} _rootschema = Root._schema @@ -915,12 +921,15 @@ def __init__(self, *args, **kwds): class transformMark(VegaSchema): """transformMark schema wrapper - oneOf(binTransform, collectTransform, extentTransform, formulaTransform, - joinaggregateTransform, lookupTransform, sampleTransform, windowTransform, - identifierTransform, linkpathTransform, pieTransform, stackTransform, geojsonTransform, - geopathTransform, geopointTransform, geoshapeTransform, forceTransform, packTransform, - partitionTransform, stratifyTransform, treeTransform, treemapTransform, voronoiTransform, - wordcloudTransform, crossfilterTransform, resolvefilterTransform) + oneOf(:class:`binTransform`, :class:`collectTransform`, :class:`extentTransform`, + :class:`formulaTransform`, :class:`joinaggregateTransform`, :class:`lookupTransform`, + :class:`sampleTransform`, :class:`windowTransform`, :class:`identifierTransform`, + :class:`linkpathTransform`, :class:`pieTransform`, :class:`stackTransform`, + :class:`geojsonTransform`, :class:`geopathTransform`, :class:`geopointTransform`, + :class:`geoshapeTransform`, :class:`forceTransform`, :class:`packTransform`, + :class:`partitionTransform`, :class:`stratifyTransform`, :class:`treeTransform`, + :class:`treemapTransform`, :class:`voronoiTransform`, :class:`wordcloudTransform`, + :class:`crossfilterTransform`, :class:`resolvefilterTransform`) """ _schema = {'$ref': '#/defs/transformMark'} _rootschema = Root._schema @@ -939,23 +948,26 @@ class aggregateTransform(VegaSchema): type : enum('aggregate') - cross : anyOf(boolean, signal) + cross : anyOf(boolean, :class:`signal`) - drop : anyOf(boolean, signal) + drop : anyOf(boolean, :class:`signal`) - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', - 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal)), signal) + 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/aggregateTransform'} @@ -976,33 +988,33 @@ class binTransform(VegaSchema): Attributes ---------- - extent : oneOf(List(anyOf(float, signal)), signal) + extent : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('bin') - anchor : anyOf(float, signal) + anchor : anyOf(float, :class:`signal`) - base : anyOf(float, signal) + base : anyOf(float, :class:`signal`) - divide : oneOf(List(anyOf(float, signal)), signal) + divide : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - maxbins : anyOf(float, signal) + maxbins : anyOf(float, :class:`signal`) - minstep : anyOf(float, signal) + minstep : anyOf(float, :class:`signal`) - name : anyOf(string, signal) + name : anyOf(string, :class:`signal`) - nice : anyOf(boolean, signal) + nice : anyOf(boolean, :class:`signal`) signal : string - step : anyOf(float, signal) + step : anyOf(float, :class:`signal`) - steps : oneOf(List(anyOf(float, signal)), signal) + steps : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/binTransform'} @@ -1029,7 +1041,7 @@ class collectTransform(VegaSchema): signal : string - sort : compare + sort : :class:`compare` """ _schema = {'$ref': '#/defs/collectTransform'} @@ -1047,19 +1059,19 @@ class countpatternTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('countpattern') - case : anyOf(enum('upper', 'lower', 'mixed'), signal) + case : anyOf(enum('upper', 'lower', 'mixed'), :class:`signal`) - pattern : anyOf(string, signal) + pattern : anyOf(string, :class:`signal`) signal : string - stopwords : anyOf(string, signal) + stopwords : anyOf(string, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/countpatternTransform'} @@ -1081,11 +1093,11 @@ class crossTransform(VegaSchema): type : enum('cross') - filter : exprString + filter : :class:`exprString` signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/crossTransform'} @@ -1108,15 +1120,15 @@ class densityTransform(VegaSchema): distribution : oneOf(Mapping(required=[function]), Mapping(required=[function]), Mapping(required=[function, field]), Mapping(required=[function])) - extent : oneOf(List(anyOf(float, signal)), signal) + extent : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - method : anyOf(string, signal) + method : anyOf(string, :class:`signal`) signal : string - steps : anyOf(float, signal) + steps : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/densityTransform'} @@ -1136,7 +1148,7 @@ class extentTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('extent') @@ -1158,7 +1170,7 @@ class filterTransform(VegaSchema): Attributes ---------- - expr : exprString + expr : :class:`exprString` type : enum('filter') @@ -1180,13 +1192,14 @@ class flattenTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) type : enum('flatten') signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/flattenTransform'} @@ -1204,13 +1217,14 @@ class foldTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) type : enum('fold') signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/foldTransform'} @@ -1228,15 +1242,15 @@ class formulaTransform(VegaSchema): Attributes ---------- - expr : exprString + expr : :class:`exprString` type : enum('formula') - initonly : anyOf(boolean, signal) + initonly : anyOf(boolean, :class:`signal`) signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/formulaTransform'} @@ -1255,17 +1269,18 @@ class imputeTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('impute') - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - keyvals : oneOf(List(Mapping(required=[])), signal) + keyvals : oneOf(List(Mapping(required=[])), :class:`signal`) - method : anyOf(enum('value', 'mean', 'median', 'max', 'min'), signal) + method : anyOf(enum('value', 'mean', 'median', 'max', 'min'), :class:`signal`) signal : string @@ -1292,19 +1307,22 @@ class joinaggregateTransform(VegaSchema): type : enum('joinaggregate') - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) ops : oneOf(List(anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', - 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal)), signal) + 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/joinaggregateTransform'} @@ -1324,9 +1342,10 @@ class lookupTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('lookup') @@ -1334,9 +1353,10 @@ class lookupTransform(VegaSchema): signal : string - values : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + values : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) from : string @@ -1358,21 +1378,22 @@ class pivotTransform(VegaSchema): Attributes ---------- - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('pivot') - value : oneOf(scaleField, paramField, expr) + value : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - limit : anyOf(float, signal) + limit : anyOf(float, :class:`signal`) op : anyOf(enum('values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', - 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), signal) + 'median', 'q1', 'q3', 'argmin', 'argmax', 'min', 'max'), :class:`signal`) signal : string @@ -1396,11 +1417,12 @@ class projectTransform(VegaSchema): type : enum('project') - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) signal : string - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/projectTransform'} @@ -1422,7 +1444,7 @@ class sampleTransform(VegaSchema): signal : string - size : anyOf(float, signal) + size : anyOf(float, :class:`signal`) """ _schema = {'$ref': '#/defs/sampleTransform'} @@ -1440,15 +1462,15 @@ class sequenceTransform(VegaSchema): Attributes ---------- - start : anyOf(float, signal) + start : anyOf(float, :class:`signal`) - stop : anyOf(float, signal) + stop : anyOf(float, :class:`signal`) type : enum('sequence') signal : string - step : anyOf(float, signal) + step : anyOf(float, :class:`signal`) """ _schema = {'$ref': '#/defs/sequenceTransform'} @@ -1470,27 +1492,29 @@ class windowTransform(VegaSchema): type : enum('window') - fields : oneOf(List(oneOf(scaleField, paramField, expr, None)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`, None)), + :class:`signal`) - frame : oneOf(List(anyOf(float, signal, None)), signal) + frame : oneOf(List(anyOf(float, :class:`signal`, None)), :class:`signal`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - ignorePeers : anyOf(boolean, signal) + ignorePeers : anyOf(boolean, :class:`signal`) ops : oneOf(List(anyOf(enum('row_number', 'rank', 'dense_rank', 'percent_rank', 'cume_dist', 'ntile', 'lag', 'lead', 'first_value', 'last_value', 'nth_value', 'values', 'count', '__count__', 'missing', 'valid', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'stderr', 'distinct', 'ci0', 'ci1', 'median', 'q1', 'q3', 'argmin', 'argmax', - 'min', 'max'), signal)), signal) + 'min', 'max'), :class:`signal`)), :class:`signal`) - params : oneOf(List(anyOf(float, signal, None)), signal) + params : oneOf(List(anyOf(float, :class:`signal`, None)), :class:`signal`) signal : string - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal, None)), signal) + as : oneOf(List(anyOf(string, :class:`signal`, None)), :class:`signal`) """ _schema = {'$ref': '#/defs/windowTransform'} @@ -1516,7 +1540,7 @@ class identifierTransform(VegaSchema): signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/identifierTransform'} @@ -1536,21 +1560,21 @@ class linkpathTransform(VegaSchema): type : enum('linkpath') - orient : anyOf(enum('horizontal', 'vertical', 'radial'), signal) + orient : anyOf(enum('horizontal', 'vertical', 'radial'), :class:`signal`) - shape : anyOf(enum('line', 'arc', 'curve', 'diagonal', 'orthogonal'), signal) + shape : anyOf(enum('line', 'arc', 'curve', 'diagonal', 'orthogonal'), :class:`signal`) signal : string - sourceX : oneOf(scaleField, paramField, expr) + sourceX : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - sourceY : oneOf(scaleField, paramField, expr) + sourceY : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - targetX : oneOf(scaleField, paramField, expr) + targetX : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - targetY : oneOf(scaleField, paramField, expr) + targetY : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/linkpathTransform'} @@ -1573,17 +1597,17 @@ class pieTransform(VegaSchema): type : enum('pie') - endAngle : anyOf(float, signal) + endAngle : anyOf(float, :class:`signal`) - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string - sort : anyOf(boolean, signal) + sort : anyOf(boolean, :class:`signal`) - startAngle : anyOf(float, signal) + startAngle : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/pieTransform'} @@ -1605,17 +1629,18 @@ class stackTransform(VegaSchema): type : enum('stack') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - groupby : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + groupby : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - offset : anyOf(enum('zero', 'center', 'normalize'), signal) + offset : anyOf(enum('zero', 'center', 'normalize'), :class:`signal`) signal : string - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/stackTransform'} @@ -1635,31 +1660,31 @@ class contourTransform(VegaSchema): Attributes ---------- - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) type : enum('contour') - bandwidth : anyOf(float, signal) + bandwidth : anyOf(float, :class:`signal`) - cellSize : anyOf(float, signal) + cellSize : anyOf(float, :class:`signal`) - count : anyOf(float, signal) + count : anyOf(float, :class:`signal`) - nice : anyOf(boolean, signal) + nice : anyOf(boolean, :class:`signal`) signal : string - smooth : anyOf(boolean, signal) + smooth : anyOf(boolean, :class:`signal`) - thresholds : oneOf(List(anyOf(float, signal)), signal) + thresholds : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - values : oneOf(List(anyOf(float, signal)), signal) + values : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - weight : oneOf(scaleField, paramField, expr) + weight : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - x : oneOf(scaleField, paramField, expr) + x : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - y : oneOf(scaleField, paramField, expr) + y : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) """ _schema = {'$ref': '#/defs/contourTransform'} @@ -1685,9 +1710,10 @@ class geojsonTransform(VegaSchema): type : enum('geojson') - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - geojson : oneOf(scaleField, paramField, expr) + geojson : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string @@ -1710,15 +1736,15 @@ class geopathTransform(VegaSchema): type : enum('geopath') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - pointRadius : anyOf(float, signal, expr, paramField) + pointRadius : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) projection : string signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/geopathTransform'} @@ -1738,7 +1764,8 @@ class geopointTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) projection : string @@ -1746,7 +1773,7 @@ class geopointTransform(VegaSchema): signal : string - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/geopointTransform'} @@ -1767,15 +1794,15 @@ class geoshapeTransform(VegaSchema): type : enum('geoshape') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - pointRadius : anyOf(float, signal, expr, paramField) + pointRadius : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) projection : string signal : string - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/geoshapeTransform'} @@ -1797,21 +1824,21 @@ class graticuleTransform(VegaSchema): type : enum('graticule') - extent : oneOf(List(Mapping(required=[])), signal) + extent : oneOf(List(Mapping(required=[])), :class:`signal`) - extentMajor : oneOf(List(Mapping(required=[])), signal) + extentMajor : oneOf(List(Mapping(required=[])), :class:`signal`) - extentMinor : oneOf(List(Mapping(required=[])), signal) + extentMinor : oneOf(List(Mapping(required=[])), :class:`signal`) - precision : anyOf(float, signal) + precision : anyOf(float, :class:`signal`) signal : string - step : oneOf(List(anyOf(float, signal)), signal) + step : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - stepMajor : oneOf(List(anyOf(float, signal)), signal) + stepMajor : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - stepMinor : oneOf(List(anyOf(float, signal)), signal) + stepMinor : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/graticuleTransform'} @@ -1836,27 +1863,27 @@ class forceTransform(VegaSchema): type : enum('force') - alpha : anyOf(float, signal) + alpha : anyOf(float, :class:`signal`) - alphaMin : anyOf(float, signal) + alphaMin : anyOf(float, :class:`signal`) - alphaTarget : anyOf(float, signal) + alphaTarget : anyOf(float, :class:`signal`) forces : List(oneOf(Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]), Mapping(required=[force]))) - iterations : anyOf(float, signal) + iterations : anyOf(float, :class:`signal`) - restart : anyOf(boolean, signal) + restart : anyOf(boolean, :class:`signal`) signal : string - static : anyOf(boolean, signal) + static : anyOf(boolean, :class:`signal`) - velocityDecay : anyOf(float, signal) + velocityDecay : anyOf(float, :class:`signal`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/forceTransform'} @@ -1881,9 +1908,10 @@ class nestTransform(VegaSchema): type : enum('nest') - generate : anyOf(boolean, signal) + generate : anyOf(boolean, :class:`signal`) - keys : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + keys : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) signal : string @@ -1906,19 +1934,19 @@ class packTransform(VegaSchema): type : enum('pack') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - radius : oneOf(scaleField, paramField, expr) + radius : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/packTransform'} @@ -1940,19 +1968,19 @@ class partitionTransform(VegaSchema): type : enum('partition') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - round : anyOf(boolean, signal) + round : anyOf(boolean, :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/partitionTransform'} @@ -1972,9 +2000,9 @@ class stratifyTransform(VegaSchema): Attributes ---------- - key : oneOf(scaleField, paramField, expr) + key : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - parentKey : oneOf(scaleField, paramField, expr) + parentKey : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) type : enum('stratify') @@ -1999,19 +2027,19 @@ class treeTransform(VegaSchema): type : enum('tree') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - method : anyOf(enum('tidy', 'cluster'), signal) + method : anyOf(enum('tidy', 'cluster'), :class:`signal`) - nodeSize : oneOf(List(anyOf(float, signal)), signal) + nodeSize : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/treeTransform'} @@ -2053,36 +2081,36 @@ class treemapTransform(VegaSchema): type : enum('treemap') - field : oneOf(scaleField, paramField, expr) + field : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) method : anyOf(enum('squarify', 'resquarify', 'binary', 'dice', 'slice', 'slicedice'), - signal) + :class:`signal`) - padding : anyOf(float, signal) + padding : anyOf(float, :class:`signal`) - paddingBottom : anyOf(float, signal) + paddingBottom : anyOf(float, :class:`signal`) - paddingInner : anyOf(float, signal) + paddingInner : anyOf(float, :class:`signal`) - paddingLeft : anyOf(float, signal) + paddingLeft : anyOf(float, :class:`signal`) - paddingOuter : anyOf(float, signal) + paddingOuter : anyOf(float, :class:`signal`) - paddingRight : anyOf(float, signal) + paddingRight : anyOf(float, :class:`signal`) - paddingTop : anyOf(float, signal) + paddingTop : anyOf(float, :class:`signal`) - ratio : anyOf(float, signal) + ratio : anyOf(float, :class:`signal`) - round : anyOf(boolean, signal) + round : anyOf(boolean, :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - sort : compare + sort : :class:`compare` - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/treemapTransform'} @@ -2110,17 +2138,17 @@ class voronoiTransform(VegaSchema): type : enum('voronoi') - x : oneOf(scaleField, paramField, expr) + x : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - y : oneOf(scaleField, paramField, expr) + y : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - extent : oneOf(List(Mapping(required=[])), signal) + extent : oneOf(List(Mapping(required=[])), :class:`signal`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - as : anyOf(string, signal) + as : anyOf(string, :class:`signal`) """ _schema = {'$ref': '#/defs/voronoiTransform'} @@ -2142,29 +2170,29 @@ class wordcloudTransform(VegaSchema): type : enum('wordcloud') - font : anyOf(string, signal, expr, paramField) + font : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - fontSize : anyOf(float, signal, expr, paramField) + fontSize : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) - fontSizeRange : oneOf(List(anyOf(float, signal)), signal, None) + fontSizeRange : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`, None) - fontStyle : anyOf(string, signal, expr, paramField) + fontStyle : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - fontWeight : anyOf(string, signal, expr, paramField) + fontWeight : anyOf(string, :class:`signal`, :class:`expr`, :class:`paramField`) - padding : anyOf(float, signal, expr, paramField) + padding : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) - rotate : anyOf(float, signal, expr, paramField) + rotate : anyOf(float, :class:`signal`, :class:`expr`, :class:`paramField`) signal : string - size : oneOf(List(anyOf(float, signal)), signal) + size : oneOf(List(anyOf(float, :class:`signal`)), :class:`signal`) - spiral : anyOf(string, signal) + spiral : anyOf(string, :class:`signal`) - text : oneOf(scaleField, paramField, expr) + text : oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`) - as : oneOf(List(anyOf(string, signal)), signal) + as : oneOf(List(anyOf(string, :class:`signal`)), :class:`signal`) """ _schema = {'$ref': '#/defs/wordcloudTransform'} @@ -2188,9 +2216,10 @@ class crossfilterTransform(VegaSchema): Attributes ---------- - fields : oneOf(List(oneOf(scaleField, paramField, expr)), signal) + fields : oneOf(List(oneOf(:class:`scaleField`, :class:`paramField`, :class:`expr`)), + :class:`signal`) - query : oneOf(List(Mapping(required=[])), signal) + query : oneOf(List(Mapping(required=[])), :class:`signal`) type : enum('crossfilter') @@ -2215,7 +2244,7 @@ class resolvefilterTransform(VegaSchema): filter : Mapping(required=[]) - ignore : anyOf(float, signal) + ignore : anyOf(float, :class:`signal`) type : enum('resolvefilter') @@ -2246,7 +2275,7 @@ class tickCount(VegaSchema): """tickCount schema wrapper oneOf(float, enum('millisecond', 'second', 'minute', 'hour', 'day', 'week', 'month', - 'year'), Mapping(required=[interval]), signal) + 'year'), Mapping(required=[interval]), :class:`signal`) """ _schema = {'$ref': '#/refs/tickCount'} _rootschema = Root._schema @@ -2290,7 +2319,7 @@ def __init__(self, field=Undefined, **kwds): class field(VegaSchema): """field schema wrapper - oneOf(string, oneOf(signal, Mapping(required=[datum]), Mapping(required=[group]), + oneOf(string, oneOf(:class:`signal`, Mapping(required=[datum]), Mapping(required=[group]), Mapping(required=[parent]))) """ _schema = {'$ref': '#/refs/field'} @@ -2303,7 +2332,7 @@ def __init__(self, *args, **kwds): class scale(VegaSchema): """scale schema wrapper - oneOf(string, oneOf(signal, Mapping(required=[datum]), Mapping(required=[group]), + oneOf(string, oneOf(:class:`signal`, Mapping(required=[datum]), Mapping(required=[group]), Mapping(required=[parent]))) """ _schema = {'$ref': '#/refs/scale'} @@ -2321,7 +2350,7 @@ class stringModifiers(VegaSchema): Attributes ---------- - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/stringModifiers'} @@ -2341,17 +2370,17 @@ class numberModifiers(VegaSchema): band : anyOf(float, boolean) - exponent : oneOf(float, numberValue) + exponent : oneOf(float, :class:`numberValue`) extra : boolean - mult : oneOf(float, numberValue) + mult : oneOf(float, :class:`numberValue`) - offset : oneOf(float, numberValue) + offset : oneOf(float, :class:`numberValue`) round : boolean - scale : scale + scale : :class:`scale` """ _schema = {'$ref': '#/refs/numberModifiers'} @@ -2366,12 +2395,13 @@ def __init__(self, band=Undefined, exponent=Undefined, extra=Undefined, mult=Und class value(VegaSchema): """value schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/value'} _rootschema = Root._schema @@ -2383,12 +2413,13 @@ def __init__(self, *args, **kwds): class numberValue(VegaSchema): """numberValue schema wrapper - oneOf(List(allOf(rule, allOf(numberModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(numberModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`numberModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`numberModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/numberValue'} _rootschema = Root._schema @@ -2400,12 +2431,13 @@ def __init__(self, *args, **kwds): class stringValue(VegaSchema): """stringValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/stringValue'} _rootschema = Root._schema @@ -2417,12 +2449,13 @@ def __init__(self, *args, **kwds): class booleanValue(VegaSchema): """booleanValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/booleanValue'} _rootschema = Root._schema @@ -2434,12 +2467,13 @@ def __init__(self, *args, **kwds): class arrayValue(VegaSchema): """arrayValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/arrayValue'} _rootschema = Root._schema @@ -2451,12 +2485,13 @@ def __init__(self, *args, **kwds): class nullableStringValue(VegaSchema): """nullableStringValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/nullableStringValue'} _rootschema = Root._schema @@ -2468,12 +2503,13 @@ def __init__(self, *args, **kwds): class fontWeightValue(VegaSchema): """fontWeightValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/fontWeightValue'} _rootschema = Root._schema @@ -2485,12 +2521,13 @@ def __init__(self, *args, **kwds): class alignValue(VegaSchema): """alignValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/alignValue'} _rootschema = Root._schema @@ -2502,12 +2539,13 @@ def __init__(self, *args, **kwds): class baselineValue(VegaSchema): """baselineValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/baselineValue'} _rootschema = Root._schema @@ -2519,12 +2557,13 @@ def __init__(self, *args, **kwds): class orientValue(VegaSchema): """orientValue schema wrapper - oneOf(List(allOf(rule, allOf(stringModifiers, anyOf(oneOf(signal, Mapping(required=[value]), - Mapping(required=[field]), Mapping(required=[range])), Mapping(required=[scale, value]), - Mapping(required=[scale, band]), Mapping(required=[offset]))))), allOf(stringModifiers, - anyOf(oneOf(signal, Mapping(required=[value]), Mapping(required=[field]), - Mapping(required=[range])), Mapping(required=[scale, value]), Mapping(required=[scale, - band]), Mapping(required=[offset])))) + oneOf(List(allOf(:class:`rule`, allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset]))))), allOf(:class:`stringModifiers`, anyOf(oneOf(:class:`signal`, + Mapping(required=[value]), Mapping(required=[field]), Mapping(required=[range])), + Mapping(required=[scale, value]), Mapping(required=[scale, band]), + Mapping(required=[offset])))) """ _schema = {'$ref': '#/refs/orientValue'} _rootschema = Root._schema @@ -2541,11 +2580,11 @@ class colorRGB(VegaSchema): Attributes ---------- - b : numberValue + b : :class:`numberValue` - g : numberValue + g : :class:`numberValue` - r : numberValue + r : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorRGB'} @@ -2563,11 +2602,11 @@ class colorHSL(VegaSchema): Attributes ---------- - h : numberValue + h : :class:`numberValue` - l : numberValue + l : :class:`numberValue` - s : numberValue + s : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorHSL'} @@ -2585,11 +2624,11 @@ class colorLAB(VegaSchema): Attributes ---------- - a : numberValue + a : :class:`numberValue` - b : numberValue + b : :class:`numberValue` - l : numberValue + l : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorLAB'} @@ -2607,11 +2646,11 @@ class colorHCL(VegaSchema): Attributes ---------- - c : numberValue + c : :class:`numberValue` - h : numberValue + h : :class:`numberValue` - l : numberValue + l : :class:`numberValue` """ _schema = {'$ref': '#/refs/colorHCL'} @@ -2624,7 +2663,7 @@ def __init__(self, c=Undefined, h=Undefined, l=Undefined, **kwds): class colorValue(VegaSchema): """colorValue schema wrapper - oneOf(nullableStringValue, Mapping(required=[gradient]), Mapping(required=[color])) + oneOf(:class:`nullableStringValue`, Mapping(required=[gradient]), Mapping(required=[color])) """ _schema = {'$ref': '#/refs/colorValue'} _rootschema = Root._schema @@ -2719,7 +2758,7 @@ def __init__(self, facet=Undefined, data=Undefined, **kwds): class markclip(VegaSchema): """markclip schema wrapper - oneOf(booleanOrSignal, Mapping(required=[path]), Mapping(required=[sphere])) + oneOf(:class:`booleanOrSignal`, Mapping(required=[path]), Mapping(required=[sphere])) """ _schema = {'$ref': '#/refs/markclip'} _rootschema = Root._schema @@ -2755,7 +2794,7 @@ def __init__(self, *args): class sortOrder(VegaSchema): """sortOrder schema wrapper - oneOf(enum('ascending', 'descending'), signal) + oneOf(enum('ascending', 'descending'), :class:`signal`) """ _schema = {'$ref': '#/refs/sortOrder'} _rootschema = Root._schema @@ -2767,7 +2806,7 @@ def __init__(self, *args, **kwds): class scaleField(VegaSchema): """scaleField schema wrapper - oneOf(string, signal) + oneOf(string, :class:`signal`) """ _schema = {'$ref': '#/refs/scaleField'} _rootschema = Root._schema @@ -2779,7 +2818,7 @@ def __init__(self, *args, **kwds): class scaleInterpolate(VegaSchema): """scaleInterpolate schema wrapper - oneOf(string, signal, Mapping(required=[type])) + oneOf(string, :class:`signal`, Mapping(required=[type])) """ _schema = {'$ref': '#/refs/scaleInterpolate'} _rootschema = Root._schema @@ -2834,7 +2873,7 @@ def __init__(self, signal=Undefined, **kwds): class arrayOrSignal(VegaSchema): """arrayOrSignal schema wrapper - oneOf(List(Mapping(required=[])), signal) + oneOf(List(Mapping(required=[])), :class:`signal`) """ _schema = {'$ref': '#/refs/arrayOrSignal'} _rootschema = Root._schema @@ -2846,7 +2885,7 @@ def __init__(self, *args, **kwds): class booleanOrSignal(VegaSchema): """booleanOrSignal schema wrapper - oneOf(boolean, signal) + oneOf(boolean, :class:`signal`) """ _schema = {'$ref': '#/refs/booleanOrSignal'} _rootschema = Root._schema @@ -2858,7 +2897,7 @@ def __init__(self, *args, **kwds): class numberOrSignal(VegaSchema): """numberOrSignal schema wrapper - oneOf(float, signal) + oneOf(float, :class:`signal`) """ _schema = {'$ref': '#/refs/numberOrSignal'} _rootschema = Root._schema @@ -2870,7 +2909,7 @@ def __init__(self, *args, **kwds): class stringOrSignal(VegaSchema): """stringOrSignal schema wrapper - oneOf(string, signal) + oneOf(string, :class:`signal`) """ _schema = {'$ref': '#/refs/stringOrSignal'} _rootschema = Root._schema diff --git a/altair/vegalite/v1/schema/channels.py b/altair/vegalite/v1/schema/channels.py index ad5532074..96f2e6206 100644 --- a/altair/vegalite/v1/schema/channels.py +++ b/altair/vegalite/v1/schema/channels.py @@ -80,28 +80,28 @@ class Row(FieldChannelMixin, core.PositionChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - axis : Axis + axis : :class:`Axis` - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -132,28 +132,28 @@ class Column(FieldChannelMixin, core.PositionChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - axis : Axis + axis : :class:`Axis` - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -184,28 +184,28 @@ class X(FieldChannelMixin, core.PositionChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - axis : Axis + axis : :class:`Axis` - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -236,28 +236,28 @@ class Y(FieldChannelMixin, core.PositionChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - axis : Axis + axis : :class:`Axis` - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -288,22 +288,22 @@ class X2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -332,22 +332,22 @@ class Y2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -376,28 +376,28 @@ class Color(FieldChannelMixin, core.ChannelDefWithLegend): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - legend : Legend + legend : :class:`Legend` - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -428,28 +428,28 @@ class Opacity(FieldChannelMixin, core.ChannelDefWithLegend): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - legend : Legend + legend : :class:`Legend` - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -480,28 +480,28 @@ class Size(FieldChannelMixin, core.ChannelDefWithLegend): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - legend : Legend + legend : :class:`Legend` - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -532,28 +532,28 @@ class Shape(FieldChannelMixin, core.ChannelDefWithLegend): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - legend : Legend + legend : :class:`Legend` - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -584,22 +584,22 @@ class Detail(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -628,22 +628,22 @@ class Text(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -672,22 +672,22 @@ class Label(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -716,24 +716,24 @@ class Path(FieldChannelMixin, core.OrderChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - sort : SortOrder + sort : :class:`SortOrder` - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -764,24 +764,24 @@ class Order(FieldChannelMixin, core.OrderChannelDef): shorthand : string shorthand for field, aggregate, and type - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - sort : SortOrder + sort : :class:`SortOrder` - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) diff --git a/altair/vegalite/v1/schema/core.py b/altair/vegalite/v1/schema/core.py index 8215eacfb..b64e16630 100644 --- a/altair/vegalite/v1/schema/core.py +++ b/altair/vegalite/v1/schema/core.py @@ -22,7 +22,7 @@ def _default_wrapper_classes(cls): class Root(VegaLiteSchema): """Root schema wrapper - anyOf(ExtendedUnitSpec, FacetSpec, LayerSpec) + anyOf(:class:`ExtendedUnitSpec`, :class:`FacetSpec`, :class:`LayerSpec`) """ _schema = load_schema() _rootschema = _schema @@ -47,27 +47,27 @@ class ExtendedUnitSpec(VegaLiteSchema): Attributes ---------- - mark : Mark + mark : :class:`Mark` The mark type. One of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, and ``"text"``. - config : Config + config : :class:`Config` Configuration object - data : Data + data : :class:`Data` An object describing the data source description : string An optional description of this mark for commenting purpose. This property has no effect on the output visualization. - encoding : Encoding + encoding : :class:`Encoding` A key-value mapping between encoding channels and definition of fields. height : float name : string Name of the visualization for later reference. - transform : Transform + transform : :class:`Transform` An object describing filter and new field calculation. width : float @@ -104,36 +104,36 @@ class Encoding(VegaLiteSchema): Attributes ---------- - color : ChannelDefWithLegend + color : :class:`ChannelDefWithLegend` Color of the marks – either fill or stroke color based on mark type. (By default, fill color for ``area``, ``bar``, ``tick``, ``text``, ``circle``, and ``square`` / stroke color for ``line`` and ``point``.) - column : PositionChannelDef + column : :class:`PositionChannelDef` Horizontal facets for trellis plots. - detail : anyOf(FieldDef, List(FieldDef)) + detail : anyOf(:class:`FieldDef`, List(:class:`FieldDef`)) Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel. - label : FieldDef + label : :class:`FieldDef` - opacity : ChannelDefWithLegend + opacity : :class:`ChannelDefWithLegend` Opacity of the marks – either can be a value or in a range. - order : anyOf(OrderChannelDef, List(OrderChannelDef)) + order : anyOf(:class:`OrderChannelDef`, List(:class:`OrderChannelDef`)) Layer order for non-stacked marks, or stack order for stacked marks. - path : anyOf(OrderChannelDef, List(OrderChannelDef)) + path : anyOf(:class:`OrderChannelDef`, List(:class:`OrderChannelDef`)) Order of data points in line marks. - row : PositionChannelDef + row : :class:`PositionChannelDef` Vertical facets for trellis plots. - shape : ChannelDefWithLegend + shape : :class:`ChannelDefWithLegend` The symbol's shape (only for ``point`` marks). The supported values are ``"circle"`` (default), ``"square"``, ``"cross"``, ``"diamond"``, ``"triangle-up"``, or ``"triangle-down"``, or else a custom SVG path string. - size : ChannelDefWithLegend + size : :class:`ChannelDefWithLegend` Size of the mark. @@ -147,23 +147,23 @@ class Encoding(VegaLiteSchema): For ``text`` – the text's font size. Size is currently unsupported for ``line`` and ``area``. - text : FieldDef + text : :class:`FieldDef` Text of the ``text`` mark. - x : PositionChannelDef + x : :class:`PositionChannelDef` X coordinates for ``point``, ``circle``, ``square``, ``line``, ``rule``, ``text``, and ``tick`` (or to width and height for ``bar`` and ``area`` marks). - x2 : FieldDef + x2 : :class:`FieldDef` X2 coordinates for ranged ``bar``, ``rule``, ``area`` - y : PositionChannelDef + y : :class:`PositionChannelDef` Y coordinates for ``point``, ``circle``, ``square``, ``line``, ``rule``, ``text``, and ``tick`` (or to width and height for ``bar`` and ``area`` marks). - y2 : FieldDef + y2 : :class:`FieldDef` Y2 coordinates for ranged ``bar``, ``rule``, ``area`` """ _schema = {'$ref': '#/definitions/Encoding'} @@ -186,28 +186,28 @@ class PositionChannelDef(VegaLiteSchema): Attributes ---------- - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - axis : Axis + axis : :class:`Axis` - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -312,19 +312,19 @@ class Scale(VegaLiteSchema): Attributes ---------- - bandSize : anyOf(BandSize, float) + bandSize : anyOf(:class:`BandSize`, float) clamp : boolean If true, values that exceed the data domain are clamped to either the minimum or maximum range value - domain : anyOf(List(string), List(float), List(DateTime)) + domain : anyOf(List(string), List(float), List(:class:`DateTime`)) The domain of the scale, representing the set of data values. For quantitative data, this can take the form of a two-element array with minimum and maximum values. For ordinal/categorical data, this may be an array of valid input values. exponent : float Sets the exponent of the scale transformation. For pow scale types only, otherwise ignored. - nice : anyOf(NiceTime, boolean) + nice : anyOf(:class:`NiceTime`, boolean) If specified, modifies the scale domain to use a more human-friendly value range. If specified as a true boolean, modifies the scale domain to use a more human-friendly number range (e.g., 7 instead of 6.96). If specified as a string, modifies the scale @@ -339,7 +339,7 @@ class Scale(VegaLiteSchema): in the range [0, 1] and corresponds to the fraction of space in the range interval to allocate to padding. A value of 0.5 means that the range band width will be equal to the padding width. For more, see the `D3 ordinal scale documentation - `_. + `__. range : anyOf(List(string), List(float), string) The range of the scale, representing the set of visual values. For numeric values, the range can take the form of a two-element array with minimum and maximum values. @@ -350,7 +350,7 @@ class Scale(VegaLiteSchema): round : boolean If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. - type : ScaleType + type : :class:`ScaleType` useRawDomain : boolean Uses the source data range as scale domain instead of aggregated data for aggregate @@ -438,9 +438,9 @@ class SortField(VegaLiteSchema): field : string The field name to aggregate over. - op : AggregateOp + op : :class:`AggregateOp` The sort aggregation operator - order : SortOrder + order : :class:`SortOrder` """ _schema = {'$ref': '#/definitions/SortField'} @@ -542,22 +542,22 @@ class FieldDef(VegaLiteSchema): Attributes ---------- - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -585,28 +585,28 @@ class ChannelDefWithLegend(VegaLiteSchema): Attributes ---------- - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - legend : Legend + legend : :class:`Legend` - scale : Scale + scale : :class:`Scale` - sort : anyOf(SortOrder, SortField) + sort : anyOf(:class:`SortOrder`, :class:`SortField`) - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -649,24 +649,24 @@ class OrderChannelDef(VegaLiteSchema): Attributes ---------- - aggregate : AggregateOp + aggregate : :class:`AggregateOp` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). - bin : anyOf(Bin, boolean) + bin : anyOf(:class:`Bin`, boolean) Flag for binning a ``quantitative`` field, or a bin property object for binning parameters. field : string Name of the field from which to pull a data value. - sort : SortOrder + sort : :class:`SortOrder` - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for a ``temporal`` field (e.g., ``year``, ``yearmonth``, ``month``, ``hour`` ). title : string Title for axis or legend. - type : Type + type : :class:`Type` The encoded field's type of measurement. This can be either a full type name ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, and ``"nominal"`` ) @@ -695,7 +695,7 @@ class Data(VegaLiteSchema): Attributes ---------- - format : DataFormat + format : :class:`DataFormat` An object that specifies the format for the data file or values. url : string A URL from which to load the data set. Use the format.type property @@ -745,7 +745,8 @@ class DataFormat(VegaLiteSchema): (one of ``"number"``, ``"boolean"`` or ``"date"`` ). For example, ``"parse": {"modified_on":"date"}`` ensures that the ``modified_on`` value in each row of the input data is parsed as a Date value. (See Datalib's `dl.read.types method - `_ for more information.) + `__ for more + information.) property : string JSON only) The JSON property containing the desired data. @@ -756,7 +757,7 @@ class DataFormat(VegaLiteSchema): ``json.values.features`` from the loaded JSON object. - type : DataFormatType + type : :class:`DataFormatType` Type of input data: ``"json"``, ``"csv"``, ``"tsv"``. The default format type is determined by the extension of the file url. @@ -792,11 +793,12 @@ class Transform(VegaLiteSchema): Attributes ---------- - calculate : List(Formula) + calculate : List(:class:`Formula`) Calculate new field(s) using the provided expresssion(s). Calculation are applied before filter. - filter : anyOf(EqualFilter, RangeFilter, OneOfFilter, List(anyOf(EqualFilter, RangeFilter, - OneOfFilter, string)), string) + filter : anyOf(:class:`EqualFilter`, :class:`RangeFilter`, :class:`OneOfFilter`, + List(anyOf(:class:`EqualFilter`, :class:`RangeFilter`, :class:`OneOfFilter`, string)), + string) A string containing the filter Vega expression. Use ``datum`` to refer to the current data object. filterInvalid : boolean @@ -821,11 +823,11 @@ class EqualFilter(VegaLiteSchema): Attributes ---------- - equal : anyOf(DateTime, anyOf(string, float, boolean)) + equal : anyOf(:class:`DateTime`, anyOf(string, float, boolean)) Value that the field should be equal to. field : string Field to be filtered. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/EqualFilter'} @@ -845,11 +847,11 @@ class RangeFilter(VegaLiteSchema): field : string Field to be filtered - range : List(anyOf(DateTime, float)) + range : List(anyOf(:class:`DateTime`, float)) Array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/RangeFilter'} @@ -869,11 +871,11 @@ class OneOfFilter(VegaLiteSchema): field : string Field to be filtered - oneOf : List(anyOf(DateTime, anyOf(string, float, boolean))) + oneOf : List(anyOf(:class:`DateTime`, anyOf(string, float, boolean))) A set of values that the ``field`` 's value should be a member of, for a data item included in the filtered data. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/OneOfFilter'} @@ -913,26 +915,26 @@ class Config(VegaLiteSchema): Attributes ---------- - axis : AxisConfig + axis : :class:`AxisConfig` Axis Config background : string CSS color property to use as background of visualization. Default is ``"transparent"``. - cell : CellConfig + cell : :class:`CellConfig` Cell Config countTitle : string Default axis and legend title for count fields. - facet : FacetConfig + facet : :class:`FacetConfig` Facet Config - legend : LegendConfig + legend : :class:`LegendConfig` Legend Config - mark : MarkConfig + mark : :class:`MarkConfig` Mark Config numberFormat : string D3 Number format for axis labels and text tables. For example "s" for SI units. - overlay : OverlayConfig + overlay : :class:`OverlayConfig` Mark Overlay Config - scale : ScaleConfig + scale : :class:`ScaleConfig` Scale Config timeFormat : string Default datetime format for axis and legend labels. The format can be set directly @@ -1002,7 +1004,7 @@ class MarkConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of left, right, center. angle : float The rotation angle of the text, in degrees. @@ -1014,7 +1016,7 @@ class MarkConfig(VegaLiteSchema): which provides 1 pixel offset between bars. barThinSize : float The size of the bars on continuous scales. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of top, middle, bottom. color : string Default color. @@ -1042,21 +1044,21 @@ class MarkConfig(VegaLiteSchema): The typeface to set the text in (e.g., Helvetica Neue). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., italic). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight (e.g., bold). format : string The formatting pattern for text value. If not defined, this will be determined automatically. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use. One of linear, step-before, step-after, basis, basis-open, cardinal, cardinal-open, monotone. lineSize : float Size of line mark. opacity : float - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -1081,7 +1083,7 @@ class MarkConfig(VegaLiteSchema): determined by the x and y properties. ruleSize : float Size of rule mark. - shape : anyOf(Shape, string) + shape : anyOf(:class:`Shape`, string) The symbol shape to use. One of circle (default), square, cross, diamond, triangle-up, or triangle-down, or a custom SVG path. shortTimeLabels : boolean @@ -1089,7 +1091,7 @@ class MarkConfig(VegaLiteSchema): size : float The pixel area each the point. For example: in the case of circles, the radius is determined in part by the square root of the size value. - stacked : StackOffset + stacked : :class:`StackOffset` stroke : string Default Stroke Color. This has higher precedence than config.color @@ -1249,13 +1251,13 @@ class OverlayConfig(VegaLiteSchema): Attributes ---------- - area : AreaOverlay + area : :class:`AreaOverlay` Type of overlay for area mark (line or linepoint) line : boolean Whether to overlay line with point. - lineStyle : MarkConfig + lineStyle : :class:`MarkConfig` Default style for the overlayed point. - pointStyle : MarkConfig + pointStyle : :class:`MarkConfig` Default style for the overlayed point. """ _schema = {'$ref': '#/definitions/OverlayConfig'} @@ -1286,7 +1288,7 @@ class ScaleConfig(VegaLiteSchema): Attributes ---------- - bandSize : anyOf(BandSize, float) + bandSize : anyOf(:class:`BandSize`, float) Default band size for (1) ``y`` ordinal scale, and (2) ``x`` ordinal scale when the mark is not ``text``. @@ -1564,13 +1566,13 @@ class FacetConfig(VegaLiteSchema): Attributes ---------- - axis : AxisConfig + axis : :class:`AxisConfig` Facet Axis Config - cell : CellConfig + cell : :class:`CellConfig` Facet Cell Config - grid : FacetGridConfig + grid : :class:`FacetGridConfig` Facet Grid Config - scale : FacetScaleConfig + scale : :class:`FacetScaleConfig` Facet Scale Config """ _schema = {'$ref': '#/definitions/FacetConfig'} @@ -1630,13 +1632,13 @@ class FacetSpec(VegaLiteSchema): Attributes ---------- - facet : Facet + facet : :class:`Facet` - spec : anyOf(UnitSpec, LayerSpec) + spec : anyOf(:class:`UnitSpec`, :class:`LayerSpec`) - config : Config + config : :class:`Config` Configuration object - data : Data + data : :class:`Data` An object describing the data source description : string An optional description of this mark for commenting purpose. @@ -1644,7 +1646,7 @@ class FacetSpec(VegaLiteSchema): This property has no effect on the output visualization. name : string Name of the visualization for later reference. - transform : Transform + transform : :class:`Transform` An object describing filter and new field calculation. """ _schema = {'$ref': '#/definitions/FacetSpec'} @@ -1664,9 +1666,9 @@ class Facet(VegaLiteSchema): Attributes ---------- - column : PositionChannelDef + column : :class:`PositionChannelDef` - row : PositionChannelDef + row : :class:`PositionChannelDef` """ _schema = {'$ref': '#/definitions/Facet'} @@ -1684,27 +1686,27 @@ class UnitSpec(VegaLiteSchema): Attributes ---------- - mark : Mark + mark : :class:`Mark` The mark type. One of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, and ``"text"``. - config : Config + config : :class:`Config` Configuration object - data : Data + data : :class:`Data` An object describing the data source description : string An optional description of this mark for commenting purpose. This property has no effect on the output visualization. - encoding : UnitEncoding + encoding : :class:`UnitEncoding` A key-value mapping between encoding channels and definition of fields. height : float name : string Name of the visualization for later reference. - transform : Transform + transform : :class:`Transform` An object describing filter and new field calculation. width : float @@ -1728,32 +1730,32 @@ class UnitEncoding(VegaLiteSchema): Attributes ---------- - color : ChannelDefWithLegend + color : :class:`ChannelDefWithLegend` Color of the marks – either fill or stroke color based on mark type. (By default, fill color for ``area``, ``bar``, ``tick``, ``text``, ``circle``, and ``square`` / stroke color for ``line`` and ``point``.) - detail : anyOf(FieldDef, List(FieldDef)) + detail : anyOf(:class:`FieldDef`, List(:class:`FieldDef`)) Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel. - label : FieldDef + label : :class:`FieldDef` - opacity : ChannelDefWithLegend + opacity : :class:`ChannelDefWithLegend` Opacity of the marks – either can be a value or in a range. - order : anyOf(OrderChannelDef, List(OrderChannelDef)) + order : anyOf(:class:`OrderChannelDef`, List(:class:`OrderChannelDef`)) Layer order for non-stacked marks, or stack order for stacked marks. - path : anyOf(OrderChannelDef, List(OrderChannelDef)) + path : anyOf(:class:`OrderChannelDef`, List(:class:`OrderChannelDef`)) Order of data points in line marks. - shape : ChannelDefWithLegend + shape : :class:`ChannelDefWithLegend` The symbol's shape (only for ``point`` marks). The supported values are ``"circle"`` (default), ``"square"``, ``"cross"``, ``"diamond"``, ``"triangle-up"``, or ``"triangle-down"``, or else a custom SVG path string. - size : ChannelDefWithLegend + size : :class:`ChannelDefWithLegend` Size of the mark. @@ -1767,23 +1769,23 @@ class UnitEncoding(VegaLiteSchema): For ``text`` – the text's font size. Size is currently unsupported for ``line`` and ``area``. - text : FieldDef + text : :class:`FieldDef` Text of the ``text`` mark. - x : PositionChannelDef + x : :class:`PositionChannelDef` X coordinates for ``point``, ``circle``, ``square``, ``line``, ``rule``, ``text``, and ``tick`` (or to width and height for ``bar`` and ``area`` marks). - x2 : FieldDef + x2 : :class:`FieldDef` X2 coordinates for ranged ``bar``, ``rule``, ``area`` - y : PositionChannelDef + y : :class:`PositionChannelDef` Y coordinates for ``point``, ``circle``, ``square``, ``line``, ``rule``, ``text``, and ``tick`` (or to width and height for ``bar`` and ``area`` marks). - y2 : FieldDef + y2 : :class:`FieldDef` Y2 coordinates for ranged ``bar``, ``rule``, ``area`` """ _schema = {'$ref': '#/definitions/UnitEncoding'} @@ -1805,11 +1807,11 @@ class LayerSpec(VegaLiteSchema): Attributes ---------- - layers : List(UnitSpec) + layers : List(:class:`UnitSpec`) Unit specs that will be layered. - config : Config + config : :class:`Config` Configuration object - data : Data + data : :class:`Data` An object describing the data source description : string An optional description of this mark for commenting purpose. @@ -1819,7 +1821,7 @@ class LayerSpec(VegaLiteSchema): name : string Name of the visualization for later reference. - transform : Transform + transform : :class:`Transform` An object describing filter and new field calculation. width : float diff --git a/altair/vegalite/v2/schema/channels.py b/altair/vegalite/v2/schema/channels.py index 515e5bafe..305082691 100644 --- a/altair/vegalite/v2/schema/channels.py +++ b/altair/vegalite/v2/schema/channels.py @@ -81,55 +81,55 @@ class Color(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -141,13 +141,13 @@ class Color(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -155,11 +155,11 @@ class Color(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -175,17 +175,17 @@ class Color(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -206,8 +206,8 @@ class ColorValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -228,35 +228,35 @@ class Column(FieldChannelMixin, core.FacetFieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - header : Header + header : :class:`Header` An object defining properties of a facet's header. - sort : Sort + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -268,13 +268,13 @@ class Column(FieldChannelMixin, core.FacetFieldDef): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -282,11 +282,11 @@ class Column(FieldChannelMixin, core.FacetFieldDef): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -302,17 +302,17 @@ class Column(FieldChannelMixin, core.FacetFieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -335,37 +335,37 @@ class Detail(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -381,17 +381,17 @@ class Detail(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -412,55 +412,55 @@ class Fill(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -472,13 +472,13 @@ class Fill(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -486,11 +486,11 @@ class Fill(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -506,17 +506,17 @@ class Fill(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -537,8 +537,8 @@ class FillValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -560,43 +560,43 @@ class Href(FieldChannelMixin, core.FieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -612,17 +612,17 @@ class Href(FieldChannelMixin, core.FieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -642,7 +642,8 @@ class HrefValue(ValueChannelMixin, core.ValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalFieldDef, ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -664,37 +665,37 @@ class Key(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -710,17 +711,17 @@ class Key(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -741,37 +742,37 @@ class Latitude(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -787,17 +788,17 @@ class Latitude(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -818,37 +819,37 @@ class Latitude2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -864,17 +865,17 @@ class Latitude2(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -895,37 +896,37 @@ class Longitude(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -941,17 +942,17 @@ class Longitude(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -972,37 +973,37 @@ class Longitude2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1018,17 +1019,17 @@ class Longitude2(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1049,55 +1050,55 @@ class Opacity(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1109,13 +1110,13 @@ class Opacity(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1123,11 +1124,11 @@ class Opacity(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1143,17 +1144,17 @@ class Opacity(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1174,8 +1175,8 @@ class OpacityValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -1196,39 +1197,39 @@ class Order(FieldChannelMixin, core.OrderFieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - sort : SortOrder + sort : :class:`SortOrder` The sort order. One of ``"ascending"`` (default) or ``"descending"``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1244,17 +1245,17 @@ class Order(FieldChannelMixin, core.OrderFieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1293,35 +1294,35 @@ class Row(FieldChannelMixin, core.FacetFieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - header : Header + header : :class:`Header` An object defining properties of a facet's header. - sort : Sort + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1333,13 +1334,13 @@ class Row(FieldChannelMixin, core.FacetFieldDef): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1347,11 +1348,11 @@ class Row(FieldChannelMixin, core.FacetFieldDef): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1367,17 +1368,17 @@ class Row(FieldChannelMixin, core.FacetFieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1400,55 +1401,55 @@ class Shape(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1460,13 +1461,13 @@ class Shape(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1474,11 +1475,11 @@ class Shape(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1494,17 +1495,17 @@ class Shape(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1525,8 +1526,8 @@ class ShapeValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -1548,55 +1549,55 @@ class Size(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1608,13 +1609,13 @@ class Size(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1622,11 +1623,11 @@ class Size(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1642,17 +1643,17 @@ class Size(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1673,8 +1674,8 @@ class SizeValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -1696,55 +1697,55 @@ class Stroke(FieldChannelMixin, core.MarkPropFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1756,13 +1757,13 @@ class Stroke(FieldChannelMixin, core.MarkPropFieldDefWithCondition): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1770,11 +1771,11 @@ class Stroke(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1790,17 +1791,17 @@ class Stroke(FieldChannelMixin, core.MarkPropFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1821,8 +1822,8 @@ class StrokeValue(ValueChannelMixin, core.MarkPropValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -1844,46 +1845,46 @@ class Text(FieldChannelMixin, core.TextFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1899,17 +1900,17 @@ class Text(FieldChannelMixin, core.TextFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -1930,7 +1931,8 @@ class TextValue(ValueChannelMixin, core.TextValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalTextFieldDef, ConditionalValueDef, List(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 : anyOf(float, string, boolean) A constant value in visual domain. @@ -1952,46 +1954,46 @@ class Tooltip(FieldChannelMixin, core.TextFieldDefWithCondition): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2007,17 +2009,17 @@ class Tooltip(FieldChannelMixin, core.TextFieldDefWithCondition): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -2038,7 +2040,8 @@ class TooltipValue(ValueChannelMixin, core.TextValueDefWithCondition): Attributes ---------- - condition : anyOf(ConditionalTextFieldDef, ConditionalValueDef, List(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 : anyOf(float, string, boolean) A constant value in visual domain. @@ -2059,49 +2062,49 @@ class X(FieldChannelMixin, core.PositionFieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - axis : anyOf(Axis, None) + axis : anyOf(:class:`Axis`, None) An object defining properties of axis's gridlines, ticks and labels. If ``null``, the axis for the encoding channel will be removed. **Default value:** If undefined, default `axis properties - `_ are applied. - bin : anyOf(boolean, BinParams) + `__ are applied. + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - scale : anyOf(Scale, None) + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -2113,13 +2116,13 @@ class X(FieldChannelMixin, core.PositionFieldDef): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -2127,7 +2130,7 @@ class X(FieldChannelMixin, core.PositionFieldDef): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - stack : anyOf(StackOffset, None) + stack : anyOf(:class:`StackOffset`, None) Type of stacking offset if the field should be stacked. ``stack`` is only applicable for ``x`` and ``y`` channels with continuous domains. For example, ``stack`` of ``y`` can be used to customize stacking for a vertical bar @@ -2138,14 +2141,15 @@ class X(FieldChannelMixin, core.PositionFieldDef): * `"zero"`: stacking with baseline offset at zero value of the scale (for creating typical stacked [bar](https://vega.github.io/vega-lite/docs/stack.html#bar) and - `area `_ chart). + `area `__ chart). * ``"normalize"`` - stacking with normalized domain (for creating `normalized stacked bar and area charts - `_. :raw-html:`
` + `__. + :raw-html:`
` - ``"center"`` - stacking with center baseline (for `streamgraph - `_ ). + `__ ). * ``null`` - No-stacking. This will produce layered `bar - `_ and area + `__ and area chart. **Default value:** ``zero`` for plots with all of the following conditions are true: @@ -2153,11 +2157,11 @@ class X(FieldChannelMixin, core.PositionFieldDef): (2) the stacked measure channel (x or y) has a linear scale; (3) At least one of non-position channels mapped to an unaggregated field that is different from x and y. Otherwise, ``null`` by default. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2173,17 +2177,17 @@ class X(FieldChannelMixin, core.PositionFieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -2225,37 +2229,37 @@ class X2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2271,17 +2275,17 @@ class X2(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -2320,49 +2324,49 @@ class Y(FieldChannelMixin, core.PositionFieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - axis : anyOf(Axis, None) + axis : anyOf(:class:`Axis`, None) An object defining properties of axis's gridlines, ticks and labels. If ``null``, the axis for the encoding channel will be removed. **Default value:** If undefined, default `axis properties - `_ are applied. - bin : anyOf(boolean, BinParams) + `__ are applied. + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - scale : anyOf(Scale, None) + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -2374,13 +2378,13 @@ class Y(FieldChannelMixin, core.PositionFieldDef): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -2388,7 +2392,7 @@ class Y(FieldChannelMixin, core.PositionFieldDef): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - stack : anyOf(StackOffset, None) + stack : anyOf(:class:`StackOffset`, None) Type of stacking offset if the field should be stacked. ``stack`` is only applicable for ``x`` and ``y`` channels with continuous domains. For example, ``stack`` of ``y`` can be used to customize stacking for a vertical bar @@ -2399,14 +2403,15 @@ class Y(FieldChannelMixin, core.PositionFieldDef): * `"zero"`: stacking with baseline offset at zero value of the scale (for creating typical stacked [bar](https://vega.github.io/vega-lite/docs/stack.html#bar) and - `area `_ chart). + `area `__ chart). * ``"normalize"`` - stacking with normalized domain (for creating `normalized stacked bar and area charts - `_. :raw-html:`
` + `__. + :raw-html:`
` - ``"center"`` - stacking with center baseline (for `streamgraph - `_ ). + `__ ). * ``null`` - No-stacking. This will produce layered `bar - `_ and area + `__ and area chart. **Default value:** ``zero`` for plots with all of the following conditions are true: @@ -2414,11 +2419,11 @@ class Y(FieldChannelMixin, core.PositionFieldDef): (2) the stacked measure channel (x or y) has a linear scale; (3) At least one of non-position channels mapped to an unaggregated field that is different from x and y. Otherwise, ``null`` by default. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2434,17 +2439,17 @@ class Y(FieldChannelMixin, core.PositionFieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False @@ -2486,37 +2491,37 @@ class Y2(FieldChannelMixin, core.FieldDef): shorthand : string shorthand for field, aggregate, and type - aggregate : Aggregate + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2532,17 +2537,17 @@ class Y2(FieldChannelMixin, core.FieldDef): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. + `__. """ _class_is_valid_at_instantiation = False diff --git a/altair/vegalite/v2/schema/core.py b/altair/vegalite/v2/schema/core.py index 009cd7fdc..6518cac28 100644 --- a/altair/vegalite/v2/schema/core.py +++ b/altair/vegalite/v2/schema/core.py @@ -22,8 +22,9 @@ def _default_wrapper_classes(cls): class Root(VegaLiteSchema): """Root schema wrapper - anyOf(TopLevelFacetedUnitSpec, TopLevelFacetSpec, TopLevelLayerSpec, TopLevelRepeatSpec, - TopLevelVConcatSpec, TopLevelHConcatSpec) + anyOf(:class:`TopLevelFacetedUnitSpec`, :class:`TopLevelFacetSpec`, + :class:`TopLevelLayerSpec`, :class:`TopLevelRepeatSpec`, :class:`TopLevelVConcatSpec`, + :class:`TopLevelHConcatSpec`) """ _schema = load_schema() _rootschema = _schema @@ -68,7 +69,7 @@ class AggregateTransform(VegaLiteSchema): Attributes ---------- - aggregate : List(AggregatedFieldDef) + aggregate : List(:class:`AggregatedFieldDef`) Array of objects that define fields to aggregate. groupby : List(string) The data fields to group by. If not specified, a single group containing all data @@ -89,10 +90,10 @@ class AggregatedFieldDef(VegaLiteSchema): Attributes ---------- - op : AggregateOp + op : :class:`AggregateOp` The aggregation operations to apply to the fields, such as sum, average or count. See the `full list of supported aggregation operations - `_ + `__ for more information. field : string The data field for which to compute aggregate function. This is required for all @@ -122,7 +123,7 @@ def __init__(self, *args): class AnyMark(VegaLiteSchema): """AnyMark schema wrapper - anyOf(Mark, MarkDef) + anyOf(:class:`Mark`, :class:`MarkDef`) """ _schema = {'$ref': '#/definitions/AnyMark'} _rootschema = Root._schema @@ -139,11 +140,11 @@ class AreaConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -155,15 +156,15 @@ class AreaConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -196,21 +197,21 @@ class AreaConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -237,7 +238,7 @@ class AreaConfig(VegaLiteSchema): truncated if the rendered size exceeds the limit. **Default value:** ``0``, indicating no limit - line : anyOf(boolean, OverlayMarkDef) + line : anyOf(boolean, :class:`OverlayMarkDef`) A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines. @@ -253,7 +254,7 @@ class AreaConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -266,7 +267,7 @@ class AreaConfig(VegaLiteSchema): if ``config.sortLineBy`` is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored. - point : anyOf(boolean, OverlayMarkDef, enum('transparent')) + point : anyOf(boolean, :class:`OverlayMarkDef`, enum('transparent')) A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points. @@ -300,7 +301,7 @@ class AreaConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -309,7 +310,7 @@ class AreaConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -384,9 +385,9 @@ class AutoSizeParams(VegaLiteSchema): update. **Default value** : ``false`` - type : AutosizeType + type : :class:`AutosizeType` The sizing format type. One of ``"pad"``, ``"fit"`` or ``"none"``. See the `autosize - type `_ documentation for + type `__ documentation for descriptions of each. **Default value** : ``"pad"`` @@ -425,31 +426,31 @@ class Axis(VegaLiteSchema): **Default value:** ``true`` format : string The formatting pattern for labels. This is D3's `number format pattern - `_ for quantitative fields and D3's - `time format pattern `_ for time - field. + `__ for quantitative fields and D3's + `time format pattern `__ for + time field. - See the `format documentation `_ + See the `format documentation `__ for more information. **Default value:** derived from `numberFormat - `_ config for quantitative - fields and from `timeFormat - `_ config for temporal + `__ config for + quantitative fields and from `timeFormat + `__ config for temporal fields. grid : boolean A boolean flag indicating if grid lines should be included as part of the axis **Default value:** ``true`` for `continuous scales - `_ that are not binned; - otherwise, ``false``. + `__ that are not + binned; otherwise, ``false``. labelAngle : float The rotation angle of the axis labels. **Default value:** ``-90`` for nominal and ordinal fields; ``0`` otherwise. labelBound : anyOf(boolean, float) - Indicates if labels should be hidden if they exceed the axis range. If  ``false`` - (the default) no bounds overlap analysis is performed. If  ``true``, labels will be + Indicates if labels should be hidden if they exceed the axis range. If ``false`` + (the default) no bounds overlap analysis is performed. If ``true``, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range. @@ -497,9 +498,9 @@ class Axis(VegaLiteSchema): group or data rectangle. **Default value:** derived from the `axis config - `_ 's + `__ 's ``offset`` ( ``0`` by default) - orient : AxisOrient + orient : :class:`AxisOrient` The orientation of the axis. One of ``"top"``, ``"bottom"``, ``"left"`` or ``"right"``. The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). @@ -532,9 +533,9 @@ class Axis(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -543,7 +544,7 @@ class Axis(VegaLiteSchema): description. titlePadding : float The padding, in pixels, between title and axis. - values : anyOf(List(float), List(string), List(boolean), List(DateTime)) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`)) Explicitly set the visible axis tick values. zindex : float A non-positive integer indicating z-index of the axis. @@ -601,8 +602,8 @@ class AxisConfig(VegaLiteSchema): A boolean flag indicating if grid lines should be included as part of the axis **Default value:** ``true`` for `continuous scales - `_ that are not binned; - otherwise, ``false``. + `__ that are not + binned; otherwise, ``false``. gridColor : string Color of gridlines. gridDash : List(float) @@ -618,8 +619,8 @@ class AxisConfig(VegaLiteSchema): **Default value:** ``-90`` for nominal and ordinal fields; ``0`` otherwise. labelBound : anyOf(boolean, float) - Indicates if labels should be hidden if they exceed the axis range. If  ``false`` - (the default) no bounds overlap analysis is performed. If  ``true``, labels will be + Indicates if labels should be hidden if they exceed the axis range. If ``false`` + (the default) no bounds overlap analysis is performed. If ``true``, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range. @@ -697,7 +698,7 @@ class AxisConfig(VegaLiteSchema): Font of the title. (e.g., ``"Helvetica Neue"`` ). titleFontSize : float Font size of the title. - titleFontWeight : FontWeight + titleFontWeight : :class:`FontWeight` Font weight of the title. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -768,9 +769,9 @@ class AxisResolveMap(VegaLiteSchema): Attributes ---------- - x : ResolveMode + x : :class:`ResolveMode` - y : ResolveMode + y : :class:`ResolveMode` """ _schema = {'$ref': '#/definitions/AxisResolveMap'} @@ -788,11 +789,11 @@ class BarConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -809,7 +810,7 @@ class BarConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. continuousBandSize : float The default size of the bars on continuous scales. @@ -818,10 +819,10 @@ class BarConfig(VegaLiteSchema): The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -857,21 +858,21 @@ class BarConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -903,7 +904,7 @@ class BarConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -935,7 +936,7 @@ class BarConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -944,7 +945,7 @@ class BarConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -1088,7 +1089,7 @@ class BinTransform(VegaLiteSchema): Attributes ---------- - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) An object indicating bin properties, or simply ``true`` for using default bin parameters. field : string @@ -1152,7 +1153,7 @@ class CalculateTransform(VegaLiteSchema): ---------- calculate : string - A `expression `_ + A `expression `__ string. Use the variable ``datum`` to refer to the current data object. as : string The field for storing the computed formula value. @@ -1172,16 +1173,16 @@ class CompositeUnitSpec(VegaLiteSchema): Attributes ---------- - mark : AnyMark + mark : :class:`AnyMark` A string describing the mark type (one of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, ``"geoshape"``, and ``"text"`` ) or a `mark - definition object `_. - data : Data + definition object `__. + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. - encoding : Encoding + encoding : :class:`Encoding` A key-value mapping between encoding channels and definition of fields. height : float The height of a visualization. @@ -1189,38 +1190,39 @@ class CompositeUnitSpec(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - projection : Projection + projection : :class:`Projection` An object defining properties of geographic projection, which will be applied to ``shape`` path for ``"geoshape"`` marks and to ``latitude`` and ``"longitude"`` channels for other marks. selection : Mapping(required=[]) A key-value mapping between selection names and definitions. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -1228,29 +1230,30 @@ class CompositeUnitSpec(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. """ _schema = {'$ref': '#/definitions/CompositeUnitSpec'} _rootschema = Root._schema @@ -1267,7 +1270,7 @@ def __init__(self, mark=Undefined, data=Undefined, description=Undefined, encodi class ConditionalFieldDef(VegaLiteSchema): """ConditionalFieldDef schema wrapper - anyOf(ConditionalPredicateFieldDef, ConditionalSelectionFieldDef) + anyOf(:class:`ConditionalPredicateFieldDef`, :class:`ConditionalSelectionFieldDef`) """ _schema = {'$ref': '#/definitions/ConditionalFieldDef'} _rootschema = Root._schema @@ -1279,7 +1282,8 @@ def __init__(self, *args, **kwds): class ConditionalMarkPropFieldDef(VegaLiteSchema): """ConditionalMarkPropFieldDef schema wrapper - anyOf(ConditionalPredicateMarkPropFieldDef, ConditionalSelectionMarkPropFieldDef) + anyOf(:class:`ConditionalPredicateMarkPropFieldDef`, + :class:`ConditionalSelectionMarkPropFieldDef`) """ _schema = {'$ref': '#/definitions/ConditionalMarkPropFieldDef'} _rootschema = Root._schema @@ -1291,7 +1295,7 @@ def __init__(self, *args, **kwds): class ConditionalTextFieldDef(VegaLiteSchema): """ConditionalTextFieldDef schema wrapper - anyOf(ConditionalPredicateTextFieldDef, ConditionalSelectionTextFieldDef) + anyOf(:class:`ConditionalPredicateTextFieldDef`, :class:`ConditionalSelectionTextFieldDef`) """ _schema = {'$ref': '#/definitions/ConditionalTextFieldDef'} _rootschema = Root._schema @@ -1303,7 +1307,7 @@ def __init__(self, *args, **kwds): class ConditionalValueDef(VegaLiteSchema): """ConditionalValueDef schema wrapper - anyOf(ConditionalPredicateValueDef, ConditionalSelectionValueDef) + anyOf(:class:`ConditionalPredicateValueDef`, :class:`ConditionalSelectionValueDef`) """ _schema = {'$ref': '#/definitions/ConditionalValueDef'} _rootschema = Root._schema @@ -1320,44 +1324,44 @@ class ConditionalPredicateFieldDef(VegaLiteSchema): Attributes ---------- - test : LogicalOperandPredicate + test : :class:`LogicalOperandPredicate` - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1373,9 +1377,9 @@ class ConditionalPredicateFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1398,56 +1402,56 @@ class ConditionalPredicateMarkPropFieldDef(VegaLiteSchema): Attributes ---------- - test : LogicalOperandPredicate + test : :class:`LogicalOperandPredicate` - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1459,13 +1463,13 @@ class ConditionalPredicateMarkPropFieldDef(VegaLiteSchema): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1473,11 +1477,11 @@ class ConditionalPredicateMarkPropFieldDef(VegaLiteSchema): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1493,9 +1497,9 @@ class ConditionalPredicateMarkPropFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1522,47 +1526,47 @@ class ConditionalPredicateTextFieldDef(VegaLiteSchema): Attributes ---------- - test : LogicalOperandPredicate + test : :class:`LogicalOperandPredicate` - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1578,9 +1582,9 @@ class ConditionalPredicateTextFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1604,7 +1608,7 @@ class ConditionalPredicateValueDef(VegaLiteSchema): Attributes ---------- - test : LogicalOperandPredicate + test : :class:`LogicalOperandPredicate` value : anyOf(float, string, boolean) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values @@ -1625,46 +1629,46 @@ class ConditionalSelectionFieldDef(VegaLiteSchema): Attributes ---------- - selection : SelectionOperand - A `selection name `_, or a + selection : :class:`SelectionOperand` + A `selection name `__, or a series of `composed selections - `_. - type : Type + `__. + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1680,9 +1684,9 @@ class ConditionalSelectionFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1705,58 +1709,58 @@ class ConditionalSelectionMarkPropFieldDef(VegaLiteSchema): Attributes ---------- - selection : SelectionOperand - A `selection name `_, or a + selection : :class:`SelectionOperand` + A `selection name `__, or a series of `composed selections - `_. - type : Type + `__. + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -1768,13 +1772,13 @@ class ConditionalSelectionMarkPropFieldDef(VegaLiteSchema): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -1782,11 +1786,11 @@ class ConditionalSelectionMarkPropFieldDef(VegaLiteSchema): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1802,9 +1806,9 @@ class ConditionalSelectionMarkPropFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1831,49 +1835,49 @@ class ConditionalSelectionTextFieldDef(VegaLiteSchema): Attributes ---------- - selection : SelectionOperand - A `selection name `_, or a + selection : :class:`SelectionOperand` + A `selection name `__, or a series of `composed selections - `_. - type : Type + `__. + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -1889,9 +1893,9 @@ class ConditionalSelectionTextFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -1915,10 +1919,10 @@ class ConditionalSelectionValueDef(VegaLiteSchema): Attributes ---------- - selection : SelectionOperand - A `selection name `_, or a + selection : :class:`SelectionOperand` + A `selection name `__, or a series of `composed selections - `_. + `__. value : anyOf(float, string, boolean) A constant value in visual domain (e.g., ``"red"`` / "#0099ff" for color, values between ``0`` to ``1`` for opacity). @@ -1938,9 +1942,9 @@ class Config(VegaLiteSchema): Attributes ---------- - area : AreaConfig + area : :class:`AreaConfig` Area-Specific Config - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -1949,38 +1953,38 @@ class Config(VegaLiteSchema): ``rangeStep``. **Default value** : ``pad`` - axis : AxisConfig + axis : :class:`AxisConfig` Axis configuration, which determines default properties for all ``x`` and ``y`` - `axes `_. For a full list of axis + `axes `__. For a full list of axis configuration options, please see the `corresponding section of the axis - documentation `_. - axisBand : VgAxisConfig + documentation `__. + axisBand : :class:`VgAxisConfig` Specific axis config for axes with "band" scales. - axisBottom : VgAxisConfig + axisBottom : :class:`VgAxisConfig` Specific axis config for x-axis along the bottom edge of the chart. - axisLeft : VgAxisConfig + axisLeft : :class:`VgAxisConfig` Specific axis config for y-axis along the left edge of the chart. - axisRight : VgAxisConfig + axisRight : :class:`VgAxisConfig` Specific axis config for y-axis along the right edge of the chart. - axisTop : VgAxisConfig + axisTop : :class:`VgAxisConfig` Specific axis config for x-axis along the top edge of the chart. - axisX : VgAxisConfig + axisX : :class:`VgAxisConfig` X-axis specific config. - axisY : VgAxisConfig + axisY : :class:`VgAxisConfig` Y-axis specific config. background : string CSS color property to use as the background of visualization. **Default value:** none (transparent) - bar : BarConfig + bar : :class:`BarConfig` Bar-Specific Config - circle : MarkConfig + circle : :class:`MarkConfig` Circle-Specific Config countTitle : string Default axis and legend title for count fields. **Default value:** ``'Number of Records'``. - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive @@ -1995,13 +1999,13 @@ class Config(VegaLiteSchema): "SUM(field)", "YEARMONTH(date)", "BIN(field)"). * ``"plain"`` - displays only the field name without functions (e.g., "field", "date", "field"). - geoshape : MarkConfig + geoshape : :class:`MarkConfig` Geoshape-Specific Config - header : HeaderConfig + header : :class:`HeaderConfig` Header configuration, which determines default properties for all `header - `_. For a full list of header + `__. For a full list of header configuration options, please see the `corresponding section of in the header - documentation `_. + documentation `__. invalidValues : enum('filter', None) Defines how Vega-Lite should handle invalid values ( ``null`` and ``NaN`` ). @@ -2010,79 +2014,79 @@ class Config(VegaLiteSchema): (for line, trail, and area marks) or filtered (for other marks). * If ``null``, all data items are included. In this case, invalid values will be interpreted as zeroes. - legend : LegendConfig + legend : :class:`LegendConfig` Legend configuration, which determines default properties for all `legends - `_. For a full list of legend + `__. For a full list of legend configuration options, please see the `corresponding section of in the legend - documentation `_. - line : LineConfig + documentation `__. + line : :class:`LineConfig` Line-Specific Config - mark : MarkConfig + mark : :class:`MarkConfig` Mark Config numberFormat : string D3 Number format for axis labels and text tables. For example "s" for SI units. Use - `D3's number format pattern `_. - padding : Padding + `D3's number format pattern `__. + padding : :class:`Padding` 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`` - point : MarkConfig + point : :class:`MarkConfig` Point-Specific Config - projection : ProjectionConfig + projection : :class:`ProjectionConfig` Projection configuration, which determines default properties for all `projections - `_. For a full list of + `__. For a full list of projection configuration options, please see the `corresponding section of the projection documentation - `_. - range : RangeConfig + `__. + range : :class:`RangeConfig` An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the `corresponding section of the scale documentation - `_. - rect : MarkConfig + `__. + rect : :class:`MarkConfig` Rect-Specific Config - rule : MarkConfig + rule : :class:`MarkConfig` Rule-Specific Config - scale : ScaleConfig + scale : :class:`ScaleConfig` Scale configuration determines default properties for all `scales - `_. For a full list of scale + `__. For a full list of scale configuration options, please see the `corresponding section of the scale - documentation `_. - selection : SelectionConfig + documentation `__. + selection : :class:`SelectionConfig` An object hash for defining default properties for each type of selections. - square : MarkConfig + square : :class:`MarkConfig` Square-Specific Config - stack : StackOffset + stack : :class:`StackOffset` Default stack offset for stackable mark. - style : StyleConfigIndex + style : :class:`StyleConfigIndex` An object hash that defines key-value mappings to determine default properties for marks with a given `style - `_. The keys represent + `__. The keys represent styles names; the values have to be valid `mark configuration objects - `_. - text : TextConfig + `__. + text : :class:`TextConfig` Text-Specific Config - tick : TickConfig + tick : :class:`TickConfig` Tick-Specific Config timeFormat : string Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use `D3's time format pattern - `_. + `__. **Default value:** ``''`` (The format will be automatically determined). - title : VgTitleConfig + title : :class:`VgTitleConfig` Title configuration, which determines default properties for all `titles - `_. For a full list of title + `__. For a full list of title configuration options, please see the `corresponding section of the title - documentation `_. - trail : LineConfig + documentation `__. + trail : :class:`LineConfig` Trail-Specific Config - view : ViewConfig + view : :class:`ViewConfig` Default properties for `single view plots - `_. + `__. """ _schema = {'$ref': '#/definitions/Config'} _rootschema = Root._schema @@ -2118,7 +2122,7 @@ class CsvDataFormat(VegaLiteSchema): Attributes ---------- - parse : anyOf(enum('auto'), Parse, None) + parse : anyOf(enum('auto'), :class:`Parse`, None) If set to ``"auto"`` (the default), perform automatic type inference to determine the desired data types. If set to ``null``, disable type inference based on the spec and only use type @@ -2131,11 +2135,12 @@ class CsvDataFormat(VegaLiteSchema): in each input record a Date value. For ``"date"``, we parse data based using Javascript's `Date.parse() - `_. + `__. For Specific date formats can be provided (e.g., ``{foo: 'date:"%m%d%Y"'}`` ), using - the `d3-time-format syntax `_. + the `d3-time-format syntax `__. UTC date format parsing is supported similarly (e.g., ``{foo: 'utc:"%m%d%Y"'}`` ). - See more about `UTC time `_ + See more about `UTC time + `__ type : enum('csv', 'tsv') Type of input data: ``"json"``, ``"csv"``, ``"tsv"``, ``"dsv"``. The default format type is determined by the extension of the file URL. @@ -2167,7 +2172,7 @@ def __init__(self, *args): class Data(VegaLiteSchema): """Data schema wrapper - anyOf(UrlData, InlineData, NamedData) + anyOf(:class:`UrlData`, :class:`InlineData`, :class:`NamedData`) """ _schema = {'$ref': '#/definitions/Data'} _rootschema = Root._schema @@ -2179,7 +2184,8 @@ def __init__(self, *args, **kwds): class DataFormat(VegaLiteSchema): """DataFormat schema wrapper - anyOf(CsvDataFormat, DsvDataFormat, JsonDataFormat, TopoDataFormat) + anyOf(:class:`CsvDataFormat`, :class:`DsvDataFormat`, :class:`JsonDataFormat`, + :class:`TopoDataFormat`) """ _schema = {'$ref': '#/definitions/DataFormat'} _rootschema = Root._schema @@ -2214,7 +2220,7 @@ class DateTime(VegaLiteSchema): date : float Integer value representing the date from 1-31. - day : anyOf(Day, string) + day : anyOf(:class:`Day`, string) Value representing the day of a week. This can be one of: (1) integer value -- ``1`` represents Monday; (2) case-insensitive day name (e.g., ``"Monday"`` ); (3) case-insensitive, 3-character short day name (e.g., ``"Mon"`` ). :raw-html:`
` @@ -2226,7 +2232,7 @@ class DateTime(VegaLiteSchema): Integer value representing the millisecond segment of time. minutes : float Integer value representing the minute segment of time from 0-59. - month : anyOf(Month, string) + month : anyOf(:class:`Month`, string) One of: (1) integer value representing the month from ``1`` - ``12``. ``1`` represents January; (2) case-insensitive month name (e.g., ``"January"`` ); (3) case-insensitive, 3-character short month name (e.g., ``"Jan"`` ). @@ -2299,7 +2305,7 @@ class DsvDataFormat(VegaLiteSchema): The delimiter between records. The delimiter must be a single character (i.e., a single 16-bit code unit); so, ASCII delimiters are fine, but emoji delimiters are not. - parse : anyOf(enum('auto'), Parse, None) + parse : anyOf(enum('auto'), :class:`Parse`, None) If set to ``"auto"`` (the default), perform automatic type inference to determine the desired data types. If set to ``null``, disable type inference based on the spec and only use type @@ -2312,11 +2318,12 @@ class DsvDataFormat(VegaLiteSchema): in each input record a Date value. For ``"date"``, we parse data based using Javascript's `Date.parse() - `_. + `__. For Specific date formats can be provided (e.g., ``{foo: 'date:"%m%d%Y"'}`` ), using - the `d3-time-format syntax `_. + the `d3-time-format syntax `__. UTC date format parsing is supported similarly (e.g., ``{foo: 'utc:"%m%d%Y"'}`` ). - See more about `UTC time `_ + See more about `UTC time + `__ type : enum('dsv') Type of input data: ``"json"``, ``"csv"``, ``"tsv"``, ``"dsv"``. The default format type is determined by the extension of the file URL. @@ -2337,7 +2344,8 @@ class Encoding(VegaLiteSchema): Attributes ---------- - color : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + color : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Color of the marks – either fill or stroke color based on the ``filled`` property of mark definition. By default, ``color`` represents fill color for ``"area"``, ``"bar"``, ``"tick"``, @@ -2345,72 +2353,74 @@ class Encoding(VegaLiteSchema): ``"line"`` and ``"point"``. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *Note:* 1) For fine-grained control over both fill and stroke colors of the marks, please use the ``fill`` and ``stroke`` channels. If either ``fill`` or ``stroke`` channel is specified, ``color`` channel will be ignored. 2) See the scale documentation for more information about customizing `color scheme - `_. - detail : anyOf(FieldDef, List(FieldDef)) + `__. + detail : anyOf(:class:`FieldDef`, List(:class:`FieldDef`)) Additional levels of detail for grouping data in aggregate views and in line, trail, and area marks without mapping data to a specific visual channel. - fill : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + fill : anyOf(:class:`MarkPropFieldDefWithCondition`, :class:`MarkPropValueDefWithCondition`) Fill color of the marks. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *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`` ). - href : anyOf(FieldDefWithCondition, ValueDefWithCondition) + href : anyOf(:class:`FieldDefWithCondition`, :class:`ValueDefWithCondition`) A URL to load upon mouse click. - key : FieldDef + key : :class:`FieldDef` A data field to use as a unique key for data binding. When a visualization’s data is updated, the key value will be used to match data elements to existing mark instances. Use a key channel to enable object constancy for transitions over dynamic data. - latitude : FieldDef + latitude : :class:`FieldDef` Latitude position of geographically projected marks. - latitude2 : FieldDef + latitude2 : :class:`FieldDef` Latitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - longitude : FieldDef + longitude : :class:`FieldDef` Longitude position of geographically projected marks. - longitude2 : FieldDef + longitude2 : :class:`FieldDef` Longitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - opacity : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + opacity : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Opacity of the marks – either can be a value or a range. **Default value:** If undefined, the default opacity depends on `mark config - `_ 's ``opacity`` property. - order : anyOf(OrderFieldDef, List(OrderFieldDef), ValueDef) + `__ 's ``opacity`` property. + order : anyOf(:class:`OrderFieldDef`, List(:class:`OrderFieldDef`), :class:`ValueDef`) Order of the marks. * For stacked marks, this ``order`` channel encodes `stack order - `_. + `__. * For line and trail marks, this ``order`` channel encodes order of data points in the lines. This can be useful for creating `a connected scatterplot - `_. Setting - ``order`` to ``{"value": null}`` makes the line marks use the original order in - the data sources. + `__. + Setting ``order`` to ``{"value": null}`` makes the line marks use the original + order in the data sources. * Otherwise, this ``order`` channel encodes layer order of the marks. **Note** : In aggregate plots, ``order`` field should be ``aggregate`` d to avoid creating additional aggregation grouping. - shape : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + shape : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) For ``point`` marks the supported values are ``"circle"`` (default), ``"square"``, ``"cross"``, ``"diamond"``, ``"triangle-up"``, or ``"triangle-down"``, or else a custom SVG path string. For ``geoshape`` marks it should be a field definition of the geojson data **Default value:** If undefined, the default shape depends on `mark config - `_ 's ``shape`` + `__ 's ``shape`` property. - size : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + size : anyOf(:class:`MarkPropFieldDefWithCondition`, :class:`MarkPropValueDefWithCondition`) Size of the mark. @@ -2420,25 +2430,27 @@ class Encoding(VegaLiteSchema): * For ``"text"`` – the text's font size. * Size is unsupported for ``"line"``, ``"area"``, and ``"rect"``. (Use ``"trail"`` instead of line with varying size) - stroke : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + stroke : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Stroke color of the marks. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *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`` ). - text : anyOf(TextFieldDefWithCondition, TextValueDefWithCondition) + text : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`) Text of the ``text`` mark. - tooltip : anyOf(TextFieldDefWithCondition, TextValueDefWithCondition, List(TextFieldDef)) + tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, + List(:class:`TextFieldDef`)) The tooltip text to show upon mouse hover. - x : anyOf(PositionFieldDef, ValueDef) + x : anyOf(:class:`PositionFieldDef`, :class:`ValueDef`) X coordinates of the marks, or width of horizontal ``"bar"`` and ``"area"``. - x2 : anyOf(FieldDef, ValueDef) + x2 : anyOf(:class:`FieldDef`, :class:`ValueDef`) X2 coordinates for ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - y : anyOf(PositionFieldDef, ValueDef) + y : anyOf(:class:`PositionFieldDef`, :class:`ValueDef`) Y coordinates of the marks, or height of vertical ``"bar"`` and ``"area"``. - y2 : anyOf(FieldDef, ValueDef) + y2 : anyOf(:class:`FieldDef`, :class:`ValueDef`) Y2 coordinates for ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. """ _schema = {'$ref': '#/definitions/Encoding'} @@ -2465,22 +2477,22 @@ class EncodingSortField(VegaLiteSchema): Attributes ---------- - op : AggregateOp - An `aggregate operation `_ - to perform on the field prior to sorting (e.g., ``"count"``, ``"mean"`` and - ``"median"`` ). + op : :class:`AggregateOp` + An `aggregate operation + `__ to perform on the + field prior to sorting (e.g., ``"count"``, ``"mean"`` and ``"median"`` ). This property is required in cases where the sort field and the data reference field do not match. The input data objects will be aggregated, grouped by the encoded data field. For a full list of operations, please see the documentation for `aggregate - `_. - field : anyOf(string, RepeatRef) - The data `field `_ to sort by. + `__. + field : anyOf(string, :class:`RepeatRef`) + The data `field `__ to sort by. **Default value:** If unspecified, defaults to the field specified in the outer data reference. - order : SortOrder + order : :class:`SortOrder` The sort order. One of ``"ascending"`` (default), ``"descending"``, or ``null`` (no not sort). """ @@ -2499,7 +2511,8 @@ class EncodingWithFacet(VegaLiteSchema): Attributes ---------- - color : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + color : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Color of the marks – either fill or stroke color based on the ``filled`` property of mark definition. By default, ``color`` represents fill color for ``"area"``, ``"bar"``, ``"tick"``, @@ -2507,76 +2520,78 @@ class EncodingWithFacet(VegaLiteSchema): ``"line"`` and ``"point"``. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *Note:* 1) For fine-grained control over both fill and stroke colors of the marks, please use the ``fill`` and ``stroke`` channels. If either ``fill`` or ``stroke`` channel is specified, ``color`` channel will be ignored. 2) See the scale documentation for more information about customizing `color scheme - `_. - column : FacetFieldDef + `__. + column : :class:`FacetFieldDef` Horizontal facets for trellis plots. - detail : anyOf(FieldDef, List(FieldDef)) + detail : anyOf(:class:`FieldDef`, List(:class:`FieldDef`)) Additional levels of detail for grouping data in aggregate views and in line, trail, and area marks without mapping data to a specific visual channel. - fill : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + fill : anyOf(:class:`MarkPropFieldDefWithCondition`, :class:`MarkPropValueDefWithCondition`) Fill color of the marks. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *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`` ). - href : anyOf(FieldDefWithCondition, ValueDefWithCondition) + href : anyOf(:class:`FieldDefWithCondition`, :class:`ValueDefWithCondition`) A URL to load upon mouse click. - key : FieldDef + key : :class:`FieldDef` A data field to use as a unique key for data binding. When a visualization’s data is updated, the key value will be used to match data elements to existing mark instances. Use a key channel to enable object constancy for transitions over dynamic data. - latitude : FieldDef + latitude : :class:`FieldDef` Latitude position of geographically projected marks. - latitude2 : FieldDef + latitude2 : :class:`FieldDef` Latitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - longitude : FieldDef + longitude : :class:`FieldDef` Longitude position of geographically projected marks. - longitude2 : FieldDef + longitude2 : :class:`FieldDef` Longitude-2 position for geographically projected ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - opacity : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + opacity : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Opacity of the marks – either can be a value or a range. **Default value:** If undefined, the default opacity depends on `mark config - `_ 's ``opacity`` property. - order : anyOf(OrderFieldDef, List(OrderFieldDef), ValueDef) + `__ 's ``opacity`` property. + order : anyOf(:class:`OrderFieldDef`, List(:class:`OrderFieldDef`), :class:`ValueDef`) Order of the marks. * For stacked marks, this ``order`` channel encodes `stack order - `_. + `__. * For line and trail marks, this ``order`` channel encodes order of data points in the lines. This can be useful for creating `a connected scatterplot - `_. Setting - ``order`` to ``{"value": null}`` makes the line marks use the original order in - the data sources. + `__. + Setting ``order`` to ``{"value": null}`` makes the line marks use the original + order in the data sources. * Otherwise, this ``order`` channel encodes layer order of the marks. **Note** : In aggregate plots, ``order`` field should be ``aggregate`` d to avoid creating additional aggregation grouping. - row : FacetFieldDef + row : :class:`FacetFieldDef` Vertical facets for trellis plots. - shape : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + shape : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) For ``point`` marks the supported values are ``"circle"`` (default), ``"square"``, ``"cross"``, ``"diamond"``, ``"triangle-up"``, or ``"triangle-down"``, or else a custom SVG path string. For ``geoshape`` marks it should be a field definition of the geojson data **Default value:** If undefined, the default shape depends on `mark config - `_ 's ``shape`` + `__ 's ``shape`` property. - size : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + size : anyOf(:class:`MarkPropFieldDefWithCondition`, :class:`MarkPropValueDefWithCondition`) Size of the mark. @@ -2586,25 +2601,27 @@ class EncodingWithFacet(VegaLiteSchema): * For ``"text"`` – the text's font size. * Size is unsupported for ``"line"``, ``"area"``, and ``"rect"``. (Use ``"trail"`` instead of line with varying size) - stroke : anyOf(MarkPropFieldDefWithCondition, MarkPropValueDefWithCondition) + stroke : anyOf(:class:`MarkPropFieldDefWithCondition`, + :class:`MarkPropValueDefWithCondition`) Stroke color of the marks. **Default value:** If undefined, the default color depends on `mark config - `_ 's ``color`` property. + `__ 's ``color`` property. *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`` ). - text : anyOf(TextFieldDefWithCondition, TextValueDefWithCondition) + text : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`) Text of the ``text`` mark. - tooltip : anyOf(TextFieldDefWithCondition, TextValueDefWithCondition, List(TextFieldDef)) + tooltip : anyOf(:class:`TextFieldDefWithCondition`, :class:`TextValueDefWithCondition`, + List(:class:`TextFieldDef`)) The tooltip text to show upon mouse hover. - x : anyOf(PositionFieldDef, ValueDef) + x : anyOf(:class:`PositionFieldDef`, :class:`ValueDef`) X coordinates of the marks, or width of horizontal ``"bar"`` and ``"area"``. - x2 : anyOf(FieldDef, ValueDef) + x2 : anyOf(:class:`FieldDef`, :class:`ValueDef`) X2 coordinates for ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. - y : anyOf(PositionFieldDef, ValueDef) + y : anyOf(:class:`PositionFieldDef`, :class:`ValueDef`) Y coordinates of the marks, or height of vertical ``"bar"`` and ``"area"``. - y2 : anyOf(FieldDef, ValueDef) + y2 : anyOf(:class:`FieldDef`, :class:`ValueDef`) Y2 coordinates for ranged ``"area"``, ``"bar"``, ``"rect"``, and ``"rule"``. """ _schema = {'$ref': '#/definitions/EncodingWithFacet'} @@ -2633,16 +2650,16 @@ class LayerSpec(VegaLiteSchema): Attributes ---------- - layer : List(anyOf(LayerSpec, CompositeUnitSpec)) + layer : List(anyOf(:class:`LayerSpec`, :class:`CompositeUnitSpec`)) Layer or single view specifications to be layered. **Note** : Specifications inside ``layer`` cannot use ``row`` and ``column`` channels as layering facet specifications is not allowed. - data : Data + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. - encoding : Encoding + encoding : :class:`Encoding` A shared key-value mapping between encoding channels and definition of fields in the underlying layers. height : float @@ -2651,37 +2668,38 @@ class LayerSpec(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - projection : Projection + projection : :class:`Projection` An object defining properties of the geographic projection shared by underlying layers. - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for layers. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -2689,29 +2707,30 @@ class LayerSpec(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. """ _schema = {'$ref': '#/definitions/LayerSpec'} _rootschema = Root._schema @@ -2733,40 +2752,40 @@ class FacetFieldDef(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - header : Header + header : :class:`Header` An object defining properties of a facet's header. - sort : Sort + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -2778,13 +2797,13 @@ class FacetFieldDef(VegaLiteSchema): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -2792,11 +2811,11 @@ class FacetFieldDef(VegaLiteSchema): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2812,9 +2831,9 @@ class FacetFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -2837,9 +2856,9 @@ class FacetMapping(VegaLiteSchema): Attributes ---------- - column : FacetFieldDef + column : :class:`FacetFieldDef` Horizontal facets for trellis plots. - row : FacetFieldDef + row : :class:`FacetFieldDef` Vertical facets for trellis plots. """ _schema = {'$ref': '#/definitions/FacetMapping'} @@ -2858,42 +2877,42 @@ class FieldDef(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2909,9 +2928,9 @@ class FieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -2934,48 +2953,48 @@ class FieldDefWithCondition(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -2991,9 +3010,9 @@ class FieldDefWithCondition(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -3017,60 +3036,60 @@ class MarkPropFieldDefWithCondition(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - legend : anyOf(Legend, None) + legend : anyOf(:class:`Legend`, None) An object defining properties of the legend. If ``null``, the legend for the encoding channel will be removed. **Default value:** If undefined, default `legend properties - `_ are applied. - scale : anyOf(Scale, None) + `__ are applied. + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -3082,13 +3101,13 @@ class MarkPropFieldDefWithCondition(VegaLiteSchema): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -3096,11 +3115,11 @@ class MarkPropFieldDefWithCondition(VegaLiteSchema): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -3116,9 +3135,9 @@ class MarkPropFieldDefWithCondition(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -3144,51 +3163,51 @@ class TextFieldDefWithCondition(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - condition : anyOf(ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalValueDef`, List(:class:`ConditionalValueDef`)) One or more value definition(s) with a selection predicate. **Note:** A field definition's ``condition`` property can only contain `value - definitions `_ + definitions `__ since Vega-Lite only allows at most one encoded field per encoding channel. - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -3204,9 +3223,9 @@ class TextFieldDefWithCondition(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -3229,11 +3248,11 @@ class FieldEqualPredicate(VegaLiteSchema): Attributes ---------- - equal : anyOf(string, float, boolean, DateTime) + equal : anyOf(string, float, boolean, :class:`DateTime`) The value that the field should be equal to. field : string Field to be filtered. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldEqualPredicate'} @@ -3253,9 +3272,9 @@ class FieldGTEPredicate(VegaLiteSchema): field : string Field to be filtered. - gte : anyOf(string, float, DateTime) + gte : anyOf(string, float, :class:`DateTime`) The value that the field should be greater than or equals to. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldGTEPredicate'} @@ -3275,9 +3294,9 @@ class FieldGTPredicate(VegaLiteSchema): field : string Field to be filtered. - gt : anyOf(string, float, DateTime) + gt : anyOf(string, float, :class:`DateTime`) The value that the field should be greater than. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldGTPredicate'} @@ -3297,9 +3316,9 @@ class FieldLTEPredicate(VegaLiteSchema): field : string Field to be filtered. - lte : anyOf(string, float, DateTime) + lte : anyOf(string, float, :class:`DateTime`) The value that the field should be less than or equals to. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldLTEPredicate'} @@ -3319,9 +3338,9 @@ class FieldLTPredicate(VegaLiteSchema): field : string Field to be filtered. - lt : anyOf(string, float, DateTime) + lt : anyOf(string, float, :class:`DateTime`) The value that the field should be less than. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldLTPredicate'} @@ -3341,10 +3360,10 @@ class FieldOneOfPredicate(VegaLiteSchema): field : string Field to be filtered. - oneOf : anyOf(List(string), List(float), List(boolean), List(DateTime)) + oneOf : anyOf(List(string), List(float), List(boolean), List(:class:`DateTime`)) A set of values that the ``field`` 's value should be a member of, for a data item included in the filtered data. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldOneOfPredicate'} @@ -3364,10 +3383,10 @@ class FieldRangePredicate(VegaLiteSchema): field : string Field to be filtered. - range : List(anyOf(float, DateTime, None)) + range : List(anyOf(float, :class:`DateTime`, None)) An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit for the field to be filtered. """ _schema = {'$ref': '#/definitions/FieldRangePredicate'} @@ -3385,24 +3404,24 @@ class FilterTransform(VegaLiteSchema): Attributes ---------- - filter : LogicalOperandPredicate + filter : :class:`LogicalOperandPredicate` The ``filter`` property must be one of the predicate definitions: - 1) an `expression `_ + 1) an `expression `__ string, where ``datum`` can be used to refer to the current data object 2) one of the field predicates: `equal - `_, - `lt `_, - `lte `_, - `gt `_, - `gte `_, - `range `_, - or `oneOf `_. + `__, + `lt `__, + `lte `__, + `gt `__, + `gte `__, + `range `__, + or `oneOf `__. 3) a `selection predicate - `_ + `__ 4) a logical operand that combines (1), (2), or (3). """ @@ -3428,7 +3447,7 @@ def __init__(self, *args): class FontWeight(VegaLiteSchema): """FontWeight schema wrapper - anyOf(FontWeightString, FontWeightNumber) + anyOf(:class:`FontWeightString`, :class:`FontWeightNumber`) """ _schema = {'$ref': '#/definitions/FontWeight'} _rootschema = Root._schema @@ -3469,12 +3488,12 @@ class FacetSpec(VegaLiteSchema): Attributes ---------- - facet : FacetMapping + facet : :class:`FacetMapping` An object that describes mappings between ``row`` and ``column`` channels and their field definitions. - spec : anyOf(LayerSpec, CompositeUnitSpec) + spec : anyOf(:class:`LayerSpec`, :class:`CompositeUnitSpec`) A specification of the view that gets faceted. - align : anyOf(VgLayoutAlign, RowColVgLayoutAlign) + align : anyOf(:class:`VgLayoutAlign`, :class:`RowColVgLayoutAlign`) The alignment to apply to grid rows and columns. The supported string values are ``"all"``, ``"each"``, and ``"none"``. @@ -3503,7 +3522,7 @@ class FacetSpec(VegaLiteSchema): sub-plots without axes or legends into a uniform grid structure. **Default value:** ``"full"`` - center : anyOf(boolean, RowColboolean) + center : anyOf(boolean, :class:`RowColboolean`) Boolean flag indicating if subviews should be centered relative to their respective rows or columns. @@ -3511,23 +3530,23 @@ class FacetSpec(VegaLiteSchema): supply different centering values for rows and columns. **Default value:** ``false`` - data : Data + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for facets. - spacing : anyOf(float, RowColnumber) + spacing : anyOf(float, :class:`RowColnumber`) The spacing in pixels between sub-views of the composition operator. An object of the form ``{"row": number, "column": number}`` can be used to set different spacing values for rows and columns. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. """ _schema = {'$ref': '#/definitions/FacetSpec'} @@ -3550,7 +3569,7 @@ class HConcatSpec(VegaLiteSchema): Attributes ---------- - hconcat : List(Spec) + hconcat : List(:class:`Spec`) A list of views that should be concatenated and put into a row. bounds : enum('full', 'flush') The bounds calculation method to use for determining the extent of a sub-plot. One @@ -3569,21 +3588,21 @@ class HConcatSpec(VegaLiteSchema): rows or columns. **Default value:** ``false`` - data : Data + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for horizontally concatenated charts. spacing : float The spacing in pixels between sub-views of the concat operator. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. """ _schema = {'$ref': '#/definitions/HConcatSpec'} @@ -3605,12 +3624,12 @@ class RepeatSpec(VegaLiteSchema): Attributes ---------- - repeat : Repeat + repeat : :class:`Repeat` An object that describes what fields should be repeated into views that are laid out as a ``row`` or ``column``. - spec : Spec + spec : :class:`Spec` - align : anyOf(VgLayoutAlign, RowColVgLayoutAlign) + align : anyOf(:class:`VgLayoutAlign`, :class:`RowColVgLayoutAlign`) The alignment to apply to grid rows and columns. The supported string values are ``"all"``, ``"each"``, and ``"none"``. @@ -3639,7 +3658,7 @@ class RepeatSpec(VegaLiteSchema): sub-plots without axes or legends into a uniform grid structure. **Default value:** ``"full"`` - center : anyOf(boolean, RowColboolean) + center : anyOf(boolean, :class:`RowColboolean`) Boolean flag indicating if subviews should be centered relative to their respective rows or columns. @@ -3647,23 +3666,23 @@ class RepeatSpec(VegaLiteSchema): supply different centering values for rows and columns. **Default value:** ``false`` - data : Data + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - resolve : Resolve + resolve : :class:`Resolve` Scale and legend resolutions for repeated charts. - spacing : anyOf(float, RowColnumber) + spacing : anyOf(float, :class:`RowColnumber`) The spacing in pixels between sub-views of the composition operator. An object of the form ``{"row": number, "column": number}`` can be used to set different spacing values for rows and columns. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. """ _schema = {'$ref': '#/definitions/RepeatSpec'} @@ -3681,7 +3700,8 @@ def __init__(self, repeat=Undefined, spec=Undefined, align=Undefined, bounds=Und class Spec(VegaLiteSchema): """Spec schema wrapper - anyOf(CompositeUnitSpec, LayerSpec, FacetSpec, RepeatSpec, VConcatSpec, HConcatSpec) + anyOf(:class:`CompositeUnitSpec`, :class:`LayerSpec`, :class:`FacetSpec`, + :class:`RepeatSpec`, :class:`VConcatSpec`, :class:`HConcatSpec`) """ _schema = {'$ref': '#/definitions/Spec'} _rootschema = Root._schema @@ -3698,16 +3718,16 @@ class CompositeUnitSpecAlias(VegaLiteSchema): Attributes ---------- - mark : AnyMark + mark : :class:`AnyMark` A string describing the mark type (one of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, ``"geoshape"``, and ``"text"`` ) or a `mark - definition object `_. - data : Data + definition object `__. + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. - encoding : Encoding + encoding : :class:`Encoding` A key-value mapping between encoding channels and definition of fields. height : float The height of a visualization. @@ -3715,38 +3735,39 @@ class CompositeUnitSpecAlias(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - projection : Projection + projection : :class:`Projection` An object defining properties of geographic projection, which will be applied to ``shape`` path for ``"geoshape"`` marks and to ``latitude`` and ``"longitude"`` channels for other marks. selection : Mapping(required=[]) A key-value mapping between selection names and definitions. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -3754,29 +3775,30 @@ class CompositeUnitSpecAlias(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. """ _schema = {'$ref': '#/definitions/CompositeUnitSpecAlias'} _rootschema = Root._schema @@ -3799,16 +3821,16 @@ class FacetedCompositeUnitSpecAlias(VegaLiteSchema): Attributes ---------- - mark : AnyMark + mark : :class:`AnyMark` A string describing the mark type (one of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, ``"geoshape"``, and ``"text"`` ) or a `mark - definition object `_. - data : Data + definition object `__. + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. - encoding : EncodingWithFacet + encoding : :class:`EncodingWithFacet` A key-value mapping between encoding channels and definition of fields. height : float The height of a visualization. @@ -3816,38 +3838,39 @@ class FacetedCompositeUnitSpecAlias(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - projection : Projection + projection : :class:`Projection` An object defining properties of geographic projection, which will be applied to ``shape`` path for ``"geoshape"`` marks and to ``latitude`` and ``"longitude"`` channels for other marks. selection : Mapping(required=[]) A key-value mapping between selection names and definitions. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -3855,29 +3878,30 @@ class FacetedCompositeUnitSpecAlias(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. """ _schema = {'$ref': '#/definitions/FacetedCompositeUnitSpecAlias'} _rootschema = Root._schema @@ -3901,7 +3925,7 @@ class VConcatSpec(VegaLiteSchema): Attributes ---------- - vconcat : List(Spec) + vconcat : List(:class:`Spec`) A list of views that should be concatenated and put into a column. bounds : enum('full', 'flush') The bounds calculation method to use for determining the extent of a sub-plot. One @@ -3920,21 +3944,21 @@ class VConcatSpec(VegaLiteSchema): rows or columns. **Default value:** ``false`` - data : Data + data : :class:`Data` An object describing the data source description : string Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for vertically concatenated charts. spacing : float The spacing in pixels between sub-views of the concat operator. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. """ _schema = {'$ref': '#/definitions/VConcatSpec'} @@ -3971,17 +3995,17 @@ class Header(VegaLiteSchema): format : string The formatting pattern for labels. This is D3's `number format pattern - `_ for quantitative fields and D3's - `time format pattern `_ for time - field. + `__ for quantitative fields and D3's + `time format pattern `__ for + time field. - See the `format documentation `_ + See the `format documentation `__ for more information. **Default value:** derived from `numberFormat - `_ config for quantitative - fields and from `timeFormat - `_ config for temporal + `__ config for + quantitative fields and from `timeFormat + `__ config for temporal fields. labelAngle : float The rotation angle of the header labels. @@ -4011,9 +4035,9 @@ class Header(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -4023,20 +4047,20 @@ class Header(VegaLiteSchema): left-, center-, or right-aligned title. **Default value:** ``"middle"`` for `single - `_ and `layered - `_ views. + `__ and `layered + `__ views. ``"start"`` for other composite views. - **Note:** `For now `_, ``anchor`` is + **Note:** `For now `__, ``anchor`` is only customizable only for `single - `_ and `layered - `_ views. For other composite + `__ and `layered + `__ views. For other composite views, ``anchor`` is always ``"start"``. titleAngle : float The rotation angle of the header title. **Default value:** ``0``. - titleBaseline : TextBaseline + titleBaseline : :class:`TextBaseline` Vertical text baseline for the header title. One of ``"top"``, ``"bottom"``, ``"middle"``. @@ -4047,7 +4071,7 @@ class Header(VegaLiteSchema): Font of the header title. (e.g., ``"Helvetica Neue"`` ). titleFontSize : float Font size of the header title. - titleFontWeight : FontWeight + titleFontWeight : :class:`FontWeight` Font weight of the header title. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -4104,20 +4128,20 @@ class HeaderConfig(VegaLiteSchema): left-, center-, or right-aligned title. **Default value:** ``"middle"`` for `single - `_ and `layered - `_ views. + `__ and `layered + `__ views. ``"start"`` for other composite views. - **Note:** `For now `_, ``anchor`` is + **Note:** `For now `__, ``anchor`` is only customizable only for `single - `_ and `layered - `_ views. For other composite + `__ and `layered + `__ views. For other composite views, ``anchor`` is always ``"start"``. titleAngle : float The rotation angle of the header title. **Default value:** ``0``. - titleBaseline : TextBaseline + titleBaseline : :class:`TextBaseline` Vertical text baseline for the header title. One of ``"top"``, ``"bottom"``, ``"middle"``. @@ -4128,7 +4152,7 @@ class HeaderConfig(VegaLiteSchema): Font of the header title. (e.g., ``"Helvetica Neue"`` ). titleFontSize : float Font size of the header title. - titleFontWeight : FontWeight + titleFontWeight : :class:`FontWeight` Font weight of the header title. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -4176,12 +4200,12 @@ class InlineData(VegaLiteSchema): Attributes ---------- - values : InlineDataset + values : :class:`InlineDataset` The full data set, included inline. This can be an array of objects or primitive values, an object, or a string. Arrays of primitive values are ingested as objects with a ``data`` property. Strings are parsed according to the specified format type. - format : DataFormat + format : :class:`DataFormat` An object that specifies the format for parsing the data. name : string Provide a placeholder name and bind data at runtime. @@ -4236,29 +4260,29 @@ class IntervalSelection(VegaLiteSchema): empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) An array of field names whose values must match for a data tuple to fall within the selection. - mark : BrushConfig + mark : :class:`BrushConfig` An interval selection also adds a rectangle mark to depict the extents of the interval. The ``mark`` property can be used to customize the appearance of the mark. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. translate : anyOf(string, boolean) When truthy, allows a user to interactively move an interval selection back-and-forth. Can be ``true``, ``false`` (to disable panning), or a - `Vega event stream definition `_ + `Vega event stream definition `__ which must include a start and end event to trigger continuous panning. **Default value:** ``true``, which corresponds to @@ -4267,7 +4291,7 @@ class IntervalSelection(VegaLiteSchema): zoom : anyOf(string, boolean) When truthy, allows a user to interactively resize an interval selection. Can be ``true``, ``false`` (to disable zooming), or a `Vega event stream - definition `_. Currently, + definition `__. Currently, only ``wheel`` events are supported. **Default value:** ``true``, which corresponds to ``wheel!``. @@ -4298,29 +4322,29 @@ class IntervalSelectionConfig(VegaLiteSchema): empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) An array of field names whose values must match for a data tuple to fall within the selection. - mark : BrushConfig + mark : :class:`BrushConfig` An interval selection also adds a rectangle mark to depict the extents of the interval. The ``mark`` property can be used to customize the appearance of the mark. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. translate : anyOf(string, boolean) When truthy, allows a user to interactively move an interval selection back-and-forth. Can be ``true``, ``false`` (to disable panning), or a - `Vega event stream definition `_ + `Vega event stream definition `__ which must include a start and end event to trigger continuous panning. **Default value:** ``true``, which corresponds to @@ -4329,7 +4353,7 @@ class IntervalSelectionConfig(VegaLiteSchema): zoom : anyOf(string, boolean) When truthy, allows a user to interactively resize an interval selection. Can be ``true``, ``false`` (to disable zooming), or a `Vega event stream - definition `_. Currently, + definition `__. Currently, only ``wheel`` events are supported. **Default value:** ``true``, which corresponds to ``wheel!``. @@ -4353,7 +4377,7 @@ class JsonDataFormat(VegaLiteSchema): Attributes ---------- - parse : anyOf(enum('auto'), Parse, None) + parse : anyOf(enum('auto'), :class:`Parse`, None) If set to ``"auto"`` (the default), perform automatic type inference to determine the desired data types. If set to ``null``, disable type inference based on the spec and only use type @@ -4366,11 +4390,12 @@ class JsonDataFormat(VegaLiteSchema): in each input record a Date value. For ``"date"``, we parse data based using Javascript's `Date.parse() - `_. + `__. For Specific date formats can be provided (e.g., ``{foo: 'date:"%m%d%Y"'}`` ), using - the `d3-time-format syntax `_. + the `d3-time-format syntax `__. UTC date format parsing is supported similarly (e.g., ``{foo: 'utc:"%m%d%Y"'}`` ). - See more about `UTC time `_ + See more about `UTC time + `__ property : string The JSON property containing the desired data. This parameter can be used when the loaded JSON file may have surrounding structure @@ -4403,24 +4428,24 @@ class Legend(VegaLiteSchema): Padding (in pixels) between legend entries in a symbol legend. format : string The formatting pattern for labels. This is D3's `number format pattern - `_ for quantitative fields and D3's - `time format pattern `_ for time - field. + `__ for quantitative fields and D3's + `time format pattern `__ for + time field. - See the `format documentation `_ + See the `format documentation `__ for more information. **Default value:** derived from `numberFormat - `_ config for quantitative - fields and from `timeFormat - `_ config for temporal + `__ config for + quantitative fields and from `timeFormat + `__ config for temporal fields. offset : float The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle. **Default value:** ``0`` - orient : LegendOrient + orient : :class:`LegendOrient` The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none". @@ -4443,9 +4468,9 @@ class Legend(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -4455,7 +4480,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(DateTime)) + values : anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`)) Explicitly set the visible legend values. zindex : float A non-positive integer indicating z-index of the legend. @@ -4522,7 +4547,7 @@ class LegendConfig(VegaLiteSchema): enclosing group or data rectangle. **Default value:** ``0`` - orient : LegendOrient + orient : :class:`LegendOrient` The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none". @@ -4558,7 +4583,7 @@ class LegendConfig(VegaLiteSchema): The font of the legend title. titleFontSize : float The font size of the legend title. - titleFontWeight : FontWeight + titleFontWeight : :class:`FontWeight` The font weight of the legend title. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -4626,17 +4651,17 @@ class LegendResolveMap(VegaLiteSchema): Attributes ---------- - color : ResolveMode + color : :class:`ResolveMode` - fill : ResolveMode + fill : :class:`ResolveMode` - opacity : ResolveMode + opacity : :class:`ResolveMode` - shape : ResolveMode + shape : :class:`ResolveMode` - size : ResolveMode + size : :class:`ResolveMode` - stroke : ResolveMode + stroke : :class:`ResolveMode` """ _schema = {'$ref': '#/definitions/LegendResolveMap'} @@ -4656,11 +4681,11 @@ class LineConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -4672,15 +4697,15 @@ class LineConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -4713,21 +4738,21 @@ class LineConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -4759,7 +4784,7 @@ class LineConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -4772,7 +4797,7 @@ class LineConfig(VegaLiteSchema): if ``config.sortLineBy`` is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored. - point : anyOf(boolean, OverlayMarkDef, enum('transparent')) + point : anyOf(boolean, :class:`OverlayMarkDef`, enum('transparent')) A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points. @@ -4806,7 +4831,7 @@ class LineConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -4815,7 +4840,7 @@ class LineConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -4903,7 +4928,7 @@ class LogicalAndPredicate(VegaLiteSchema): Attributes ---------- - and : List(LogicalOperandPredicate) + and : List(:class:`LogicalOperandPredicate`) """ _schema = {'$ref': '#/definitions/LogicalAnd'} @@ -4921,7 +4946,7 @@ class SelectionAnd(VegaLiteSchema): Attributes ---------- - and : List(SelectionOperand) + and : List(:class:`SelectionOperand`) """ _schema = {'$ref': '#/definitions/SelectionAnd'} @@ -4939,7 +4964,7 @@ class LogicalNotPredicate(VegaLiteSchema): Attributes ---------- - not : LogicalOperandPredicate + not : :class:`LogicalOperandPredicate` """ _schema = {'$ref': '#/definitions/LogicalNot'} @@ -4957,7 +4982,7 @@ class SelectionNot(VegaLiteSchema): Attributes ---------- - not : SelectionOperand + not : :class:`SelectionOperand` """ _schema = {'$ref': '#/definitions/SelectionNot'} @@ -4970,7 +4995,8 @@ def __init__(self, **kwds): class LogicalOperandPredicate(VegaLiteSchema): """LogicalOperandPredicate schema wrapper - anyOf(LogicalNotPredicate, LogicalAndPredicate, LogicalOrPredicate, Predicate) + anyOf(:class:`LogicalNotPredicate`, :class:`LogicalAndPredicate`, + :class:`LogicalOrPredicate`, :class:`Predicate`) """ _schema = {'$ref': '#/definitions/LogicalOperand'} _rootschema = Root._schema @@ -4982,7 +5008,7 @@ def __init__(self, *args, **kwds): class SelectionOperand(VegaLiteSchema): """SelectionOperand schema wrapper - anyOf(SelectionNot, SelectionAnd, SelectionOr, string) + anyOf(:class:`SelectionNot`, :class:`SelectionAnd`, :class:`SelectionOr`, string) """ _schema = {'$ref': '#/definitions/SelectionOperand'} _rootschema = Root._schema @@ -4999,7 +5025,7 @@ class LogicalOrPredicate(VegaLiteSchema): Attributes ---------- - or : List(LogicalOperandPredicate) + or : List(:class:`LogicalOperandPredicate`) """ _schema = {'$ref': '#/definitions/LogicalOr'} @@ -5017,7 +5043,7 @@ class SelectionOr(VegaLiteSchema): Attributes ---------- - or : List(SelectionOperand) + or : List(:class:`SelectionOperand`) """ _schema = {'$ref': '#/definitions/SelectionOr'} @@ -5035,7 +5061,7 @@ class LookupData(VegaLiteSchema): Attributes ---------- - data : Data + data : :class:`Data` Secondary data source to lookup in. key : string Key in data to lookup. @@ -5069,7 +5095,7 @@ class LookupTransform(VegaLiteSchema): If ``from.fields`` is specified, the transform will use the same names for ``as``. If ``from.fields`` is not specified, ``as`` has to be a string and we put the whole object into the data under the specified name. - from : LookupData + from : :class:`LookupData` Secondary data reference. """ _schema = {'$ref': '#/definitions/LookupTransform'} @@ -5101,11 +5127,11 @@ class MarkConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -5117,15 +5143,15 @@ class MarkConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -5158,21 +5184,21 @@ class MarkConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -5204,7 +5230,7 @@ class MarkConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -5236,7 +5262,7 @@ class MarkConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -5245,7 +5271,7 @@ class MarkConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -5305,15 +5331,15 @@ class MarkDef(VegaLiteSchema): Attributes ---------- - type : Mark + type : :class:`Mark` The mark type. One of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"geoshape"``, ``"rule"``, and ``"text"``. - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -5332,15 +5358,15 @@ class MarkDef(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -5373,21 +5399,21 @@ class MarkDef(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -5414,7 +5440,7 @@ class MarkDef(VegaLiteSchema): truncated if the rendered size exceeds the limit. **Default value:** ``0``, indicating no limit - line : anyOf(boolean, OverlayMarkDef) + line : anyOf(boolean, :class:`OverlayMarkDef`) A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines. @@ -5430,7 +5456,7 @@ class MarkDef(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -5443,7 +5469,7 @@ class MarkDef(VegaLiteSchema): if ``config.sortLineBy`` is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored. - point : anyOf(boolean, OverlayMarkDef, enum('transparent')) + point : anyOf(boolean, :class:`OverlayMarkDef`, enum('transparent')) A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points. @@ -5477,7 +5503,7 @@ class MarkDef(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -5486,7 +5512,7 @@ class MarkDef(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -5502,10 +5528,10 @@ class MarkDef(VegaLiteSchema): A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the `style configuration - `_. If style is an + `__. If style is an array, later styles will override earlier styles. Any `mark properties - `_ explicitly defined - within the ``encoding`` will override a style default. + `__ explicitly + defined within the ``encoding`` will override a style default. **Default value:** The mark's name. For example, a bar mark will have style ``"bar"`` by default. @@ -5594,7 +5620,7 @@ class MultiSelection(VegaLiteSchema): empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) @@ -5604,26 +5630,26 @@ class MultiSelection(VegaLiteSchema): When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value *nearest* the mouse cursor is added to the selection. - See the `nearest transform `_ + See the `nearest transform `__ documentation for more information. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. toggle : anyOf(string, boolean) Controls whether data values should be toggled or only ever inserted into multi selections. Can be ``true``, ``false`` (for insertion only), or a - `Vega expression `_. + `Vega expression `__. **Default value:** ``true``, which corresponds to ``event.shiftKey`` (i.e., data values are toggled when a user interacts with the shift-key pressed). - See the `toggle transform `_ + See the `toggle transform `__ documentation for more information. """ _schema = {'$ref': '#/definitions/MultiSelection'} @@ -5647,7 +5673,7 @@ class MultiSelectionConfig(VegaLiteSchema): empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) @@ -5657,26 +5683,26 @@ class MultiSelectionConfig(VegaLiteSchema): When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value *nearest* the mouse cursor is added to the selection. - See the `nearest transform `_ + See the `nearest transform `__ documentation for more information. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. toggle : anyOf(string, boolean) Controls whether data values should be toggled or only ever inserted into multi selections. Can be ``true``, ``false`` (for insertion only), or a - `Vega expression `_. + `Vega expression `__. **Default value:** ``true``, which corresponds to ``event.shiftKey`` (i.e., data values are toggled when a user interacts with the shift-key pressed). - See the `toggle transform `_ + See the `toggle transform `__ documentation for more information. """ _schema = {'$ref': '#/definitions/MultiSelectionConfig'} @@ -5692,7 +5718,7 @@ def __init__(self, empty=Undefined, encodings=Undefined, fields=Undefined, neare class MultiTimeUnit(VegaLiteSchema): """MultiTimeUnit schema wrapper - anyOf(LocalMultiTimeUnit, UtcMultiTimeUnit) + anyOf(:class:`LocalMultiTimeUnit`, :class:`UtcMultiTimeUnit`) """ _schema = {'$ref': '#/definitions/MultiTimeUnit'} _rootschema = Root._schema @@ -5711,7 +5737,7 @@ class NamedData(VegaLiteSchema): name : string Provide a placeholder name and bind data at runtime. - format : DataFormat + format : :class:`DataFormat` An object that specifies the format for parsing the data. """ _schema = {'$ref': '#/definitions/NamedData'} @@ -5741,44 +5767,44 @@ class OrderFieldDef(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - sort : SortOrder + sort : :class:`SortOrder` The sort order. One of ``"ascending"`` (default) or ``"descending"``. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -5794,9 +5820,9 @@ class OrderFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -5830,11 +5856,11 @@ class OverlayMarkDef(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -5848,15 +5874,15 @@ class OverlayMarkDef(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -5889,21 +5915,21 @@ class OverlayMarkDef(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -5935,7 +5961,7 @@ class OverlayMarkDef(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -5967,7 +5993,7 @@ class OverlayMarkDef(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -5976,7 +6002,7 @@ class OverlayMarkDef(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -5992,10 +6018,10 @@ class OverlayMarkDef(VegaLiteSchema): A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the `style configuration - `_. If style is an + `__. If style is an array, later styles will override earlier styles. Any `mark properties - `_ explicitly defined - within the ``encoding`` will override a style default. + `__ explicitly + defined within the ``encoding`` will override a style default. **Default value:** The mark's name. For example, a bar mark will have style ``"bar"`` by default. @@ -6085,54 +6111,54 @@ class PositionFieldDef(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - axis : anyOf(Axis, None) + axis : anyOf(:class:`Axis`, None) An object defining properties of axis's gridlines, ticks and labels. If ``null``, the axis for the encoding channel will be removed. **Default value:** If undefined, default `axis properties - `_ are applied. - bin : anyOf(boolean, BinParams) + `__ are applied. + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. - scale : anyOf(Scale, None) + scale : anyOf(:class:`Scale`, None) An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels. If ``null``, the scale will be `disabled and the data value will be directly encoded - `_. + `__. **Default value:** If undefined, default `scale properties - `_ are applied. - sort : Sort + `__ are applied. + sort : :class:`Sort` Sort order for the encoded field. For continuous fields (quantitative or temporal), ``sort`` can be either @@ -6144,13 +6170,13 @@ class PositionFieldDef(VegaLiteSchema): * ``"ascending"`` or ``"descending"`` -- for sorting by the values' natural order in Javascript. * `A sort field definition - `_ for sorting by + `__ for sorting by another field. * `An array specifying the field values in preferred order - `_. In this case, the + `__. 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 + `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. @@ -6158,7 +6184,7 @@ class PositionFieldDef(VegaLiteSchema): **Default value:** ``"ascending"`` **Note:** ``null`` is not supported for ``row`` and ``column``. - stack : anyOf(StackOffset, None) + stack : anyOf(:class:`StackOffset`, None) Type of stacking offset if the field should be stacked. ``stack`` is only applicable for ``x`` and ``y`` channels with continuous domains. For example, ``stack`` of ``y`` can be used to customize stacking for a vertical bar @@ -6169,14 +6195,15 @@ class PositionFieldDef(VegaLiteSchema): * `"zero"`: stacking with baseline offset at zero value of the scale (for creating typical stacked [bar](https://vega.github.io/vega-lite/docs/stack.html#bar) and - `area `_ chart). + `area `__ chart). * ``"normalize"`` - stacking with normalized domain (for creating `normalized stacked bar and area charts - `_. :raw-html:`
` + `__. + :raw-html:`
` - ``"center"`` - stacking with center baseline (for `streamgraph - `_ ). + `__ ). * ``null`` - No-stacking. This will produce layered `bar - `_ and area + `__ and area chart. **Default value:** ``zero`` for plots with all of the following conditions are true: @@ -6184,11 +6211,11 @@ class PositionFieldDef(VegaLiteSchema): (2) the stacked measure channel (x or y) has a linear scale; (3) At least one of non-position channels mapped to an unaggregated field that is different from x and y. Otherwise, ``null`` by default. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -6204,9 +6231,9 @@ class PositionFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -6225,8 +6252,9 @@ def __init__(self, type=Undefined, aggregate=Undefined, axis=Undefined, bin=Unde class Predicate(VegaLiteSchema): """Predicate schema wrapper - anyOf(FieldEqualPredicate, FieldRangePredicate, FieldOneOfPredicate, FieldLTPredicate, - FieldGTPredicate, FieldLTEPredicate, FieldGTEPredicate, SelectionPredicate, string) + anyOf(:class:`FieldEqualPredicate`, :class:`FieldRangePredicate`, + :class:`FieldOneOfPredicate`, :class:`FieldLTPredicate`, :class:`FieldGTPredicate`, + :class:`FieldLTEPredicate`, :class:`FieldGTEPredicate`, :class:`SelectionPredicate`, string) """ _schema = {'$ref': '#/definitions/Predicate'} _rootschema = Root._schema @@ -6250,7 +6278,7 @@ class Projection(VegaLiteSchema): **Default value:** ``[0, 0]`` clipAngle : float Sets the projection’s clipping circle radius to the specified angle in degrees. If - ``null``, switches to `antimeridian `_ cutting + ``null``, switches to `antimeridian `__ cutting rather than small-circle clipping. clipExtent : List(List(float)) Sets the projection’s viewport clip extent to the specified bounds in pixels. The @@ -6269,10 +6297,10 @@ class Projection(VegaLiteSchema): precision : Mapping(required=[length]) Sets the threshold for the projection’s `adaptive resampling - `_ to the specified value in pixels. This value - corresponds to the `Douglas–Peucker distance - `_. If - precision is not specified, returns the projection’s current resampling precision + `__ to the specified value in pixels. This + value corresponds to the `Douglas–Peucker distance + `__. + If precision is not specified, returns the projection’s current resampling precision which defaults to ``√0.5 ≅ 0.70710…``. radius : float @@ -6289,11 +6317,11 @@ class Projection(VegaLiteSchema): tilt : float - type : ProjectionType + type : :class:`ProjectionType` The cartographic projection to use. This value is case-insensitive, for example ``"albers"`` and ``"Albers"`` indicate the same projection type. You can find all valid projection types `in the documentation - `_. + `__. **Default value:** ``mercator`` """ @@ -6327,7 +6355,7 @@ class ProjectionConfig(VegaLiteSchema): **Default value:** ``[0, 0]`` clipAngle : float Sets the projection’s clipping circle radius to the specified angle in degrees. If - ``null``, switches to `antimeridian `_ cutting + ``null``, switches to `antimeridian `__ cutting rather than small-circle clipping. clipExtent : List(List(float)) Sets the projection’s viewport clip extent to the specified bounds in pixels. The @@ -6346,10 +6374,10 @@ class ProjectionConfig(VegaLiteSchema): precision : Mapping(required=[length]) Sets the threshold for the projection’s `adaptive resampling - `_ to the specified value in pixels. This value - corresponds to the `Douglas–Peucker distance - `_. If - precision is not specified, returns the projection’s current resampling precision + `__ to the specified value in pixels. This + value corresponds to the `Douglas–Peucker distance + `__. + If precision is not specified, returns the projection’s current resampling precision which defaults to ``√0.5 ≅ 0.70710…``. radius : float @@ -6366,11 +6394,11 @@ class ProjectionConfig(VegaLiteSchema): tilt : float - type : ProjectionType + type : :class:`ProjectionType` The cartographic projection to use. This value is case-insensitive, for example ``"albers"`` and ``"Albers"`` indicate the same projection type. You can find all valid projection types `in the documentation - `_. + `__. **Default value:** ``mercator`` """ @@ -6411,15 +6439,15 @@ class RangeConfig(VegaLiteSchema): Attributes ---------- - category : anyOf(List(string), VgScheme) + category : anyOf(List(string), :class:`VgScheme`) Default range for *nominal* (categorical) fields. - diverging : anyOf(List(string), VgScheme) + diverging : anyOf(List(string), :class:`VgScheme`) Default range for diverging *quantitative* fields. - heatmap : anyOf(List(string), VgScheme) + heatmap : anyOf(List(string), :class:`VgScheme`) Default range for *quantitative* heatmaps. - ordinal : anyOf(List(string), VgScheme) + ordinal : anyOf(List(string), :class:`VgScheme`) Default range for *ordinal* fields. - ramp : anyOf(List(string), VgScheme) + ramp : anyOf(List(string), :class:`VgScheme`) Default range for *quantitative* and *temporal* fields. symbol : List(string) Default range palette for the ``shape`` channel. @@ -6436,7 +6464,7 @@ def __init__(self, category=Undefined, diverging=Undefined, heatmap=Undefined, o class RangeConfigValue(VegaLiteSchema): """RangeConfigValue schema wrapper - anyOf(List(anyOf(float, string)), VgScheme, Mapping(required=[step])) + anyOf(List(anyOf(float, string)), :class:`VgScheme`, Mapping(required=[step])) """ _schema = {'$ref': '#/definitions/RangeConfigValue'} _rootschema = Root._schema @@ -6494,11 +6522,11 @@ class Resolve(VegaLiteSchema): Attributes ---------- - axis : AxisResolveMap + axis : :class:`AxisResolveMap` - legend : LegendResolveMap + legend : :class:`LegendResolveMap` - scale : ScaleResolveMap + scale : :class:`ScaleResolveMap` """ _schema = {'$ref': '#/definitions/Resolve'} @@ -6528,9 +6556,9 @@ class RowColVgLayoutAlign(VegaLiteSchema): Attributes ---------- - column : VgLayoutAlign + column : :class:`VgLayoutAlign` - row : VgLayoutAlign + row : :class:`VgLayoutAlign` """ _schema = {'$ref': '#/definitions/RowCol'} @@ -6595,15 +6623,15 @@ class Scale(VegaLiteSchema): maximum range value **Default value:** derived from the `scale config - `_ 's ``clamp`` ( + `__ 's ``clamp`` ( ``true`` by default). - domain : anyOf(List(float), List(string), List(boolean), List(DateTime), - enum('unaggregated'), 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 minimum and maximum values. `Piecewise scales - `_ can be created by + `__ can be created by providing a ``domain`` with more than two entries. If the input field is aggregated, ``domain`` can also be a string value ``"unaggregated"``, indicating that the domain should include the raw data values @@ -6611,17 +6639,17 @@ class Scale(VegaLiteSchema): For *temporal* fields, ``domain`` can be a two-element array minimum and maximum values, in the form of either timestamps or the `DateTime definition objects - `_. + `__. For *ordinal* and *nominal* fields, ``domain`` can be an array that lists valid input values. The ``selection`` property can be used to `interactively determine - `_ the scale + `__ the scale domain. exponent : float The exponent of the ``pow`` scale. - interpolate : anyOf(ScaleInterpolate, ScaleInterpolateParams) + interpolate : anyOf(:class:`ScaleInterpolate`, :class:`ScaleInterpolateParams`) The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include @@ -6630,13 +6658,13 @@ class Scale(VegaLiteSchema): If object-valued, this property accepts an object with a string-valued *type* property and an optional numeric *gamma* property applicable to rgb and cubehelix interpolators. For more, see the `d3-interpolate documentation - `_. + `__. **Note:** Sequential scales do not support ``interpolate`` as they have a fixed interpolator. Since Vega-Lite uses sequential scales for quantitative fields by default, you have to set the scale ``type`` to other quantitative scale type such as ``"linear"`` to customize ``interpolate``. - nice : anyOf(boolean, float, NiceTime, Mapping(required=[interval, step])) + nice : anyOf(boolean, float, :class:`NiceTime`, Mapping(required=[interval, step])) 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 @@ -6658,21 +6686,21 @@ class Scale(VegaLiteSchema): **Default value:** ``true`` for unbinned *quantitative* fields; ``false`` otherwise. padding : float - For * `continuous `_ * + For * `continuous `__ * scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to - function as intended. Padding adjustment is performed prior to all other - adjustments, including the effects of the zero, nice, domainMin, - and domainMax properties. + function as intended. Padding adjustment is performed prior to all other + adjustments, including the effects of the zero, nice, domainMin, and domainMax + properties. - For * `band `_ * scales, + For * `band `__ * scales, shortcut for setting ``paddingInner`` and ``paddingOuter`` to the same value. - For * `point `_ * scales, + For * `point `__ * scales, alias for ``paddingOuter``. **Default value:** For *continuous* scales, derived from the `scale config - `_ 's + `__ 's ``continuousPadding``. For *band and point* scales, see ``paddingInner`` and ``paddingOuter``. paddingInner : float @@ -6683,56 +6711,57 @@ class Scale(VegaLiteSchema): widths (only step sizes between bands). **Default value:** derived from the `scale config - `_ 's ``bandPaddingInner``. + `__ 's + ``bandPaddingInner``. paddingOuter : float The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1]. **Default value:** derived from the `scale config - `_ 's ``bandPaddingOuter`` + `__ 's ``bandPaddingOuter`` for band scales and ``pointPadding`` for point scales. range : anyOf(List(float), List(string), string) The range of the scale. One of: A string indicating a `pre-defined named scale range - `_ (e.g., example, + `__ (e.g., example, ``"symbol"``, or ``"diverging"`` ). For `continuous scales - `_, two-element array + `__, two-element array indicating minimum and maximum values, or an array with more than two entries for specifying a `piecewise scale - `_. + `__. - For `discrete `_ and - `discretizing `_ + For `discrete `__ and + `discretizing `__ scales, an array of desired output values. **Notes:** - 1) For `sequential `_, - `ordinal `_, and + 1) For `sequential `__, + `ordinal `__, and discretizing color scales, you can also specify a color `scheme - `_ instead of ``range``. + `__ instead of ``range``. 2) Any directly specified ``range`` for ``x`` and ``y`` channels will be ignored. Range can be customized via the view's corresponding `size - `_ ( ``width`` and ``height`` ) or - via `range steps and paddings properties <#range-step>`_ for `band <#band>`_ and - `point <#point>`_ scales. + `__ ( ``width`` and ``height`` ) or + via `range steps and paddings properties <#range-step>`__ for `band <#band>`__ and + `point <#point>`__ scales. rangeStep : anyOf(float, None) The distance between the starts of adjacent bands or points in `band - `_ and `point - `_ scales. + `__ and `point + `__ scales. If ``rangeStep`` is ``null`` or if the view contains the scale's corresponding `size - `_ ( ``width`` for ``x`` scales and - ``height`` for ``y`` scales), ``rangeStep`` will be automatically determined to fit - the size of the view. + `__ ( ``width`` for ``x`` scales + and ``height`` for ``y`` scales), ``rangeStep`` will be automatically determined to + fit the size of the view. **Default value:** derived the `scale config - `_ 's + `__ 's ``textXRangeStep`` ( ``90`` by default) for x-scales of ``text`` marks and ``rangeStep`` ( ``21`` by default) for x-scales of other marks and y-scales. @@ -6744,48 +6773,48 @@ class Scale(VegaLiteSchema): snapping to the pixel grid. **Default value:** ``false``. - scheme : anyOf(string, SchemeParams) + scheme : anyOf(string, :class:`SchemeParams`) A string indicating a color `scheme - `_ name (e.g., + `__ name (e.g., ``"category10"`` or ``"viridis"`` ) or a `scheme parameter object - `_. + `__. Discrete color schemes may be used with `discrete - `_ or `discretizing - `_ scales. Continuous - color schemes are intended for use with `sequential - `_ scales. + `__ or `discretizing + `__ scales. + Continuous color schemes are intended for use with `sequential + `__ scales. For the full list of supported schemes, please refer to the `Vega Scheme - `_ reference. - type : ScaleType + `__ reference. + type : :class:`ScaleType` The type of scale. Vega-Lite supports the following categories of scale types: 1) `Continuous Scales - `_ -- mapping + `__ -- mapping continuous domains to continuous output ranges ( `"linear" - `_, `"pow" - `_, `"sqrt" - `_, `"log" - `_, `"time" - `_, `"utc" - `_, `"sequential" - `_ ). - - 2) `Discrete Scales `_ -- - mapping discrete domains to discrete ( `"ordinal" - `_ ) or continuous ( - `"band" `_ and `"point" - `_ ) output ranges. + `__, `"pow" + `__, `"sqrt" + `__, `"log" + `__, `"time" + `__, `"utc" + `__, `"sequential" + `__ ). + + 2) `Discrete Scales `__ + -- mapping discrete domains to discrete ( `"ordinal" + `__ ) or continuous ( + `"band" `__ and `"point" + `__ ) output ranges. 3) `Discretizing Scales - `_ -- mapping + `__ -- mapping continuous domains to discrete output ranges ( `"bin-linear" - `_ and `"bin-ordinal" - `_ ). + `__ and `"bin-ordinal" + `__ ). **Default value:** please see the `scale type table - `_. + `__. zero : boolean If ``true``, ensures that a zero baseline value is included in the scale domain. @@ -6966,21 +6995,21 @@ class ScaleResolveMap(VegaLiteSchema): Attributes ---------- - color : ResolveMode + color : :class:`ResolveMode` - fill : ResolveMode + fill : :class:`ResolveMode` - opacity : ResolveMode + opacity : :class:`ResolveMode` - shape : ResolveMode + shape : :class:`ResolveMode` - size : ResolveMode + size : :class:`ResolveMode` - stroke : ResolveMode + stroke : :class:`ResolveMode` - x : ResolveMode + x : :class:`ResolveMode` - y : ResolveMode + y : :class:`ResolveMode` """ _schema = {'$ref': '#/definitions/ScaleResolveMap'} @@ -7018,7 +7047,7 @@ class SchemeParams(VegaLiteSchema): ``"viridis"`` ). For the full list of supported schemes, please refer to the `Vega Scheme - `_ reference. + `__ reference. extent : List(float) For sequential and diverging schemes only, determines the extent of the color range to use. For example ``[0.2, 1]`` will rescale the color scheme such that color @@ -7039,27 +7068,27 @@ class SelectionConfig(VegaLiteSchema): Attributes ---------- - interval : IntervalSelectionConfig + interval : :class:`IntervalSelectionConfig` The default definition for an `interval - `_ selection. All + `__ selection. All properties and transformations for an interval selection definition (except ``type`` ) may be specified here. For instance, setting ``interval`` to ``{"translate": false}`` disables the ability to move interval selections by default. - multi : MultiSelectionConfig + multi : :class:`MultiSelectionConfig` The default definition for a `multi - `_ selection. All + `__ selection. All properties and transformations for a multi selection definition (except ``type`` ) may be specified here. For instance, setting ``multi`` to ``{"toggle": "event.altKey"}`` adds additional values to multi selections when clicking with the alt-key pressed by default. - single : SingleSelectionConfig + single : :class:`SingleSelectionConfig` The default definition for a `single - `_ selection. All + `__ selection. All properties and transformations for a single selection definition (except ``type`` ) may be specified here. @@ -7076,7 +7105,7 @@ def __init__(self, interval=Undefined, multi=Undefined, single=Undefined, **kwds class SelectionDef(VegaLiteSchema): """SelectionDef schema wrapper - anyOf(SingleSelection, MultiSelection, IntervalSelection) + anyOf(:class:`SingleSelection`, :class:`MultiSelection`, :class:`IntervalSelection`) """ _schema = {'$ref': '#/definitions/SelectionDef'} _rootschema = Root._schema @@ -7105,7 +7134,7 @@ class SelectionPredicate(VegaLiteSchema): Attributes ---------- - selection : SelectionOperand + selection : :class:`SelectionOperand` Filter using a selection name. """ _schema = {'$ref': '#/definitions/SelectionPredicate'} @@ -7151,19 +7180,19 @@ class SingleSelection(VegaLiteSchema): type : enum('single') - bind : anyOf(VgBinding, Mapping(required=[])) + bind : anyOf(:class:`VgBinding`, Mapping(required=[])) Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's `input element binding definition - `_ + `__ or can be a mapping between projected field/encodings and binding definitions. - See the `bind transform `_ + See the `bind transform `__ documentation for more information. empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) @@ -7173,14 +7202,14 @@ class SingleSelection(VegaLiteSchema): When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value *nearest* the mouse cursor is added to the selection. - See the `nearest transform `_ + See the `nearest transform `__ documentation for more information. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. @@ -7203,19 +7232,19 @@ class SingleSelectionConfig(VegaLiteSchema): Attributes ---------- - bind : anyOf(VgBinding, Mapping(required=[])) + bind : anyOf(:class:`VgBinding`, Mapping(required=[])) Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's `input element binding definition - `_ + `__ or can be a mapping between projected field/encodings and binding definitions. - See the `bind transform `_ + See the `bind transform `__ documentation for more information. empty : enum('all', 'none') By default, all data values are considered to lie within an empty selection. When set to ``none``, empty selections contain no data values. - encodings : List(SingleDefChannel) + encodings : List(:class:`SingleDefChannel`) An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection. fields : List(string) @@ -7225,14 +7254,14 @@ class SingleSelectionConfig(VegaLiteSchema): When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value *nearest* the mouse cursor is added to the selection. - See the `nearest transform `_ + See the `nearest transform `__ documentation for more information. - on : VgEventStream - A `Vega event stream `_ (object or + on : :class:`VgEventStream` + A `Vega event stream `__ (object or selector) that triggers the selection. For interval selections, the event stream must specify a `start and end - `_. - resolve : SelectionResolution + `__. + resolve : :class:`SelectionResolution` With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain. @@ -7250,7 +7279,7 @@ def __init__(self, bind=Undefined, empty=Undefined, encodings=Undefined, fields= class SingleTimeUnit(VegaLiteSchema): """SingleTimeUnit schema wrapper - anyOf(LocalSingleTimeUnit, UtcSingleTimeUnit) + anyOf(:class:`LocalSingleTimeUnit`, :class:`UtcSingleTimeUnit`) """ _schema = {'$ref': '#/definitions/SingleTimeUnit'} _rootschema = Root._schema @@ -7262,8 +7291,8 @@ def __init__(self, *args, **kwds): class Sort(VegaLiteSchema): """Sort schema wrapper - anyOf(List(float), List(string), List(boolean), List(DateTime), SortOrder, - EncodingSortField, None) + anyOf(List(float), List(string), List(boolean), List(:class:`DateTime`), :class:`SortOrder`, + :class:`EncodingSortField`, None) """ _schema = {'$ref': '#/definitions/Sort'} _rootschema = Root._schema @@ -7283,7 +7312,7 @@ class SortField(VegaLiteSchema): field : string The name of the field to sort. - order : VgComparatorOrder + order : :class:`VgComparatorOrder` Whether to sort the field in ascending or descending order. """ _schema = {'$ref': '#/definitions/SortField'} @@ -7296,7 +7325,7 @@ def __init__(self, field=Undefined, order=Undefined, **kwds): class SortOrder(VegaLiteSchema): """SortOrder schema wrapper - anyOf(VgComparatorOrder, None) + anyOf(:class:`VgComparatorOrder`, None) """ _schema = {'$ref': '#/definitions/SortOrder'} _rootschema = Root._schema @@ -7356,7 +7385,7 @@ def __init__(self, **kwds): class TextBaseline(VegaLiteSchema): """TextBaseline schema wrapper - anyOf(enum('alphabetic'), Baseline) + anyOf(enum('alphabetic'), :class:`Baseline`) """ _schema = {'$ref': '#/definitions/TextBaseline'} _rootschema = Root._schema @@ -7373,11 +7402,11 @@ class TextConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -7389,15 +7418,15 @@ class TextConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -7430,21 +7459,21 @@ class TextConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -7476,7 +7505,7 @@ class TextConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -7510,7 +7539,7 @@ class TextConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -7519,7 +7548,7 @@ class TextConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -7580,45 +7609,45 @@ class TextFieldDef(VegaLiteSchema): Attributes ---------- - type : Type + type : :class:`Type` The encoded field's type of measurement ( ``"quantitative"``, ``"temporal"``, ``"ordinal"``, or ``"nominal"`` ). It can also be a ``"geojson"`` type for encoding `'geoshape' - `_. - aggregate : Aggregate + `__. + aggregate : :class:`Aggregate` Aggregation function for the field (e.g., ``mean``, ``sum``, ``median``, ``min``, ``max``, ``count`` ). **Default value:** ``undefined`` (None) - bin : anyOf(boolean, BinParams) + bin : anyOf(boolean, :class:`BinParams`) A flag for binning a ``quantitative`` field, or `an object defining binning - parameters `_. + parameters `__. If ``true``, default `binning parameters - `_ will be applied. + `__ will be applied. **Default value:** ``false`` - field : anyOf(string, RepeatRef) + field : anyOf(string, :class:`RepeatRef`) **Required.** A string defining the name of the field from which to pull a data value or an object defining iterated values from the `repeat - `_ operator. + `__ operator. **Note:** Dots ( ``.`` ) and brackets ( ``[`` and ``]`` ) can be used to access nested objects (e.g., ``"field": "foo.bar"`` and ``"field": "foo['bar']"`` ). If field names contain dots or brackets but are not nested, you can use ``\\`` to escape dots and brackets (e.g., ``"a\\.b"`` and ``"a\\[0\\]"`` ). See more details about escaping in the `field documentation - `_. + `__. **Note:** ``field`` is not required if ``aggregate`` is ``count``. format : string - The `formatting pattern `_ for a + The `formatting pattern `__ for a text field. If not defined, this will be determined automatically. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` Time unit (e.g., ``year``, ``yearmonth``, ``month``, ``hours`` ) for a temporal field. or `a temporal field that gets casted as ordinal - `_. + `__. **Default value:** ``undefined`` (None) title : anyOf(string, None) @@ -7634,9 +7663,9 @@ class TextFieldDef(VegaLiteSchema): **Notes** : 1) You can customize the default field title format by providing the [fieldTitle - property in the `config `_ or + property in the `config `__ or `fieldTitle function via the compile function's options - `_. + `__. 2) If both field definition's ``title`` and axis, header, or legend ``title`` are defined, axis/header/legend title will be used. @@ -7658,7 +7687,7 @@ class TickConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. @@ -7666,7 +7695,7 @@ class TickConfig(VegaLiteSchema): The width of the ticks. **Default value:** 2/3 of rangeStep. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -7678,15 +7707,15 @@ class TickConfig(VegaLiteSchema): ``"#4682b4"`` **Note:** This property cannot be used in a `style config - `_. + `__. cornerRadius : float The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -7719,21 +7748,21 @@ class TickConfig(VegaLiteSchema): **Applicable for:** ``bar``, ``point``, ``circle``, ``square``, and ``area`` marks. **Note:** This property cannot be used in a `style config - `_. + `__. font : string The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -7765,7 +7794,7 @@ class TickConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -7797,7 +7826,7 @@ class TickConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -7806,7 +7835,7 @@ class TickConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -7866,7 +7895,7 @@ def __init__(self, align=Undefined, angle=Undefined, bandSize=Undefined, baselin class TimeUnit(VegaLiteSchema): """TimeUnit schema wrapper - anyOf(SingleTimeUnit, MultiTimeUnit) + anyOf(:class:`SingleTimeUnit`, :class:`MultiTimeUnit`) """ _schema = {'$ref': '#/definitions/TimeUnit'} _rootschema = Root._schema @@ -7885,7 +7914,7 @@ class TimeUnitTransform(VegaLiteSchema): field : string The data field to apply time unit. - timeUnit : TimeUnit + timeUnit : :class:`TimeUnit` The timeUnit. as : string The output field to write the timeUnit value. @@ -7919,29 +7948,29 @@ class TitleParams(VegaLiteSchema): text : string The title text. - anchor : Anchor + anchor : :class:`Anchor` The anchor position for placing the title. One of ``"start"``, ``"middle"``, or ``"end"``. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title. **Default value:** ``"middle"`` for `single - `_ and `layered - `_ views. + `__ and `layered + `__ views. ``"start"`` for other composite views. - **Note:** `For now `_, ``anchor`` is + **Note:** `For now `__, ``anchor`` is only customizable only for `single - `_ and `layered - `_ views. For other composite + `__ and `layered + `__ views. For other composite views, ``anchor`` is always ``"start"``. offset : float The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart. - orient : TitleOrient + orient : :class:`TitleOrient` The orientation of the title relative to the chart. One of ``"top"`` (the default), ``"bottom"``, ``"left"``, or ``"right"``. style : anyOf(string, List(string)) - A `mark style property `_ + A `mark style property `__ to apply to the title text mark. **Default value:** ``"group-title"``. @@ -7963,12 +7992,12 @@ class TopLevelLayerSpec(VegaLiteSchema): Attributes ---------- - layer : List(anyOf(LayerSpec, CompositeUnitSpec)) + layer : List(anyOf(:class:`LayerSpec`, :class:`CompositeUnitSpec`)) Layer or single view specifications to be layered. **Note** : Specifications inside ``layer`` cannot use ``row`` and ``column`` channels as layering facet specifications is not allowed. - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -7981,19 +8010,19 @@ class TopLevelLayerSpec(VegaLiteSchema): CSS color property to use as the background of visualization. **Default value:** none (transparent) - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - data : Data + data : :class:`Data` An object describing the data source - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a ``data`` property. description : string Description of this mark for commenting purpose. - encoding : Encoding + encoding : :class:`Encoding` A shared key-value mapping between encoding channels and definition of fields in the underlying layers. height : float @@ -8002,44 +8031,45 @@ class TopLevelLayerSpec(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - projection : Projection + projection : :class:`Projection` An object defining properties of the geographic projection shared by underlying layers. - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for layers. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -8047,31 +8077,32 @@ class TopLevelLayerSpec(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8100,9 +8131,9 @@ class TopLevelHConcatSpec(VegaLiteSchema): Attributes ---------- - hconcat : List(Spec) + hconcat : List(:class:`Spec`) A list of views that should be concatenated and put into a row. - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -8132,12 +8163,12 @@ class TopLevelHConcatSpec(VegaLiteSchema): rows or columns. **Default value:** ``false`` - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - data : Data + data : :class:`Data` An object describing the data source - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive @@ -8146,25 +8177,25 @@ class TopLevelHConcatSpec(VegaLiteSchema): Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for horizontally concatenated charts. spacing : float The spacing in pixels between sub-views of the concat operator. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8193,12 +8224,12 @@ class TopLevelRepeatSpec(VegaLiteSchema): Attributes ---------- - repeat : Repeat + repeat : :class:`Repeat` An object that describes what fields should be repeated into views that are laid out as a ``row`` or ``column``. - spec : Spec + spec : :class:`Spec` - align : anyOf(VgLayoutAlign, RowColVgLayoutAlign) + align : anyOf(:class:`VgLayoutAlign`, :class:`RowColVgLayoutAlign`) The alignment to apply to grid rows and columns. The supported string values are ``"all"``, ``"each"``, and ``"none"``. @@ -8215,7 +8246,7 @@ class TopLevelRepeatSpec(VegaLiteSchema): be used to supply different alignments for rows and columns. **Default value:** ``"all"``. - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -8240,7 +8271,7 @@ class TopLevelRepeatSpec(VegaLiteSchema): sub-plots without axes or legends into a uniform grid structure. **Default value:** ``"full"`` - center : anyOf(boolean, RowColboolean) + center : anyOf(boolean, :class:`RowColboolean`) Boolean flag indicating if subviews should be centered relative to their respective rows or columns. @@ -8248,12 +8279,12 @@ class TopLevelRepeatSpec(VegaLiteSchema): supply different centering values for rows and columns. **Default value:** ``false`` - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - data : Data + data : :class:`Data` An object describing the data source - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive @@ -8262,27 +8293,27 @@ class TopLevelRepeatSpec(VegaLiteSchema): Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - resolve : Resolve + resolve : :class:`Resolve` Scale and legend resolutions for repeated charts. - spacing : anyOf(float, RowColnumber) + spacing : anyOf(float, :class:`RowColnumber`) The spacing in pixels between sub-views of the composition operator. An object of the form ``{"row": number, "column": number}`` can be used to set different spacing values for rows and columns. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8312,9 +8343,9 @@ class TopLevelVConcatSpec(VegaLiteSchema): Attributes ---------- - vconcat : List(Spec) + vconcat : List(:class:`Spec`) A list of views that should be concatenated and put into a column. - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -8344,12 +8375,12 @@ class TopLevelVConcatSpec(VegaLiteSchema): rows or columns. **Default value:** ``false`` - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - data : Data + data : :class:`Data` An object describing the data source - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive @@ -8358,25 +8389,25 @@ class TopLevelVConcatSpec(VegaLiteSchema): Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for vertically concatenated charts. spacing : float The spacing in pixels between sub-views of the concat operator. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8405,14 +8436,14 @@ class TopLevelFacetSpec(VegaLiteSchema): Attributes ---------- - data : Data + data : :class:`Data` An object describing the data source - facet : FacetMapping + facet : :class:`FacetMapping` An object that describes mappings between ``row`` and ``column`` channels and their field definitions. - spec : anyOf(LayerSpec, CompositeUnitSpec) + spec : anyOf(:class:`LayerSpec`, :class:`CompositeUnitSpec`) A specification of the view that gets faceted. - align : anyOf(VgLayoutAlign, RowColVgLayoutAlign) + align : anyOf(:class:`VgLayoutAlign`, :class:`RowColVgLayoutAlign`) The alignment to apply to grid rows and columns. The supported string values are ``"all"``, ``"each"``, and ``"none"``. @@ -8429,7 +8460,7 @@ class TopLevelFacetSpec(VegaLiteSchema): be used to supply different alignments for rows and columns. **Default value:** ``"all"``. - autosize : anyOf(AutosizeType, AutoSizeParams) + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -8454,7 +8485,7 @@ class TopLevelFacetSpec(VegaLiteSchema): sub-plots without axes or legends into a uniform grid structure. **Default value:** ``"full"`` - center : anyOf(boolean, RowColboolean) + center : anyOf(boolean, :class:`RowColboolean`) Boolean flag indicating if subviews should be centered relative to their respective rows or columns. @@ -8462,10 +8493,10 @@ class TopLevelFacetSpec(VegaLiteSchema): supply different centering values for rows and columns. **Default value:** ``false`` - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive @@ -8474,27 +8505,27 @@ class TopLevelFacetSpec(VegaLiteSchema): Description of this mark for commenting purpose. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - resolve : Resolve + resolve : :class:`Resolve` Scale, axis, and legend resolutions for facets. - spacing : anyOf(float, RowColnumber) + spacing : anyOf(float, :class:`RowColnumber`) The spacing in pixels between sub-views of the composition operator. An object of the form ``{"row": number, "column": number}`` can be used to set different spacing values for rows and columns. **Default value** : ``10`` - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8524,14 +8555,14 @@ class TopLevelFacetedUnitSpec(VegaLiteSchema): Attributes ---------- - data : Data + data : :class:`Data` An object describing the data source - mark : AnyMark + mark : :class:`AnyMark` A string describing the mark type (one of ``"bar"``, ``"circle"``, ``"square"``, ``"tick"``, ``"line"``, ``"area"``, ``"point"``, ``"rule"``, ``"geoshape"``, and ``"text"`` ) or a `mark - definition object `_. - autosize : anyOf(AutosizeType, AutoSizeParams) + definition object `__. + autosize : anyOf(:class:`AutosizeType`, :class:`AutoSizeParams`) Sets how the visualization size should be determined. If a string, should be one of ``"pad"``, ``"fit"`` or ``"none"``. Object values can additionally specify parameters for content sizing and automatic @@ -8544,17 +8575,17 @@ class TopLevelFacetedUnitSpec(VegaLiteSchema): CSS color property to use as the background of visualization. **Default value:** none (transparent) - config : Config + config : :class:`Config` Vega-Lite configuration object. This property can only be defined at the top-level of a specification. - datasets : Datasets + datasets : :class:`Datasets` A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a ``data`` property. description : string Description of this mark for commenting purpose. - encoding : EncodingWithFacet + encoding : :class:`EncodingWithFacet` A key-value mapping between encoding channels and definition of fields. height : float The height of a visualization. @@ -8562,45 +8593,46 @@ class TopLevelFacetedUnitSpec(VegaLiteSchema): **Default value:** - * If a view's `autosize `_ - type is ``"fit"`` or its y-channel has a `continuous scale - `_, the height will + * If a view's `autosize + `__ type is ``"fit"`` or + its y-channel has a `continuous scale + `__, the height will be the value of `config.view.height - `_. + `__. * For y-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the height is `determined by the range step, paddings, and the cardinality of the field mapped to y-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the height will be the value of `config.view.height - `_. + `__. * If no field is mapped to ``y`` channel, the ``height`` will be the value of ``rangeStep``. **Note** : For plots with `row and column channels - `_, this represents the + `__, this represents the height of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. name : string Name of the visualization for later reference. - padding : Padding + padding : :class:`Padding` 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`` - projection : Projection + projection : :class:`Projection` An object defining properties of geographic projection, which will be applied to ``shape`` path for ``"geoshape"`` marks and to ``latitude`` and ``"longitude"`` channels for other marks. selection : Mapping(required=[]) A key-value mapping between selection names and definitions. - title : anyOf(string, TitleParams) + title : anyOf(string, :class:`TitleParams`) Title for the plot. - transform : List(Transform) + transform : List(:class:`Transform`) An array of data transformations such as filter and new field calculation. width : float The width of a visualization. @@ -8608,31 +8640,32 @@ class TopLevelFacetedUnitSpec(VegaLiteSchema): **Default value:** This will be determined by the following rules: - * If a view's `autosize `_ - type is ``"fit"`` or its x-channel has a `continuous scale - `_, the width will be - the value of `config.view.width - `_. + * If a view's `autosize + `__ type is ``"fit"`` or + its x-channel has a `continuous scale + `__, the width will + be the value of `config.view.width + `__. * For x-axis with a band or point scale: if `rangeStep - `_ is a numeric value or + `__ is a numeric value or unspecified, the width is `determined by the range step, paddings, and the cardinality of the field mapped to x-channel - `_. Otherwise, if the + `__. Otherwise, if the ``rangeStep`` is ``null``, the width will be the value of `config.view.width - `_. + `__. * If no field is mapped to ``x`` channel, the ``width`` will be the value of `config.scale.textXRangeStep - `_ for + `__ for ``text`` mark and the value of ``rangeStep`` for other marks. **Note:** For plots with `row and column channels - `_, this represents the + `__, this represents the width of a single view. **See also:** The documentation for `width and height - `_ contains more examples. + `__ contains more examples. $schema : string - URL to `JSON schema `_ for a Vega-Lite specification. + URL to `JSON schema `__ for a Vega-Lite specification. Unless you have a reason to change this, use ``https://vega.github.io/schema/vega-lite/v2.json``. Setting the ``$schema`` property allows automatic validation and autocomplete in editors that support JSON @@ -8657,8 +8690,9 @@ def __init__(self, data=Undefined, mark=Undefined, autosize=Undefined, backgroun class TopLevelSpec(VegaLiteSchema): """TopLevelSpec schema wrapper - anyOf(TopLevelFacetedUnitSpec, TopLevelFacetSpec, TopLevelLayerSpec, TopLevelRepeatSpec, - TopLevelVConcatSpec, TopLevelHConcatSpec) + anyOf(:class:`TopLevelFacetedUnitSpec`, :class:`TopLevelFacetSpec`, + :class:`TopLevelLayerSpec`, :class:`TopLevelRepeatSpec`, :class:`TopLevelVConcatSpec`, + :class:`TopLevelHConcatSpec`) """ _schema = {'$ref': '#/definitions/TopLevelSpec'} _rootschema = Root._schema @@ -8689,7 +8723,7 @@ class TopoDataFormat(VegaLiteSchema): Extracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties. - parse : anyOf(enum('auto'), Parse, None) + parse : anyOf(enum('auto'), :class:`Parse`, None) If set to ``"auto"`` (the default), perform automatic type inference to determine the desired data types. If set to ``null``, disable type inference based on the spec and only use type @@ -8702,11 +8736,12 @@ class TopoDataFormat(VegaLiteSchema): in each input record a Date value. For ``"date"``, we parse data based using Javascript's `Date.parse() - `_. + `__. For Specific date formats can be provided (e.g., ``{foo: 'date:"%m%d%Y"'}`` ), using - the `d3-time-format syntax `_. + the `d3-time-format syntax `__. UTC date format parsing is supported similarly (e.g., ``{foo: 'utc:"%m%d%Y"'}`` ). - See more about `UTC time `_ + See more about `UTC time + `__ type : enum('topojson') Type of input data: ``"json"``, ``"csv"``, ``"tsv"``, ``"dsv"``. The default format type is determined by the extension of the file URL. @@ -8722,8 +8757,9 @@ def __init__(self, feature=Undefined, mesh=Undefined, parse=Undefined, type=Unde class Transform(VegaLiteSchema): """Transform schema wrapper - anyOf(FilterTransform, CalculateTransform, LookupTransform, BinTransform, TimeUnitTransform, - AggregateTransform, WindowTransform) + anyOf(:class:`FilterTransform`, :class:`CalculateTransform`, :class:`LookupTransform`, + :class:`BinTransform`, :class:`TimeUnitTransform`, :class:`AggregateTransform`, + :class:`WindowTransform`) """ _schema = {'$ref': '#/definitions/Transform'} _rootschema = Root._schema @@ -8735,7 +8771,7 @@ def __init__(self, *args, **kwds): class Type(VegaLiteSchema): """Type schema wrapper - anyOf(BasicType, GeoType) + anyOf(:class:`BasicType`, :class:`GeoType`) Constants and utilities for data type :raw-html:`
` Data type based on level of measurement """ @@ -8757,7 +8793,7 @@ class UrlData(VegaLiteSchema): url : string An URL from which to load the data set. Use the ``format.type`` property to ensure the loaded data is correctly parsed. - format : DataFormat + format : :class:`DataFormat` An object that specifies the format for parsing the data. name : string Provide a placeholder name and bind data at runtime. @@ -8826,7 +8862,8 @@ class ValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(ConditionalFieldDef, ConditionalValueDef, List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -8847,8 +8884,8 @@ class MarkPropValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(ConditionalMarkPropFieldDef, ConditionalValueDef, - List(ConditionalValueDef)) + condition : anyOf(:class:`ConditionalMarkPropFieldDef`, :class:`ConditionalValueDef`, + List(:class:`ConditionalValueDef`)) A field definition or one or more value definition(s) with a selection predicate. value : anyOf(float, string, boolean) A constant value in visual domain. @@ -8869,7 +8906,8 @@ class TextValueDefWithCondition(VegaLiteSchema): Attributes ---------- - condition : anyOf(ConditionalTextFieldDef, ConditionalValueDef, List(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 : anyOf(float, string, boolean) A constant value in visual domain. @@ -8922,8 +8960,8 @@ class VgAxisConfig(VegaLiteSchema): A boolean flag indicating if grid lines should be included as part of the axis **Default value:** ``true`` for `continuous scales - `_ that are not binned; - otherwise, ``false``. + `__ that are not + binned; otherwise, ``false``. gridColor : string Color of gridlines. gridDash : List(float) @@ -8939,8 +8977,8 @@ class VgAxisConfig(VegaLiteSchema): **Default value:** ``-90`` for nominal and ordinal fields; ``0`` otherwise. labelBound : anyOf(boolean, float) - Indicates if labels should be hidden if they exceed the axis range. If  ``false`` - (the default) no bounds overlap analysis is performed. If  ``true``, labels will be + Indicates if labels should be hidden if they exceed the axis range. If ``false`` + (the default) no bounds overlap analysis is performed. If ``true``, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range. @@ -9014,7 +9052,7 @@ class VgAxisConfig(VegaLiteSchema): Font of the title. (e.g., ``"Helvetica Neue"`` ). titleFontSize : float Font size of the title. - titleFontWeight : FontWeight + titleFontWeight : :class:`FontWeight` Font weight of the title. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -9068,7 +9106,8 @@ def __init__(self, bandPosition=Undefined, domain=Undefined, domainColor=Undefin class VgBinding(VegaLiteSchema): """VgBinding schema wrapper - anyOf(VgCheckboxBinding, VgRadioBinding, VgSelectBinding, VgRangeBinding, VgGenericBinding) + anyOf(:class:`VgCheckboxBinding`, :class:`VgRadioBinding`, :class:`VgSelectBinding`, + :class:`VgRangeBinding`, :class:`VgGenericBinding`) """ _schema = {'$ref': '#/definitions/VgBinding'} _rootschema = Root._schema @@ -9161,11 +9200,11 @@ class VgMarkConfig(VegaLiteSchema): Attributes ---------- - align : HorizontalAlign + align : :class:`HorizontalAlign` The horizontal alignment of the text. One of ``"left"``, ``"right"``, ``"center"``. angle : float The rotation angle of the text, in degrees. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` The vertical alignment of the text. One of ``"top"``, ``"middle"``, ``"bottom"``. **Default value:** ``"middle"`` @@ -9173,10 +9212,10 @@ class VgMarkConfig(VegaLiteSchema): The radius in pixels of rounded rectangle corners. **Default value:** ``0`` - cursor : Cursor + cursor : :class:`Cursor` The mouse cursor used over the mark. Any valid `CSS cursor type - `_ can be used. - dir : Dir + `__ can be used. + dir : :class:`Dir` The direction of the text. One of ``"ltr"`` (left-to-right) or ``"rtl"`` (right-to-left). This property determines on which side is truncated in response to the limit parameter. @@ -9204,16 +9243,16 @@ class VgMarkConfig(VegaLiteSchema): The typeface to set the text in (e.g., ``"Helvetica Neue"`` ). fontSize : float The font size, in pixels. - fontStyle : FontStyle + fontStyle : :class:`FontStyle` The font style (e.g., ``"italic"`` ). - fontWeight : FontWeight + fontWeight : :class:`FontWeight` The font weight. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` ). href : string A URL to load upon mouse click. If defined, the mark acts as a hyperlink. - interpolate : Interpolate + interpolate : :class:`Interpolate` The line interpolation method to use for line and area marks. One of the following: @@ -9245,7 +9284,7 @@ class VgMarkConfig(VegaLiteSchema): **Default value:** ``0.7`` for non-aggregate plots with ``point``, ``tick``, ``circle``, or ``square`` marks or layered ``bar`` charts and ``1`` otherwise. - orient : Orient + orient : :class:`Orient` The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. @@ -9277,7 +9316,7 @@ class VgMarkConfig(VegaLiteSchema): Default Stroke Color. This has higher precedence than ``config.color`` **Default value:** (None) - strokeCap : StrokeCap + strokeCap : :class:`StrokeCap` The stroke cap for line ending style. One of ``"butt"``, ``"round"``, or ``"square"``. @@ -9286,7 +9325,7 @@ class VgMarkConfig(VegaLiteSchema): An array of alternating stroke, space lengths for creating dashed or dotted lines. strokeDashOffset : float The offset (in pixels) into which to begin drawing with the stroke dash array. - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of ``"miter"``, ``"round"`` or ``"bevel"``. **Default value:** ``"miter"`` @@ -9453,24 +9492,24 @@ class VgTitleConfig(VegaLiteSchema): Attributes ---------- - anchor : Anchor + anchor : :class:`Anchor` The anchor position for placing the title. One of ``"start"``, ``"middle"``, or ``"end"``. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title. **Default value:** ``"middle"`` for `single - `_ and `layered - `_ views. + `__ and `layered + `__ views. ``"start"`` for other composite views. - **Note:** `For now `_, ``anchor`` is + **Note:** `For now `__, ``anchor`` is only customizable only for `single - `_ and `layered - `_ views. For other composite + `__ and `layered + `__ views. For other composite views, ``anchor`` is always ``"start"``. angle : float Angle in degrees of title text. - baseline : VerticalAlign + baseline : :class:`VerticalAlign` Vertical text baseline for title text. color : string Text color for title text. @@ -9480,7 +9519,7 @@ class VgTitleConfig(VegaLiteSchema): Font size in pixels for title text. **Default value:** ``10``. - fontWeight : FontWeight + fontWeight : :class:`FontWeight` Font weight for title text. This can be either a string (e.g ``"bold"``, ``"normal"`` ) or a number ( ``100``, ``200``, ``300``, ..., ``900`` where ``"normal"`` = ``400`` and ``"bold"`` = ``700`` @@ -9489,7 +9528,7 @@ class VgTitleConfig(VegaLiteSchema): The maximum allowed length in pixels of legend labels. offset : float Offset in pixels of the title from the chart body and axes. - orient : TitleOrient + orient : :class:`TitleOrient` Default title orientation ("top", "bottom", "left", or "right") """ _schema = {'$ref': '#/definitions/VgTitleConfig'} @@ -9538,7 +9577,7 @@ class ViewConfig(VegaLiteSchema): The offset (in pixels) into which to begin drawing with the stroke dash array. **Default value:** (none) - strokeJoin : StrokeJoin + strokeJoin : :class:`StrokeJoin` The stroke line join method. One of miter (default), round or bevel. **Default value:** 'miter' @@ -9583,10 +9622,10 @@ class WindowFieldDef(VegaLiteSchema): Attributes ---------- - op : anyOf(AggregateOp, WindowOnlyOp) + op : anyOf(:class:`AggregateOp`, :class:`WindowOnlyOp`) The window or aggregation operations to apply within a window, including ``rank``, ``lead``, ``sum``, ``average`` or ``count``. See the list of all supported - operations `here `_. + operations `here `__. field : string The data field for which to compute the aggregate or window function. This can be omitted for window functions that do not operate over a field such as ``count``, @@ -9596,7 +9635,7 @@ class WindowFieldDef(VegaLiteSchema): operations that do not accept a parameter. See the list of all supported operations and their parameters `here - `_. + `__. as : string The output name for the window operation. """ @@ -9628,7 +9667,7 @@ class WindowTransform(VegaLiteSchema): Attributes ---------- - window : List(WindowFieldDef) + window : List(:class:`WindowFieldDef`) The definition of the fields in the window, and what calculations to use. frame : List(anyOf(None, float)) A frame specification as a two-element array indicating how the sliding window @@ -9657,7 +9696,7 @@ class WindowTransform(VegaLiteSchema): last_value, and nth_value window operations. **Default value:** ``false`` - sort : List(SortField) + sort : List(:class:`SortField`) A sort field definition for sorting data objects within a window. If two data objects are considered equal by the comparator, they are considered “peer” values of equal rank. If sort is not specified, the order is undefined: data objects are diff --git a/tools/generate_schema_wrapper.py b/tools/generate_schema_wrapper.py index acf1d72fc..e12b53b07 100644 --- a/tools/generate_schema_wrapper.py +++ b/tools/generate_schema_wrapper.py @@ -31,6 +31,8 @@ def _process_description(self, description): description = description.replace(":raw-html-m2r:", ":raw-html:") description = description.replace(r'\ ,', ',') description = description.replace(r'\ ', ' ') + # turn explicit references into anonymous references + description = description.replace('>`_', '>`__') description += '\n' return description.strip() diff --git a/tools/schemapi/utils.py b/tools/schemapi/utils.py index 71072ea1c..dd77b60e3 100644 --- a/tools/schemapi/utils.py +++ b/tools/schemapi/utils.py @@ -167,7 +167,11 @@ def title(self): @property def short_description(self): - return self.title or self.medium_description + if self.title: + # use RST syntax for generated sphinx docs + return ":class:`{0}`".format(self.title) + else: + return self.medium_description @property def medium_description(self): From 857a893a8a3b84a6726d1e3e49d6e6309b9004d4 Mon Sep 17 00:00:00 2001 From: Jake VanderPlas Date: Wed, 1 Aug 2018 09:02:29 -0700 Subject: [PATCH 6/6] BUG: fix unnecessary warning in schematable extension code --- altair/sphinxext/schematable.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/altair/sphinxext/schematable.py b/altair/sphinxext/schematable.py index c07b9919a..1dd6befe4 100644 --- a/altair/sphinxext/schematable.py +++ b/altair/sphinxext/schematable.py @@ -10,7 +10,7 @@ def type_description(schema): """Return a concise type description for the given schema""" - if schema == {}: + if not schema or schema.keys() == {'description'}: return 'any' elif "$ref" in schema: return ":class:`{0}`".format(schema['$ref'].split('/')[-1])