You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document appearance options for various Lens chart types (#2210)
Initially created this PR for the new **point visibility** and **table
density** options added in 9.1, but I noticed that appearance options
aren't even listed in the Lens docs. There's more to do to properly
document how to build each type of charts, but at least this PR adds
mentions for all appearance options I found. (All those behind the
:brush: icon)
@markov00 I did some minimal testing to come up with some of these
descriptions. Feel free to check/have them checked and edited by the
team. Would love your input to make sure that's accurate enough even
though this is quite minimal. Similarly, I added screenshots to help
explain the various "missing values" options, but feel free to suggest
better examples to showcase the differences between each option.
Find a direct link to the page preview in one of the automatic comments
below.
Note: I'll make a separate PR for 8.19 once we're happy with the content
here.
Closes: #1662Closes: #1663
---------
Co-authored-by: Mike Birnstiehl <[email protected]>
Copy file name to clipboardExpand all lines: explore-analyze/visualize/lens.md
+100-6Lines changed: 100 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -456,19 +456,113 @@ In the legend, click the field, then choose one of the following options:
456
456
***Filter out value** — Applies a filter that removes the field data from the visualization.
457
457
458
458
459
-
### Configure the visualization components[configure-the-visualization-components]
459
+
##Customize the visualization display[configure-the-visualization-components]
460
460
461
461
Each visualization type comes with a set of components that you access from the editor toolbar.
462
462
463
463
The following component menus are available:
464
464
465
-
***Visual options** — Specifies how to display area, line, and bar chart options. For example, you can specify how to display the labels in bar charts.
465
+
***Appearance** — Specifies how to display area, line, and bar chart options. For example, you can specify how to display the labels in bar charts.
466
466
***Labels** — Specifies how to display the labels for donut charts, pie charts, and treemaps.
467
467
***Legend** — Specifies how to display the legend. You can choose to display the legend inside or outside the visualization, truncate the legend values when they’re too long, and [select additional statistics to show](#customize-visualization-legend).
468
468
***Left axis**, **Bottom axis**, and **Right axis** — Specify how you want to display the chart axes. For example, add axis labels and change the orientation and bounds.
#### Customize a visualization legend [customize-visualization-legend]
472
+
When creating or editing a visualization, you can customize several appearance options. To do that, look for the {icon}`brush` icon.
473
+
474
+
These options can vary depending on the type of chart.
475
+
476
+
#### Area, Bar, and Line charts
477
+
478
+
**Area fill opacity**
479
+
: For **Area** charts. Opacity of the area fill. Defaults to `0.3`.
480
+
481
+
**Bar orientation**
482
+
: For **Bar** charts. Choose between **Horizontal** and **Vertical**.
483
+
484
+
**Line interpolation**
485
+
: For **Line** charts. Choose how to interpolate the line between data points from the available options: **Straight** (default), **Smooth**, and **Step**.
486
+
487
+
**Missing values**
488
+
: For **Area** and **Line** charts. Choose between **Hide**, **Zero**, **Linear**, **Last**, and **Next**. This option controls how gaps in data appear on the chart. By default, gaps are hidden.
489
+
490
+
_Missing values_ include empty buckets and metrics: Buckets without documents or metrics that returned `null` due to their operation and data content.
491
+
492
+
```{note}
493
+
You can only use this option when the **Include empty rows** option of the chart is enabled or when a metric produces a null bucket. For example, if a moving average finds empty buckets.
* **Zero**: Fill gaps by connecting starting and ending data points to zero.
501
+
502
+

503
+
504
+
* **Linear**: Fill gaps by connecting related starting and ending data points together with a direct line.
505
+
506
+

507
+
508
+
* **Last**: Fill gaps between data points with a horizontal or vertical line that uses the last ending point value, when available, to determine its position.
509
+
510
+

511
+
512
+
* **Next**: Fill gaps between data points with a horizontal or vertical line that uses the next starting point value, when available, to determine its position.
513
+
514
+

515
+
516
+
**End values**
517
+
: If you've chosen to show missing values, you can also decide to extend data series to the edge of the chart. By default, end values are hidden.
518
+
519
+
* **Hide**: Don't extend series to the edge of the chart.
520
+
* **Zero**: Extend series as zero to the edge of the chart.
521
+
* **Nearest**: Extend series with their first or last value to the edge of the chart.
522
+
523
+
**Show as dotted line**
524
+
: If you've chosen to show missing values, you can turn on this option to show gaps as a dotted line.
525
+
526
+
**Point visibility** {applies_to}`stack: ga 9.1` {applies_to}`serverless: ga`
527
+
: For **Area** and **Line** charts. Use this option to show or hide data points. Set to `Auto` by default: Points are visible unless the distance between them is too short.
528
+
529
+
#### Tables
530
+
531
+
**Density** {applies_to}`stack: ga 9.1` {applies_to}`serverless: ga`
532
+
: Make the table more or less compact. Choose between **Compact**, **Normal** (default), and **Expanded**.
533
+
534
+
**Max header cell lines**
535
+
: The maximum number of lines that header cells can span over. If the content exceeds this limit and is truncated, an ellipsis indicates it.
536
+
537
+
**Body cell lines**
538
+
: The fixed number of lines that body cells span over. If the content exceeds this limit and is truncated, an ellipsis indicates it.
539
+
540
+
**Paginate table**
541
+
: Turn on this option to paginate the table. Pagination shows when the table contains at least 10 items, and lets you define how many items to display per page. When turned off, you can scroll through all items.
542
+
543
+
#### Pie charts
544
+
545
+
**Donut hole**
546
+
: Display a **Small**, **Medium**, or **Large** hole at the center of the pie chart. Defaults to **None**.
547
+
548
+
#### Gauge charts
549
+
550
+
**Gauge shape**
551
+
: Define the shape of the gauge. Choose between **Linear**, **Minor arc**, **Major arc**, and **Circle**. When set to **Linear**, you can choose to display the chart horizontally or vertically.
552
+
553
+
#### Tag clouds
554
+
555
+
**Font size**
556
+
: Define the range of font sizes used in the tag cloud. The font size is based on the number of times a tag appears in the data.
557
+
558
+
**Orientation**
559
+
: Define the orientation of the tags. Choose **Single**, **Right angled**, and **Multiple**.
560
+
561
+
**Show label**
562
+
: Turn on this option to show a label for the tag cloud. You can define this label when defining the tags to show for the visualization, by customizing the **Name** field.
563
+
564
+
565
+
### Customize the visualization legend [customize-visualization-legend]
472
566
473
567
When creating or editing a visualization, you can customize the way the legend gets displayed, and the data it displays. To do that, look for the  icon.
474
568
@@ -522,7 +616,7 @@ For example, if the metric plotted in the chart is `Median(system.memory)` and t
522
616
:::
523
617
524
618
525
-
###Explore the data in Discover [explore-lens-data-in-discover]
619
+
## Explore the data in Discover [explore-lens-data-in-discover]
526
620
527
621
When your visualization includes one data view, you can open and explore the visualization data in **Discover**.
528
622
@@ -531,7 +625,7 @@ To get started, click **Explore data in Discover** in the toolbar.
531
625
For more information about exploring your data with **Discover**, check out [Discover](../discover.md).
532
626
533
627
534
-
###View the visualization data and requests [view-data-and-requests]
628
+
## View the visualization data and requests [view-data-and-requests]
535
629
536
630
To view the data included in the visualization and the requests that collected the data, use the **Inspector**.
537
631
@@ -548,7 +642,7 @@ To view the data included in the visualization and the requests that collected t
548
642
549
643
550
644
551
-
###Save and add the panel [save-the-lens-panel]
645
+
## Save and add the panel [save-the-lens-panel]
552
646
553
647
Save the panel to the **Visualize Library** and add it to the dashboard, or add it to the dashboard without saving.
0 commit comments