{ "id": "reporting", "client": { "classes": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient", "type": "Class", "tags": [], "label": "ReportingAPIClient", "description": [], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 47 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 50 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.Unnamed.$1", "type": "Object", "tags": [], "label": "http", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 50 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getReportURL", "type": "Function", "tags": [], "label": "getReportURL", "description": [], "signature": [ "(jobId: string) => string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 54 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getReportURL.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 54 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.downloadReport", "type": "Function", "tags": [], "label": "downloadReport", "description": [], "signature": [ "(jobId: string) => void" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 61 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.downloadReport.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 61 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.deleteReport", "type": "Function", "tags": [], "label": "deleteReport", "description": [], "signature": [ "(jobId: string) => Promise" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 67 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.deleteReport.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 67 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.list", "type": "Function", "tags": [], "label": "list", "description": [], "signature": [ "(page?: number, jobIds?: string[]) => Promise<", "JobQueueEntry", "[]>" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 73 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.list.$1", "type": "number", "tags": [], "label": "page", "description": [], "signature": [ "number" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 73 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.list.$2", "type": "Array", "tags": [], "label": "jobIds", "description": [], "signature": [ "string[]" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 73 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.total", "type": "Function", "tags": [], "label": "total", "description": [], "signature": [ "() => Promise" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 86 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getContent", "type": "Function", "tags": [], "label": "getContent", "description": [], "signature": [ "(jobId: string) => Promise<", "JobContent", ">" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 92 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getContent.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 92 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getInfo", "type": "Function", "tags": [], "label": "getInfo", "description": [], "signature": [ "(jobId: string) => Promise<", "ReportApiJSON", ">" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 98 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getInfo.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 98 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.findForJobIds", "type": "Function", "tags": [], "label": "findForJobIds", "description": [], "signature": [ "(jobIds: string[]) => Promise<", "ReportDocument", "[]>" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 104 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.findForJobIds.$1", "type": "Array", "tags": [], "label": "jobIds", "description": [], "signature": [ "string[]" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 104 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getReportingJobPath", "type": "Function", "tags": [], "label": "getReportingJobPath", "description": [], "signature": [ "(exportType: string, jobParams: JobParams) => string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 114 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getReportingJobPath.$1", "type": "string", "tags": [], "label": "exportType", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 114 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getReportingJobPath.$2", "type": "Object", "tags": [], "label": "jobParams", "description": [], "signature": [ "JobParams" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 114 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.createReportingJob", "type": "Function", "tags": [], "label": "createReportingJob", "description": [], "signature": [ "(exportType: string, jobParams: any) => Promise" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 122 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.createReportingJob.$1", "type": "string", "tags": [], "label": "exportType", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 122 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.createReportingJob.$2", "type": "Any", "tags": [], "label": "jobParams", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 122 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getManagementLink", "type": "Function", "tags": [], "label": "getManagementLink", "description": [], "signature": [ "() => string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 136 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getDownloadLink", "type": "Function", "tags": [], "label": "getDownloadLink", "description": [], "signature": [ "(jobId: string) => string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 139 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getDownloadLink.$1", "type": "string", "tags": [], "label": "jobId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 139 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.getServerBasePath", "type": "Function", "tags": [], "label": "getServerBasePath", "description": [], "signature": [ "() => string" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 145 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.verifyConfig", "type": "Function", "tags": [], "label": "verifyConfig", "description": [], "signature": [ "() => Promise<", "DiagnoseResponse", ">" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 150 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.verifyBrowser", "type": "Function", "tags": [], "label": "verifyBrowser", "description": [], "signature": [ "() => Promise<", "DiagnoseResponse", ">" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 158 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.verifyScreenCapture", "type": "Function", "tags": [], "label": "verifyScreenCapture", "description": [], "signature": [ "() => Promise<", "DiagnoseResponse", ">" ], "source": { "path": "x-pack/plugins/reporting/public/lib/reporting_api_client.ts", "lineNumber": 166 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin", "type": "Class", "tags": [], "label": "ReportingPublicPlugin", "description": [], "signature": [ { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingPublicPlugin", "text": "ReportingPublicPlugin" }, " implements ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.Plugin", "text": "Plugin" }, "<", { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingSetup", "text": "ReportingSetup" }, ", ", { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingSetup", "text": "ReportingSetup" }, ", ", "ReportingPublicPluginSetupDendencies", ", ", "ReportingPublicPluginStartDendencies", ">" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 79 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 97 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.Unnamed.$1", "type": "Object", "tags": [], "label": "initializerContext", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, "" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 97 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, ", setupDeps: ", "ReportingPublicPluginSetupDendencies", ") => ", { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 117 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.setup.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, "" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 117 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.setup.$2", "type": "Object", "tags": [], "label": "setupDeps", "description": [], "signature": [ "ReportingPublicPluginSetupDendencies" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 117 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ") => ", { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 200 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.start.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" } ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 200 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-public.ReportingPublicPlugin.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "source": { "path": "x-pack/plugins/reporting/public/plugin.ts", "lineNumber": 219 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "reporting", "id": "def-public.getDefaultLayoutSelectors", "type": "Function", "tags": [], "label": "getDefaultLayoutSelectors", "description": [], "signature": [ "() => ", "LayoutSelectorDictionary" ], "source": { "path": "x-pack/plugins/reporting/common/index.ts", "lineNumber": 14 }, "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [], "start": { "parentPluginId": "reporting", "id": "def-public.ReportingStart", "type": "Type", "tags": [], "label": "ReportingStart", "description": [], "signature": [ { "pluginId": "reporting", "scope": "public", "docId": "kibReportingPluginApi", "section": "def-public.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/public/index.ts", "lineNumber": 20 }, "deprecated": false, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore", "type": "Class", "tags": [], "label": "ReportingCore", "description": [], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 60 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getContract", "type": "Function", "tags": [], "label": "getContract", "description": [], "signature": [ "() => ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 72 }, "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 74 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.Unnamed.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "LevelLogger" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 74 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.Unnamed.$2", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 74 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginSetup", "type": "Function", "tags": [], "label": "pluginSetup", "description": [], "signature": [ "(setupDeps: ", "ReportingInternalSetup", ") => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 90 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginSetup.$1", "type": "Object", "tags": [], "label": "setupDeps", "description": [], "signature": [ "ReportingInternalSetup" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 90 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginStart", "type": "Function", "tags": [], "label": "pluginStart", "description": [], "signature": [ "(startDeps: ", "ReportingInternalStart", ") => Promise" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 104 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginStart.$1", "type": "Object", "tags": [], "label": "startDeps", "description": [], "signature": [ "ReportingInternalStart" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 104 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginSetsUp", "type": "Function", "tags": [], "label": "pluginSetsUp", "description": [], "signature": [ "() => Promise" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 117 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginStartsUp", "type": "Function", "tags": [], "label": "pluginStartsUp", "description": [], "signature": [ "() => Promise" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 128 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginIsStarted", "type": "Function", "tags": [], "label": "pluginIsStarted", "description": [], "signature": [ "() => boolean" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 135 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.setConfig", "type": "Function", "tags": [], "label": "setConfig", "description": [], "signature": [ "(config: ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingConfig", "text": "ReportingConfig" }, ") => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 142 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.setConfig.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingConfig", "text": "ReportingConfig" } ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 142 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.registerFeature", "type": "Function", "tags": [], "label": "registerFeature", "description": [ "\nIf xpack.reporting.roles.enabled === true, register Reporting as a feature\nthat is controlled by user role names" ], "signature": [ "() => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 151 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "() => ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingConfig", "text": "ReportingConfig" } ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 185 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getDeprecatedAllowedRoles", "type": "Function", "tags": [], "label": "getDeprecatedAllowedRoles", "description": [], "signature": [ "() => false | string[]" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 197 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getPluginStartDeps", "type": "Function", "tags": [], "label": "getPluginStartDeps", "description": [], "signature": [ "() => Promise<", "ReportingInternalStart", ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 204 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getExportTypesRegistry", "type": "Function", "tags": [], "label": "getExportTypesRegistry", "description": [], "signature": [ "() => ", "ExportTypesRegistry" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 212 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.scheduleTask", "type": "Function", "tags": [], "label": "scheduleTask", "description": [], "signature": [ "(report: ", "ReportTaskParams", "<", "BasePayload", ">) => Promise<", { "pluginId": "taskManager", "scope": "server", "docId": "kibTaskManagerPluginApi", "section": "def-server.ConcreteTaskInstance", "text": "ConcreteTaskInstance" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 216 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.scheduleTask.$1", "type": "Object", "tags": [], "label": "report", "description": [], "signature": [ "ReportTaskParams", "<", "BasePayload", ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 216 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getStore", "type": "Function", "tags": [], "label": "getStore", "description": [], "signature": [ "() => Promise<", "ReportingStore", ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 220 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getLicenseInfo", "type": "Function", "tags": [], "label": "getLicenseInfo", "description": [], "signature": [ "() => Promise>" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 224 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getScreenshotsObservable", "type": "Function", "tags": [], "label": "getScreenshotsObservable", "description": [], "signature": [ "() => Promise<", "ScreenshotsObservableFn", ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 234 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getEnableScreenshotMode", "type": "Function", "tags": [], "label": "getEnableScreenshotMode", "description": [], "signature": [ "() => () => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 240 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getPluginSetupDeps", "type": "Function", "tags": [], "label": "getPluginSetupDeps", "description": [], "signature": [ "() => ", "ReportingInternalSetup" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 248 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getUiSettingsServiceFactory", "type": "Function", "tags": [], "label": "getUiSettingsServiceFactory", "description": [], "signature": [ "(savedObjectsClient: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 260 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getUiSettingsServiceFactory.$1", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 260 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getSpaceId", "type": "Function", "tags": [], "label": "getSpaceId", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", logger?: ", "LevelLogger", ") => string | undefined" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 266 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getSpaceId.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 266 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getSpaceId.$2", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "LevelLogger" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 266 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getFakeRequest", "type": "Function", "tags": [], "label": "getFakeRequest", "description": [], "signature": [ "(baseRequest: object, spaceId: string | undefined, logger?: ", "LevelLogger", ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 280 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getFakeRequest.$1", "type": "Uncategorized", "tags": [], "label": "baseRequest", "description": [], "signature": [ "object" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 280 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getFakeRequest.$2", "type": "string", "tags": [], "label": "spaceId", "description": [], "signature": [ "string | undefined" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 280 }, "deprecated": false, "isRequired": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getFakeRequest.$3", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "LevelLogger" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 280 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getUiSettingsClient", "type": "Function", "tags": [], "label": "getUiSettingsClient", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", logger?: ", "LevelLogger", ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 300 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getUiSettingsClient.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 300 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getUiSettingsClient.$2", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "LevelLogger" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 300 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getDataService", "type": "Function", "tags": [], "label": "getDataService", "description": [], "signature": [ "() => Promise<", { "pluginId": "data", "scope": "server", "docId": "kibDataPluginApi", "section": "def-server.DataPluginStart", "text": "DataPluginStart" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 310 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.getEsClient", "type": "Function", "tags": [], "label": "getEsClient", "description": [], "signature": [ "() => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IClusterClient", "text": "IClusterClient" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 315 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.trackReport", "type": "Function", "tags": [], "label": "trackReport", "description": [], "signature": [ "(reportId: string) => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 320 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.trackReport.$1", "type": "string", "tags": [], "label": "reportId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 320 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.untrackReport", "type": "Function", "tags": [], "label": "untrackReport", "description": [], "signature": [ "(reportId: string) => void" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 324 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingCore.untrackReport.$1", "type": "string", "tags": [], "label": "reportId", "description": [], "signature": [ "string" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 324 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.countConcurrentReports", "type": "Function", "tags": [], "label": "countConcurrentReports", "description": [], "signature": [ "() => number" ], "source": { "path": "x-pack/plugins/reporting/server/core.ts", "lineNumber": 328 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin", "type": "Class", "tags": [], "label": "ReportingPlugin", "description": [], "signature": [ { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingPlugin", "text": "ReportingPlugin" }, " implements ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.Plugin", "text": "Plugin" }, "<", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetup", "text": "ReportingSetup" }, ", ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetup", "text": "ReportingSetup" }, ", ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetupDeps", "text": "ReportingSetupDeps" }, ", ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingStartDeps", "text": "ReportingStartDeps" }, ">" ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 26 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 31 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.Unnamed.$1", "type": "Object", "tags": [], "label": "initContext", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, "; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 31 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, ", plugins: ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetupDeps", "text": "ReportingSetupDeps" }, ") => ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 35 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.setup.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, "" ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 35 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.setup.$2", "type": "Object", "tags": [], "label": "plugins", "description": [], "signature": [ { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetupDeps", "text": "ReportingSetupDeps" } ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 35 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" }, ", plugins: ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingStartDeps", "text": "ReportingStartDeps" }, ") => ", { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingSetup", "text": "ReportingSetup" } ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 88 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.start.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" } ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 88 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "reporting", "id": "def-server.ReportingPlugin.start.$2", "type": "Object", "tags": [], "label": "plugins", "description": [], "signature": [ { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingStartDeps", "text": "ReportingStartDeps" } ], "source": { "path": "x-pack/plugins/reporting/server/plugin.ts", "lineNumber": 88 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "reporting", "id": "def-server.ReportingConfig", "type": "Interface", "tags": [], "label": "ReportingConfig", "description": [], "signature": [ { "pluginId": "reporting", "scope": "server", "docId": "kibReportingPluginApi", "section": "def-server.ReportingConfig", "text": "ReportingConfig" }, " extends Config; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; kibanaServer: Readonly<{ hostname?: string | undefined; port?: number | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ", "ByteSizeValue", "; useByteOrderMarkEncoding: boolean; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>" ], "source": { "path": "x-pack/plugins/reporting/server/config/config.ts", "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingConfig.kbnConfig", "type": "Object", "tags": [], "label": "kbnConfig", "description": [], "signature": [ "Config" ], "source": { "path": "x-pack/plugins/reporting/server/config/config.ts", "lineNumber": 56 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps", "type": "Interface", "tags": [], "label": "ReportingSetupDeps", "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.licensing", "type": "Object", "tags": [], "label": "licensing", "description": [], "signature": [ { "pluginId": "licensing", "scope": "server", "docId": "kibLicensingPluginApi", "section": "def-server.LicensingPluginSetup", "text": "LicensingPluginSetup" } ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 30 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.features", "type": "Object", "tags": [], "label": "features", "description": [], "signature": [ { "pluginId": "features", "scope": "server", "docId": "kibFeaturesPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 31 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.security", "type": "Object", "tags": [], "label": "security", "description": [], "signature": [ { "pluginId": "security", "scope": "server", "docId": "kibSecurityPluginApi", "section": "def-server.SecurityPluginSetup", "text": "SecurityPluginSetup" }, " | undefined" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 32 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.spaces", "type": "Object", "tags": [], "label": "spaces", "description": [], "signature": [ { "pluginId": "spaces", "scope": "server", "docId": "kibSpacesPluginApi", "section": "def-server.SpacesPluginSetup", "text": "SpacesPluginSetup" }, " | undefined" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 33 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.taskManager", "type": "CompoundType", "tags": [], "label": "taskManager", "description": [], "signature": [ "{ index: string; addMiddleware: (middleware: ", "Middleware", ") => void; } & Pick<", "TaskTypeDictionary", ", \"registerTaskDefinitions\">" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 34 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.usageCollection", "type": "Object", "tags": [], "label": "usageCollection", "description": [], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.UsageCollectionSetup", "text": "UsageCollectionSetup" }, " | undefined" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 35 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingSetupDeps.screenshotMode", "type": "Object", "tags": [], "label": "screenshotMode", "description": [], "signature": [ { "pluginId": "screenshotMode", "scope": "server", "docId": "kibScreenshotModePluginApi", "section": "def-server.ScreenshotModePluginSetup", "text": "ScreenshotModePluginSetup" } ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 36 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingStartDeps", "type": "Interface", "tags": [], "label": "ReportingStartDeps", "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 39 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingStartDeps.data", "type": "Object", "tags": [], "label": "data", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataPluginApi", "section": "def-server.DataPluginStart", "text": "DataPluginStart" } ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 40 }, "deprecated": false }, { "parentPluginId": "reporting", "id": "def-server.ReportingStartDeps.taskManager", "type": "CompoundType", "tags": [], "label": "taskManager", "description": [], "signature": [ "Pick<", "TaskScheduling", ", \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<", "TaskStore", ", \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: (id: string) => Promise; }" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 41 }, "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "start": { "parentPluginId": "reporting", "id": "def-server.ReportingSetup", "type": "Interface", "tags": [], "label": "ReportingSetup", "description": [], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 44 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-server.ReportingSetup.usesUiCapabilities", "type": "Function", "tags": [], "label": "usesUiCapabilities", "description": [], "signature": [ "() => boolean" ], "source": { "path": "x-pack/plugins/reporting/server/types.ts", "lineNumber": 45 }, "deprecated": false, "returnComment": [], "children": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [ { "parentPluginId": "reporting", "id": "def-common.CancellationToken", "type": "Class", "tags": [], "label": "CancellationToken", "description": [], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 10 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-common.CancellationToken.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 14 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.CancellationToken.on", "type": "Function", "tags": [], "label": "on", "description": [], "signature": [ "(callback: Function) => void" ], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 19 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-common.CancellationToken.on.$1", "type": "Object", "tags": [], "label": "callback", "description": [], "signature": [ "Function" ], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 19 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.CancellationToken.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [], "signature": [ "() => void" ], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 32 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.CancellationToken.isCancelled", "type": "Function", "tags": [], "label": "isCancelled", "description": [], "signature": [ "() => boolean" ], "source": { "path": "x-pack/plugins/reporting/common/cancellation_token.ts", "lineNumber": 37 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "reporting", "id": "def-common.Poller", "type": "Class", "tags": [], "label": "Poller", "description": [], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 21 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-common.Poller.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 32 }, "deprecated": false, "children": [ { "parentPluginId": "reporting", "id": "def-common.Poller.Unnamed.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "PollerOptions" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 32 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.Poller.getPollFrequency", "type": "Function", "tags": [], "label": "getPollFrequency", "description": [], "signature": [ "() => number" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 45 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.Poller._poll", "type": "Function", "tags": [], "label": "_poll", "description": [], "signature": [ "() => Promise" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 49 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.Poller.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "() => void" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 76 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.Poller.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 89 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "reporting", "id": "def-common.Poller.isRunning", "type": "Function", "tags": [], "label": "isRunning", "description": [], "signature": [ "() => boolean" ], "source": { "path": "x-pack/plugins/reporting/common/poller.ts", "lineNumber": 103 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "reporting", "id": "def-common.getDefaultLayoutSelectors", "type": "Function", "tags": [], "label": "getDefaultLayoutSelectors", "description": [], "signature": [ "() => ", "LayoutSelectorDictionary" ], "source": { "path": "x-pack/plugins/reporting/common/index.ts", "lineNumber": 14 }, "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [ { "parentPluginId": "reporting", "id": "def-common.constants", "type": "Object", "tags": [], "label": "constants", "description": [], "signature": [ "typeof ", "x-pack/plugins/reporting/common/constants" ], "source": { "path": "x-pack/plugins/reporting/common/index.ts", "lineNumber": 10 }, "deprecated": false, "initialIsOpen": false } ] } }