altair.ConditionalPredicateValueDefstring¶
-
class
altair.
ConditionalPredicateValueDefstring
(test=Undefined, value=Undefined, **kwds)¶ ConditionalPredicateValueDefstring schema wrapper
Mapping(required=[test, value])
Attributes: - test :
PredicateComposition
Predicate for triggering the condition
- value : string
A constant value in visual domain (e.g.,
"red"
/"#0099ff"
/ gradient definition for color, values between0
to1
for opacity).
-
__init__
(test=Undefined, value=Undefined, **kwds)¶
Methods
__init__
([test, value])copy
([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
([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
(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 -
copy
(deep=True, ignore=())¶ Return a copy of the object
Parameters: - deep : boolean 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.
- ignore : list, optional
A list of keys for which the contents should not be copied, but only stored by reference.
-
from_dict
(dct, validate=True, _wrapper_classes=None)¶ Construct class from a dictionary representation
Parameters: - dct : dictionary
The dict from which to construct the class
- validate : boolean
If True (default), then validate the input against the schema.
- _wrapper_classes : list (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: - obj : Schema object
The wrapped schema
Raises: - jsonschema.ValidationError :
if validate=True and dct does not conform to the schema
-
from_json
(json_string, validate=True, **kwargs)¶ Instantiate the object from a valid JSON string
Parameters: - json_string : string
The string containing a valid JSON chart specification.
- validate : boolean
If True (default), then validate the input against the schema.
- **kwargs :
Additional keyword arguments are passed to json.loads
Returns: - chart : Chart object
The altair Chart object built from the specification.
-
resolve_references
(schema=None)¶ Resolve references in the context of this object’s schema or root schema.
-
to_dict
(validate=True, ignore=None, context=None)¶ Return a dictionary representation of the object
Parameters: - validate : boolean 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.
- ignore : list
A list of keys to ignore. This will not passed to child to_dict function calls.
- context : dict (optional)
A context dictionary that will be passed to all child to_dict function calls
Returns: - dct : dictionary
The dictionary representation of this object
Raises: - jsonschema.ValidationError :
if validate=True and the dict does not conform to the schema
-
to_json
(validate=True, ignore=[], context={}, indent=2, sort_keys=True, **kwargs)¶ Emit the JSON representation for this object as a string.
Parameters: - validate : boolean 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.
- ignore : list
A list of keys to ignore. This will not passed to child to_dict function calls.
- context : dict (optional)
A context dictionary that will be passed to all child to_dict function calls
- indent : integer, default 2
the number of spaces of indentation to use
- sort_keys : boolean, default True
if True, sort keys in the output
- **kwargs
Additional keyword arguments are passed to
json.dumps()
Returns: - spec : string
The JSON specification of the chart object.
-
validate
(instance, schema=None)¶ Validate the instance against the class schema in the context of the rootschema.
-
validate_property
(name, value, schema=None)¶ Validate a property against property schema in the context of the rootschema
- test :