Skip to content

Commit c783afc

Browse files
elasticmachineelasticmachine
authored
Merge branch 'master' into resolver/pills-add-backdrop-and-update-comment
2 parents ef070af + 33e3aa2 commit c783afc

134 files changed

Lines changed: 2745 additions & 1423 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/canvas/canvas-edit-workpads.asciidoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ For example, to change the index pattern for a set of charts:
2525
Specify the variable options.
2626

2727
[role="screenshot"]
28-
image::images/specify_variable_syntax.png[Specify the variable syntax]
28+
image::images/specify_variable_syntax.png[Image describing how to specify the variable syntax]
2929

3030
Copy the variable, then apply it to each element you want to update in the *Expression editor*.
3131

3232
[role="screenshot"]
33-
image::images/copy_variable_syntax.png[Copy the variable syntax]
33+
image::images/copy_variable_syntax.png[Image demonstrating expression editor]
3434

3535
[float]
3636
[[apply-changes-to-the-entire-workpad]]
@@ -85,7 +85,7 @@ To use an element with the same functionality and appearance in multiple places,
8585
Select the element, then click *Edit > Clone*.
8686

8787
[role="screenshot"]
88-
image::images/clone_element.gif[Clone elements]
88+
image::images/clone_element.gif[Image showing how to clone elements]
8989

9090
[float]
9191
[[move-and-resize-elements]]

‎docs/canvas/canvas-expression-lifecycle.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The filtered <<demodata_fn, demo data>> becomes the _context_ of the next functi
3030

3131
Let’s look at another expression, which uses the same <<demodata_fn, demodata>> function, but instead produces a pie chart.
3232

33-
image::images/canvas-functions-can-take-arguments-pie-chart.png[Pie Chart, height=400]
33+
image::images/canvas-functions-can-take-arguments-pie-chart.png[Pie chart showing output of demodata function]
3434
[source,text]
3535
----
3636
filters
@@ -47,7 +47,7 @@ If the expression stopped there, it would produce a `pointseries` data type as t
4747
The end result is a simple pie chart that uses the default color palette, but the <<pie_fn, pie>> function can take additional arguments that control how it gets rendered. For example, you can provide a `hole` argument to turn your pie chart into a donut chart by changing the expression to:
4848

4949

50-
image::images/canvas-functions-can-take-arguments-donut-chart.png[Donut Chart, height=400]
50+
image::images/canvas-functions-can-take-arguments-donut-chart.png[Alternative output as donut chart]
5151
[source,text]
5252
----
5353
filters
@@ -83,7 +83,7 @@ You can substitute one function for another to change the output. For example, y
8383

8484
Let’s change that last pie chart into a bubble chart by replacing the <<pie_fn, pie>> function with the <<plot_fn, plot>> function. This is possible because both functions can accept a `pointseries` data type as their _context_. Switching the functions will work, but it won’t produce a useful visualization on its own since you don’t have the x-axis and y-axis defined. You will also need to modify the <<pointseries_fn, pointseries>> function to change its output. In this case, you can change the `size` argument to `y`, so the maximum price values are plotted on the y-axis, and add an `x` argument using the `@timestamp` field in the data to plot those values over time. This leaves you with the following expression and produces a bubble chart showing the max price of each state over time:
8585

86-
image::images/canvas-change-your-expression-chart.png[Bubble Chart, height=400]
86+
image::images/canvas-change-your-expression-chart.png[Bubble Chart, with price along x axis, and time along y axis]
8787
[source,text]
8888
----
8989
filters
@@ -95,7 +95,7 @@ filters
9595

9696
Similar to the <<pie_fn, pie>> function, the <<plot_fn, plot>> function takes arguments that control the design elements of the visualization. As one example, passing a `legend` argument with a value of `false` to the function will hide the legend on the chart.
9797

98-
image::images/canvas-change-your-expression-chart-no-legend.png[Bubble Chart Without Legend, height=400]
98+
image::images/canvas-change-your-expression-chart-no-legend.png[Bubble Chart Without Legend]
9999
[source,text,subs=+quotes]
100100
----
101101
filters

‎docs/canvas/canvas-present-workpad.asciidoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
1818
. To start your presentation, click *View > Enter fullscreen mode*.
1919
+
2020
[role="screenshot"]
21-
image::images/canvas-fullscreen.png[Fullscreen mode]
21+
image::images/canvas-fullscreen.png[Image showing how to enter fullscreen mode from view dropdown]
2222

2323
. When you are ready to exit fullscreen mode, press the Esc (Escape) key.
2424

@@ -33,7 +33,7 @@ To get a closer look at a portion of your workpad, use the zoom options.
3333
. Select the zoom option.
3434
+
3535
[role="screenshot"]
36-
image::images/canvas-zoom-controls.png[Zoom controls]
36+
image::images/canvas-zoom-controls.png[Zoom controls, also in view dropdown]
3737

3838
[float]
3939
[[configure-auto-refresh-interval]]

‎docs/canvas/canvas-share-workpad.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Create a JSON file of your workpad that you can export outside of {kib}.
1313
Click *Share > Download as JSON*.
1414

1515
[role="screenshot"]
16-
image::images/canvas-export-workpad.png[Export single workpad]
16+
image::images/canvas-export-workpad.png[Export single workpad through JSON, from Share dropdown]
1717

1818
Want to export multiple workpads? Go to the *Canvas* home page, select the workpads you want to export, then click *Export*.
1919

@@ -26,7 +26,7 @@ If you have a subscription that supports the {report-features}, you can create a
2626
Click *Share > PDF reports > Generate PDF*.
2727

2828
[role="screenshot"]
29-
image::images/canvas-generate-pdf.gif[Generate PDF]
29+
image::images/canvas-generate-pdf.gif[Image showing how to generate a PDF]
3030

3131
For more information, refer to <<reporting-getting-started, Reporting from Kibana>>.
3232

@@ -39,7 +39,7 @@ If you have a subscription that supports the {report-features}, you can create a
3939
Click *Share > PDF reports > Copy POST URL*.
4040

4141
[role="screenshot"]
42-
image::images/canvas-create-URL.gif[Create POST URL]
42+
image::images/canvas-create-URL.gif[Image showing how to create POST URL]
4343

4444
For more information, refer to <<automating-report-generation, Automating report generation>>.
4545

@@ -58,7 +58,7 @@ beta[] Canvas allows you to create _shareables_, which are workpads that you dow
5858
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. Canvas does not display elements that manipulate the data on the workpad.
5959
+
6060
[role="screenshot"]
61-
image::canvas/images/canvas-embed_workpad.gif[Share the workpad on a website]
61+
image::canvas/images/canvas-embed_workpad.gif[Image showing how to share the workpad on a website]
6262
+
6363
NOTE: Shareable workpads encode the current state of the workpad in a JSON file. When you make changes to the workpad, the changes do not appear in the shareable workpad on your website.
6464

‎docs/canvas/canvas-tutorial.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The default Elastic logo image appears on the page.
3030
. To replace the Elastic logo with your own image, select the image, then use the editor.
3131

3232
[role="screenshot"]
33-
image::images/canvas-image-element.png[]
33+
image::images/canvas-image-element.png[Image showing how to add the image element]
3434

3535
[float]
3636
=== Customize your data with metrics
@@ -70,7 +70,7 @@ You're now looking at the raw data syntax that Canvas uses to display the elemen
7070
.. Click *Run*.
7171

7272
[role="screenshot"]
73-
image::images/canvas-metric-element.png[]
73+
image::images/canvas-metric-element.png[Image showing changes to the Canvas workpad]
7474

7575
[float]
7676
=== Show off your data with charts
@@ -96,7 +96,7 @@ To show what your data can do, add charts, graphs, progress monitors, and more t
9696
.. From the *Y-axis* drop-down lists, select *Value*, then select *taxless_total_price*.
9797

9898
[role="screenshot"]
99-
image::images/canvas-chart-element.png[]
99+
image::images/canvas-chart-element.png[Image showing Canvas workpad with sample data graph]
100100

101101
[float]
102102
=== Show how your data changes over time
@@ -110,7 +110,7 @@ To focus your data on a specific time range, add the time filter.
110110
. To use the date time field from the sample data, enter `order_date` in the *Column* field, then click *Set*.
111111

112112
[role="screenshot"]
113-
image::images/canvas-timefilter-element.png[]
113+
image::images/canvas-timefilter-element.png[Image showing Canvas workpad with filtered sample data graph]
114114

115115
To see how the data changes, set the time filter to *Last 7 days*. As you change the time filter options, the elements automatically update.
116116

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ export interface ISearchStart
1919
| [aggs](./kibana-plugin-plugins-data-public.isearchstart.aggs.md) | <code>AggsStart</code> | agg config sub service [AggsStart](./kibana-plugin-plugins-data-public.aggsstart.md) |
2020
| [search](./kibana-plugin-plugins-data-public.isearchstart.search.md) | <code>ISearchGeneric</code> | low level search [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |
2121
| [searchSource](./kibana-plugin-plugins-data-public.isearchstart.searchsource.md) | <code>ISearchStartSearchSource</code> | high level search [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) |
22+
| [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> | |
2223

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.showerror.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) &gt; [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md)
4+
5+
## ISearchStart.showError property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
showError: (e: Error) => void;
11+
```

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
| [IndexPatternSelect](./kibana-plugin-plugins-data-public.indexpatternselect.md) | |
2020
| [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) | |
2121
| [OptionedParamType](./kibana-plugin-plugins-data-public.optionedparamtype.md) | |
22+
| [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) | |
2223
| [Plugin](./kibana-plugin-plugins-data-public.plugin.md) | |
23-
| [RequestTimeoutError](./kibana-plugin-plugins-data-public.requesttimeouterror.md) | Class used to signify that a request timed out. Useful for applications to conditionally handle this type of error differently than other errors. |
2424
| [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) | |
2525
| [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) | \* |
26+
| [SearchTimeoutError](./kibana-plugin-plugins-data-public.searchtimeouterror.md) | Request Failure - When an entire multi request fails |
2627
| [TimeHistory](./kibana-plugin-plugins-data-public.timehistory.md) | |
2728

2829
## Enumerations
@@ -35,6 +36,7 @@
3536
| [METRIC\_TYPES](./kibana-plugin-plugins-data-public.metric_types.md) | |
3637
| [QuerySuggestionTypes](./kibana-plugin-plugins-data-public.querysuggestiontypes.md) | |
3738
| [SortDirection](./kibana-plugin-plugins-data-public.sortdirection.md) | |
39+
| [TimeoutErrorMode](./kibana-plugin-plugins-data-public.timeouterrormode.md) | |
3840

3941
## Functions
4042

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.painlesserror._constructor_.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.painlesserror._constructor_.md)
4+
5+
## PainlessError.(constructor)
6+
7+
Constructs a new instance of the `PainlessError` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(err: EsError, request: IKibanaSearchRequest);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| err | <code>EsError</code> | |
20+
| request | <code>IKibanaSearchRequest</code> | |
21+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.painlesserror.geterrormessage.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) &gt; [getErrorMessage](./kibana-plugin-plugins-data-public.painlesserror.geterrormessage.md)
4+
5+
## PainlessError.getErrorMessage() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getErrorMessage(application: ApplicationStart): JSX.Element;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| application | <code>ApplicationStart</code> | |
18+
19+
<b>Returns:</b>
20+
21+
`JSX.Element`
22+

0 commit comments

Comments
 (0)