@siedlerchr/types-ol-ext/featureanimation/Bounce.d.ts

Type definitions for ol-ext

import type { FeatureAnimationEvent, Options as FeatureAnimationOptions } from './FeatureAnimation'
import { FeatureAnimation } from './FeatureAnimation'

export interface Options extends FeatureAnimationOptions {
  bounce?: number;
  amplitude?: number;
  easing: ((p0: number) => number);
  duration?: number;
}

/** Bounce animation:
 * @constructor
 * @extends {featureAnimation}

 */
export default class Bounce extends FeatureAnimation {
  /**
   * @param {featureAnimationBounceOptions} options
   *  @param {number} options.bounce number of bounce, default 3
   *  @param {number} options.amplitude bounce amplitude,default 40
   *  @param {easing} options.easing easing used for decaying amplitude, use function(){return 0} for no decay, default easing.linear
   *  @param {number} options.duration duration in ms, default 1000
   */
  constructor(options?: Options)

  /** Animate
   * @param {FeatureAnimationEvent} e
   */
  animate(e: FeatureAnimationEvent): boolean;
}