superset设置查看权限_如何为Superset 添加一个自定义组件

# clone repo
git clone https://github.com/apache/incubator-superset.git
 
# checkout release 0.36.0 
cd incubator-superset
git checkout tags/0.36.0

brew install pyenv
pyenv install 3.7.0
// 在当前superset目录下，设置python版本为3.7.0,
pyenv local 3.7.0

# 安装各种依赖
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .
 
# 创建admin用户，记得记住用户名密码，之后要登陆
superset fab create-admin
 
# 脚本初始化和迁移数据库
superset db upgrade
 
# 脚本初始化用户和组的权限
superset init
 
# 脚本加载默认的图表和面板
superset load_examples
 
# run flask server
FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger

cd superset-frontend
# 使用package.lock 安装依赖
npm ci
# run dev server
npm run dev-server

import { t } from '@superset-ui/translation';
 
export default {
  controlPanelSections: [
    // label对应的是每个section的标题
    // expand对应的是改section是否可以被展开
    // controlSetRows 定义的是每一行有几个组件，metric，adhoc_filters对应的是组件的key
    // 可以在superset-frontend/src/explore/controls.jsx
    // 中通过这些key找到对应的配置
    {
      label: t('Query'),
      expanded: true,
      controlSetRows: [
        ['metric'],
        ['adhoc_filters'],
        ['groupby'],
        ['row_limit'],
      ],
    },
    {
      label: t('Chart Options'),
      expanded: true,
      controlSetRows: [
        ['pie_label_type', 'number_format'],
        ['donut', 'show_legend'],
        ['show_labels', 'labels_outside'],
        ['color_scheme', 'label_colors'],
      ],
    },
  ],
  controlOverrides: {
    row_limit: {
      default: 25,
    },
    number_format: {
      description:
        t('D3 format syntax: https://github.com/d3/d3-format') +
        ' ' +
        t('Only applies when the "Label Type" is not set to a percentage.'),
    },
  },
};

const metrics = {
  type: 'MetricsControl',
  multi: true,
  label: t('Metrics'),
  validators: [v.nonEmpty],
  default: c => {
    const metric = mainMetric(c.savedMetrics);
    return metric ? [metric] : null;
  },
  mapStateToProps: state => {
    const datasource = state.datasource;
    return {
      columns: datasource ? datasource.columns : [],
      savedMetrics: datasource ? datasource.metrics : [],
      datasourceType: datasource && datasource.type,
    };
  },
  description: t('One or many metrics to display'),
};
 
// label 为该组件显示在控制面板的名称
// type 为对应的UI组件
const metric = {
  ...metrics,
  multi: false,
  label: t('Metric'),
  description: t('Metric'),
  default: props => mainMetric(props.savedMetrics),
};

// ... 此处省略
import { getChartControlPanelRegistry } from '@superset-ui/chart';
import MainPreset from '../visualizations/presets/MainPreset';
import setupPluginsExtra from './setupPluginsExtra';
 
import Area from '../explore/controlPanels/Area';
// ... 此处省略
 
// 引入自定义的控制面板配置
import CustomTable from '../explore/controlPanels/CustomTable';
 
export default function setupPlugins() {
  new MainPreset().register();
 
  // TODO: Remove these shims once the control panel configs are moved into the plugin package.
  getChartControlPanelRegistry()
    .registerValue('area', Area)
    // ... 此处省略
    // 注册控制面板，custom_table就是我将要引入的图表的key
    // 那么如果图表的key是custom_table的时候，
    // 页面会使用CustomRader这个配置来显示控制面板
    .registerValue('custom_radar', CustomRader);
 
  setupPluginsExtra();
}

import { Preset } from '@superset-ui/core';
// ...
import {
  AreaChartPlugin,
  // ...
} from '@superset-ui/legacy-preset-chart-nvd3';
// 引入自定义图表
import CustomRadar from '自定义组件的目录/custom-radar';
 
export default class MainPreset extends Preset {
  constructor() {
    super({
      name: 'Legacy charts',
      presets: [new DeckGLChartPreset()],
      plugins: [
        new AreaChartPlugin().configure({ key: 'area' }),
        // ...
        // 注册自定义图表
        new CustomRadar().configure({ key: 'custom-radar' }),
      ],
    });
  }
}

// ...
class DistributionPieViz(NVD3Viz):
 
    """Annoy visualization snobs with this controversial pie chart"""
 
    viz_type = "pie"
    verbose_name = _("Distribution - NVD3 - Pie Chart")
    is_timeseries = False
 
    def get_data(self, df: pd.DataFrame) -> VizData:
        if df.empty:
            return None
        metric = self.metric_labels[0]
        df = df.pivot_table(index=self.groupby, values=[metric])
        df.sort_values(by=metric, ascending=False, inplace=True)
        df = df.reset_index()
        df.columns = ["x", "y"]
        return df.to_dict(orient="records")
// ...
 
viz_types = {
    o.viz_type: o
    for o in globals().values()
    if (
        inspect.isclass(o)
        and issubclass(o, BaseViz)
        and o.viz_type not in config["VIZ_TYPE_BLACKLIST"]
    )
}