github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/unified_search.devdocs.json

2411 lines
No EOL
87 KiB
JSON
Raw Blame History

{
"id": "unifiedSearch",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPicker",
"type": "Function",
"tags": [],
"label": "DataViewPicker",
"description": [],
"signature": [
"({ isMissingCurrent, currentDataViewId, adHocDataViews, savedDataViews, onChangeDataView, onEditDataView, onAddField, onDataViewCreated, trigger, selectableProps, textBasedLanguages, onSaveTextLanguageQuery, onTextLangQuerySubmit, textBasedLanguage, onCreateDefaultAdHocDataView, isDisabled, }: ",
"DataViewPickerPropsExtended",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPicker.$1",
"type": "Object",
"tags": [],
"label": "{\n isMissingCurrent,\n currentDataViewId,\n adHocDataViews,\n savedDataViews,\n onChangeDataView,\n onEditDataView,\n onAddField,\n onDataViewCreated,\n trigger,\n selectableProps,\n textBasedLanguages,\n onSaveTextLanguageQuery,\n onTextLangQuerySubmit,\n textBasedLanguage,\n onCreateDefaultAdHocDataView,\n isDisabled,\n}",
"description": [],
"signature": [
"DataViewPickerPropsExtended"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewSelector",
"type": "Function",
"tags": [],
"label": "DataViewSelector",
"description": [],
"signature": [
"({ currentDataViewId, searchListInputId, dataViewsList, selectableProps, isTextBasedLangSelected, setPopoverIsOpen, onChangeDataView, onCreateDefaultAdHocDataView, }: DataViewSelectorProps) => JSX.Element"
],
"path": "src/plugins/unified_search/public/dataview_picker/data_view_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewSelector.$1",
"type": "Object",
"tags": [],
"label": "{\n currentDataViewId,\n searchListInputId,\n dataViewsList,\n selectableProps,\n isTextBasedLangSelected,\n setPopoverIsOpen,\n onChangeDataView,\n onCreateDefaultAdHocDataView,\n}",
"description": [],
"signature": [
"DataViewSelectorProps"
],
"path": "src/plugins/unified_search/public/dataview_picker/data_view_selector.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewsList",
"type": "Function",
"tags": [],
"label": "DataViewsList",
"description": [],
"signature": [
"({\n dataViewsList,\n onChangeDataView,\n isTextBasedLangSelected,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}: ",
"DataViewsListProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewsList.$1",
"type": "Object",
"tags": [],
"label": "{\n dataViewsList,\n onChangeDataView,\n isTextBasedLangSelected,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}",
"description": [],
"signature": [
"DataViewsListProps"
],
"path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItem",
"type": "Function",
"tags": [],
"label": "FilterItem",
"description": [
"\nRenders a single filter pill"
],
"signature": [
"(props: ",
"FilterItemProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItem.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FilterItemProps"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItems",
"type": "Function",
"tags": [],
"label": "FilterItems",
"description": [
"\nRenders a group of filter pills"
],
"signature": [
"(props: Pick<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.FilterItemsProps",
"text": "FilterItemsProps"
},
", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes<React.Component<Pick<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.FilterItemsProps",
"text": "FilterItemsProps"
},
", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\">, any, any>>) => JSX.Element"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItems.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.FilterItemsProps",
"text": "FilterItemsProps"
},
", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes<React.Component<Pick<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.FilterItemsProps",
"text": "FilterItemsProps"
},
", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\">, any, any>>"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterLabel",
"type": "Function",
"tags": [],
"label": "FilterLabel",
"description": [
"\nRenders the label for a single filter pill"
],
"signature": [
"(props: ",
"FilterLabelProps",
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterLabel.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FilterLabelProps"
],
"path": "src/plugins/unified_search/public/filter_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInput",
"type": "Function",
"tags": [],
"label": "QueryStringInput",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
},
") => JSX.Element"
],
"path": "src/plugins/unified_search/public/query_string_input/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInput.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
}
],
"path": "src/plugins/unified_search/public/query_string_input/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.SearchBar",
"type": "Function",
"tags": [],
"label": "SearchBar",
"description": [],
"signature": [
"<QT extends ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" = ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
">(props: Omit<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.SearchBarProps",
"text": "SearchBarProps"
},
"<QT>, \"kibana\" | \"intl\">) => JSX.Element"
],
"path": "src/plugins/unified_search/public/search_bar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.SearchBar.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"{ query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | QT | undefined; dataTestSubj?: string | undefined; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; savedQuery?: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
" | undefined; refreshInterval?: number | undefined; placeholder?: string | undefined; iconType?: ",
"IconType",
" | undefined; indexPatterns?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[] | undefined; isDisabled?: boolean | undefined; isLoading?: boolean | undefined; timeHistory?: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.TimeHistoryContract",
"text": "TimeHistoryContract"
},
" | undefined; customSubmitButton?: React.ReactNode; screenTitle?: string | undefined; showQueryMenu?: boolean | undefined; showQueryInput?: boolean | undefined; showFilterBar?: boolean | undefined; showDatePicker?: boolean | undefined; showAutoRefreshOnly?: boolean | undefined; hiddenFilterPanelOptions?: ",
"FilterPanelOption",
"[] | undefined; isRefreshPaused?: boolean | undefined; dateRangeFrom?: string | undefined; dateRangeTo?: string | undefined; showSaveQuery?: boolean | undefined; onQueryChange?: ((payload: { dateRange: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | QT | undefined; }) => void) | undefined; onQuerySubmit?: ((payload: { dateRange: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | QT | undefined; }, isUpdate?: boolean | undefined) => void) | undefined; onSaved?: ((savedQuery: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
") => void) | undefined; onSavedQueryUpdated?: ((savedQuery: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.SavedQuery",
"text": "SavedQuery"
},
") => void) | undefined; onClearSavedQuery?: (() => void) | undefined; onRefresh?: ((payload: { dateRange: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; }) => void) | undefined; indicateNoData?: boolean | undefined; isClearable?: boolean | undefined; nonKqlMode?: \"text\" | \"lucene\" | undefined; displayStyle?: \"inPage\" | \"detached\" | undefined; fillSubmitButton?: boolean | undefined; dataViewPickerComponentProps?: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.DataViewPickerProps",
"text": "DataViewPickerProps"
},
" | undefined; textBasedLanguageModeErrors?: Error[] | undefined; onTextBasedSavedAndExit?: (({ onSave }: ",
"OnSaveTextLanguageQueryProps",
") => void) | undefined; showSubmitButton?: boolean | undefined; submitButtonStyle?: \"auto\" | \"full\" | \"iconOnly\" | undefined; suggestionsSize?: ",
"SuggestionsListSize",
" | undefined; isScreenshotMode?: boolean | undefined; onFiltersUpdated?: ((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined; onRefreshChange?: ((options: { isPaused: boolean; refreshInterval: number; }) => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/search_bar/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext",
"type": "Interface",
"tags": [],
"label": "ApplyGlobalFilterActionContext",
"description": [],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any> | undefined"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ApplyGlobalFilterActionContext.controlledBy",
"type": "string",
"tags": [],
"label": "controlledBy",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps",
"type": "Interface",
"tags": [],
"label": "DataViewPickerProps",
"description": [],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.trigger",
"type": "CompoundType",
"tags": [],
"label": "trigger",
"description": [
"\nThe properties of the button that triggers the dataview picker."
],
"signature": [
"EuiButtonProps",
" & { label: string; title?: string | undefined; }"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.isMissingCurrent",
"type": "CompoundType",
"tags": [],
"label": "isMissingCurrent",
"description": [
"\nFlag that should be enabled when the current dataview is missing."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onChangeDataView",
"type": "Function",
"tags": [],
"label": "onChangeDataView",
"description": [
"\nCallback that is called when the user changes the currently selected dataview."
],
"signature": [
"(newId: string) => void"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onChangeDataView.$1",
"type": "string",
"tags": [],
"label": "newId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onEditDataView",
"type": "Function",
"tags": [],
"label": "onEditDataView",
"description": [
"\nCallback that is called when the user edits the current data view via flyout.\nThe first parameter is the updated data view stub without fetched fields"
],
"signature": [
"((updatedDataViewStub: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onEditDataView.$1",
"type": "Object",
"tags": [],
"label": "updatedDataViewStub",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.currentDataViewId",
"type": "string",
"tags": [],
"label": "currentDataViewId",
"description": [
"\nThe id of the selected dataview."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.adHocDataViews",
"type": "Array",
"tags": [],
"label": "adHocDataViews",
"description": [
"\nThe adHocDataviews."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[] | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.savedDataViews",
"type": "Array",
"tags": [],
"label": "savedDataViews",
"description": [
"\nSaved data views"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[] | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.selectableProps",
"type": "CompoundType",
"tags": [],
"label": "selectableProps",
"description": [
"\nEuiSelectable properties."
],
"signature": [
"EuiSelectableProps",
"<{}> | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onAddField",
"type": "Function",
"tags": [],
"label": "onAddField",
"description": [
"\nCallback that is called when the user clicks the add runtime field option.\nAlso works as a flag to show the add runtime field button."
],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onDataViewCreated",
"type": "Function",
"tags": [],
"label": "onDataViewCreated",
"description": [
"\nCallback that is called when the user clicks the create dataview option.\nAlso works as a flag to show the create dataview button."
],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onCreateDefaultAdHocDataView",
"type": "Function",
"tags": [],
"label": "onCreateDefaultAdHocDataView",
"description": [],
"signature": [
"((pattern: string) => void) | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onCreateDefaultAdHocDataView.$1",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.textBasedLanguages",
"type": "Array",
"tags": [],
"label": "textBasedLanguages",
"description": [
"\nList of the supported text based languages (SQL, ESQL) etc.\nDefined per application, if not provided, no text based languages\nwill be available."
],
"signature": [
"TextBasedLanguages",
"[] | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onSaveTextLanguageQuery",
"type": "Function",
"tags": [],
"label": "onSaveTextLanguageQuery",
"description": [
"\nCallback that is called when the user clicks the Save and switch transition modal button"
],
"signature": [
"(({ onSave, onCancel }: ",
"OnSaveTextLanguageQueryProps",
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.onSaveTextLanguageQuery.$1",
"type": "Object",
"tags": [],
"label": "{ onSave, onCancel }",
"description": [],
"signature": [
"OnSaveTextLanguageQueryProps"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.DataViewPickerProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [
"\nMakes the picker disabled by disabling the popover trigger"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/dataview_picker/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps",
"type": "Interface",
"tags": [],
"label": "FilterItemsProps",
"description": [
"\nProperties for the filter items component, which will render a single filter pill for every filter that is sent in\nas part of the `Filter[]` property."
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"Array of filters that will be rendered as filter pills"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.readOnly",
"type": "CompoundType",
"tags": [],
"label": "readOnly",
"description": [
"Optional property that controls whether or not clicking the filter pill opens a popover *and* whether\nor not the `x` button to remove the filter is rendered."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.onFiltersUpdated",
"type": "Function",
"tags": [],
"label": "onFiltersUpdated",
"description": [
"If not read only, this is called whenever a filter is removed and/or updated"
],
"signature": [
"((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.onFiltersUpdated.$1",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [
"A list of all dataviews that are used for the filters"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.intl",
"type": "Object",
"tags": [],
"label": "intl",
"description": [
"This is injected by the lazer loader"
],
"signature": [
"ReactIntl.InjectedIntl"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.timeRangeForSuggestionsOverride",
"type": "CompoundType",
"tags": [],
"label": "timeRangeForSuggestionsOverride",
"description": [
"Controls whether or not filter suggestions are influenced by the global time"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.FilterItemsProps.hiddenPanelOptions",
"type": "Array",
"tags": [],
"label": "hiddenPanelOptions",
"description": [
"Array of panel options that controls the styling of each filter pill"
],
"signature": [
"FilterPanelOption",
"[] | undefined"
],
"path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices",
"type": "Interface",
"tags": [],
"label": "IUnifiedSearchPluginServices",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.IUnifiedSearchPluginServices",
"text": "IUnifiedSearchPluginServices"
},
" extends Partial<",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
">"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.unifiedSearch",
"type": "Object",
"tags": [],
"label": "unifiedSearch",
"description": [],
"signature": [
"{ autocomplete: { getQuerySuggestions: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",
"ValueSuggestionsGetFn",
"; }; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.appName",
"type": "string",
"tags": [],
"label": "appName",
"description": [],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.uiSettings",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-ui-settings-browser",
"scope": "common",
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.savedObjects",
"type": "Object",
"tags": [],
"label": "savedObjects",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsBrowserPluginApi",
"section": "def-common.SavedObjectsStart",
"text": "SavedObjectsStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.notifications",
"type": "Object",
"tags": [],
"label": "notifications",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-notifications-browser",
"scope": "common",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-common.NotificationsStart",
"text": "NotificationsStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.application",
"type": "Object",
"tags": [],
"label": "application",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.ApplicationStart",
"text": "ApplicationStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.storage",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.IStorageWrapper",
"text": "IStorageWrapper"
},
"<any, void>"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-doc-links-browser",
"scope": "common",
"docId": "kibKbnCoreDocLinksBrowserPluginApi",
"section": "def-common.DocLinksStart",
"text": "DocLinksStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.dataViewEditor",
"type": "Object",
"tags": [],
"label": "dataViewEditor",
"description": [],
"signature": [
{
"pluginId": "dataViewEditor",
"scope": "public",
"docId": "kibDataViewEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
}
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IUnifiedSearchPluginServices.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionStart",
"text": "UsageCollectionStart"
},
" | undefined"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps",
"type": "Interface",
"tags": [],
"label": "QueryStringInputProps",
"description": [],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [],
"signature": [
"(string | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | ",
"DataViewByIdOrTitle",
")[]"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.disableAutoFocus",
"type": "CompoundType",
"tags": [],
"label": "disableAutoFocus",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.screenTitle",
"type": "string",
"tags": [],
"label": "screenTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.prepend",
"type": "Any",
"tags": [],
"label": "prepend",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.persistedLog",
"type": "Object",
"tags": [],
"label": "persistedLog",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.PersistedLog",
"text": "PersistedLog"
},
"<any> | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.bubbleSubmitEvent",
"type": "CompoundType",
"tags": [],
"label": "bubbleSubmitEvent",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.placeholder",
"type": "string",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.disableLanguageSwitcher",
"type": "CompoundType",
"tags": [],
"label": "disableLanguageSwitcher",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition",
"type": "CompoundType",
"tags": [],
"label": "languageSwitcherPopoverAnchorPosition",
"description": [],
"signature": [
"\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onBlur",
"type": "Function",
"tags": [],
"label": "onBlur",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"((query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChange.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus",
"type": "Function",
"tags": [],
"label": "onChangeQueryInputFocus",
"description": [],
"signature": [
"((isFocused: boolean) => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus.$1",
"type": "boolean",
"tags": [],
"label": "isFocused",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onSubmit",
"type": "Function",
"tags": [],
"label": "onSubmit",
"description": [],
"signature": [
"((query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void) | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.onSubmit.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.submitOnBlur",
"type": "CompoundType",
"tags": [],
"label": "submitOnBlur",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.size",
"type": "CompoundType",
"tags": [],
"label": "size",
"description": [],
"signature": [
"SuggestionsListSize",
" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.isInvalid",
"type": "CompoundType",
"tags": [],
"label": "isInvalid",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.isClearable",
"type": "CompoundType",
"tags": [],
"label": "isClearable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.iconType",
"type": "CompoundType",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"IconType",
" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.appName",
"type": "string",
"tags": [],
"label": "appName",
"description": [],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.deps",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"QueryStringInputDependencies"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.nonKqlMode",
"type": "CompoundType",
"tags": [],
"label": "nonKqlMode",
"description": [],
"signature": [
"\"text\" | \"lucene\" | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.autoSubmit",
"type": "CompoundType",
"tags": [],
"label": "autoSubmit",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.storageKey",
"type": "string",
"tags": [],
"label": "storageKey",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.QueryStringInputProps.timeRangeForSuggestionsOverride",
"type": "CompoundType",
"tags": [],
"label": "timeRangeForSuggestionsOverride",
"description": [
"\nOverride whether autocomplete suggestions are restricted by time range."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.ACTION_GLOBAL_APPLY_FILTER",
"type": "string",
"tags": [],
"label": "ACTION_GLOBAL_APPLY_FILTER",
"description": [],
"signature": [
"\"ACTION_GLOBAL_APPLY_FILTER\""
],
"path": "src/plugins/unified_search/public/actions/apply_filter_action.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.IndexPatternSelectProps",
"type": "Type",
"tags": [],
"label": "IndexPatternSelectProps",
"description": [],
"signature": [
"Omit",
"<Omit<",
"EuiComboBoxProps",
"<any>, \"options\" | \"onChange\" | \"selectedOptions\" | \"isLoading\" | \"onSearchChange\">, \"placeholder\"> & Required<Pick<Omit<",
"EuiComboBoxProps",
"<any>, \"options\" | \"onChange\" | \"selectedOptions\" | \"isLoading\" | \"onSearchChange\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; onNoIndexPatterns?: (() => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.SearchBarProps",
"type": "Type",
"tags": [],
"label": "SearchBarProps",
"description": [],
"signature": [
"SearchBarOwnProps",
"<QT> & ",
"SearchBarInjectedDeps"
],
"path": "src/plugins/unified_search/public/search_bar/search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.StatefulSearchBarProps",
"type": "Type",
"tags": [],
"label": "StatefulSearchBarProps",
"description": [],
"signature": [
"SearchBarOwnProps",
"<QT> & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; onFiltersUpdated?: ((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void) | undefined; }"
],
"path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UPDATE_FILTER_REFERENCES_ACTION",
"type": "string",
"tags": [],
"label": "UPDATE_FILTER_REFERENCES_ACTION",
"description": [],
"signature": [
"\"UPDATE_FILTER_REFERENCES_ACTION\""
],
"path": "src/plugins/unified_search/public/actions/update_filter_references_action.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UPDATE_FILTER_REFERENCES_TRIGGER",
"type": "string",
"tags": [],
"label": "UPDATE_FILTER_REFERENCES_TRIGGER",
"description": [],
"signature": [
"\"UPDATE_FILTER_REFERENCES_TRIGGER\""
],
"path": "src/plugins/unified_search/public/triggers/update_filter_references_trigger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchPublicPluginStart",
"description": [
"\nUnified search plugin public Start contract"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [
"\nautocomplete service\n{@link AutocompleteStart}"
],
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",
"ValueSuggestionsGetFn",
"; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPublicPluginStart.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [
"\nprewired UI components\n{@link UnifiedSearchPublicPluginStartUi}"
],
"signature": [
"UnifiedSearchPublicPluginStartUi"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPluginSetup",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchPluginSetup",
"description": [],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-public.UnifiedSearchPluginSetup.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [],
"signature": [
"{ getQuerySuggestions: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchAutocompletePluginApi",
"section": "def-public.QuerySuggestionGetFn",
"text": "QuerySuggestionGetFn"
},
"; getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }"
],
"path": "src/plugins/unified_search/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin",
"type": "Class",
"tags": [],
"label": "UnifiedSearchServerPlugin",
"description": [],
"signature": [
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPlugin",
"text": "UnifiedSearchServerPlugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-server",
"scope": "server",
"docId": "kibKbnCorePluginsServerPluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginSetup",
"text": "UnifiedSearchServerPluginSetup"
},
", void, object, object>"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-server",
"scope": "server",
"docId": "kibKbnCorePluginsServerPluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { timeout: moment.Duration; enabled: boolean; tiers: string[]; terminateAfter: moment.Duration; }>; }>; }>>"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"UnifiedSearchServerPluginStartDependencies",
", ",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginStart",
"text": "UnifiedSearchServerPluginStart"
},
">, {}: ",
"UnifiedSearchServerPluginSetupDependencies",
") => { autocomplete: { getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }; }"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"UnifiedSearchServerPluginStartDependencies",
", ",
{
"pluginId": "unifiedSearch",
"scope": "server",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-server.UnifiedSearchServerPluginStart",
"text": "UnifiedSearchServerPluginStart"
},
">"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{}",
"description": [],
"signature": [
"UnifiedSearchServerPluginSetupDependencies"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
", {}: ",
"UnifiedSearchServerPluginStartDependencies",
") => {}"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{}",
"description": [],
"signature": [
"UnifiedSearchServerPluginStartDependencies"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginStart",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchServerPluginStart",
"description": [],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "UnifiedSearchServerPluginSetup",
"description": [],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedSearch",
"id": "def-server.UnifiedSearchServerPluginSetup.autocomplete",
"type": "Object",
"tags": [],
"label": "autocomplete",
"description": [],
"signature": [
"{ getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }"
],
"path": "src/plugins/unified_search/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink