1413 lines
43 KiB
JSON
1413 lines
43 KiB
JSON
{
|
|
"id": "share",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "KibanaURL",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.appName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.appPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appPath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "UrlGeneratorsService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorsService",
|
|
"text": "UrlGeneratorsService"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
"UrlGeneratorsSetup",
|
|
", ",
|
|
"UrlGeneratorsStart",
|
|
", object, object>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>) => ",
|
|
"UrlGeneratorsSetup"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => ",
|
|
"UrlGeneratorsStart"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadFileAs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "downloadFileAs",
|
|
"description": [
|
|
"\nConvenient method to use for a single file download\n**Note**: for multiple files use the downloadMultipleAs method, do not iterate with this method here"
|
|
],
|
|
"signature": [
|
|
"(filename: string, payload: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.DownloadableContent",
|
|
"text": "DownloadableContent"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadFileAs.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filename",
|
|
"description": [
|
|
"full name of the file"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadFileAs.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "payload",
|
|
"description": [
|
|
"either a Blob content, or a Record with a stringified content and type"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.DownloadableContent",
|
|
"text": "DownloadableContent"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a Promise that resolves when the download has been correctly started"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadMultipleAs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "downloadMultipleAs",
|
|
"description": [
|
|
"\nMultiple files download method"
|
|
],
|
|
"signature": [
|
|
"(files: Record<string, ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.DownloadableContent",
|
|
"text": "DownloadableContent"
|
|
},
|
|
">) => Promise<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadMultipleAs.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "files",
|
|
"description": [
|
|
"a Record containing one entry per file: the key entry should be the filename\nand the value either a Blob content, or a Record with a stringified content and type"
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.DownloadableContent",
|
|
"text": "DownloadableContent"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a Promise that resolves when all the downloads have been correctly started"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareContext",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.objectType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.objectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.shareableUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shareableUrl",
|
|
"description": [
|
|
"\nCurrent url for sharing. This can be set in cases where `window.location.href`\ndoes not contain a shareable URL (e.g. if using session storage to store the current\napp state is enabled). In these cases the property should contain the URL in a\nformat which makes it possible to use it without having access to any other state\nlike the current session.\n\nIf not set it will default to `window.location.href`"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.sharingData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sharingData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: unknown; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.isDirty",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDirty",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.showPublicUrlSwitch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showPublicUrlSwitch",
|
|
"description": [],
|
|
"signature": [
|
|
"((anonymousUserCapabilities: ",
|
|
"Capabilities",
|
|
") => boolean) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContextMenuPanelItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareContextMenuPanelItem",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContextMenuPanelItem",
|
|
"text": "ShareContextMenuPanelItem"
|
|
},
|
|
" extends Pick<",
|
|
"EuiContextMenuPanelItemDescriptorEntry",
|
|
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"disabled\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContextMenuPanelItem.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContextMenuPanelItem.sortOrder",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareMenuItem",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuItem.shareMenuItem",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "shareMenuItem",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContextMenuPanelItem",
|
|
"text": "ShareContextMenuPanelItem"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuItem.panel",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panel",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiContextMenuPanelDescriptor"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareMenuProvider",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 71
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider.getShareMenuItems",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getShareMenuItems",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContext",
|
|
"text": "ShareContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareMenuItem",
|
|
"text": "ShareMenuItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.context",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContext",
|
|
"text": "ShareContext"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShowShareMenuOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShowShareMenuOptions",
|
|
"text": "ShowShareMenuOptions"
|
|
},
|
|
" extends Pick<",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContext",
|
|
"text": "ShareContext"
|
|
},
|
|
", \"objectType\" | \"objectId\" | \"shareableUrl\" | \"sharingData\" | \"isDirty\" | \"showPublicUrlSwitch\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 87
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.anchorElement",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "anchorElement",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.allowEmbed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowEmbed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.allowShortUrl",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowShortUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.embedUrlParamExtensions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "embedUrlParamExtensions",
|
|
"description": [],
|
|
"signature": [
|
|
"UrlParamExtension",
|
|
"[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UrlGeneratorContract",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorContract",
|
|
"text": "UrlGeneratorContract"
|
|
},
|
|
"<Id>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"Id"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.createUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]) => Promise<string>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.createUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.isDeprecated",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDeprecated",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.migrate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "migrate",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]) => Promise<{ state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"MigratedState\"]; id: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"MigratedId\"]; }>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.migrate.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UrlGeneratorsDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorsDefinition",
|
|
"text": "UrlGeneratorsDefinition"
|
|
},
|
|
"<Id>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"Id"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.createUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"((state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]) => Promise<string>) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.isDeprecated",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isDeprecated",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.migrate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "migrate",
|
|
"description": [],
|
|
"signature": [
|
|
"((state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]) => Promise<{ state: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"MigratedState\"]; id: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"MigratedId\"]; }>) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UrlGeneratorState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorState",
|
|
"text": "UrlGeneratorState"
|
|
},
|
|
"<S, I, MS>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.State",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "State",
|
|
"description": [],
|
|
"signature": [
|
|
"S"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.MigratedId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "MigratedId",
|
|
"description": [],
|
|
"signature": [
|
|
"I | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.MigratedState",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "MigratedState",
|
|
"description": [],
|
|
"signature": [
|
|
"MS | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorStateMapping",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UrlGeneratorStateMapping",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorStateMapping.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.CSV_QUOTE_VALUES_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_QUOTE_VALUES_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:quoteValues\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.CSV_SEPARATOR_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_SEPARATOR_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:separator\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.DownloadableContent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DownloadableContent",
|
|
"description": [],
|
|
"signature": [
|
|
"Blob | { content: string; type: string; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UrlGeneratorId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "share",
|
|
"id": "def-public.SharePluginSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SharePluginSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ register: (shareMenuProvider: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareMenuProvider",
|
|
"text": "ShareMenuProvider"
|
|
},
|
|
") => void; } & { urlGenerators: ",
|
|
"UrlGeneratorsSetup",
|
|
"; url: ",
|
|
"UrlService",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/plugin.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "share",
|
|
"id": "def-public.SharePluginStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SharePluginStart",
|
|
"description": [],
|
|
"signature": [
|
|
"{ toggleShareContextMenu: (options: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShowShareMenuOptions",
|
|
"text": "ShowShareMenuOptions"
|
|
},
|
|
") => void; } & { urlGenerators: ",
|
|
"UrlGeneratorsStart",
|
|
"; url: ",
|
|
"UrlService",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/public/plugin.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-server.CSV_QUOTE_VALUES_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_QUOTE_VALUES_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:quoteValues\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-server.CSV_SEPARATOR_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_SEPARATOR_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:separator\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |