* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
1789 lines
63 KiB
JSON
1789 lines
63 KiB
JSON
{
|
|
"id": "kibanaLegacy",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.KibanaLegacyPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "KibanaLegacyPlugin",
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.KibanaLegacyPlugin.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "initializerContext",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<Readonly<{} & { defaultAppId: string; }>>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L15"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.KibanaLegacyPlugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<{}, { dashboardConfig: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.DashboardConfig",
|
|
"text": "DashboardConfig"
|
|
},
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<{}, { dashboardConfig: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.DashboardConfig",
|
|
"text": "DashboardConfig"
|
|
},
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L17"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.KibanaLegacyPlugin.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"({ application, http: { basePath }, uiSettings }: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => { dashboardConfig: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.DashboardConfig",
|
|
"text": "DashboardConfig"
|
|
},
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{ application, http: { basePath }, uiSettings }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L21"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L21"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L14"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ToastNotifications",
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ToastNotifications.list",
|
|
"type": "Array",
|
|
"label": "list",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L12"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "toasts",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastsApi",
|
|
"text": "ToastsApi"
|
|
},
|
|
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.onChange",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Function",
|
|
"label": "callback",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(callback: () => void) => void"
|
|
],
|
|
"description": [],
|
|
"label": "onChange",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.add",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "toastOrTitle",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "add",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.remove",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "toast",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(toast: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"label": "remove",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.addSuccess",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "toastOrTitle",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "addSuccess",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.addWarning",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "toastOrTitle",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "addWarning",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.addDanger",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "toastOrTitle",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "addDanger",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.ToastNotifications.addError",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "error",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(error: Error, options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "addError",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.initAngularBootstrap",
|
|
"type": "Function",
|
|
"label": "initAngularBootstrap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular_bootstrap/index.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular_bootstrap/index.ts#L15"
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.PaginateDirectiveProvider",
|
|
"type": "Function",
|
|
"label": "PaginateDirectiveProvider",
|
|
"signature": [
|
|
"($parse: any, $compile: any) => any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Any",
|
|
"label": "$parse",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"
|
|
}
|
|
},
|
|
{
|
|
"type": "Any",
|
|
"label": "$compile",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.PaginateControlsDirectiveProvider",
|
|
"type": "Function",
|
|
"label": "PaginateControlsDirectiveProvider",
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L10"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.PromiseServiceCreator",
|
|
"type": "Function",
|
|
"label": "PromiseServiceCreator",
|
|
"signature": [
|
|
"($q: unknown, $timeout: unknown) => (fn: unknown) => unknown"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Unknown",
|
|
"label": "$q",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/promises.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"
|
|
}
|
|
},
|
|
{
|
|
"type": "Unknown",
|
|
"label": "$timeout",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/promises.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/promises.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.watchMultiDecorator",
|
|
"type": "Function",
|
|
"label": "watchMultiDecorator",
|
|
"signature": [
|
|
"($provide: unknown) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Unknown",
|
|
"label": "$provide",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.createTopNavHelper",
|
|
"type": "Function",
|
|
"label": "createTopNavHelper",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L14"
|
|
},
|
|
"signature": [
|
|
"(options: unknown) => angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.loadKbnTopNavDirectives",
|
|
"type": "Function",
|
|
"label": "loadKbnTopNavDirectives",
|
|
"signature": [
|
|
"(navUi: unknown) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Unknown",
|
|
"label": "navUi",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.subscribeWithScope",
|
|
"type": "Function",
|
|
"label": "subscribeWithScope",
|
|
"signature": [
|
|
"($scope: angular.IScope, observable: ",
|
|
"Observable",
|
|
"<T>, observer: ",
|
|
"NextObserver",
|
|
"<T> | ",
|
|
"ErrorObserver",
|
|
"<T> | ",
|
|
"CompletionObserver",
|
|
"<T> | undefined, fatalError: FatalErrorFn | undefined) => ",
|
|
"Subscription"
|
|
],
|
|
"description": [
|
|
"\nSubscribe to an observable at a $scope, ensuring that the digest cycle\nis run for subscriber hooks and routing errors to fatalError if not handled."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "$scope",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"angular.IScope"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L40"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "observable",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Observable",
|
|
"<T>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L41"
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "observer",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"NextObserver",
|
|
"<T> | ",
|
|
"ErrorObserver",
|
|
"<T> | ",
|
|
"CompletionObserver",
|
|
"<T> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L42"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "fatalError",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"FatalErrorFn | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L43"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L39"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.configureAppAngularModule",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "angularModule",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"angular.IModule"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 63,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L63"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.configureAppAngularModule.newPlatform",
|
|
"type": "Object",
|
|
"label": "newPlatform",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.configureAppAngularModule.newPlatform.core",
|
|
"type": "Object",
|
|
"label": "core",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 65,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L65"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.configureAppAngularModule.newPlatform.env",
|
|
"type": "Object",
|
|
"label": "env",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 66,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L66"
|
|
},
|
|
"signature": [
|
|
"{ mode: Readonly<",
|
|
"EnvironmentMode",
|
|
">; packageInfo: Readonly<",
|
|
"PackageInfo",
|
|
">; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 64,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L64"
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "isLocalAngular",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L71"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "getHistory",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"(() => ",
|
|
"History",
|
|
"<any>) | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L72"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(angularModule: angular.IModule, newPlatform: { core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
"; readonly env: { mode: Readonly<",
|
|
"EnvironmentMode",
|
|
">; packageInfo: Readonly<",
|
|
"PackageInfo",
|
|
">; }; }, isLocalAngular: boolean, getHistory?: (() => ",
|
|
"History",
|
|
"<any>) | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"label": "configureAppAngularModule",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 62,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L62"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.$setupXsrfRequestInterceptor",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "version",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 136,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(version: string) => ($httpProvider: angular.IHttpProvider) => void"
|
|
],
|
|
"description": [],
|
|
"label": "$setupXsrfRequestInterceptor",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 136,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.formatESMsg",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "err",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string | Record<string, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(err: string | Record<string, any>) => string | undefined"
|
|
],
|
|
"description": [
|
|
"\nUtilize the extended error information returned from elasticsearch"
|
|
],
|
|
"label": "formatESMsg",
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.formatMsg",
|
|
"type": "Function",
|
|
"label": "formatMsg",
|
|
"signature": [
|
|
"(err: string | Record<string, any>, source: string) => string"
|
|
],
|
|
"description": [
|
|
"\nFormats the error message from an error object, extended elasticsearch\nobject or simple string; prepends optional second parameter to the message"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "err",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string | Record<string, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "source",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
"- Prefix for message indicating source (optional)"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_msg.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.formatStack",
|
|
"type": "Function",
|
|
"label": "formatStack",
|
|
"signature": [
|
|
"(err: Record<string, any>) => any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "err",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_stack.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.isAngularHttpError",
|
|
"type": "Function",
|
|
"label": "isAngularHttpError",
|
|
"signature": [
|
|
"(error: any) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Any",
|
|
"label": "error",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.formatAngularHttpError",
|
|
"type": "Function",
|
|
"label": "formatAngularHttpError",
|
|
"signature": [
|
|
"(error: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.AngularHttpError",
|
|
"text": "AngularHttpError"
|
|
},
|
|
") => string"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "error",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.AngularHttpError",
|
|
"text": "AngularHttpError"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.addFatalError",
|
|
"type": "Function",
|
|
"label": "addFatalError",
|
|
"signature": [
|
|
"(fatalErrors: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.FatalErrorsSetup",
|
|
"text": "FatalErrorsSetup"
|
|
},
|
|
", error: string | Error | ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.AngularHttpError",
|
|
"text": "AngularHttpError"
|
|
},
|
|
", location: string | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "fatalErrors",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.FatalErrorsSetup",
|
|
"text": "FatalErrorsSetup"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
|
|
"lineNumber": 17,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "error",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string | Error | ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.AngularHttpError",
|
|
"text": "AngularHttpError"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L18"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "location",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L19"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L16"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.PrivateProvider",
|
|
"type": "Function",
|
|
"label": "PrivateProvider",
|
|
"signature": [
|
|
"() => angular.IServiceProvider"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/private.d.ts#L13"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.registerListenEventListener",
|
|
"type": "Function",
|
|
"label": "registerListenEventListener",
|
|
"signature": [
|
|
"($rootScope: unknown) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Unknown",
|
|
"label": "$rootScope",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.addSystemApiHeader",
|
|
"type": "Function",
|
|
"label": "addSystemApiHeader",
|
|
"signature": [
|
|
"(originalHeaders: Record<string, string>) => { \"kbn-system-request\": boolean; }"
|
|
],
|
|
"description": [
|
|
"\nAdds a custom header designating request as system API"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "originalHeaders",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Record<string, string>"
|
|
],
|
|
"description": [
|
|
"Object representing set of headers"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/system_api.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/system_api.ts#L19"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"returnComment": [
|
|
"Object representing set of headers, with system API header added in"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/system_api.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/system_api.ts#L19"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.isSystemApiRequest",
|
|
"type": "Function",
|
|
"label": "isSystemApiRequest",
|
|
"signature": [
|
|
"(request: angular.IRequestConfig) => boolean | undefined"
|
|
],
|
|
"description": [
|
|
"\nReturns true if request is a system API request; false otherwise\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"angular.IRequestConfig"
|
|
],
|
|
"description": [
|
|
"Object Request object created by $http service"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/system_api.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/system_api.ts#L35"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"returnComment": [
|
|
"true if request is a system API request; false otherwise"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/system_api.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/system_api.ts#L35"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.RouteConfiguration",
|
|
"type": "Interface",
|
|
"label": "RouteConfiguration",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.controller",
|
|
"type": "CompoundType",
|
|
"label": "controller",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L29"
|
|
},
|
|
"signature": [
|
|
"string | ((...args: any[]) => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.redirectTo",
|
|
"type": "string",
|
|
"label": "redirectTo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L30"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.resolveRedirectTo",
|
|
"type": "Function",
|
|
"label": "resolveRedirectTo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L31"
|
|
},
|
|
"signature": [
|
|
"((...args: any[]) => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.reloadOnSearch",
|
|
"type": "CompoundType",
|
|
"label": "reloadOnSearch",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L32"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.reloadOnUrl",
|
|
"type": "CompoundType",
|
|
"label": "reloadOnUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L33"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.outerAngularWrapperRoute",
|
|
"type": "CompoundType",
|
|
"label": "outerAngularWrapperRoute",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L34"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.resolve",
|
|
"type": "Uncategorized",
|
|
"label": "resolve",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L35"
|
|
},
|
|
"signature": [
|
|
"object | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.template",
|
|
"type": "string",
|
|
"label": "template",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L36"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.k7Breadcrumbs",
|
|
"type": "Function",
|
|
"label": "k7Breadcrumbs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L37"
|
|
},
|
|
"signature": [
|
|
"((...args: any[]) => ",
|
|
"EuiBreadcrumb",
|
|
"[]) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RouteConfiguration.requireUICapability",
|
|
"type": "string",
|
|
"label": "requireUICapability",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L38"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L28"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.KibanaLegacySetup",
|
|
"type": "Type",
|
|
"label": "KibanaLegacySetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 45,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L45"
|
|
},
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.KibanaLegacyStart",
|
|
"type": "Type",
|
|
"label": "KibanaLegacyStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/plugin.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/plugin.ts#L46"
|
|
},
|
|
"signature": [
|
|
"{ dashboardConfig: ",
|
|
"DashboardConfig",
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.createTopNavDirective",
|
|
"type": "CompoundType",
|
|
"label": "createTopNavDirective",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L11"
|
|
},
|
|
"signature": [
|
|
"angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AngularHttpError",
|
|
"type": "Type",
|
|
"label": "AngularHttpError",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L12"
|
|
},
|
|
"signature": [
|
|
"IHttpResponse<{ message: string; }>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.KbnAccessibleClickProvider",
|
|
"type": "CompoundType",
|
|
"label": "KbnAccessibleClickProvider",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts#L11"
|
|
},
|
|
"signature": [
|
|
"angular.Injectable<angular.IDirectiveFactory<angular.IScope, JQLite, angular.IAttributes, angular.IController>>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.IPrivate",
|
|
"type": "Type",
|
|
"label": "IPrivate",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/kibana_legacy/public/utils/private.d.ts#L11"
|
|
},
|
|
"signature": [
|
|
"(provider: (...injectable: any[]) => T) => T"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |