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

Type definitions for ol-ext

import type { Map as _ol_Map_ } from 'ol'
import type Feature from 'ol/Feature'
import type { Layer } from 'ol/layer'
import type { StyleLike } from 'ol/style/Style'
import type { Options as DrawOptions } from 'ol/interaction/Draw'
import Draw from 'ol/interaction/Draw'
import type Collection from 'ol/Collection'
import type { EventsKey } from 'ol/events'
import type { ModifyEvent } from 'ol/interaction/Modify'
import type { ObjectEvent } from 'ol/Object'
import type { CombinedOnSignature, EventTypes, OnSignature } from 'ol/Observable'
import type { Types } from 'ol/ObjectEventType'
import type VectorLayer from 'ol/layer/Vector'
import type VectorSource from 'ol/source/Vector'
import type { Geometry, Polygon } from 'ol/geom'
import type { DrawEvent } from './DrawRegular'

type DrawHoleOnSignature<Return> = OnSignature<EventTypes, Event, Return> &
  OnSignature<Types | 'change' | 'change:active' | 'error' | 'propertychange', ObjectEvent, Return> &
  OnSignature<Types | 'drawabort' | 'drawend' | 'drawstart', DrawEvent, Return> &
  OnSignature<Types | 'modifyend' | 'modifystart', ModifyEvent, Return> &
  CombinedOnSignature<Types | EventTypes | 'change' | 'change:active' | 'error' | 'propertychange' | 'drawabort' | 'drawend' | 'drawstart' | 'modifyend' | 'modifystart', Return>;

export interface Options extends DrawOptions {
  layers?: VectorLayer<VectorSource<Feature<Geometry>>>[] | ((l: Layer) => boolean);
  featureFilter?: Feature[] | Collection<Feature> | ((feature: Feature, layer: Layer) => boolean);
  style?: StyleLike;
}

/** Interaction to draw holes in a polygon.
 * It fires a drawstart, drawend event when drawing the hole
 * and a modifystart, modifyend event before and after inserting the hole in the feature geometry.
 * @constructor
 * @extends {ol_interaction_Interaction}
 * @fires drawstart
 * @fires drawend
 * @fires modifystart
 * @fires modifyend

 */
export default class DrawHole extends Draw {
  /**
   * @param {Options} options extend olx.interaction.DrawOptions
   *  @param {Array<VectorLayer> | function | undefined} options.layers A list of layers from which polygons should be selected. Alternatively, a filter function can be provided. default: all visible layers
   *  @param {Array<Feature> | Collection<Feature> | function | undefined} options.featureFilter An array or a collection of features the interaction applies on or a function that takes a feature and a layer and returns true if the feature is a candidate
   *  @param { Style | Array<Style> | StyleFunction | undefined }  Style for the selected features, default: default edit style
   */
  constructor(options?: Options);

  /**
   * Remove the interaction from its current map, if any,  and attach it to a new
   * map, if any. Pass `null` to just remove the interaction from the current map.
   * @param {Map} map Map.
   * @api stable
   */
  setMap(map: _ol_Map_): void;

  /**
   * Activate/deactivate the interaction
   * @param {boolean}
   * @api stable
   */
  setActive(b: boolean): void;

  /**
   * Remove last point of the feature currently being drawn
   * (test if points to remove before).
   */
  removeLastPoint(): void;

  /**
   * Get the current polygon to hole
   * @return {Polygon}
   */
  getPolygon(): Polygon;

  on: DrawHoleOnSignature<EventsKey>

  once: DrawHoleOnSignature<EventsKey>

  un: DrawHoleOnSignature<void>
}