- class altair.X2(shorthand=Undefined, aggregate=Undefined, band=Undefined, bin=Undefined, field=Undefined, timeUnit=Undefined, title=Undefined, **kwds)
X2 schema wrapper
Mapping(required=[shorthand]) A field definition of a secondary channel that shares a scale with another primary channel. For example,
xError2share the same scale with
shorthand for field, aggregate, and type
Aggregation function for the field (e.g.,
See also: aggregate documentation.
For rect-based marks (
image), mark size relative to bandwidth of band scales, bins or time units. If set to
1, the mark size is set to the bandwidth, the bin interval, or the time unit interval. If set to
0.5, the mark size is half of the bandwidth or the time unit interval.
For other marks, relative position on a band of a stacked, binned, time unit or band scale. If set to
0, the marks will be positioned at the beginning of the band. If set to
0.5, the marks will be positioned in the middle of the band.
A flag for binning a
quantitativefield, an object defining binning parameters, or indicating that the data for
ychannel are binned before they are imported into Vega-Lite (
true, default binning parameters will be applied.
"binned", this indicates that the data for the
y) channel are already binned. You can map the bin-start field to
y) and the bin-end field to
y2). The scale and axis will be formatted similar to binning in Vega-Lite. To adjust the axis ticks based on the bin step, you can also set the axis’s tickMinStep property.
See also: bin documentation.
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.
See also: field documentation.
Notes: 1) Dots (
.) and brackets (
]) can be used to access nested objects (e.g.,
"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\[0\]"). See more details about escaping in the field documentation. 2)
fieldis not required if
Time unit (e.g.,
hours) for a temporal field. or a temporal field that gets casted as ordinal.
See also: timeUnit documentation.
A title for the field. If
null, the title will be removed.
Default value: derived from the field’s name and transformation function (
timeUnit). If the field has an aggregate function, the function is displayed as part of the title (e.g.,
"Sum of Profit"). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g.,
"Transaction Date (year-month)"). Otherwise, the title is simply the field name.
1) You can customize the default field title format by providing the fieldTitle property in the config or fieldTitle function via the compile function’s options.
2) If both field definition’s
titleand axis, header, or legend
titleare defined, axis/header/legend title will be used.
- __init__(shorthand=Undefined, aggregate=Undefined, band=Undefined, bin=Undefined, field=Undefined, timeUnit=Undefined, title=Undefined, **kwds)
__init__([shorthand, aggregate, band, bin, ...])
Return a copy of the object
from_dict(dct[, validate, _wrapper_classes])
Construct class from a dictionary representation
Instantiate the object from a valid JSON string
Resolve references in the context of this object's schema or root schema.
to_dict([validate, ignore, context])
Return a dictionary representation of the object
to_json([validate, ignore, context, indent, ...])
Emit the JSON representation for this object as a string.
Validate the instance against the class schema in the context of the rootschema.
validate_property(name, value[, schema])
Validate a property against property schema in the context of the rootschema