Interface BasemapConfigParser

parse

• parse(
      config:
          | string
          | BasemapConfigObject
          | LayerProperties
          | LayerProperties[],
      options?: BasemapProperties,
  ): Promise<{ instance: Basemap }>

  Parses a basemap configuration.

  Parameters

  • config: string | BasemapConfigObject | LayerProperties | LayerProperties[]

    See examples.
  • Optionaloptions: BasemapProperties

    Additional properties that will be merged into the basemap instance, e.g. title.

  Returns Promise<{ instance: Basemap }>

  A promise which resolves to {instance: basemap}.

  Example

  // string of well-known basemap
  const result = await configParser.parse("streets", { title: 'Streets' });
  // result instance is @arcgis/core/Basemap, the well-known streets basemap, with custom title
  Copy

  Example

  // string of well-known basemap
  const result = await configParser.parse({ id: "streets" });
  // result instance is @arcgis/core/Basemap, the well-known streets basemap
  Copy

  Example

  // config object with custom layer
  const result = await configParser.parse({
    title: "My Basemap",
    baseLayers: [{
      "url": "https://myarcgis.com/arcgis/rest/services/MyService/MapServer",
      "type": "AGS_TILED"
    }]
  });
  // result instance is @arcgis/core/Basemap, with a custom layer
  Copy

  Example

  // config object with custom layer, but shorter
  const result = await configParser.parse({
    "url": "https://myarcgis.com/arcgis/rest/services/MyService/MapServer",
    "type": "AGS_TILED"
  })
  // result instance is @arcgis/core/Basemap, with a custom layer
  Copy

  Example

  // config object with custom layers, but shorter
  const result = await configParser.parse([{
    "url": "https://myarcgis.com/arcgis/rest/services/MyService/MapServer",
    "type": "AGS_TILED"
  },
  {
    "url": "https://myarcgis.com/arcgis/rest/services/OtherService/MapServer",
    "type": "AGS_TILED"
  }])
  // result instance is @arcgis/core/Basemap, with two custom layers
  Copy