github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2023-04-05 Daily api_docs build (#154406)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/298
This commit is contained in:
Kibana Machine 2023-04-05 00:49:53 -04:00 • committed by GitHub
parent caf4ef8156
commit 70fe1a8774
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
510 changed files with 2410 additions and 650 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

2
api_docs/advanced_settings.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

2
api_docs/aiops.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

2
api_docs/alerting.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';

2
api_docs/apm.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

2
api_docs/asset_manager.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
title: "assetManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the assetManager plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.devdocs.json';

2
api_docs/banners.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

2
api_docs/bfetch.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';

2
api_docs/canvas.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas"
image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

18
api_docs/cases.devdocs.json
View file

@ -874,7 +874,23 @@
"CaseSeverity",
" | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; rootSearchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<",
"Cases",
">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; }; }"
">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; bulkGet: <Field extends \"id\" | \"connector\" | \"tags\" | \"description\" | \"version\" | \"title\" | \"status\" | \"settings\" | \"owner\" | \"severity\" | \"assignees\" | \"duration\" | \"closed_at\" | \"closed_by\" | \"created_at\" | \"created_by\" | \"external_service\" | \"updated_at\" | \"updated_by\" | \"totalComment\" | \"totalAlerts\" | \"comments\" = \"id\" | \"connector\" | \"tags\" | \"description\" | \"version\" | \"title\" | \"status\" | \"settings\" | \"owner\" | \"severity\" | \"assignees\" | \"duration\" | \"closed_at\" | \"closed_by\" | \"created_at\" | \"created_by\" | \"external_service\" | \"updated_at\" | \"updated_by\" | \"totalComment\" | \"totalAlerts\" | \"comments\">(params: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesBulkGetRequestCertainFields",
"text": "CasesBulkGetRequestCertainFields"
},
"<Field>, signal?: AbortSignal | undefined) => Promise<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesBulkGetResponseCertainFields",
"text": "CasesBulkGetResponseCertainFields"
},
"<Field>>; }; }"
],
"path": "x-pack/plugins/cases/public/types.ts",
"deprecated": false,

2
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

51
api_docs/charts.devdocs.json
View file

@ -3370,6 +3370,57 @@
}
],
"misc": [
{
"parentPluginId": "charts",
"id": "def-common.AllowedSettingsOverrides",
"type": "Type",
"tags": [],
"label": "AllowedSettingsOverrides",
"description": [],
"signature": [
"{ settings?: { tooltip?: ",
"TooltipSettings",
" | undefined; debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; } | undefined; }"
],
"path": "src/plugins/charts/common/static/overrides/settings.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-common.COLOR_MAPPING_SETTING",

4
api_docs/charts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 270 | 16 | 255 | 9 |
| 271 | 16 | 256 | 10 |
## Client

2
api_docs/cloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_chat.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
---
import cloudChatObj from './cloud_chat.devdocs.json';

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_defend.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';

2
api_docs/cloud_experiments.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
---
import cloudExperimentsObj from './cloud_experiments.devdocs.json';

2
api_docs/cloud_security_posture.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

2
api_docs/console.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

294
api_docs/content_management.devdocs.json
View file

@ -59,7 +59,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object> = ",
"<string, object> = ",
{
"pluginId": "contentManagement",
"scope": "common",
@ -67,7 +67,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>, O = unknown>(_input: I) => { queryKey: readonly [string, \"search\", unknown]; queryFn: () => Promise<O>; }; }"
"<string, object>, O = unknown>(_input: I) => { queryKey: readonly [string, \"search\", unknown, object | undefined]; queryFn: () => Promise<O>; }; }"
],
"path": "src/plugins/content_management/public/content_client/content_client.tsx",
"deprecated": false,
@ -363,7 +363,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>, O = unknown>(input: I) => Promise<O>"
"<string, object>, O = unknown>(input: I) => Promise<O>"
],
"path": "src/plugins/content_management/public/content_client/content_client.tsx",
"deprecated": false,
@ -403,7 +403,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>, O = unknown>(input: I) => ",
"<string, object>, O = unknown>(input: I) => ",
"Observable",
"<",
"QueryObserverResult",
@ -684,7 +684,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object> = ",
"<string, object> = ",
{
"pluginId": "contentManagement",
"scope": "common",
@ -692,7 +692,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>, O = unknown>(input: I, queryOptions?: ",
"<string, object>, O = unknown>(input: I, queryOptions?: ",
{
"pluginId": "contentManagement",
"scope": "public",
@ -1005,7 +1005,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>) => Promise<unknown>"
"<string, object>) => Promise<unknown>"
],
"path": "src/plugins/content_management/public/crud_client/crud_client.ts",
"deprecated": false,
@ -1026,7 +1026,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<string, object, object>"
"<string, object>"
],
"path": "src/plugins/content_management/public/crud_client/crud_client.ts",
"deprecated": false,
@ -1159,6 +1159,16 @@
"tags": [],
"label": "ContentStorage",
"description": [],
"signature": [
{
"pluginId": "contentManagement",
"scope": "server",
"docId": "kibContentManagementPluginApi",
"section": "def-server.ContentStorage",
"text": "ContentStorage"
},
"<T, U>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1181,7 +1191,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", id: string, options: unknown) => Promise<any>"
", id: string, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1226,17 +1236,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.get.$3",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -1259,7 +1269,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", ids: string[], options: unknown) => Promise<any>"
", ids: string[], options?: object | undefined) => Promise<{ hits: ({ item: T; } | { item: T; meta: any; })[]; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1304,17 +1314,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.bulkGet.$3",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -1337,7 +1347,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", data: object, options: unknown) => Promise<any>"
", data: object, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1382,17 +1392,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.create.$3",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -1415,7 +1425,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", id: string, data: object, options: unknown) => Promise<any>"
", id: string, data: object, options?: object | undefined) => Promise<{ item: U; } | { item: U; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1475,17 +1485,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.update.$4",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -1508,7 +1518,15 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", id: string, options: unknown) => Promise<any>"
", id: string, options?: object | undefined) => Promise<",
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.DeleteResult",
"text": "DeleteResult"
},
">"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1553,17 +1571,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.delete.$3",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -1586,7 +1604,15 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", query: object, options: unknown) => Promise<any>"
", query: ",
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.SearchQuery",
"text": "SearchQuery"
},
", options?: object | undefined) => Promise<{ hits: T[]; pagination: { total: number; cursor?: string | undefined; }; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1616,12 +1642,18 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.search.$2",
"type": "Uncategorized",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"object"
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.SearchQuery",
"text": "SearchQuery"
}
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1631,17 +1663,17 @@
{
"parentPluginId": "contentManagement",
"id": "def-server.ContentStorage.search.$3",
"type": "Unknown",
"type": "Uncategorized",
"tags": [],
"label": "options",
"description": [],
"signature": [
"unknown"
"object | undefined"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
"isRequired": false
}
],
"returnComment": []
@ -2022,6 +2054,31 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.DeleteResult",
"type": "Interface",
"tags": [],
"label": "DeleteResult",
"description": [],
"path": "src/plugins/content_management/common/rpc/delete.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "contentManagement",
"id": "def-common.DeleteResult.success",
"type": "boolean",
"tags": [],
"label": "success",
"description": [],
"path": "src/plugins/content_management/common/rpc/delete.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.GetIn",
@ -2172,7 +2229,7 @@
"section": "def-common.SearchIn",
"text": "SearchIn"
},
"<T, Query, Options>"
"<T, Options>"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
@ -2195,12 +2252,18 @@
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchIn.query",
"type": "Uncategorized",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"Query"
{
"pluginId": "contentManagement",
"scope": "common",
"docId": "kibContentManagementPluginApi",
"section": "def-common.SearchQuery",
"text": "SearchQuery"
}
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
@ -2237,6 +2300,84 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchQuery",
"type": "Interface",
"tags": [],
"label": "SearchQuery",
"description": [],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchQuery.text",
"type": "string",
"tags": [],
"label": "text",
"description": [
"The text to search for"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchQuery.tags",
"type": "Object",
"tags": [],
"label": "tags",
"description": [
"List of tags id to include and exclude"
],
"signature": [
"{ included?: string[] | undefined; excluded?: string[] | undefined; } | undefined"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchQuery.limit",
"type": "number",
"tags": [],
"label": "limit",
"description": [
"The number of result to return"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchQuery.cursor",
"type": "string",
"tags": [],
"label": "cursor",
"description": [
"The cursor for this query. Can be a page number or a cursor"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.UpdateIn",
@ -2346,6 +2487,55 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.BulkGetResult",
"type": "Type",
"tags": [],
"label": "BulkGetResult",
"description": [],
"signature": [
"ResultMeta extends void ? { hits: ",
"ItemResult",
"<T, ItemMeta>[]; } : { hits: ",
"ItemResult",
"<T, ItemMeta>[]; meta: ResultMeta; }"
],
"path": "src/plugins/content_management/common/rpc/bulk_get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.CreateResult",
"type": "Type",
"tags": [],
"label": "CreateResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/create.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.GetResult",
"type": "Type",
"tags": [],
"label": "GetResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.PLUGIN_ID",
@ -2375,6 +2565,36 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.SearchResult",
"type": "Type",
"tags": [],
"label": "SearchResult",
"description": [],
"signature": [
"M extends void ? { hits: T[]; pagination: { total: number; cursor?: string | undefined; }; } : { hits: T[]; pagination: { total: number; cursor?: string | undefined; }; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/search.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "contentManagement",
"id": "def-common.UpdateResult",
"type": "Type",
"tags": [],
"label": "UpdateResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/update.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []

4
api_docs/content_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 118 | 0 | 104 | 4 |
| 130 | 0 | 112 | 5 |
## Client

2
api_docs/controls.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls"
image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';

2
api_docs/custom_integrations.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

2
api_docs/dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';

2
api_docs/dashboard_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

2
api_docs/data.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

2
api_docs/data_query.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

2
api_docs/data_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

2
api_docs/data_view_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

2
api_docs/data_view_field_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

2
api_docs/data_view_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

2
api_docs/data_views.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

2
api_docs/data_visualizer.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

2
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/dev_tools.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

2
api_docs/discover.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';

2
api_docs/discover_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

2
api_docs/ecs_data_quality_dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

2
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';

2
api_docs/embeddable_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

2
api_docs/encrypted_saved_objects.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

2
api_docs/enterprise_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

2
api_docs/es_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

2
api_docs/event_annotation.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

2
api_docs/event_log.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

2
api_docs/exploratory_view.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

2
api_docs/expression_error.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

109
api_docs/expression_gauge.devdocs.json
View file

@ -893,6 +893,49 @@
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.AllowedGaugeOverrides",
"type": "Type",
"tags": [],
"label": "AllowedGaugeOverrides",
"description": [],
"signature": [
"{ gauge?: { id: string; subtype: ",
"GoalSubtype",
"; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"GoalDomainRange",
">; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ",
"GoalLabelAccessor",
" | undefined; labelMinor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMajor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMinor?: string | ",
"GoalLabelAccessor",
" | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; } | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.EXPRESSION_GAUGE_NAME",
@ -1160,7 +1203,71 @@
"section": "def-public.PersistedState",
"text": "PersistedState"
},
"; }"
"; overrides?: (Partial<Record<\"gauge\", { id: string; subtype: ",
"GoalSubtype",
"; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"GoalDomainRange",
">; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ",
"GoalLabelAccessor",
" | undefined; labelMinor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMajor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMinor?: string | ",
"GoalLabelAccessor",
" | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; }>> & Partial<Record<\"settings\", { tooltip?: ",
"TooltipSettings",
" | undefined; debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts",
"deprecated": false,

4
api_docs/expression_gauge.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 58 | 0 | 58 | 2 |
| 59 | 0 | 59 | 2 |
## Client

50
api_docs/expression_heatmap.devdocs.json
View file

@ -484,6 +484,56 @@
"path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionHeatmap",
"id": "def-common.HeatmapExpressionProps.overrides",
"type": "Object",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"Partial<Record<\"settings\", { tooltip?: ",
"TooltipSettings",
" | undefined; debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

4
api_docs/expression_heatmap.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 111 | 14 | 107 | 2 |
| 112 | 14 | 108 | 2 |
## Common

2
api_docs/expression_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

2
api_docs/expression_legacy_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

2
api_docs/expression_metric.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

93
api_docs/expression_metric_vis.devdocs.json
View file

@ -462,6 +462,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.palette",
@ -680,6 +694,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.palette",
@ -831,6 +859,56 @@
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.overrides",
"type": "Object",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"Partial<Record<\"settings\", { tooltip?: ",
"TooltipSettings",
" | undefined; debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -928,6 +1006,21 @@
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.AvailableMetricIcon",
"type": "Type",
"tags": [],
"label": "AvailableMetricIcon",
"description": [],
"signature": [
"\"alert\" | \"temperature\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\" | \"tag\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.EXPRESSION_METRIC_NAME",

4
api_docs/expression_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 63 | 0 | 63 | 2 |
| 67 | 0 | 67 | 2 |
## Client

33
api_docs/expression_partition_vis.devdocs.json
View file

@ -1068,6 +1068,31 @@
}
],
"misc": [
{
"parentPluginId": "expressionPartitionVis",
"id": "def-common.AllowedPartitionOverrides",
"type": "Type",
"tags": [],
"label": "AllowedPartitionOverrides",
"description": [],
"signature": [
"{ partition?: { animation?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<{ duration: number; } | undefined>; valueGetter?: ",
"ValueGetter",
" | undefined; fillOutside?: boolean | undefined; radiusOutside?: number | undefined; fillRectangleWidth?: number | undefined; fillRectangleHeight?: number | undefined; topGroove?: number | undefined; percentFormatter?: \"ignore\" | undefined; clockwiseSectors?: boolean | undefined; maxRowCount?: number | undefined; specialFirstInnermostSector?: boolean | undefined; smallMultiples?: string | undefined; drilldown?: boolean | undefined; } | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionPartitionVis",
"id": "def-common.ExpressionValuePartitionLabels",
@ -1154,7 +1179,7 @@
"text": "ExpressionValueRender"
},
"<",
"RenderValue",
"PartitionChartProps",
">, ",
{
"pluginId": "expressions",
@ -1335,7 +1360,7 @@
"text": "ExpressionValueRender"
},
"<",
"RenderValue",
"PartitionChartProps",
">, ",
{
"pluginId": "expressions",
@ -1452,7 +1477,7 @@
"text": "ExpressionValueRender"
},
"<",
"RenderValue",
"PartitionChartProps",
">, ",
{
"pluginId": "expressions",
@ -1539,7 +1564,7 @@
"text": "ExpressionValueRender"
},
"<",
"RenderValue",
"PartitionChartProps",
">, ",
{
"pluginId": "expressions",

4
api_docs/expression_partition_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 72 | 0 | 72 | 2 |
| 73 | 0 | 73 | 2 |
## Client

2
api_docs/expression_repeat_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

2
api_docs/expression_reveal_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

2
api_docs/expression_shape.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

2
api_docs/expression_tagcloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

201
api_docs/expression_x_y.devdocs.json
View file

@ -1858,6 +1858,90 @@
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionXY",
"id": "def-common.XYChartProps.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"(Partial<Record<\"axisX\" | \"axisLeft\" | \"axisRight\", { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; position?: ",
"Position",
" | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial<Record<\"settings\", { tooltip?: ",
"TooltipSettings",
" | undefined; debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -2014,6 +2098,123 @@
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionXY",
"id": "def-common.AllowedXYOverrides",
"type": "Type",
"tags": [],
"label": "AllowedXYOverrides",
"description": [],
"signature": [
"{ axisX?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; position?: ",
"Position",
" | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; axisLeft?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; position?: ",
"Position",
" | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; axisRight?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; position?: ",
"Position",
" | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionXY",
"id": "def-common.AvailableReferenceLineIcon",

4
api_docs/expression_x_y.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 171 | 0 | 161 | 13 |
| 173 | 0 | 163 | 13 |
## Client

2
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';

2
api_docs/features.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features"
image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/file_upload.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

2
api_docs/files.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

2
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';

2
api_docs/global_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

2
api_docs/guided_onboarding.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

2
api_docs/home.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home"
image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

2
api_docs/image_embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

2
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/infra.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
title: "infra"
image: https://source.unsplash.com/400x175/?github
description: API docs for the infra plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

2
api_docs/inspector.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
title: "inspector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inspector plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

2
api_docs/interactive_setup.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

2
api_docs/kbn_ace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
title: "@kbn/ace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ace plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

2
api_docs/kbn_aiops_components.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
title: "@kbn/aiops-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-components plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';

2
api_docs/kbn_aiops_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
title: "@kbn/aiops-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-utils plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';

2
api_docs/kbn_alerting_state_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
title: "@kbn/alerting-state-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-state-types plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

2
api_docs/kbn_alerts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
title: "@kbn/alerts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
---
import kbnAlertsObj from './kbn_alerts.devdocs.json';

2
api_docs/kbn_alerts_as_data_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
title: "@kbn/alerts-as-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-as-data-utils plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

2
api_docs/kbn_alerts_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
title: "@kbn/alerts-ui-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-ui-shared plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';

2
api_docs/kbn_analytics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

2
api_docs/kbn_analytics_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
title: "@kbn/analytics-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-client plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser
title: "@kbn/analytics-shippers-elastic-v3-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
---
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_common.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common
title: "@kbn/analytics-shippers-elastic-v3-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
---
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_server.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server
title: "@kbn/analytics-shippers-elastic-v3-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
---
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';

2
api_docs/kbn_analytics_shippers_fullstory.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
title: "@kbn/analytics-shippers-fullstory"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-fullstory plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
---
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';

2
api_docs/kbn_analytics_shippers_gainsight.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight
title: "@kbn/analytics-shippers-gainsight"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-gainsight plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight']
---
import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json';

2
api_docs/kbn_apm_config_loader.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
title: "@kbn/apm-config-loader"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-config-loader plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';

2
api_docs/kbn_apm_synthtrace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
title: "@kbn/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';

2
api_docs/kbn_apm_synthtrace_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client
title: "@kbn/apm-synthtrace-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace-client plugin
date: 2023-04-04
date: 2023-04-05
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client']
---
import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json';

Some files were not shown because too many files have changed in this diff Show more