github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/reporting.devdocs.json
Kibana Machine e82e0a150f
[api-docs] Daily api_docs build (#144203)
2022-10-29 00:46:56 -04:00

702 lines
No EOL
23 KiB
JSON
Raw Blame History

{
"id": "reporting",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps",
"type": "Interface",
"tags": [],
"label": "ApplicationProps",
"description": [
"\nProperties for displaying a share menu with Reporting features."
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps.getJobParams",
"type": "Function",
"tags": [],
"label": "getJobParams",
"description": [
"\nA function that Reporting calls to get the sharing data from the application."
],
"signature": [
"(forShareUrl?: boolean | undefined) => Omit<{ layout?: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }, \"version\" | \"browserTimezone\">"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps.getJobParams.$1",
"type": "CompoundType",
"tags": [],
"label": "forShareUrl",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/reporting/public/share_context_menu/reporting_panel_content/reporting_panel_content.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps.layoutOption",
"type": "CompoundType",
"tags": [],
"label": "layoutOption",
"description": [
"\nOption to control how the screenshot(s) is/are placed in the PDF"
],
"signature": [
"\"canvas\" | \"print\" | undefined"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps.objectId",
"type": "string",
"tags": [],
"label": "objectId",
"description": [
"\nSaved object ID"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-public.ApplicationProps.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [
"\nA function to callback when the Reporting panel should be closed"
],
"signature": [
"() => void"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents",
"type": "Interface",
"tags": [],
"label": "ReportingPublicComponents",
"description": [
"\nReact components used to display share menus with Reporting features in an application."
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPDF",
"type": "Function",
"tags": [
"deprecated"
],
"label": "ReportingPanelPDF",
"description": [
"\nAn element to display a form to export the page as PDF"
],
"signature": [
"(props: ",
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
},
") => JSX.Element"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [],
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPDF.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
}
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPDFV2",
"type": "Function",
"tags": [],
"label": "ReportingPanelPDFV2",
"description": [
"\nAn element to display a form to export the page as PDF"
],
"signature": [
"(props: ",
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
},
") => JSX.Element"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPDFV2.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
}
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPNGV2",
"type": "Function",
"tags": [],
"label": "ReportingPanelPNGV2",
"description": [
"\nAn element to display a form to export the page as PNG"
],
"signature": [
"(props: ",
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
},
") => JSX.Element"
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.ReportingPublicComponents.ReportingPanelPNGV2.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ApplicationProps",
"text": "ApplicationProps"
}
],
"path": "x-pack/plugins/reporting/public/shared/get_shared_components.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "reporting",
"id": "def-public.ReportingStart",
"type": "Type",
"tags": [],
"label": "ReportingStart",
"description": [
"\nStart contract for the Reporting plugin."
],
"signature": [
{
"pluginId": "reporting",
"scope": "public",
"docId": "kibReportingPluginApi",
"section": "def-public.ReportingSetup",
"text": "ReportingSetup"
}
],
"path": "x-pack/plugins/reporting/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "reporting",
"id": "def-server.ReportingStart",
"type": "Type",
"tags": [],
"label": "ReportingStart",
"description": [
"\nPlugin Start Contract"
],
"signature": [
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
}
],
"path": "x-pack/plugins/reporting/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "reporting",
"id": "def-common.BasePayload",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "BasePayload",
"description": [],
"signature": [
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.BasePayload",
"text": "BasePayload"
},
" extends { layout?: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.BasePayload.headers",
"type": "string",
"tags": [],
"label": "headers",
"description": [],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BasePayload.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BasePayload.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BasePayloadV2",
"type": "Interface",
"tags": [],
"label": "BasePayloadV2",
"description": [
"\nReport job parameters, after they are processed in the request handler."
],
"signature": [
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.BasePayloadV2",
"text": "BasePayloadV2"
},
" extends ",
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.BaseParamsV2",
"text": "BaseParamsV2"
}
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.BasePayloadV2.headers",
"type": "string",
"tags": [],
"label": "headers",
"description": [],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BasePayloadV2.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BasePayloadV2.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.LocatorParams",
"type": "Interface",
"tags": [],
"label": "LocatorParams",
"description": [],
"signature": [
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.LocatorParams",
"text": "LocatorParams"
},
"<P>"
],
"path": "x-pack/plugins/reporting/common/types/url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.LocatorParams.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/reporting/common/types/url.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.LocatorParams.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nKibana version used to create the params"
],
"path": "x-pack/plugins/reporting/common/types/url.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "reporting",
"id": "def-common.LocatorParams.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"\nData to recreate the user's state in the application"
],
"signature": [
"P"
],
"path": "x-pack/plugins/reporting/common/types/url.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "reporting",
"id": "def-common.BaseParams",
"type": "Type",
"tags": [
"deprecated"
],
"label": "BaseParams",
"description": [],
"signature": [
"{ layout?: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.BaseParamsV2",
"type": "Type",
"tags": [],
"label": "BaseParamsV2",
"description": [
"\nReport job parameters that an application must return from its\ngetSharingData function."
],
"signature": [
"{ layout?: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; } & { locatorParams: ",
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.LocatorParams",
"text": "LocatorParams"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">[]; }"
],
"path": "x-pack/plugins/reporting/common/types/base.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.JobAppParamsPDF",
"type": "Type",
"tags": [
"deprecated"
],
"label": "JobAppParamsPDF",
"description": [],
"signature": [
"{ title: string; layout: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }; objectType: string; relativeUrls: string[]; isDeprecated?: boolean | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.JobAppParamsPDFV2",
"type": "Type",
"tags": [],
"label": "JobAppParamsPDFV2",
"description": [],
"signature": [
"{ title: string; layout: { id?: ",
{
"pluginId": "screenshotting",
"scope": "common",
"docId": "kibScreenshottingPluginApi",
"section": "def-common.LayoutType",
"text": "LayoutType"
},
" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }; objectType: string; locatorParams: ",
{
"pluginId": "reporting",
"scope": "common",
"docId": "kibReportingPluginApi",
"section": "def-common.LocatorParams",
"text": "LocatorParams"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">[]; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf_v2.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink