[Lens] Generating PDF and PNG exports directly from Lens #130438
Assignees
Labels
enhancement
New value added to drive a business result
Feature:Lens
impact:needs-assessment
Product and/or Engineering needs to evaluate the impact of the change.
Team:Visualizations
Visualization editors, elastic-charts and infrastructure
Projects
Comments
ghudgins
added
enhancement
|
Pinging @elastic/kibana-vis-editors @elastic/kibana-vis-editors-external (Team:VisEditors) |
49 tasks
stratoula
added
the
impact:needs-assessment
dej611
added a commit
that referenced
this issue
Apr 12, 2023
## Summary Fixes #130438 This PR introduces the PNG/PDF reporting feature within Lens editor. **Note** each reporting tasks is generating a shortURL SO in addition of the reporting job SO. There's a reusing mechanism but it applies only to the same config within the same session. * [x] Enable reporting for ~~`lens_visualization` type~~ `lens` type * [x] Introduce disabled state within the reporter logic * [x] Extends the logic to support the custom URL types in Lens * [x] Make reporting list page to support `lens_visualization` object type * migrated `lens_visualization` to `lens` and used the app icon * [x] Extends the custom CSS styling to handle specific Lens editor layout * [x] Introduce logic for `renderComplete` within the Lens editor * [x] Loading logic * [x] Trigger `renderComplete` event for the right node * [x] Add `.hide-for-sharing` class where needed * [x] Add the `.stretch-for-sharing` where needed * Improve layout settings to have a better fit of some charts * Maybe this can be addressed as separate issue? * Check the `renderComplete` for the RegionMap external plugin => separate issue * Write tests * [x] Functional tests Reporting page: <img width="1255" alt="Screenshot 2023-03-24 at 15 25 12" src="https://user-images.githubusercontent.com/924948/227552385-1b52a0ae-8902-4972-acf3-323093a7b840.png"> **Note**: at the moment the reporting name follows the CSV naming convention of `unsaved` for unsaved Lens visualizations. The legacy Agg-based editor uses instead a namming pattern as follow: `Visualization <timestamp>.png`. Final results: | Chart type | PNG result | | ------ | ----- | | Stacked bar chart |  | | Vertical bar chart |  | | Horizontal stacked bar chart |  | | Horizontal bar chart |  | | Datatable |  | | Horizontal gauge |  | | Vertical gauge |  | | Legacy metric |  | | Metric |  | | Metric with breakdown |  | | Area chart |  | | Line chart |  | | Bar chart with annotation + reference lines |  | | Heatmap |  | | Donut chart |  | | Pie chart |  | | Treemap |  | | Mosaic |  | | Waffle |  | | Region Map |  | ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co> Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the feature: Make the reporting features available from Lens directly
Describe a specific use case for the feature: Today a user is making a dashboard to download a single Lens visualization. For convenience, they would prefer to download the single visualization directly without having to do the extra step. This would maximize the space in the export for the desired visualization.
The text was updated successfully, but these errors were encountered: