matplotlib.pyplot.rgrids#

matplotlib.pyplot.rgrids(radii=None,labels=None,angle=None,fmt=None,**kwargs)[source]#

Get or set the radial gridlines on the current polar plot.

Call signatures:

lines,labels=rgrids()lines,labels=rgrids(radii,labels=None,angle=22.5,fmt=None,**kwargs)

When called with no arguments,rgrids simply returns the tuple(lines,labels). When called with arguments, the labels willappear at the specified radial distances and angle.

Parameters:

radiituple with floats

The radii for the radial gridlines

labelstuple with strings or None

The labels to use at each radial gridline. Thematplotlib.ticker.ScalarFormatter will be used if None.

anglefloat

The angular position of the radius labels in degrees.

fmtstr or None

Format string used inmatplotlib.ticker.FormatStrFormatter.For example '%f'.

Returns:

lineslist oflines.Line2D

The radial gridlines.

labelslist oftext.Text

The tick labels.

Other Parameters:

**kwargs

kwargs are optionalText properties for the labels.

See also

pyplot.thetagrids

projections.polar.PolarAxes.set_rgrids

Axis.get_gridlines

Axis.get_ticklabels

Examples

# set the locations of the radial gridlineslines,labels=rgrids((0.25,0.5,1.0))# set the locations and labels of the radial gridlineslines,labels=rgrids((0.25,0.5,1.0),('Tom','Dick','Harry'))