[Lens] Add some more documentation for dynamic coloring #101369

dej611 · 2021-06-04T10:52:17Z

Summary

Fixes #100880

Adds some Color continuity explanation

Adds some troubleshooting for edge cases when using dynamic coloring

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials

elasticmachine · 2021-06-04T10:52:19Z

Pinging @elastic/kibana-app (Team:KibanaApp)

flash1293 · 2021-06-04T11:18:20Z

docs/user/dashboard/lens.asciidoc

+
+[float]
+[[why-my-value-is-not-of-the-right-color-using-dynamic-coloring]]
+===== Why mt value is not of the right color when using dynamic coloring?


Are we using the term "dynamic coloring" anywhere else? I don't think it's self-explanatory

Fair point. I assumed here it will be in the release notes.
Probably I'd suggest then datatable coloring, wdyt?

Sounds good to me. Other things that would work IMHO:

conditional coloring

value-based coloring

table cell coloring

dej611 · 2021-06-07T08:16:58Z

@elasticmachine merge upstream

dej611 · 2021-06-07T12:52:51Z

Used the value-based coloring name as for now, as it can also apply to future other visualizations.

dej611 · 2021-06-09T15:43:24Z

@elasticmachine merge upstream

KOTungseth

I made a few grammatical and structure suggestions, but otherwise, LGTM!

KOTungseth · 2021-06-10T17:25:19Z

docs/user/dashboard/lens.asciidoc

+
+[float]
+[[why-my-value-is-not-of-the-right-color-using-value-based-coloring]]
+===== Why mt value is not of the right color when using value-based coloring?


Suggested change

===== Why mt value is not of the right color when using value-based coloring?

===== Why is my value the incorrect color when using value-based coloring?

docs/user/dashboard/lens.asciidoc

KOTungseth · 2021-06-10T17:26:44Z

docs/user/dashboard/lens.asciidoc

+There could be various reason for a specific value in the table to have a different color than expected.
+
+Here's a short list of few different aspects to check:
+* Make sure the value falls within the desidered color stop value defined in the panel. Color stop values are "inclusive".


I'm a little out of my realm here. Do users know what "inclusive" means when it comes to color stop values?

Inclusivity, in this context refers to "ranges", so I would expect they are. I do not have a strong opinion here on the terminology, so if anything better comes I'm open.

docs/user/dashboard/lens.asciidoc

KOTungseth · 2021-06-10T17:28:04Z

docs/user/dashboard/lens.asciidoc

+
+* Make sure to have the right value precision setup: value formatters could round up or down numeric values.
+
+* Make sure the right color continuity option is selected: if the number is below the first color stop value a continuity of type `Below` or `Above and below range` is required


Suggested change

* Make sure the right color continuity option is selected: if the number is below the first color stop value a continuity of type `Below` or `Above and below range` is required

* Make sure the right color continuity option is selected: if the number is below the first color stop value, a continuity of type `Below` or `Above and below range` is required.

docs/user/dashboard/lens.asciidoc

KOTungseth · 2021-06-10T17:29:48Z

docs/user/dashboard/lens.asciidoc

+
+** If a `Number` custom configuration is used, check the color stops value are covering the current data range.
+
+** If a `Percent` configuration is used, when the data range changes this has an effect on colors displayed.


Suggested change

** If a `Percent` configuration is used, when the data range changes this has an effect on colors displayed.

** If a `Percent` configuration is used, and the data range changes, the colors displayed are affected.

x-pack/plugins/lens/public/shared_components/coloring/palette_configuration.tsx

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

…configuration.tsx Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

dej611 · 2021-06-15T08:37:51Z

@elasticmachine merge upstream

kibanamachine · 2021-06-15T12:47:43Z

💚 Build Succeeded

Metrics [docs]

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.4MB	1.4MB	+462.0B

History

💚 Build #131225 succeeded a9dd5a1
💔 Build #131221 failed 43faf14
💔 Build #131224 failed 0359ab3
💚 Build #130190 succeeded 4f303b4
💚 Build #129470 succeeded 4b3f4d9

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

flash1293

LGTM

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-06-17T08:29:57Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…egrations-to-global-search * 'master' of github.com:elastic/kibana: (46 commits) [Lens] Add some more documentation for dynamic coloring (elastic#101369) hide not searchable results when no term (elastic#102401) [Lens] Fix Formula functional test with multiple suggestions (elastic#102378) Fix trusted apps modified by field displayed as a date field (elastic#102377) [Lens] Docs for time shift (elastic#102048) update readme of logs-metrics-ui (elastic#101968) Refactor observability plugin breadcrumbs (elastic#102290) [Index Patterns] Move rollup config to index pattern management v2 (elastic#102285) [Security Solution][Endpoint] Isolate Action should only be available to Platinum+ licenses (elastic#102374) [build] Updates Ironbank templates (elastic#102407) Update security best practices document (elastic#100814) [Enterprise Search] Set up initial KibanaPageTemplate (elastic#102170) [Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs (elastic#102278) [DOCS] Updating Elastic Security Overview topic (elastic#101922) [Uptime] refactor Synthetics Integration package UI (elastic#102080) [Task Manager] Log at different levels based on the state (elastic#101751) [APM] Fixing time comparison types (elastic#101423) [RAC] Update alert documents in lifecycle rule type helper (elastic#101598) [ML] Functional tests - fix and re-activate alerting flyout test (elastic#102368) [Reporting] remove unused reference to path.data config (elastic#102267) ... # Conflicts: # x-pack/plugins/fleet/kibana.json

…02470) Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Marco Liberati <dej611@users.noreply.github.com> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

dej611 added 3 commits June 4, 2021 12:18

📝 Add some continuity explanation

720d7a6

📝 Add some faq about dynamic coloring

fd88b1f

📝 revisit copy

6166ebe

dej611 added Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Feature:Lens v7.14.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Jun 4, 2021

dej611 requested review from KOTungseth and a team June 4, 2021 10:52

flash1293 reviewed Jun 4, 2021

View reviewed changes

kibanamachine and others added 2 commits June 7, 2021 04:17

Merge branch 'master' into lens/coloring-more-doc

f09064d

👌 Rename question

4b3f4d9

Merge branch 'master' into lens/coloring-more-doc

4f303b4

KOTungseth approved these changes Jun 10, 2021

View reviewed changes

dej611 and others added 6 commits June 15, 2021 10:35

Update docs/user/dashboard/lens.asciidoc

2acdf52

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Update docs/user/dashboard/lens.asciidoc

6185cf3

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Update docs/user/dashboard/lens.asciidoc

43faf14

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Update docs/user/dashboard/lens.asciidoc

a594405

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Update docs/user/dashboard/lens.asciidoc

08414b9

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Update x-pack/plugins/lens/public/shared_components/coloring/palette_…

0359ab3

…configuration.tsx Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

kibanamachine and others added 2 commits June 15, 2021 04:37

Merge branch 'master' into lens/coloring-more-doc

a9dd5a1

👌 Integrated feedback

f27c3f2

dej611 requested a review from flash1293 June 15, 2021 12:51

dej611 enabled auto-merge (squash) June 17, 2021 08:12

dej611 disabled auto-merge June 17, 2021 08:12

flash1293 approved these changes Jun 17, 2021

View reviewed changes

dej611 merged commit 7f62553 into elastic:master Jun 17, 2021

dej611 deleted the lens/coloring-more-doc branch June 17, 2021 08:27

kibanamachine mentioned this pull request Jun 17, 2021

[7.x] [Lens] Add some more documentation for dynamic coloring (#101369) #102470

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lens] Add some more documentation for dynamic coloring #101369

[Lens] Add some more documentation for dynamic coloring #101369

dej611 commented Jun 4, 2021

elasticmachine commented Jun 4, 2021

flash1293 Jun 4, 2021

dej611 Jun 7, 2021

flash1293 Jun 7, 2021

dej611 commented Jun 7, 2021

dej611 commented Jun 7, 2021

dej611 commented Jun 9, 2021

KOTungseth left a comment

KOTungseth Jun 10, 2021

KOTungseth Jun 10, 2021

dej611 Jun 15, 2021

KOTungseth Jun 10, 2021

KOTungseth Jun 10, 2021

dej611 commented Jun 15, 2021

kibanamachine commented Jun 15, 2021

flash1293 left a comment

kibanamachine commented Jun 17, 2021

	===== Why mt value is not of the right color when using value-based coloring?
	===== Why is my value the incorrect color when using value-based coloring?


		* Make sure to have the right value precision setup: value formatters could round up or down numeric values.

		* Make sure the right color continuity option is selected: if the number is below the first color stop value a continuity of type `Below` or `Above and below range` is required


		** If a `Number` custom configuration is used, check the color stops value are covering the current data range.

		** If a `Percent` configuration is used, when the data range changes this has an effect on colors displayed.

[Lens] Add some more documentation for dynamic coloring #101369

[Lens] Add some more documentation for dynamic coloring #101369

Conversation

dej611 commented Jun 4, 2021

Summary

Checklist

elasticmachine commented Jun 4, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dej611 commented Jun 7, 2021

dej611 commented Jun 7, 2021

dej611 commented Jun 9, 2021

KOTungseth 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

dej611 commented Jun 15, 2021

kibanamachine commented Jun 15, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

History

flash1293 left a comment

Choose a reason for hiding this comment

kibanamachine commented Jun 17, 2021

💚 Backport successful