@siedlerchr/types-ol-ext/source/FeatureBin.d.ts

Type definitions for ol-ext

import type { Coordinate } from 'ol/coordinate'
import type Feature from 'ol/Feature'
import type { Point, Polygon } from 'ol/geom'
import type VectorSource from 'ol/source/Vector'
import { BinBase } from './BinBase'

export interface Options {
  source?: VectorSource;
  binSource?: VectorSource;
  features?: Feature[];
  size?: number;
  geometryFunction?: (f: Feature) => Point;
  flatAttributes?: (bin: Feature, features: Feature[]) => void;
}

/** A source that use a set of feature to collect data on it.
 * If a binSource is provided the bin is recalculated when features change.
 * @constructor
 * @extends {ol_source_BinBase}

 *
 */
export default class FeatureBin extends BinBase {
  /**
   * @param {Object} options ol_source_VectorOptions + grid option
   *  @param {ol.source.Vector} options.source source to collect in the bin
   *  @param {ol.source.Vector} options.binSource a source to use as bin collector, default none
   *  @param {Array<ol.Feature>} options.features the features, ignored if binSource is provided, default none
   *  @param {number} [options.size] size of the grid in meter, default 200m
   *  @param {function} [options.geometryFunction] Function that takes an ol.Feature as argument and returns an ol.geom.Point as feature's center.
   *  @param {function} [options.flatAttributes] Function takes a bin and the features it contains and aggragate the features in the bin attributes when saving
   */
  constructor(options: Options);

  /** Set features to use as bin collector
   * @param features
   */
  setFeatures(features: Feature): void;

  /** Get the grid geometry at the coord
   * @param {Coordinate} coord
   * @returns {Polygon}
   * @api
   */
  getGridGeomAt(coord: Coordinate): Polygon;

  /** Overwrite Vector clear to fire clearstart / clearend event
   */
  clear(): void;
}