forestploter

User guide

  • Getting started
    • Install
    • Read a file
    • Minimal long table
    • Table borders
    • Save the result
    • Next steps
  • Data contract
    • Two independent column orders
    • Field dictionary
    • Row-type recipes
    • Complete single-CI example
    • Multiple series: header row and indented children
    • Multiple CI columns: duplicate records, share a visual row
    • Multiple series, multiple CI columns, and trailing text
    • XLSX merge rules
    • CSV compatibility
    • Accepted versus recommended input
    • Clipping semantics
  • Example gallery
    • 01 · Single series with trailing effect text
      • Run the example
      • Plot function used by the gallery and tests
    • 02 · Three series in one CI column
      • Run the example
      • Plot function used by the gallery and tests
    • 03 · One series across two CI columns
      • Run the example
      • Plot function used by the gallery and tests
    • 04 · Clipping stress test
      • Run the example
      • Plot function used by the gallery and tests
    • 05 · Long text and multilingual layout
      • Run the example
      • Plot function used by the gallery and tests
    • 06 · Automatic axis range
      • Run the example
      • Plot function used by the gallery and tests
    • 07 · Four dense series
      • Run the example
      • Plot function used by the gallery and tests
    • 08 · Two series across two CI columns, then text
      • Run the example
      • Plot function used by the gallery and tests
    • 09 · Deep hierarchy and many rows
      • Run the example
      • Plot function used by the gallery and tests
    • 10 · Unicode labels and a custom theme
      • Run the example
      • Plot function used by the gallery and tests
    • 11 · Boundaries and floating-point precision
      • Run the example
      • Plot function used by the gallery and tests
    • 12 · Per-series CI text rows after the plot
      • Run the example
      • Plot function used by the gallery and tests
    • 13 · Comprehensive two-column, three-series showcase
      • Run the example
      • Plot function used by the gallery and tests

Reference

  • API reference
    • Core workflow
      • forestploter.read_forest_data
      • forestploter.forest
      • forestploter.ForestPlotResult
    • Data model
      • forestploter.ForestData
      • forestploter.ForestDataMapping
      • forestploter.ForestCellSpan
    • Configuration
      • forestploter.ForestColumn
      • forestploter.ForestSeriesStyle
      • forestploter.ForestTheme
      • forestploter.ForestTableLayoutSpec
      • forestploter.ForestLegendSpec
      • forestploter.ForestReferenceLegendSpec
    • Diagnostics and geometry
      • forestploter.ForestLayoutDiagnostics
      • forestploter.ColumnGeometry
      • forestploter.compute_column_geometry
forestploter
  • Example gallery
  • View page source

Example gallery

Each case has one XLSX primary file, one semantically equivalent CSV companion, one PNG with the same filename stem, and the exact plotting function used by the renderer and regression tests. On every detail page, df means the forestploter.ForestData returned by forestploter.read_forest_data().

Download the general XLSX long-table template

01 · Single series with trailing effect text

Display text on both sides of one CI column, group rows, summary diamonds, reference and ideal lines.

02 · Three series in one CI column

Three series in one CI column with one explicit visual row per series.

03 · One series across two CI columns

One series aligned across two follow-up CI columns.

04 · Clipping stress test

Single-sided, two-sided, and fully off-scale clipping behavior.

05 · Long text and multilingual layout

Long headers, long cells, multilingual content, wrapping, and auto width.

06 · Automatic axis range

Automatic limits and ticks across heterogeneous effects.

07 · Four dense series

Four series, four markers, summary rows, and a bottom legend.

08 · Two series across two CI columns, then text

Two series aligned across two CI columns, followed by a text column whose header contains the legend.

09 · Deep hierarchy and many rows

Thirty visual rows, two indentation levels, subtotals, and spacers.

10 · Unicode labels and a custom theme

Chinese, English, Greek, mathematical symbols, a custom theme, and the optional full table border.

11 · Boundaries and floating-point precision

Exact limits, zero-width intervals, narrow intervals, and tiny overflows.

12 · Per-series CI text rows after the plot

Three independent CI-text rows placed after the CI column and aligned one-to-one with the corresponding series graphics.

13 · Comprehensive two-column, three-series showcase

Three series aligned across crude and adjusted CI columns with paired value-only CI text, compact outcome headers and indented series children, two-sided clipping, shared no-effect lines, an additional target line in one panel, direction labels, and bottom legends. This case uses no merges.

Previous Next

© Copyright 2026, Xuxu Wei.

Built with Sphinx using a theme provided by Read the Docs.