AutoFormatter¶
- class AutoFormatter(zerotrim=None, tickrange=None, wraprange=None, prefix=None, suffix=None, negpos=None, **kwargs)[source]¶
Bases:
matplotlib.ticker.ScalarFormatter
The new default number formatter. Differs from
ScalarFormatter
in the following ways:Trims trailing decimal zeros by default.
Permits specifying range within which major tick marks are labeled.
Permits adding arbitrary prefix or suffix to every tick label string.
Permits adding “negative” and “positive” indicator.
- Parameters
zerotrim (
bool
, optional) – Whether to trim trailing decimal zeros. Default isrc['formatter.zerotrim']
=True
.tickrange (
2-tuple
offloat
, optional) – Range within which major tick marks are labelled. Default is(-np.inf, np.inf)
.wraprange (
2-tuple
offloat
, optional) – Range outside of which tick values are wrapped. For example,(-180, 180)
will format a value of200
as-160
.prefix, suffix (
str
, optional) – Prefix and suffix for all tick strings. The suffix is added before the optionalnegpos
suffix.negpos (
str
, optional) – Length-2 string indicating the suffix for “negative” and “positive” numbers, meant to replace the minus sign.
- Other Parameters
**kwargs – Passed to
ScalarFormatter
.
Warning
The matplotlib
ScalarFormatter
determines the number of significant digits based on the axis limits, and therefore may truncate digits while formatting ticks on highly non-linear axis scales likeLogScale
. We try to correct this behavior with a patch.Methods Summary
__call__
(x[, pos])Convert number to a string.
Get the offset but always use math text.