Formatter

Formatter(formatter, *args, date=False, index=False, **kwargs)[source]

Returns a Formatter instance, used to interpret the xformatter, xformatter_kw, yformatter, and yformatter_kw arguments when passed to format, and the formatter and formatter_kw arguments when passed to colorbar methods wrapped by colorbar_wrapper.

Parameters

  • formatter (Formatter, str, list of str, or function) – If Formatter, the object is returned.

    If list of strings, ticks are labeled with these strings. Returns a FixedFormatter instance when index is False and an IndexFormatter instance when index is True.

    If function, labels will be generated using this function. Returns a FuncFormatter instance.

    If string, there are 4 possibilities:

    1. If string contains '%' and date is False, ticks will be formatted using the C-notation string % number method. See this page for a review.

    2. If string contains '%' and date is True, datetime string % number formatting is used. See this page for a review.

    3. If string contains {x} or {x:...}, ticks will be formatted by calling string.format(x=number).

    4. In all other cases, a dictionary lookup is performed (see below table).

    Key

    Class

    Description

    'null', 'none'

    NullFormatter

    No tick labels

    'auto'

    AutoFormatter

    New default tick labels for axes

    'simple'

    SimpleFormatter

    New default tick labels for e.g. contour labels

    'frac'

    FracFormatter

    Rational fractions

    'date'

    AutoDateFormatter

    Default tick labels for datetime axes

    'datestr'

    DateFormatter

    Date formatting with C-style string % format notation

    'concise'

    ConciseDateFormatter

    More concise date labels introduced in matplotlib 3.1

    'scalar'

    ScalarFormatter

    Old default tick labels for axes

    'strmethod'

    StrMethodFormatter

    From the string.format method

    'formatstr'

    FormatStrFormatter

    From C-style string % format notation

    'log', 'sci'

    LogFormatterSciNotation

    For log-scale axes with scientific notation

    'math'

    LogFormatterMathtext

    For log-scale axes with math text

    'logit'

    LogitFormatter

    For logistic-scale axes

    'eng'

    EngFormatter

    Engineering notation

    'percent'

    PercentFormatter

    Trailing percent sign

    'fixed'

    FixedFormatter

    List of strings

    'index'

    IndexFormatter

    List of strings corresponding to non-negative integer positions along the axis

    'theta'

    ThetaFormatter

    Formats radians as degrees, with a degree symbol

    'pi'

    FracFormatter preset

    Fractions of \(\pi\)

    'e'

    FracFormatter preset

    Fractions of e

    'deg'

    SimpleFormatter preset

    Trailing degree symbol

    'deglon'

    SimpleFormatter preset

    Trailing degree symbol and cardinal “WE” indicator

    'deglat'

    SimpleFormatter preset

    Trailing degree symbol and cardinal “SN” indicator

    'lon'

    SimpleFormatter preset

    Cardinal “WE” indicator

    'lat'

    SimpleFormatter preset

    Cardinal “SN” indicator

  • date (bool, optional) – Toggles the behavior when formatter contains a '%' sign (see above).

  • index (bool, optional) – Controls the behavior when formatter is a list of strings (see above).

  • *args, **kwargs – Passed to the Formatter class.

Returns

Formatter – A Formatter instance.