maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/data_autocomplete.json
Stacey Gammon cecdcc538e
API docs clean up (#93508) 
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00

415 lines
12 KiB
JSON
Raw Blame History

{
"id": "data.autocomplete",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.QuerySuggestionBasic",
"type": "Interface",
"label": "QuerySuggestionBasic",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.type",
"type": "Enum",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 37
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionTypes",
"text": "QuerySuggestionTypes"
}
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.description",
"type": "CompoundType",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 38
},
"signature": [
"string | JSX.Element | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.end",
"type": "number",
"label": "end",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.start",
"type": "number",
"label": "start",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 40
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 41
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionBasic.cursorIndex",
"type": "number",
"label": "cursorIndex",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 42
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionField",
"type": "Interface",
"label": "QuerySuggestionField",
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionField",
"text": "QuerySuggestionField"
},
" extends ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionBasic",
"text": "QuerySuggestionBasic"
}
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionField.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 47
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionTypes",
"text": "QuerySuggestionTypes"
},
".Field"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionField.field",
"type": "Object",
"label": "field",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 48
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionGetFnArgs",
"type": "Interface",
"label": "QuerySuggestionGetFnArgs",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.language",
"type": "string",
"label": "language",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.indexPatterns",
"type": "Array",
"label": "indexPatterns",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.query",
"type": "string",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.selectionStart",
"type": "number",
"label": "selectionStart",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 28
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.selectionEnd",
"type": "number",
"label": "selectionEnd",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 29
}
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.signal",
"type": "Object",
"label": "signal",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 30
},
"signature": [
"AbortSignal | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.useTimeRange",
"type": "CompoundType",
"label": "useTimeRange",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 31
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QuerySuggestionGetFnArgs.boolFilter",
"type": "Any",
"label": "boolFilter",
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 32
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 24
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.QuerySuggestionTypes",
"type": "Enum",
"label": "QuerySuggestionTypes",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 11
},
"initialIsOpen": false
}
],
"misc": [
{
"id": "def-public.AutocompleteStart",
"type": "Type",
"label": "AutocompleteStart",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/autocomplete_service.ts",
"lineNumber": 93
},
"signature": [
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
],
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestion",
"type": "Type",
"label": "QuerySuggestion",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionBasic",
"text": "QuerySuggestionBasic"
},
" | ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionField",
"text": "QuerySuggestionField"
}
],
"initialIsOpen": false
},
{
"id": "def-public.QuerySuggestionGetFn",
"type": "Type",
"label": "QuerySuggestionGetFn",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
"lineNumber": 19
},
"signature": [
"(args: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFnArgs",
"text": "QuerySuggestionGetFnArgs"
},
") => Promise<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataAutocompletePluginApi",
"section": "def-public.QuerySuggestion",
"text": "QuerySuggestion"
},
"[]> | undefined"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink