Section Navigation

matplotlib.pyplot.grid#

matplotlib.pyplot.grid(visible=None, which='major', axis='both', **kwargs)[source]#

Configure the grid lines.

Parameters:

visiblebool or None, optional

Whether to show the grid lines. If any kwargs are supplied, it is assumed you want the grid on and visible will be set to True.

If visible is None and there are no kwargs, this toggles the visibility of the lines.

which{'major', 'minor', 'both'}, optional

The grid lines to apply the changes on.

axis{'both', 'x', 'y'}, optional

The axis to apply the changes on.

**kwargsLine2D properties

Define the line properties of the grid, e.g.:

grid(color='r', linestyle='-', linewidth=2)

Valid keyword arguments 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`	color
`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
`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'}
`transform`	unknown
`url`	str
`visible`	bool
`xdata`	1D array
`ydata`	1D array
`zorder`	float

Notes

Note

This is the pyplot wrapper for axes.Axes.grid.

The axis is drawn as a unit, so the effective zorder for drawing the grid is determined by the zorder of each axis, not by the zorder of the Line2D objects comprising the grid. Therefore, to set grid zorder, use set_axisbelow or, for more control, call the set_zorder method of each axis.