kibana/api_docs/maps_legacy.json

{
  "id": "mapsLegacy",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [
      {
        "id": "def-server.MapsLegacyPlugin",
        "type": "Class",
        "tags": [],
        "label": "MapsLegacyPlugin",
        "description": [],
        "signature": [
          {
            "pluginId": "mapsLegacy",
            "scope": "server",
            "docId": "kibMapsLegacyPluginApi",
            "section": "def-server.MapsLegacyPlugin",
            "text": "MapsLegacyPlugin"
          },
          " implements ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCorePluginApi",
            "section": "def-server.Plugin",
            "text": "Plugin"
          },
          "<",
          {
            "pluginId": "mapsLegacy",
            "scope": "server",
            "docId": "kibMapsLegacyPluginApi",
            "section": "def-server.MapsLegacyPluginSetup",
            "text": "MapsLegacyPluginSetup"
          },
          ", void, object, object>"
        ],
        "children": [
          {
            "tags": [],
            "id": "def-server.MapsLegacyPlugin._initializerContext",
            "type": "Object",
            "label": "_initializerContext",
            "description": [],
            "source": {
              "path": "src/plugins/maps_legacy/server/index.ts",
              "lineNumber": 36
            },
            "signature": [
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCorePluginApi",
                "section": "def-server.PluginInitializerContext",
                "text": "PluginInitializerContext"
              },
              "<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
            ]
          },
          {
            "id": "def-server.MapsLegacyPlugin.Unnamed",
            "type": "Function",
            "label": "Constructor",
            "signature": [
              "any"
            ],
            "description": [],
            "children": [
              {
                "type": "Object",
                "label": "initializerContext",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.PluginInitializerContext",
                    "text": "PluginInitializerContext"
                  },
                  "<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
                ],
                "description": [],
                "source": {
                  "path": "src/plugins/maps_legacy/server/index.ts",
                  "lineNumber": 38
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "src/plugins/maps_legacy/server/index.ts",
              "lineNumber": 38
            }
          },
          {
            "id": "def-server.MapsLegacyPlugin.setup",
            "type": "Function",
            "label": "setup",
            "signature": [
              "(core: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCorePluginApi",
                "section": "def-server.CoreSetup",
                "text": "CoreSetup"
              },
              "<object, unknown>) => { config: Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
            ],
            "description": [],
            "children": [
              {
                "type": "Object",
                "label": "core",
                "isRequired": true,
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCorePluginApi",
                    "section": "def-server.CoreSetup",
                    "text": "CoreSetup"
                  },
                  "<object, unknown>"
                ],
                "description": [],
                "source": {
                  "path": "src/plugins/maps_legacy/server/index.ts",
                  "lineNumber": 42
                }
              }
            ],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "src/plugins/maps_legacy/server/index.ts",
              "lineNumber": 42
            }
          },
          {
            "id": "def-server.MapsLegacyPlugin.start",
            "type": "Function",
            "label": "start",
            "signature": [
              "() => void"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "src/plugins/maps_legacy/server/index.ts",
              "lineNumber": 51
            }
          }
        ],
        "source": {
          "path": "src/plugins/maps_legacy/server/index.ts",
          "lineNumber": 35
        },
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [
      {
        "id": "def-server.MapsLegacyPluginSetup",
        "type": "Interface",
        "label": "MapsLegacyPluginSetup",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.MapsLegacyPluginSetup.config",
            "type": "Object",
            "label": "config",
            "description": [],
            "source": {
              "path": "src/plugins/maps_legacy/server/index.ts",
              "lineNumber": 32
            },
            "signature": [
              "Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>"
            ]
          }
        ],
        "source": {
          "path": "src/plugins/maps_legacy/server/index.ts",
          "lineNumber": 31
        },
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "tags": [],
        "id": "def-common.DEFAULT_EMS_FILE_API_URL",
        "type": "string",
        "label": "DEFAULT_EMS_FILE_API_URL",
        "description": [],
        "source": {
          "path": "src/plugins/maps_legacy/common/ems_defaults.ts",
          "lineNumber": 10
        },
        "signature": [
          "\"https://vector.maps.elastic.co\""
        ],
        "initialIsOpen": false
      },
      {
        "tags": [],
        "id": "def-common.DEFAULT_EMS_FONT_LIBRARY_URL",
        "type": "string",
        "label": "DEFAULT_EMS_FONT_LIBRARY_URL",
        "description": [],
        "source": {
          "path": "src/plugins/maps_legacy/common/ems_defaults.ts",
          "lineNumber": 13
        },
        "signature": [
          "\"https://tiles.maps.elastic.co/fonts/{fontstack}/{range}.pbf\""
        ],
        "initialIsOpen": false
      },
      {
        "tags": [],
        "id": "def-common.DEFAULT_EMS_LANDING_PAGE_URL",
        "type": "string",
        "label": "DEFAULT_EMS_LANDING_PAGE_URL",
        "description": [],
        "source": {
          "path": "src/plugins/maps_legacy/common/ems_defaults.ts",
          "lineNumber": 12
        },
        "signature": [
          "\"https://maps.elastic.co/v7.12\""
        ],
        "initialIsOpen": false
      },
      {
        "tags": [],
        "id": "def-common.DEFAULT_EMS_TILE_API_URL",
        "type": "string",
        "label": "DEFAULT_EMS_TILE_API_URL",
        "description": [],
        "source": {
          "path": "src/plugins/maps_legacy/common/ems_defaults.ts",
          "lineNumber": 11
        },
        "signature": [
          "\"https://tiles.maps.elastic.co\""
        ],
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}