6b8ebbfa18
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs # Conflicts: # api_docs/actions.json # api_docs/advanced_settings.json # api_docs/alerting.json # api_docs/apm.json # api_docs/apm_oss.json # api_docs/banners.json # api_docs/beats_management.json # api_docs/bfetch.json # api_docs/canvas.json # api_docs/case.json # api_docs/charts.json # api_docs/cloud.json # api_docs/console.json # api_docs/core.json # api_docs/core_application.json # api_docs/core_chrome.json # api_docs/core_http.json # api_docs/core_saved_objects.json # api_docs/dashboard.json # api_docs/dashboard_enhanced.json # api_docs/dashboard_mode.json # api_docs/data.json # api_docs/data_autocomplete.json # api_docs/data_enhanced.json # api_docs/data_field_formats.json # api_docs/data_index_patterns.json # api_docs/data_query.json # api_docs/data_search.json # api_docs/data_ui.json # api_docs/dev_tools.json # api_docs/discover.json # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/embeddable_enhanced.json # api_docs/encrypted_saved_objects.json # api_docs/enterprise_search.json # api_docs/es_ui_shared.json # api_docs/event_log.json # api_docs/expressions.json # api_docs/features.json # api_docs/file_upload.json # api_docs/fleet.json # api_docs/global_search.json # api_docs/home.json # api_docs/index_lifecycle_management.json # api_docs/index_management.json # api_docs/index_pattern_field_editor.json # api_docs/index_pattern_management.json # api_docs/infra.json # api_docs/ingest_pipelines.json # api_docs/inspector.json # api_docs/kibana_legacy.json # api_docs/kibana_react.json # api_docs/kibana_utils.json # api_docs/lens.json # api_docs/license_management.json # api_docs/licensing.json # api_docs/lists.json # api_docs/management.json # api_docs/maps.json # api_docs/maps_legacy.json # api_docs/ml.json # api_docs/monitoring.json # api_docs/navigation.json # api_docs/newsfeed.json # api_docs/observability.json # api_docs/osquery.json # api_docs/presentation_util.json # api_docs/remote_clusters.json # api_docs/reporting.json # api_docs/rollup.json # api_docs/runtime_fields.json # api_docs/saved_objects.json # api_docs/saved_objects_management.json # api_docs/saved_objects_tagging.json # api_docs/saved_objects_tagging_oss.json # api_docs/security.json # api_docs/security_oss.json # api_docs/security_solution.json # api_docs/share.json # api_docs/snapshot_restore.json # api_docs/spaces.json # api_docs/spaces_oss.json # api_docs/stack_alerts.json # api_docs/task_manager.json # api_docs/telemetry.json # api_docs/telemetry_collection_manager.json # api_docs/telemetry_collection_xpack.json # api_docs/telemetry_management_section.json # api_docs/triggers_actions_ui.json # api_docs/ui_actions.json # api_docs/ui_actions_enhanced.json # api_docs/uptime.json # api_docs/url_forwarding.json # api_docs/usage_collection.json # api_docs/vis_type_timeseries.json # api_docs/visualizations.json
589 lines
No EOL
19 KiB
JSON
589 lines
No EOL
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\" | \"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": []
|
|
}
|
|
} |