DataFile

AMD: require(["esri/tasks/support/DataFile"], (DataFile) => { /* code goes here */ });
ESM: import DataFile from "@arcgis/core/tasks/support/DataFile";
Class: esri/tasks/support/DataFile
Inheritance: DataFile Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use DataFile instead.

A geoprocessing data object containing a data source.

See also:
Example:
require([
 "esri/tasks/Geoprocessor", "esri/tasks/support/DataFile", ...
], function(Geoprocessor, DataFile, ... ) {
let gp = new Geoprocessor( ... );
 function requestSucceeded(result) {
   let itemID = result.item.itemID;
   let dataFile = new DataFile();
   dataFile.itemID = itemID;
   let params = {
     "Input_File": dataFile
   };
   gp.execute(params).then(function(gpResult){
     ...
   });
 }
});

Constructors

new DataFile(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The ID of the uploaded file returned as a result of the upload operation.

more detailsDataFile
Stringmore details

URL to the location of the data file.

more detailsDataFile

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

itemId String

The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater services that support uploads, this class can be used to specify an uploaded item as input by specifying the itemID.

url String

URL to the location of the data file.

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsDataFile
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsDataFile

Method Details

fromJSON(json){*}static

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.

Parameter:
json Object

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.