forestploter.ForestLayoutDiagnostics

class forestploter.ForestLayoutDiagnostics(series_gap_used, row_bounds, row_scales, wrapped_headers, final_figure_width, header_overflow_count, plot_row_ids=(), observation_positions=(), resolved_spans=(), legend_bounds=())

Store layout diagnostics suitable for automated acceptance checks.

Parameters:

series_gap_usedfloat

Always 0.0 because the explicit long-table model never offsets series implicitly.

row_boundstuple of tuple of float

(bottom, top) pairs in unique _plot_row order.

row_scalestuple of float

Relative height multiplier for every visual row.

wrapped_headerstuple of tuple of str

(column_key, final_header) pairs.

final_figure_widthfloat

Final Figure width in inches.

header_overflow_countint

Number of headers overflowing their column width, header-row height, or Figure boundary.

plot_row_idstuple

Visual-row identifiers in the same order as row_bounds and the result’s row_centers.

observation_positionstuple of tuple

(plot_row, series, ci_column, y) for every drawable observation.

resolved_spanstuple of tuple

(column_key, start_plot_row, end_plot_row, bottom, top) for each resolved merged-cell span.

legend_boundstuple of tuple

(kind, left, bottom, right, top) bounds for every legend in data coordinates.

Parameters:

• series_gap_used (float)

• row_bounds (tuple[tuple[float, float], ...])

• row_scales (tuple[float, ...])

• wrapped_headers (tuple[tuple[str, str], ...])

• final_figure_width (float)

• header_overflow_count (int)

• plot_row_ids (tuple[Any, ...])

• observation_positions (tuple[tuple[Any, str, str, float], ...])

• resolved_spans (tuple[tuple[str, Any, Any, float, float], ...])

• legend_bounds (tuple[tuple[str, float, float, float, float], ...])

__init__(series_gap_used, row_bounds, row_scales, wrapped_headers, final_figure_width, header_overflow_count, plot_row_ids=(), observation_positions=(), resolved_spans=(), legend_bounds=())

Parameters:

• series_gap_used (float)

• row_bounds (tuple[tuple[float, float], ...])

• row_scales (tuple[float, ...])

• wrapped_headers (tuple[tuple[str, str], ...])

• final_figure_width (float)

• header_overflow_count (int)

• plot_row_ids (tuple[Any, ...])

• observation_positions (tuple[tuple[Any, str, str, float], ...])

• resolved_spans (tuple[tuple[str, Any, Any, float, float], ...])

• legend_bounds (tuple[tuple[str, float, float, float, float], ...])

Return type:

None

Methods

__init__(series_gap_used, row_bounds, ...[, ...])

Attributes

legend_bounds
observation_positions
plot_row_ids
resolved_spans
series_gap_used
row_bounds
row_scales
wrapped_headers
final_figure_width
header_overflow_count