API reference

The 15 public objects are organized below in the order most users encounter them. autosummary regenerates the detail pages from current signatures and pandas/NumPy-style docstrings on every documentation build.

Core workflow

Read data, render a plot, and work with the returned figure and diagnostics.

read_forest_data	Read an XLSX or CSV file that follows the forest long-table contract.
forest	Render a table-style forest plot from an explicit long table.
ForestPlotResult	Store rendered objects and auditable layout information.

Data model

Inspect normalized values, source-cell locations, field mappings, and XLSX merge spans.

ForestData	Store a renderable long table and its source-cell structure.
ForestDataMapping	Map the nine reserved long-table fields to source column names.
ForestCellSpan	Describe one supported vertical merge in an XLSX display field.

Configuration

Define output columns, series styles, themes, automatic table layout, and series/reference legends.

ForestColumn	Define a display column or a confidence-interval plotting area.
ForestSeriesStyle	Define the color, marker, and legend label for one series.
ForestTheme	Define visual styles for the table, text, intervals, and guide lines.
ForestTableLayoutSpec	Configure automatic column widths, header wrapping, and margins.
ForestLegendSpec	Place and arrange the series legend.
ForestReferenceLegendSpec	Place and label reference-line and ideal-line legend entries.

Diagnostics and geometry

Audit visual rows, observation coordinates, merged spans, legend bounds, and normalized column boundaries.

ForestLayoutDiagnostics	Store layout diagnostics suitable for automated acceptance checks.
ColumnGeometry	Store the normalized horizontal boundaries of one column.
compute_column_geometry	Convert relative widths to contiguous boundaries within [0, 1].