{ "id": "indexPatternFieldEditor", "client": { "classes": [ { "id": "def-public.DefaultFormatEditor", "type": "Class", "tags": [], "label": "DefaultFormatEditor", "description": [], "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.DefaultFormatEditor", "text": "DefaultFormatEditor" }, "
extends React.PureComponent<", "FormatEditorProps", "
, ", "FormatEditorState", " & S, any>" ], "children": [ { "tags": [], "id": "def-public.DefaultFormatEditor.formatId", "type": "string", "label": "formatId", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 75 } }, { "tags": [], "id": "def-public.DefaultFormatEditor.state", "type": "CompoundType", "label": "state", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 76 }, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.FormatEditorState", "text": "FormatEditorState" }, " & S" ] }, { "id": "def-public.DefaultFormatEditor.getDerivedStateFromProps", "type": "Function", "label": "getDerivedStateFromProps", "signature": [ "typeof ", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.DefaultFormatEditor", "text": "DefaultFormatEditor" }, ".getDerivedStateFromProps" ], "description": [], "children": [ { "type": "Object", "label": "nextProps", "isRequired": true, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.FormatEditorProps", "text": "FormatEditorProps" }, "<{}>" ], "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 78 } }, { "type": "Object", "label": "state", "isRequired": true, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.FormatEditorState", "text": "FormatEditorState" } ], "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 78 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 78 } }, { "id": "def-public.DefaultFormatEditor.onChange", "type": "Function", "children": [ { "type": "Object", "label": "newParams", "isRequired": true, "signature": [ "{}" ], "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 90 } } ], "signature": [ "(newParams?: {}) => void" ], "description": [], "label": "onChange", "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 90 }, "tags": [], "returnComment": [] }, { "id": "def-public.DefaultFormatEditor.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 99 } } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", "lineNumber": 71 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { "id": "def-public.FieldEditorContext", "type": "Interface", "label": "FieldEditorContext", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.FieldEditorContext.indexPattern", "type": "Object", "label": "indexPattern", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", "lineNumber": 28 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ] }, { "tags": [], "id": "def-public.FieldEditorContext.fieldTypeToProcess", "type": "CompoundType", "label": "fieldTypeToProcess", "description": [ "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", "lineNumber": 33 }, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.InternalFieldType", "text": "InternalFieldType" } ] }, { "tags": [], "id": "def-public.FieldEditorContext.search", "type": "Object", "label": "search", "description": [ "The search service from the data plugin" ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", "lineNumber": 35 }, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.ISearchStart", "text": "ISearchStart" } ] } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", "lineNumber": 27 }, "initialIsOpen": false }, { "id": "def-public.OpenFieldDeleteModalOptions", "type": "Interface", "label": "OpenFieldDeleteModalOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.OpenFieldDeleteModalOptions.ctx", "type": "Object", "label": "ctx", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 25 }, "signature": [ "{ indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, "; }" ] }, { "tags": [], "id": "def-public.OpenFieldDeleteModalOptions.onDelete", "type": "Function", "label": "onDelete", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 28 }, "signature": [ "((fieldNames: string[]) => void) | undefined" ] }, { "tags": [], "id": "def-public.OpenFieldDeleteModalOptions.fieldName", "type": "CompoundType", "label": "fieldName", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 29 }, "signature": [ "string | string[]" ] } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", "lineNumber": 24 }, "initialIsOpen": false }, { "id": "def-public.OpenFieldEditorOptions", "type": "Interface", "label": "OpenFieldEditorOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.OpenFieldEditorOptions.ctx", "type": "Object", "label": "ctx", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", "lineNumber": 28 }, "signature": [ "{ indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, "; }" ] }, { "tags": [], "id": "def-public.OpenFieldEditorOptions.onSave", "type": "Function", "label": "onSave", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", "lineNumber": 31 }, "signature": [ "((field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternField", "text": "IndexPatternField" }, ") => void) | undefined" ] }, { "tags": [], "id": "def-public.OpenFieldEditorOptions.fieldName", "type": "string", "label": "fieldName", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", "lineNumber": 32 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", "lineNumber": 27 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "start": { "id": "def-public.PluginStart", "type": "Interface", "label": "PluginStart", "description": [], "tags": [], "children": [ { "id": "def-public.PluginStart.openEditor", "type": "Function", "label": "openEditor", "signature": [ "(options: ", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.OpenFieldEditorOptions", "text": "OpenFieldEditorOptions" }, ") => () => void" ], "description": [], "children": [ { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.OpenFieldEditorOptions", "text": "OpenFieldEditorOptions" } ], "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 27 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 27 } }, { "id": "def-public.PluginStart.openDeleteModal", "type": "Function", "label": "openDeleteModal", "signature": [ "(options: ", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.OpenFieldDeleteModalOptions", "text": "OpenFieldDeleteModalOptions" }, ") => () => void" ], "description": [], "children": [ { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.OpenFieldDeleteModalOptions", "text": "OpenFieldDeleteModalOptions" } ], "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 28 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 28 } }, { "tags": [], "id": "def-public.PluginStart.fieldFormatEditors", "type": "Object", "label": "fieldFormatEditors", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 29 }, "signature": [ "{ getAll: () => typeof ", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.DefaultFormatEditor", "text": "DefaultFormatEditor" }, "[]; getById: (id: string) => typeof ", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.DefaultFormatEditor", "text": "DefaultFormatEditor" }, " | undefined; }" ] }, { "tags": [], "id": "def-public.PluginStart.userPermissions", "type": "Object", "label": "userPermissions", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 30 }, "signature": [ "{ editIndexPattern: () => boolean; }" ] }, { "tags": [], "id": "def-public.PluginStart.DeleteRuntimeFieldProvider", "type": "Function", "label": "DeleteRuntimeFieldProvider", "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 33 }, "signature": [ "React.FunctionComponent<", { "pluginId": "indexPatternFieldEditor", "scope": "public", "docId": "kibIndexPatternFieldEditorPluginApi", "section": "def-public.Props", "text": "Props" }, ">" ] } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", "lineNumber": 26 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }