kibana/api_docs/index_pattern_field_editor.json
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

781 lines
27 KiB
JSON

{
"id": "indexPatternFieldEditor",
"client": {
"classes": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor",
"type": "Class",
"tags": [],
"label": "DefaultFormatEditor",
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.DefaultFormatEditor",
"text": "DefaultFormatEditor"
},
"<P, S> extends React.PureComponent<",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<P>, ",
"FormatEditorState",
" & S, any>"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.formatId",
"type": "string",
"tags": [],
"label": "formatId",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.state",
"type": "CompoundType",
"tags": [],
"label": "state",
"description": [],
"signature": [
"FormatEditorState",
" & S"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps",
"type": "Function",
"tags": [],
"label": "getDerivedStateFromProps",
"description": [],
"signature": [
"(nextProps: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<{}>, state: ",
"FormatEditorState",
") => { error: string | undefined; samples: ",
"Sample",
"[]; }"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$1",
"type": "Object",
"tags": [],
"label": "nextProps",
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<{}>"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps.$2",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"FormatEditorState"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"(newParams?: {}) => void"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.onChange.$1",
"type": "Object",
"tags": [],
"label": "newParams",
"description": [],
"signature": [
"{}"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.DefaultFormatEditor.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps",
"type": "Interface",
"tags": [],
"label": "FormatEditorProps",
"description": [
"\nProps for received by {@link FieldFormatEditor}"
],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<P>"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.fieldType",
"type": "string",
"tags": [],
"label": "fieldType",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.formatParams",
"type": "CompoundType",
"tags": [],
"label": "formatParams",
"description": [],
"signature": [
"{ type?: string | undefined; } & P"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"(newParams: { [key: string]: any; }) => void"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.onChange.$1",
"type": "Object",
"tags": [],
"label": "newParams",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.onChange.$1.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.onError",
"type": "Function",
"tags": [],
"label": "onError",
"description": [],
"signature": [
"(error?: string | undefined) => void"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FormatEditorProps.onError.$1",
"type": "string",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/field_format_editor.tsx",
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions",
"type": "Interface",
"tags": [],
"label": "OpenFieldDeleteModalOptions",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.ctx",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"{ indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }"
],
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.onDelete",
"type": "Function",
"tags": [],
"label": "onDelete",
"description": [],
"signature": [
"((fieldNames: string[]) => void) | undefined"
],
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.onDelete.$1",
"type": "Array",
"tags": [],
"label": "fieldNames",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldDeleteModalOptions.fieldName",
"type": "CompoundType",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions",
"type": "Interface",
"tags": [],
"label": "OpenFieldEditorOptions",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.ctx",
"type": "Object",
"tags": [],
"label": "ctx",
"description": [],
"signature": [
"{ indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }"
],
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [],
"signature": [
"((field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
") => void) | undefined"
],
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.onSave.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
}
],
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.OpenFieldEditorOptions.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldFormatEditor",
"type": "Type",
"tags": [],
"label": "FieldFormatEditor",
"description": [
"\nA React component for editing custom field format params"
],
"signature": [
"(React.ComponentClass<",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<FormatParams>, any> & { formatId: string; }) | (React.FunctionComponent<",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FormatEditorProps",
"text": "FormatEditorProps"
},
"<FormatParams>> & { formatId: string; })"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.FieldFormatEditorFactory",
"type": "Type",
"tags": [],
"label": "FieldFormatEditorFactory",
"description": [
"\nA factory for registering field format editor for a field format with `formatId`"
],
"signature": [
"(() => Promise<",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FieldFormatEditor",
"text": "FieldFormatEditor"
},
"<FormatParams>>) & { formatId: string; }"
],
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginSetup",
"type": "Interface",
"tags": [],
"label": "PluginSetup",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginSetup.fieldFormatEditors",
"type": "Object",
"tags": [],
"label": "fieldFormatEditors",
"description": [],
"signature": [
"{ register: (editor: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FieldFormatEditorFactory",
"text": "FieldFormatEditorFactory"
},
"<any>) => void; }"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart",
"type": "Interface",
"tags": [],
"label": "PluginStart",
"description": [],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openEditor",
"type": "Function",
"tags": [],
"label": "openEditor",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldEditorOptions",
"text": "OpenFieldEditorOptions"
},
") => () => void"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openEditor.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldEditorOptions",
"text": "OpenFieldEditorOptions"
}
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openDeleteModal",
"type": "Function",
"tags": [],
"label": "openDeleteModal",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldDeleteModalOptions",
"text": "OpenFieldDeleteModalOptions"
},
") => () => void"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.openDeleteModal.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.OpenFieldDeleteModalOptions",
"text": "OpenFieldDeleteModalOptions"
}
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.fieldFormatEditors",
"type": "Object",
"tags": [],
"label": "fieldFormatEditors",
"description": [],
"signature": [
"{ getAll: () => ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FieldFormatEditorFactory",
"text": "FieldFormatEditorFactory"
},
"<any>[]; getById: (id: string) => ",
{
"pluginId": "indexPatternFieldEditor",
"scope": "public",
"docId": "kibIndexPatternFieldEditorPluginApi",
"section": "def-public.FieldFormatEditorFactory",
"text": "FieldFormatEditorFactory"
},
"<any> | undefined; }"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.userPermissions",
"type": "Object",
"tags": [],
"label": "userPermissions",
"description": [],
"signature": [
"{ editIndexPattern: () => boolean; }"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider",
"type": "Function",
"tags": [],
"label": "DeleteRuntimeFieldProvider",
"description": [],
"signature": [
"React.FunctionComponent<",
"Props",
">"
],
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternFieldEditor",
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}