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
  • Search

© Copyright 2026, Xuxu Wei.

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