204efae5bf
* Use Serializable from package * Rename to align with core * fix * more replacements * docssss * fix * Move it to @kbn/utility-types and remove core export * buildy build * tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2299 lines
74 KiB
JSON
2299 lines
74 KiB
JSON
{
|
|
"id": "share",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "KibanaURL",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.appName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.appPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appPath",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaURL.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/share/public/kibana_url.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsService.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_service.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.downloadFileAs.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filename",
|
|
"description": [
|
|
"full name of the file"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a Promise that resolves when all the downloads have been correctly started"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.formatSearchParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatSearchParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(opts: ",
|
|
"RedirectOptions",
|
|
") => URLSearchParams"
|
|
],
|
|
"path": "src/plugins/share/public/url_service/redirect/util/format_search_params.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.formatSearchParams.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
"RedirectOptions"
|
|
],
|
|
"path": "src/plugins/share/public/url_service/redirect/util/format_search_params.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/public/url_service/redirect/util/parse_search_params.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.parseSearchParams.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "urlSearch",
|
|
"description": [
|
|
"Search part of URL path."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/share/public/url_service/redirect/util/parse_search_params.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"Parsed out locator ID, version, and locator params."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.useLocatorUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useLocatorUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"<P extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.Serializable",
|
|
"text": "Serializable"
|
|
},
|
|
">(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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.useLocatorUrl.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "locator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<P> | null | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.useLocatorUrl.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.useLocatorUrl.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.useLocatorUrl.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
"React.DependencyList"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaLocation.app",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "app",
|
|
"description": [
|
|
"\nKibana application ID."
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaLocation.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [
|
|
"\nA relative URL path within a Kibana application."
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.KibanaLocation.state",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [
|
|
"\nA serializable location state object, which the app can use to determine\nwhat should be displayed on the screen."
|
|
],
|
|
"signature": [
|
|
"S"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.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>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nUnique ID of the locator. Should be constant and unique across Kibana."
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.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>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.getLocation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLocation",
|
|
"description": [
|
|
"\nReturns a reference to a Kibana client-side location.\n"
|
|
],
|
|
"signature": [
|
|
"(params: P) => Promise<",
|
|
"KibanaLocation",
|
|
"<object>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.getLocation.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.getUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUrl",
|
|
"description": [
|
|
"\nReturns a URL as a string.\n"
|
|
],
|
|
"signature": [
|
|
"(params: P, getUrlParams?: ",
|
|
"LocatorGetUrlParams",
|
|
" | undefined) => Promise<string>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.getUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.getUrl.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [
|
|
"URL construction parameters."
|
|
],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.navigate.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.navigate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "navigationParams",
|
|
"description": [
|
|
"Navigation parameters."
|
|
],
|
|
"signature": [
|
|
"LocatorNavigationParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.useUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.useUrl.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.LocatorPublic.useUrl.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
"React.DependencyList | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareContext",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.objectType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectType",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.objectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"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`"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.sharingData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sharingData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: unknown; }"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.isDirty",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDirty",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.showPublicUrlSwitch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showPublicUrlSwitch",
|
|
"description": [],
|
|
"signature": [
|
|
"((anonymousUserCapabilities: ",
|
|
"Capabilities",
|
|
") => boolean) | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContext.showPublicUrlSwitch.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "anonymousUserCapabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"Capabilities"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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\">"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContextMenuPanelItem.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareContextMenuPanelItem.sortOrder",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareMenuItem",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuItem.panel",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panel",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiContextMenuPanelDescriptor"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareMenuProvider",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShareMenuProvider.getShareMenuItems.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.ShareContext",
|
|
"text": "ShareContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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\">"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.anchorElement",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "anchorElement",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.allowEmbed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowEmbed",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.allowShortUrl",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowShortUrl",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.ShowShareMenuOptions.embedUrlParamExtensions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "embedUrlParamExtensions",
|
|
"description": [],
|
|
"signature": [
|
|
"UrlParamExtension",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/types.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"Id"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"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\"]"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorContract.isDeprecated",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDeprecated",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"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\"]; }>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"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\"]"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_contract.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.id",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"Id"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.createUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.isDeprecated",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isDeprecated",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorsDefinition.migrate.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[Id][\"State\"]"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.State",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "State",
|
|
"description": [],
|
|
"signature": [
|
|
"S"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.MigratedId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "MigratedId",
|
|
"description": [],
|
|
"signature": [
|
|
"I | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorState.MigratedState",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "MigratedState",
|
|
"description": [],
|
|
"signature": [
|
|
"MS | undefined"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorStateMapping",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UrlGeneratorStateMapping",
|
|
"description": [],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorStateMapping.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"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\""
|
|
],
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.CSV_SEPARATOR_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_SEPARATOR_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:separator\""
|
|
],
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.DownloadableContent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DownloadableContent",
|
|
"description": [],
|
|
"signature": [
|
|
"Blob | { content: string; type: string; }"
|
|
],
|
|
"path": "src/plugins/share/public/lib/download_as.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-public.UrlGeneratorId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UrlGeneratorId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/share/public/url_generators/url_generator_definition.ts",
|
|
"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",
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/share/public/plugin.ts",
|
|
"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",
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/share/public/plugin.ts",
|
|
"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\""
|
|
],
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-server.CSV_SEPARATOR_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CSV_SEPARATOR_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"csv:separator\""
|
|
],
|
|
"path": "src/plugins/share/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "share",
|
|
"id": "def-server.SharePluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SharePluginSetup",
|
|
"description": [],
|
|
"path": "src/plugins/share/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-server.SharePluginSetup.url",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"signature": [
|
|
"UrlService"
|
|
],
|
|
"path": "src/plugins/share/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "share",
|
|
"id": "def-server.SharePluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SharePluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/share/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-server.SharePluginStart.url",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"signature": [
|
|
"UrlService"
|
|
],
|
|
"path": "src/plugins/share/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"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.Serializable",
|
|
"text": "Serializable"
|
|
},
|
|
">(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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.useLocatorUrl.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.useLocatorUrl.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.useLocatorUrl.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
"React.DependencyList"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/use_locator_url.ts",
|
|
"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>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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."
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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>>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.getLocation.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.getUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.getUrl.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [
|
|
"URL construction parameters."
|
|
],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.navigate.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"URL locator parameters."
|
|
],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.navigate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "navigationParams",
|
|
"description": [
|
|
"Navigation parameters."
|
|
],
|
|
"signature": [
|
|
"LocatorNavigationParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.useUrl.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.useUrl.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "getUrlParams",
|
|
"description": [],
|
|
"signature": [
|
|
"LocatorGetUrlParams",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "share",
|
|
"id": "def-common.LocatorPublic.useUrl.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
"React.DependencyList | undefined"
|
|
],
|
|
"path": "src/plugins/share/common/url_service/locators/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |