etr2460 commented on a change in pull request #9819:
URL:
https://github.com/apache/incubator-superset/pull/9819#discussion_r426218477
##########
File path: superset-frontend/src/dashboard/components/HeaderActionsDropdown.jsx
##########
@@ -217,6 +218,17 @@ class HeaderActionsDropdown extends React.PureComponent {
onChange={this.changeCss}
/>
)}
+
+ {!editMode && (
+ <MenuItem
+ onClick={downloadAsImage(
+ '.dashboard',
+ generateFileStem(dashboardTitle),
Review comment:
instead of needing to call `generateFileStem` and passing it into
`downloadAsImage`, I think it's cleaner to pass in a name/description field
that `downloadAsImage` then uses to generate the file stem within the function
##########
File path: superset-frontend/src/dashboard/util/downloadAsImage.ts
##########
@@ -0,0 +1,61 @@
+/**
+ * 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 { MouseEvent, MouseEventHandler } from 'react';
+import domToImage from 'dom-to-image';
+import kebabCase from 'lodash/kebabCase';
+
+/**
+ * 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
+ */
+export const generateFileStem = (description: string, date = new Date()) => {
+ return `${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 fileStem name of generated file, without extension
+ * @param backgroundColor background color to apply to screenshot document
+ */
+export const downloadAsImage = (
+ selector: string,
+ fileStem: string,
+ backgroundColor = '#f5f5f5',
+): MouseEventHandler => (event: MouseEvent) => {
+ const elementToPrint = event.currentTarget.closest(selector);
+
+ if (!elementToPrint) throw new Error('printable element not found');
+
+ domToImage
+ .toJpeg(elementToPrint, { quality: 0.95, bgcolor: backgroundColor })
+ .then(dataUrl => {
+ const link = document.createElement('a');
+ link.download = `${fileStem}.jpeg`;
Review comment:
it might be personal preference, but i think `.jpg` is more common
##########
File path: superset-frontend/src/dashboard/util/downloadAsImage.ts
##########
@@ -0,0 +1,61 @@
+/**
+ * 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 { MouseEvent, MouseEventHandler } from 'react';
+import domToImage from 'dom-to-image';
+import kebabCase from 'lodash/kebabCase';
+
+/**
+ * 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
+ */
+export const generateFileStem = (description: string, date = new Date()) => {
+ return `${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 fileStem name of generated file, without extension
+ * @param backgroundColor background color to apply to screenshot document
+ */
+export const downloadAsImage = (
+ selector: string,
+ fileStem: string,
+ backgroundColor = '#f5f5f5',
+): MouseEventHandler => (event: MouseEvent) => {
+ const elementToPrint = event.currentTarget.closest(selector);
+
+ if (!elementToPrint) throw new Error('printable element not found');
+
+ domToImage
+ .toJpeg(elementToPrint, { quality: 0.95, bgcolor: backgroundColor })
+ .then(dataUrl => {
+ const link = document.createElement('a');
+ link.download = `${fileStem}.jpeg`;
+ link.href = dataUrl;
+ link.click();
+ });
+};
+
+export default downloadAsImage;
Review comment:
and then remove this line
##########
File path: superset-frontend/src/dashboard/util/downloadAsImage.ts
##########
@@ -0,0 +1,61 @@
+/**
+ * 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 { MouseEvent, MouseEventHandler } from 'react';
+import domToImage from 'dom-to-image';
+import kebabCase from 'lodash/kebabCase';
+
+/**
+ * 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
+ */
+export const generateFileStem = (description: string, date = new Date()) => {
+ return `${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 fileStem name of generated file, without extension
+ * @param backgroundColor background color to apply to screenshot document
+ */
+export const downloadAsImage = (
Review comment:
you can change this to `export default const...`
##########
File path: superset-frontend/src/dashboard/util/downloadAsImage.ts
##########
@@ -0,0 +1,61 @@
+/**
+ * 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 { MouseEvent, MouseEventHandler } from 'react';
+import domToImage from 'dom-to-image';
+import kebabCase from 'lodash/kebabCase';
+
+/**
+ * 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
+ */
+export const generateFileStem = (description: string, date = new Date()) => {
+ return `${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 fileStem name of generated file, without extension
+ * @param backgroundColor background color to apply to screenshot document
+ */
+export const downloadAsImage = (
+ selector: string,
+ fileStem: string,
+ backgroundColor = '#f5f5f5',
+): MouseEventHandler => (event: MouseEvent) => {
+ const elementToPrint = event.currentTarget.closest(selector);
+
+ if (!elementToPrint) throw new Error('printable element not found');
Review comment:
instead of throwing an error, it might be better to show a warning
toast:
https://github.com/apache/incubator-superset/blob/master/superset-frontend/src/messageToasts/actions/index.js#L69
##########
File path: superset-frontend/src/dashboard/util/downloadAsImage.ts
##########
@@ -0,0 +1,61 @@
+/**
+ * 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 { MouseEvent, MouseEventHandler } from 'react';
+import domToImage from 'dom-to-image';
+import kebabCase from 'lodash/kebabCase';
+
+/**
+ * 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
+ */
+export const generateFileStem = (description: string, date = new Date()) => {
+ return `${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 fileStem name of generated file, without extension
+ * @param backgroundColor background color to apply to screenshot document
+ */
+export const downloadAsImage = (
+ selector: string,
+ fileStem: string,
+ backgroundColor = '#f5f5f5',
Review comment:
can we pull this color out into a constant? Or better yet, is it defined
somewhere in a theme file already as a constant to be reused here?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
