matplotlib.axes.Axes.grid¶
-
Axes.grid(self, b=None, which='major', axis='both', **kwargs)¶ Configure the grid lines.
Parameters: - bbool or None, optional
Whether to show the grid lines. If any kwargs are supplied, it is assumed you want the grid on and b will be set to True.
If b 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.
- **kwargs
Line2Dproperties Define the line properties of the grid, e.g.:
grid(color='r', linestyle='-', linewidth=2)
Valid keyword arguments are:
Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None animatedbool antialiasedor aabool clip_boxBboxclip_onbool clip_pathPatch or (Path, Transform) or None coloror ccolor containsunknown dash_capstyle{'butt', 'round', 'projecting'} dash_joinstyle{'miter', 'round', 'bevel'} dashessequence of floats (on/off ink in points) or (None, None) data(2, N) array or two 1D arrays drawstyleor ds{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default' figureFigurefillstyle{'full', 'left', 'right', 'bottom', 'top', 'none'} gidstr in_layoutbool labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat markermarker style string, PathorMarkerStylemarkeredgecoloror meccolor markeredgewidthor mewfloat markerfacecoloror mfccolor markerfacecoloraltor mfcaltcolor markersizeor msfloat markeveryNone or int or (int, int) or slice or List[int] or float or (float, float) or List[bool] path_effectsAbstractPathEffectpickerunknown pickradiusfloat rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None solid_capstyle{'butt', 'round', 'projecting'} solid_joinstyle{'miter', 'round', 'bevel'} transformmatplotlib.transforms.Transformurlstr visiblebool xdata1D array ydata1D array zorderfloat
Notes
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
Line2Dobjects comprising the grid. Therefore, to set grid zorder, useset_axisbelowor, for more control, call theset_zordermethod of each axis.