matplotlib ---------- +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.axes.Axes` object | | - :class:`matplotlib.axes.Axes` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of float, optional, default: (0, 0) | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`float`, optional, default: (0, 0) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - "expand" or None | | - "expand" or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - "horizontal" or "vertical" | | - "horizontal" or "vertical" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (# of dimensions, # of points)-array | | - (# :xref_param_type:`of` :xref_param_type:`dimensions`, # :xref_param_type:`of` :xref_param_type:`points`)-array | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (# of points,)-array | | - (# :xref_param_type:`of` points,)-array | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., 3) array-like | | - (..., 3) :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., 3) ndarray | | - (..., 3) :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (matplotlib.axes.AxesSubplot) | | - (:xref_param_type:`matplotlib.axes.AxesSubplot`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (n, ) array_like or None, optional | | - (:xref_param_type:`n`, ) :term:`numpy:array_like` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (n,) array or sequence of (n,) arrays | | - (n,) :xref_param_type:`array ` or :term:`python:sequence` :xref_param_type:`of` (n,) :xref_param_type:`arrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (subset, all), optional, default: (1, 0.4) | | - (:xref_param_type:`subset`, :xref_param_type:`all`), optional, default: (1, 0.4) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (tuple) | | - (:xref_param_type:`tuple`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 0-D or 1-D array or sequence | | - 0-D or 1-D :xref_param_type:`array ` or :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array | | - 1-D :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array or sequence | | - 1-D :xref_param_type:`array ` or :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-d array | | - 1-d :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D array or sequence | | - 1D :xref_param_type:`array ` or :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D array-like object | | - 1D :term:`array-like` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D or 2D array or sequence | | - 1D or 2D :xref_param_type:`array ` or :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D or 2D array-like object | | - 1D or 2D :term:`array-like` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array of length: *refi_tri* node count. | | - 1d :xref_param_type:`array ` :xref_param_type:`of` length: *refi_tri* :xref_param_type:`node` count. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d boolean array or None | | - 1d :xref_param_type:`boolean ` :xref_param_type:`array ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d integer array | | - 1d :xref_param_type:`integer ` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d-array-like of length ``n_points`` | | - 1d-array-like :xref_param_type:`of` :xref_param_type:`length` ``n_points`` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 3D np.array of bool | | - 3D :xref_param_type:`np.array` :xref_param_type:`of` :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 4-tuple or 3 tuple | | - 4-tuple or 3 :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`FigureCanvasBase` | | - :class:`FigureCanvasBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`KeyEvent` | | - :class:`KeyEvent` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`MovieWriter` or str, optional | | - :class:`MovieWriter` or :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`NavigationToolbar2` | | - :class:`NavigationToolbar2` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`datetime` or sequence of :class:`datetime` | | - :class:`datetime` or :term:`python:sequence` :xref_param_type:`of` :class:`datetime` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.artist.Artist` or similar | | - :class:`matplotlib.artist.Artist` or :xref_param_type:`similar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.axes.Axes` | | - :class:`matplotlib.axes.Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.backend_bases.RendererBase` instance | | - :class:`matplotlib.backend_bases.RendererBase` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.colors.Normalize` instance | | - :class:`matplotlib.colors.Normalize` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.figure.Figure` | | - :class:`matplotlib.figure.Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.figure.Figure` object | | - :class:`matplotlib.figure.Figure` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.legend.Legend` instance | | - :class:`matplotlib.legend.Legend` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.offsetbox.OffsetBox` instance | | - :class:`matplotlib.offsetbox.OffsetBox` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`matplotlib.transforms.BboxBase` instance or tuple of floats | | - :class:`matplotlib.transforms.BboxBase` :xref_param_type:`instance` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.axes.Axes` | | - :class:`~matplotlib.axes.Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.figure.Figure` or int, optional | | - :class:`~matplotlib.figure.Figure` or :xref_param_type:`int`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.lines.Line2D` instance | | - :class:`~matplotlib.lines.Line2D` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.text.Text` | | - :class:`~matplotlib.text.Text` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.tri.TriFinder` object, optional | | - :class:`~matplotlib.tri.TriFinder` :xref_param_type:`object`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.tri.TriInterpolator`, optional | | - :class:`~matplotlib.tri.TriInterpolator`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.tri.Triangulation` | | - :class:`~matplotlib.tri.Triangulation` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :class:`~matplotlib.tri.Triangulation` object | | - :class:`~matplotlib.tri.Triangulation` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - :mod:`~mpl_toolkits.axes_grid.axes_size` or float or string | | - :mod:`~mpl_toolkits.axes_grid.axes_size` or :xref_param_type:`float` or :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Array or a sequence of vectors. | | - :xref_param_type:`Array` or :xref_param_type:`a` :term:`python:sequence` :xref_param_type:`of` vectors. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Axes | | - :xref_param_type:`Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Axes object or array of Axes objects. | | - :xref_param_type:`Axes` :xref_param_type:`object` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`Axes` objects. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - AxesDivider | | - :xref_param_type:`AxesDivider` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Bbox | | - :xref_param_type:`Bbox` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Bool | | - :xref_param_type:`Bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Cycler | | - :xref_param_type:`Cycler` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Dict[str, str], optional | | - :xref_param_type:`Dict`\[:xref_param_type:`str`, :xref_param_type:`str`], optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Event | | - :xref_param_type:`Event` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - FancyArrow | | - :xref_param_type:`FancyArrow` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Figure | | - :xref_param_type:`Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Int | | - :xref_param_type:`Int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None (default), string, or function, optional | | - :xref_param_type:`None` (default), :xref_param_type:`string `, :xref_param_type:`or` :xref_param_type:`function`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or "inherit" or a color spec | | - :xref_param_type:`None` or "inherit" or :xref_param_type:`a` :xref_param_type:`color` :xref_param_type:`spec` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or :class:`matplotlib.font_manager.FontProperties` or dict | | - :xref_param_type:`None` or :class:`matplotlib.font_manager.FontProperties` or :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or :class:`matplotlib.transforms.Transform` | | - :xref_param_type:`None` or :class:`matplotlib.transforms.Transform` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or :class:`~matplotlib.transforms.Transform` instance | | - :xref_param_type:`None` or :class:`~matplotlib.transforms.Transform` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or FontProperties or dict | | - :xref_param_type:`None` or :xref_param_type:`FontProperties` or :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or bool | | - :xref_param_type:`None` or :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or bool, optional | | - :xref_param_type:`None` or :xref_param_type:`bool`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float | | - :xref_param_type:`None` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float, optional, default: None | | - :xref_param_type:`None` or :xref_param_type:`float`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or int | | - :xref_param_type:`None` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or int or float | | - :xref_param_type:`None` or :xref_param_type:`int` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or iterable | | - :xref_param_type:`None` or :term:`python:iterable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or scalar | | - :xref_param_type:`None` or :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or sequence, optional | | - :xref_param_type:`None` or :term:`python:sequence`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, ('minor', 'major', 'both') | | - :xref_param_type:`None`, ('minor', 'major', 'both') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, ArrowStyle, str, optional (default: None) | | - :xref_param_type:`None`, :xref_param_type:`ArrowStyle`, :xref_param_type:`str`, optional (default: :xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, ConnectionStyle instance, or string | | - :xref_param_type:`None`, :xref_param_type:`ConnectionStyle` :xref_param_type:`instance`, :xref_param_type:`or` :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, Path (default: None) | | - :xref_param_type:`None`, :xref_param_type:`Path` (default: :xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, scalar, optional (default: None) | | - :xref_param_type:`None`, :xref_param_type:`scalar`, optional (default: :xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, string, or sequence of float, optional, default (1.0,) | | - :xref_param_type:`None`, :xref_param_type:`string `, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`float`, optional, default (1.0,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Normalize, optional | | - :xref_param_type:`Normalize`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Object | | - :xref_param_type:`Object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Patch | | - :xref_param_type:`Patch` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Poly3DCollection | | - :xref_param_type:`Poly3DCollection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - RendererBase instance | | - :xref_param_type:`RendererBase` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Slider, optional, default: None | | - :xref_param_type:`Slider`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - String | | - :xref_param_type:`String` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Tfm | | - :xref_param_type:`Tfm` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Vf | | - :xref_param_type:`Vf` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ 'default' | 'constant' | 'mean' | 'linear' | 'none'] or function | | - [ 'default' | 'constant' | 'mean' | 'linear' | 'none'] :xref_param_type:`or` :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ 'default' | 'linear' | 'dB' ] | | - [ 'default' | 'linear' | 'dB' ] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ 'default' | 'psd' | 'magnitude' | 'angle' | 'phase' ] | | - [ 'default' | 'psd' | 'magnitude' | 'angle' | 'phase' ] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ 'pre' | 'post' | 'mid' ] | | - [ 'pre' | 'post' | 'mid' ] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ 'upper' | 'lower' ] | | - [ 'upper' | 'lower' ] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [ *None* | timezone string | :class:`tzinfo` instance] | | - [ *None* | :xref_param_type:`timezone` :xref_param_type:`string ` | :class:`tzinfo` :xref_param_type:`instance`] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ["upper", "lower"], optional, default: "upper" | | - ["upper", "lower"], optional, default: "upper" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ['aitoff' | 'hammer' | 'lambert' | 'mollweide', 'polar' | 'rectilinear'], optional | | - ['aitoff' | 'hammer' | 'lambert' | 'mollweide', 'polar' | 'rectilinear'], optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ['auto' | 'equal' | scalar], optional, default: "equal" | | - ['auto' | 'equal' | :xref_param_type:`scalar`], optional, default: "equal" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ['auto' | 'equal' | scalar], optional, default: None | | - ['auto' | 'equal' | :xref_param_type:`scalar`], optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional | | - ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ['upper' | 'lower'], optional, default: None | | - ['upper' | 'lower'], optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - [None | (xmin, xmax)] | | - [:xref_param_type:`None` | (:xref_param_type:`xmin`, :xref_param_type:`xmax`)] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `Artist`, `BboxBase`, or `Transform` | | - `Artist`, `BboxBase`, :xref_param_type:`or` `Transform` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `Axes` | | - `Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `GraphicsContextBase` | | - `GraphicsContextBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `RendererBase` | | - `RendererBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `Transform` | | - `Transform` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ``0 <= scalar <= 1`` or ``None``, optional | | - ``0 <= scalar <= 1`` or ``None``, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `axes_class` | | - `axes_class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `barCollection` | | - `barCollection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.axes.Axes` | | - `matplotlib.axes.Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.axes.Axes` type, optional | | - `matplotlib.axes.Axes` :xref_param_type:`type`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.backend_bases.RendererBase` | | - `matplotlib.backend_bases.RendererBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.collections.Collection` | | - `matplotlib.collections.Collection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.colors.Normalize`, optional, default: None | | - `matplotlib.colors.Normalize`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.figure.Figure` | | - `matplotlib.figure.Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.font_manager.FontProperties` | | - `matplotlib.font_manager.FontProperties` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.font_manager.FontProperties`, optional | | - `matplotlib.font_manager.FontProperties`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.offsetbox.AuxTransformBox` | | - `matplotlib.offsetbox.AuxTransformBox` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.offsetbox.DrawingArea` | | - `matplotlib.offsetbox.DrawingArea` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.offsetbox.TextArea` | | - `matplotlib.offsetbox.TextArea` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.patches.Ellipse` | | - `matplotlib.patches.Ellipse` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.patches.Patch` | | - `matplotlib.patches.Patch` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.path.Path` | | - `matplotlib.path.Path` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.text.Text` | | - `matplotlib.text.Text` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.transforms.Affine2DBase` | | - `matplotlib.transforms.Affine2DBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.transforms.Bbox` | | - `matplotlib.transforms.Bbox` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.transforms.Transform` | | - `matplotlib.transforms.Transform` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `matplotlib.transforms.Transform`, optional | | - `matplotlib.transforms.Transform`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.collections.LineCollection` | | - `~matplotlib.collections.LineCollection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.collections.PathCollection` | | - `~matplotlib.collections.PathCollection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.colors.Colormap` instance | | - `~matplotlib.colors.Colormap` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.colors.Colormap`, optional, default: None | | - `~matplotlib.colors.Colormap`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.colors.Normalize` instance, optional | | - `~matplotlib.colors.Normalize` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.colors.Normalize`, optional, default: None | | - `~matplotlib.colors.Normalize`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.font_manager.FontProperties`, optional | | - `~matplotlib.font_manager.FontProperties`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.image.AxesImage` | | - `~matplotlib.image.AxesImage` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.lines.Line2D` prop, optional, default: None | | - `~matplotlib.lines.Line2D` :xref_param_type:`prop`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.markers.MarkerStyle`, optional, default: 'o' | | - `~matplotlib.markers.MarkerStyle`, optional, default: 'o' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.patches.Polygon` | | - `~matplotlib.patches.Polygon` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `~matplotlib.transforms.Bbox` | | - `~matplotlib.transforms.Bbox` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a :class:`~matplotlib.lines.Line2D` instance | | - :xref_param_type:`a` :class:`~matplotlib.lines.Line2D` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a variable length argument | | - :xref_param_type:`a` :xref_param_type:`variable` :xref_param_type:`length` :xref_param_type:`argument` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - angle in degrees | | - :xref_param_type:`angle` :xref_param_type:`in` :xref_param_type:`degrees` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any matplotlib color | | - :xref_param_type:`any` :xref_param_type:`matplotlib` :xref_param_type:`color` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any object | | - :xref_param_type:`any` :xref_param_type:`object` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array | | - :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array like of dim 2 (shape: (nx,3)) | | - :xref_param_type:`array ` :xref_param_type:`like` :xref_param_type:`of` :xref_param_type:`dim` 2 (shape: (nx,3)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array like of dim 3 (shape: (nx,3,2)) | | - :xref_param_type:`array ` :xref_param_type:`like` :xref_param_type:`of` :xref_param_type:`dim` 3 (shape: (nx,3,2)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of dim 2 (shape (nx,3)) | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`dim` 2 (:xref_param_type:`shape` (nx,3)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of dim 3 (shape (nx,2,2)) | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`dim` 3 (:xref_param_type:`shape` (nx,2,2)) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or list of arrays | | - :xref_param_type:`array ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`arrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or masked array, optional, default is *None* | | - :xref_param_type:`array ` or :xref_param_type:`masked` :xref_param_type:`array `, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or sequence | | - :xref_param_type:`array ` or :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, mpl image, Pillow Image | | - :xref_param_type:`array `, :xref_param_type:`mpl` :xref_param_type:`image`, :xref_param_type:`Pillow` :xref_param_type:`Image` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, optional | | - :xref_param_type:`array `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like | | - :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like of booleans | | - :term:`array-like` :xref_param_type:`of` :xref_param_type:`booleans` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like of integers | | - :term:`array-like` :xref_param_type:`of` :xref_param_type:`integers ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, default = 0.5 | | - :term:`array-like`, default = 0.5 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, default = None | | - :term:`array-like`, default = :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, default = [1, 2, ..., n] | | - :term:`array-like`, default = [1, 2, ..., :xref_param_type:`n`] | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional | | - :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional, default: None | | - :term:`array-like`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like | | - :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of colors, optional, default: 'k' | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`colors`, optional, default: 'k' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of shape (npoints,) | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`shape` (npoints,) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like shape (n, m) | | - :term:`numpy:array_like` :xref_param_type:`shape` (:xref_param_type:`n`, :xref_param_type:`m`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like shape(2, 2), optional, default: None | | - :term:`numpy:array_like` :xref_param_type:`shape`\(2, 2), optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, optional | | - :term:`numpy:array_like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, scalar, or None | | - :term:`numpy:array_like`, :xref_param_type:`scalar`, :xref_param_type:`or` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (n, ), optional, default: None | | - :term:`numpy:array_like`, :xref_param_type:`shape` (:xref_param_type:`n`, ), optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (n, m) or (n, m, 3) or (n, m, 4) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (:xref_param_type:`n`, :xref_param_type:`m`) :xref_param_type:`or` (:xref_param_type:`n`, :xref_param_type:`m`, 3) :xref_param_type:`or` (:xref_param_type:`n`, :xref_param_type:`m`, 4) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (npts,2) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (npts,2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape=(3, 2) | | - :term:`numpy:array_like`, shape=(3, 2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape=(3, 4) | | - :term:`numpy:array_like`, shape=(3, 4) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape=(N, 3, 2) | | - :term:`numpy:array_like`, shape=(:xref_param_type:`N`, 3, 2) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape=(N, 3, 4) | | - :term:`numpy:array_like`, shape=(:xref_param_type:`N`, 3, 4) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape=(N, M, 4), dtype=np.uint8 | | - :term:`numpy:array_like`, shape=(:xref_param_type:`N`, :xref_param_type:`M`, 4), dtype=np.uint8 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool | | - :xref_param_type:`bool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or None | | - :xref_param_type:`bool` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or None, optional | | - :xref_param_type:`bool` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default = False | | - :xref_param_type:`bool`, default = :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default = True | | - :xref_param_type:`bool`, default = :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default = True. | | - :xref_param_type:`bool`, default = True. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default is False | | - :xref_param_type:`bool`, default :xref_param_type:`is` :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default: False | | - :xref_param_type:`bool`, default: :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default: True | | - :xref_param_type:`bool`, default: :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional | | - :xref_param_type:`bool`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional (False) | | - :xref_param_type:`bool`, optional (:xref_param_type:`False`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional (True) | | - :xref_param_type:`bool`, optional (:xref_param_type:`True`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional (default = True) | | - :xref_param_type:`bool`, optional (default = :xref_param_type:`True`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional, default is *False* | | - :xref_param_type:`bool`, optional, default :xref_param_type:`is` *False* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional, default: False | | - :xref_param_type:`bool`, optional, default: :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional, default: True | | - :xref_param_type:`bool`, optional, default: :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean | | - :xref_param_type:`boolean ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean array_like of shape (ntri), optional | | - :xref_param_type:`boolean ` :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`shape` (:xref_param_type:`ntri`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional | | - :xref_param_type:`boolean `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional, *deprecated*, default: True | | - :xref_param_type:`boolean `, optional, *deprecated*, default: :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional, default: False | | - :xref_param_type:`boolean `, optional, default: :xref_param_type:`False` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional, default: True | | - :xref_param_type:`boolean `, optional, default: :xref_param_type:`True` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bytes | | - :xref_param_type:`bytes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable | | - :xref_param_type:`callable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable, optional | | - :xref_param_type:`callable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable, optional, default: `mlab.detrend_none` | | - :xref_param_type:`callable`, optional, default: `mlab.detrend_none` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class derived from matplotlib.figure.Figure | | - :term:`python:class` :xref_param_type:`derived` :xref_param_type:`from` :xref_param_type:`matplotlib.figure.Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class_like, i.e. str or type | | - :xref_param_type:`class_like`, i.e. :xref_param_type:`str` or :xref_param_type:`type` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color | | - :xref_param_type:`color` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color or array_like of colors or None, optional | | - :xref_param_type:`color` or :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`colors` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color or sequence of color, optional, default: None | | - :xref_param_type:`color` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`color`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color spec or None, optional | | - :xref_param_type:`color` :xref_param_type:`spec` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color, sequence of colors or None, optional, default: None | | - :xref_param_type:`color`, :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`colors` or :xref_param_type:`None`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - color, sequence, or sequence of color, optional, default: 'b' | | - :xref_param_type:`color`, :term:`python:sequence`, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`color`, optional, default: 'b' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime instance, optional | | - :xref_param_type:`datetime` :xref_param_type:`instance`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict | | - :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None | | - :xref_param_type:`dict` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None (default) | | - :xref_param_type:`dict` or :xref_param_type:`None` (default) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, default is None | | - :xref_param_type:`dict`, default :xref_param_type:`is` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, default: {} | | - :xref_param_type:`dict`, default: {} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional | | - :xref_param_type:`dict`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional (None) | | - :xref_param_type:`dict`, optional (:xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional, default: None | | - :xref_param_type:`dict`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary, optional | | - :xref_param_type:`dictionary `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary, optional, default: None | | - :xref_param_type:`dictionary `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file handle | | - :xref_param_type:`file` :xref_param_type:`handle` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float | | - :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or None | | - :xref_param_type:`float` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or int | | - :xref_param_type:`float` or :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or sequence of floats | | - :xref_param_type:`float` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or str | | - :xref_param_type:`float` or :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, None | | - :xref_param_type:`float`, :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, default is None | | - :xref_param_type:`float`, default :xref_param_type:`is` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional | | - :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : 0.2 | | - :xref_param_type:`float`, optional, default : 0.2 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : 0.3 | | - :xref_param_type:`float`, optional, default : 0.3 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : 0.4 | | - :xref_param_type:`float`, optional, default : 0.4 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : 0.5 | | - :xref_param_type:`float`, optional, default : 0.5 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : 1.0 | | - :xref_param_type:`float`, optional, default : 1.0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default : None | | - :xref_param_type:`float`, optional, default : :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 0 | | - :xref_param_type:`float`, optional, default: 0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 0.5 | | - :xref_param_type:`float`, optional, default: 0.5 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 0.6 | | - :xref_param_type:`float`, optional, default: 0.6 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 1 | | - :xref_param_type:`float`, optional, default: 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 1.1 | | - :xref_param_type:`float`, optional, default: 1.1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: 10. | | - :xref_param_type:`float`, optional, default: 10. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional, default: None | | - :xref_param_type:`float`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, sequence of floats | | - :xref_param_type:`float`, :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, sequence, or string (default = 1.5) | | - :xref_param_type:`float`, :term:`python:sequence`, :xref_param_type:`or` :xref_param_type:`string ` (default = 1.5) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, string, or sequence (default = 1.5) | | - :xref_param_type:`float`, :xref_param_type:`string `, :xref_param_type:`or` :term:`python:sequence` (default = 1.5) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - func(min, max), min/max are floats | | - :xref_param_type:`func`\(:xref_param_type:`min`, :xref_param_type:`max`), min/max :xref_param_type:`are` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - func(min, max), min/max are floats, default is None | | - :xref_param_type:`func`\(:xref_param_type:`min`, :xref_param_type:`max`), min/max :xref_param_type:`are` :xref_param_type:`floats `, default :xref_param_type:`is` :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function | | - :xref_param_type:`function` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function or array. | | - :xref_param_type:`function` or array. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if the dimensionality of the input points is different | | - :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`dimensionality` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`input` :xref_param_type:`points` :xref_param_type:`is` :xref_param_type:`different` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - image, offset_x, offset_y | | - :xref_param_type:`image`, :xref_param_type:`offset_x`, :xref_param_type:`offset_y` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - imshow kwargs | | - :xref_param_type:`imshow` :xref_param_type:`kwargs` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int | | - :xref_param_type:`int` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default: None) | | - :xref_param_type:`int` (default: :xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (optional) | | - :xref_param_type:`int` (optional) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int > 0, optional, default is *None* | | - :xref_param_type:`int` > 0, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or (int, int), optional, default is 100 | | - :xref_param_type:`int` :xref_param_type:`or` (:xref_param_type:`int`, :xref_param_type:`int`), optional, default :xref_param_type:`is` 100 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or float | | - :xref_param_type:`int` or :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} | | - :xref_param_type:`int` or :xref_param_type:`float` :xref_param_type:`or` {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or float, optional | | - :xref_param_type:`int` or :xref_param_type:`float`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list of ints | | - :xref_param_type:`int` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ints ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string or pair of floats, default: 'upper right' | | - :xref_param_type:`int` or :xref_param_type:`string ` or :xref_param_type:`pair` :xref_param_type:`of` :xref_param_type:`floats `, default: 'upper right' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string, optional, default to 1 | | - :xref_param_type:`int` or :xref_param_type:`string `, optional, default :xref_param_type:`to` 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, one of (1, 2, 3), optional, default: 1 (left click) | | - :xref_param_type:`int`, :xref_param_type:`one` :xref_param_type:`of` (1, 2, 3), optional, default: 1 (:xref_param_type:`left` :xref_param_type:`click`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, one of (1, 2, 3), optional, default: 2 (middle click) | | - :xref_param_type:`int`, :xref_param_type:`one` :xref_param_type:`of` (1, 2, 3), optional, default: 2 (:xref_param_type:`middle` :xref_param_type:`click`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, one of (1, 2, 3), optional, default: 3 (right click) | | - :xref_param_type:`int`, :xref_param_type:`one` :xref_param_type:`of` (1, 2, 3), optional, default: 3 (:xref_param_type:`right` :xref_param_type:`click`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional | | - :xref_param_type:`int`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional, default: 1 | | - :xref_param_type:`int`, optional, default: 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer | | - :xref_param_type:`integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer array | | - :xref_param_type:`integer ` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer array_like of shape (ntri, 3), optional | | - :xref_param_type:`integer ` :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`shape` (:xref_param_type:`ntri`, 3), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer array_like, optional | | - :xref_param_type:`integer ` :term:`numpy:array_like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or array_like or 'auto', optional | | - :xref_param_type:`integer ` or :term:`numpy:array_like` or 'auto', optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or string, optional, default: none | | - :xref_param_type:`integer ` or :xref_param_type:`string `, optional, default: :xref_param_type:`none` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional | | - :xref_param_type:`integer `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional, default: 10 | | - :xref_param_type:`integer `, optional, default: 10 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional, default: None | | - :xref_param_type:`integer `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - is a (N x 1 x 9) arrays (arrays of row-matrices) of computed | | - :xref_param_type:`is` :xref_param_type:`a` (:xref_param_type:`N` :xref_param_type:`x` 1 :xref_param_type:`x` 9) :xref_param_type:`arrays` (:xref_param_type:`arrays` :xref_param_type:`of` row-matrices) :xref_param_type:`of` :xref_param_type:`computed` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - is a (N x 3 x 1) array (array of column-matrices) of | | - :xref_param_type:`is` :xref_param_type:`a` (:xref_param_type:`N` :xref_param_type:`x` 3 :xref_param_type:`x` 1) :xref_param_type:`array ` (:xref_param_type:`array ` :xref_param_type:`of` column-matrices) :xref_param_type:`of` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - is a (N x 3 x 1) array (array of column-matrices) of triangle | | - :xref_param_type:`is` :xref_param_type:`a` (:xref_param_type:`N` :xref_param_type:`x` 3 :xref_param_type:`x` 1) :xref_param_type:`array ` (:xref_param_type:`array ` :xref_param_type:`of` column-matrices) :xref_param_type:`of` :xref_param_type:`triangle` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable | | - :term:`python:iterable` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of :class:`AbstractPathEffect` | | - :term:`python:iterable` :xref_param_type:`of` :class:`AbstractPathEffect` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of floats | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of four floats | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`four` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, int, generator function, or None, optional | | - :term:`python:iterable`, :xref_param_type:`int`, :xref_param_type:`generator` :xref_param_type:`function`, :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, optional | | - :term:`python:iterable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keys to associate with the Tool | | - :xref_param_type:`keys` :xref_param_type:`to` :xref_param_type:`associate` :xref_param_type:`with` :xref_param_type:`the` :xref_param_type:`Tool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - length 2 sequence | | - :xref_param_type:`length` 2 :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list | | - :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of :class:`~matplotlib.collections.LineCollection` | | - :xref_param_type:`list` :xref_param_type:`of` :class:`~matplotlib.collections.LineCollection` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of :class:`~matplotlib.lines.Line2D` instances | | - :xref_param_type:`list` :xref_param_type:`of` :class:`~matplotlib.lines.Line2D` :xref_param_type:`instances` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of :mod:`~mpl_toolkits.axes_grid.axes_size` | | - :xref_param_type:`list` :xref_param_type:`of` :mod:`~mpl_toolkits.axes_grid.axes_size` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Images | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Images` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of `~matplotlib.artist.Artist`, optional | | - :xref_param_type:`list` :xref_param_type:`of` `~matplotlib.artist.Artist`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of arrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`arrays` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of dict | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dict` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of dicts | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dicts` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of float or {'on', 'off', 'equal', 'tight', 'scaled', 'normal', 'auto', 'image', 'square'} | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`float` :xref_param_type:`or` {'on', 'off', 'equal', 'tight', 'scaled', 'normal', 'auto', 'image', 'square'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of floats | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of keys associated with the Tool | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`keys` :xref_param_type:`associated` :xref_param_type:`with` :xref_param_type:`the` :xref_param_type:`Tool` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings or callable, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` or :xref_param_type:`callable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings, optional, default: None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuples | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuples (etype, dict()) | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` (:xref_param_type:`etype`, :xref_param_type:`dict`\()) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of vertices (xdata, ydata) | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`vertices` (:xref_param_type:`xdata`, :xref_param_type:`ydata`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or list of lists | | - :xref_param_type:`list` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`lists` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, optional | | - :xref_param_type:`list`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, optional, default: None | | - :xref_param_type:`list`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - masked array | | - :xref_param_type:`masked` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.axes.Axes | | - :xref_param_type:`matplotlib.axes.Axes` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.colors.Colormap, optional | | - :xref_param_type:`matplotlib.colors.Colormap`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.container.BarContainer | | - :xref_param_type:`matplotlib.container.BarContainer` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.figure.Figure | | - :xref_param_type:`matplotlib.figure.Figure` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.image.AxesImage | | - :xref_param_type:`matplotlib.image.AxesImage` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.patches.Polygon | | - :xref_param_type:`matplotlib.patches.Polygon` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - module | | - :xref_param_type:`module` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - module string or canvas class | | - :xref_param_type:`module` :xref_param_type:`string ` or :xref_param_type:`canvas` :term:`python:class` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - mpl color, optional, default: None | | - :xref_param_type:`mpl` :xref_param_type:`color`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - name | | - :xref_param_type:`name` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray | | - :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or None | | - :xref_param_type:`ndarray ` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray | | - :xref_param_type:`np.ndarray` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number | | - :xref_param_type:`number` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number, optional | | - :xref_param_type:`number`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy array | | - :xref_param_type:`numpy` :xref_param_type:`array ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy array or iterable of pairs | | - :xref_param_type:`numpy` :xref_param_type:`array ` or :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`pairs` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, optional | | - :xref_param_type:`object`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, optional, default is *None* | | - :xref_param_type:`object`, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pair of floats | | - :xref_param_type:`pair` :xref_param_type:`of` :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - plot format string, optional, default: None | | - :xref_param_type:`plot` :xref_param_type:`format` :xref_param_type:`string `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - positive integer, optional, default:1 | | - :xref_param_type:`positive` :xref_param_type:`integer `, optional, default:1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar | | - :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar > 1 | | - :xref_param_type:`scalar` > 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar between 0 and 1, optional, default is *None* | | - :xref_param_type:`scalar` :xref_param_type:`between` 0 :xref_param_type:`and` 1, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or 1D array_like | | - :xref_param_type:`scalar` or 1D :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or None, optional | | - :xref_param_type:`scalar` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or None, optional, default: None | | - :xref_param_type:`scalar` or :xref_param_type:`None`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array-like | | - :xref_param_type:`scalar` or :term:`array-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array-like, optional | | - :xref_param_type:`scalar` or :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array-like, optional, default: None | | - :xref_param_type:`scalar` or :term:`array-like`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like | | - :xref_param_type:`scalar` or :term:`numpy:array_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like, optional, default: None | | - :xref_param_type:`scalar` or :term:`numpy:array_like`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like, shape (n, ), optional | | - :xref_param_type:`scalar` or :term:`numpy:array_like`, :xref_param_type:`shape` (:xref_param_type:`n`, ), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or sequence of scalar | | - :xref_param_type:`scalar` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or sequence of scalars | | - :xref_param_type:`scalar` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or sequence of scalars, optional, default: 1 | | - :xref_param_type:`scalar` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars`, optional, default: 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, default = None | | - :xref_param_type:`scalar`, default = :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, default = 100 | | - :xref_param_type:`scalar`, default = 100 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, ndarray | | - :xref_param_type:`scalar`, :xref_param_type:`ndarray ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional | | - :xref_param_type:`scalar`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional (None) | | - :xref_param_type:`scalar`, optional (:xref_param_type:`None`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional (default: 1) | | - :xref_param_type:`scalar`, optional (default: 1) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default is *None* | | - :xref_param_type:`scalar`, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default: 0 | | - :xref_param_type:`scalar`, optional, default: 0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default: 1 | | - :xref_param_type:`scalar`, optional, default: 1 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default: 30 | | - :xref_param_type:`scalar`, optional, default: 30 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default: 4.0 | | - :xref_param_type:`scalar`, optional, default: 4.0 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional, default: None | | - :xref_param_type:`scalar`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, scalar sequence or None, optional, default: None | | - :xref_param_type:`scalar`, :xref_param_type:`scalar` :term:`python:sequence` or :xref_param_type:`None`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalars (columns, rows), optional, default: None | | - :xref_param_type:`scalars` (:xref_param_type:`columns`, :xref_param_type:`rows`), optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalars (left, right, bottom, top), optional, default: None | | - :xref_param_type:`scalars` (:xref_param_type:`left`, :xref_param_type:`right`, :xref_param_type:`bottom`, :xref_param_type:`top`), optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence | | - :term:`python:sequence` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of (time, open, close, high, low, ...) sequences | | - :term:`python:sequence` :xref_param_type:`of` (:xref_param_type:`time`, :xref_param_type:`open`, :xref_param_type:`close`, :xref_param_type:`high`, :xref_param_type:`low`, ...) :xref_param_type:`sequences` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of (time, open, high, low, close, ...) sequences | | - :term:`python:sequence` :xref_param_type:`of` (:xref_param_type:`time`, :xref_param_type:`open`, :xref_param_type:`high`, :xref_param_type:`low`, :xref_param_type:`close`, ...) :xref_param_type:`sequences` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of (x, y), optional | | - :term:`python:sequence` :xref_param_type:`of` (:xref_param_type:`x`, :xref_param_type:`y`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of colors | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`colors` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of float | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of form (year, month, day), `datetime`, or `date` | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`form` (:xref_param_type:`year`, :xref_param_type:`month`, :xref_param_type:`day`), `datetime`, :xref_param_type:`or` `date` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of numbers | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`numbers` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of quote sequences | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`quote` :xref_param_type:`sequences` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of scalar | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalar` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of scalars | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of scalars of length n | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars` :xref_param_type:`of` :xref_param_type:`length` :xref_param_type:`n` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of scalars, optional, default: 0.8 | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars`, optional, default: 0.8 | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of valid color specifications, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`valid` :xref_param_type:`color` :xref_param_type:`specifications`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence, optional | | - :term:`python:sequence`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - single Axes object or array of Axes objects | | - :xref_param_type:`single` :xref_param_type:`Axes` :xref_param_type:`object` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`Axes` :xref_param_type:`objects` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sparse array (n, m) | | - :xref_param_type:`sparse ` :xref_param_type:`array ` (:xref_param_type:`n`, :xref_param_type:`m`) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str | | - :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str (default: " ") | | - :xref_param_type:`str` (default: " ") | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str (default: "") | | - :xref_param_type:`str` (default: "") | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or :class:`~matplotlib.colors.Colormap` instance | | - :xref_param_type:`str` or :class:`~matplotlib.colors.Colormap` :xref_param_type:`instance` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or ArrowStyle, optional (default: 'simple') | | - :xref_param_type:`str` or :xref_param_type:`ArrowStyle`, optional (default: 'simple') | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None | | - :xref_param_type:`str` or :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or `None` | | - :xref_param_type:`str` or `None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or `~matplotlib.transforms.Bbox`, optional | | - :xref_param_type:`str` or `~matplotlib.transforms.Bbox`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or file-like | | - :xref_param_type:`str` or :term:`file-like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or tuple or a sequence of such values, optional | | - :xref_param_type:`str` or :xref_param_type:`tuple` or :xref_param_type:`a` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`such` :xref_param_type:`values`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or tuple, optional, default: 'solid' | | - :xref_param_type:`str` or :xref_param_type:`tuple`, optional, default: 'solid' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, Artist, Transform, callable or tuple, optional | | - :xref_param_type:`str`, :xref_param_type:`Artist`, :xref_param_type:`Transform`, :xref_param_type:`callable` or :xref_param_type:`tuple`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, ConnectionStyle, or None, optional | | - :xref_param_type:`str`, :xref_param_type:`ConnectionStyle`, :xref_param_type:`or` :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, ToolBase | | - :xref_param_type:`str`, :xref_param_type:`ToolBase` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, `Artist`, `Transform`, callable or tuple, optional | | - :xref_param_type:`str`, `Artist`, `Transform`, :xref_param_type:`callable` or :xref_param_type:`tuple`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, dict, or list | | - :xref_param_type:`str`, :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`list` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional | | - :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional, default: "%1.2f" | | - :xref_param_type:`str`, optional, default: "%1.2f" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, scalar or callable, optional | | - :xref_param_type:`str`, :xref_param_type:`scalar` or :xref_param_type:`callable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string | | - :xref_param_type:`string ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string amongst known fillstyles | | - :xref_param_type:`string ` :xref_param_type:`amongst` :xref_param_type:`known` :xref_param_type:`fillstyles` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string key from {'nn', 'linear'} | | - :xref_param_type:`string ` :xref_param_type:`key` :xref_param_type:`from` {'nn', 'linear'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string key from {'z', 'dzdx', 'dzdy'} | | - :xref_param_type:`string ` :xref_param_type:`key` :xref_param_type:`from` {'z', 'dzdx', 'dzdy'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or None, optional | | - :xref_param_type:`string ` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or array-like, optional | | - :xref_param_type:`string ` or :term:`array-like`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or array-like, optional, default: None | | - :xref_param_type:`string ` or :term:`array-like`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or array_like, optional, default: None | | - :xref_param_type:`string ` or :term:`numpy:array_like`, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or bytestring | | - :xref_param_type:`string ` or :xref_param_type:`bytestring` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or integer | | - :xref_param_type:`string ` or :xref_param_type:`integer ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence of strings | | - :xref_param_type:`string ` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`strings ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional | | - :xref_param_type:`string `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, default: '' | | - :xref_param_type:`string `, optional, default: '' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, default: 'full' | | - :xref_param_type:`string `, optional, default: 'full' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, default: 'o' | | - :xref_param_type:`string `, optional, default: 'o' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, default: None | | - :xref_param_type:`string `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, {'mask', 'clip'} | | - :xref_param_type:`string `, optional, {'mask', 'clip'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - text properties | | - :xref_param_type:`text` :xref_param_type:`properties` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tool_like | | - :xref_param_type:`tool_like` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple | | - :xref_param_type:`tuple` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple (*numRows*, *numCols*, *plotNum*) | | - :xref_param_type:`tuple` (*numRows*, *numCols*, *plotNum*) | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of 2 scalars | | - :xref_param_type:`tuple` :xref_param_type:`of` 2 :xref_param_type:`scalars` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of 4 floats | | - :xref_param_type:`tuple` :xref_param_type:`of` 4 :xref_param_type:`floats ` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of 4 floats, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` 4 :xref_param_type:`floats `, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of array_likes (dzdx, dzdy), optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`array_likes` (:xref_param_type:`dzdx`, :xref_param_type:`dzdy`), optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of float | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`float` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of integers, optional, default: None | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`integers `, optional, default: :xref_param_type:`None` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of keys from {'z', 'dzdx', 'dzdy'} | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`keys` :xref_param_type:`from` {'z', 'dzdx', 'dzdy'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or None, optional | | - :xref_param_type:`tuple` or :xref_param_type:`None`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or `matplotlib.transforms.BboxBase`, optional | | - :xref_param_type:`tuple` or `matplotlib.transforms.BboxBase`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, optional | | - :xref_param_type:`tuple`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - { '-', '--', '-.', ':'} and more see description | | - { '-', '--', '-.', ':'} :xref_param_type:`and` :xref_param_type:`more` :xref_param_type:`see` :xref_param_type:`description` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - { ``'-'``, ``'--'``, ``'-.'``, ``':'``} and more see description | | - { ``'-'``, ``'--'``, ``'-.'``, ``':'``} :xref_param_type:`and` :xref_param_type:`more` :xref_param_type:`see` :xref_param_type:`description` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {"expand", None} | | - {"expand", :xref_param_type:`None`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {"linear", "log", "symlog", "logit"} | | - {"linear", "log", "symlog", "logit"} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'} | | - {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'bar', 'barstacked', 'step', 'stepfilled'}, optional | | - {'bar', 'barstacked', 'step', 'stepfilled'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'center', 'edge'}, optional, default: 'center' | | - {'center', 'edge'}, optional, default: 'center' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'center', 'left', 'right'}, str, optional | | - {'center', 'left', 'right'}, :xref_param_type:`str`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'face', 'none', *None*} or mpl color, optional, default is 'face' | | - {'face', 'none', *None*} :xref_param_type:`or` :xref_param_type:`mpl` :xref_param_type:`color`, optional, default :xref_param_type:`is` 'face' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'horizontal', 'vertical'}, optional | | - {'horizontal', 'vertical'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'hsv', 'overlay', 'soft'} or callable, optional | | - {'hsv', 'overlay', 'soft'} :xref_param_type:`or` :xref_param_type:`callable`, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'in', 'out', 'inout'} | | - {'in', 'out', 'inout'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'landscape', 'portrait'}, optional | | - {'landscape', 'portrait'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'mid', 'right'}, optional | | - {'left', 'mid', 'right'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'linear', 'log'}, optional, default is 'linear' | | - {'linear', 'log'}, optional, default :xref_param_type:`is` 'linear' | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'log'} or int or sequence, optional, default is *None* | | - {'log'} :xref_param_type:`or` :xref_param_type:`int` or :term:`python:sequence`, optional, default :xref_param_type:`is` *None* | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'major', 'minor', 'both'} | | - {'major', 'minor', 'both'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'mask' | 'clip'} str | | - {'mask' | 'clip'} :xref_param_type:`str` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'min_E', 'geom', 'user'}, optional | | - {'min_E', 'geom', 'user'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'neither', 'min', 'max', 'both'}, optional | | - {'neither', 'min', 'max', 'both'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'points', 'pixels'} | | - {'points', 'pixels'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'points, 'pixels'} | | - {'points, 'pixels'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'pre', 'post', 'mid'}, optional | | - {'pre', 'post', 'mid'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'vertical', 'horizontal'}, optional | | - {'vertical', 'horizontal'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'x', 'y', 'both'} | | - {'x', 'y', 'both'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'x', 'y', 'both'}, optional | | - {'x', 'y', 'both'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {1, 2, 3, 4} | | - {1, 2, 3, 4} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {1, 2, 3, 4}, optional | | - {1, 2, 3, 4}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {Colormap, string}, optional | | - {:xref_param_type:`Colormap`, :xref_param_type:`string `}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True}, optional | | - {:xref_param_type:`False`, :xref_param_type:`True`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'horizontal', 'vertical'}, optional | | - {:xref_param_type:`None`, 'horizontal', 'vertical'}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'major', 'minor', 'both'} | | - {:xref_param_type:`None`, 'major', 'minor', 'both'} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'none', color, color sequence} | | - {:xref_param_type:`None`, 'none', :xref_param_type:`color`, :xref_param_type:`color` :term:`python:sequence`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 1, 2}, optional | | - {:xref_param_type:`None`, 1, 2}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, array_like}, optional | | - {:xref_param_type:`None`, :term:`numpy:array_like`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, sequence, :class:`~matplotlib.ticker.Locator` instance} | | - {:xref_param_type:`None`, :term:`python:sequence`, :class:`~matplotlib.ticker.Locator` :xref_param_type:`instance`} | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False}, optional | | - {:xref_param_type:`True`, :xref_param_type:`False`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {str: class_like}, optional | | - {str: :xref_param_type:`class_like`}, optional | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+