kibana/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md

Home > kibana-plugin-plugins-data-public

kibana-plugin-plugins-data-public package

Classes

Class	Description
AggConfig
AggConfigs
AggParamType
DuplicateIndexPatternError
FieldFormat
FilterManager
IndexPattern
IndexPatternField
IndexPatternsService
OptionedParamType
PainlessError
Plugin
SearchInterceptor
SearchSource	*
SearchTimeoutError	Request Failure - When an entire multi request fails
TimeHistory

Enumerations

Enumeration	Description
BUCKET_TYPES
ES_FIELD_TYPES	*
KBN_FIELD_TYPES	*
METRIC_TYPES
QuerySuggestionTypes
SearchSessionState	Possible state that current session can be in
SortDirection
TimeoutErrorMode

Functions

Function	Description
getDefaultQuery(language)
getEsPreference(uiSettings, sessionId)
getSearchParamsFromRequest(searchRequest, dependencies)
getTime(indexPattern, timeRange, options)
isEsError(e)	Checks if a given errors originated from Elasticsearch. Those params are assigned to the attributes property of an error.
plugin(initializerContext)
waitUntilNextSessionCompletes$(sessionService, { waitForIdle })	Creates an observable that emits when next search session completes. This utility is helpful to use in the application to delay some tasks until next session completes.

Interfaces

Interface	Description
AggFunctionsMapping	A global list of the expression function definitions for each agg type function.
AggParamOption
ApplyGlobalFilterActionContext
DataPublicPluginSetup	Data plugin public Setup contract
DataPublicPluginStart	Data plugin public Start contract
DataPublicPluginStartActions	utilities to generate filters from action context
DataPublicPluginStartUi	Data plugin prewired UI components
EsQueryConfig
FieldFormatConfig
IDataPluginServices
IEsSearchRequest
IFieldSubType
IFieldType
IIndexPattern
IIndexPatternFieldList
IKibanaSearchRequest
IKibanaSearchResponse
IndexPatternAttributes	Interface for an index pattern saved object
IndexPatternSpec	Static index pattern format Serialized data object, representing index pattern attributes and state
IndexPatternTypeMeta
ISearchOptions
ISearchSetup	The setup contract exposed by the Search plugin exposes the search strategy extension point.
ISearchStart	search service
ISearchStartSearchSource	high level search service
KueryNode
OptionedValueProp
QueryState	All query state service state
QueryStateChange
QueryStringInputProps
QuerySuggestionBasic	*
QuerySuggestionField	*
QuerySuggestionGetFnArgs	*
RangeFilterParams
Reason
RefreshInterval
SavedQuery
SavedQueryService
SearchError
SearchInterceptorDeps
SearchSessionInfoProvider	Provide info about current search session to be stored in the Search Session saved object
SearchSourceFields	search source fields
WaitUntilNextSessionCompletesOptions	Options for waitUntilNextSessionCompletes$()

Variables

Variable	Description
ACTION_GLOBAL_APPLY_FILTER
AggGroupLabels
AggGroupNames
APPLY_FILTER_TRIGGER
baseFormattersPublic
castEsToKbnFieldTypeName	Get the KbnFieldType name for an esType string
connectToQueryState	Helper to setup two-way syncing of global data and a state container
createSavedQueryService
ES_SEARCH_STRATEGY
esFilters
esKuery
esQuery
exporters
extractSearchSourceReferences
fieldFormats
fieldList
getKbnTypeNames	Get the esTypes known by all kbnFieldTypes {Array}
indexPatterns
injectSearchSourceReferences
isCompleteResponse
isErrorResponse
isFilter
isFilters
isPartialResponse
isQuery
isTimeRange
noSearchSessionStorageCapabilityMessage	Message to display in case storing session session is disabled due to turned off capability
parseSearchSourceJSON
QueryStringInput
SEARCH_SESSIONS_MANAGEMENT_ID
search
SearchBar
syncQueryStateWithUrl	Helper to setup syncing of global data with the URL
UI_SETTINGS

Type Aliases

Type Alias	Description
AggConfigOptions
AggGroupName
AggParam
AggsStart	AggsStart represents the actual external contract as AggsCommonStart is only used internally. The difference is that AggsStart includes the typings for the registry with initialized agg types.
AutocompleteStart	*
AutoRefreshDoneFn
CustomFilter
EsaggsExpressionFunctionDefinition
EsdslExpressionFunctionDefinition
EsQuerySortValue
EsRawResponseExpressionTypeDefinition
ExecutionContextSearch
ExistsFilter
ExpressionFunctionKibana
ExpressionFunctionKibanaContext
ExpressionValueSearchContext
FieldFormatId	id type is needed for creating custom converters.
FieldFormatsContentType	*
FieldFormatsGetConfigFn
FieldFormatsStart
Filter
IAggConfig	AggConfig This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app.
IAggType
IEsError
IEsSearchResponse
IFieldFormat
IFieldFormatsRegistry
IFieldParamType
IMetricAggType
IndexPatternAggRestrictions
IndexPatternLoadExpressionFunctionDefinition
IndexPatternsContract
IndexPatternSelectProps
InputTimeRange
ISearchGeneric
ISearchSource	search source interface
ISessionsClient
ISessionService
KibanaContext
MatchAllFilter
ParsedInterval
PhraseFilter
PhrasesFilter
Query
QueryStart
QuerySuggestion	*
QuerySuggestionGetFn
RangeFilter
RangeFilterMeta
SavedQueryTimeFilter
SearchBarProps
StatefulSearchBarProps
TimefilterContract
TimeHistoryContract
TimeRange