predominantCategories

import predominantCategories from "@arcgis/core/smartMapping/statistics/predominantCategories.js";

Since: ArcGIS Maps SDK for JavaScript 4.13

Function for generating category statistics for a predominance renderer.

Functions

Function

Determines predominant categories for a layer based on a given set of competing numeric fields and returns the number of features belonging to each category.

Signature: predominantCategories (parameters: PredominantCategoriesParameters): Promise<PredominantCategoriesResult>

Parameters

Parameter	Type	Description	Required
parameters	`PredominantCategoriesParameters`	The function parameters.

Returns: Promise<PredominantCategoriesResult>
Returns a promise that resolves to PredominantCategoriesResult.

Example

predominantCategories({
  layer: featureLayer,
  fields: [ "corn_acres", "cotton_acres", "wheat_acres", "soybeans_acres", "vegetables_acres" ],
  view: mapView
}).then(function(stats){
  console.log(stats.predominantCategoryInfos);
});