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