kibana/api_docs/vis_type_pie.json
Stacey Gammon 53fa5ff3fd
API Doc Fixes (#109685) (#110466)
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/charts.mdx
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.json
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/expression_shape.json
#	api_docs/expression_shape.mdx
#	api_docs/expressions.json
#	api_docs/field_formats.json
#	api_docs/fleet.json
#	api_docs/kibana_react.json
#	api_docs/kibana_react.mdx
#	api_docs/lists.json
#	api_docs/observability.json
#	api_docs/reporting.json
#	api_docs/rule_registry.json
#	api_docs/rule_registry.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
#	api_docs/timelines.json
#	api_docs/timelines.mdx
#	api_docs/visualizations.mdx
2021-08-30 11:02:04 -04:00

237 lines
6.8 KiB
JSON

{
"id": "visTypePie",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "visTypePie",
"id": "def-public.pieVisType",
"type": "Function",
"tags": [],
"label": "pieVisType",
"description": [],
"signature": [
"(props: ",
"PieTypeProps",
") => ",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisTypeDefinition",
"text": "VisTypeDefinition"
},
"<",
"PieVisParams",
">"
],
"path": "src/plugins/vis_types/pie/public/vis_type/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypePie",
"id": "def-public.pieVisType.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"PieTypeProps"
],
"path": "src/plugins/vis_types/pie/public/vis_type/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimension",
"type": "Interface",
"tags": [],
"label": "Dimension",
"description": [],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimension.accessor",
"type": "number",
"tags": [],
"label": "accessor",
"description": [],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
},
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimension.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
"{ id?: string | undefined; params?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<object> | undefined; }"
],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimensions",
"type": "Interface",
"tags": [],
"label": "Dimensions",
"description": [],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimensions.metric",
"type": "Object",
"tags": [],
"label": "metric",
"description": [],
"signature": [
{
"pluginId": "visTypePie",
"scope": "public",
"docId": "kibVisTypePiePluginApi",
"section": "def-public.Dimension",
"text": "Dimension"
}
],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
},
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimensions.buckets",
"type": "Array",
"tags": [],
"label": "buckets",
"description": [],
"signature": [
{
"pluginId": "visTypePie",
"scope": "public",
"docId": "kibVisTypePiePluginApi",
"section": "def-public.Dimension",
"text": "Dimension"
},
"[] | undefined"
],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
},
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimensions.splitRow",
"type": "Array",
"tags": [],
"label": "splitRow",
"description": [],
"signature": [
{
"pluginId": "visTypePie",
"scope": "public",
"docId": "kibVisTypePiePluginApi",
"section": "def-public.Dimension",
"text": "Dimension"
},
"[] | undefined"
],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
},
{
"parentPluginId": "visTypePie",
"id": "def-public.Dimensions.splitColumn",
"type": "Array",
"tags": [],
"label": "splitColumn",
"description": [],
"signature": [
{
"pluginId": "visTypePie",
"scope": "public",
"docId": "kibVisTypePiePluginApi",
"section": "def-public.Dimension",
"text": "Dimension"
},
"[] | undefined"
],
"path": "src/plugins/vis_types/pie/public/types/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "visTypePie",
"id": "def-common.DEFAULT_PERCENT_DECIMALS",
"type": "number",
"tags": [],
"label": "DEFAULT_PERCENT_DECIMALS",
"description": [],
"signature": [
"2"
],
"path": "src/plugins/vis_types/pie/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "visTypePie",
"id": "def-common.LEGACY_PIE_CHARTS_LIBRARY",
"type": "string",
"tags": [],
"label": "LEGACY_PIE_CHARTS_LIBRARY",
"description": [],
"signature": [
"\"visualization:visualize:legacyPieChartsLibrary\""
],
"path": "src/plugins/vis_types/pie/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}