@siedlerchr/types-ol-ext/control/EditBar.d.ts

Type definitions for ol-ext

import type { Collection, Feature, Map as _ol_Map_ } from 'ol'
import type ol_control_Control from 'ol/control/Control'
import type { Vector as VectorSource } from 'ol/source'
import type Event from 'ol/events/Event'
import type { Interaction, Select, Draw } from 'ol/interaction'
import type { EventsKey } from 'ol/events'
import BaseEvent from 'ol/events/Event'
import type { ObjectEvent } from 'ol/Object'
import type { Geometry } from 'ol/geom'
import type { CombinedOnSignature, EventTypes, OnSignature } from 'ol/Observable'
import type { Types } from 'ol/ObjectEventType'
import Bar from './Bar'
import type { position } from './control'
import type Delete from '../interaction/Delete'
import type ModifyFeature from '../interaction/ModifyFeature'
import type DrawRegular from '../interaction/DrawRegular'
import type Transform from '../interaction/Transform'
import type Split from '../interaction/Split'
import type Offset from '../interaction/Offset'

type EditBarOnSignature<Return> = OnSignature<EventTypes, Event, Return> &
  OnSignature<Types | 'change' | 'error' | 'propertychange', ObjectEvent, Return> &
  OnSignature<Types | 'info', InfoEvent, Return> &
  CombinedOnSignature<EventTypes | Types | 'change' | 'error' | 'propertychange' | 'info', Return>;

export enum EditBarEventType {
  INFO = 'info',
}

export interface DrawRegularInit {
  title?: string;
  ptsLabel?: string;
  circleLabel?: string;
}

export interface Interactions {
  Select?: Select | string | boolean;
  Delete?: Delete | boolean;
  Info?: boolean; // no real interaction
  DrawPoint?: Draw | string | boolean;
  DrawLine?: Draw | string | boolean;
  DrawPolygon?: Draw | string | boolean;
  DrawRegular?: DrawRegular | string | boolean | DrawRegularInit;
  ModifySelect?: ModifyFeature | boolean;
  Transform?: Transform | boolean;
  Split?: Split | boolean;
  Offset?: Offset | boolean;
}

export interface Options {
  className?: string;
  target?: string;
  edition?: boolean;
  interactions?: Interactions; // TODO dig deeper into the type system
  source?: VectorSource | null;
}

/** Control bar for editing in a layer
 * @constructor
 * @extends {contrBar}
 * @fires info
 */
export default class EditBar extends Bar {
  /**
   * @param {Object=} options Control options.
   *  @param {String} options.className class of the control
   *  @param {String} options.target Specify a target if you want the control to be rendered outside of the map's viewport.
   *  @param {boolean} options.edition false to remove the edition tools, default true
   *  @param {Object} options.interactions List of interactions to add to the bar
   *    ie. Select, Delete, Info, DrawPoint, DrawLine, DrawPolygon
   *    Each interaction can be an interaction or true (to get the default one) or false to remove it from bar
   *  @param {VectorSource} options.source Source for the drawn features.
   */
  constructor(options?: Options);

  /**
   * Set the map instance the control is associated with
   * and add its controls associated to this map.
   * @param {_ol_Map_} map The map instance.
   */
  setMap(map: _ol_Map_): void;

  /** Get an interaction associated with the bar
   * @param {string} name
   */
  getInteraction(name: string): Interaction;

  /** Set the control visibility
   * @param {boolean} b
   */
  setVisible(b: boolean): void;

  /** Get the control visibility
   * @return {boolean} b
   */
  getVisible(): boolean;

  /** Get controls in the panel
   *  @param {Array<_ol_control_>}
   */
  getControls(): ol_control_Control[];

  /** Set tool bar position
   *  @param {top|left|bottom|right} pos
   */
  setPosition(pos: position): void;

  /** Add a control to the bar
   *  @param {_ol_control_} c control to add
   */
  addControl(c: ol_control_Control): void;

  /** Deativate all controls in a bar
   * @param {_ol_control_} except a control
   */
  deactivateControls(except: ol_control_Control): void;

  /** Auto activate/deactivate controls in the bar
   * @param {boolean} b activate/deactivate
   */
  setActive(b: boolean): void;

  /** Post-process an activated/deactivated control
   *  @param {event} e :an object with a target {_ol_control_} and active flag {bool}
   */
  onActivateControl_(e: Event): void;

  /**
   * @param {string} name of the control to search
   * @return {contrControl}
   */
  getControlsByName(name: string): ol_control_Control;

  on: EditBarOnSignature<EventsKey>

  once: EditBarOnSignature<EventsKey>

  un: EditBarOnSignature<void>
}

export class InfoEvent extends BaseEvent {
  constructor(type: EditBarEventType, features: Collection<Feature<Geometry>>);

  features: Collection<Feature<Geometry>>
}