bokeh.models.formatters
¶Models for controlling the text and visual formatting of tick labels on Bokeh plot axes.
BasicTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Display tick values from continuous ranges as “basic numbers”, using scientific notation when appropriate by default.
power_limit_high
¶property type: Int
Limit the use of scientific notation to when:
log(x) >= power_limit_high
[
{
"attributes": {
"doc": null,
"id": "8d91a3e8-3a51-4981-a531-88f1291614f0",
"name": null,
"power_limit_high": 5,
"power_limit_low": -3,
"precision": "auto",
"tags": [],
"use_scientific": true
},
"id": "8d91a3e8-3a51-4981-a531-88f1291614f0",
"type": "BasicTickFormatter"
}
]
CategoricalTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Display tick values from categorical ranges as string values.
[
{
"attributes": {
"doc": null,
"id": "6efbfe2f-aab1-4754-97d8-b442cb2c2435",
"name": null,
"tags": []
},
"id": "6efbfe2f-aab1-4754-97d8-b442cb2c2435",
"type": "CategoricalTickFormatter"
}
]
DatetimeTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Display tick values from a continuous range as formatted datetimes.
formats
¶property type: Dict
(Enum
(‘microseconds’, ‘milliseconds’, ‘seconds’, ‘minsec’, ‘minutes’, ‘hourmin’, ‘hours’, ‘days’, ‘months’, ‘years’), List
(String
))
User defined formats for displaying datetime values.
The enum values correspond roughly to different “time scales”. The corresponding value is a list of strftime formats to use for formatting datetime tick values that fall in 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. These behaviors cannot be changed as of now.
An example of specifying the same date format over a range of time scales:
DatetimeTickFormatter(
formats=dict(
hours=["%B %Y"],
days=["%B %Y"],
months=["%B %Y"],
years=["%B %Y"],
)
)
This list of supported strftime formats is reproduced below.
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 compliment 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.
[
{
"attributes": {
"doc": null,
"formats": {},
"id": "40ee96a9-efc0-40bd-94b1-11b9b3055ae1",
"name": null,
"tags": []
},
"id": "40ee96a9-efc0-40bd-94b1-11b9b3055ae1",
"type": "DatetimeTickFormatter"
}
]
LogTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Display tick values from continuous ranges as powers of some base.
Most often useful in conjunction with a LogTicker
.
[
{
"attributes": {
"doc": null,
"id": "009da081-b257-4d0a-8097-6cb3c1d14b6f",
"name": null,
"tags": [],
"ticker": null
},
"id": "009da081-b257-4d0a-8097-6cb3c1d14b6f",
"type": "LogTickFormatter"
}
]
NumeralTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Tick formatter based on a human-readable format string.
format
¶property type: String
The number format, as defined in the following tables:
NUMBERS:
Number | Format | String |
---|---|---|
10000 | ‘0,0.0000’ | 10,000.0000 |
10000.23 | ‘0,0’ | 10,000 |
10000.23 | ‘+0,0’ | +10,000 |
-10000 | ‘0,0.0’ | -10,000.0 |
10000.1234 | ‘0.000’ | 10000.123 |
10000.1234 | ‘0[.]00000’ | 10000.12340 |
-10000 | ‘(0,0.0000)’ | (10,000.0000) |
-0.23 | ‘.00’ | -.23 |
-0.23 | ‘(.00)’ | (.23) |
0.23 | ‘0.00000’ | 0.23000 |
0.23 | ‘0.0[0000]’ | 0.23 |
1230974 | ‘0.0a’ | 1.2m |
1460 | ‘0 a’ | 1 k |
-104000 | ‘0a’ | -104k |
1 | ‘0o’ | 1st |
52 | ‘0o’ | 52nd |
23 | ‘0o’ | 23rd |
100 | ‘0o’ | 100th |
CURRENCY:
Number | Format | String |
---|---|---|
1000.234 | ‘$0,0.00’ | $1,000.23 |
1000.2 | ‘0,0[.]00 $’ | 1,000.20 $ |
1001 | ‘$ 0,0[.]00’ | $ 1,001 |
-1000.234 | ‘($0,0)’ | ($1,000) |
-1000.234 | ‘$0.00’ | -$1000.23 |
1230974 | ‘($ 0.00 a)’ | $ 1.23 m |
BYTES:
Number | Format | String |
---|---|---|
100 | ‘0b’ | 100B |
2048 | ‘0 b’ | 2 KB |
7884486213 | ‘0.0b’ | 7.3GB |
3467479682787 | ‘0.000 b’ | 3.154 TB |
PERCENTAGES:
Number | Format | String |
---|---|---|
1 | ‘0%’ | 100% |
0.974878234 | ‘0.000%’ | 97.488% |
-0.43 | ‘0 %’ | -43 % |
0.43 | ‘(0.000 %)’ | 43.000 % |
TIME:
Number | Format | String |
---|---|---|
25 | ‘00:00:00’ | 0:00:25 |
238 | ‘00:00:00’ | 0:03:58 |
63846 | ‘00:00:00’ | 17:44:06 |
language
¶property type: Enum
(‘be-nl’, ‘chs’, ‘cs’, ‘da-dk’, ‘de-ch’, ‘de’, ‘en’, ‘en-gb’, ‘es-ES’, ‘es’, ‘et’, ‘fi’, ‘fr-CA’, ‘fr-ch’, ‘fr’, ‘hu’, ‘it’, ‘ja’, ‘nl-nl’, ‘pl’, ‘pt-br’, ‘pt-pt’, ‘ru’, ‘ru-UA’, ‘sk’, ‘th’, ‘tr’, ‘uk-UA’)
The language to use for formatting language-specific features (e.g. thousands separator).
[
{
"attributes": {
"doc": null,
"format": "0,0",
"id": "8c7cc724-f9d4-4668-bedc-d7e04a2c81b5",
"language": "en",
"name": null,
"rounding": "round",
"tags": []
},
"id": "8c7cc724-f9d4-4668-bedc-d7e04a2c81b5",
"type": "NumeralTickFormatter"
}
]
PrintfTickFormatter
(**kwargs)¶Bases: bokeh.models.formatters.TickFormatter
Tick formatter based on a printf-style format string.
format
¶property type: String
The numer format, as defined as follows: the placeholder in the format string is marked by % and is followed by one or more of these elements, in this order:
+
signCauses the result to be preceded with a plus or minus sign on numeric
values. By default, only the -
sign is used on negative numbers.
Specifies what (if any) character to use for padding. Possible values
are 0 or any other character precedeed by a '
(single quote). The
default is to pad with spaces.
-
signCauses sprintf to left-align the result of this placeholder. The default is to right-align the result.
Specifies how many characters the result should have. If the value to be returned is shorter than this number, the result will be padded.
Consists of a .
(dot) followed by a number, specifies how many digits
should be displayed for floating point numbers. When used on a string, it
causes the result to be truncated.
Can be any of:
%
— yields a literal %
characterb
— yields an integer as a binary numberc
— yields an integer as the character with that ASCII valued
or i
— yields an integer as a signed decimal numbere
— yields a float using scientific notationu
— yields an integer as an unsigned decimal numberf
— yields a float as iso
— yields an integer as an octal numbers
— yields a string as isx
— yields an integer as a hexadecimal number (lower-case)X
— yields an integer as a hexadecimal number (upper-case)[
{
"attributes": {
"doc": null,
"format": "%s",
"id": "07530c77-ce7b-40eb-a9e6-d646a3d47e5b",
"name": null,
"tags": []
},
"id": "07530c77-ce7b-40eb-a9e6-d646a3d47e5b",
"type": "PrintfTickFormatter"
}
]
TickFormatter
(**kwargs)¶Bases: bokeh.plot_object.PlotObject
A base class for all tick formatter types. TickFormatter
is
not generally useful to instantiate on its own.
[
{
"attributes": {
"doc": null,
"id": "7223581c-a619-4690-ab6d-70e905688194",
"name": null,
"tags": []
},
"id": "7223581c-a619-4690-ab6d-70e905688194",
"type": "TickFormatter"
}
]