Comprehensive API Guide

Version:

0.15

Target Audience:

AI agents, LLMs, and developers

Purpose:

Complete, machine-parseable API documentation for dashboard_lego library

This comprehensive guide provides detailed documentation of all modules, classes, and patterns in the dashboard_lego library. It is organized into logical sections for easy navigation.

Guide Sections

• System Overview
  • Architecture Hierarchy
  • Module Dependency Graph
  • Core Design Principles
• Core Module API
  • DataSource
  • DashboardPage
• DataSources Module API
  • CsvDataSource
  • ParquetDataSource
  • SqlDataSource
• Blocks Module API
  • BaseBlock
  • TypedChartBlock
  • Metrics Factory Pattern
  • MetricsBlock (Deprecated)
  • ControlPanelBlock
  • TextBlock
  • KPIBlock (Deprecated)
• Presets Module API
  • Base Preset
  • Auto-sizing Controls
  • EDA Presets
  • ML Presets
  • Layout Presets
  • Control Styles
• Integration Patterns
  • Publisher/Subscriber Pattern
  • Multi-State Subscriptions
  • Navigation Pattern
  • Theme Customization Pattern
  • Layout Composition Pattern
  • Data Processing Pipeline Pattern (v0.15)
  • Quick Dashboard Pattern
  • Export Pattern
  • IPython Magic Commands
  • Placeholders Guide
• IPython Magic Commands
  • Installation
  • Dashboard Creation
  • Understanding Control Bindings
  • Theme Management
  • Plotly Export
  • Examples
  • Common Patterns
  • Troubleshooting
  • Error Messages
• Contracts and Guarantees
  • Data Source Lifecycle (v0.15)
  • Block Lifecycle
  • Layout Height Contract (v0.15)
  • State Management Callbacks
  • Cache Behavior (v0.15)
• Quick Reference
  • Class Summary
  • Configuration Options
  • Common Patterns
  • Error Handling
  • Performance Tips