Skip to content
This repository has been archived by the owner on Mar 15, 2021. It is now read-only.

Latest commit

 

History

History
159 lines (144 loc) · 11.3 KB

kibana-plugin-plugins-data-public.md

File metadata and controls

159 lines (144 loc) · 11.3 KB

Home > kibana-plugin-plugins-data-public

kibana-plugin-plugins-data-public package

Classes

Class Description
AggParamType
FieldFormat
FilterManager
IndexPattern
IndexPatternField
IndexPatternSelect
OptionedParamType
Plugin
RequestTimeoutError Class used to signify that a request timed out. Useful for applications to conditionally handle this type of error differently than other errors.
SearchError
SearchInterceptor
TimeHistory

Enumerations

Enumeration Description
BUCKET_TYPES
ES_FIELD_TYPES *
KBN_FIELD_TYPES *
METRIC_TYPES
QuerySuggestionTypes
SortDirection

Functions

Function Description
getDefaultQuery(language)
getEsPreference(uiSettings, sessionId)
getQueryLog(uiSettings, storage, appName, language)
getSearchErrorType({ message })
getTime(indexPattern, timeRange, options)
plugin(initializerContext)

Interfaces

Interface Description
AggParamOption
DataPublicPluginSetup
DataPublicPluginStart
EsQueryConfig
FetchOptions
FieldFormatConfig
Filter
IDataPluginServices
IEsSearchRequest
IEsSearchResponse
IFieldSubType
IFieldType
IIndexPattern
IIndexPatternFieldList
IKibanaSearchRequest
IKibanaSearchResponse
IndexPatternAttributes Use data plugin interface instead
IndexPatternTypeMeta
IRequestTypesMap
IResponseTypesMap
ISearchOptions
ISearchStrategy Search strategy interface contains a search method that takes in a request and returns a promise that resolves to a response.
ISyncSearchRequest
KueryNode
OptionedValueProp
Query
QueryState All query state service state
QuerySuggestionBasic *
QuerySuggestionField *
QuerySuggestionGetFnArgs *
RangeFilterParams
RefreshInterval
SavedQuery
SavedQueryService
SearchSourceFields
TabbedAggColumn *
TabbedTable *
TimeRange

Variables

Variable Description
AggGroupLabels
AggGroupNames
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
extractSearchSourceReferences
fieldFormats
FilterBar
getIndexPatternFieldListCreator
getKbnTypeNames Get the esTypes known by all kbnFieldTypes {Array}
indexPatterns
injectSearchSourceReferences
parseSearchSourceJSON
QueryStringInput
search
SearchBar
SYNC_SEARCH_STRATEGY
syncQueryStateWithUrl Helper to setup syncing of global data with the URL
UI_SETTINGS

Type Aliases

Type Alias Description
AggConfigOptions
AggGroupName
AggParam
CustomFilter
EsQuerySortValue
ExistsFilter
FieldFormatId id type is needed for creating custom converters.
FieldFormatsContentType *
FieldFormatsGetConfigFn
IAggConfig AggConfig This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app.
IAggType
IFieldFormat
IFieldFormatsRegistry
IFieldParamType
IMetricAggType
IndexPatternAggRestrictions
IndexPatternsContract
InputTimeRange
ISearch
ISearchGeneric
ISearchSource *
MatchAllFilter
ParsedInterval
PhraseFilter
PhrasesFilter
QuerySuggestion *
QuerySuggestionGetFn
RangeFilter
RangeFilterMeta
SavedQueryTimeFilter
SearchBarProps
SearchRequest
SearchResponse
StatefulSearchBarProps
TabbedAggRow *
TimefilterContract
TimeHistoryContract