28d0cf4485
* Add doc building for data plugin * Added data server md file * index file for suggestion component * Clear out internal imports from public API * Remove FunctionalComponent usage * comment out working docs * Added fixes following @octogonz feedback * new docs * Clean up * Clean up 2 * fix jest * rename docs script file * update tasks * tasks * update docs
2.8 KiB
2.8 KiB
Home > kibana-plugin-plugins-data-public > SearchSource
SearchSource class
Signature:
export declare class SearchSource
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(fields) | Constructs a new instance of the SearchSource class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| history | SearchRequest[] |
Methods
| Method | Modifiers | Description |
|---|---|---|
| create() | ||
| createChild(options) | ||
| createCopy() | ||
| destroy() | Completely destroy the SearchSource. {undefined} | |
| fetch(options) | Fetch this source and reject the returned Promise on error | |
| getField(field, recurse) | Get fields from the fields | |
| getFields() | ||
| getId() | ||
| getOwnField(field) | Get the field from our own fields, don't traverse up the chain | |
| getParent() | Get the parent of this SearchSource {undefined|searchSource} | |
| getSearchRequestBody() | ||
| onRequestStart(handler) | Add a handler that will be notified whenever requests start | |
| setField(field, value) | ||
| setFields(newFields) | ||
| setParent(parent, options) | Set a searchSource that this source should inherit from | |
| setPreferredSearchStrategyId(searchStrategyId) | *** PUBLIC API *** |