Skip to content

Commit

Permalink
Merge branch 'master' into migrate_markdown_styles
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine authored Mar 12, 2020
2 parents 1cc7679 + ec78348 commit 7aa3305
Show file tree
Hide file tree
Showing 231 changed files with 3,764 additions and 3,838 deletions.
463 changes: 0 additions & 463 deletions docs/developer/visualize/development-create-visualization.asciidoc

This file was deleted.

This file was deleted.

27 changes: 16 additions & 11 deletions docs/developer/visualize/development-visualize-index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
[[development-visualize-index]]
== Developing Visualizations

Kibana Visualizations are the easiest way to add additional functionality to Kibana.
This part of documentation is split into two parts.
The first part tells you all you need to know on how to embed existing Kibana Visualizations in your plugin.
The second step explains how to create your own custom visualization.

[IMPORTANT]
==============================================
These pages document internal APIs and are not guaranteed to be supported across future versions of Kibana.
However, these docs will be kept up-to-date to reflect the current implementation of Visualization plugins in Kibana.
These pages document internal APIs and are not guaranteed to be supported across future versions of Kibana.
==============================================

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

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

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

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

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [getDefaultQuery](./kibana-plugin-plugins-data-public.getdefaultquery.md)

## getDefaultQuery() function

<b>Signature:</b>

```typescript
export declare function getDefaultQuery(language?: QueryLanguage): {
query: string;
language: QueryLanguage;
};
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| language | <code>QueryLanguage</code> | |

<b>Returns:</b>

`{
query: string;
language: QueryLanguage;
}`

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[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)

## IEsSearchRequest.indexType property

<b>Signature:</b>

```typescript
indexType?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ export interface IEsSearchRequest extends IKibanaSearchRequest
| Property | Type | Description |
| --- | --- | --- |
| [indexType](./kibana-plugin-plugins-data-public.iessearchrequest.indextype.md) | <code>string</code> | |
| [params](./kibana-plugin-plugins-data-public.iessearchrequest.params.md) | <code>SearchParams</code> | |
Original file line number Diff line number Diff line change
Expand Up @@ -74,32 +74,26 @@
| [RangeFilterParams](./kibana-plugin-plugins-data-public.rangefilterparams.md) | |
| [RefreshInterval](./kibana-plugin-plugins-data-public.refreshinterval.md) | |
| [SavedQuery](./kibana-plugin-plugins-data-public.savedquery.md) | |
| [SavedQueryAttributes](./kibana-plugin-plugins-data-public.savedqueryattributes.md) | |
| [SavedQueryService](./kibana-plugin-plugins-data-public.savedqueryservice.md) | |
| [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | |
| [SearchStrategyProvider](./kibana-plugin-plugins-data-public.searchstrategyprovider.md) | |
| [TimefilterSetup](./kibana-plugin-plugins-data-public.timefiltersetup.md) | |
| [TimeRange](./kibana-plugin-plugins-data-public.timerange.md) | |

## Variables

| Variable | Description |
| --- | --- |
| [addSearchStrategy](./kibana-plugin-plugins-data-public.addsearchstrategy.md) | |
| [baseFormattersPublic](./kibana-plugin-plugins-data-public.baseformatterspublic.md) | |
| [castEsToKbnFieldTypeName](./kibana-plugin-plugins-data-public.castestokbnfieldtypename.md) | Get the KbnFieldType name for an esType string |
| [connectToQueryState](./kibana-plugin-plugins-data-public.connecttoquerystate.md) | Helper to setup two-way syncing of global data and a state container |
| [createSavedQueryService](./kibana-plugin-plugins-data-public.createsavedqueryservice.md) | |
| [defaultSearchStrategy](./kibana-plugin-plugins-data-public.defaultsearchstrategy.md) | |
| [ES\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.es_search_strategy.md) | |
| [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) | |
| [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) | |
| [esQuery](./kibana-plugin-plugins-data-public.esquery.md) | |
| [esSearchStrategyProvider](./kibana-plugin-plugins-data-public.essearchstrategyprovider.md) | |
| [fieldFormats](./kibana-plugin-plugins-data-public.fieldformats.md) | |
| [FilterBar](./kibana-plugin-plugins-data-public.filterbar.md) | |
| [getKbnTypeNames](./kibana-plugin-plugins-data-public.getkbntypenames.md) | Get the esTypes known by all kbnFieldTypes {<!-- -->Array<string>} |
| [hasSearchStategyForIndexPattern](./kibana-plugin-plugins-data-public.hassearchstategyforindexpattern.md) | |
| [indexPatterns](./kibana-plugin-plugins-data-public.indexpatterns.md) | |
| [QueryStringInput](./kibana-plugin-plugins-data-public.querystringinput.md) | |
| [SearchBar](./kibana-plugin-plugins-data-public.searchbar.md) | |
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 7aa3305

Please sign in to comment.