mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
611 lines
No EOL
19 KiB
JSON
611 lines
No EOL
19 KiB
JSON
{
|
|
"id": "screenshotting",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-public.LayoutParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LayoutParams",
|
|
"description": [
|
|
"\nScreenshot layout parameters."
|
|
],
|
|
"signature": [
|
|
"{ id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } extends ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" ? ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" & { id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } : never"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/layout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PdfScreenshotOptions",
|
|
"description": [
|
|
"\nOptions that should be provided to a PDF screenshot request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PdfScreenshotOptions",
|
|
"text": "PdfScreenshotOptions"
|
|
},
|
|
" extends ",
|
|
"CaptureOptions"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotOptions.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [
|
|
"\nWhether to format the output as a PDF."
|
|
],
|
|
"signature": [
|
|
"\"pdf\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotOptions.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nDocument title."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotOptions.logo",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "logo",
|
|
"description": [
|
|
"\nLogo at the footer."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotOptions.layout",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "layout",
|
|
"description": [
|
|
"\nWe default to the \"print\" layout if no ID is specified for the layout"
|
|
],
|
|
"signature": [
|
|
"{ id?: ",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "common",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-common.LayoutType",
|
|
"text": "LayoutType"
|
|
},
|
|
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PdfScreenshotResult",
|
|
"description": [
|
|
"\nFinal, formatted PDF result"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotResult.metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [
|
|
"\nCollected performance metrics during the screenshotting session along with the PDF generation ones."
|
|
],
|
|
"signature": [
|
|
"PdfScreenshotMetrics"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotResult.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [
|
|
"\nPDF document data buffer."
|
|
],
|
|
"signature": [
|
|
"Buffer"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotResult.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [
|
|
"\nAny errors that were encountered while create the PDF and navigating between pages"
|
|
],
|
|
"signature": [
|
|
"Error[]"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PdfScreenshotResult.renderErrors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "renderErrors",
|
|
"description": [
|
|
"\nAny render errors that could mean some visualizations are missing from the end result."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PngScreenshotOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PngScreenshotOptions",
|
|
"description": [
|
|
"\nOptions that should be provided to a screenshot PNG request"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PngScreenshotOptions",
|
|
"text": "PngScreenshotOptions"
|
|
},
|
|
" extends ",
|
|
"CaptureOptions"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/png.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PngScreenshotOptions.format",
|
|
"type": "string",
|
|
"tags": [
|
|
"default"
|
|
],
|
|
"label": "format",
|
|
"description": [
|
|
"\nWhether to format the output as a PNG."
|
|
],
|
|
"signature": [
|
|
"\"png\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/png.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PngScreenshotOptions.layout",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "layout",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id?: \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/png.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.PngScreenshotResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PngScreenshotResult",
|
|
"description": [
|
|
"\nThe final output of a PNG screenshot"
|
|
],
|
|
"signature": [
|
|
"CaptureResult"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/formats/png.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshotOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScreenshotOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PdfScreenshotOptions",
|
|
"text": "PdfScreenshotOptions"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PngScreenshotOptions",
|
|
"text": "PngScreenshotOptions"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/screenshots/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshotResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScreenshotResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PdfScreenshotResult",
|
|
"text": "PdfScreenshotResult"
|
|
},
|
|
" | ",
|
|
"CaptureResult"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/screenshots/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshottingStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ScreenshottingStart",
|
|
"description": [
|
|
"\nStart public contract."
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshottingStart.diagnose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "diagnose",
|
|
"description": [
|
|
"\nRuns browser diagnostics."
|
|
],
|
|
"signature": [
|
|
"(overrideFlags?: string[]) => ",
|
|
"Observable",
|
|
"<string>"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [
|
|
"Observable with output messages."
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshottingStart.diagnose.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "overrideFlags",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/browsers/chromium/driver_factory/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-server.ScreenshottingStart.getScreenshots",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getScreenshots",
|
|
"description": [
|
|
"\nTakes screenshots of multiple pages."
|
|
],
|
|
"signature": [
|
|
"{ (options: ",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PngScreenshotOptions",
|
|
"text": "PngScreenshotOptions"
|
|
},
|
|
"): ",
|
|
"Observable",
|
|
"<",
|
|
"CaptureResult",
|
|
">; (options: ",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PdfScreenshotOptions",
|
|
"text": "PdfScreenshotOptions"
|
|
},
|
|
"): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.PdfScreenshotResult",
|
|
"text": "PdfScreenshotResult"
|
|
},
|
|
">; (options: ",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.ScreenshotOptions",
|
|
"text": "ScreenshotOptions"
|
|
},
|
|
"): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.ScreenshotResult",
|
|
"text": "ScreenshotResult"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.LayoutParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LayoutParams",
|
|
"description": [
|
|
"\nScreenshot layout parameters."
|
|
],
|
|
"signature": [
|
|
"{ id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } extends ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" ? ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" & { id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
|
|
"LayoutSelectorDictionary",
|
|
"> | undefined; zoom?: number | undefined; } : never"
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/layout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.LayoutType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LayoutType",
|
|
"description": [
|
|
"\nSupported layout types."
|
|
],
|
|
"signature": [
|
|
"\"canvas\" | \"preserve_layout\" | \"print\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/layout.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.PLUGIN_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PLUGIN_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"screenshotting\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.SCREENSHOTTING_APP_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SCREENSHOTTING_APP_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"screenshotting\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/expression.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.SCREENSHOTTING_EXPRESSION",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SCREENSHOTTING_EXPRESSION",
|
|
"description": [],
|
|
"signature": [
|
|
"\"expression\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/expression.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotting",
|
|
"id": "def-common.SCREENSHOTTING_EXPRESSION_INPUT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SCREENSHOTTING_EXPRESSION_INPUT",
|
|
"description": [],
|
|
"signature": [
|
|
"\"input\""
|
|
],
|
|
"path": "x-pack/plugins/screenshotting/common/expression.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |