mirror of
https://github.com/apache/superset.git
synced 2026-05-30 12:49:17 +00:00
80 lines
2.8 KiB
TypeScript
80 lines
2.8 KiB
TypeScript
/**
|
|
* 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.
|
|
*/
|
|
import { t } from '@apache-superset/core/translation';
|
|
import { ChartMetadata, ChartPlugin } from '@superset-ui/core';
|
|
import buildQuery from './buildQuery';
|
|
import controlPanel from './controlPanel';
|
|
import transformProps from './transformProps';
|
|
import thumbnail from '../images/thumbnail.png';
|
|
import thumbnailDark from '../images/thumbnail-dark.png';
|
|
import example1 from '../images/example1.png';
|
|
import example1Dark from '../images/example1-dark.png';
|
|
import example2 from '../images/example2.png';
|
|
import example2Dark from '../images/example2-dark.png';
|
|
import { CartodiagramPluginConstructorOpts } from '../types';
|
|
import { getLayerConfig } from '../util/controlPanelUtil';
|
|
|
|
export default class CartodiagramPlugin extends ChartPlugin {
|
|
constructor(opts: CartodiagramPluginConstructorOpts) {
|
|
const metadata = new ChartMetadata({
|
|
description:
|
|
'Display charts on a map. For using this plugin, users first have to create any other chart that can then be placed on the map.',
|
|
name: t('Cartodiagram'),
|
|
thumbnail,
|
|
thumbnailDark,
|
|
tags: [t('Geo'), t('2D'), t('Spatial'), t('Experimental')],
|
|
category: t('Map'),
|
|
exampleGallery: [
|
|
{
|
|
url: example1,
|
|
urlDark: example1Dark,
|
|
caption: t('Pie charts on a map'),
|
|
},
|
|
{
|
|
url: example2,
|
|
urlDark: example2Dark,
|
|
caption: t('Line charts on a map'),
|
|
},
|
|
],
|
|
});
|
|
|
|
if (opts.defaultLayers) {
|
|
const layerConfig = getLayerConfig(controlPanel);
|
|
|
|
// set defaults for layer config if found
|
|
if (layerConfig) {
|
|
layerConfig.config.default = opts.defaultLayers;
|
|
} else {
|
|
// eslint-disable-next-line no-console
|
|
console.warn(
|
|
'Cannot set defaultLayers. layerConfig not found in control panel. Please check if the path to layerConfig should be adjusted.',
|
|
);
|
|
}
|
|
}
|
|
|
|
super({
|
|
buildQuery,
|
|
controlPanel,
|
|
loadChart: () => import('../CartodiagramPlugin'),
|
|
metadata,
|
|
transformProps,
|
|
});
|
|
}
|
|
}
|