* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
266 lines
9.5 KiB
JSON
266 lines
9.5 KiB
JSON
{
|
|
"id": "presentationUtil",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.SavedObjectSaveModalDashboard",
|
|
"type": "Function",
|
|
"label": "SavedObjectSaveModalDashboard",
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.SaveModalDashboardProps",
|
|
"text": "SaveModalDashboardProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "props",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.SaveModalDashboardProps",
|
|
"text": "SaveModalDashboardProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L37"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L37"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.DashboardPicker",
|
|
"type": "Function",
|
|
"label": "DashboardPicker",
|
|
"signature": [
|
|
"(props: ",
|
|
"DashboardPickerProps",
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "props",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.DashboardPickerProps",
|
|
"text": "DashboardPickerProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/dashboard_picker.tsx",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/dashboard_picker.tsx#L27"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/dashboard_picker.tsx",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/dashboard_picker.tsx#L27"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.SaveModalDashboardProps",
|
|
"type": "Interface",
|
|
"label": "SaveModalDashboardProps",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalDashboardProps.documentInfo",
|
|
"type": "Object",
|
|
"label": "documentInfo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L30"
|
|
},
|
|
"signature": [
|
|
"SaveModalDocumentInfo"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalDashboardProps.objectType",
|
|
"type": "string",
|
|
"label": "objectType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L31"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalDashboardProps.onClose",
|
|
"type": "Function",
|
|
"label": "onClose",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L32"
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalDashboardProps.onSave",
|
|
"type": "Function",
|
|
"label": "onSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L33"
|
|
},
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.OnSaveProps",
|
|
"text": "OnSaveProps"
|
|
},
|
|
" & { dashboardId: string | null; }) => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SaveModalDashboardProps.tagOptions",
|
|
"type": "CompoundType",
|
|
"label": "tagOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L34"
|
|
},
|
|
"signature": [
|
|
"string | number | boolean | {} | 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>)> | React.ReactNodeArray | React.ReactPortal | ((state: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SaveModalState",
|
|
"text": "SaveModalState"
|
|
},
|
|
") => React.ReactNode) | null | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#L29"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.PresentationUtilPluginSetup",
|
|
"type": "Interface",
|
|
"label": "PresentationUtilPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/types.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/types.ts#L10"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.PresentationUtilPluginStart",
|
|
"type": "Interface",
|
|
"label": "PresentationUtilPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PresentationUtilPluginStart.ContextProvider",
|
|
"type": "Function",
|
|
"label": "ContextProvider",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/types.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/types.ts#L13"
|
|
},
|
|
"signature": [
|
|
"React.FC<{}>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/presentation_util/public/types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/presentation_util/public/types.ts#L12"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |