2021-03-04 02:12:24 +01:00
{
"id" : "share" ,
"client" : {
"classes" : [
2021-03-06 16:05:27 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.KibanaURL" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "KibanaURL" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 11
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.KibanaURL.path" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "path" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 12
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.KibanaURL.appName" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "appName" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 13
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.KibanaURL.appPath" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "appPath" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 14
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.KibanaURL.Unnamed" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "Constructor" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"any"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 16
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.KibanaURL.Unnamed.$1" ,
2021-03-06 16:05:27 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "path" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"string"
] ,
"source" : {
"path" : "src/plugins/share/public/kibana_url.ts" ,
"lineNumber" : 16
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-06 16:05:27 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"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>"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_service.ts" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 35
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.UrlGeneratorsService.Unnamed" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "Constructor" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"any"
] ,
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_service.ts" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 40
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.UrlGeneratorsService.setup" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "setup" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<object, unknown>) => " ,
2021-04-15 22:47:21 +02:00
"UrlGeneratorsSetup"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_service.ts" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 42
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.UrlGeneratorsService.setup.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "core" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"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" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 42
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.UrlGeneratorsService.start" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "start" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
} ,
") => " ,
2021-04-15 22:47:21 +02:00
"UrlGeneratorsStart"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_service.ts" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 55
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.UrlGeneratorsService.start.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "core" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"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" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 55
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.UrlGeneratorsService.stop" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "stop" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"() => void"
] ,
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_service.ts" ,
2021-06-08 22:26:37 +02:00
"lineNumber" : 62
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"functions" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.downloadFileAs" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "downloadFileAs" ,
2021-05-06 23:59:11 +02:00
"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"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(filename: string, payload: " ,
2021-03-04 02:12:24 +01:00
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.DownloadableContent" ,
"text" : "DownloadableContent"
} ,
2021-03-06 16:05:27 +01:00
") => Promise<void>"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/lib/download_as.ts" ,
"lineNumber" : 23
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.downloadFileAs.$1" ,
2021-03-06 16:05:27 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "filename" ,
"description" : [
"full name of the file"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/share/public/lib/download_as.ts" ,
"lineNumber" : 23
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.downloadFileAs.$2" ,
2021-03-06 16:05:27 +01:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "payload" ,
2021-05-06 23:59:11 +02:00
"description" : [
"either a Blob content, or a Record with a stringified content and type"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.DownloadableContent" ,
"text" : "DownloadableContent"
2021-03-06 16:05:27 +01:00
}
2021-03-04 02:12:24 +01:00
] ,
"source" : {
"path" : "src/plugins/share/public/lib/download_as.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 23
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [
2021-03-06 16:05:27 +01:00
"a Promise that resolves when the download has been correctly started"
2021-03-04 02:12:24 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.downloadMultipleAs" ,
2021-03-04 02:12:24 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "downloadMultipleAs" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nMultiple files download method"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"(files: Record<string, " ,
2021-03-04 02:12:24 +01:00
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.DownloadableContent" ,
"text" : "DownloadableContent"
} ,
2021-03-06 16:05:27 +01:00
">) => Promise<void>"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/lib/download_as.ts" ,
"lineNumber" : 34
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.downloadMultipleAs.$1" ,
2021-03-06 16:05:27 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "files" ,
2021-05-06 23:59:11 +02:00
"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"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-03-06 16:05:27 +01:00
"Record<string, " ,
2021-03-04 02:12:24 +01:00
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.DownloadableContent" ,
"text" : "DownloadableContent"
2021-03-06 16:05:27 +01:00
} ,
">"
2021-03-04 02:12:24 +01:00
] ,
"source" : {
"path" : "src/plugins/share/public/lib/download_as.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 34
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [
2021-03-06 16:05:27 +01:00
"a Promise that resolves when all the downloads have been correctly started"
2021-03-04 02:12:24 +01:00
] ,
"initialIsOpen" : false
2021-06-30 19:04:59 +02:00
} ,
2021-08-02 22:44:47 +02:00
{
"parentPluginId" : "share" ,
"id" : "def-public.formatSearchParams" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "formatSearchParams" ,
"description" : [ ] ,
"signature" : [
"(opts: " ,
"RedirectOptions" ,
") => URLSearchParams"
] ,
"source" : {
"path" : "src/plugins/share/public/url_service/redirect/util/format_search_params.ts" ,
"lineNumber" : 11
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.formatSearchParams.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "opts" ,
"description" : [ ] ,
"signature" : [
"RedirectOptions"
] ,
"source" : {
"path" : "src/plugins/share/public/url_service/redirect/util/format_search_params.ts" ,
"lineNumber" : 11
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-public.parseSearchParams" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "parseSearchParams" ,
"description" : [
"\nParses redirect endpoint URL path search parameters. Expects them in the\nfollowing form:\n\n```\n/r?l=<locator_id>&v=<version>&p=<params>\n```\n"
] ,
"signature" : [
"(urlSearch: string) => " ,
"RedirectOptions"
] ,
"source" : {
"path" : "src/plugins/share/public/url_service/redirect/util/parse_search_params.ts" ,
"lineNumber" : 24
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.parseSearchParams.$1" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "urlSearch" ,
"description" : [
"Search part of URL path."
] ,
"signature" : [
"string"
] ,
"source" : {
"path" : "src/plugins/share/public/url_service/redirect/util/parse_search_params.ts" ,
"lineNumber" : 24
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [
"Parsed out locator ID, version, and locator params."
] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.useLocatorUrl" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "useLocatorUrl" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-06-30 19:04:59 +02:00
"signature" : [
"<P extends " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">(locator: " ,
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> | null | undefined, params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined, deps?: React.DependencyList) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 14
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.useLocatorUrl.$1" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "locator" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-06-30 19:04:59 +02:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> | null | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 15
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.useLocatorUrl.$2" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "params" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"P"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 16
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.useLocatorUrl.$3" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getUrlParams" ,
"description" : [ ] ,
"signature" : [
"LocatorGetUrlParams" ,
" | undefined"
2021-03-04 02:12:24 +01:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 17
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.useLocatorUrl.$4" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "deps" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"React.DependencyList"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 18
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.KibanaLocation" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "KibanaLocation" ,
"description" : [
"\nThis interface represents a location in Kibana to which one can navigate\nusing the `core.application.navigateToApp()` method."
] ,
"signature" : [
"KibanaLocation" ,
"<S>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 110
} ,
"deprecated" : false ,
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.KibanaLocation.app" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "app" ,
"description" : [
"\nKibana application ID."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 114
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.KibanaLocation.path" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "path" ,
"description" : [
"\nA relative URL path within a Kibana application."
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 119
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.KibanaLocation.state" ,
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "state" ,
"description" : [
"\nA serializable location state object, which the app can use to determine\nwhat should be displayed on the screen."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-06-30 19:04:59 +02:00
"S"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 125
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorDefinition" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "LocatorDefinition" ,
"description" : [
"\nA convenience interface used to define and register a locator."
] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"scope" : "common" ,
2021-03-06 16:05:27 +01:00
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-common.LocatorDefinition" ,
"text" : "LocatorDefinition"
2021-03-06 16:05:27 +01:00
} ,
2021-06-30 19:04:59 +02:00
"<P> extends Partial<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
"<P>>"
2021-03-06 16:05:27 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 34
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorDefinition.id" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "id" ,
"description" : [
"\nUnique ID of the locator. Should be constant and unique across Kibana."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 39
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorDefinition.getLocation" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getLocation" ,
"description" : [
"\nReturns a deep link, including location state, which can be used for\nnavigation in Kibana.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"(params: P) => Promise<" ,
"KibanaLocation" ,
"<object>>"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 47
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.LocatorDefinition.getLocation.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"Parameters from which to generate a Kibana location."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorPublic" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "LocatorPublic" ,
"description" : [
"\nPublic interface of a registered locator."
] ,
"signature" : [
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> extends " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
"<P>"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 53
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorPublic.getLocation" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getLocation" ,
"description" : [
"\nReturns a reference to a Kibana client-side location.\n"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-06-30 19:04:59 +02:00
"(params: P) => Promise<" ,
"KibanaLocation" ,
"<object>>"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 59
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.getLocation.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 59
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorPublic.getUrl" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getUrl" ,
"description" : [
"\nReturns a URL as a string.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"(params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined) => Promise<string>"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.getUrl.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
} ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.getUrl.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "getUrlParams" ,
"description" : [
"URL construction parameters."
] ,
"signature" : [
"LocatorGetUrlParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
} ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.LocatorPublic.navigate" ,
2021-03-06 16:05:27 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "navigate" ,
"description" : [
"\nNavigate using the `core.application.navigateToApp()` method to a Kibana\nlocation generated by this locator. This method is available only on the\nbrowser.\n"
] ,
2021-03-06 16:05:27 +01:00
"signature" : [
2021-06-30 19:04:59 +02:00
"(params: P, navigationParams?: " ,
"LocatorNavigationParams" ,
" | undefined) => Promise<void>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"children" : [
2021-03-06 16:05:27 +01:00
{
2021-06-30 19:04:59 +02:00
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.navigate.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-06 16:05:27 +01:00
} ,
{
2021-06-30 19:04:59 +02:00
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.navigate.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "navigationParams" ,
"description" : [
"Navigation parameters."
] ,
"signature" : [
"LocatorNavigationParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "share" ,
"id" : "def-public.LocatorPublic.useUrl" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useUrl" ,
"description" : [
"\nReact hook which returns a URL string given locator parameters. Returns\nempty string if URL is being loaded or an error happened."
] ,
"signature" : [
"(params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined, deps?: React.DependencyList | undefined) => string"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
2021-05-06 23:59:11 +02:00
} ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.params" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [ ] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-public.getUrlParams" ,
2021-05-20 22:11:31 +02:00
"type" : "Object" ,
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getUrlParams" ,
2021-05-20 22:11:31 +02:00
"description" : [ ] ,
"signature" : [
2021-06-30 19:04:59 +02:00
"LocatorGetUrlParams" ,
" | undefined"
2021-05-20 22:11:31 +02:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-public.deps" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "deps" ,
"description" : [ ] ,
"signature" : [
"React.DependencyList | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
2021-05-20 22:11:31 +02:00
} ,
"deprecated" : false
}
]
2021-03-06 16:05:27 +01:00
}
] ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContext" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "ShareContext" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/public/types.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 23
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContext.objectType" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"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" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"string | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/public/types.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 25
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContext.shareableUrl" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"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" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-06-30 19:04:59 +02:00
"signature" : [
"{ [key: string]: unknown; }"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/public/types.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 36
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContext.isDirty" ,
2021-03-04 02:12:24 +01:00
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "isDirty" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/public/types.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 37
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContext.onClose" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "onClose" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"() => void"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/public/types.ts" ,
2021-06-30 19:04:59 +02:00
"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
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContextMenuPanelItem" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "ShareContextMenuPanelItem" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShareContextMenuPanelItem" ,
"text" : "ShareContextMenuPanelItem"
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
" extends Pick<" ,
"EuiContextMenuPanelItemDescriptorEntry" ,
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"disabled\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 48
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContextMenuPanelItem.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "name" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 50
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareContextMenuPanelItem.sortOrder" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"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" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShareContextMenuPanelItem" ,
"text" : "ShareContextMenuPanelItem"
}
2021-03-06 16:05:27 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 60
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareMenuItem.panel" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "panel" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-06-30 19:04:59 +02:00
"signature" : [
"EuiContextMenuPanelDescriptor"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"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
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShareMenuProvider.getShareMenuItems" ,
2021-03-06 16:05:27 +01:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "getShareMenuItems" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
2021-06-30 19:04:59 +02:00
"(context: " ,
2021-03-06 16:05:27 +01:00
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShareContext" ,
"text" : "ShareContext"
2021-03-06 16:05:27 +01:00
} ,
2021-06-30 19:04:59 +02:00
") => " ,
2021-03-06 16:05:27 +01:00
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShareMenuItem" ,
"text" : "ShareMenuItem"
2021-03-06 16:05:27 +01:00
} ,
2021-06-30 19:04:59 +02:00
"[]"
2021-03-06 16:05:27 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 74
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-06-30 19:04:59 +02:00
"returnComment" : [ ] ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.context" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "context" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-06 16:05:27 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShareContext" ,
"text" : "ShareContext"
}
2021-03-06 16:05:27 +01:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 74
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
2021-06-30 19:04:59 +02:00
]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShowShareMenuOptions" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "ShowShareMenuOptions" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.ShowShareMenuOptions" ,
"text" : "ShowShareMenuOptions"
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
" extends Pick<" ,
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.ShareContext" ,
"text" : "ShareContext"
} ,
", \"objectType\" | \"objectId\" | \"shareableUrl\" | \"sharingData\" | \"isDirty\" | \"showPublicUrlSwitch\">"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 87
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShowShareMenuOptions.anchorElement" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "anchorElement" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"HTMLElement"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 88
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShowShareMenuOptions.allowEmbed" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "allowEmbed" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 89
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShowShareMenuOptions.allowShortUrl" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "allowShortUrl" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/types.ts" ,
"lineNumber" : 90
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.ShowShareMenuOptions.embedUrlParamExtensions" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "embedUrlParamExtensions" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
"signature" : [
2021-06-30 19:04:59 +02:00
"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: " ,
{
2021-03-04 02:12:24 +01:00
"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"
} ,
2021-06-30 19:04:59 +02:00
"[Id][\"MigratedId\"]; }>"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
2021-06-30 19:04:59 +02:00
"path" : "src/plugins/share/public/url_generators/url_generator_contract.ts" ,
"lineNumber" : 15
2021-05-06 23:59:11 +02:00
} ,
2021-06-30 19:04:59 +02:00
"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" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.UrlGeneratorsDefinition" ,
2021-03-04 02:12:24 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "UrlGeneratorsDefinition" ,
2021-05-06 23:59:11 +02:00
"description" : [ ] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
2021-06-30 19:04:59 +02:00
"section" : "def-public.UrlGeneratorsDefinition" ,
"text" : "UrlGeneratorsDefinition"
2021-03-04 02:12:24 +01:00
} ,
2021-06-30 19:04:59 +02:00
"<Id>"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 30
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.UrlGeneratorsDefinition.id" ,
2021-03-04 02:12:24 +01:00
"type" : "Uncategorized" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "id" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"Id"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 31
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.UrlGeneratorsDefinition.createUrl" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "createUrl" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"((state: " ,
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.UrlGeneratorStateMapping" ,
"text" : "UrlGeneratorStateMapping"
} ,
"[Id][\"State\"]) => Promise<string>) | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 32
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.UrlGeneratorsDefinition.isDeprecated" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "isDeprecated" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-06-30 19:04:59 +02:00
"boolean | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
2021-06-30 19:04:59 +02:00
"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
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-06-30 19:04:59 +02:00
"id" : "def-public.UrlGeneratorState" ,
2021-03-06 16:05:27 +01:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-06-30 19:04:59 +02:00
"label" : "UrlGeneratorState" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-06-30 19:04:59 +02:00
"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
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.UrlGeneratorStateMapping.Unnamed" ,
"type" : "Any" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "Unnamed" ,
2021-03-06 16:05:27 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"any"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
"lineNumber" : 27
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.CSV_QUOTE_VALUES_SETTING" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "CSV_QUOTE_VALUES_SETTING" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"csv:quoteValues\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 10
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.CSV_SEPARATOR_SETTING" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "CSV_SEPARATOR_SETTING" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"csv:separator\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.DownloadableContent" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "DownloadableContent" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"Blob | { content: string; type: string; }"
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/lib/download_as.ts" ,
"lineNumber" : 13
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-06 16:05:27 +01:00
"id" : "def-public.UrlGeneratorId" ,
2021-03-04 02:12:24 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "UrlGeneratorId" ,
2021-03-04 02:12:24 +01:00
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "src/plugins/share/public/url_generators/url_generator_definition.ts" ,
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.SharePluginSetup" ,
"type" : "Type" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SharePluginSetup" ,
"description" : [ ] ,
"signature" : [
"{ register: (shareMenuProvider: " ,
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.ShareMenuProvider" ,
"text" : "ShareMenuProvider"
} ,
2021-05-20 22:11:31 +02:00
") => void; } & { urlGenerators: " ,
"UrlGeneratorsSetup" ,
2021-06-08 22:26:37 +02:00
"; url: " ,
"UrlService" ,
2021-05-20 22:11:31 +02:00
"; }"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/plugin.ts" ,
2021-08-02 22:44:47 +02:00
"lineNumber" : 33
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.SharePluginStart" ,
"type" : "Type" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SharePluginStart" ,
"description" : [ ] ,
"signature" : [
"{ toggleShareContextMenu: (options: " ,
{
"pluginId" : "share" ,
"scope" : "public" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-public.ShowShareMenuOptions" ,
"text" : "ShowShareMenuOptions"
} ,
2021-05-20 22:11:31 +02:00
") => void; } & { urlGenerators: " ,
"UrlGeneratorsStart" ,
2021-06-08 22:26:37 +02:00
"; url: " ,
"UrlService" ,
2021-05-20 22:11:31 +02:00
"; }"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/share/public/plugin.ts" ,
2021-08-02 22:44:47 +02:00
"lineNumber" : 48
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.CSV_QUOTE_VALUES_SETTING" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "CSV_QUOTE_VALUES_SETTING" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"csv:quoteValues\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 10
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "share" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.CSV_SEPARATOR_SETTING" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "CSV_SEPARATOR_SETTING" ,
"description" : [ ] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"csv:separator\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/share/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 9
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
2021-06-30 19:04:59 +02:00
"objects" : [ ] ,
"setup" : {
"parentPluginId" : "share" ,
"id" : "def-server.SharePluginSetup" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "SharePluginSetup" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/server/plugin.ts" ,
"lineNumber" : 18
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-server.SharePluginSetup.url" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "url" ,
"description" : [ ] ,
"signature" : [
"UrlService"
] ,
"source" : {
"path" : "src/plugins/share/server/plugin.ts" ,
"lineNumber" : 19
} ,
"deprecated" : false
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"parentPluginId" : "share" ,
"id" : "def-server.SharePluginStart" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "SharePluginStart" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/share/server/plugin.ts" ,
"lineNumber" : 23
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-server.SharePluginStart.url" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "url" ,
"description" : [ ] ,
"signature" : [
"UrlService"
] ,
"source" : {
"path" : "src/plugins/share/server/plugin.ts" ,
"lineNumber" : 24
} ,
"deprecated" : false
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
2021-03-04 02:12:24 +01:00
} ,
"common" : {
"classes" : [ ] ,
2021-06-30 19:04:59 +02:00
"functions" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.useLocatorUrl" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useLocatorUrl" ,
"description" : [ ] ,
"signature" : [
"<P extends " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">(locator: " ,
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> | null | undefined, params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined, deps?: React.DependencyList) => string"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 14
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.useLocatorUrl.$1" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "locator" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> | null | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 15
} ,
"deprecated" : false ,
"isRequired" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.useLocatorUrl.$2" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [ ] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 16
} ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.useLocatorUrl.$3" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "getUrlParams" ,
"description" : [ ] ,
"signature" : [
"LocatorGetUrlParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 17
} ,
"deprecated" : false ,
"isRequired" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.useLocatorUrl.$4" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "deps" ,
"description" : [ ] ,
"signature" : [
"React.DependencyList"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/use_locator_url.ts" ,
"lineNumber" : 18
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorDefinition" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "LocatorDefinition" ,
"description" : [
"\nA convenience interface used to define and register a locator."
] ,
"signature" : [
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorDefinition" ,
"text" : "LocatorDefinition"
} ,
"<P> extends Partial<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
"<P>>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 34
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorDefinition.id" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "id" ,
"description" : [
"\nUnique ID of the locator. Should be constant and unique across Kibana."
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 39
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorDefinition.getLocation" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getLocation" ,
"description" : [
"\nReturns a deep link, including location state, which can be used for\nnavigation in Kibana.\n"
] ,
"signature" : [
"(params: P) => Promise<" ,
"KibanaLocation" ,
"<object>>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorDefinition.getLocation.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"Parameters from which to generate a Kibana location."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "LocatorPublic" ,
"description" : [
"\nPublic interface of a registered locator."
] ,
"signature" : [
{
"pluginId" : "share" ,
"scope" : "common" ,
"docId" : "kibSharePluginApi" ,
"section" : "def-common.LocatorPublic" ,
"text" : "LocatorPublic"
} ,
"<P> extends " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
"<P>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 53
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.getLocation" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getLocation" ,
"description" : [
"\nReturns a reference to a Kibana client-side location.\n"
] ,
"signature" : [
"(params: P) => Promise<" ,
"KibanaLocation" ,
"<object>>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 59
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.getLocation.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 59
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.getUrl" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "getUrl" ,
"description" : [
"\nReturns a URL as a string.\n"
] ,
"signature" : [
"(params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined) => Promise<string>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.getUrl.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
} ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.getUrl.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "getUrlParams" ,
"description" : [
"URL construction parameters."
] ,
"signature" : [
"LocatorGetUrlParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 67
} ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.navigate" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "navigate" ,
"description" : [
"\nNavigate using the `core.application.navigateToApp()` method to a Kibana\nlocation generated by this locator. This method is available only on the\nbrowser.\n"
] ,
"signature" : [
"(params: P, navigationParams?: " ,
"LocatorNavigationParams" ,
" | undefined) => Promise<void>"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.navigate.$1" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [
"URL locator parameters."
] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"isRequired" : true
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.navigate.$2" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "navigationParams" ,
"description" : [
"Navigation parameters."
] ,
"signature" : [
"LocatorNavigationParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 77
} ,
"deprecated" : false ,
"isRequired" : false
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.LocatorPublic.useUrl" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "useUrl" ,
"description" : [
"\nReact hook which returns a URL string given locator parameters. Returns\nempty string if URL is being loaded or an error happened."
] ,
"signature" : [
"(params: P, getUrlParams?: " ,
"LocatorGetUrlParams" ,
" | undefined, deps?: React.DependencyList | undefined) => string"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "share" ,
"id" : "def-common.params" ,
"type" : "Uncategorized" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [ ] ,
"signature" : [
"P"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.getUrlParams" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "getUrlParams" ,
"description" : [ ] ,
"signature" : [
"LocatorGetUrlParams" ,
" | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "share" ,
"id" : "def-common.deps" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "deps" ,
"description" : [ ] ,
"signature" : [
"React.DependencyList | undefined"
] ,
"source" : {
"path" : "src/plugins/share/common/url_service/locators/types.ts" ,
"lineNumber" : 83
} ,
"deprecated" : false
}
]
}
] ,
"initialIsOpen" : false
}
] ,
2021-03-04 02:12:24 +01:00
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}