RasterData | References | ArcGIS Maps SDK for JavaScript

import RasterData from "@arcgis/core/rest/support/RasterData.js";

Inheritance:: RasterData→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

A geoprocessing data type representing raster data file or service.

See also

Geoprocessing Data Types | GPRasterDataLayer

Example

// Create a new RasterData object representing a tif image.
const rasterData = new RasterData({
  url: "https://myserver/lake.tif"
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RasterDataProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`format` readonly	`string \| null \| undefined`
`itemId`	`string \| null \| undefined`
`type` readonly	`RasterDataType \| null \| undefined`
`url`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

format

readonly Property

Type: string | null | undefined

The image type (e.g. "jpg" or "tif") when this data type references an image.

Example

const parameterValue = await jobInfo.fetchResultData("Output_TIF_GDB");
console.log(parameterValue.dataType); // "raster-data-layer"

const rasterData = parameterValue.value;
console.log(rasterData.url);    // "https://machine.domain.com/webadaptor/rest/directories/arcgisoutput/GPServer/_ags_africa_150m.tif"
console.log(rasterData.format); // "tif"

itemId

Property

Type: string | null | undefined

The ID of the portal item containing the raster data file or service.

Example

const rasterData = new RasterData({
  itemId: "my-portal-item-id"
});

type

readonly Property

Type: RasterDataType | null | undefined

When the output data type is an image service, this property will return image-service.

Example

const rasterData = parameterValue.value;
const { url, format, type } = rasterData;
if (url) {
  if (type === "image-service") {
    console.log(`The url to the image service is: ${url}`);
  else {
    console.log(`The url to the raster data file is: ${url}`);
    console.log(`The raster data file is a ${format} image`);
  }
}

url

Property

Type: string | null | undefined

The URL to the raster data file or image service.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

Type definitions

RasterDataType

Type definition

When the output data type is an image service.

See also

type

Type: "image-service"