CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-superset-ui--plugin-chart-pivot-table

Superset Chart - Pivot Table provides comprehensive pivot table chart plugin for Apache Superset with interactive data visualization and summarization capabilities.

—

Pending
Overview
Eval results
Files

plugin-registration.mddocs/

Plugin Registration

Main plugin class for registering the pivot table chart type with Superset, including chart metadata, behaviors, and configuration options.

Capabilities

PivotTableChartPlugin Class

The main plugin class that extends ChartPlugin to register the pivot table chart type.

/**
 * Main plugin class for registering pivot table chart with Superset
 * Extends ChartPlugin with pivot table specific configuration
 */
export default class PivotTableChartPlugin extends ChartPlugin<
  PivotTableQueryFormData,
  ChartProps<QueryFormData>
> {
  constructor();
}

Usage Example:

import { PivotTableChartPlugin } from "@superset-ui/plugin-chart-pivot-table";

// Create and register the plugin
const plugin = new PivotTableChartPlugin();
plugin.configure({ key: 'pivot-table-v2' }).register();

// Plugin is now registered with Superset registry

Chart Metadata

The plugin includes comprehensive chart metadata that defines its capabilities and appearance in Superset.

interface ChartMetadata {
  behaviors: [Behavior.INTERACTIVE_CHART, Behavior.DRILL_TO_DETAIL];
  category: string; // 'Table'
  description: string;
  exampleGallery: { url: string }[];
  name: string; // 'Pivot Table'  
  tags: string[]; // ['Additive', 'Report', 'Tabular', 'Popular']
  thumbnail: string;
}

Plugin Configuration

The plugin is configured with essential components for chart functionality.

interface PluginConfiguration {
  buildQuery: (formData: PivotTableQueryFormData) => QueryContext;
  controlPanel: ControlPanelConfig;
  loadChart: () => Promise<ChartComponent>;
  metadata: ChartMetadata;
  transformProps: (chartProps: ChartProps<QueryFormData>) => PivotTableProps;
}

Chart Behaviors

Defines the interactive capabilities supported by the pivot table chart.

enum Behavior {
  INTERACTIVE_CHART = 'INTERACTIVE_CHART',
  DRILL_TO_DETAIL = 'DRILL_TO_DETAIL'
}

Behavior Details:

  • INTERACTIVE_CHART: Enables cross-filtering and interactive selection
  • DRILL_TO_DETAIL: Supports drilling down to underlying data records

Install with Tessl CLI

npx tessl i tessl/npm-superset-ui--plugin-chart-pivot-table

docs

chart-component.md

configuration-types.md

index.md

pivot-table-engine.md

plugin-registration.md

props-transformation.md

query-building.md

tile.json