This website is for version 5. You can find the documentation for version 4 here.

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 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.

Parameters:
datefloat

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

daystr, float, Day

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.

monthstr, float, Month

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

utcbool

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__(date=Undefined, day=Undefined, hours=Undefined, milliseconds=Undefined, minutes=Undefined, month=Undefined, quarter=Undefined, seconds=Undefined, utc=Undefined, year=Undefined, **kwds)#

Methods

__init__([date, day, hours, milliseconds, ...])

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, indent, sort_keys, ...])

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