[8.6] Adds the VisEditor docs for 8.6 (#146471) (#147289)

# Backport

This will backport the following commits from `main` to `8.6`:
- [Adds the VisEditor docs for 8.6
(#146471)](https://github.com/elastic/kibana/pull/146471)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Kaarina
Tungseth","email":"kaarina.tungseth@elastic.co"},"sourceCommit":{"committedDate":"2022-12-08T20:18:03Z","message":"Adds
the VisEditor docs for 8.6 (#146471)\n\n## Summary\r\n\r\nAdds the 8.6
for the following:\r\n\r\n- #140878, #143946 and
#142187\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/tsvb.html#edit-visualizations-in-lens)\r\n\r\n-
#142936, #142561, #143820, and
#142838\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/add-aggregation-based-visualization-panels.html#edit-agg-based-visualizations-in-lens)\r\n\r\n-
#138732\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#change-the-fields)\r\n\r\n-
#141626 and #141615\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#add-annotations)\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Stratoula Kalafateli
<stratoula1@gmail.com>","sha":"f918a3745be3badff9cf05950db61d7f47877961","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v8.6.0","v8.7.0"],"number":146471,"url":"https://github.com/elastic/kibana/pull/146471","mergeCommit":{"message":"Adds
the VisEditor docs for 8.6 (#146471)\n\n## Summary\r\n\r\nAdds the 8.6
for the following:\r\n\r\n- #140878, #143946 and
#142187\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/tsvb.html#edit-visualizations-in-lens)\r\n\r\n-
#142936, #142561, #143820, and
#142838\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/add-aggregation-based-visualization-panels.html#edit-agg-based-visualizations-in-lens)\r\n\r\n-
#138732\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#change-the-fields)\r\n\r\n-
#141626 and #141615\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#add-annotations)\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Stratoula Kalafateli
<stratoula1@gmail.com>","sha":"f918a3745be3badff9cf05950db61d7f47877961"}},"sourceBranch":"main","suggestedTargetBranches":["8.6"],"targetPullRequestStates":[{"branch":"8.6","label":"v8.6.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/146471","number":146471,"mergeCommit":{"message":"Adds
the VisEditor docs for 8.6 (#146471)\n\n## Summary\r\n\r\nAdds the 8.6
for the following:\r\n\r\n- #140878, #143946 and
#142187\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/tsvb.html#edit-visualizations-in-lens)\r\n\r\n-
#142936, #142561, #143820, and
#142838\r\n\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/add-aggregation-based-visualization-panels.html#edit-agg-based-visualizations-in-lens)\r\n\r\n-
#138732\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#change-the-fields)\r\n\r\n-
#141626 and #141615\r\n
\r\n[Doc\r\npreview](https://kibana_146471.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#add-annotations)\r\n\r\nCo-authored-by:
Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Stratoula Kalafateli
<stratoula1@gmail.com>","sha":"f918a3745be3badff9cf05950db61d7f47877961"}}]}]
BACKPORT-->

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
This commit is contained in:
Kibana Machine 2022-12-08 15:35:37 -05:00 committed by GitHub
parent d8230efff1
commit d6e4afa691
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 70 additions and 9 deletions

View file

@ -191,6 +191,29 @@ TIP: Aggregation-based panels support a maximum of three *Split series*.
[role="screenshot"]
image:images/aggBased_barChartTutorial2_8.4.png[Bar chart with sample logs data]
[float]
[[edit-agg-based-visualizations-in-lens]]
==== Open and edit aggregation-based visualizations in Lens
When you open aggregation-based visualizations in *Lens*, all configuration options appear in the *Lens* visualization editor.
You can open the following aggregation-based visualizations in *Lens*:
* Area
* Data table
* Gauge
* Goal
* Heat map
* Horizontal bar
* Line
* Metric
* Pie
* Vertical bar
To get started, click *Edit visualization in Lens* in the toolbar.
For more information, check out <<lens,Create visualizations with Lens>>.
[float]
[[save-the-aggregation-based-panel]]
===== Save and add the panel

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

View file

@ -43,7 +43,7 @@ Edit and delete.
. To delete a field, close the configuration options, then click *X* next to the field.
. To clone a layer, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to duplicate Lens visualization layers] in the layer pane, then select *Duplicate layer*.
. To duplicate a layer, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to duplicate Lens visualization layers] in the layer pane, then select *Duplicate layer*.
. To clear the layer configuration, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to clear Lens visualization layers] in the layer pane, then select *Clear layer*.
@ -56,6 +56,8 @@ TIP: You can manually apply the changes you make, which is helpful when creating
Change the fields list to display a different {data-source}, different time range, or add your own fields.
* To create a visualization with fields in a different {data-source}, open the {data-source} dropdown, then select the {data-source}.
+
For more information about {data-sources}, refer to <<data-views>>.
* If the fields list is empty, change the <<set-time-filter,time filter>>.
@ -192,24 +194,52 @@ Note: this option is not available for mosaic charts.
preview::[]
Annotations allow you to call out specific points in your visualizations that are important, such as a major change in the data. You can add annotations for any {data-source}, add text and icons, specify the line format and color, and more.
Annotations allow you to call out specific points in your visualizations that are important, such as significant changes in the data. You can add annotations for any {data-source}, add text and icons, specify the line format and color, and more.
[role="screenshot"]
image::images/lens_annotations_8.2.0.png[Lens annotations]
Annotations support two placement types:
* *Static date* &mdash; Displays annotations for specific times or time ranges.
* *Custom query* &mdash; Displays annotations based on custom {es} queries. For detailed information about queries, check <<semi-structured-search>>.
Create the annotation layer.
. In the layer pane, click *Add layer > Annotations*.
. Select the {data-source}.
. Select the {data-source} for the annotation.
. To open the annotation options, click *Event*.
. From the fields list, drag a field to the *Add an annotation* field.
. Specify the *Annotation date*.
. To use global filters in the annotation, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the annotations layer], then select *Keep global filters* from the dropdown.
. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* time range.
Create static annotations.
. Select *Static date*.
. In the *Annotation date* field, click image:images/lens_annotationDateIcon_8.6.0.png[Annodation date icon in Lens], then select the date.
. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* dates.
Create custom query annotations.
. Select *Custom query*.
. Enter the *Annotation query* for the data you want to display.
+
For detailed information about queries and examples, check <<semi-structured-search>>.
. Select the *Target date field*.
Specify the annotation appearance.
. Enter the annotation *Name*.
. Change the *Appearance* options for how you want the annotation to display.
. Change the *Appearance* options for how you want the annotation to display on the visualization.
. If you created a custom query annotation, click *Add field* to add a field to the annotation tooltip.
. To close, click *X*.
@ -240,7 +270,7 @@ image::images/lens_referenceLine_7.16.png[Lens drag and drop focus state]
[[filter-the-data]]
==== Apply filters
You can use the <<semi-structured-search, KQL query bar>> to focus on a known set of data for the entire visualization, or use the filter options from the layer pane or legend.
You can use the <<semi-structured-search, query bar>> to create queries that filter all the data in a visualization, or use the layer pane and legend filters to apply filters based on field values.
[float]
[[filter-with-the-function]]

View file

@ -136,7 +136,15 @@ The *Markdown* visualization supports Markdown with Handlebar (mustache) syntax
[[edit-visualizations-in-lens]]
==== Open and edit TSVB visualizations in Lens
Open and edit Time Series and Top N *TSVB* visualizations in *Lens*. When you open *TSVB* visualizations in *Lens*, all configuration options and annotations appear in the *Lens* visualization editor.
When you open *TSVB* visualizations in *Lens*, all configuration options and annotations appear in the *Lens* visualization editor.
You can open the following *TSVB* visualizations in *Lens*:
* Time Series
* Metric
* Top N
* Gauge
* Table
To get started, click *Edit visualization in Lens* in the toolbar.