[Lens] Enable read only editor mode to inspect panel's configuration by dej611 · Pull Request #208554 · elastic/kibana

dej611 · 2025-01-28T15:03:25Z

Summary

This PR enables the Read Only editor feature for Lens panels, who will let users in read mode (no matter broader permissions) to explore the visualization configuration.

Short list of changes:

Edit action tooltip now changed from Edit {name} into Edit {name} configuration
isEditingEnabled takes into account now also Managed state of both visualization and parentApi
A new showConfigAction has been created to show users without write capabilities the current Lens chart configuration
Edit inline flyout title changed to Configuration no matter the context (this has impact also on creation, i.e. ES|QL new panel)
Within the configuration panel the Visualization configuration section title has changed to Visualization layers
When the panel is in read-only mode a callout is shown and no editing/saving action is shown

UX guidance

Here's some guidance inherited by @MichaelMarcialis comment about the different flows based on user permissions.

Read/write UX

No change

Read-only UX

The glasses icon's tooltip shows as "View visualization configuration"?
Flyout title should simply be "Configuration"
On second read, "Read only panel changes will revert after closing" sounds a bit odd. Can we change to "Read-only: Changes will be reverted on close"? Also, can we change the callout icon to glasses?
Change "Visualization configuration" accordion title to "Visualization layers".

Screenshots

Read-only UX

If user has no write permissions the glasses icon is shown for the action:

And the panel is shown with the read only callout with no edit buttons:

For a Managed dashboard the behaviour is the same as above (for the user there's no difference between regular or managed dashboard, just wanted to report here both cases):

Checklist

Unit or functional tests were updated or added to match the most common scenarios

elasticmachine · 2025-01-28T15:03:29Z

Pinging @elastic/kibana-visualizations (Team:Visualizations)

dej611 · 2025-01-28T15:08:52Z

+  public getDisplayName({ embeddable }: EmbeddableApiContext) {
+    if (!isApiCompatible(embeddable)) throw new IncompatibleActionError();
+    return i18n.translate('presentationPanel.action.showConfigPanel.displayName', {
+      defaultMessage: 'Configuration',


I've been discussing offline with @MichaelMarcialis about naming here, and there's this idea to change the Edit action label too into something on the line with this:

Configuration => show

Configure => edit

WDYT @elastic/kibana-presentation ?

I think that works pretty well! @wajihaparvez FYI.

Good for me, can we also change the Edit Lens to this Configure name?

That's the proposal @markov00 . I'll create a follow up PR for that so we could discuss it more clearly.

Just jumping in on this. I think these labels are a good idea, but is it possible to say View configuration for "show" instead of just Configuration?

nreese

I am not sure a new action and interfaces are needed. Instead of having separate actions for edit and view - how about just a single action for viewing panel configuration. Then, the panel configuration view can either show a read-only mode or edit mode based on container view mode and user permissions.

dej611 · 2025-01-29T09:04:11Z

I am not sure a new action and interfaces are needed. Instead of having separate actions for edit and view - how about just a single action for viewing panel configuration. Then, the panel configuration view can either show a read-only mode or edit mode based on container view mode and user permissions.

That was my initial idea too, and partially this can be found also in the Lens embeddable code, but after tweaking too many things around the edit action, I've decided a distinct action was a better approach.
In particular the worst part was the compatibility check in the edit action would become very complex to take into account too many factors who do not strictly belong to it.

ThomThomson · 2025-01-29T13:51:28Z

@nreese in regards to multiple actions vs one action, I was thinking we would consolidate those later as part of our inline editing project - i.e. when we merge panel settings and this editor.

dej611 · 2025-02-12T11:20:50Z

Put on hold for the moment to discuss a bit the edit behaviour for author users.

MichaelMarcialis · 2025-02-18T18:28:48Z

Quick recap from today's sync with @dej611, @ThomThomson, @ghudgins:

Read-only users

View mode: Continue to offer the "View visualization configuration" action with glasses icon on visualization panels. These users are allowed to view/fiddle with the configuration options, but not apply them.

Read/write users

View mode: No option to view or edit the configuration is offered for these users in view mode.
Edit mode: Continue to offer the "Edit visualization configuration" action with pencil icon. These users are allowed to apply edits made to the configuration.

nreese · 2025-03-06T18:19:45Z

+  }
+
+  /**
+   * The execute method contains a compatibility check with a wider scope


This comment can be removed since its no longer valid

You are right, removed it with d9d56e5

nreese

kibana-presentation changes LGTM
code review only

…ctions/show_config_panel_action/show_config_panel_action.ts

markov00

Code and functionality are fine for me! LGTM

markov00 · 2025-03-10T14:15:13Z

                  <h5>
                    {i18n.translate('xpack.lens.config.visualizationConfigurationLabel', {
-                      defaultMessage: 'Visualization configuration',
+                      defaultMessage: 'Visualization layers',


I don't agree much on this change, this works fine with cartesian charts, but doesn't have much sense for all the other charts that only have a single layer

No strong opinion here. I can see as a flexible wording for a plugin-first interface, which could potentially can hit any chart type (i.e. annotations for pie charts?). But pragmatically I see your point.
The change was triggered initially by Michael comment here: https://github.com/elastic/kibana/pull/208554/files/34ff73b5fdab54a0e798ddbdd09203b7e9401ee8#r1939693883 . I'll be fine with anything @gvnmagni or @wajihaparvez agree.

I would personally go with the most agnostic word here so that we avoid incongruences with different kind of charts. If we want to simplify a bit, even just "Configuration" would work

@markov00 made me notice that we have a Configuration title above that makes this redundant. What if we use "Visualisation Parameters"? I am afraid we need you here @wajihaparvez I am honestly struggling with words :)

Thanks for looping me in!
I agree with @gvnmagni that we should use something with a broader meaning so that it applies to all visualizations. I really like "Visualization parameters". We could also consider "Visualization settings".
Just a note that whichever phrase we end up using, it should be in sentence case so only the first word should be capitalized, e.g. "Visualization parameters"

I'll address it with Visualization parameters for now.

…dit_on_the_fly/lens_configuration_flyout.tsx

elasticmachine · 2025-03-14T10:18:57Z

💚 Build Succeeded

Buildkite Build
Commit: 7077e65

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`aiops`	603	604	+1
`apm`	1890	1891	+1
`cases`	1014	1015	+1
`controls`	353	354	+1
`dashboard`	638	639	+1
`dashboardEnhanced`	87	88	+1
`dataVisualizer`	747	748	+1
`discover`	1208	1209	+1
`discoverEnhanced`	48	49	+1
`embeddable`	82	83	+1
`embeddableEnhanced`	46	47	+1
`imageEmbeddable`	133	134	+1
`infra`	1453	1454	+1
`inputControlVis`	90	91	+1
`lens`	1527	1528	+1
`links`	108	109	+1
`maps`	1253	1254	+1
`ml`	2419	2420	+1
`presentationPanel`	117	120	+3
`reporting`	148	149	+1
`securitySolution`	7081	7082	+1
`slo`	1126	1127	+1
`synthetics`	1215	1216	+1
`urlDrilldown`	50	51	+1
`visTypeMarkdown`	64	65	+1
`visTypeVega`	538	539	+1
`visualizations`	471	472	+1
total			+29

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/presentation-publishing`	205	208	+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`lens`	1.5MB	1.5MB	+715.0B
`presentationPanel`	36.4KB	37.5KB	+1.1KB
total			+1.8KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`lens`	58.8KB	58.8KB	-12.0B
`presentationPanel`	10.9KB	11.1KB	+239.0B
total			+227.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/presentation-publishing`	242	247	+5

History

💚 Build #283829 succeeded f9e9cf6
💚 Build #281734 succeeded daabf8a
💔 Build #281696 failed d9d56e5
💚 Build #281145 succeeded dc028c6
💚 Build #280383 succeeded 54deb76
💔 Build #280318 failed 7662660

@MichaelMarcialis

…lastic#208554) ## Summary Fixes elastic#106553 This PR enables the Read Only editor feature for Lens panels, who will let users in read mode (no matter broader permissions) to explore the visualization configuration. Short list of changes: * Edit action tooltip now changed from `Edit {name}` into `Edit {name} configuration` * `isEditingEnabled` takes into account now also `Managed` state of both visualization and `parentApi` * A new `showConfigAction` has been created to show users without write capabilities the current Lens chart configuration * Edit inline flyout title changed to `Configuration` no matter the context (this has impact also on creation, i.e. ES|QL new panel) * Within the configuration panel the `Visualization configuration` section title has changed to `Visualization layers` * When the panel is in read-only mode a callout is shown and no editing/saving action is shown ## UX guidance Here's some guidance [inherited by @MichaelMarcialis comment](elastic#208554 (comment)) about the different flows based on user permissions. **Read/write UX** * No change **Read-only UX** * The glasses icon's tooltip shows as "View visualization configuration"? * Flyout title should simply be "Configuration" * On second read, "Read only panel changes will revert after closing" sounds a bit odd. Can we change to "Read-only: Changes will be reverted on close"? Also, can we change the callout icon to glasses? * Change "Visualization configuration" accordion title to "Visualization layers". ### Screenshots **Read-only UX** If user has no write permissions the `glasses` icon is shown for the action: ![Screenshot 2025-02-05 at 14 25 15](https://github.com/user-attachments/assets/64d23f00-82f7-4e90-bcef-29a18ae7116a) And the panel is shown with the `read only` callout with no edit buttons: ![Screenshot 2025-02-05 at 14 25 23](https://github.com/user-attachments/assets/39782a01-5d61-4498-9f50-4a3c7a6bf35d) For a `Managed` dashboard the behaviour is the same as above (for the user there's no difference between regular or managed dashboard, just wanted to report here both cases): ![Screenshot 2025-02-05 at 14 25 34](https://github.com/user-attachments/assets/0b9aebd5-96db-4140-8e85-b08a9720ae33) ![Screenshot 2025-02-05 at 14 25 41](https://github.com/user-attachments/assets/d3487aa8-af9c-4b73-80fc-8ee2489f2f90) ### Checklist - [x] [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 --------- Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com> Co-authored-by: Michael Marcialis <michael.l.marcialis@gmail.com>

@MichaelMarcialis

…lastic#208554) ## Summary Fixes elastic#106553 This PR enables the Read Only editor feature for Lens panels, who will let users in read mode (no matter broader permissions) to explore the visualization configuration. Short list of changes: * Edit action tooltip now changed from `Edit {name}` into `Edit {name} configuration` * `isEditingEnabled` takes into account now also `Managed` state of both visualization and `parentApi` * A new `showConfigAction` has been created to show users without write capabilities the current Lens chart configuration * Edit inline flyout title changed to `Configuration` no matter the context (this has impact also on creation, i.e. ES|QL new panel) * Within the configuration panel the `Visualization configuration` section title has changed to `Visualization layers` * When the panel is in read-only mode a callout is shown and no editing/saving action is shown ## UX guidance Here's some guidance [inherited by @MichaelMarcialis comment](elastic#208554 (comment)) about the different flows based on user permissions. **Read/write UX** * No change **Read-only UX** * The glasses icon's tooltip shows as "View visualization configuration"? * Flyout title should simply be "Configuration" * On second read, "Read only panel changes will revert after closing" sounds a bit odd. Can we change to "Read-only: Changes will be reverted on close"? Also, can we change the callout icon to glasses? * Change "Visualization configuration" accordion title to "Visualization layers". ### Screenshots **Read-only UX** If user has no write permissions the `glasses` icon is shown for the action: ![Screenshot 2025-02-05 at 14 25 15](https://github.com/user-attachments/assets/64d23f00-82f7-4e90-bcef-29a18ae7116a) And the panel is shown with the `read only` callout with no edit buttons: ![Screenshot 2025-02-05 at 14 25 23](https://github.com/user-attachments/assets/39782a01-5d61-4498-9f50-4a3c7a6bf35d) For a `Managed` dashboard the behaviour is the same as above (for the user there's no difference between regular or managed dashboard, just wanted to report here both cases): ![Screenshot 2025-02-05 at 14 25 34](https://github.com/user-attachments/assets/0b9aebd5-96db-4140-8e85-b08a9720ae33) ![Screenshot 2025-02-05 at 14 25 41](https://github.com/user-attachments/assets/d3487aa8-af9c-4b73-80fc-8ee2489f2f90) ### Checklist - [x] [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 --------- Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com> Co-authored-by: Michael Marcialis <michael.l.marcialis@gmail.com>

dej611 added 14 commits January 28, 2025 11:54

💄 Enable read only mode for the flyout

b28b798

✅ Add tests

5f78ceb

✨ New show config action

26f96b6

✅ Add tests

2a67834

✨ Enabled read only api

7c3a49d

✅ Add tests

6c6f7f3

🔧 Add read only typeguards

88bea79

✨ Add action complementary functions

1ab9a8a

🔧 Export new action

ff5cdcd

✨ Enable show config action on hover quick actions

9536d39

♻️ Refactor edit/show logic

233ae77

✅ Add tests

4d5f159

💄 Change icon to wrench

ba66538

✨ Enable read only panels in embeddable

34ff73b

dej611 added Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// Feature:Lens release_note:feature Makes this part of the condensed release notes backport:prev-major labels Jan 28, 2025

dej611 requested review from a team as code owners January 28, 2025 15:03

dej611 commented Jan 28, 2025

View reviewed changes

Comment thread ...presentation_panel/public/panel_actions/show_config_panel_action/show_config_panel_action.ts Outdated

dej611 commented Jan 28, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into fix/106553

8fa0749

nreese reviewed Jan 28, 2025

View reviewed changes

dej611 added 2 commits January 29, 2025 12:01

🏷️ Fix types

8980e3c

🏷️ Fix type

af5eb85

🔧 Updated limits

903d98b

🔥 Removed unused translations

98af290

Merge remote-tracking branch 'upstream/main' into fix/106553

4ae9ab1

dej611 added 5 commits March 3, 2025 11:20

Merge remote-tracking branch 'upstream/main' into fix/106553

22f90b3

♻️ Sync with new changes

ba46222

👌 Integrate feedback

c3df978

✅ Adapt tests for new API

830429c

✅ Add FTR test

7662660

dej611 requested a review from ThomThomson March 3, 2025 13:41

dej611 and others added 3 commits March 3, 2025 16:39

Merge remote-tracking branch 'upstream/main' into fix/106553

139ca11

✅ Fix tests

54deb76

Merge branch 'main' into fix/106553

dc028c6

nreese reviewed Mar 6, 2025

View reviewed changes

nreese approved these changes Mar 6, 2025

View reviewed changes

dej611 commented Mar 7, 2025

View reviewed changes

Comment thread ...presentation_panel/public/panel_actions/show_config_panel_action/show_config_panel_action.ts Outdated

dej611 added 2 commits March 7, 2025 10:03

Update src/platform/plugins/private/presentation_panel/public/panel_a…

d9d56e5

…ctions/show_config_panel_action/show_config_panel_action.ts

Merge branch 'main' into fix/106553

daabf8a

markov00 approved these changes Mar 10, 2025

View reviewed changes

dej611 commented Mar 13, 2025

View reviewed changes

Comment thread ...m/plugins/shared/lens/public/app_plugin/shared/edit_on_the_fly/lens_configuration_flyout.tsx Outdated

dej611 and others added 2 commits March 13, 2025 17:26

Update x-pack/platform/plugins/shared/lens/public/app_plugin/shared/e…

f9e9cf6

…dit_on_the_fly/lens_configuration_flyout.tsx

Merge remote-tracking branch 'upstream/main' into fix/106553

7077e65

dej611 merged commit 07c7450 into elastic:main Mar 14, 2025

kibanamachine added the v9.1.0 label Mar 14, 2025

florent-leborgne mentioned this pull request Jun 10, 2025

[Lens] Read-only mode improvements elastic/docs-content#1666

Closed

teresaalvarezsoler mentioned this pull request Sep 23, 2025

Users need to see charts configurations in "write-protected" dashboards #236097

Closed

awahab07 mentioned this pull request Jan 20, 2026

[Lens] Allow read only view for users with write permissions but having no write access to the dashboard #247746

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lens] Enable read only editor mode to inspect panel's configuration#208554

[Lens] Enable read only editor mode to inspect panel's configuration#208554
dej611 merged 52 commits intoelastic:mainfrom
dej611:fix/106553

dej611 commented Jan 28, 2025 •

edited

Loading

elasticmachine commented Jan 28, 2025

Uh oh!

dej611 Jan 28, 2025 •

edited

Loading

ThomThomson Jan 28, 2025

markov00 Jan 29, 2025

dej611 Jan 29, 2025

wajihaparvez Feb 4, 2025

nreese left a comment

dej611 commented Jan 29, 2025

ThomThomson commented Jan 29, 2025

dej611 commented Feb 12, 2025

MichaelMarcialis commented Feb 18, 2025 •

edited

Loading

nreese Mar 6, 2025

dej611 Mar 7, 2025

nreese left a comment

Uh oh!

markov00 left a comment

markov00 Mar 10, 2025

dej611 Mar 10, 2025

gvnmagni Mar 11, 2025

gvnmagni Mar 11, 2025

wajihaparvez Mar 13, 2025

dej611 Mar 13, 2025

Uh oh!

elasticmachine commented Mar 14, 2025

API count

Labels

11 participants

Conversation

dej611 commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

UX guidance

Screenshots

Checklist

elasticmachine commented Jan 28, 2025

Uh oh!

dej611 Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nreese left a comment

Choose a reason for hiding this comment

dej611 commented Jan 29, 2025

ThomThomson commented Jan 29, 2025

dej611 commented Feb 12, 2025

MichaelMarcialis commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Read-only users

Read/write users

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nreese left a comment

Choose a reason for hiding this comment

Uh oh!

markov00 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Mar 14, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

Labels

11 participants

dej611 commented Jan 28, 2025 •

edited

Loading

dej611 Jan 28, 2025 •

edited

Loading

MichaelMarcialis commented Feb 18, 2025 •

edited

Loading