ui_utils_locationCount.mjs

/**
### /ui/utils/locationCount
Exports the default locationCount utility method as mapp.ui.utils.locationCount().

@module /ui/utils/locationCount
*/

/**
@function locationCount

@description
Returns the length of the layer.Features[] array or the response from a layer_count query.

The layer.Features[] array length is returned if the filter is not restricted to the viewport, or if the layer features have been loaded for the viewport. Cluster layer features are not counted as locations.
@param {layer} layer
@property {String} layer.key The layers' identifier.
@property {String} layer.format The layer format.
@property {Object} layer.filter The filter currently active on the layer.
@property {Object} [layer.params] The parameters for the layer data query.
@property {Object} layer.mapview The mapview associated to the layer.
@property {Object} [layer.queryparams] The query parameters that are being used on the layer.

@returns {Integer} The number of locations that pass the filter.
*/
export default async function locationCount(layer) {
  // The Features array can be counted if the features are not required to be restricted to the viewport, or if the features have been loaded for the viewport.
  // Cluster features must not be counted as locations.
  if (
    Array.isArray(layer.Features) &&
    layer.format !== 'cluster' &&
    (!layer.filter?.viewport || layer.params?.viewport)
  ) {
    return layer.Features.length;
  }

  //Whether or not to use the viewport in the query
  const options = {
    layer: layer,
    queryparams: {},
  };

  options.viewport = layer.filter?.viewport;

  const params = mapp.utils.queryParams(options);

  const paramString = mapp.utils.paramString({
    ...params,
    filter: layer.filter?.current,
    layer: layer.key,
    table: layer.tableCurrent(),
    geom: layer.geomCurrent(),
    qID: layer.qID,
    template: 'location_count',
  });

  const feature_count = await mapp.utils.xhr(
    `${layer.mapview.host}/api/query?${paramString}`,
  );

  if (feature_count instanceof Error) {
    if (layer.filter?.viewport) {
      console.warn('locationCount failed on viewport.');
      return;
    } else {
      layer.filter.viewport = true;
      return await locationCount(layer);
    }
  }

  return feature_count;
}