@siedlerchr/types-ol-ext/interaction/Delete.d.ts

Type definitions for ol-ext

import type Collection from 'ol/Collection'
import type { EventsKey } from 'ol/events'
import type Feature from 'ol/Feature'
import { Select } from 'ol/interaction'
import type { ObjectEvent } from 'ol/Object'
import BaseEvent from 'ol/events/Event'
import type { Condition } from 'ol/events/condition'
import type { Geometry } from 'ol/geom'
import type { FilterFunction, SelectEvent } from 'ol/interaction/Select'
import type { Layer } from 'ol/layer'
import type { Source } from 'ol/source'
import type { StyleLike } from 'ol/style/Style'
import type { CombinedOnSignature, EventTypes, OnSignature } from 'ol/Observable'
import type { Types } from 'ol/ObjectEventType'

type DeleteOnSignature<Return> = OnSignature<EventTypes, Event, Return> &
  OnSignature<Types | 'change' | 'change:active' | 'error' | 'propertychange', ObjectEvent, Return> &
  OnSignature<Types | 'select', SelectEvent, Return> &
  OnSignature<Types | 'deletestart' | 'deleteend', DeleteEvent, Return> &
  CombinedOnSignature<Types | EventTypes | 'change' | 'change:active' | 'error' | 'propertychange' | 'select' | 'deletestart' | 'deleteend', Return>;

export interface Options {
  addCondition?: Condition;
  condition?: Condition;
  layers?: Layer<Source>[] | ((p0: Layer<Source>) => boolean);
  style?: StyleLike;
  removeCondition?: Condition;
  toggleCondition?: Condition;
  multi?: boolean;
  features?: Collection<Feature<Geometry>>;
  filter?: FilterFunction;
  hitTolerance?: number;
}

export enum DeleteEventType {
  DELETESTART = 'deletestart',
  DELETEEND = 'deleteend'
}

/** A Select interaction to delete features on click.
 * @constructor
 * @extends {Interaction}
 * @fires deletestart
 * @fires deleteend
 */
export default class Delete extends Select {
  /**
   * @param {*} options interaction.Select options
   */
  constructor(options?: Options);

  /** Delete features: remove the features from the map (from all layers in the map)
   * @param {Collection<Feature>|Array<Feature>} features The features to delete
   * @api
   */
  delete(features: Collection<Feature> | Feature[]): void;

  on: DeleteOnSignature<EventsKey>

  once: DeleteOnSignature<EventsKey>

  un: DeleteOnSignature<void>
}

export class DeleteEvent extends BaseEvent {
  constructor(
    type: DeleteEventType,
    features: Collection<Feature<Geometry>>[] | Feature<Geometry>[]
  );

  features: Collection<Feature<Geometry>>[] | Feature<Geometry>[]
}