mirror of
https://github.com/apache/superset.git
synced 2024-09-12 16:49:40 -04:00
e632b82395
* adds: plugin chart handlebars * adds: handlebars plugin to main presets * update: npm install * chore: lint * adds: dateFormat handlebars helper * deletes: unused props * chore: linting plugin-chart-handlebars * docs: chart-plugin-handlebars * adds: moment to peer deps * update: use error handling * update: inline config, adds renderTrigger * update: inline config, adds renderTrigger * camelCase controls * (plugins-chart-handlebars) adds: missing props Adds missing propeties in test formData * (plugin-chart-handlebars) fixes test * (plugin-handlebars-chart) use numbers for size * (feature-handlebars-chart) fix viz_type * (plugin-handlebars-chart) revert revert the viz_type change. it was in the wrong place. * fix test and add license headers Co-authored-by: Ville Brofeldt <ville.v.brofeldt@gmail.com>
75 lines
2.1 KiB
Markdown
75 lines
2.1 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
## @superset-ui/plugin-chart-handlebars
|
|
|
|
[](https://www.npmjs.com/package/@superset-ui/plugin-chart-handlebars)
|
|
|
|
This plugin renders the data using a handlebars template.
|
|
|
|
### Usage
|
|
|
|
Configure `key`, which can be any `string`, and register the plugin. This `key` will be used to
|
|
lookup this chart throughout the app.
|
|
|
|
```js
|
|
import HandlebarsChartPlugin from '@superset-ui/plugin-chart-handlebars';
|
|
|
|
new HandlebarsChartPlugin().configure({ key: 'handlebars' }).register();
|
|
```
|
|
|
|
Then use it via `SuperChart`. See
|
|
[storybook](https://apache-superset.github.io/superset-ui/?selectedKind=plugin-chart-handlebars) for
|
|
more details.
|
|
|
|
```js
|
|
<SuperChart
|
|
chartType="handlebars"
|
|
width={600}
|
|
height={600}
|
|
formData={...}
|
|
queriesData={[{
|
|
data: {...},
|
|
}]}
|
|
/>
|
|
```
|
|
|
|
### File structure generated
|
|
|
|
```
|
|
├── package.json
|
|
├── README.md
|
|
├── tsconfig.json
|
|
├── src
|
|
│ ├── Handlebars.tsx
|
|
│ ├── images
|
|
│ │ └── thumbnail.png
|
|
│ ├── index.ts
|
|
│ ├── plugin
|
|
│ │ ├── buildQuery.ts
|
|
│ │ ├── controlPanel.ts
|
|
│ │ ├── index.ts
|
|
│ │ └── transformProps.ts
|
|
│ └── types.ts
|
|
├── test
|
|
│ └── index.test.ts
|
|
└── types
|
|
└── external.d.ts
|
|
```
|