Parameters ---------- figsize : (float, float) or (float, float, str), default: :rc:`figure.figsize` The figure dimensions. This can be - a tuple ``(width, height, unit)``, where *unit* is one of "in" (inch), "cm" (centimenter), "px" (p
(self,
figsize=None,
dpi=None,
*,
facecolor=None,
edgecolor=None,
linewidth=0.0,
frameon=None,
subplotpars=None, # rc figure.subplot.*
tight_layout=None, # rc figure.autolayout
constrained_layout=None, # rc figure.constrained_layout.use
layout=None,
**kwargs
)
| 2468 | ) |
| 2469 | |
| 2470 | def __init__(self, |
| 2471 | figsize=None, |
| 2472 | dpi=None, |
| 2473 | *, |
| 2474 | facecolor=None, |
| 2475 | edgecolor=None, |
| 2476 | linewidth=0.0, |
| 2477 | frameon=None, |
| 2478 | subplotpars=None, # rc figure.subplot.* |
| 2479 | tight_layout=None, # rc figure.autolayout |
| 2480 | constrained_layout=None, # rc figure.constrained_layout.use |
| 2481 | layout=None, |
| 2482 | **kwargs |
| 2483 | ): |
| 2484 | """ |
| 2485 | Parameters |
| 2486 | ---------- |
| 2487 | figsize : (float, float) or (float, float, str), default: :rc:`figure.figsize` |
| 2488 | The figure dimensions. This can be |
| 2489 | |
| 2490 | - a tuple ``(width, height, unit)``, where *unit* is one of "in" (inch), |
| 2491 | "cm" (centimenter), "px" (pixel). |
| 2492 | - a tuple ``(width, height)``, which is interpreted in inches, i.e. as |
| 2493 | ``(width, height, "in")``. |
| 2494 | |
| 2495 | One of *width* or *height* may be ``None``; the respective value is |
| 2496 | taken from :rc:`figure.figsize`. |
| 2497 | |
| 2498 | dpi : float, default: :rc:`figure.dpi` |
| 2499 | Dots per inch. |
| 2500 | |
| 2501 | facecolor : default: :rc:`figure.facecolor` |
| 2502 | The figure patch facecolor. |
| 2503 | |
| 2504 | edgecolor : default: :rc:`figure.edgecolor` |
| 2505 | The figure patch edge color. |
| 2506 | |
| 2507 | linewidth : float |
| 2508 | The linewidth of the frame (i.e. the edge linewidth of the figure |
| 2509 | patch). |
| 2510 | |
| 2511 | frameon : bool, default: :rc:`figure.frameon` |
| 2512 | If ``False``, suppress drawing the figure background patch. |
| 2513 | |
| 2514 | subplotpars : `~matplotlib.gridspec.SubplotParams` |
| 2515 | Subplot parameters. If not given, the default subplot |
| 2516 | parameters :rc:`figure.subplot.*` are used. |
| 2517 | |
| 2518 | tight_layout : bool or dict, default: :rc:`figure.autolayout` |
| 2519 | Whether to use the tight layout mechanism. See `.set_tight_layout`. |
| 2520 | |
| 2521 | .. admonition:: Discouraged |
| 2522 | |
| 2523 | The use of this parameter is discouraged. Please use |
| 2524 | ``layout='tight'`` instead for the common case of |
| 2525 | ``tight_layout=True`` and use `.set_tight_layout` otherwise. |
| 2526 | |
| 2527 | constrained_layout : bool, default: :rc:`figure.constrained_layout.use` |
no test coverage detected