Merge branch 'master' into alert-list-reducer-fix

Author: elasticmachine

docs/canvas/canvas-elements.asciidoc

@@ -20,7 +20,9 @@ When you add elements to your workpad, you can:
 [[add-canvas-element]]
 === Add elements to your workpad
 
-Choose the elements to display on your workpad, then familiarize yourself with the element using the preconfigured demo data. By default, every element you add to a workpad uses demo data until you change the data source. The demo data includes a small sample data set that you can use to experiment with your element.
+Choose the elements to display on your workpad, then familiarize yourself with the element using the preconfigured demo data. By default, most elements use demo data until you change the data source. The demo data includes a small sample data set that you can use to experiment with your element.
+
+To add a Canvas element:
 
 . Click *Add element*.
 
@@ -31,13 +33,26 @@ image::images/canvas-element-select.gif[Canvas elements]
 
 . Play around with the default settings and see what the element can do.
 
-TIP: Want to use a different element? You can delete the element by selecting it, clicking the *Element options* icon in the top right, then selecting *Delete*.
+To add a map:
+
+. Click *Embed object*.
+
+. Select the map you want to add to the workpad.
++
+[role="screenshot"]
+image::images/canvas-map-embed.gif[]
+
+NOTE: Demo data is only supported on Canvas elements. Maps do not support demo data.
+
+Want to use a different element? You can delete the element by selecting it, clicking the *Element options* icon in the top right, then selecting *Delete*.
 
 [float]
 [[connect-element-data]]
-=== Connect the element to your data
+=== Connect the Canvas element to your data
 
-When you have finished using the demo data, connect the element to a data source.
+When you have finished using the demo data, connect the Canvas element to a data source.
+
+NOTE: Maps do not support data sources. To change the map data, refer to <<maps, Elastic Maps>>.
 
 . Make sure that the element is selected, then select *Data*.
 
@@ -142,7 +157,7 @@ text.align: center;
 [[configure-auto-refresh-interval]]
 ==== Change the data auto-refresh interval
 
-Increase or decrease how often your data refreshes on your workpad.
+Increase or decrease how often your Canvas element data refreshes on your workpad.
 
 . In the top left corner, click the *Control settings* icon.
 
@@ -153,6 +168,17 @@ image::images/canvas-refresh-interval.png[Element data refresh interval]
 
 TIP: To manually refresh the data, click the *Refresh data* icon.
 
+[float]
+[[canvas-time-range]]
+==== Customize map time ranges
+
+Configure the maps on your workpad for a specific time range.
+
+From the panel menu, select *Customize time range* to expose a time filter dedicated to the map.
+
+[role="screenshot"]
+image::images/canvas_map-time-filter.gif[]
+
 [float]
 [[organize-element]]
 === Organize the elements on your workpad

docs/images/canvas-map-embed.gif

@@ -18,26 +18,23 @@
  */
 
 import { CoreSetup } from 'src/core/public';
-import { QuerySuggestionsGetFn } from './providers/query_suggestion_provider';
+import { QuerySuggestionGetFn } from './providers/query_suggestion_provider';
 import {
   setupValueSuggestionProvider,
   ValueSuggestionsGetFn,
 } from './providers/value_suggestion_provider';
 
 export class AutocompleteService {
-  private readonly querySuggestionProviders: Map<string, QuerySuggestionsGetFn> = new Map();
+  private readonly querySuggestionProviders: Map<string, QuerySuggestionGetFn> = new Map();
   private getValueSuggestions?: ValueSuggestionsGetFn;
 
-  private addQuerySuggestionProvider = (
-    language: string,
-    provider: QuerySuggestionsGetFn
-  ): void => {
+  private addQuerySuggestionProvider = (language: string, provider: QuerySuggestionGetFn): void => {
     if (language && provider) {
       this.querySuggestionProviders.set(language, provider);
     }
   };
 
-  private getQuerySuggestions: QuerySuggestionsGetFn = args => {
+  private getQuerySuggestions: QuerySuggestionGetFn = args => {
     const { language } = args;
     const provider = this.querySuggestionProviders.get(language);
 

docs/images/canvas_map-time-filter.gif

@@ -16,7 +16,14 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import * as autocomplete from './static';
-export { AutocompleteService, AutocompleteSetup, AutocompleteStart } from './autocomplete_service';
 
-export { autocomplete };
+export {
+  QuerySuggestion,
+  QuerySuggestionTypes,
+  QuerySuggestionGetFn,
+  QuerySuggestionGetFnArgs,
+  QuerySuggestionBasic,
+  QuerySuggestionField,
+} from './providers/query_suggestion_provider';
+
+export { AutocompleteService, AutocompleteSetup, AutocompleteStart } from './autocomplete_service';

src/plugins/data/public/autocomplete/autocomplete_service.ts

@@ -19,20 +19,20 @@
 
 import { IFieldType, IIndexPattern } from '../../../common/index_patterns';
 
-export enum QuerySuggestionsTypes {
+export enum QuerySuggestionTypes {
   Field = 'field',
   Value = 'value',
   Operator = 'operator',
   Conjunction = 'conjunction',
   RecentSearch = 'recentSearch',
 }
 
-export type QuerySuggestionsGetFn = (
-  args: QuerySuggestionsGetFnArgs
+export type QuerySuggestionGetFn = (
+  args: QuerySuggestionGetFnArgs
 ) => Promise<QuerySuggestion[]> | undefined;
 
 /** @public **/
-export interface QuerySuggestionsGetFnArgs {
+export interface QuerySuggestionGetFnArgs {
   language: string;
   indexPatterns: IIndexPattern[];
   query: string;
@@ -43,8 +43,8 @@ export interface QuerySuggestionsGetFnArgs {
 }
 
 /** @public **/
-export interface BasicQuerySuggestion {
-  type: QuerySuggestionsTypes;
+export interface QuerySuggestionBasic {
+  type: QuerySuggestionTypes;
   description?: string | JSX.Element;
   end: number;
   start: number;
@@ -53,10 +53,10 @@ export interface BasicQuerySuggestion {
 }
 
 /** @public **/
-export interface FieldQuerySuggestion extends BasicQuerySuggestion {
-  type: QuerySuggestionsTypes.Field;
+export interface QuerySuggestionField extends QuerySuggestionBasic {
+  type: QuerySuggestionTypes.Field;
   field: IFieldType;
 }
 
 /** @public **/
-export type QuerySuggestion = BasicQuerySuggestion | FieldQuerySuggestion;
+export type QuerySuggestion = QuerySuggestionBasic | QuerySuggestionField;

src/plugins/data/public/autocomplete/index.ts

@@ -104,7 +104,17 @@ export {
   FieldFormatConfig,
   FieldFormatId,
 } from '../common';
-export { autocomplete } from './autocomplete';
+
+export {
+  QuerySuggestion,
+  QuerySuggestionTypes,
+  QuerySuggestionGetFn,
+  QuerySuggestionGetFnArgs,
+  QuerySuggestionBasic,
+  QuerySuggestionField,
+} from './autocomplete';
+
+export * from './field_formats';
 export * from './index_patterns';
 export * from './search';
 export * from './query';

src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts

@@ -35,7 +35,6 @@ import { InjectedIntl, injectI18n, FormattedMessage } from '@kbn/i18n/react';
 import { debounce, compact, isEqual } from 'lodash';
 import { Toast } from 'src/core/public';
 import {
-  autocomplete,
   IDataPluginServices,
   IIndexPattern,
   PersistedLog,
@@ -46,6 +45,8 @@ import {
   getQueryLog,
   Query,
 } from '../..';
+import { QuerySuggestion, QuerySuggestionTypes } from '../../autocomplete';
+
 import { withKibana, KibanaReactContextValue, toMountPoint } from '../../../../kibana_react/public';
 import { fetchIndexPatterns } from './fetch_index_patterns';
 import { QueryLanguageSwitcher } from './language_switcher';
@@ -70,7 +71,7 @@ interface Props {
 interface State {
   isSuggestionsVisible: boolean;
   index: number | null;
-  suggestions: autocomplete.QuerySuggestion[];
+  suggestions: QuerySuggestion[];
   suggestionLimit: number;
   selectionStart: number | null;
   selectionEnd: number | null;
@@ -191,7 +192,7 @@ export class QueryStringInputUI extends Component<Props, State> {
       const text = toUser(recentSearch);
       const start = 0;
       const end = query.length;
-      return { type: autocomplete.QuerySuggestionsTypes.RecentSearch, text, start, end };
+      return { type: QuerySuggestionTypes.RecentSearch, text, start, end };
     });
   };
 
@@ -317,7 +318,7 @@ export class QueryStringInputUI extends Component<Props, State> {
     }
   };
 
-  private selectSuggestion = (suggestion: autocomplete.QuerySuggestion) => {
+  private selectSuggestion = (suggestion: QuerySuggestion) => {
     if (!this.inputRef) {
       return;
     }
@@ -341,13 +342,13 @@ export class QueryStringInputUI extends Component<Props, State> {
       selectionEnd: start + (cursorIndex ? cursorIndex : text.length),
     });
 
-    if (type === autocomplete.QuerySuggestionsTypes.RecentSearch) {
+    if (type === QuerySuggestionTypes.RecentSearch) {
       this.setState({ isSuggestionsVisible: false, index: null });
       this.onSubmit({ query: newQueryString, language: this.props.query.language });
     }
   };
 
-  private handleNestedFieldSyntaxNotification = (suggestion: autocomplete.QuerySuggestion) => {
+  private handleNestedFieldSyntaxNotification = (suggestion: QuerySuggestion) => {
     if (
       'field' in suggestion &&
       suggestion.field.subType &&
@@ -449,7 +450,7 @@ export class QueryStringInputUI extends Component<Props, State> {
     }
   };
 
-  private onClickSuggestion = (suggestion: autocomplete.QuerySuggestion) => {
+  private onClickSuggestion = (suggestion: QuerySuggestion) => {
     if (!this.inputRef) {
       return;
     }

src/plugins/data/public/autocomplete/static.ts

@@ -19,19 +19,19 @@
 
 import { mount, shallow } from 'enzyme';
 import React from 'react';
-import { autocomplete } from '../..';
+import { QuerySuggestion, QuerySuggestionTypes } from '../../autocomplete';
 import { SuggestionComponent } from './suggestion_component';
 
 const noop = () => {
   return;
 };
 
-const mockSuggestion: autocomplete.QuerySuggestion = {
+const mockSuggestion: QuerySuggestion = {
   description: 'This is not a helpful suggestion',
   end: 0,
   start: 42,
   text: 'as promised, not helpful',
-  type: autocomplete.QuerySuggestionsTypes.Value,
+  type: QuerySuggestionTypes.Value,
 };
 
 describe('SuggestionComponent', () => {