kibana/api_docs/data_ui.json

539 lines
38 KiB
JSON
Raw Normal View History

{
"id": "data.ui",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.QueryStringInput",
"type": "Function",
"children": [
{
"type": "Object",
"label": "props",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
}
],
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/index.tsx",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24"
}
}
],
"signature": [
"(props: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.QueryStringInputProps",
"text": "QueryStringInputProps"
},
") => JSX.Element"
],
"description": [],
"label": "QueryStringInput",
"source": {
"path": "src/plugins/data/public/ui/query_string_input/index.tsx",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.QueryStringInputProps",
"type": "Interface",
"label": "QueryStringInputProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.QueryStringInputProps.indexPatterns",
"type": "Array",
"label": "indexPatterns",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L42"
},
"signature": [
"(string | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
")[]"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L43"
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
}
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.disableAutoFocus",
"type": "CompoundType",
"label": "disableAutoFocus",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L44"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.screenTitle",
"type": "string",
"label": "screenTitle",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L45"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.prepend",
"type": "Any",
"label": "prepend",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L46"
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.persistedLog",
"type": "Object",
"label": "persistedLog",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L47"
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.PersistedLog",
"text": "PersistedLog"
},
"<any> | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.bubbleSubmitEvent",
"type": "CompoundType",
"label": "bubbleSubmitEvent",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L48"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.placeholder",
"type": "string",
"label": "placeholder",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L49"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.disableLanguageSwitcher",
"type": "CompoundType",
"label": "disableLanguageSwitcher",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L50"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition",
"type": "CompoundType",
"label": "languageSwitcherPopoverAnchorPosition",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L51"
},
"signature": [
"\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.onBlur",
"type": "Function",
"label": "onBlur",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L52"
},
"signature": [
"(() => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.onChange",
"type": "Function",
"label": "onChange",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L53"
},
"signature": [
"((query: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus",
"type": "Function",
"label": "onChangeQueryInputFocus",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L54"
},
"signature": [
"((isFocused: boolean) => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.onSubmit",
"type": "Function",
"label": "onSubmit",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L55"
},
"signature": [
"((query: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
") => void) | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.dataTestSubj",
"type": "string",
"label": "dataTestSubj",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L56"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.size",
"type": "CompoundType",
"label": "size",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L57"
},
"signature": [
"\"s\" | \"l\" | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.className",
"type": "string",
"label": "className",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L58"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.isInvalid",
"type": "CompoundType",
"label": "isInvalid",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L59"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.isClearable",
"type": "CompoundType",
"label": "isClearable",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L60"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.iconType",
"type": "CompoundType",
"label": "iconType",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L61"
},
"signature": [
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.nonKqlMode",
"type": "CompoundType",
"label": "nonKqlMode",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L67"
},
"signature": [
"\"text\" | \"lucene\" | undefined"
]
},
{
"tags": [],
"id": "def-public.QueryStringInputProps.nonKqlModeHelpText",
"type": "string",
"label": "nonKqlModeHelpText",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L68"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L41"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.SearchBar",
"type": "CompoundType",
"label": "SearchBar",
"description": [],
"source": {
"path": "src/plugins/data/public/ui/search_bar/index.tsx",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/index.tsx#L23"
},
"signature": [
"React.ComponentClass<Pick<Pick<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.SearchBarProps",
"text": "SearchBarProps"
},
", \"filters\" | \"query\" | \"intl\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType<Pick<",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataUiPluginApi",
"section": "def-public.SearchBarProps",
"text": "SearchBarProps"
},
", \"filters\" | \"query\" | \"intl\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & ReactIntl.InjectedIntlProps>; }"
],
"initialIsOpen": false
},
{
"id": "def-public.SearchBarProps",
"type": "Type",
"label": "SearchBarProps",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/ui/search_bar/search_bar.tsx",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/search_bar.tsx#L80"
},
"signature": [
"SearchBarOwnProps & SearchBarInjectedDeps"
],
"initialIsOpen": false
},
{
"id": "def-public.StatefulSearchBarProps",
"type": "Type",
"label": "StatefulSearchBarProps",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/ui/search_bar/create_search_bar.tsx",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/create_search_bar.tsx#L31"
},
"signature": [
"SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternSelectProps",
"type": "Type",
"label": "IndexPatternSelectProps",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx#L17"
},
"signature": [
"Pick<Pick<EuiComboBoxProps<any>, \"children\" | \"onClick\" | \"color\" | \"id\" | \"title\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}