mirror of
https://github.com/apache/superset.git
synced 2026-04-26 03:24:53 +00:00
feat(docs): Populate Developer Portal with comprehensive documentation framework (#35217)
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
80
docs/developer_portal/viz-plugins/creating-viz-plugin.md
Normal file
80
docs/developer_portal/viz-plugins/creating-viz-plugin.md
Normal file
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Creating a Visualization Plugin
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Creating a Visualization Plugin
|
||||
|
||||
🚧 **Coming Soon** 🚧
|
||||
|
||||
Step-by-step guide to building your first custom visualization plugin for Apache Superset.
|
||||
|
||||
## Topics to be covered:
|
||||
|
||||
- Setting up the plugin development environment
|
||||
- Using the visualization plugin generator
|
||||
- Understanding the plugin file structure
|
||||
- Implementing the chart component
|
||||
- Creating the control panel interface
|
||||
- Adding data transformation logic
|
||||
- Testing your visualization locally
|
||||
- Debugging common issues
|
||||
- Packaging for distribution
|
||||
- Publishing to npm registry
|
||||
|
||||
## Development Steps
|
||||
|
||||
### 1. Project Setup
|
||||
- Clone the superset-ui repository
|
||||
- Install dependencies and development tools
|
||||
- Create a new plugin directory
|
||||
- Configure build and development scripts
|
||||
|
||||
### 2. Chart Implementation
|
||||
- Define the main chart component
|
||||
- Handle data props and rendering
|
||||
- Implement responsive design
|
||||
- Add interactive features
|
||||
|
||||
### 3. Configuration Interface
|
||||
- Design the control panel layout
|
||||
- Add form controls and validation
|
||||
- Implement conditional controls
|
||||
- Handle control state management
|
||||
|
||||
### 4. Testing and Validation
|
||||
- Unit testing with Jest
|
||||
- Integration testing with Storybook
|
||||
- Visual regression testing
|
||||
- Performance benchmarking
|
||||
|
||||
## Code Examples
|
||||
|
||||
Examples will include:
|
||||
- Basic chart component structure
|
||||
- Control panel configuration
|
||||
- Data transformation functions
|
||||
- Event handling patterns
|
||||
|
||||
---
|
||||
|
||||
*This documentation is under active development. Check back soon for updates!*
|
||||
Reference in New Issue
Block a user