maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/core_chrome.json

2537 lines
89 KiB
JSON
Raw Normal View History

API DOCS Step 3/3 (#92929) * 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>
2021-03-03 04:02:17 +01:00
{
"id": "core.chrome",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.ChromeBadge",
"type": "Interface",
"label": "ChromeBadge",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeBadge.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L20"
}
},
{
"tags": [],
"id": "def-public.ChromeBadge.tooltip",
"type": "string",
"label": "tooltip",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L21"
}
},
{
"tags": [],
"id": "def-public.ChromeBadge.iconType",
"type": "CompoundType",
"label": "iconType",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L22"
},
"signature": [
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
]
}
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L19"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeBrand",
"type": "Interface",
"label": "ChromeBrand",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeBrand.logo",
"type": "string",
"label": "logo",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L27"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeBrand.smallLogo",
"type": "string",
"label": "smallLogo",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L28"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtension",
"type": "Interface",
"label": "ChromeHelpExtension",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeHelpExtension.appName",
"type": "string",
"label": "appName",
"description": [
"\nProvide your plugin's name to create a header for separation"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L49"
}
},
{
"tags": [],
"id": "def-public.ChromeHelpExtension.links",
"type": "Array",
"label": "links",
"description": [
"\nCreates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L53"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuLink",
"text": "ChromeHelpExtensionMenuLink"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtension.content",
"type": "Function",
"label": "content",
"description": [
"\nCustom content to occur below the list of links"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L57"
},
"signature": [
"((element: HTMLDivElement) => () => void) | undefined"
]
}
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L45"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionMenuCustomLink",
"type": "Interface",
"label": "ChromeHelpExtensionMenuCustomLink",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuCustomLink",
"text": "ChromeHelpExtensionMenuCustomLink"
},
" extends Pick<(",
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuCustomLink.linkType",
"type": "string",
"label": "linkType",
"description": [
"\nExtend EuiButtonEmpty to provide extra functionality"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L86"
},
"signature": [
"\"custom\""
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuCustomLink.href",
"type": "string",
"label": "href",
"description": [
"\nURL of the link"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L90"
}
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuCustomLink.content",
"type": "CompoundType",
"label": "content",
"description": [
"\nContent of the button (in lieu of `children`)"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 94,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L94"
},
"signature": [
"React.ReactNode"
]
}
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L82"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionMenuDiscussLink",
"type": "Interface",
"label": "ChromeHelpExtensionMenuDiscussLink",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuDiscussLink",
"text": "ChromeHelpExtensionMenuDiscussLink"
},
" extends Pick<(",
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuDiscussLink.linkType",
"type": "string",
"label": "linkType",
"description": [
"\nCreates a generic give feedback link with comment icon"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L60"
},
"signature": [
"\"discuss\""
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuDiscussLink.href",
"type": "string",
"label": "href",
"description": [
"\nURL to discuss page.\ni.e. `https://discuss.elastic.co/c/${appName}`"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L65"
}
}
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L56"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionMenuDocumentationLink",
"type": "Interface",
"label": "ChromeHelpExtensionMenuDocumentationLink",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuDocumentationLink",
"text": "ChromeHelpExtensionMenuDocumentationLink"
},
" extends Pick<(",
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuDocumentationLink.linkType",
"type": "string",
"label": "linkType",
"description": [
"\nCreates a deep-link to app-specific documentation"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L73"
},
"signature": [
"\"documentation\""
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuDocumentationLink.href",
"type": "string",
"label": "href",
"description": [
"\nURL to documentation page.\ni.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`,"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 78,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L78"
}
}
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L69"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionMenuGitHubLink",
"type": "Interface",
"label": "ChromeHelpExtensionMenuGitHubLink",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuGitHubLink",
"text": "ChromeHelpExtensionMenuGitHubLink"
},
" extends Pick<(",
"DisambiguateSet",
"<",
"PropsForAnchor",
"<CommonEuiButtonEmptyProps, {}>, ",
"PropsForButton",
"<CommonEuiButtonEmptyProps, {}>> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
"DisambiguateSet"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuGitHubLink.linkType",
"type": "string",
"label": "linkType",
"description": [
"\nCreates a link to a new github issue in the Kibana repo"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L44"
},
"signature": [
"\"github\""
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuGitHubLink.labels",
"type": "Array",
"label": "labels",
"description": [
"\nInclude at least one app-specific label to be applied to the new github issue"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L48"
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.ChromeHelpExtensionMenuGitHubLink.title",
"type": "string",
"label": "title",
"description": [
"\nProvides initial text for the title of the issue"
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L52"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L40"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeNavControl",
"type": "Interface",
"label": "ChromeNavControl",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeNavControl.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L16"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavControl.mount",
"type": "Function",
"label": "mount",
"description": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L17"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.MountPoint",
"text": "MountPoint"
},
"<HTMLElement>"
]
}
],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L15"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeNavControls",
"type": "Interface",
"label": "ChromeNavControls",
"description": [
"\n{@link ChromeNavControls | APIs} for registering new controls to be displayed in the navigation bar.\n"
],
"tags": [
"example",
"public"
],
"children": [
{
"id": "def-public.ChromeNavControls.registerLeft",
"type": "Function",
"label": "registerLeft",
"signature": [
"(navControl: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
},
") => void"
],
"description": [
"Register a nav control to be presented on the bottom-left side of the chrome header."
],
"children": [
{
"type": "Object",
"label": "navControl",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
}
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38"
}
},
{
"id": "def-public.ChromeNavControls.registerRight",
"type": "Function",
"label": "registerRight",
"signature": [
"(navControl: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
},
") => void"
],
"description": [
"Register a nav control to be presented on the top-right side of the chrome header."
],
"children": [
{
"type": "Object",
"label": "navControl",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
}
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40"
}
},
{
"id": "def-public.ChromeNavControls.registerCenter",
"type": "Function",
"label": "registerCenter",
"signature": [
"(navControl: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
},
") => void"
],
"description": [
"Register a nav control to be presented on the top-center side of the chrome header."
],
"children": [
{
"type": "Object",
"label": "navControl",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControl",
"text": "ChromeNavControl"
}
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42"
}
}
],
"source": {
"path": "src/core/public/chrome/nav_controls/nav_controls_service.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L36"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeNavLink",
"type": "Interface",
"label": "ChromeNavLink",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeNavLink.id",
"type": "string",
"label": "id",
"description": [
"\nA unique identifier for looking up links."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L19"
}
},
{
"tags": [],
"id": "def-public.ChromeNavLink.title",
"type": "string",
"label": "title",
"description": [
"\nThe title of the application."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L24"
}
},
{
"tags": [],
"id": "def-public.ChromeNavLink.category",
"type": "Object",
"label": "category",
"description": [
"\nThe category the app lives in"
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L29"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.AppCategory",
"text": "AppCategory"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.baseUrl",
"type": "string",
"label": "baseUrl",
"description": [
"\nThe base route used to open the root of an application."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L34"
}
},
{
"tags": [],
"id": "def-public.ChromeNavLink.url",
"type": "string",
"label": "url",
"description": [
"\nThe route used to open the {@link AppBase.defaultPath | default path } of an application.\nIf unset, `baseUrl` will be used instead."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L40"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.order",
"type": "number",
"label": "order",
"description": [
"\nAn ordinal used to sort nav links relative to one another for display."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L45"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.tooltip",
"type": "string",
"label": "tooltip",
"description": [
"\nA tooltip shown when hovering over an app link."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L50"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.euiIconType",
"type": "string",
"label": "euiIconType",
"description": [
"\nA EUI iconType that will be used for the app's icon. This icon\ntakes precedence over the `icon` property."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L56"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.icon",
"type": "string",
"label": "icon",
"description": [
"\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L62"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.href",
"type": "string",
"label": "href",
"description": [
"\nSettled state between `url`, `baseUrl`, and `active`"
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L67"
}
},
{
"tags": [
"internalRemarks"
],
"id": "def-public.ChromeNavLink.disabled",
"type": "CompoundType",
"label": "disabled",
"description": [
"\nDisables a link from being clickable.\n"
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L76"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.ChromeNavLink.hidden",
"type": "CompoundType",
"label": "hidden",
"description": [
"\nHides a link from the navigation."
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L81"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L15"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeNavLinks",
"type": "Interface",
"label": "ChromeNavLinks",
"description": [
"\n{@link ChromeNavLinks | APIs} for manipulating nav links.\n"
],
"tags": [
"public"
],
"children": [
{
"id": "def-public.ChromeNavLinks.getNavLinks$",
"type": "Function",
"label": "getNavLinks$",
"signature": [
"() => ",
"Observable",
"<Readonly<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
">[]>"
],
"description": [
"\nGet an observable for a sorted list of navlinks."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L32"
}
},
{
"id": "def-public.ChromeNavLinks.get",
"type": "Function",
"label": "get",
"signature": [
"(id: string) => ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
" | undefined"
],
"description": [
"\nGet the state of a navlink at this point in time."
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38"
}
},
{
"id": "def-public.ChromeNavLinks.getAll",
"type": "Function",
"label": "getAll",
"signature": [
"() => Readonly<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
">[]"
],
"description": [
"\nGet the current state of all navlinks."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L43"
}
},
{
"id": "def-public.ChromeNavLinks.has",
"type": "Function",
"label": "has",
"signature": [
"(id: string) => boolean"
],
"description": [
"\nCheck whether or not a navlink exists."
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49"
}
},
{
"id": "def-public.ChromeNavLinks.showOnly",
"type": "Function",
"label": "showOnly",
"signature": [
"(id: string) => void"
],
"description": [
"\nRemove all navlinks except the one matching the given id.\n"
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59"
}
}
],
"tags": [
"remarks"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59"
}
},
{
"id": "def-public.ChromeNavLinks.update",
"type": "Function",
"label": "update",
"signature": [
"(id: string, values: Partial<Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
", \"hidden\" | \"disabled\" | \"href\" | \"url\">>) => ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
" | undefined"
],
"description": [
"\nUpdate the navlink for the given id with the updated attributes.\nReturns the updated navlink or `undefined` if it does not exist.\n"
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"
}
},
{
"type": "Object",
"label": "values",
"isRequired": true,
"signature": [
"Partial<Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
", \"hidden\" | \"disabled\" | \"href\" | \"url\">>"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"
}
}
],
"tags": [
"deprecated"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"
}
},
{
"id": "def-public.ChromeNavLinks.enableForcedAppSwitcherNavigation",
"type": "Function",
"label": "enableForcedAppSwitcherNavigation",
"signature": [
"() => void"
],
"description": [
"\nEnable forced navigation mode, which will trigger a page refresh\nwhen a nav link is clicked and only the hash is updated.\n"
],
"children": [],
"tags": [
"remarks"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L85"
}
},
{
"id": "def-public.ChromeNavLinks.getForceAppSwitcherNavigation$",
"type": "Function",
"label": "getForceAppSwitcherNavigation$",
"signature": [
"() => ",
"Observable",
"<boolean>"
],
"description": [
"\nAn observable of the forced app switcher state."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L90"
}
}
],
"source": {
"path": "src/core/public/chrome/nav_links/nav_links_service.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L28"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeDocTitle",
"type": "Interface",
"label": "ChromeDocTitle",
"description": [
"\nAPIs for accessing and updating the document title.\n"
],
"tags": [
"example",
"example",
"public"
],
"children": [
{
"id": "def-public.ChromeDocTitle.change",
"type": "Function",
"label": "change",
"signature": [
"(newTitle: string | string[]) => void"
],
"description": [
"\nChanges the current document title.\n"
],
"children": [
{
"type": "CompoundType",
"label": "newTitle",
"isRequired": true,
"signature": [
"string | string[]"
],
"description": [
"The new title to set, either a string or string array"
],
"source": {
"path": "src/core/public/chrome/doc_title/doc_title_service.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45"
}
}
],
"tags": [
"example"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/doc_title/doc_title_service.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45"
}
},
{
"id": "def-public.ChromeDocTitle.reset",
"type": "Function",
"label": "reset",
"signature": [
"() => void"
],
"description": [
"\nResets the document title to it's initial value.\n(meaning the one present in the title meta at application load.)"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/doc_title/doc_title_service.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L50"
}
}
],
"source": {
"path": "src/core/public/chrome/doc_title/doc_title_service.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L32"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeRecentlyAccessed",
"type": "Interface",
"label": "ChromeRecentlyAccessed",
"description": [
"\n{@link ChromeRecentlyAccessed | APIs} for recently accessed history."
],
"tags": [
"public"
],
"children": [
{
"id": "def-public.ChromeRecentlyAccessed.add",
"type": "Function",
"label": "add",
"signature": [
"(link: string, label: string, id: string) => void"
],
"description": [
"\nAdds a new item to the recently accessed history.\n"
],
"children": [
{
"type": "string",
"label": "link",
"isRequired": true,
"signature": [
"string"
],
"description": [
"a relative URL to the resource (not including the {@link HttpStart.basePath | `http.basePath`})"
],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"
}
},
{
"type": "string",
"label": "label",
"isRequired": true,
"signature": [
"string"
],
"description": [
"the label to display in the UI"
],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"a unique string used to de-duplicate the recently accessed list."
],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"
}
}
],
"tags": [
"example"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"
}
},
{
"id": "def-public.ChromeRecentlyAccessed.get",
"type": "Function",
"label": "get",
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeRecentlyAccessedHistoryItem",
"text": "ChromeRecentlyAccessedHistoryItem"
},
"[]"
],
"description": [
"\nGets an Array of the current recently accessed history.\n"
],
"children": [],
"tags": [
"example"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L81"
}
},
{
"id": "def-public.ChromeRecentlyAccessed.get$",
"type": "Function",
"label": "get$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeRecentlyAccessedHistoryItem",
"text": "ChromeRecentlyAccessedHistoryItem"
},
"[]>"
],
"description": [
"\nGets an Observable of the array of recently accessed history.\n"
],
"children": [],
"tags": [
"example"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 91,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L91"
}
}
],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L58"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeRecentlyAccessedHistoryItem",
"type": "Interface",
"label": "ChromeRecentlyAccessedHistoryItem",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeRecentlyAccessedHistoryItem.link",
"type": "string",
"label": "link",
"description": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L17"
}
},
{
"tags": [],
"id": "def-public.ChromeRecentlyAccessedHistoryItem.label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L18"
}
},
{
"tags": [],
"id": "def-public.ChromeRecentlyAccessedHistoryItem.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L19"
}
}
],
"source": {
"path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeUserBanner",
"type": "Interface",
"label": "ChromeUserBanner",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeUserBanner.content",
"type": "Function",
"label": "content",
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L41"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.MountPoint",
"text": "MountPoint"
},
"<HTMLDivElement>"
]
}
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L40"
},
"initialIsOpen": false
},
{
"id": "def-public.ChromeStart",
"type": "Interface",
"label": "ChromeStart",
"description": [
"\nChromeStart allows plugins to customize the global chrome header UI and\nenrich the UX with additional information about the current location of the\nbrowser.\n"
],
"tags": [
"remarks",
"example",
"example",
"public"
],
"children": [
{
"tags": [],
"id": "def-public.ChromeStart.navLinks",
"type": "Object",
"label": "navLinks",
"description": [
"{@inheritdoc ChromeNavLinks}"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L88"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLinks",
"text": "ChromeNavLinks"
}
]
},
{
"tags": [],
"id": "def-public.ChromeStart.navControls",
"type": "Object",
"label": "navControls",
"description": [
"{@inheritdoc ChromeNavControls}"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L90"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavControls",
"text": "ChromeNavControls"
}
]
},
{
"tags": [],
"id": "def-public.ChromeStart.recentlyAccessed",
"type": "Object",
"label": "recentlyAccessed",
"description": [
"{@inheritdoc ChromeRecentlyAccessed}"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L92"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeRecentlyAccessed",
"text": "ChromeRecentlyAccessed"
}
]
},
{
"tags": [],
"id": "def-public.ChromeStart.docTitle",
"type": "Object",
"label": "docTitle",
"description": [
"{@inheritdoc ChromeDocTitle}"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 94,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L94"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeDocTitle",
"text": "ChromeDocTitle"
}
]
},
{
"id": "def-public.ChromeStart.setAppTitle",
"type": "Function",
"label": "setAppTitle",
"signature": [
"(appTitle: string) => void"
],
"description": [
"\nSets the current app's title\n"
],
"children": [
{
"type": "string",
"label": "appTitle",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 103,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103"
}
}
],
"tags": [
"internalRemarks"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 103,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103"
}
},
{
"id": "def-public.ChromeStart.getBrand$",
"type": "Function",
"label": "getBrand$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
},
">"
],
"description": [
"\nGet an observable of the current brand information."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 108,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L108"
}
},
{
"id": "def-public.ChromeStart.setBrand",
"type": "Function",
"label": "setBrand",
"signature": [
"(brand: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
},
") => void"
],
"description": [
"\nSet the brand configuration.\n"
],
"children": [
{
"type": "Object",
"label": "brand",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBrand",
"text": "ChromeBrand"
}
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128"
}
}
],
"tags": [
"remarks",
"example"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128"
}
},
{
"id": "def-public.ChromeStart.getIsVisible$",
"type": "Function",
"label": "getIsVisible$",
"signature": [
"() => ",
"Observable",
"<boolean>"
],
"description": [
"\nGet an observable of the current visibility state of the chrome."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 133,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L133"
}
},
{
"id": "def-public.ChromeStart.setIsVisible",
"type": "Function",
"label": "setIsVisible",
"signature": [
"(isVisible: boolean) => void"
],
"description": [
"\nSet the temporary visibility for the chrome. This does nothing if the chrome is hidden\nby default and should be used to hide the chrome for things like full-screen modes\nwith an exit button."
],
"children": [
{
"type": "boolean",
"label": "isVisible",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 140,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 140,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140"
}
},
{
"id": "def-public.ChromeStart.getApplicationClasses$",
"type": "Function",
"label": "getApplicationClasses$",
"signature": [
"() => ",
"Observable",
"<string[]>"
],
"description": [
"\nGet the current set of classNames that will be set on the application container."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 145,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L145"
}
},
{
"id": "def-public.ChromeStart.addApplicationClass",
"type": "Function",
"label": "addApplicationClass",
"signature": [
"(className: string) => void"
],
"description": [
"\nAdd a className that should be set on the application container."
],
"children": [
{
"type": "string",
"label": "className",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 150,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 150,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150"
}
},
{
"id": "def-public.ChromeStart.removeApplicationClass",
"type": "Function",
"label": "removeApplicationClass",
"signature": [
"(className: string) => void"
],
"description": [
"\nRemove a className added with `addApplicationClass()`. If className is unknown it is ignored."
],
"children": [
{
"type": "string",
"label": "className",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155"
}
},
{
"id": "def-public.ChromeStart.getBadge$",
"type": "Function",
"label": "getBadge$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBadge",
"text": "ChromeBadge"
},
" | undefined>"
],
"description": [
"\nGet an observable of the current badge"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 160,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L160"
}
},
{
"id": "def-public.ChromeStart.setBadge",
"type": "Function",
"label": "setBadge",
"signature": [
"(badge?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBadge",
"text": "ChromeBadge"
},
" | undefined) => void"
],
"description": [
"\nOverride the current badge"
],
"children": [
{
"type": "Object",
"label": "badge",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBadge",
"text": "ChromeBadge"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 165,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 165,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165"
}
},
{
"id": "def-public.ChromeStart.getBreadcrumbs$",
"type": "Function",
"label": "getBreadcrumbs$",
"signature": [
"() => ",
"Observable",
"<",
"EuiBreadcrumb",
"[]>"
],
"description": [
"\nGet an observable of the current list of breadcrumbs"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 170,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L170"
}
},
{
"id": "def-public.ChromeStart.setBreadcrumbs",
"type": "Function",
"label": "setBreadcrumbs",
"signature": [
"(newBreadcrumbs: ",
"EuiBreadcrumb",
"[]) => void"
],
"description": [
"\nOverride the current set of breadcrumbs"
],
"children": [
{
"type": "Array",
"label": "newBreadcrumbs",
"isRequired": true,
"signature": [
"EuiBreadcrumb",
"[]"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 175,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 175,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175"
}
},
{
"id": "def-public.ChromeStart.getBreadcrumbsAppendExtension$",
"type": "Function",
"label": "getBreadcrumbsAppendExtension$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBreadcrumbsAppendExtension",
"text": "ChromeBreadcrumbsAppendExtension"
},
" | undefined>"
],
"description": [
"\nGet an observable of the current extension appended to breadcrumbs"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 180,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L180"
}
},
{
"id": "def-public.ChromeStart.setBreadcrumbsAppendExtension",
"type": "Function",
"label": "setBreadcrumbsAppendExtension",
"signature": [
"(breadcrumbsAppendExtension?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBreadcrumbsAppendExtension",
"text": "ChromeBreadcrumbsAppendExtension"
},
" | undefined) => void"
],
"description": [
"\nMount an element next to the last breadcrumb"
],
"children": [
{
"type": "Object",
"label": "breadcrumbsAppendExtension",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeBreadcrumbsAppendExtension",
"text": "ChromeBreadcrumbsAppendExtension"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 186,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L186"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 185,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L185"
}
},
{
"id": "def-public.ChromeStart.getCustomNavLink$",
"type": "Function",
"label": "getCustomNavLink$",
"signature": [
"() => ",
"Observable",
"<Partial<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
"> | undefined>"
],
"description": [
"\nGet an observable of the current custom nav link"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 192,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L192"
}
},
{
"id": "def-public.ChromeStart.setCustomNavLink",
"type": "Function",
"label": "setCustomNavLink",
"signature": [
"(newCustomNavLink?: Partial<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
"> | undefined) => void"
],
"description": [
"\nOverride the current set of custom nav link"
],
"children": [
{
"type": "Object",
"label": "newCustomNavLink",
"isRequired": false,
"signature": [
"Partial<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeNavLink",
"text": "ChromeNavLink"
},
"> | undefined"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 197,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 197,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197"
}
},
{
"id": "def-public.ChromeStart.getHelpExtension$",
"type": "Function",
"label": "getHelpExtension$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtension",
"text": "ChromeHelpExtension"
},
" | undefined>"
],
"description": [
"\nGet an observable of the current custom help conttent"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 202,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L202"
}
},
{
"id": "def-public.ChromeStart.setHelpExtension",
"type": "Function",
"label": "setHelpExtension",
"signature": [
"(helpExtension?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtension",
"text": "ChromeHelpExtension"
},
" | undefined) => void"
],
"description": [
"\nOverride the current set of custom help content"
],
"children": [
{
"type": "Object",
"label": "helpExtension",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtension",
"text": "ChromeHelpExtension"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 207,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 207,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207"
}
},
{
"id": "def-public.ChromeStart.setHelpSupportUrl",
"type": "Function",
"label": "setHelpSupportUrl",
"signature": [
"(url: string) => void"
],
"description": [
"\nOverride the default support URL shown in the help menu"
],
"children": [
{
"type": "string",
"label": "url",
"isRequired": true,
"signature": [
"string"
],
"description": [
"The updated support URL"
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 213,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 213,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213"
}
},
{
"id": "def-public.ChromeStart.getIsNavDrawerLocked$",
"type": "Function",
"label": "getIsNavDrawerLocked$",
"signature": [
"() => ",
"Observable",
"<boolean>"
],
"description": [
"\nGet an observable of the current locked state of the nav drawer."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 218,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L218"
}
},
{
"id": "def-public.ChromeStart.setHeaderBanner",
"type": "Function",
"label": "setHeaderBanner",
"signature": [
"(headerBanner?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeUserBanner",
"text": "ChromeUserBanner"
},
" | undefined) => void"
],
"description": [
"\nSet the banner that will appear on top of the chrome header.\n"
],
"children": [
{
"type": "Object",
"label": "headerBanner",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeUserBanner",
"text": "ChromeUserBanner"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 225,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225"
}
}
],
"tags": [
"remarks"
],
"returnComment": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 225,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225"
}
}
],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L86"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.ChromeBreadcrumb",
"type": "Type",
"label": "ChromeBreadcrumb",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/public/chrome/types.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L32"
},
"signature": [
"CommonProps",
" & { text: ",
"ReactNode",
"; href?: string | undefined; onClick?: ((event: ",
"MouseEvent",
"<HTMLAnchorElement, MouseEvent>) => void) | undefined; truncate?: boolean | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionMenuLink",
"type": "Type",
"label": "ChromeHelpExtensionMenuLink",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 98,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L98"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuGitHubLink",
"text": "ChromeHelpExtensionMenuGitHubLink"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuDiscussLink",
"text": "ChromeHelpExtensionMenuDiscussLink"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuDocumentationLink",
"text": "ChromeHelpExtensionMenuDocumentationLink"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreChromePluginApi",
"section": "def-public.ChromeHelpExtensionMenuCustomLink",
"text": "ChromeHelpExtensionMenuCustomLink"
}
],
"initialIsOpen": false
},
{
"id": "def-public.ChromeHelpExtensionLinkBase",
"type": "Type",
"label": "ChromeHelpExtensionLinkBase",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L34"
},
"signature": [
"{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.ChromeNavLinkUpdateableFields",
"type": "Type",
"label": "ChromeNavLinkUpdateableFields",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/public/chrome/nav_links/nav_link.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L85"
},
"signature": [
"{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.NavType",
"type": "Type",
"label": "NavType",
"tags": [],
"description": [],
"source": {
"path": "src/core/public/chrome/ui/header/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/types.ts#L10"
},
"signature": [
"\"legacy\" | \"modern\""
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue Copy permalink