altair.DateTime

class altair.DateTime(date=Undefined, day=Undefined, hours=Undefined, milliseconds=Undefined, minutes=Undefined, month=Undefined, quarter=Undefined, seconds=Undefined, utc=Undefined, year=Undefined, **kwds)

DateTime schema wrapper

Mapping(required=[]) Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

Attributes

datefloat

Integer value representing the date (day of the month) from 1-31.

dayanyOf(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" ).

Warning: A DateTime definition object with day ** should not be combined with year, quarter, month, or date.

hoursfloat

Integer value representing the hour of a day from 0-23.

millisecondsfloat

Integer value representing the millisecond segment of time.

minutesfloat

Integer value representing the minute segment of time from 0-59.

monthanyOf(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" ).

quarterfloat

Integer value representing the quarter of the year (from 1-4).

secondsfloat

Integer value representing the second segment (0-59) of a time value

utcboolean

A boolean flag indicating if date time is in utc time. If false, the date time is in local time

yearfloat

Integer value representing the year.

__init__(self, date=Undefined, day=Undefined, hours=Undefined, milliseconds=Undefined, minutes=Undefined, month=Undefined, quarter=Undefined, seconds=Undefined, utc=Undefined, year=Undefined, **kwds)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, date, day, hours, …])	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