mirror of
https://github.com/apache/superset.git
synced 2026-04-10 20:06:13 +00:00
75 lines
2.4 KiB
Markdown
75 lines
2.4 KiB
Markdown
---
|
|
title: References Overview
|
|
sidebar_position: 1
|
|
---
|
|
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
|
|
# References Overview
|
|
|
|
🚧 **Coming Soon** 🚧
|
|
|
|
Comprehensive reference documentation for all Superset plugin APIs, configuration options, and development resources.
|
|
|
|
## Topics to be covered:
|
|
|
|
- Complete API reference documentation
|
|
- Plugin configuration schemas
|
|
- Event and hook reference
|
|
- Component library documentation
|
|
- TypeScript type definitions
|
|
- Extension point catalog
|
|
- Error code reference
|
|
- Performance metrics documentation
|
|
- Migration guides and changelogs
|
|
- Troubleshooting and FAQ
|
|
|
|
## Reference Sections
|
|
|
|
### API Documentation
|
|
- **Plugin APIs** - Core plugin development interfaces
|
|
- **Chart APIs** - Visualization component interfaces
|
|
- **Data APIs** - Query and transformation interfaces
|
|
- **UI APIs** - User interface and theming interfaces
|
|
- **Utility APIs** - Helper functions and utilities
|
|
|
|
### Configuration References
|
|
- **Plugin Manifests** - Plugin.json schema and options
|
|
- **Contribution Points** - Available extension points
|
|
- **Activation Events** - Plugin lifecycle triggers
|
|
- **Settings Schema** - Configuration option definitions
|
|
|
|
### Development Resources
|
|
- **TypeScript Definitions** - Complete type reference
|
|
- **Component Library** - Reusable UI components
|
|
- **Testing Utilities** - Testing helpers and mocks
|
|
- **Build Tools** - Webpack and bundling configuration
|
|
|
|
## Documentation Format
|
|
|
|
- **Interactive examples** - Live code demonstrations
|
|
- **Type annotations** - Complete TypeScript signatures
|
|
- **Usage patterns** - Common implementation examples
|
|
- **Migration notes** - Version upgrade guidance
|
|
|
|
---
|
|
|
|
*This documentation is under active development. Check back soon for updates!*
|