* Clean up api doc infra * updated docs * Update api dics # Conflicts: # api_docs/actions.mdx # api_docs/alerting.json # api_docs/core.mdx # api_docs/core_application.mdx # 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.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/expressions.mdx # api_docs/interactive_setup.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.json # api_docs/rule_registry.json # api_docs/saved_objects.json # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/url_forwarding.json
1694 lines
No EOL
57 KiB
JSON
1694 lines
No EOL
57 KiB
JSON
{
|
|
"id": "maps",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "MapEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddable",
|
|
"text": "MapEmbeddable"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddableInput",
|
|
"text": "MapEmbeddableInput"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddableOutput",
|
|
"text": "MapEmbeddableOutput"
|
|
},
|
|
"> implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReferenceOrValueEmbeddable",
|
|
"text": "ReferenceOrValueEmbeddable"
|
|
},
|
|
"<",
|
|
"MapByValueInput",
|
|
", ",
|
|
"MapByReferenceInput",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.deferEmbeddableLoad",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "deferEmbeddableLoad",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"MapEmbeddableConfig"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.Unnamed.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddableInput",
|
|
"text": "MapEmbeddableInput"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.inputIsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "inputIsRefType",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddableInput",
|
|
"text": "MapEmbeddableInput"
|
|
},
|
|
") => input is ",
|
|
"MapByReferenceInput"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.inputIsRefType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.MapEmbeddableInput",
|
|
"text": "MapEmbeddableInput"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getInputAsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsRefType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"MapByReferenceInput",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getInputAsValueType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsValueType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"MapByValueInput",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.supportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "supportedTriggers",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setRenderTooltipContent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setRenderTooltipContent",
|
|
"description": [],
|
|
"signature": [
|
|
"(renderTooltipContent: ",
|
|
"RenderToolTipContent",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setRenderTooltipContent.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderTooltipContent",
|
|
"description": [],
|
|
"signature": [
|
|
"RenderToolTipContent"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setEventHandlers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setEventHandlers",
|
|
"description": [],
|
|
"signature": [
|
|
"(eventHandlers: ",
|
|
"EventHandlers",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setEventHandlers.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "eventHandlers",
|
|
"description": [],
|
|
"signature": [
|
|
"EventHandlers"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getInspectorAdapters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInspectorAdapters",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.onUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onUpdate",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._getFilters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_getFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"Filter",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._getSearchSessionId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_getSearchSessionId",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._dispatchSetQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_dispatchSetQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"({ forceRefresh }: { forceRefresh: boolean; }) => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._dispatchSetQuery.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ forceRefresh }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._dispatchSetQuery.$1.forceRefresh",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "forceRefresh",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._dispatchSetChartsPaletteServiceGetColor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_dispatchSetChartsPaletteServiceGetColor",
|
|
"description": [],
|
|
"signature": [
|
|
"(syncColors?: boolean | undefined) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._dispatchSetChartsPaletteServiceGetColor.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "syncColors",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"(domNode: HTMLElement) => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "domNode",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setLayerList",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setLayerList",
|
|
"description": [],
|
|
"signature": [
|
|
"(layerList: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
"[]) => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setLayerList.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "layerList",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.onSingleValueTrigger",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSingleValueTrigger",
|
|
"description": [],
|
|
"signature": [
|
|
"(actionId: string, key: string, value: ",
|
|
"RawValue",
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.onSingleValueTrigger.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.onSingleValueTrigger.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.onSingleValueTrigger.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"RawValue"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.addFilters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"(filters: ",
|
|
"Filter",
|
|
"[], actionId?: string) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.addFilters.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
"Filter",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.addFilters.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getFilterActions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilterActions",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.getActionContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<object>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.setMapExtentFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setMapExtentFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.clearMapExtentFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearMapExtentFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable.reload",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reload",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddable._handleStoreChanges",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "_handleStoreChanges",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.EMSTermJoinConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EMSTermJoinConfig",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.EMSTermJoinConfig.layerId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "layerId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.EMSTermJoinConfig.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RenderTooltipContentParams",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.addFilters",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "addFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"((filters: ",
|
|
"Filter",
|
|
"[], actionId: string) => Promise<void>) | null"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.closeTooltip",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "closeTooltip",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.features",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.TooltipFeature",
|
|
"text": "TooltipFeature"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.getActionContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<object>) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.getFilterActions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilterActions",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]>) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.getLayerName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLayerName",
|
|
"description": [],
|
|
"signature": [
|
|
"(layerId: string) => Promise<string | null>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.getLayerName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "layerId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.isLocked",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isLocked",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "loadFeatureProperties",
|
|
"description": [],
|
|
"signature": [
|
|
"({ layerId, featureId, mbProperties, }: { layerId: string; featureId?: string | number | undefined; mbProperties: GeoJSON.GeoJsonProperties; }) => Promise<",
|
|
"ITooltipProperty",
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n layerId,\n featureId,\n mbProperties,\n }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "layerId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.featureId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "featureId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.mbProperties",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mbProperties",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [name: string]: any; } | null"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "loadFeatureGeometry",
|
|
"description": [],
|
|
"signature": [
|
|
"({ layerId, featureId, }: { layerId: string; featureId?: string | number | undefined; }) => GeoJSON.Point | GeoJSON.MultiPoint | GeoJSON.LineString | GeoJSON.MultiLineString | GeoJSON.Polygon | GeoJSON.MultiPolygon | GeoJSON.GeometryCollection | null"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n layerId,\n featureId,\n }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "layerId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.featureId",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "featureId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSingleValueTrigger",
|
|
"description": [],
|
|
"signature": [
|
|
"((actionId: string, key: string, value: ",
|
|
"RawValue",
|
|
") => void) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"RawValue"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.SampleValuesConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SampleValuesConfig",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.SampleValuesConfig.sampleValues",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "sampleValues",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ReactText[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.SampleValuesConfig.sampleValuesColumnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sampleValuesColumnName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MAP_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAP_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"map\""
|
|
],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddableInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MapEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"MapByValueInput",
|
|
" | ",
|
|
"MapByReferenceInput"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapEmbeddableOutput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MapEmbeddableOutput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" & { indexPatterns: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MapsStartApi",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.createLayerDescriptors",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "createLayerDescriptors",
|
|
"description": [],
|
|
"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: ",
|
|
"CreateLayerDescriptorParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.registerLayerWizard",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerLayerWizard",
|
|
"description": [],
|
|
"signature": [
|
|
"(layerWizard: ",
|
|
"LayerWizard",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.registerLayerWizard.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "layerWizard",
|
|
"description": [],
|
|
"signature": [
|
|
"LayerWizard"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.registerSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerSource",
|
|
"description": [],
|
|
"signature": [
|
|
"(entry: ",
|
|
"SourceRegistryEntry",
|
|
") => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.registerSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "entry",
|
|
"description": [],
|
|
"signature": [
|
|
"SourceRegistryEntry"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.suggestEMSTermJoinConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "suggestEMSTermJoinConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.SampleValuesConfig",
|
|
"text": "SampleValuesConfig"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.EMSTermJoinConfig",
|
|
"text": "EMSTermJoinConfig"
|
|
},
|
|
" | null>"
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-public.MapsStartApi.suggestEMSTermJoinConfig.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "public",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-public.SampleValuesConfig",
|
|
"text": "SampleValuesConfig"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/maps/public/api/start_api.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.AGG_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AGG_TYPE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.COLOR_MAP_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "COLOR_MAP_TYPE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.ES_GEO_FIELD_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ES_GEO_FIELD_TYPE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.FIELD_ORIGIN",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "FIELD_ORIGIN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.INITIAL_LOCATION",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "INITIAL_LOCATION",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.LABEL_BORDER_SIZES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "LABEL_BORDER_SIZES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.SOURCE_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "SOURCE_TYPES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.STYLE_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "STYLE_TYPE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.SYMBOLIZE_AS_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "SYMBOLIZE_AS_TYPES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.EMSFileSourceDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EMSFileSourceDescriptor",
|
|
"description": [],
|
|
"signature": [
|
|
"AbstractSourceDescriptor",
|
|
" & { id: string; tooltipProperties: string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.ESTermSourceDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ESTermSourceDescriptor",
|
|
"description": [],
|
|
"signature": [
|
|
"AbstractSourceDescriptor",
|
|
" & { id: string; indexPatternId: string; geoField?: string | undefined; applyGlobalQuery: boolean; applyGlobalTime: boolean; applyForceRefresh: boolean; } & { metrics: ",
|
|
"AggDescriptor",
|
|
"[]; } & { indexPatternTitle?: string | undefined; term: string; whereQuery?: ",
|
|
"Query",
|
|
" | undefined; size?: number | undefined; type: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.SOURCE_TYPES",
|
|
"text": "SOURCE_TYPES"
|
|
},
|
|
".ES_TERM_SOURCE; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/source_descriptor_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.LayerDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LayerDescriptor",
|
|
"description": [],
|
|
"signature": [
|
|
"{ __dataRequests?: ",
|
|
"DataRequestDescriptor",
|
|
"[] | undefined; __isInErrorState?: boolean | undefined; __isPreviewLayer?: boolean | undefined; __errorMessage?: string | undefined; __trackedLayerDescriptor?: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
" | undefined; __areTilesLoaded?: boolean | undefined; __metaFromTiles?: ",
|
|
"TileMetaFeature",
|
|
"[] | undefined; alpha?: number | undefined; attribution?: ",
|
|
"Attribution",
|
|
" | undefined; id: string; joins?: ",
|
|
"JoinDescriptor",
|
|
"[] | undefined; label?: string | null | undefined; areLabelsOnTop?: boolean | undefined; minZoom?: number | undefined; maxZoom?: number | undefined; sourceDescriptor: ",
|
|
"AbstractSourceDescriptor",
|
|
" | null; type?: string | undefined; visible?: boolean | undefined; style?: ",
|
|
"StyleDescriptor",
|
|
" | null | undefined; query?: ",
|
|
"Query",
|
|
" | undefined; includeInFitToBounds?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.MAP_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MAP_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"map\""
|
|
],
|
|
"path": "x-pack/plugins/maps/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.TooltipFeature",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TooltipFeature",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id?: string | number | undefined; layerId: string; geometry?: GeoJSON.Point | GeoJSON.MultiPoint | GeoJSON.LineString | GeoJSON.MultiLineString | GeoJSON.Polygon | GeoJSON.MultiPolygon | GeoJSON.GeometryCollection | undefined; mbProperties: GeoJSON.GeoJsonProperties; actions: ",
|
|
"TooltipFeatureAction",
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/map_descriptor.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.VectorLayerDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VectorLayerDescriptor",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.LayerDescriptor",
|
|
"text": "LayerDescriptor"
|
|
},
|
|
" & { style: ",
|
|
{
|
|
"pluginId": "maps",
|
|
"scope": "common",
|
|
"docId": "kibMapsPluginApi",
|
|
"section": "def-common.VectorStyleDescriptor",
|
|
"text": "VectorStyleDescriptor"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "maps",
|
|
"id": "def-common.VectorStyleDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VectorStyleDescriptor",
|
|
"description": [],
|
|
"signature": [
|
|
"StyleDescriptor",
|
|
" & { properties: ",
|
|
"VectorStylePropertiesDescriptor",
|
|
"; isTimeAware: boolean; __styleMeta?: ",
|
|
"StyleMetaDescriptor",
|
|
" | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/maps/common/descriptor_types/style_property_descriptor_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |