87a5b22626
* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
437 lines
15 KiB
JSON
437 lines
15 KiB
JSON
{
|
|
"id": "maps",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams",
|
|
"type": "Interface",
|
|
"label": "RenderTooltipContentParams",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams.addFilters",
|
|
"type": "Function",
|
|
"label": "addFilters",
|
|
"signature": [
|
|
"(filter: object) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "filter",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L32"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L32"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams.closeTooltip",
|
|
"type": "Function",
|
|
"label": "closeTooltip",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L33"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RenderTooltipContentParams.features",
|
|
"type": "Array",
|
|
"label": "features",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L34"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.TooltipFeature",
|
|
"text": "TooltipFeature"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RenderTooltipContentParams.isLocked",
|
|
"type": "boolean",
|
|
"label": "isLocked",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams.getLayerName",
|
|
"type": "Function",
|
|
"label": "getLayerName",
|
|
"signature": [
|
|
"(layerId: string) => Promise<string>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "layerId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L36"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L36"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties",
|
|
"type": "Function",
|
|
"label": "loadFeatureProperties",
|
|
"signature": [
|
|
"({ layerId, featureId }: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LoadFeatureProps",
|
|
"text": "LoadFeatureProps"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.ITooltipProperty",
|
|
"text": "ITooltipProperty"
|
|
},
|
|
"[]>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{ layerId, featureId }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LoadFeatureProps",
|
|
"text": "LoadFeatureProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L37"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry",
|
|
"type": "Function",
|
|
"label": "loadFeatureGeometry",
|
|
"signature": [
|
|
"({ layerId, featureId }: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LoadFeatureProps",
|
|
"text": "LoadFeatureProps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.FeatureGeometry",
|
|
"text": "FeatureGeometry"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{ layerId, featureId }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LoadFeatureProps",
|
|
"text": "LoadFeatureProps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L38"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L38"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts#L31"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.MAP_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"label": "MAP_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/common/constants.ts#L29"
|
|
},
|
|
"signature": [
|
|
"\"map\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-public.MapsStartApi",
|
|
"type": "Interface",
|
|
"label": "MapsStartApi",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.MapsStartApi.createLayerDescriptors",
|
|
"type": "Object",
|
|
"label": "createLayerDescriptors",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L14"
|
|
},
|
|
"signature": [
|
|
"{ createSecurityLayerDescriptors: (indexPatternId: string, indexPatternTitle: string) => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
"[]>; createBasemapLayerDescriptor: () => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
" | null>; createESSearchSourceLayerDescriptor: (params: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.CreateLayerDescriptorParams",
|
|
"text": "CreateLayerDescriptorParams"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
">; }"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.MapsStartApi.registerLayerWizard",
|
|
"type": "Function",
|
|
"label": "registerLayerWizard",
|
|
"signature": [
|
|
"(layerWizard: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LayerWizard",
|
|
"text": "LayerWizard"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "layerWizard",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.LayerWizard",
|
|
"text": "LayerWizard"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L24"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L24"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.MapsStartApi.registerSource",
|
|
"type": "Function",
|
|
"label": "registerSource",
|
|
"signature": [
|
|
"(entry: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.SourceRegistryEntry",
|
|
"text": "SourceRegistryEntry"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "entry",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.SourceRegistryEntry",
|
|
"text": "SourceRegistryEntry"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L25"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L25"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/maps/public/api/start_api.ts#L13"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |