forestploter.ForestPlotResult
- class forestploter.ForestPlotResult(figure, axes, geometry, row_centers, clipped_intervals, layout_diagnostics)[source]
Store rendered objects and auditable layout information.
- Parameters:
- figurematplotlib.figure.Figure
Complete Matplotlib Figure.
- axesmatplotlib.axes.Axes
Axes shared by the table and confidence intervals.
- geometrytuple of ColumnGeometry
Normalized horizontal boundaries for every output column.
- row_centerstuple of float
Visual-row centers in unique
_plot_roworder.- clipped_intervalsint
Number of intervals with at least one endpoint outside
xlim; each interval is counted at most once.- layout_diagnosticsForestLayoutDiagnostics
Diagnostics for rows, observation positions, merged spans, legends, and headers.
- Parameters:
figure (Figure)
axes (Axes)
geometry (tuple[ColumnGeometry, ...])
row_centers (tuple[float, ...])
clipped_intervals (int)
layout_diagnostics (ForestLayoutDiagnostics)
- __init__(figure, axes, geometry, row_centers, clipped_intervals, layout_diagnostics)
- Parameters:
figure (Figure)
axes (Axes)
geometry (tuple[ColumnGeometry, ...])
row_centers (tuple[float, ...])
clipped_intervals (int)
layout_diagnostics (ForestLayoutDiagnostics)
- Return type:
None
Methods
__init__(figure, axes, geometry, ...)save(path, *[, dpi])Save PNG, SVG, or another Matplotlib-supported format.
Attributes
figureaxesgeometryrow_centersclipped_intervalslayout_diagnostics