AnimationEvent is incorrectly typed

[NorthBlue333]

Expected Behavior

According to the documentation, AnimationEvent should be typed as :

export interface AnimationEvent {
	chart: Chart;
	initial: boolean;
	numSteps: number;
	currentStep: number;
}

Current Behavior

AnimationEvent is currently typed as :

export interface AnimationEvent {
	chart: Chart;
	numSteps: number;
	currentState: number;
}

Possible Solution

Type AnimationEvent as :

export interface AnimationEvent {
	chart: Chart;
	initial: boolean;
	numSteps: number;
	currentStep: number;
}

Steps to Reproduce

Using the callbacks as the documentation shows :

const config = {
  type: 'line',
  data: data,
  options: {
    animation: {
      duration: 2000,
      onProgress: function(context) {
        if (context.initial) {
          initProgress.value = context.currentStep / context.numSteps;
        } else {
          progress.value = context.currentStep / context.numSteps;
        }
      },
      onComplete: function(context) {
        if (context.initial) {
          console.log('Initial animation finished');
        } else {
          console.log('animation finished');
        }
      }
    },
  },
};

Context

It is currently needed to override/cast the event to use the correct properties.

Environment

• Chart.js version: 3.6.0

[NorthBlue333]

Hello @kurkle
currentStep: number; instead of currentState: number; is missing from #9834