@razi91/types-ol-ext/interaction/Split.d.ts

Type definitions for ol-ext

import { Map as _ol_Map_ } from 'ol';
import Collection from 'ol/Collection';
import { Coordinate } from 'ol/coordinate';
import Feature from 'ol/Feature';
import { Style } from 'ol/style';
import { Interaction } from 'ol/interaction';
import MapBrowserEvent from 'ol/MapBrowserEvent';

export interface Options {
    features: Collection<Feature>;
    snapDistance: number;
    cursor: string | undefined;
    sketchStyle: Style | Style[] | undefined;
    tolerance: ((...params: any[]) => number) | undefined;
}
/** Interaction split interaction for splitting feature geometry
 * @constructor
 * @extends {Interaction}
 * @fires  beforesplit, aftersplit, pointermove
 * @param {*}
 *  @param {VectorSource|Array{VectorSource}} options.source a list of source to split (configured with useSpatialIndex set to true)
 *  @param {Collection.<Feature>} options.features collection of feature to split
 *  @param {number} options.snapDistance distance (in px) to snap to an object, default 25px
 *	@param {string|undefined} options.cursor cursor name to display when hovering an objet
 *  @param {function|undefined} opttion.filter a filter that takes a feature and return true if it can be clipped, default always split.
 *  @param Style | Array<Style> | false | undefined} options.featureStyle Style for the selected features, choose false if you don't want feature selection. By default the default edit style is used.
 *  @param {Style | Array<Style> | undefined} options.sketchStyle Style for the sektch features.
 *  @param {function|undefined} options.tolerance Distance between the calculated intersection and a vertex on the source geometry below which the existing vertex will be used for the split.  Default is 1e-10.
 */
export default class Split extends Interaction {
    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;
    /** Get nearest coordinate in a list
    * @param {Coordinate} pt the point to find nearest
    * @param {Array<Coordinate>} coords list of coordinates
    * @return {Coordinate} the nearest coordinate in the list
     */
    getNearestCoord(pt: Coordinate, coords: Coordinate[]): Coordinate;
    /**
     * @param {MapBrowserEvent} evt Map browser event.
     * @return {boolean} `true` to start the drag sequence.
     */
    handleDownEvent(evt: MapBrowserEvent): boolean;
    /**
     * @param {MapBrowserEvent} evt Event.
     */
    handleMoveEvent(evt: MapBrowserEvent): void;
}