geolocation-8.x-3.x-dev/js/WidgetSubscriber/WidgetSubscriberBase.js

/**
 * @prop {GeolocationWidgetBroker} broker
 */

/**
 * @abstract
 *
 * @prop {String} id
 * @prop {Object} settings
 * @prop {int} settings.cardinality
 * @prop {String} settings.fieldName
 */
export class WidgetSubscriberBase {
  constructor(broker, settings) {
    this.broker = broker;
    this.settings = settings;
  }

  initialize() {}

  /**
   * @param {Number[]} newOrder
   *   New order.
   * @param {String} source
   *   Source.
   */
  reorder(newOrder, source) {}

  /**
   * @param {GeolocationCoordinates} coordinates
   *   Coordinates.
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  addCoordinates(coordinates, index, source) {}

  /**
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  removeCoordinates(index, source) {}

  /**
   * @param {GeolocationCoordinates} coordinates
   *   Coordinates.
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  alterCoordinates(coordinates, index, source) {}

  /**
   * @param {GeolocationGeometry} geometry
   *   Shape.
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  addGeometry(geometry, index, source) {}

  /**
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  removeGeometry(index, source) {}

  /**
   * @param {GeolocationGeometry} geometry
   *   Shape.
   * @param {Number} index
   *   Index.
   * @param {String} source
   *   Source.
   */
  alterGeometry(geometry, index, source) {}
}