superset2/docs/developer_portal/references/api.md

title, sidebar_position

title	sidebar_position
API Reference	2

API Reference

🚧 Coming Soon 🚧

Complete API documentation for all Superset plugin development interfaces and services.

Topics to be covered:

• Core plugin development APIs
• Chart and visualization APIs
• Data transformation and query APIs
• UI component and theming APIs
• Event handling and lifecycle APIs
• Configuration and settings APIs
• Security and authentication APIs
• Performance and monitoring APIs
• Utility functions and helpers
• TypeScript type definitions

API Categories

Core Plugin APIs

Plugin Registration

// Plugin registration interface
interface PluginConfig {
  name: string;
  version: string;
  components: ComponentRegistry;
  metadata: PluginMetadata;
}

// registerPlugin function
function registerPlugin(config: PluginConfig): void;

Plugin Lifecycle

• onActivate() - Plugin activation hook
• onDeactivate() - Plugin deactivation hook
• onUpdate() - Plugin update hook
• onConfigChange() - Configuration change hook

Chart Development APIs

Chart Component Interface

interface ChartComponent {
  render(props: ChartProps): JSX.Element;
  transformProps(chartProps: ChartProps): TransformedProps;
  buildQuery(formData: FormData): Query;
}

Data Transformation

• transformProps() - Data transformation function
• buildQuery() - Query building function
• formatData() - Data formatting utilities
• validateData() - Data validation helpers

UI and Theming APIs

Theme Provider

• useTheme() - Theme context hook
• ThemeProvider - Theme provider component
• createTheme() - Theme creation utility
• mergeThemes() - Theme composition function

Component Library

• Button components and variants
• Form controls and inputs
• Layout and grid components
• Data display components

---

This documentation is under active development. Check back soon for updates!