Skip to content

Commit 7aa3305

Browse files
elasticmachineelasticmachine
authored
Merge branch 'master' into migrate_markdown_styles
2 parents 1cc7679 + ec78348 commit 7aa3305

231 files changed

Lines changed: 3764 additions & 3838 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/developer/visualize/development-create-visualization.asciidoc‎

Lines changed: 0 additions & 463 deletions
This file was deleted.

‎docs/developer/visualize/development-embedding-visualizations.asciidoc‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎docs/developer/visualize/development-visualize-index.asciidoc‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
[[development-visualize-index]]
22
== Developing Visualizations
33

4-
Kibana Visualizations are the easiest way to add additional functionality to Kibana.
5-
This part of documentation is split into two parts.
6-
The first part tells you all you need to know on how to embed existing Kibana Visualizations in your plugin.
7-
The second step explains how to create your own custom visualization.
8-
94
[IMPORTANT]
105
==============================================
11-
These pages document internal APIs and are not guaranteed to be supported across future versions of Kibana.
12-
However, these docs will be kept up-to-date to reflect the current implementation of Visualization plugins in Kibana.
6+
These pages document internal APIs and are not guaranteed to be supported across future versions of Kibana.
137
==============================================
148

15-
* <<development-embedding-visualizations>>
16-
* <<development-create-visualization>>
9+
The internal APIs for creating custom visualizations are in a state of heavy churn as
10+
they are being migrated to the new Kibana platform, and large refactorings have been
11+
happening across minor releases in the `7.x` series. In particular, in `7.5` and later
12+
we have made significant changes to the legacy APIs as we work to gradually replace them.
1713

14+
As a result, starting in `7.5` we have removed the documentation for the legacy APIs
15+
to prevent confusion. We expect to be able to create new documentation later in `7.x`
16+
when the visualizations plugin has been completed.
1817

19-
include::development-embedding-visualizations.asciidoc[]
18+
We would recommend waiting until later in `7.x` to upgrade your plugins if possible.
19+
If you would like to keep up with progress on the visualizations plugin in the meantime,
20+
here are a few resources:
2021

21-
include::development-create-visualization.asciidoc[]
22+
* The <<breaking-changes,breaking changes>> documentation, where we try to capture any changes to the APIs as they occur across minors.
23+
* link:https://github.com/elastic/kibana/issues/44121[Meta issue] which is tracking the move of the plugin to the new Kibana platform
24+
* Our link:https://www.elastic.co/blog/join-our-elastic-stack-workspace-on-slack[Elastic Stack workspace on Slack].
25+
* The {repo}blob/{branch}/src/plugins/visualizations[source code], which will continue to be
26+
the most accurate source of information.

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

Lines changed: 0 additions & 11 deletions
This file was deleted.

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

Lines changed: 0 additions & 11 deletions
This file was deleted.

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

Lines changed: 0 additions & 11 deletions
This file was deleted.

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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; [getDefaultQuery](./kibana-plugin-plugins-data-public.getdefaultquery.md)
4+
5+
## getDefaultQuery() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare function getDefaultQuery(language?: QueryLanguage): {
11+
query: string;
12+
language: QueryLanguage;
13+
};
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| language | <code>QueryLanguage</code> | |
21+
22+
<b>Returns:</b>
23+
24+
`{
25+
query: string;
26+
language: QueryLanguage;
27+
}`
28+

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

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iessearchrequest.indextype.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; [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) &gt; [indexType](./kibana-plugin-plugins-data-public.iessearchrequest.indextype.md)
4+
5+
## IEsSearchRequest.indexType property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
indexType?: string;
11+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ export interface IEsSearchRequest extends IKibanaSearchRequest
1414
1515
| Property | Type | Description |
1616
| --- | --- | --- |
17+
| [indexType](./kibana-plugin-plugins-data-public.iessearchrequest.indextype.md) | <code>string</code> | |
1718
| [params](./kibana-plugin-plugins-data-public.iessearchrequest.params.md) | <code>SearchParams</code> | |
1819

0 commit comments

Comments
 (0)