DataFile
require(["esri/tasks/support/DataFile"], function(DataFile) { /* code goes here */ });
esri/tasks/support/DataFile
A geoprocessing data object containing a data source.
- See also:
require([
"esri/tasks/Geoprocessor", "esri/tasks/support/DataFile", ...
], function(Geoprocessor, DataFile, ... ) {
var gp = new Geoprocessor( ... );
function requestSucceeded(result) {
var itemID = result.item.itemID;
var dataFile = new DataFile();
dataFile.itemID = itemID;
var params = {
"Input_File": dataFile
};
gp.execute(params).then(function(gpResult){
...
});
}
});
Constructors
- new DataFile(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | The ID of the uploaded file returned as a result of the upload operation. more details | more details | DataFile | |
String | URL to the location of the data file. more details | more details | DataFile |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- itemIdString
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.
- urlString
URL to the location of the data file.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
* | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | DataFile | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | DataFile |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.