mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
512 lines
No EOL
18 KiB
JSON
512 lines
No EOL
18 KiB
JSON
{
|
|
"id": "screenshotMode",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-public.setScreenshotModeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotModeEnabled",
|
|
"description": [
|
|
"\nUse this function to set the current browser to screenshot mode.\n\nThis function should be called as early as possible to ensure that screenshot mode is\ncorrectly detected for the first page load. It is not suitable for use inside any plugin\ncode unless the plugin code is guaranteed to, somehow, load before any other code.\n\nAdditionally, we don't know what environment this code will run in so we remove as many external\nreferences as possible to make it portable. For instance, running inside puppeteer."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-public.KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"__KBN_SCREENSHOT_MODE_ENABLED_KEY__\""
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-public.KBN_SCREENSHOT_MODE_HEADER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_HEADER",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-public.ScreenshotModePublicStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScreenshotModePublicStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotMode",
|
|
"scope": "public",
|
|
"docId": "kibScreenshotModePluginApi",
|
|
"section": "def-public.ScreenshotModePublicSetup",
|
|
"text": "ScreenshotModePublicSetup"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.setScreenshotModeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotModeEnabled",
|
|
"description": [
|
|
"\nUse this function to set the current browser to screenshot mode.\n\nThis function should be called as early as possible to ensure that screenshot mode is\ncorrectly detected for the first page load. It is not suitable for use inside any plugin\ncode unless the plugin code is guaranteed to, somehow, load before any other code.\n\nAdditionally, we don't know what environment this code will run in so we remove as many external\nreferences as possible to make it portable. For instance, running inside puppeteer."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"__KBN_SCREENSHOT_MODE_ENABLED_KEY__\""
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.KBN_SCREENSHOT_MODE_HEADER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_HEADER",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeRequestHandlerContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScreenshotModeRequestHandlerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"RequestHandlerContext",
|
|
" & { screenshotMode: Promise<{ isScreenshot: boolean; }>; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ScreenshotModeServerSetup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotMode",
|
|
"scope": "server",
|
|
"docId": "kibScreenshotModePluginApi",
|
|
"section": "def-server.ScreenshotModeServerSetup",
|
|
"text": "ScreenshotModeServerSetup"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "screenshotMode",
|
|
"scope": "server",
|
|
"docId": "kibScreenshotModePluginApi",
|
|
"section": "def-server.ScreenshotModeServerStart",
|
|
"text": "ScreenshotModeServerStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerSetup.setScreenshotContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotContext",
|
|
"description": [
|
|
"\nStores a value in the screenshotting context."
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(key: string, value: T) => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerSetup.setScreenshotContext.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [
|
|
"Context key to set."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerSetup.setScreenshotContext.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"Value to set."
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerSetup.setScreenshotModeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotModeEnabled",
|
|
"description": [
|
|
"\nSet the current environment to screenshot mode. Intended to run in a browser-environment, before any other scripts\non the page have run to ensure that screenshot mode is detected as early as possible."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ScreenshotModeServerStart",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerStart.isScreenshotMode",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isScreenshotMode",
|
|
"description": [
|
|
"\nAny context that requires access to the screenshot mode flag but does not have access\nto request context {@link ScreenshotModeRequestHandlerContext}, for instance if they are pre-context,\ncan use this function to check whether the request originates from a client that is in screenshot mode."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => boolean"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-server.ScreenshotModeServerStart.isScreenshotMode.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.getScreenshotContext",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getScreenshotContext",
|
|
"description": [
|
|
"\nRetrieves a value from the screenshotting context."
|
|
],
|
|
"signature": [
|
|
"(key: string, defaultValue: T | undefined) => T | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.getScreenshotContext.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [
|
|
"Context key to get."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.getScreenshotContext.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultValue",
|
|
"description": [
|
|
"Value to return if the key is not found."
|
|
],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The value stored in the screenshotting context."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.getScreenshotMode",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getScreenshotMode",
|
|
"description": [
|
|
"\nThis function is responsible for detecting whether we are currently in screenshot mode.\n\nWe check in the current window context whether screenshot mode is enabled, otherwise we check\nlocalStorage. The ability to set a value in localStorage enables more convenient development and testing\nin functionality that needs to detect screenshot mode."
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.setScreenshotContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotContext",
|
|
"description": [
|
|
"\nStores a value in the screenshotting context."
|
|
],
|
|
"signature": [
|
|
"(key: string, value: T) => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.setScreenshotContext.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [
|
|
"Context key to set."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.setScreenshotContext.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"Value to set."
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/context.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.setScreenshotModeDisabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotModeDisabled",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.setScreenshotModeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setScreenshotModeEnabled",
|
|
"description": [
|
|
"\nUse this function to set the current browser to screenshot mode.\n\nThis function should be called as early as possible to ensure that screenshot mode is\ncorrectly detected for the first page load. It is not suitable for use inside any plugin\ncode unless the plugin code is guaranteed to, somehow, load before any other code.\n\nAdditionally, we don't know what environment this code will run in so we remove as many external\nreferences as possible to make it portable. For instance, running inside puppeteer."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_ENABLED_KEY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"__KBN_SCREENSHOT_MODE_ENABLED_KEY__\""
|
|
],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/mode.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "screenshotMode",
|
|
"id": "def-common.KBN_SCREENSHOT_MODE_HEADER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KBN_SCREENSHOT_MODE_HEADER",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/screenshot_mode/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |