98b7e99747
* Clean up api doc infra * updated docs * Update api dics
378 lines
No EOL
12 KiB
JSON
378 lines
No EOL
12 KiB
JSON
{
|
|
"id": "visualize",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EditorRenderProps",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.core",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
"Filter",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"Query",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.savedSearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedSearch",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.uiState",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.PersistedState",
|
|
"text": "PersistedState"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.EditorRenderProps.linked",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "linked",
|
|
"description": [
|
|
"\nFlag to determine if visualiztion is linked to the saved search"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.IEditorController",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IEditorController",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.IEditorController.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "visualize",
|
|
"scope": "public",
|
|
"docId": "kibVisualizePluginApi",
|
|
"section": "def-public.EditorRenderProps",
|
|
"text": "EditorRenderProps"
|
|
},
|
|
") => void | Promise<void>"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.IEditorController.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualize",
|
|
"scope": "public",
|
|
"docId": "kibVisualizePluginApi",
|
|
"section": "def-public.EditorRenderProps",
|
|
"text": "EditorRenderProps"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.IEditorController.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/visualize/public/application/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "VisualizeConstants",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.VISUALIZE_BASE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VISUALIZE_BASE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.LANDING_PAGE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LANDING_PAGE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.WIZARD_STEP_1_PAGE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WIZARD_STEP_1_PAGE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.WIZARD_STEP_2_PAGE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WIZARD_STEP_2_PAGE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.CREATE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.EDIT_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EDIT_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.EDIT_BY_VALUE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EDIT_BY_VALUE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizeConstants.APP_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "APP_ID",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/common/constants.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizePluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizePluginSetup",
|
|
"description": [],
|
|
"path": "src/plugins/visualize/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualize",
|
|
"id": "def-public.VisualizePluginSetup.visEditorsRegistry",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visEditorsRegistry",
|
|
"description": [],
|
|
"signature": [
|
|
"{ registerDefault: (editor: ",
|
|
"VisEditorConstructor",
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">) => void; register: <TVisParams>(name: string, editor: ",
|
|
"VisEditorConstructor",
|
|
"<TVisParams>) => void; get: (name: string) => ",
|
|
"VisEditorConstructor",
|
|
"<any> | undefined; }"
|
|
],
|
|
"path": "src/plugins/visualize/public/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |