h+SrSSKJr SSKrSSKJr SSKJrJ r "SS5r "SS \ 5r "S S \ 5r "S S \ 5r g)a1 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 but with two differences. First, when printing we disable the layout engine for the final draw. Second, it is useful to know the layout engine while the figure is being created. In particular, colorbars are made differently with different layout engines (for historical reasons). 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_figurecf^\rSrSrSrSrSrU4SjrSr\ S5r \ S5r Sr S r S rU=r$) LayoutEngineau 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 4>[TU]"S0UD6 0UlgN)super__init___params)selfkwargs __class__s J/var/www/html/env/lib/python3.13/site-packages/matplotlib/layout_engine.pyrLayoutEngine.__init__>s "6" c [e)z+ Set the parameters for the layout engine. NotImplementedError)rrs rsetLayoutEngine.setBs "!rc@URc[eUR$)zK Return a boolean if the layout engine creates colorbars using a gridspec. )_colorbar_gridspecrrs rcolorbar_gridspecLayoutEngine.colorbar_gridspecH"  " " *% %&&&rc@URc[eUR$)zV Return a boolean if the layout engine is compatible with `~.Figure.subplots_adjust`. )_adjust_compatiblerrs radjust_compatibleLayoutEngine.adjust_compatibleRr rc,[UR5$)z6 Return copy of the parameters for the layout engine. )dictrrs rgetLayoutEngine.get\sDLL!!rc[e)z2 Execute the layout on the figure given by *fig*. rrfigs rexecuteLayoutEngine.executebs "!r)r)__name__ __module__ __qualname____firstlineno____doc__r"rrrpropertyrr#r'r,__static_attributes__ __classcell__rs@rrrsW>" ''''" ""rrc2^\rSrSrSrU4SjrSrSrU=r$)PlaceHolderLayoutEngineja This layout engine does not adjust the figure layout at all. The purpose of this `.LayoutEngine` is to act as a placeholder when the user removes a layout engine to ensure an incompatible `.LayoutEngine` cannot be set later. Parameters ---------- adjust_compatible, colorbar_gridspec : bool Allow the PlaceHolderLayoutEngine to mirror the behavior of whatever layout engine it is replacing. c >>XlX l[TU] "S0UD6 gr )r"rr r)rr#rrrs rr PlaceHolderLayoutEngine.__init__xs"3"3 "6"rcg)z Do nothing. Nr r*s rr,PlaceHolderLayoutEngine.execute}s r)r"r) r.r/r0r1r2rr,r4r5r6s@rr8r8js # rr8c\^\rSrSrSrSrSrSSSSS.U4SjjrS rSSSSS .S jr S r U=r $) TightLayoutEnginezb Implements the ``tight_layout`` geometry management. See :ref:`tight_layout_guide` for details. TgHzG?NrrrBpadh_padw_padrectc v>[TU]"S0UD6 SHnSURU'M URXX4S9 g)a Initialize tight_layout engine. Parameters ---------- pad : float, default: 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. rCNr )r rrr)rrDrErFrGrtdrs rrTightLayoutEngine.__init__s?" "6"3B#DLL 4 SU>rc @URnUR5n[US[5"5 [ XR [ UR 5UUSUSUSUSS9nSSS5 W(aUR"S0UD6 gg!,(df  N)=f) a 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 .pyplot.tight_layout _draw_disabledrDrErFrGrCNr )r _get_renderergetattrrraxesrsubplots_adjust)rr+inforendererrs rr,TightLayoutEngine.executes"||$$& X/ = ?,XX3CHH=xKtG}DM&\#F@     )& )  @ ?s 9B B)rDrFrErGcURRH-n[5UcM[5UURU'M/ g)a Set the pads for tight_layout. Parameters ---------- pad : float Padding between the figure edge and the edges of subplots, as a fraction of the font size. w_pad, h_pad : float Padding (width/height) between edges of adjacent subplots. Defaults to *pad*. rect : tuple (left, bottom, right, top) rectangle in normalized figure coordinates that the subplots (including labels) will fit into. Nr__kwdefaults__localsr)rrDrFrErGrIs rrTightLayoutEngine.sets8 (())Bx|'#)8B< R *rr r.r/r0r1r2r"rrr,rr4r5r6s@rr?r?sD"$d"??.*6TD00rr?cb^\rSrSrSrSrSrSSSSSSS.U4SjjrSrSSSSSS .S jr S r U=r $) ConstrainedLayoutEnginezm Implements the ``constrained_layout`` geometry management. See :ref:`constrainedlayout_guide` for details. FNrA)rErFhspacewspacerGcompressc >[TU]"S0UD6 UR[RS[RS[RS[RSSS9 URX!XCUS9 X`lg) a Initialize ``constrained_layout`` settings. Parameters ---------- h_pad, w_pad : float Padding around the Axes elements in inches. 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.hspacerA)rFrEr^r]rGNr )r rrmplrcParams _compress) rrErFr]r^rGr_rrs rr ConstrainedLayoutEngine.__init__s{8 "6" s||$EF||$EF %GH %GH"  $ u&  !rc UR5up#URSU- nURSU- n[XUURSURSURSURS9$)z Perform constrained_layout and move and resize Axes accordingly. Parameters ---------- fig : `.Figure` to perform layout on. rFrEr^r]rG)rFrEr^r]rGr_)get_size_inchesrrrc)rr+widthheightrFrEs rr,ConstrainedLayoutEngine.executesv++-  W%- W%.$SU,0LL,B,0LL,B*.,,v*>.2nn > >r)rErFr]r^rGcURRH-n[5UcM[5UURU'M/ g)a$ Set the pads for constrained_layout. Parameters ---------- h_pad, w_pad : float Padding around the Axes elements in inches. 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. NrU)rrErFr]r^rGrIs rrConstrainedLayoutEngine.sets8.(())Bx|'#)8B< R *r)rcrYr6s@rr[r[sM  $DT &"&"P>& t400rr[)r2 contextlibr matplotlibramatplotlib._constrained_layoutrmatplotlib._tight_layoutrrrr8r?r[r rrrpsP"#@?L"L"^l4L0 L0^]0l]0r