PlotSmith

Contents:

  • Installation
    • Requirements
    • Installing PlotSmith
    • Development Installation
  • Quick Start
    • Basic Usage
    • Time Series with Confidence Bands
    • Residual Analysis
    • Heatmap
    • Next Steps
  • Architecture
    • Layer 1: Data and Representations
    • Layer 2: Primitives
    • Layer 3: Tasks
    • Layer 4: Workflows
    • Public API
  • API Reference
    • Workflows
      • Workflows
        • figure()
        • plot_backtest()
        • plot_bar()
        • plot_box()
        • plot_correlation()
        • plot_dumbbell()
        • plot_forecast_comparison()
        • plot_heatmap()
        • plot_histogram()
        • plot_lollipop()
        • plot_metric()
        • plot_model_comparison()
        • plot_range()
        • plot_residuals()
        • plot_scatter()
        • plot_slope()
        • plot_timeseries()
        • plot_violin()
        • plot_waffle()
        • plot_waterfall()
        • small_multiples()
    • View Objects
      • View Objects
        • BandView
        • BarView
        • BoxView
        • DumbbellView
        • FigureSpec
        • HeatmapView
        • HistogramView
        • LollipopView
        • MetricView
        • RangeView
        • ScatterView
        • SeriesView
        • SlopeView
        • ViolinView
        • WaffleView
        • WaterfallView
    • Primitives
      • Primitives
        • accent_point()
        • add_range_frame()
        • apply_axes_style()
        • direct_label()
        • draw_band()
        • draw_bar()
        • draw_heatmap()
        • draw_histogram()
        • draw_scatter()
        • draw_series()
        • emphasize_last()
        • event_line()
        • force_bar_zero()
        • minimal_axes()
        • note()
        • style_bar_plot()
        • style_line_plot()
        • style_scatter_plot()
        • tidy_axes()
  • Examples
    • Jupyter Notebooks
    • Python Scripts
    • New Chart Types
  • Performance Guide
    • Performance Characteristics
    • Optimization Tips
    • Memory Usage
    • Benchmarking
    • Performance Regression Testing
    • Known Performance Considerations
  • Troubleshooting Guide
    • Installation Issues
    • Plotting Issues
    • Data Validation Issues
    • Type Errors
    • Performance Issues
    • Styling Issues
    • CI/CD Issues
    • Getting Help
  • Contributing
    • Development Setup
    • Architecture Guidelines
    • Code Style
    • Testing
PlotSmith
  • API Reference
  • View page source

API Reference

This section provides detailed API documentation for all public functions and classes.

Workflows

  • Workflows
    • figure()
    • plot_backtest()
    • plot_bar()
    • plot_box()
    • plot_correlation()
    • plot_dumbbell()
    • plot_forecast_comparison()
    • plot_heatmap()
    • plot_histogram()
    • plot_lollipop()
    • plot_metric()
    • plot_model_comparison()
    • plot_range()
    • plot_residuals()
    • plot_scatter()
    • plot_slope()
    • plot_timeseries()
    • plot_violin()
    • plot_waffle()
    • plot_waterfall()
    • small_multiples()

View Objects

  • View Objects
    • BandView
    • BarView
    • BoxView
    • DumbbellView
    • FigureSpec
    • HeatmapView
    • HistogramView
    • LollipopView
    • MetricView
    • RangeView
    • ScatterView
    • SeriesView
    • SlopeView
    • ViolinView
    • WaffleView
    • WaterfallView

Primitives

  • Primitives
    • accent_point()
    • add_range_frame()
    • apply_axes_style()
    • direct_label()
    • draw_band()
    • draw_bar()
    • draw_heatmap()
    • draw_histogram()
    • draw_scatter()
    • draw_series()
    • emphasize_last()
    • event_line()
    • force_bar_zero()
    • minimal_axes()
    • note()
    • style_bar_plot()
    • style_line_plot()
    • style_scatter_plot()
    • tidy_axes()
Previous Next

© Copyright 2024, Kyle T. Jones.

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