mpl_toolkits.axisartist.axis_artist.Ticks

class mpl_toolkits.axisartist.axis_artist.Ticks(ticksize, tick_out=<deprecated parameter>, *, axis=None, **kwargs)

Bases: AttributeCopier, Line2D

Ticks are derived from Line2D, and note that ticks themselves are markers. Thus, you should use set_mec, set_mew, etc.

To change the tick size (length), use set_ticksize. To change the direction of the ticks, use set_tick_direction("in") (or "out", or "inout").

draw(renderer)

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_color()

Return the line color.

See also set_color.

get_markeredgecolor()

Return the marker edge color.

See also set_markeredgecolor.

get_markeredgewidth()

Return the marker edge width in points.

See also set_markeredgewidth.

get_ref_artist()

Return the underlying artist that actually defines some properties (e.g., color) of this artist.

get_tick_direction()

get_tick_out()

[Deprecated] Return whether ticks are drawn inside or outside the axes.

Notes

Deprecated since version 3.11: Use get_tick_direction instead.

get_ticksize()

Return length of the ticks in points.

property locs_angles_labels

[Deprecated]

Notes

Deprecated since version 3.11:

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, dash_capstyle=<UNSET>, dash_joinstyle=<UNSET>, dashes=<UNSET>, data=<UNSET>, drawstyle=<UNSET>, fillstyle=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, locs_angles=<UNSET>, marker=<UNSET>, markeredgecolor=<UNSET>, markeredgewidth=<UNSET>, markerfacecolor=<UNSET>, markerfacecoloralt=<UNSET>, markersize=<UNSET>, markevery=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, solid_capstyle=<UNSET>, solid_joinstyle=<UNSET>, tick_direction=<UNSET>, tick_out=<UNSET>, ticksize=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xdata=<UNSET>, ydata=<UNSET>, zorder=<UNSET>)

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties are

Property	Description
agg_filter	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
alpha	float or None
animated	bool
antialiased or aa	bool
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color or c	unknown
dash_capstyle	CapStyle or {'butt', 'projecting', 'round'}
dash_joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
dashes	sequence of floats (on/off ink in points) or (None, None)
data	(2, N) array or two 1D arrays
drawstyle or ds	{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
figure	Figure or SubFigure
fillstyle	{'full', 'left', 'right', 'bottom', 'top', 'none'}
gapcolor	color or None
gid	str
in_layout	bool
label	object
linestyle or ls	{'-', '--', '-.', ':', '', ...} or (offset, on-off-seq)
linewidth or lw	float
locs_angles	unknown
marker	marker style string, Path or MarkerStyle
markeredgecolor or mec	color
markeredgewidth or mew	float
markerfacecolor or mfc	color
markerfacecoloralt or mfcalt	color
markersize or ms	float
markevery	None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
mouseover	bool
path_effects	list of AbstractPathEffect
picker	float or callable[[Artist, Event], tuple[bool, dict]]
pickradius	float
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
solid_capstyle	CapStyle or {'butt', 'projecting', 'round'}
solid_joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
tick_direction	unknown
tick_out	unknown
ticksize	unknown
transform	Transform
url	str
visible	bool
xdata	1D array
ydata	1D array
zorder	float

set_color(color)

Set the color of the line.

Parameters:

colorcolor

set_locs_angles(locs_angles)

set_tick_direction(direction)

set_tick_out(b)

Set whether ticks are drawn inside or outside the axes.

set_ticksize(ticksize)

Set length of the ticks in points.