Skip to content

Commit

Permalink
import and doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
mattkime committed Sep 23, 2020
1 parent 278d037 commit 726b92b
Show file tree
Hide file tree
Showing 10 changed files with 113 additions and 22 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Constructs a new instance of the `IndexPattern` class
<b>Signature:</b>

```typescript
constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, shortDotsEnable, metaFields, }: IndexPatternDeps);
constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, }: IndexPatternDeps);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | <code>string &#124; undefined</code> | |
| { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> | |
| { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> | |

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [getIndex](./kibana-plugin-plugins-data-server.indexpattern.getindex.md)

## IndexPattern.getIndex() method

<b>Signature:</b>

```typescript
getIndex(): string;
```
<b>Returns:</b>

`string`

Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
intervalName: string | undefined;
intervalName: string | undefined | null;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [isUnsupportedTimePattern](./kibana-plugin-plugins-data-server.indexpattern.isunsupportedtimepattern.md)

## IndexPattern.isUnsupportedTimePattern() method

<b>Signature:</b>

```typescript
isUnsupportedTimePattern(): boolean;
```
<b>Returns:</b>

`boolean`

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare class IndexPattern implements IIndexPattern
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(id, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, shortDotsEnable, metaFields, })](./kibana-plugin-plugins-data-server.indexpattern._constructor_.md) | | Constructs a new instance of the <code>IndexPattern</code> class |
| [(constructor)(id, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, })](./kibana-plugin-plugins-data-server.indexpattern._constructor_.md) | | Constructs a new instance of the <code>IndexPattern</code> class |
## Properties
Expand All @@ -27,7 +27,7 @@ export declare class IndexPattern implements IIndexPattern
| [formatField](./kibana-plugin-plugins-data-server.indexpattern.formatfield.md) | | <code>any</code> | |
| [formatHit](./kibana-plugin-plugins-data-server.indexpattern.formathit.md) | | <code>any</code> | |
| [id](./kibana-plugin-plugins-data-server.indexpattern.id.md) | | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-server.indexpattern.intervalname.md) | | <code>string &#124; undefined</code> | |
| [intervalName](./kibana-plugin-plugins-data-server.indexpattern.intervalname.md) | | <code>string &#124; undefined &#124; null</code> | |
| [metaFields](./kibana-plugin-plugins-data-server.indexpattern.metafields.md) | | <code>string[]</code> | |
| [originalBody](./kibana-plugin-plugins-data-server.indexpattern.originalbody.md) | | <code>{</code><br/><code> [key: string]: any;</code><br/><code> }</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-server.indexpattern.sourcefilters.md) | | <code>SourceFilter[]</code> | |
Expand All @@ -48,6 +48,7 @@ export declare class IndexPattern implements IIndexPattern
| [getComputedFields()](./kibana-plugin-plugins-data-server.indexpattern.getcomputedfields.md) | | |
| [getFieldByName(name)](./kibana-plugin-plugins-data-server.indexpattern.getfieldbyname.md) | | |
| [getFormatterForField(field)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfield.md) | | |
| [getIndex()](./kibana-plugin-plugins-data-server.indexpattern.getindex.md) | | |
| [getNonScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getnonscriptedfields.md) | | |
| [getScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md) | | |
| [getSourceFiltering()](./kibana-plugin-plugins-data-server.indexpattern.getsourcefiltering.md) | | |
Expand All @@ -57,7 +58,9 @@ export declare class IndexPattern implements IIndexPattern
| [isTimeBased()](./kibana-plugin-plugins-data-server.indexpattern.istimebased.md) | | |
| [isTimeBasedWildcard()](./kibana-plugin-plugins-data-server.indexpattern.istimebasedwildcard.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-server.indexpattern.istimenanosbased.md) | | |
| [isUnsupportedTimePattern()](./kibana-plugin-plugins-data-server.indexpattern.isunsupportedtimepattern.md) | | |
| [isWildcard()](./kibana-plugin-plugins-data-server.indexpattern.iswildcard.md) | | |
| [migrate(newTitle)](./kibana-plugin-plugins-data-server.indexpattern.migrate.md) | | |
| [popularizeField(fieldName, unit)](./kibana-plugin-plugins-data-server.indexpattern.popularizefield.md) | | |
| [prepBody()](./kibana-plugin-plugins-data-server.indexpattern.prepbody.md) | | |
| [refreshFields()](./kibana-plugin-plugins-data-server.indexpattern.refreshfields.md) | | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [migrate](./kibana-plugin-plugins-data-server.indexpattern.migrate.md)

## IndexPattern.migrate() method

<b>Signature:</b>

```typescript
migrate(newTitle: string): Promise<this>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| newTitle | <code>string</code> | |

<b>Returns:</b>

`Promise<this>`

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
prepBody(): {
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
intervalName: string | null | undefined;
sourceFilters: string | undefined;
fields: string | undefined;
fieldFormatMap: string | undefined;
Expand All @@ -23,7 +23,7 @@ prepBody(): {
`{
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
intervalName: string | null | undefined;
sourceFilters: string | undefined;
fields: string | undefined;
fieldFormatMap: string | undefined;
Expand Down
53 changes: 50 additions & 3 deletions src/plugins/data/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ export type IMetricAggType = MetricAggType;
// @public (undocumented)
export class IndexPattern implements IIndexPattern {
// Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts
constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, shortDotsEnable, metaFields, }: IndexPatternDeps);
constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, }: IndexPatternDeps);
// (undocumented)
addScriptedField(name: string, script: string, fieldType: string | undefined, lang: string): Promise<void>;
// (undocumented)
Expand Down Expand Up @@ -673,6 +673,8 @@ export class IndexPattern implements IIndexPattern {
getFieldByName(name: string): IndexPatternField | undefined;
// (undocumented)
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
// (undocumented)
getIndex(): string;
// Warning: (ae-forgotten-export) The symbol "IndexPatternField" needs to be exported by the entry point index.d.ts
//
// (undocumented)
Expand All @@ -688,9 +690,54 @@ export class IndexPattern implements IIndexPattern {
// (undocumented)
id?: string;
// (undocumented)
intervalName?: string | null;
init(): Promise<this>;
// Warning: (ae-forgotten-export) The symbol "IndexPatternSpec" needs to be exported by the entry point index.d.ts
//
// (undocumented)
timeFieldName?: string;
initFromSpec(spec: IndexPatternSpec): this;
// (undocumented)
intervalName: string | undefined | null;
// (undocumented)
isTimeBased(): boolean;
// (undocumented)
isTimeBasedWildcard(): boolean;
// (undocumented)
isTimeNanosBased(): boolean;
// (undocumented)
isUnsupportedTimePattern(): boolean;
// (undocumented)
isWildcard(): boolean;
// (undocumented)
metaFields: string[];
// (undocumented)
migrate(newTitle: string): Promise<this>;
// (undocumented)
originalBody: {
[key: string]: any;
};
// (undocumented)
popularizeField(fieldName: string, unit?: number): Promise<void>;
// (undocumented)
prepBody(): {
title: string;
timeFieldName: string | undefined;
intervalName: string | null | undefined;
sourceFilters: string | undefined;
fields: string | undefined;
fieldFormatMap: string | undefined;
type: string | undefined;
typeMeta: string | undefined;
};
// (undocumented)
refreshFields(): Promise<void | Error | never[] | undefined>;
// (undocumented)
removeScriptedField(fieldName: string): void;
// Warning: (ae-forgotten-export) The symbol "SourceFilter" needs to be exported by the entry point index.d.ts
//
// (undocumented)
sourceFilters?: SourceFilter[];
// (undocumented)
timeFieldName: string | undefined;
// (undocumented)
title: string;
// (undocumented)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { IUiSettingsClient, SavedObjectsClientContract } from 'kibana/server';
import { EsQueryConfig } from 'src/plugins/data/server';
import { esQuery, Filter, Query } from '../../../../../../../src/plugins/data/server';
import { TimeRangeParams } from '../../common';
import { TimeRangeParams } from '../../../types';
import { GenerateCsvParams } from '../../csv/generate_csv';
import {
DocValueFields,
Expand Down

0 comments on commit 726b92b

Please sign in to comment.