fabric
Version:
Object model for HTML5 canvas, and SVG-to-canvas parser. Backed by jsdom and node-canvas.
37 lines • 1.55 kB
TypeScript
import { ValueAnimation } from './ValueAnimation';
import { ArrayAnimation } from './ArrayAnimation';
import { ColorAnimation } from './ColorAnimation';
import type { ValueAnimationOptions, ArrayAnimationOptions, ColorAnimationOptions } from './types';
import type { TColorArg } from '../../color/typedefs';
export type TAnimation<T extends number | number[] | TColorArg> = T extends TColorArg ? ColorAnimation : T extends number[] ? ArrayAnimation : ValueAnimation;
/**
* Changes value(s) from startValue to endValue within a certain period of time,
* invoking callbacks as the value(s) change.
*
* @example
* animate({
* startValue: 1,
* endValue: 0,
* onChange: (v) => {
* obj.set('opacity', v);
* // since we are running in a requested frame we should call `renderAll` and not `requestRenderAll`
* canvas.renderAll();
* }
* });
*
* @example Using lists:
* animate({
* startValue: [1, 2, 3],
* endValue: [2, 4, 6],
* onChange: ([x, y, zoom]) => {
* canvas.zoomToPoint(new Point(x, y), zoom);
* canvas.renderAll();
* }
* });
*
*/
export declare function animate(options: ArrayAnimationOptions): ArrayAnimation;
export declare function animate(options: ValueAnimationOptions): ValueAnimation;
export declare function animate<T extends ValueAnimationOptions | ArrayAnimationOptions>(options: T): T extends ArrayAnimationOptions ? ArrayAnimation : ValueAnimation;
export declare function animateColor(options: ColorAnimationOptions): ColorAnimation;
//# sourceMappingURL=animate.d.ts.map