forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added support for Download as SVG image for charts
- Loading branch information
Showing
4 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| /** | ||
| * 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 { SyntheticEvent } from 'react'; | ||
| import domToImage from 'dom-to-image-more'; | ||
| import { kebabCase } from 'lodash'; | ||
| import { t, supersetTheme } from '@superset-ui/core'; | ||
| import { addWarningToast } from 'src/components/MessageToasts/actions'; | ||
|
|
||
| /** | ||
| * generate a consistent file stem from a description and date | ||
| * | ||
| * @param description title or description of content of file | ||
| * @param date date when file was generated | ||
| */ | ||
| const generateFileStem = (description: string, date = new Date()) => | ||
| `${kebabCase(description)}-${date.toISOString().replace(/[: ]/g, '-')}`; | ||
|
|
||
| /** | ||
| * Create an event handler for turning an element into an image | ||
| * | ||
| * @param selector css selector of the parent element which should be turned into image | ||
| * @param description name or a short description of what is being printed. | ||
| * Value will be normalized, and a date as well as a file extension will be added. | ||
| * @param isExactSelector if false, searches for the closest ancestor that matches selector. | ||
| * @returns event handler | ||
| */ | ||
| export default function downloadAsImage( | ||
| selector: string, | ||
| description: string, | ||
| isExactSelector = false, | ||
| ) { | ||
| return (event: SyntheticEvent) => { | ||
| const elementToPrint = isExactSelector | ||
| ? document.querySelector(selector) | ||
| : event.currentTarget.closest(selector); | ||
|
|
||
| if (!elementToPrint) { | ||
| return addWarningToast( | ||
| t('Image download failed, please refresh and try again.'), | ||
| ); | ||
| } | ||
|
|
||
| // Mapbox controls are loaded from different origin, causing CORS error | ||
| // See https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL#exceptions | ||
| const filter = (node: Element) => { | ||
| if (typeof node.className === 'string') { | ||
| return ( | ||
| node.className !== 'mapboxgl-control-container' && | ||
| !node.className.includes('header-controls') | ||
| ); | ||
| } | ||
| return true; | ||
| }; | ||
|
|
||
| return domToImage | ||
| .toSvg(elementToPrint, { | ||
| bgcolor: supersetTheme.colors.grayscale.light4, | ||
| filter, | ||
| }) | ||
| .then((dataUrl: string) => { | ||
| const link = document.createElement('a'); | ||
| link.download = `${generateFileStem(description)}.jpg`; | ||
| link.href = dataUrl; | ||
| link.click(); | ||
| }) | ||
| .catch((e: Error) => { | ||
| console.error('Creating image failed', e); | ||
| }); | ||
| }; | ||
| } |