98b7e99747
* Clean up api doc infra * updated docs * Update api dics
257 lines
No EOL
8.2 KiB
JSON
257 lines
No EOL
8.2 KiB
JSON
{
|
|
"id": "indexPatternEditor",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IndexPatternEditorProps",
|
|
"description": [],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps.onSave",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSave",
|
|
"description": [
|
|
"\nHandler for the \"save\" footer button"
|
|
],
|
|
"signature": [
|
|
"(indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps.onSave.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [
|
|
"- newly created index pattern"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps.onCancel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onCancel",
|
|
"description": [
|
|
"\nHandler for the \"cancel\" footer button"
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps.defaultTypeIsRollup",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "defaultTypeIsRollup",
|
|
"description": [
|
|
"\nSets the default index pattern type to rollup. Defaults to false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.IndexPatternEditorProps.requireTimestampField",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requireTimestampField",
|
|
"description": [
|
|
"\nSets whether a timestamp field is required to create an index pattern. Defaults to false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.openEditor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openEditor",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "indexPatternEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternEditorPluginApi",
|
|
"section": "def-public.IndexPatternEditorProps",
|
|
"text": "IndexPatternEditorProps"
|
|
},
|
|
") => () => void"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.openEditor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternEditorPluginApi",
|
|
"section": "def-public.IndexPatternEditorProps",
|
|
"text": "IndexPatternEditorProps"
|
|
}
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.IndexPatternEditorComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "IndexPatternEditorComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"React.FunctionComponent<",
|
|
{
|
|
"pluginId": "indexPatternEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternEditorPluginApi",
|
|
"section": "def-public.IndexPatternEditorProps",
|
|
"text": "IndexPatternEditorProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.IndexPatternEditorComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P & { children?: React.ReactNode; }"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.IndexPatternEditorComponent.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "indexPatternEditor",
|
|
"id": "def-public.PluginStart.userPermissions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "userPermissions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ editIndexPattern: () => boolean; }"
|
|
],
|
|
"path": "src/plugins/index_pattern_editor/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |