a Sicw*@sdZddlmZddlZddlmZddlmZddl m Z m Z GdddZ Gdd d e Z Gd d d e ZGd d d e ZdS)a Classes to layout elements in a `.Figure`. Figures have a ``layout_engine`` property that holds a subclass of `~.LayoutEngine` defined here (or *None* for no layout). At draw time ``figure.get_layout_engine().execute()`` is called, the goal of which is usually to rearrange Axes on the figure to produce a pleasing layout. This is like a ``draw`` callback, however when printing we disable the layout engine for the final draw and it is useful to know the layout engine while the figure is being created, in particular to deal with colorbars. Matplotlib supplies two layout engines, `.TightLayoutEngine` and `.ConstrainedLayoutEngine`. Third parties can create their own layout engine by subclassing `.LayoutEngine`. ) nullcontextN)do_constrained_layout)get_subplotspec_listget_tight_layout_figurecsXeZdZdZdZdZfddZddZeddZ ed d Z d d Z d dZ Z S) LayoutEnginea Base class for Matplotlib layout engines. A layout engine can be passed to a figure at instantiation or at any time with `~.figure.Figure.set_layout_engine`. Once attached to a figure, the layout engine ``execute`` function is called at draw time by `~.figure.Figure.draw`, providing a special draw-time hook. .. note:: However, note that layout engines affect the creation of colorbars, so `~.figure.Figure.set_layout_engine` should be called before any colorbars are created. Currently, there are two properties of `LayoutEngine` classes that are consulted while manipulating the figure: - ``engine.colorbar_gridspec`` tells `.Figure.colorbar` whether to make the axes using the gridspec method (see `.colorbar.make_axes_gridspec`) or not (see `.colorbar.make_axes`); - ``engine.adjust_compatible`` stops `.Figure.subplots_adjust` from being run if it is not compatible with the layout engine. To implement a custom `LayoutEngine`: 1. override ``_adjust_compatible`` and ``_colorbar_gridspec`` 2. override `LayoutEngine.set` to update *self._params* 3. override `LayoutEngine.execute` with your implementation Nc stjfi|i|_dSN)super__init___paramsselfkwargs __class__T/var/www/html/django/DPS/env/lib/python3.9/site-packages/matplotlib/layout_engine.pyr >szLayoutEngine.__init__cKstdSrNotImplementedErrorr rrrsetBszLayoutEngine.setcCs|jdurt|jS)zc Return a boolean if the layout engine creates colorbars using a gridspec. N)_colorbar_gridspecrr rrrcolorbar_gridspecEs zLayoutEngine.colorbar_gridspeccCs|jdurt|jS)zn Return a boolean if the layout engine is compatible with `~.Figure.subplots_adjust`. N)_adjust_compatiblerrrrradjust_compatibleOs zLayoutEngine.adjust_compatiblecCs t|jS)zF Return copy of the parameters for the layout engine. )dictr rrrrgetYszLayoutEngine.getcCstdS)zB Execute the layout on the figure given by *fig*. Nrr figrrrexecute_szLayoutEngine.execute)__name__ __module__ __qualname____doc__rrr rpropertyrrrr __classcell__rrrrrs   rcs(eZdZdZfddZddZZS)PlaceHolderLayoutEnginea This layout engine does not adjust the figure layout at all. The purpose of this `.LayoutEngine` is to act as a place holder when the user removes a layout engine to ensure an incompatible `.LayoutEngine` can not be set later. Parameters ---------- adjust_compatible, colorbar_gridspec : bool Allow the PlaceHolderLayoutEngine to mirror the behavior of whatever layout engine it is replacing. c s"||_||_tjfi|dSr)rrrr )r rrr rrrr vsz PlaceHolderLayoutEngine.__init__cCsdSrrrrrrr{szPlaceHolderLayoutEngine.execute)rr r!r"r rr$rrrrr%gs r%csPeZdZdZdZdZdddddfdd Zd d Zddddd d d ZZ S)TightLayoutEnginez Implements the ``tight_layout`` geometry management. See :doc:`/tutorials/intermediate/tight_layout_guide` for details. TgHzG?Nrrr(padh_padw_padrectc s<tjfi|dD]}d|j|<q|j||||ddS)a' Initialize tight_layout engine. Parameters ---------- pad : float, 1.08 Padding between the figure edge and the edges of subplots, as a fraction of the font size. h_pad, w_pad : float Padding (height/width) between edges of adjacent subplots. Defaults to *pad*. rect : tuple (left, bottom, right, top), default: (0, 0, 1, 1). rectangle in normalized figure coordinates that the subplots (including labels) will fit into. r)N)rr r r)r r*r+r,r-r tdrrrr s zTightLayoutEngine.__init__c Cs|j}t|j}d|vr"td|}t|dt:t||j|||d|d|d|dd}Wdn1sx0Y|r|j fi|dS) ad Execute tight_layout. This decides the subplot parameters given the padding that will allow the axes labels to not be covered by other labels and axes. Parameters ---------- fig : `.Figure` to perform layout on. See also: `.figure.Figure.tight_layout` and `.pyplot.tight_layout`. NzcThis figure includes Axes that are not compatible with tight_layout, so results might be incorrect._draw_disabledr*r+r,r-r)) r raxes_api warn_external _get_renderergetattrrrsubplots_adjust)r rinfosubplotspec_listrendererr rrrrs   $zTightLayoutEngine.execute)r*r,r+r-cCs0|jjD]"}t|durt||j|<qdSrr__kwdefaults__localsr )r r*r,r+r-r.rrrrs zTightLayoutEngine.set rr r!r"rrr rrr$rrrrr&sr&csVeZdZdZdZdZdddddddfdd Zdd Zdddddd d d ZZ S) ConstrainedLayoutEnginez Implements the ``constrained_layout`` geometry management. See :doc:`/tutorials/intermediate/constrainedlayout_guide` for details. FNr')r+r,hspacewspacer-compressc s\tjfi||jtjdtjdtjdtjddd|j|||||d||_dS)a Initialize ``constrained_layout`` settings. Parameters ---------- h_pad, w_pad : float Padding around the axes elements in figure-normalized units. Default to :rc:`figure.constrained_layout.h_pad` and :rc:`figure.constrained_layout.w_pad`. hspace, wspace : float Fraction of the figure to dedicate to space between the axes. These are evenly spread between the gaps between the axes. A value of 0.2 for a three-column layout would have a space of 0.1 of the figure width between each column. If h/wspace < h/w_pad, then the pads are used instead. Default to :rc:`figure.constrained_layout.hspace` and :rc:`figure.constrained_layout.wspace`. rect : tuple of 4 floats Rectangle in figure coordinates to perform constrained layout in (left, bottom, width, height), each from 0-1. compress : bool Whether to shift Axes so that white space in between them is removed. This is useful for simple grids of fixed-aspect Axes (e.g. a grid of images). See :ref:`compressed_layout`. zfigure.constrained_layout.w_padzfigure.constrained_layout.h_padz figure.constrained_layout.wspacez figure.constrained_layout.hspacer')r,r+r?r>r-N)rr rmplrcParams _compress)r r+r,r>r?r-r@r rrrr s  z ConstrainedLayoutEngine.__init__c CsR|\}}|jd|}|jd|}t||||jd|jd|jd|jdS)z Perform constrained_layout and move and resize axes accordingly. Parameters ---------- fig : `.Figure` to perform layout on. r,r+r?r>r-)r,r+r?r>r-r@)get_size_inchesr rrC)r rwidthheightr,r+rrrrs zConstrainedLayoutEngine.execute)r+r,r>r?r-cCs0|jjD]"}t|durt||j|<qdS)a Set the pads for constrained_layout. Parameters ---------- h_pad, w_pad : float Padding around the axes elements in figure-normalized units. Default to :rc:`figure.constrained_layout.h_pad` and :rc:`figure.constrained_layout.w_pad`. hspace, wspace : float Fraction of the figure to dedicate to space between the axes. These are evenly spread between the gaps between the axes. A value of 0.2 for a three-column layout would have a space of 0.1 of the figure width between each column. If h/wspace < h/w_pad, then the pads are used instead. Default to :rc:`figure.constrained_layout.hspace` and :rc:`figure.constrained_layout.wspace`. rect : tuple of 4 floats Rectangle in figure coordinates to perform constrained layout in (left, bottom, width, height), each from 0-1. Nr9)r r+r,r>r?r-r.rrrrs zConstrainedLayoutEngine.setr<rrrrr=s(r=)r" contextlibr matplotlibrAmatplotlib._apir1Zmatplotlib._constrained_layoutrZmatplotlib._tight_layoutrrrr%r&r=rrrrs   LB