Interface GroundConfigParser

parse

• parse(
      config: string | ElevationLayerProperties[] | GroundProperties,
  ): Promise<{ instance: Ground }>

  Parses ground layer configurations.

  Parameters

  • config: string | ElevationLayerProperties[] | GroundProperties

    Configurations for the ground layer.

  Returns Promise<{ instance: Ground }>

  A promise which resolves to { instance : groundlayer {.

  Example

  // well known ground name
  configParser.parse("world-elevation").then((result) => {
    // result.instance is @arcgis/core/Ground
  });
  Copy

  Example

  // array of elevation layers
  configParser.parse([{
    "url": "http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer",
    "type": "AGS_ELEVATION"
  }]).then((result) => {
    // result.instance is @arcgis/core/Ground
  });
  Copy

  Example

  // ground config object, the only way to add additional properties, like "title"
  configParser.parse({
    title: "My Ground Name",
    layers: [{
      "url": "http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer",
      "type": "AGS_ELEVATION"
    }, {
      "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Elevation/MtBaldy_Elevation/ImageServer",
      "type": "AGS_ELEVATION"
    }]
  }).then((result) => {
    // result.instance is @arcgis/core/Ground
  });
  Copy