altair.BinParams¶
-
class
altair.
BinParams
(anchor=Undefined, base=Undefined, binned=Undefined, divide=Undefined, extent=Undefined, maxbins=Undefined, minstep=Undefined, nice=Undefined, step=Undefined, steps=Undefined, **kwds)¶ BinParams schema wrapper
Mapping(required=[]) Binning properties or boolean flag for determining whether to bin data or not.
- Attributes
- anchorfloat
A value in the binned domain at which to anchor the bins, shifting the bin boundaries if necessary to ensure that a boundary aligns with the anchor value.
Default value: the minimum bin extent value
- basefloat
The number base to use for automatic bin determination (default is base 10).
Default value:
10
- binnedboolean
When set to
true
, Vega-Lite treats the input data as already binned.- divideList([float, float])
Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.
Default value:
[5, 2]
- extent
BinExtent
A two-element (
[min, max]
) array indicating the range of desired bin values.- maxbinsfloat
Maximum number of bins.
Default value:
6
forrow
,column
andshape
channels;10
for other channels- minstepfloat
A minimum allowable step size (particularly useful for integer values).
- niceboolean
If true, attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.
Default value:
true
- stepfloat
An exact step size to use between bins.
Note: If provided, options such as maxbins will be ignored.
- stepsList(float)
An array of allowable step sizes to choose from.
-
__init__
(self, anchor=Undefined, base=Undefined, binned=Undefined, divide=Undefined, extent=Undefined, maxbins=Undefined, minstep=Undefined, nice=Undefined, step=Undefined, steps=Undefined, **kwds)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(self[, anchor, base, binned, …])Initialize self.
copy
(self[, deep, ignore])Return a copy of the object
from_dict
(dct[, validate, _wrapper_classes])Construct class from a dictionary representation
from_json
(json_string[, validate])Instantiate the object from a valid JSON string
resolve_references
([schema])Resolve references in the context of this object’s schema or root schema.
to_dict
(self[, validate, ignore, context])Return a dictionary representation of the object
to_json
(self[, validate, ignore, context, …])Emit the JSON representation for this object as a string.
validate
(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property
(name, value[, schema])Validate a property against property schema in the context of the rootschema
-
copy
(self, deep=True, ignore=())¶ Return a copy of the object
- Parameters
- deepboolean or list, optional
If True (default) then return a deep copy of all dict, list, and SchemaBase objects within the object structure. If False, then only copy the top object. If a list or iterable, then only copy the listed attributes.
- ignorelist, optional
A list of keys for which the contents should not be copied, but only stored by reference.
-
classmethod
from_dict
(dct, validate=True, _wrapper_classes=None)¶ Construct class from a dictionary representation
- Parameters
- dctdictionary
The dict from which to construct the class
- validateboolean
If True (default), then validate the input against the schema.
- _wrapper_classeslist (optional)
The set of SchemaBase classes to use when constructing wrappers of the dict inputs. If not specified, the result of cls._default_wrapper_classes will be used.
- Returns
- objSchema object
The wrapped schema
- Raises
- jsonschema.ValidationError :
if validate=True and dct does not conform to the schema
-
classmethod
from_json
(json_string, validate=True, **kwargs)¶ Instantiate the object from a valid JSON string
- Parameters
- json_stringstring
The string containing a valid JSON chart specification.
- validateboolean
If True (default), then validate the input against the schema.
- **kwargs :
Additional keyword arguments are passed to json.loads
- Returns
- chartChart object
The altair Chart object built from the specification.
-
classmethod
resolve_references
(schema=None)¶ Resolve references in the context of this object’s schema or root schema.
-
to_dict
(self, validate=True, ignore=None, context=None)¶ Return a dictionary representation of the object
- Parameters
- validateboolean or string
If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.
- ignorelist
A list of keys to ignore. This will not passed to child to_dict function calls.
- contextdict (optional)
A context dictionary that will be passed to all child to_dict function calls
- Returns
- dctdictionary
The dictionary representation of this object
- Raises
- jsonschema.ValidationError :
if validate=True and the dict does not conform to the schema
-
to_json
(self, validate=True, ignore=[], context={}, indent=2, sort_keys=True, **kwargs)¶ Emit the JSON representation for this object as a string.
- Parameters
- validateboolean or string
If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.
- ignorelist
A list of keys to ignore. This will not passed to child to_dict function calls.
- contextdict (optional)
A context dictionary that will be passed to all child to_dict function calls
- indentinteger, default 2
the number of spaces of indentation to use
- sort_keysboolean, default True
if True, sort keys in the output
- **kwargs
Additional keyword arguments are passed to
json.dumps()
- Returns
- specstring
The JSON specification of the chart object.
-
classmethod
validate
(instance, schema=None)¶ Validate the instance against the class schema in the context of the rootschema.
-
classmethod
validate_property
(name, value, schema=None)¶ Validate a property against property schema in the context of the rootschema