{ "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 } }, { "tags": [], "id": "def-public.ChromeBadge.tooltip", "type": "string", "label": "tooltip", "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-public.ChromeBadge.iconType", "type": "CompoundType", "label": "iconType", "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 22 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" ] } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 19 }, "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 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.ChromeBrand.smallLogo", "type": "string", "label": "smallLogo", "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 28 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 26 }, "initialIsOpen": false }, { "id": "def-public.ChromeDocTitle", "type": "Interface", "label": "ChromeDocTitle", "description": [ "\nAPIs for accessing and updating the document title.\n" ], "tags": [ "public" ], "children": [ { "id": "def-public.ChromeDocTitle.change", "type": "Function", "label": "change", "signature": [ "(newTitle: string | string[]) => void" ], "description": [ "\nChanges the current document title.\n" ], "children": [ { "id": "def-public.ChromeDocTitle.change.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/doc_title/doc_title_service.ts", "lineNumber": 45 } }, { "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 } } ], "source": { "path": "src/core/public/chrome/doc_title/doc_title_service.ts", "lineNumber": 32 }, "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 } }, { "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 }, "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 }, "signature": [ "((element: HTMLDivElement) => () => void) | undefined" ] } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 45 }, "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" ], "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 }, "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 } }, { "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 }, "signature": [ "React.ReactNode" ] } ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 82 }, "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" ], "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 }, "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 } } ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 56 }, "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" ], "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 }, "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 } } ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 69 }, "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" ], "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 }, "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 }, "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 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 40 }, "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 }, "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 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.MountPoint", "text": "MountPoint" }, "" ] } ], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 15 }, "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": [ "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": [ { "id": "def-public.ChromeNavControls.registerLeft.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 38 } }, { "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": [ { "id": "def-public.ChromeNavControls.registerRight.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 40 } }, { "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": [ { "id": "def-public.ChromeNavControls.registerCenter.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 42 } } ], "source": { "path": "src/core/public/chrome/nav_controls/nav_controls_service.ts", "lineNumber": 36 }, "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 } }, { "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 } }, { "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 }, "signature": [ "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 } }, { "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 }, "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 }, "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 }, "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 }, "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 }, "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 } }, { "tags": [], "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 }, "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 }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 15 }, "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", "[]>" ], "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 } }, { "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": [ { "id": "def-public.ChromeNavLinks.get.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 38 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 38 } }, { "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 } }, { "id": "def-public.ChromeNavLinks.has", "type": "Function", "label": "has", "signature": [ "(id: string) => boolean" ], "description": [ "\nCheck whether or not a navlink exists." ], "children": [ { "id": "def-public.ChromeNavLinks.has.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 49 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 49 } }, { "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": [ { "id": "def-public.ChromeNavLinks.showOnly.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 59 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 59 } }, { "id": "def-public.ChromeNavLinks.update", "type": "Function", "label": "update", "signature": [ "(id: string, values: Partial>) => ", { "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": [ { "id": "def-public.ChromeNavLinks.update.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 71 } }, { "id": "def-public.ChromeNavLinks.update.$2", "type": "Object", "label": "values", "isRequired": true, "signature": [ "Partial>" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 71 } } ], "tags": [ "deprecated" ], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 71 } }, { "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": [], "returnComment": [], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 85 } }, { "id": "def-public.ChromeNavLinks.getForceAppSwitcherNavigation$", "type": "Function", "label": "getForceAppSwitcherNavigation$", "signature": [ "() => ", "Observable", "" ], "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 } } ], "source": { "path": "src/core/public/chrome/nav_links/nav_links_service.ts", "lineNumber": 28 }, "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": [ { "id": "def-public.ChromeRecentlyAccessed.add.$1", "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 } }, { "id": "def-public.ChromeRecentlyAccessed.add.$2", "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 } }, { "id": "def-public.ChromeRecentlyAccessed.add.$3", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 71 } }, { "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": [], "returnComment": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 81 } }, { "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": [], "returnComment": [], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 91 } } ], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 58 }, "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 } }, { "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 } }, { "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 } } ], "source": { "path": "src/core/public/chrome/recently_accessed/recently_accessed_service.ts", "lineNumber": 16 }, "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": [ "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 }, "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 }, "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 }, "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 }, "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": [ { "id": "def-public.ChromeStart.setAppTitle.$1", "type": "string", "label": "appTitle", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 103 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 103 } }, { "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 } }, { "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": [ { "id": "def-public.ChromeStart.setBrand.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 128 } }, { "id": "def-public.ChromeStart.getIsVisible$", "type": "Function", "label": "getIsVisible$", "signature": [ "() => ", "Observable", "" ], "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 } }, { "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": [ { "id": "def-public.ChromeStart.setIsVisible.$1", "type": "boolean", "label": "isVisible", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 140 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 140 } }, { "id": "def-public.ChromeStart.getApplicationClasses$", "type": "Function", "label": "getApplicationClasses$", "signature": [ "() => ", "Observable", "" ], "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 } }, { "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": [ { "id": "def-public.ChromeStart.addApplicationClass.$1", "type": "string", "label": "className", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 150 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 150 } }, { "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": [ { "id": "def-public.ChromeStart.removeApplicationClass.$1", "type": "string", "label": "className", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 155 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 155 } }, { "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 } }, { "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": [ { "id": "def-public.ChromeStart.setBadge.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 165 } }, { "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 } }, { "id": "def-public.ChromeStart.setBreadcrumbs", "type": "Function", "label": "setBreadcrumbs", "signature": [ "(newBreadcrumbs: ", "EuiBreadcrumb", "[]) => void" ], "description": [ "\nOverride the current set of breadcrumbs" ], "children": [ { "id": "def-public.ChromeStart.setBreadcrumbs.$1", "type": "Array", "label": "newBreadcrumbs", "isRequired": true, "signature": [ "EuiBreadcrumb", "[]" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 175 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 175 } }, { "id": "def-public.ChromeStart.getBreadcrumbsAppendExtension$", "type": "Function", "label": "getBreadcrumbsAppendExtension$", "signature": [ "() => ", "Observable", "<", "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 } }, { "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension", "type": "Function", "label": "setBreadcrumbsAppendExtension", "signature": [ "(breadcrumbsAppendExtension?: ", "ChromeBreadcrumbsAppendExtension", " | undefined) => void" ], "description": [ "\nMount an element next to the last breadcrumb" ], "children": [ { "id": "def-public.ChromeStart.setBreadcrumbsAppendExtension.$1", "type": "Object", "label": "breadcrumbsAppendExtension", "isRequired": false, "signature": [ "ChromeBreadcrumbsAppendExtension", " | undefined" ], "description": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 186 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 185 } }, { "id": "def-public.ChromeStart.getCustomNavLink$", "type": "Function", "label": "getCustomNavLink$", "signature": [ "() => ", "Observable", " | undefined>" ], "description": [ "\nGet an observable of the current custom nav link" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 192 } }, { "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": [ { "id": "def-public.ChromeStart.setCustomNavLink.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 197 } }, { "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 } }, { "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": [ { "id": "def-public.ChromeStart.setHelpExtension.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 207 } }, { "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": [ { "id": "def-public.ChromeStart.setHelpSupportUrl.$1", "type": "string", "label": "url", "isRequired": true, "signature": [ "string" ], "description": [ "The updated support URL" ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 213 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 213 } }, { "id": "def-public.ChromeStart.getIsNavDrawerLocked$", "type": "Function", "label": "getIsNavDrawerLocked$", "signature": [ "() => ", "Observable", "" ], "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 } }, { "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": [ { "id": "def-public.ChromeStart.setHeaderBanner.$1", "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 } } ], "tags": [], "returnComment": [], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 225 } } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 86 }, "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 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.MountPoint", "text": "MountPoint" }, "" ] } ], "source": { "path": "src/core/public/chrome/types.ts", "lineNumber": 40 }, "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 }, "signature": [ "CommonProps", " & { text: ", "ReactNode", "; href?: string | undefined; onClick?: ((event: ", "MouseEvent", ") => void) | undefined; truncate?: boolean | undefined; }" ], "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 }, "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.ChromeHelpExtensionMenuLink", "type": "Type", "label": "ChromeHelpExtensionMenuLink", "tags": [ "public" ], "description": [], "source": { "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "lineNumber": 98 }, "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.ChromeNavLinkUpdateableFields", "type": "Type", "label": "ChromeNavLinkUpdateableFields", "tags": [ "public" ], "description": [], "source": { "path": "src/core/public/chrome/nav_links/nav_link.ts", "lineNumber": 85 }, "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 }, "signature": [ "\"legacy\" | \"modern\"" ], "initialIsOpen": false } ], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }