kibana/api_docs/navigation.json

589 lines
19 KiB
JSON

{
"id": "navigation",
"client": {
"classes": [
{
"id": "def-public.NavigationPublicPlugin",
"type": "Class",
"tags": [],
"label": "NavigationPublicPlugin",
"description": [],
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPlugin",
"text": "NavigationPublicPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPluginSetup",
"text": "NavigationPublicPluginSetup"
},
", ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPluginStart",
"text": "NavigationPublicPluginStart"
},
", object, object>"
],
"children": [
{
"id": "def-public.NavigationPublicPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 21
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 21
}
},
{
"id": "def-public.NavigationPublicPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPluginSetup",
"text": "NavigationPublicPluginSetup"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 23
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 23
}
},
{
"id": "def-public.NavigationPublicPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"({ i18n }: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
", { data }: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPluginStartDependencies",
"text": "NavigationPluginStartDependencies"
},
") => ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPluginStart",
"text": "NavigationPublicPluginStart"
}
],
"description": [],
"children": [
{
"type": "Object",
"label": "{ i18n }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 32
}
},
{
"type": "Object",
"label": "{ data }",
"isRequired": true,
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPluginStartDependencies",
"text": "NavigationPluginStartDependencies"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 31
}
},
{
"id": "def-public.NavigationPublicPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 44
}
}
],
"source": {
"path": "src/plugins/navigation/public/plugin.ts",
"lineNumber": 17
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.TopNavMenu",
"type": "Function",
"label": "TopNavMenu",
"signature": [
"(props: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "props",
"isRequired": true,
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
}
],
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 64
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 64
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.TopNavMenuData",
"type": "Interface",
"label": "TopNavMenuData",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.TopNavMenuData.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.label",
"type": "string",
"label": "label",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-public.TopNavMenuData.run",
"type": "Function",
"label": "run",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 16
},
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuAction",
"text": "TopNavMenuAction"
}
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.testId",
"type": "string",
"label": "testId",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.className",
"type": "string",
"label": "className",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.disableButton",
"type": "CompoundType",
"label": "disableButton",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 20
},
"signature": [
"boolean | (() => boolean) | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.tooltip",
"type": "CompoundType",
"label": "tooltip",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 21
},
"signature": [
"string | (() => string | undefined) | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.emphasize",
"type": "CompoundType",
"label": "emphasize",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.isLoading",
"type": "CompoundType",
"label": "isLoading",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 23
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.iconType",
"type": "string",
"label": "iconType",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 24
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.TopNavMenuData.iconSide",
"type": "CompoundType",
"label": "iconSide",
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 25
},
"signature": [
"\"left\" | \"right\" | undefined"
]
}
],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"lineNumber": 13
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.TopNavMenuProps",
"type": "Type",
"label": "TopNavMenuProps",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx",
"lineNumber": 23
},
"signature": [
"SearchBarOwnProps",
" & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Pick<SearchBarProps, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"storageKey\" | \"disableLanguageSwitcher\" | \"isInvalid\" | \"autoSubmit\" | \"onFiltersUpdated\" | \"onRefreshChange\"> & { config?: TopNavMenuData[] | undefined; badges?: (({ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; iconSide?: \"left\" | \"right\" | undefined; color?: string | undefined; isDisabled?: boolean | undefined; closeButtonProps?: Partial<",
"EuiIconProps",
"> | undefined; } & ",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithIconOnClick, {}> & ",
"DisambiguateSet"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.NavigationPublicPluginSetup",
"type": "Interface",
"label": "NavigationPublicPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.NavigationPublicPluginSetup.registerMenuItem",
"type": "Function",
"label": "registerMenuItem",
"description": [],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 13
},
"signature": [
"(menuItem: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.RegisteredTopNavMenuData",
"text": "RegisteredTopNavMenuData"
},
") => void"
]
}
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 12
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.NavigationPublicPluginStart",
"type": "Interface",
"label": "NavigationPublicPluginStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.NavigationPublicPluginStart.ui",
"type": "Object",
"label": "ui",
"description": [],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 17
},
"signature": [
"{ TopNavMenu: React.ComponentType<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
">; }"
]
}
],
"source": {
"path": "src/plugins/navigation/public/types.ts",
"lineNumber": 16
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}