mpl_toolkits.axisartist.axislines.AxisArtistHelper

class mpl_toolkits.axisartist.axislines.AxisArtistHelper

Bases: object

AxisArtistHelper should define following method with given APIs. Note that the first axes argument will be axes attribute of the caller artist.:

# LINE (spinal line?)

def get_line(self, axes):
    # path : Path
    return path

def get_line_transform(self, axes):
    # ...
    # trans : transform
    return trans

# LABEL

def get_label_pos(self, axes):
    # x, y : position
    return (x, y), trans

def get_label_offset_transform(self,
        axes,
        pad_points, fontprops, renderer,
        bboxes,
        ):
    # va : vertical alignment
    # ha : horizontal alignment
    # a : angle
    return trans, va, ha, a

# TICK

def get_tick_transform(self, axes):
    return trans

def get_tick_iterators(self, axes):
    # iter : iterable object that yields (c, angle, l) where
    # c, angle, l is position, tick angle, and label

    return iter_major, iter_minor

class Fixed(loc, nth_coord=None)

Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base

Helper class for a fixed (in the axes coordinate) axis.

nth_coord = along which coordinate value varies in 2d, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis

__init__(self, loc, nth_coord=None)

nth_coord = along which coordinate value varies in 2d, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis

__module__ = 'mpl_toolkits.axisartist.axislines'

get_axislabel_pos_angle(self, axes)

Return the label reference position in transAxes.

get_label_transform() returns a transform of (transAxes+offset)

get_axislabel_transform(self, axes)

get_line(self, axes)

get_line_transform(self, axes)

get_nth_coord(self)

get_tick_transform(self, axes)

class Floating(nth_coord, value)

Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base

__init__(self, nth_coord, value)

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'mpl_toolkits.axisartist.axislines'

get_line(self, axes)

get_nth_coord(self)

__dict__ = mappingproxy({'__module__': 'mpl_toolkits.axisartist.axislines', '__doc__': '\n AxisArtistHelper should define\n following method with given APIs. Note that the first axes argument\n will be axes attribute of the caller artist.::\n\n\n # LINE (spinal line?)\n\n def get_line(self, axes):\n # path : Path\n return path\n\n def get_line_transform(self, axes):\n # ...\n # trans : transform\n return trans\n\n # LABEL\n\n def get_label_pos(self, axes):\n # x, y : position\n return (x, y), trans\n\n\n def get_label_offset_transform(self,\n axes,\n pad_points, fontprops, renderer,\n bboxes,\n ):\n # va : vertical alignment\n # ha : horizontal alignment\n # a : angle\n return trans, va, ha, a\n\n # TICK\n\n def get_tick_transform(self, axes):\n return trans\n\n def get_tick_iterators(self, axes):\n # iter : iterable object that yields (c, angle, l) where\n # c, angle, l is position, tick angle, and label\n\n return iter_major, iter_minor\n ', '_Base': <class 'mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base'>, 'Fixed': <class 'mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed'>, 'Floating': <class 'mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating'>, '__dict__': <attribute '__dict__' of 'AxisArtistHelper' objects>, '__weakref__': <attribute '__weakref__' of 'AxisArtistHelper' objects>})

__module__ = 'mpl_toolkits.axisartist.axislines'

__weakref__

list of weak references to the object (if defined)

Examples using mpl_toolkits.axisartist.axislines.AxisArtistHelper