@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
24 lines (23 loc) • 1.13 kB
TypeScript
/**
* Function for generating category statistics for a [predominance](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/predominance/)
* renderer.
*
* @since 4.13
*/
import type { PredominantCategoriesParameters, PredominantCategoriesResult } from "./types.js";
/**
* 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.
*
* @param parameters - The function parameters.
* @returns Returns a promise that resolves to [PredominantCategoriesResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#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);
* });
*/
export default function predominantCategories(parameters: PredominantCategoriesParameters): Promise<PredominantCategoriesResult>;