Skip to content

Commit e3a322d

Browse files
authored
[DOCS] Adds timelion deprecation to new visualize docs structure (#76959)
1 parent 8ef31f6 commit e3a322d

File tree

1 file changed

+78
-46
lines changed

1 file changed

+78
-46
lines changed

docs/user/dashboard/dashboard.asciidoc

Lines changed: 78 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[partintro]
55
--
66

7-
A _dashboard_ is a collection of panels that you use to analyze your data. On a dashboard, you can add a variety of panels that
8-
you can rearrange and tell a story about your data. Panels contain everything you need, including visualizations,
9-
interactive controls, markdown, and more.
7+
A _dashboard_ is a collection of panels that you use to analyze your data. On a dashboard, you can add a variety of panels that
8+
you can rearrange and tell a story about your data. Panels contain everything you need, including visualizations,
9+
interactive controls, markdown, and more.
1010

1111
With *Dashboard*s, you can:
1212

@@ -18,7 +18,7 @@ With *Dashboard*s, you can:
1818

1919
* Create and apply filters to focus on the data you want to display.
2020

21-
* Control who can use your data, and share the dashboard with a small or large audience.
21+
* Control who can use your data, and share the dashboard with a small or large audience.
2222

2323
* Generate reports based on your findings.
2424

@@ -42,54 +42,54 @@ image::images/dashboard-read-only-badge.png[Example of Dashboard read only acces
4242
[[types-of-panels]]
4343
== Types of panels
4444

45-
Panels contain everything you need to tell a story about you data, including visualizations,
45+
Panels contain everything you need to tell a story about you data, including visualizations,
4646
interactive controls, Markdown, and more.
4747

4848
[cols="50, 50"]
4949
|===
5050

5151
a| *Area*
5252

53-
Displays data points, connected by a line, where the area between the line and axes are shaded.
53+
Displays data points, connected by a line, where the area between the line and axes are shaded.
5454
Use area charts to compare two or more categories over time, and display the magnitude of trends.
5555

5656
| image:images/area.png[Area chart]
5757

5858
a| *Stacked area*
5959

60-
Displays the evolution of the value of several data groups. The values of each group are displayed
61-
on top of each other. Use stacked area charts to visualize part-to-whole relationships, and to show
60+
Displays the evolution of the value of several data groups. The values of each group are displayed
61+
on top of each other. Use stacked area charts to visualize part-to-whole relationships, and to show
6262
how each category contributes to the cumulative total.
6363

6464
| image:images/stacked_area.png[Stacked area chart]
6565

6666
a| *Bar*
6767

68-
Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
69-
large number of categories, display data that includes categories with negative values, and easily identify
68+
Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
69+
large number of categories, display data that includes categories with negative values, and easily identify
7070
the categories that represent the highest and lowest values. Kibana also supports horizontal bar charts.
7171

7272
| image:images/bar.png[Bar chart]
7373

7474
a| *Stacked bar*
7575

76-
Displays numeric values across two or more categories. Use stacked bar charts to compare numeric values between
76+
Displays numeric values across two or more categories. Use stacked bar charts to compare numeric values between
7777
levels of a categorical value. Kibana also supports stacked horizontal bar charts.
7878

7979
| image:images/stacked_bar.png[Stacked area chart]
8080

8181

8282
a| *Line*
8383

84-
Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
84+
Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
8585
trends over time, and forecast future values.
8686

8787
| image:images/line.png[Line chart]
8888

8989
a| *Pie*
9090

91-
Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
92-
Use pie charts to show comparisons between multiple categories, illustrate the dominance of one category over others,
91+
Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
92+
Use pie charts to show comparisons between multiple categories, illustrate the dominance of one category over others,
9393
and show percentage or proportional data.
9494

9595
| image:images/pie.png[Pie chart]
@@ -103,15 +103,15 @@ Similar to the pie chart, but the central circle is removed. Use donut charts wh
103103

104104
a| *Tree map*
105105

106-
Relates different segments of your data to the whole. Each rectangle is subdivided into smaller rectangles, or sub branches, based on
106+
Relates different segments of your data to the whole. Each rectangle is subdivided into smaller rectangles, or sub branches, based on
107107
its proportion to the whole. Use treemaps to make efficient use of space to show percent total for each category.
108108

109109
| image:images/treemap.png[Tree map]
110110

111111

112112
a| *Heat map*
113113

114-
Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
114+
Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
115115
categorical data. For example, use a heat map to see the flights of origin countries compared to destination countries using the sample flight data.
116116

117117
| image:images/heat_map.png[Heat map]
@@ -125,31 +125,31 @@ Displays how your metric progresses toward a fixed goal. Use the goal to display
125125

126126
a| *Gauge*
127127

128-
Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
128+
Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
129129
values relate to reference threshold values, or determine how a specified field is performing versus how it is expected to perform.
130130

131131
| image:images/gauge.png[Gauge]
132132

133133

134134
a| *Metric*
135135

136-
Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
136+
Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
137137
a story about your data.
138138

139139
| image:images/metric.png[Metric]
140140

141141

142142
a| *Data table*
143143

144-
Displays your raw data or aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
144+
Displays your raw data or aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
145145
or max values for a specific field, and monitor the status of key services.
146146

147147
| image:images/data_table.png[Data table]
148148

149149

150150
a| *Tag cloud*
151151

152-
Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
152+
Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
153153
create visual art for a specific topic.
154154

155155
| image:images/tag_cloud.png[Tag cloud]
@@ -168,16 +168,16 @@ For all your mapping needs, use <<maps,Maps>>.
168168
[[create-panels]]
169169
== Create panels
170170

171-
To create a panel, make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <<index-patterns,index pattern>>
172-
to retrieve the data from {es}. If you aren’t ready to use your own data, {kib} comes with several pre-built dashboards that you can test out. For more information,
171+
To create a panel, make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <<index-patterns,index pattern>>
172+
to retrieve the data from {es}. If you aren’t ready to use your own data, {kib} comes with several pre-built dashboards that you can test out. For more information,
173173
refer to <<add-sample-data, Explore {kib} using sample data>>.
174174

175-
To begin, click *Create new*, then choose one of the following options on the
175+
To begin, click *Create new*, then choose one of the following options on the
176176
*New Visualization* window:
177177

178-
* Click on the type of panel you want to create, then configure the options.
178+
* Click on the type of panel you want to create, then configure the options.
179179

180-
* Select an editor to help you create the panel.
180+
* Select an editor to help you create the panel.
181181

182182
[role="screenshot"]
183183
image:images/Dashboard_add_new_visualization.png[Example add new visualization to dashboard]
@@ -188,19 +188,19 @@ image:images/Dashboard_add_new_visualization.png[Example add new visualization t
188188
[[lens]]
189189
=== Create panels with Lens
190190

191-
*Lens* is the simplest and fastest way to create powerful visualizations of your data. To use *Lens*, you drag and drop as many data fields
191+
*Lens* is the simplest and fastest way to create powerful visualizations of your data. To use *Lens*, you drag and drop as many data fields
192192
as you want onto the visualization builder pane, and *Lens* uses heuristics to decide how to apply each field to the visualization.
193193

194194
With *Lens*, you can:
195195

196196
* Use the automatically generated suggestions to change the visualization type.
197-
* Create visualizations with multiple layers and indices.
197+
* Create visualizations with multiple layers and indices.
198198
* Change the aggregation and labels to customize the data.
199199

200200
[role="screenshot"]
201201
image::images/lens_drag_drop.gif[Drag and drop]
202202

203-
TIP: Drag-and-drop capabilities are available only when *Lens* knows how to use the data. If *Lens* is unable to automatically generate a
203+
TIP: Drag-and-drop capabilities are available only when *Lens* knows how to use the data. If *Lens* is unable to automatically generate a
204204
visualization, configure the customization options for your visualization.
205205

206206
[float]
@@ -220,7 +220,7 @@ To filter the data fields:
220220
[[view-data-summaries]]
221221
==== View data summaries
222222

223-
To help you decide exactly the data you want to display, get a quick summary of each field. The summary shows the distribution of
223+
To help you decide exactly the data you want to display, get a quick summary of each field. The summary shows the distribution of
224224
values within the specified time range.
225225

226226
To view the data field summary information, navigate to the field, then click *i*.
@@ -250,10 +250,10 @@ When there is an exclamation point (!) next to a visualization type, *Lens* is u
250250
[[customize-the-data]]
251251
==== Customize the data
252252

253-
For each visualization type, you can customize the aggregation and labels. The options available depend on the selected visualization type.
253+
For each visualization type, you can customize the aggregation and labels. The options available depend on the selected visualization type.
254254

255255
. Click a data field name in the editor, or click *Drop a field here*.
256-
. Change the options that appear.
256+
. Change the options that appear.
257257
+
258258
[role="screenshot"]
259259
image::images/lens_aggregation_labels.png[Quick function options]
@@ -262,7 +262,7 @@ image::images/lens_aggregation_labels.png[Quick function options]
262262
[[add-layers-and-indices]]
263263
==== Add layers and indices
264264

265-
To compare and analyze data from different sources, you can visualize multiple data layers and indices. Multiple layers and indices are
265+
To compare and analyze data from different sources, you can visualize multiple data layers and indices. Multiple layers and indices are
266266
supported in area, line, and bar charts.
267267

268268
To add a layer, click *+*, then drag and drop the data fields for the new layer.
@@ -281,7 +281,7 @@ Ready to try out *Lens*? Refer to the <<lens-tutorial,step-by-step tutorial>>.
281281
[[tsvb]]
282282
=== Create panels with TSVB
283283

284-
*TSVB* is a time series data visualizer that allows you to use the full power of the Elasticsearch aggregation framework. To use *TSVB*,
284+
*TSVB* is a time series data visualizer that allows you to use the full power of the Elasticsearch aggregation framework. To use *TSVB*,
285285
you can combine an infinite number of <<aggregation-reference,aggregations>> to display your data.
286286

287287
With *TSVB*, you can:
@@ -295,15 +295,15 @@ image::images/tsvb.png[TSVB UI]
295295

296296
[float]
297297
[[configure-the-data]]
298-
==== Configure the data
298+
==== Configure the data
299299

300-
With *TSVB*, you can add and display multiple data sets to compare and analyze. {kib} uses many types of <<aggregation-reference,aggregations>> that you can use to build
300+
With *TSVB*, you can add and display multiple data sets to compare and analyze. {kib} uses many types of <<aggregation-reference,aggregations>> that you can use to build
301301
complex summaries of that data.
302302

303303
. Select *Data*. If you are using *Table*, select *Columns*.
304-
. From the *Aggregation* drop down, select the aggregation you want to visualize.
304+
. From the *Aggregation* drop down, select the aggregation you want to visualize.
305305
+
306-
If you don’t see any data, change the <<set-time-filter,time filter>>.
306+
If you don’t see any data, change the <<set-time-filter,time filter>>.
307307
+
308308
To add multiple aggregations, click *+*.
309309
. From the *Group by* drop down, select how you want to group or split the data.
@@ -315,14 +315,14 @@ When you have more than one aggregation, the last value is displayed, which is i
315315
[[change-the-data-display]]
316316
==== Change the data display
317317

318-
To find the best way to display your data, *TSVB* supports several types of panels and charts.
318+
To find the best way to display your data, *TSVB* supports several types of panels and charts.
319319

320320
To change the *Time Series* chart type:
321321

322322
. Click *Data > Options*.
323323
. Select the *Chart type*.
324324

325-
To change the panel type, click on the panel options:
325+
To change the panel type, click on the panel options:
326326

327327
[role="screenshot"]
328328
image::images/tsvb_change_display.gif[TSVB change the panel type]
@@ -331,7 +331,7 @@ image::images/tsvb_change_display.gif[TSVB change the panel type]
331331
[[custommize-the-data]]
332332
==== Customize the data
333333

334-
View data in a different <<index-patterns,index pattern>>, and change the data label name and colors. The options available depend on the panel type.
334+
View data in a different <<index-patterns,index pattern>>, and change the data label name and colors. The options available depend on the panel type.
335335

336336
To change the index pattern, click *Panel options*, then enter the new *Index Pattern*.
337337

@@ -361,7 +361,7 @@ image::images/tsvb_annotations.png[TSVB annotations]
361361
[[filter-the-panel]]
362362
==== Filter the panel
363363

364-
The data that displays on the panel is based on the <<index-patterns,index pattern>> and <<set-time-filter,time filter>>.
364+
The data that displays on the panel is based on the <<index-patterns,index pattern>> and <<set-time-filter,time filter>>.
365365
You can filter the data on the panels using the <<lucene-query,Lucene query syntax>>.
366366

367367
Click *Panel options*, then enter the syntax in the *Panel Filter* field.
@@ -372,7 +372,7 @@ If you want to ignore filters from all of {kib}, select *Yes* for *Ignore global
372372
[[vega]]
373373
=== Create custom panels with Vega
374374

375-
Build custom visualizations using *Vega* and *Vega-Lite*, backed by one or more data sources including {es}, Elastic Map Service,
375+
Build custom visualizations using *Vega* and *Vega-Lite*, backed by one or more data sources including {es}, Elastic Map Service,
376376
URL, or static data. Use the {kib} extensions to embed *Vega* in your dashboard, and add interactive tools.
377377

378378
Use *Vega* and *Vega-Lite* when you want to create a visualization for:
@@ -405,7 +405,7 @@ For more information about *Vega* and *Vega-Lite*, refer to:
405405
[[timelion]]
406406
=== Create panels with Timelion
407407

408-
*Timelion* is a time series data visualizer that enables you to combine independent data sources within a single visualization.
408+
*Timelion* is a time series data visualizer that enables you to combine independent data sources within a single visualization.
409409

410410
*Timelion* is driven by a simple expression language that you use to:
411411

@@ -422,9 +422,41 @@ Ready to try out Timelion? For step-by-step tutorials, refer to:
422422
* <<timelion-tutorial-create-visualizations-with-mathematical-functions,Create visualizations with mathematical functions>>
423423
* <<timelion-tutorial-create-visualizations-withconditional-logic-and-tracking-trends,Create visualizations with conditional logic and tracking trends>>
424424

425+
[float]
426+
[[timelion-deprecation]]
427+
==== Timelion app deprecation
428+
429+
Deprecated since 7.0, the Timelion app will be removed in 8.0. If you have any Timelion worksheets, you must migrate them to a dashboard.
430+
431+
NOTE: Only the Timelion app is deprecated. {kib} continues to support Timelion
432+
visualizations on dashboards and in Visualize and Canvas.
433+
434+
To migrate a Timelion worksheet to a dashboard:
435+
436+
. Open the menu, click **Dashboard**, then click **Create dashboard**.
437+
438+
. On the dashboard, click **Create New**, then select the Timelion visualization.
439+
440+
. On a new tab, open the Timelion app, select the chart you want to copy, and copy its expression.
441+
+
442+
[role="screenshot"]
443+
image::images/timelion-copy-expression.png[]
444+
445+
. Return to the other tab and paste the copied expression to the *Timelion Expression* field and click **Update**.
446+
+
447+
[role="screenshot"]
448+
image::images/timelion-vis-paste-expression.png[]
449+
450+
. Save the new visualization, give it a name, and click **Save and Return**.
451+
+
452+
Your Timelion visualization will appear on the dashboard. Repeat this for all your charts on each worksheet.
453+
+
454+
[role="screenshot"]
455+
image::images/timelion-dashboard.png[]
456+
425457
[float]
426458
[[save-panels]]
427-
=== Save panels
459+
== Save panels
428460

429461
When you’ve finished making changes, save the panels.
430462

@@ -436,7 +468,7 @@ When you’ve finished making changes, save the panels.
436468
[[add-existing-panels]]
437469
== Add existing panels
438470

439-
Add panels that you’ve already created to your dashboard.
471+
Add panels that you’ve already created to your dashboard.
440472

441473
On the dashboard, click *Add an existing*, then select the panel you want to add.
442474

@@ -445,7 +477,7 @@ When a panel contains a stored query, both queries are applied.
445477
[role="screenshot"]
446478
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]
447479

448-
To make changes to the panel, put the dashboard in *Edit* mode, then select the edit option from the panel menu.
480+
To make changes to the panel, put the dashboard in *Edit* mode, then select the edit option from the panel menu.
449481
The changes you make appear in every dashboard that uses the panel, except if you edit the panel title. Changes to the panel title appear only on the dashboard where you made the change.
450482

451483
[float]

0 commit comments

Comments
 (0)