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
474 lines
No EOL
15 KiB
JSON
474 lines
No EOL
15 KiB
JSON
{
|
|
"id": "indexPatternFieldEditor",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.DefaultFormatEditor",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DefaultFormatEditor",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
"<P, S> extends React.PureComponent<",
|
|
"FormatEditorProps",
|
|
"<P>, ",
|
|
"FormatEditorState",
|
|
" & S, any>"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefaultFormatEditor.formatId",
|
|
"type": "string",
|
|
"label": "formatId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 75
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefaultFormatEditor.state",
|
|
"type": "CompoundType",
|
|
"label": "state",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 76
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorState",
|
|
"text": "FormatEditorState"
|
|
},
|
|
" & S"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps",
|
|
"type": "Function",
|
|
"label": "getDerivedStateFromProps",
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
".getDerivedStateFromProps"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "nextProps",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorProps",
|
|
"text": "FormatEditorProps"
|
|
},
|
|
"<{}>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "state",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorState",
|
|
"text": "FormatEditorState"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.onChange",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "newParams",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 90
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(newParams?: {}) => void"
|
|
],
|
|
"description": [],
|
|
"label": "onChange",
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 90
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.render",
|
|
"type": "Function",
|
|
"label": "render",
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 99
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 71
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.FieldEditorContext",
|
|
"type": "Interface",
|
|
"label": "FieldEditorContext",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.indexPattern",
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.fieldTypeToProcess",
|
|
"type": "CompoundType",
|
|
"label": "fieldTypeToProcess",
|
|
"description": [
|
|
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 33
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.InternalFieldType",
|
|
"text": "InternalFieldType"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.search",
|
|
"type": "Object",
|
|
"label": "search",
|
|
"description": [
|
|
"The search service from the data plugin"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 35
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.ISearchStart",
|
|
"text": "ISearchStart"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 27
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.OpenFieldEditorOptions",
|
|
"type": "Interface",
|
|
"label": "OpenFieldEditorOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.ctx",
|
|
"type": "Object",
|
|
"label": "ctx",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"{ indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.onSave",
|
|
"type": "Function",
|
|
"label": "onSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 31
|
|
},
|
|
"signature": [
|
|
"((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
") => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.fieldName",
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 32
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 27
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-public.PluginStart",
|
|
"type": "Interface",
|
|
"label": "PluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.PluginStart.openEditor",
|
|
"type": "Function",
|
|
"label": "openEditor",
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.OpenFieldEditorOptions",
|
|
"text": "OpenFieldEditorOptions"
|
|
},
|
|
") => () => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.OpenFieldEditorOptions",
|
|
"text": "OpenFieldEditorOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 26
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.fieldFormatEditors",
|
|
"type": "Object",
|
|
"label": "fieldFormatEditors",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"{ getAll: () => typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
"[]; getById: (id: string) => typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
" | undefined; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.userPermissions",
|
|
"type": "Object",
|
|
"label": "userPermissions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"{ editIndexPattern: () => boolean; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider",
|
|
"type": "Function",
|
|
"label": "DeleteRuntimeFieldProvider",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"signature": [
|
|
"React.FunctionComponent<",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
},
|
|
">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |