ag-charts-community/dist/types/src/chart/interaction/animationManager.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

import { AgDocument, type EventListener } from 'ag-charts-core';
import type { AdditionalAnimationOptions, AnimationOptions, AnimationPhase, AnimationValue, IAnimation } from '../../motion/animation';
import { Animation } from '../../motion/animation';
import type { Mutex } from '../../util/mutex';
import { InteractionManager } from './interactionManager';
type AnimationEventType = 'animation-frame' | 'animation-start' | 'animation-stop';
export interface AnimationEvent {
    readonly type: AnimationEventType;
    readonly deltaMs: number;
}
type AnimationEventMap = {
    [K in AnimationEventType]: AnimationEvent;
};
/**
 * Manage animations across a chart, running all animations through only one `requestAnimationFrame` callback,
 * preventing duplicate animations and handling their lifecycle.
 */
export declare class AnimationManager {
    private readonly agDocument;
    private readonly interactionManager;
    private readonly chartUpdateMutex;
    defaultDuration: number;
    maxAnimatableItems: number;
    private batch;
    private readonly debug;
    private readonly events;
    private readonly rafAvailable;
    private isPlaying;
    private requestId;
    private skipAnimations;
    private currentAnonymousAnimationId;
    private cumulativeAnimationTime;
    constructor(agDocument: AgDocument, interactionManager: InteractionManager, chartUpdateMutex: Mutex);
    addListener<K extends keyof AnimationEventMap>(eventName: K, listener: EventListener<AnimationEventMap[K]>): () => void;
    /**
     * Create an animation to tween a value between the `from` and `to` properties. If an animation already exists
     * with the same `id`, immediately stop it.
     */
    animate<T extends AnimationValue>(opts: AnimationOptions<T> & AdditionalAnimationOptions): Animation<T> | undefined;
    play(): void;
    stop(): void;
    stopByAnimationId(id: string): void;
    stopByAnimationGroupId(id: string): void;
    reset(): void;
    skip(skip?: boolean): void;
    isSkipped(): boolean;
    isActive(): boolean;
    getRemainingTime(phase?: AnimationPhase): number;
    getCumulativeAnimationTime(): number;
    skipCurrentBatch(): void;
    /** Mocking point for tests to guarantee that animation updates happen. */
    isSkippingFrames(): boolean;
    /** Mocking point for tests to capture requestAnimationFrame callbacks. */
    scheduleAnimationFrame(cb: (time: number) => Promise<void>): void;
    /** Mocking point for tests to skip animations to a specific point in time. */
    forceTimeJump(_animation: IAnimation, _defaultDuration: number): boolean;
    private requestAnimation;
    private cancelAnimation;
    private failsafeOnError;
    startBatch(skipAnimations?: boolean): void;
    endBatch(): void;
    onBatchStop(cb: () => void): void;
    destroy(): void;
}
export {};