github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 01:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/maps.devdocs.json

4048 lines
No EOL
137 KiB
JSON
Raw Permalink Blame History

{
"id": "maps",
"client": {
"classes": [
{
"parentPluginId": "maps",
"id": "def-public.DataRequest",
"type": "Class",
"tags": [],
"label": "DataRequest",
"description": [],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "descriptor",
"description": [],
"signature": [
"DataRequestDescriptor"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.getData",
"type": "Function",
"tags": [],
"label": "getData",
"description": [],
"signature": [
"() => object | undefined"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.isLoading",
"type": "Function",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.getMeta",
"type": "Function",
"tags": [],
"label": "getMeta",
"description": [],
"signature": [
"() => ",
"DataRequestMeta"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.hasData",
"type": "Function",
"tags": [],
"label": "hasData",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.hasDataOrRequestInProgress",
"type": "Function",
"tags": [],
"label": "hasDataOrRequestInProgress",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.getDataId",
"type": "Function",
"tags": [],
"label": "getDataId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.getRequestToken",
"type": "Function",
"tags": [],
"label": "getRequestToken",
"description": [],
"signature": [
"() => symbol | undefined"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.DataRequest.renderError",
"type": "Function",
"tags": [],
"label": "renderError",
"description": [],
"signature": [
"() => React.ReactNode"
],
"path": "x-pack/plugins/maps/public/classes/util/data_request.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "maps",
"id": "def-public.isMapApi",
"type": "Function",
"tags": [],
"label": "isMapApi",
"description": [],
"signature": [
"(api: unknown) => api is ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.MapApi",
"text": "MapApi"
}
],
"path": "x-pack/plugins/maps/public/react_embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.isMapApi.$1",
"type": "Unknown",
"tags": [],
"label": "api",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/maps/public/react_embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta",
"type": "Interface",
"tags": [],
"label": "BoundsRequestMeta",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.applyGlobalQuery",
"type": "boolean",
"tags": [],
"label": "applyGlobalQuery",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.applyGlobalTime",
"type": "boolean",
"tags": [],
"label": "applyGlobalTime",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.embeddableSearchContext",
"type": "Object",
"tags": [],
"label": "embeddableSearchContext",
"description": [],
"signature": [
"{ query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; } | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.sourceQuery",
"type": "Object",
"tags": [],
"label": "sourceQuery",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.timeFilters",
"type": "Object",
"tags": [],
"label": "timeFilters",
"description": [],
"signature": [
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.timeslice",
"type": "Object",
"tags": [],
"label": "timeslice",
"description": [],
"signature": [
"Timeslice",
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.isFeatureEditorOpenForLayer",
"type": "boolean",
"tags": [],
"label": "isFeatureEditorOpenForLayer",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.joinKeyFilter",
"type": "Object",
"tags": [],
"label": "joinKeyFilter",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.BoundsRequestMeta.executionContext",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [],
"signature": [
"{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.CreateLayerDescriptorParams",
"type": "Interface",
"tags": [],
"label": "CreateLayerDescriptorParams",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.CreateLayerDescriptorParams.indexPatternId",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.CreateLayerDescriptorParams.geoFieldName",
"type": "string",
"tags": [],
"label": "geoFieldName",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.CreateLayerDescriptorParams.geoFieldType",
"type": "Enum",
"tags": [],
"label": "geoFieldType",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.ES_GEO_FIELD_TYPE",
"text": "ES_GEO_FIELD_TYPE"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.CreateLayerDescriptorParams.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/create_layer_descriptor.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.EMSTermJoinConfig.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.GeoJsonWithMeta",
"type": "Interface",
"tags": [],
"label": "GeoJsonWithMeta",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.GeoJsonWithMeta.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.GeoJsonWithMeta.meta",
"type": "CompoundType",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"DataRequestMeta",
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs",
"type": "Interface",
"tags": [],
"label": "GetFeatureActionsArgs",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.addFilters",
"type": "CompoundType",
"tags": [],
"label": "addFilters",
"description": [],
"signature": [
"((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], actionId: string) => Promise<void>) | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.geoFieldNames",
"type": "Array",
"tags": [],
"label": "geoFieldNames",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.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/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.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/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.getGeojsonGeometry",
"type": "Function",
"tags": [],
"label": "getGeojsonGeometry",
"description": [],
"signature": [
"() => GeoJSON.Geometry | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.mbFeature",
"type": "CompoundType",
"tags": [],
"label": "mbFeature",
"description": [],
"signature": [
"maplibregl.GeoJSONFeature & { layer: (Omit<maplibregl.FillLayerSpecification, \"source\"> | Omit<maplibregl.LineLayerSpecification, \"source\"> | Omit<maplibregl.SymbolLayerSpecification, \"source\"> | Omit<maplibregl.CircleLayerSpecification, \"source\"> | Omit<maplibregl.HeatmapLayerSpecification, \"source\"> | Omit<maplibregl.FillExtrusionLayerSpecification, \"source\"> | Omit<maplibregl.RasterLayerSpecification, \"source\"> | Omit<maplibregl.HillshadeLayerSpecification, \"source\"> | Omit<maplibregl.BackgroundLayerSpecification, \"source\">) & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.GetFeatureActionsArgs.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.IField",
"type": "Interface",
"tags": [],
"label": "IField",
"description": [],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.getName",
"type": "Function",
"tags": [],
"label": "getName",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getMbFieldName",
"type": "Function",
"tags": [],
"label": "getMbFieldName",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getRootName",
"type": "Function",
"tags": [],
"label": "getRootName",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.canValueBeFormatted",
"type": "Function",
"tags": [],
"label": "canValueBeFormatted",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getLabel",
"type": "Function",
"tags": [],
"label": "getLabel",
"description": [],
"signature": [
"() => Promise<string>"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getDataType",
"type": "Function",
"tags": [],
"label": "getDataType",
"description": [],
"signature": [
"() => Promise<string>"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.createTooltipProperty",
"type": "Function",
"tags": [],
"label": "createTooltipProperty",
"description": [],
"signature": [
"(value: string | string[] | undefined) => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.ITooltipProperty",
"text": "ITooltipProperty"
},
">"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.createTooltipProperty.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getSource",
"type": "Function",
"tags": [],
"label": "getSource",
"description": [],
"signature": [
"() => ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IVectorSource",
"text": "IVectorSource"
}
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getOrigin",
"type": "Function",
"tags": [],
"label": "getOrigin",
"description": [],
"signature": [
"() => ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.FIELD_ORIGIN",
"text": "FIELD_ORIGIN"
}
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.isValid",
"type": "Function",
"tags": [],
"label": "isValid",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getExtendedStatsFieldMetaRequest",
"type": "Function",
"tags": [],
"label": "getExtendedStatsFieldMetaRequest",
"description": [],
"signature": [
"() => Promise<Record<string, { extended_stats: ",
"AggregationsExtendedStatsAggregation",
"; }> | null>"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getPercentilesFieldMetaRequest",
"type": "Function",
"tags": [],
"label": "getPercentilesFieldMetaRequest",
"description": [],
"signature": [
"(percentiles: number[]) => Promise<Record<string, { percentiles: ",
"AggregationsPercentilesAggregation",
"; }> | null>"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.getPercentilesFieldMetaRequest.$1",
"type": "Array",
"tags": [],
"label": "percentiles",
"description": [],
"signature": [
"number[]"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.getCategoricalFieldMetaRequest",
"type": "Function",
"tags": [],
"label": "getCategoricalFieldMetaRequest",
"description": [],
"signature": [
"(size: number) => Promise<Record<string, { terms: ",
"AggregationsTermsAggregation",
"; }> | null>"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.getCategoricalFieldMetaRequest.$1",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.supportsFieldMetaFromLocalData",
"type": "Function",
"tags": [],
"label": "supportsFieldMetaFromLocalData",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.supportsFieldMetaFromEs",
"type": "Function",
"tags": [],
"label": "supportsFieldMetaFromEs",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.isEqual",
"type": "Function",
"tags": [],
"label": "isEqual",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IField",
"text": "IField"
},
") => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.isEqual.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IField",
"text": "IField"
}
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.pluckRangeFromTileMetaFeature",
"type": "Function",
"tags": [],
"label": "pluckRangeFromTileMetaFeature",
"description": [],
"signature": [
"(metaFeature: ",
"TileMetaFeature",
") => { min: number; max: number; } | null"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IField.pluckRangeFromTileMetaFeature.$1",
"type": "CompoundType",
"tags": [],
"label": "metaFeature",
"description": [],
"signature": [
"TileMetaFeature"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IField.isCount",
"type": "Function",
"tags": [],
"label": "isCount",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/fields/field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource",
"type": "Interface",
"tags": [],
"label": "IRasterSource",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IRasterSource",
"text": "IRasterSource"
},
" extends ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.ITMSSource",
"text": "ITMSSource"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.canSkipSourceUpdate",
"type": "Function",
"tags": [],
"label": "canSkipSourceUpdate",
"description": [],
"signature": [
"(dataRequest: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
},
", nextRequestMeta: ",
"DataRequestMeta",
") => Promise<boolean>"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.canSkipSourceUpdate.$1",
"type": "Object",
"tags": [],
"label": "dataRequest",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.canSkipSourceUpdate.$2",
"type": "CompoundType",
"tags": [],
"label": "nextRequestMeta",
"description": [],
"signature": [
"DataRequestMeta"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.isSourceStale",
"type": "Function",
"tags": [],
"label": "isSourceStale",
"description": [],
"signature": [
"(mbSource: maplibregl.RasterTileSource, sourceData: ",
"RasterTileSourceData",
") => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.isSourceStale.$1",
"type": "Object",
"tags": [],
"label": "mbSource",
"description": [],
"signature": [
"maplibregl.RasterTileSource"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.isSourceStale.$2",
"type": "Object",
"tags": [],
"label": "sourceData",
"description": [],
"signature": [
"RasterTileSourceData"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.hasLegendDetails",
"type": "Function",
"tags": [],
"label": "hasLegendDetails",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.renderLegendDetails",
"type": "Function",
"tags": [],
"label": "renderLegendDetails",
"description": [],
"signature": [
"(dataRequest: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
},
" | undefined) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IRasterSource.renderLegendDetails.$1",
"type": "Object",
"tags": [],
"label": "dataRequest",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/raster_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.ITMSSource",
"type": "Interface",
"tags": [],
"label": "ITMSSource",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.ITMSSource",
"text": "ITMSSource"
},
" extends ",
"ISource"
],
"path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.ITMSSource.getUrlTemplate",
"type": "Function",
"tags": [],
"label": "getUrlTemplate",
"description": [],
"signature": [
"(requestMeta: ",
"SourceRequestMeta",
") => Promise<string>"
],
"path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.ITMSSource.getUrlTemplate.$1",
"type": "CompoundType",
"tags": [],
"label": "requestMeta",
"description": [],
"signature": [
"SourceRequestMeta"
],
"path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty",
"type": "Interface",
"tags": [],
"label": "ITooltipProperty",
"description": [],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.getPropertyKey",
"type": "Function",
"tags": [],
"label": "getPropertyKey",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.getPropertyName",
"type": "Function",
"tags": [],
"label": "getPropertyName",
"description": [],
"signature": [
"() => React.ReactNode"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.getHtmlDisplayValue",
"type": "Function",
"tags": [],
"label": "getHtmlDisplayValue",
"description": [],
"signature": [
"() => React.ReactNode"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.getRawValue",
"type": "Function",
"tags": [],
"label": "getRawValue",
"description": [],
"signature": [
"() => string | string[] | undefined"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.isFilterable",
"type": "Function",
"tags": [],
"label": "isFilterable",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.ITooltipProperty.getESFilters",
"type": "Function",
"tags": [],
"label": "getESFilters",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource",
"type": "Interface",
"tags": [],
"label": "IVectorSource",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IVectorSource",
"text": "IVectorSource"
},
" extends ",
"ISource"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.isMvt",
"type": "Function",
"tags": [],
"label": "isMvt",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getTooltipProperties",
"type": "Function",
"tags": [],
"label": "getTooltipProperties",
"description": [],
"signature": [
"(properties: GeoJSON.GeoJsonProperties, executionContext: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
") => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.ITooltipProperty",
"text": "ITooltipProperty"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getTooltipProperties.$1",
"type": "CompoundType",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"GeoJSON.GeoJsonProperties"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getTooltipProperties.$2",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getBoundsForFilters",
"type": "Function",
"tags": [],
"label": "getBoundsForFilters",
"description": [],
"signature": [
"(layerDataFilters: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.BoundsRequestMeta",
"text": "BoundsRequestMeta"
},
", registerCancelCallback: (callback: () => void) => void) => Promise<",
"MapExtent",
" | null>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getBoundsForFilters.$1",
"type": "Object",
"tags": [],
"label": "layerDataFilters",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.BoundsRequestMeta",
"text": "BoundsRequestMeta"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getBoundsForFilters.$2",
"type": "Function",
"tags": [],
"label": "registerCancelCallback",
"description": [],
"signature": [
"(callback: () => void) => void"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta",
"type": "Function",
"tags": [],
"label": "getGeoJsonWithMeta",
"description": [],
"signature": [
"(layerName: string, requestMeta: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.VectorSourceRequestMeta",
"text": "VectorSourceRequestMeta"
},
", registerCancelCallback: (callback: () => void) => void, isRequestStillActive: () => boolean, inspectorAdapters: ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
") => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.GeoJsonWithMeta",
"text": "GeoJsonWithMeta"
},
">"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta.$1",
"type": "string",
"tags": [],
"label": "layerName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta.$2",
"type": "CompoundType",
"tags": [],
"label": "requestMeta",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.VectorSourceRequestMeta",
"text": "VectorSourceRequestMeta"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta.$3",
"type": "Function",
"tags": [],
"label": "registerCancelCallback",
"description": [],
"signature": [
"(callback: () => void) => void"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta.$4",
"type": "Function",
"tags": [],
"label": "isRequestStillActive",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getGeoJsonWithMeta.$5",
"type": "Object",
"tags": [],
"label": "inspectorAdapters",
"description": [],
"signature": [
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getFields",
"type": "Function",
"tags": [],
"label": "getFields",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IField",
"text": "IField"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getFieldByName",
"type": "Function",
"tags": [],
"label": "getFieldByName",
"description": [],
"signature": [
"(fieldName: string) => ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IField",
"text": "IField"
},
" | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getFieldByName.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getLeftJoinFields",
"type": "Function",
"tags": [],
"label": "getLeftJoinFields",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.IField",
"text": "IField"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.supportsJoins",
"type": "Function",
"tags": [],
"label": "supportsJoins",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getSyncMeta",
"type": "Function",
"tags": [],
"label": "getSyncMeta",
"description": [],
"signature": [
"(dataFilters: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.DataFilters",
"text": "DataFilters"
},
") => object | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getSyncMeta.$1",
"type": "Object",
"tags": [],
"label": "dataFilters",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.DataFilters",
"text": "DataFilters"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.hasTooltipProperties",
"type": "Function",
"tags": [],
"label": "hasTooltipProperties",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getSupportedShapeTypes",
"type": "Function",
"tags": [],
"label": "getSupportedShapeTypes",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.VECTOR_SHAPE_TYPE",
"text": "VECTOR_SHAPE_TYPE"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.isBoundsAware",
"type": "Function",
"tags": [],
"label": "isBoundsAware",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getSourceStatus",
"type": "Function",
"tags": [],
"label": "getSourceStatus",
"description": [],
"signature": [
"(sourceDataRequest?: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
},
" | undefined) => ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.SourceStatus",
"text": "SourceStatus"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getSourceStatus.$1",
"type": "Object",
"tags": [],
"label": "sourceDataRequest",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.DataRequest",
"text": "DataRequest"
},
" | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getTimesliceMaskFieldName",
"type": "Function",
"tags": [],
"label": "getTimesliceMaskFieldName",
"description": [],
"signature": [
"() => Promise<string | null>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.supportsFeatureEditing",
"type": "Function",
"tags": [],
"label": "supportsFeatureEditing",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.addFeature",
"type": "Function",
"tags": [],
"label": "addFeature",
"description": [],
"signature": [
"(geometry: GeoJSON.Geometry | GeoJSON.Position[]) => Promise<void>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.addFeature.$1",
"type": "CompoundType",
"tags": [],
"label": "geometry",
"description": [],
"signature": [
"GeoJSON.Geometry | GeoJSON.Position[]"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.deleteFeature",
"type": "Function",
"tags": [],
"label": "deleteFeature",
"description": [],
"signature": [
"(featureId: string) => Promise<void>"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.deleteFeature.$1",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getFeatureActions",
"type": "Function",
"tags": [],
"label": "getFeatureActions",
"description": [],
"signature": [
"({ addFilters, featureId, geoFieldNames, getActionContext, getFilterActions, getGeojsonGeometry, mbFeature, onClose, }: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.GetFeatureActionsArgs",
"text": "GetFeatureActionsArgs"
},
") => ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.TooltipFeatureAction",
"text": "TooltipFeatureAction"
},
"[]"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getFeatureActions.$1",
"type": "Object",
"tags": [],
"label": "{\n addFilters,\n featureId,\n geoFieldNames,\n getActionContext,\n getFilterActions,\n getGeojsonGeometry,\n mbFeature,\n onClose,\n }",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.GetFeatureActionsArgs",
"text": "GetFeatureActionsArgs"
}
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.IVectorSource.getInspectorRequestIds",
"type": "Function",
"tags": [],
"label": "getInspectorRequestIds",
"description": [],
"signature": [
"() => string[]"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.RenderTooltipContentParams.addFilters",
"type": "CompoundType",
"tags": [],
"label": "addFilters",
"description": [],
"signature": [
"((filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[], actionId: string) => Promise<void>) | null"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties",
"type": "Function",
"tags": [],
"label": "loadFeatureProperties",
"description": [],
"signature": [
"({ layerId, properties, }: { layerId: string; properties: GeoJSON.GeoJsonProperties; }) => Promise<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.ITooltipProperty",
"text": "ITooltipProperty"
},
"[]>"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1",
"type": "Object",
"tags": [],
"label": "{\n layerId,\n properties,\n }",
"description": [],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.properties",
"type": "CompoundType",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"{ [name: string]: any; } | null"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": 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.Geometry | null"
],
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.SampleValuesConfig.sampleValues",
"type": "Array",
"tags": [],
"label": "sampleValues",
"description": [],
"signature": [
"(string | number)[] | undefined"
],
"path": "x-pack/plugins/maps/public/ems_autosuggest/ems_autosuggest.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.SourceStatus",
"type": "Interface",
"tags": [],
"label": "SourceStatus",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.SourceStatus.tooltipContent",
"type": "CompoundType",
"tags": [],
"label": "tooltipContent",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.SourceStatus.areResultsTrimmed",
"type": "boolean",
"tags": [],
"label": "areResultsTrimmed",
"description": [],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.SourceStatus.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "maps",
"id": "def-public.Attribution",
"type": "Type",
"tags": [],
"label": "Attribution",
"description": [],
"signature": [
"{ label: string; url: string; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.GEOJSON_FEATURE_ID_PROPERTY_NAME",
"type": "string",
"tags": [],
"label": "GEOJSON_FEATURE_ID_PROPERTY_NAME",
"description": [],
"signature": [
"\"__kbn__feature_id__\""
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.ImmutableSourceProperty",
"type": "Type",
"tags": [],
"label": "ImmutableSourceProperty",
"description": [],
"signature": [
"{ label: string; value: string; link?: string | undefined; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/source.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.LayerWizard",
"type": "Type",
"tags": [],
"label": "LayerWizard",
"description": [],
"signature": [
"{ id: string; title: string; categories: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LAYER_WIZARD_CATEGORY",
"text": "LAYER_WIZARD_CATEGORY"
},
"[]; order: number; description: string; icon: string | React.FunctionComponent<any>; renderWizard(renderWizardArguments: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.RenderWizardArguments",
"text": "RenderWizardArguments"
},
"): React.ReactElement<any, string | React.JSXElementConstructor<any>>; prerequisiteSteps?: ",
"LayerWizardStep",
"[] | undefined; disabledReason?: string | undefined; getIsDisabled?: (() => boolean | Promise<boolean>) | undefined; isBeta?: boolean | undefined; checkVisibility?: (() => Promise<boolean>) | undefined; showFeatureEditTools?: boolean | undefined; }"
],
"path": "x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.MapApi",
"type": "Type",
"tags": [],
"label": "MapApi",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.DefaultEmbeddableApi",
"text": "DefaultEmbeddableApi"
},
"<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.MapSerializedState",
"text": "MapSerializedState"
},
", ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.MapSerializedState",
"text": "MapSerializedState"
},
"> & Partial<{ enhancements: { dynamicActions: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.DynamicActionManager",
"text": "DynamicActionManager"
},
"; }; setDynamicActions: (newState: { dynamicActions: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.DynamicActionsState",
"text": "DynamicActionsState"
},
"; } | undefined) => void; dynamicActionsState$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<{ dynamicActions: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.DynamicActionsState",
"text": "DynamicActionsState"
},
"; } | undefined>; }> & Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasEditCapabilities",
"text": "HasEditCapabilities"
},
"> & ",
{
"pluginId": "inspector",
"scope": "public",
"docId": "kibInspectorPluginApi",
"section": "def-public.HasInspectorAdapters",
"text": "HasInspectorAdapters"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasSupportedTriggers",
"text": "HasSupportedTriggers"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDataLoading",
"text": "PublishesDataLoading"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDataViews",
"text": "PublishesDataViews"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesTimeRange",
"text": "PublishesTimeRange"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesFilters",
"text": "PublishesFilters"
},
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined>; } & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasLibraryTransforms",
"text": "HasLibraryTransforms"
},
"<",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.MapSerializedState",
"text": "MapSerializedState"
},
"> & { getLayerList: () => ",
"ILayer",
"[]; reload: () => void; setEventHandlers: (eventHandlers: ",
"EventHandlers",
") => void; setLayerList: (layerList: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LayerDescriptor",
"text": "LayerDescriptor"
},
"[]) => void; updateLayerById: (layerDescriptor: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LayerDescriptor",
"text": "LayerDescriptor"
},
") => void; onRenderComplete$: ",
"Observable",
"<void>; }"
],
"path": "x-pack/plugins/maps/public/react_embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.MAPS_APP_LOCATOR",
"type": "string",
"tags": [],
"label": "MAPS_APP_LOCATOR",
"description": [],
"signature": [
"\"MAPS_APP_LOCATOR\""
],
"path": "x-pack/plugins/maps/public/locators/map_locator/locator_definition.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.MapSerializedState",
"type": "Type",
"tags": [],
"label": "MapSerializedState",
"description": [],
"signature": [
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.SerializedTitles",
"text": "SerializedTitles"
},
" & Partial<",
"DynamicActionsSerializedState",
"> & { attributes?: ",
"MapAttributes",
" | undefined; savedObjectId?: string | undefined; isLayerTOCOpen?: boolean | undefined; openTOCDetails?: string[] | undefined; mapCenter?: ",
"MapCenterAndZoom",
" | undefined; mapBuffer?: ",
"MapExtent",
" | undefined; mapSettings?: Partial<",
"MapSettings",
"> | undefined; hiddenLayers?: string[] | undefined; hideFilterActions?: boolean | undefined; timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; filterByMapExtent?: boolean | undefined; isMovementSynchronized?: boolean | undefined; isSharable?: boolean | undefined; tooltipRenderer?: ",
"RenderToolTipContent",
" | undefined; }"
],
"path": "x-pack/plugins/maps/public/react_embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.RenderWizardArguments",
"type": "Type",
"tags": [],
"label": "RenderWizardArguments",
"description": [],
"signature": [
"{ previewLayers: (layerDescriptors: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LayerDescriptor",
"text": "LayerDescriptor"
},
"[]) => void; mapColors: string[]; mostCommonDataViewId?: string | undefined; currentStepId: string | null; isOnFinalStep: boolean; enableNextBtn: () => void; disableNextBtn: () => void; startStepLoading: () => void; stopStepLoading: () => void; advanceToNextStep: () => void; }"
],
"path": "x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-public.SourceEditorArgs",
"type": "Type",
"tags": [],
"label": "SourceEditorArgs",
"description": [],
"signature": [
"{ currentLayerType: string; hasSpatialJoins: boolean; numberOfJoins: number; onChange: (...args: ",
"OnSourceChangeArgs",
"[]) => Promise<void>; onStyleDescriptorChange: (styleDescriptor: ",
"StyleDescriptor",
") => void; style: ",
"IStyle",
"; }"
],
"path": "x-pack/plugins/maps/public/classes/sources/source.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "maps",
"id": "def-public.MapsSetupApi",
"type": "Interface",
"tags": [],
"label": "MapsSetupApi",
"description": [],
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.MapsSetupApi.registerLayerWizard",
"type": "Function",
"tags": [],
"label": "registerLayerWizard",
"description": [],
"signature": [
"(layerWizard: ",
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.LayerWizard",
"text": "LayerWizard"
},
") => void"
],
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.MapsSetupApi.registerLayerWizard.$1",
"type": "Object",
"tags": [],
"label": "layerWizard",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "public",
"docId": "kibMapsPluginApi",
"section": "def-public.LayerWizard",
"text": "LayerWizard"
}
],
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "maps",
"id": "def-public.MapsSetupApi.registerSource",
"type": "Function",
"tags": [],
"label": "registerSource",
"description": [],
"signature": [
"(entry: ",
"SourceRegistryEntry",
") => void"
],
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "maps",
"id": "def-public.MapsSetupApi.registerSource.$1",
"type": "Object",
"tags": [],
"label": "entry",
"description": [],
"signature": [
"SourceRegistryEntry"
],
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"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,
"trackAdoption": 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: ",
{
"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"
},
">; }"
],
"path": "x-pack/plugins/maps/public/api/start_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.Map",
"type": "Function",
"tags": [],
"label": "Map",
"description": [],
"signature": [
"React.FunctionComponent<",
"Props",
">"
],
"path": "x-pack/plugins/maps/public/api/start_api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.Map.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.Map.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.PassiveMap",
"type": "Function",
"tags": [],
"label": "PassiveMap",
"description": [],
"signature": [
"React.FunctionComponent<",
"Props",
">"
],
"path": "x-pack/plugins/maps/public/api/start_api.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.PassiveMap.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "maps",
"id": "def-public.MapsStartApi.PassiveMap.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.LABEL_POSITIONS",
"type": "Enum",
"tags": [],
"label": "LABEL_POSITIONS",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.LAYER_TYPE",
"type": "Enum",
"tags": [],
"label": "LAYER_TYPE",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.LAYER_WIZARD_CATEGORY",
"type": "Enum",
"tags": [],
"label": "LAYER_WIZARD_CATEGORY",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.SCALING_TYPES",
"type": "Enum",
"tags": [],
"label": "SCALING_TYPES",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.VECTOR_SHAPE_TYPE",
"type": "Enum",
"tags": [],
"label": "VECTOR_SHAPE_TYPE",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.VECTOR_STYLES",
"type": "Enum",
"tags": [],
"label": "VECTOR_STYLES",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "maps",
"id": "def-common.APP_ID",
"type": "string",
"tags": [],
"label": "APP_ID",
"description": [],
"signature": [
"\"maps\""
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.DataFilters",
"type": "Type",
"tags": [],
"label": "DataFilters",
"description": [],
"signature": [
"{ buffer?: ",
"MapExtent",
" | undefined; extent?: ",
"MapExtent",
" | undefined; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; embeddableSearchContext?: { query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; } | undefined; searchSessionId?: string | undefined; timeFilters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; timeslice?: ",
"Timeslice",
" | undefined; zoom: number; isReadOnly: boolean; joinKeyFilter?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
" | undefined; executionContext: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
"; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.DECIMAL_DEGREES_PRECISION",
"type": "number",
"tags": [],
"label": "DECIMAL_DEGREES_PRECISION",
"description": [],
"signature": [
"5"
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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,
"trackAdoption": 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",
"[]; } & { whereQuery?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; } & { term: string; 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.FieldFormatter",
"type": "Type",
"tags": [],
"label": "FieldFormatter",
"description": [],
"signature": [
"(value: ",
"RawValue",
") => string | number"
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "maps",
"id": "def-common.FieldFormatter.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | number | boolean | string[] | null | undefined"
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.LayerDescriptor",
"type": "Type",
"tags": [],
"label": "LayerDescriptor",
"description": [],
"signature": [
"{ __dataRequests?: ",
"DataRequestDescriptor",
"[] | undefined; __isPreviewLayer?: boolean | undefined; __trackedLayerDescriptor?: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LayerDescriptor",
"text": "LayerDescriptor"
},
" | undefined; __areTilesLoaded?: boolean | undefined; __tileMetaFeatures?: ",
"TileMetaFeature",
"[] | undefined; __tileErrors?: ",
"TileError",
"[] | undefined; alpha?: number | undefined; attribution?: ",
"Attribution",
" | undefined; id: string; label?: string | null | undefined; locale?: 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?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; includeInFitToBounds?: boolean | undefined; parent?: string | undefined; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.MAX_ZOOM",
"type": "number",
"tags": [],
"label": "MAX_ZOOM",
"description": [],
"signature": [
"24"
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.MIN_ZOOM",
"type": "number",
"tags": [],
"label": "MIN_ZOOM",
"description": [],
"signature": [
"0"
],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.TooltipFeature",
"type": "Type",
"tags": [],
"label": "TooltipFeature",
"description": [],
"signature": [
"{ id?: string | number | undefined; layerId: string; geometry?: GeoJSON.Geometry | undefined; mbProperties: GeoJSON.GeoJsonProperties; actions: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.TooltipFeatureAction",
"text": "TooltipFeatureAction"
},
"[]; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/map_descriptor.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.TooltipFeatureAction",
"type": "Type",
"tags": [],
"label": "TooltipFeatureAction",
"description": [],
"signature": [
"{ label: string; id: string; form?: React.ReactNode; onClick?: (() => void) | undefined; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/map_descriptor.ts",
"deprecated": false,
"trackAdoption": 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"
},
" & { type: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LAYER_TYPE",
"text": "LAYER_TYPE"
},
".GEOJSON_VECTOR | ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LAYER_TYPE",
"text": "LAYER_TYPE"
},
".BLENDED_VECTOR | ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.LAYER_TYPE",
"text": "LAYER_TYPE"
},
".MVT_VECTOR; joins?: Partial<",
"JoinDescriptor",
">[] | undefined; style: ",
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.VectorStyleDescriptor",
"text": "VectorStyleDescriptor"
},
"; disableTooltips?: boolean | undefined; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "maps",
"id": "def-common.VectorSourceRequestMeta",
"type": "Type",
"tags": [],
"label": "VectorSourceRequestMeta",
"description": [],
"signature": [
{
"pluginId": "maps",
"scope": "common",
"docId": "kibMapsPluginApi",
"section": "def-common.DataFilters",
"text": "DataFilters"
},
" & { applyGlobalQuery: boolean; applyGlobalTime: boolean; applyForceRefresh: boolean; sourceQuery?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; isForceRefresh: boolean; } & { fieldNames: string[]; timesliceMaskField?: string | undefined; sourceMeta: object | null; isFeatureEditorOpenForLayer: boolean; }"
],
"path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink