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

Type definitions for ol-ext

import type { Map as _ol_Map_, MapBrowserEvent } from 'ol'
import { Pointer } from 'ol/interaction'

export interface Delta {
  dpixel: number[];
  traction: number[];
}

export interface Options {
  onDrag?: (delta: Delta, pos: MapBrowserEvent<UIEvent>) => void; // TODO not sure
  Size?: number;
  alpha?: number;
}

/** Interaction splitter: acts as a split feature agent while editing vector features (LineString).
 * @constructor
 * @extends {interaction.Pointer}
 */
export default class TouchCompass extends Pointer {
  /**
   * @param {olx.interaction.TouchCompass} options
   *  - onDrag {function|undefined} Function handling "drag" events. It provides a dpixel and a traction (in projection) vector form the center of the compas
   *  - Size {Number} Size of the compass in px, default 80
   *  - alpha {Number} opacity of the compass, default 0.5
   */
  constructor(options?: Options);

  /** Compass Image as a JS Image object
   * @api
   */
  compass: HTMLImageElement // not sure

  /**
   * 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 {_ol_Map_} map Map.
   * @api stable
   */
  setMap(map: _ol_Map_): void;

  /**
   * Activate or deactivate the interaction.
   * @param {boolean} active Active.
   * @observable
   * @api
   */
  setActive(active: boolean): void;
}