{ "id": "dataViewEditor", "client": { "classes": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService", "type": "Class", "tags": [], "label": "DataViewEditorService", "description": [], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.Unnamed.$1", "type": "Object", "tags": [], "label": "{\n services: { http, dataViews },\n initialValues: {\n type: initialType = INDEX_PATTERN_TYPE.DEFAULT,\n indexPattern: initialIndexPattern = '',\n name: initialName = '',\n },\n requireTimestampField = false,\n }", "description": [], "signature": [ "DataViewEditorServiceConstructorArgs" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.dataViewNames$", "type": "Object", "tags": [], "label": "dataViewNames$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.rollupIndicesCaps$", "type": "Object", "tags": [], "label": "rollupIndicesCaps$", "description": [], "signature": [ "Observable", "<", "RollupIndicesCapsResponse", ">" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.isLoadingSources$", "type": "Object", "tags": [], "label": "isLoadingSources$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.loadingTimestampFields$", "type": "Object", "tags": [], "label": "loadingTimestampFields$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.timestampFieldOptions$", "type": "Object", "tags": [], "label": "timestampFieldOptions$", "description": [], "signature": [ "Observable", "<", "TimestampOption", "[]>" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.rollupIndex$", "type": "Object", "tags": [], "label": "rollupIndex$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.matchedIndices$", "type": "Object", "tags": [], "label": "matchedIndices$", "description": [], "signature": [ "Observable", "<", "MatchedIndicesSet", ">" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setIndexPattern", "type": "Function", "tags": [], "label": "setIndexPattern", "description": [], "signature": [ "(indexPattern: string) => void" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setIndexPattern.$1", "type": "string", "tags": [], "label": "indexPattern", "description": [], "signature": [ "string" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setAllowHidden", "type": "Function", "tags": [], "label": "setAllowHidden", "description": [], "signature": [ "(allowHidden: boolean) => void" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setAllowHidden.$1", "type": "boolean", "tags": [], "label": "allowHidden", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setType", "type": "Function", "tags": [], "label": "setType", "description": [], "signature": [ "(type: ", { "pluginId": "dataViews", "scope": "public", "docId": "kibDataViewsPluginApi", "section": "def-public.INDEX_PATTERN_TYPE", "text": "INDEX_PATTERN_TYPE" }, ") => void" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.setType.$1", "type": "Enum", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "public", "docId": "kibDataViewsPluginApi", "section": "def-public.INDEX_PATTERN_TYPE", "text": "INDEX_PATTERN_TYPE" } ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.indexPatternValidationProvider", "type": "Function", "tags": [], "label": "indexPatternValidationProvider", "description": [], "signature": [ "() => Promise<{ rollupIndex: string | null | undefined; matchedIndices: ", "MatchedIndicesSet", "; }>" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorService.destroy", "type": "Function", "tags": [], "label": "destroy", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data_view_editor/public/data_view_editor_service.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps", "type": "Interface", "tags": [], "label": "DataViewEditorProps", "description": [], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.onSave", "type": "Function", "tags": [], "label": "onSave", "description": [ "\nHandler for the \"save\" footer button" ], "signature": [ "(dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ") => void" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.onSave.$1", "type": "Object", "tags": [], "label": "dataView", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" } ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.onCancel", "type": "Function", "tags": [], "label": "onCancel", "description": [ "\nHandler for the \"cancel\" footer button" ], "signature": [ "(() => void) | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.defaultTypeIsRollup", "type": "CompoundType", "tags": [], "label": "defaultTypeIsRollup", "description": [ "\nSets the default index pattern type to rollup. Defaults to false." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.requireTimestampField", "type": "CompoundType", "tags": [], "label": "requireTimestampField", "description": [ "\nSets whether a timestamp field is required to create an index pattern. Defaults to false." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.editData", "type": "Object", "tags": [], "label": "editData", "description": [ "\nPass the data view to be edited." ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, " | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.allowAdHocDataView", "type": "CompoundType", "tags": [], "label": "allowAdHocDataView", "description": [ "\nif set to true user is presented with an option to create ad-hoc dataview without a saved object." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.DataViewEditorProps.showManagementLink", "type": "CompoundType", "tags": [], "label": "showManagementLink", "description": [ "\nif set to true a link to the management page is shown" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "start": { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart", "type": "Interface", "tags": [], "label": "PluginStart", "description": [], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.openEditor", "type": "Function", "tags": [], "label": "openEditor", "description": [], "signature": [ "(options: ", { "pluginId": "dataViewEditor", "scope": "public", "docId": "kibDataViewEditorPluginApi", "section": "def-public.DataViewEditorProps", "text": "DataViewEditorProps" }, ") => () => void" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.openEditor.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "dataViewEditor", "scope": "public", "docId": "kibDataViewEditorPluginApi", "section": "def-public.DataViewEditorProps", "text": "DataViewEditorProps" } ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.IndexPatternEditorComponent", "type": "Function", "tags": [], "label": "IndexPatternEditorComponent", "description": [], "signature": [ "React.FunctionComponent<", { "pluginId": "dataViewEditor", "scope": "public", "docId": "kibDataViewEditorPluginApi", "section": "def-public.DataViewEditorProps", "text": "DataViewEditorProps" }, ">" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.IndexPatternEditorComponent.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.IndexPatternEditorComponent.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.userPermissions", "type": "Object", "tags": [], "label": "userPermissions", "description": [], "signature": [ "{ editDataView: () => boolean; }" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dataViewEditor", "id": "def-public.PluginStart.dataViewEditorServiceFactory", "type": "Function", "tags": [], "label": "dataViewEditorServiceFactory", "description": [ "\nHelper method to generate a new data view editor service." ], "signature": [ "() => Promise" ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "DataViewEditorService" ] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }