Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: DashboardResult
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/datareviewer/DashboardResult"], function(DashboardResult) { /* code goes here */ });
Description
(Added at v3.14)
Encapsulates data describing a Dashboard Result. This includes arrays that contain unique field values, counts of those field values, and ReviewerFilters.
Instances of this class are returned in the deferred object of the
getDashboardResults operation and in the DashboardTask's onGetDashboardResultsComplete event.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| counts | Array | Array of reviewer result field value counts. |
| fieldName | String | Name of the reviewer results field. |
| fieldValues | Array | Array of reviewer results field values. |
| filters | ReviewerFilters | An instance of ReviewerFilters class. |
Methods
| Name | Return type | Summary |
|---|---|---|
| getCount(fieldValue) | Number | Gets the result count for a field value. |
Property Details
<Array
ArrayArray of reviewer result field value counts. Counts are a summary of unique field values in a field.
<String
StringName of the reviewer results field. This is the field name used in the
getDashboardResults function of the DashboardTask class.<Array
ArrayArray of reviewer results field values.
<ReviewerFilters
ReviewerFiltersAn instance of
ReviewerFilters class. Filters limit or precisely define which dashboard results to generate. You can apply multiple filters to a single request.Method Details
Gets the result count for a field value.
Return type:
NumberSample:
// Converts DashboardResults into an array of key-value pairs to use in a dojo chart.
var url="http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/";
var dashboardTask=new DashboardTask(url);
var deferred=dashboardTask.getDashboardResults("FEATUREOBJECTCLASS");
//Deferred callback and errback function
deferred.then(function(response)
{
var mappedArray=[];
array.forEach(response.dashboardResult.fieldValues, function (item,i)
{
mappedArray.push({
text:"FEATUREOBJECTCLASS " + item,
y:response.dashboardResult.getCount(item)});
});
// now use the mappedArray in the dojo chart addSeries function
}, function(error){
Alert("Error ocurred: " + error.message);
});