bokeh.models.DatetimeTickFormatter#

class DatetimeTickFormatter(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: TickFormatter

A TickFormatter for displaying datetime values nicely across a range of scales.

DatetimeTickFormatter has the following properties (listed together with their default values) that can be used to control the formatting of axis ticks at different scales:

Scale	Format	1st Context	2nd Context
microseconds	%fus	%T	%b %d, %Y
milliseconds	%3Nms	%T	%b %d, %Y
seconds	%T	%b %d, %Y
minsec	%T	%b %d, %Y
minutes	%H:%M	%b %d, %Y
hourmin	%H:%M	%b %d, %Y
hours	%H:%M	%b %d, %Y
days	%b %d	%Y
months	%b %Y
years	%Y

Each scale property can be set to format or list of formats to use for formatting datetime tick values that fall in that “time scale”. By default, only the first format string passed for each time scale will be used. By default, all leading zeros are stripped away from the formatted labels.

This list of supported strftime formats is reproduced below.

%a	The abbreviated name of the day of the week according to the current locale.
%A	The full name of the day of the week according to the current locale.
%b	The abbreviated month name according to the current locale.
%B	The full month name according to the current locale.
%c	The preferred date and time representation for the current locale.
%C	The century number (year/100) as a 2-digit integer.
%d	The day of the month as a decimal number (range 01 to 31).
%D	Equivalent to %m/%d/%y. (Americans should note that in many other countries %d/%m/%y is rather common. This means that in international context this format is ambiguous and should not be used.)
%e	Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.
%f	Microsecond as a decimal number, zero-padded on the left (range 000000-999999). This is an extension to the set of directives available to timezone.
%F	Equivalent to %Y-%m-%d (the ISO 8601 date format).
%G	The ISO 8601 week-based year with century as a decimal number. The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as %Y, except that if the ISO week number belongs to the previous or next year, that year is used instead.
%g	Like %G, but without century, that is, with a 2-digit year (00-99).
%h	Equivalent to %b.
%H	The hour as a decimal number using a 24-hour clock (range 00 to 23).
%I	The hour as a decimal number using a 12-hour clock (range 01 to 12).
%j	The day of the year as a decimal number (range 001 to 366).
%k	The hour (24-hour clock) as a decimal number (range 0 to 23). Single digits are preceded by a blank. See also %H.
%l	The hour (12-hour clock) as a decimal number (range 1 to 12). Single digits are preceded by a blank. See also %I.
%m	The month as a decimal number (range 01 to 12).
%M	The minute as a decimal number (range 00 to 59).
%n	A newline character. Bokeh text does not currently support newline characters.
%N	Nanosecond as a decimal number, zero-padded on the left (range 000000000-999999999). Supports a padding width specifier, i.e. %3N displays 3 leftmost digits. However, this is only accurate to the millisecond level of precision due to limitations of timezone.
%p	Either “AM” or “PM” according to the given time value, or the corresponding strings for the current locale. Noon is treated as “PM” and midnight as “AM”.
%P	Like %p but in lowercase: “am” or “pm” or a corresponding string for the current locale.
%r	The time in a.m. or p.m. notation. In the POSIX locale this is equivalent to %I:%M:%S %p.
%R	The time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.
%s	The number of seconds since the Epoch, 1970-01-01 00:00:00+0000 (UTC).
%S	The second as a decimal number (range 00 to 60). (The range is up to 60 to allow for occasional leap seconds.)
%t	A tab character. Bokeh text does not currently support tab characters.
%T	The time in 24-hour notation (%H:%M:%S).
%u	The day of the week as a decimal, range 1 to 7, Monday being 1. See also %w.
%U	The week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. See also %V and %W.
%V	The ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. See also %U and %W.
%w	The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.
%W	The week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.
%x	The preferred date representation for the current locale without the time.
%X	The preferred time representation for the current locale without the date.
%y	The year as a decimal number without a century (range 00 to 99).
%Y	The year as a decimal number including the century.
%z	The +hhmm or -hhmm numeric timezone (that is, the hour and minute offset from UTC).
%Z	The timezone name or abbreviation.
%%	A literal ‘%’ character.

Warning

The client library BokehJS uses the timezone library to format datetimes. The inclusion of the list below is based on the claim that timezone makes to support “the full complement of GNU date format specifiers.” However, this claim has not been tested exhaustively against this list. If you find formats that do not function as expected, please submit a GitHub issue, so that the documentation can be updated appropriately.

Property index#
`boundary_scaling`	`context`
`context_location`	`context_which`
`days`	`hide_repeats`
`hourmin`	`hours`
`microseconds`	`milliseconds`
`minsec`	`minutes`
`months`	`name`
`seconds`	`strip_leading_zeros`
`syncable`	`tags`
`years`	`document`

Properties#

boundary_scaling = True#

Type:: Bool

Whether to scale up ticks that are right at the boundary of the next higher resolution of time. E.g. at the hours scale a tick sequence of [“00h”, “06h”, “12h”, 18h”, “00h”] will see a scale up of the “00h” ticks as they are on boundary of the days scale: [“06/08”, “06h”, “12h”, 18h”, “06/09”]

context = None#

Type:: Nullable(

Either(

String,

Instance(DatetimeTickFormatter)

)

)

A format for adding context to the tick or ticks specified by context_which. Valid values are:

None, no context is added
A standard DatetimeTickFormatter format string, the single format is used across all scales
Another DatetimeTickFormatter instance, to have scale-dependent context

context_location = 'below'#

Type:: Enum(Location)

Relative to the tick label text baseline, where the context should be rendered. Valid values are: “below”, “above”, “left”, and “right”.

context_which = 'start'#

Type:: Enum(ContextWhich)

Which tick or ticks to add a formatted context string to. Valid values are: “start”, “end”, “center”, and “all”.

days = '%m/%d'#

Type:: String

Formats for displaying datetime values in the days range.

See the DatetimeTickFormatter help for a list of all supported formats.

hide_repeats = False#

Type:: Bool

Whether repeated formatted tick values will be suppressed.

For example, an initial set of ticks ["06/07", "06/07", "06/07", "06/08", "06/08"] will become ["06/07", "", "", "06/08", ""]. Only the base label, without any additional context, is considered when determining repeats. If the context itself is a DatetimeTickFormatter, then this property may also be set for the context separately, if desired.

hourmin = '%H:%M'#

Type:: String

Formats for displaying datetime values in the hourmin (for combined hours and minutes) range.

See the DatetimeTickFormatter help for a list of all supported formats.

hours = '%Hh'#

Type:: String

Formats for displaying datetime values in the hours range.

See the DatetimeTickFormatter help for a list of all supported formats.

microseconds = '%fus'#

Type:: String

Formats for displaying datetime values in the microseconds range.

See the DatetimeTickFormatter help for a list of all supported formats.

milliseconds = '%3Nms'#

Type:: String

Formats for displaying datetime values in the milliseconds range.

See the DatetimeTickFormatter help for a list of all supported formats.

minsec = ':%M:%S'#

Type:: String

Formats for displaying datetime values in the minsec (for combined minutes and seconds) range.

See the DatetimeTickFormatter help for a list of all supported formats.

minutes = ':%M'#

Type:: String

Formats for displaying datetime values in the minutes range.

See the DatetimeTickFormatter help for a list of all supported formats.

months = '%m/%Y'#

Type:: String

Formats for displaying datetime values in the months range.

See the DatetimeTickFormatter help for a list of all supported formats.

name = None#

Type:: Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

seconds = '%Ss'#

Type:: String

Formats for displaying datetime values in the seconds range.

See the DatetimeTickFormatter help for a list of all supported formats.

strip_leading_zeros = False#

Type:: Either(Bool, Seq(Enum(ResolutionType)))

Whether to strip any leading zeros in the formatted ticks.

Valid values are:

True or False (default) to set stripping across all resolutions.
A sequence of resolution types, e.g. ["microseconds", "milliseconds"], to enable scale-dependent stripping of leading zeros.

syncable = True#

Type:: Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#

Type:: List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

years = '%Y'#

Type:: String

Formats for displaying datetime values in the years range.

See the DatetimeTickFormatter help for a list of all supported formats.

property document: Document | None#: The Document this model is attached to (can be None)

Methods#

apply_theme(property_values: dict[str, Any]) → None#

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:: property_values (dict) – theme values to use in place of defaults
Returns:: None

classmethod clear_extensions() → None#

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:: names of DataSpec properties
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: List of property descriptors in the order of definition.

destroy() → None#: Clean up references to the document and property

equals(other: HasProps) → bool#

Structural equality of models.

Parameters:: other (HasProps) – the other instance to compare to
Returns:: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None#

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:: ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None#

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

Add a callback on this object to trigger when attr changes.

Parameters:

attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: EventCallback) → None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:: list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:: property names

classmethod properties_with_refs() → dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:: names of properties that have references
Return type:: set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:: include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
Returns:: mapping from property names to their values
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:

query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]#: Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: PropertyCallback) → None#: Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:: selector (JSON-like)
Returns:: seq[Model]

select_one(selector: SelectorType) → Model | None#

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found.

Parameters:: selector (JSON-like)
Returns:: Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

Set a property value on this object from JSON.

Parameters:

name (str) – name of the attribute to set
value (JSON-value) – value to set to the attribute to
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.

In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

selector (JSON-like)
updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None#

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:: dict or None

to_serializable(serializer: Serializer) → ObjectRefRep#: Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#

unapply_theme() → None#

Remove any themed values and restore defaults.

Returns:: None

update(**kwargs: Any) → None#

Updates the object’s properties from the given keyword arguments.

Returns:: None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)