Add events property to Plugin defined type (#11350)

This commit is contained in:
stockiNail 2023-06-20 18:16:37 +02:00 committed by GitHub
parent 201ddffa1d
commit b42f9d127d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -816,6 +816,12 @@ export declare const layouts: {
export interface Plugin<TType extends ChartType = ChartType, O = AnyObject> extends ExtendedPlugin<TType, O> {
id: string;
/**
* The events option defines the browser events that the plugin should listen.
* @default ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']
*/
events?: (keyof HTMLElementEventMap)[]
/**
* @desc Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).
* @param {Chart} chart - The chart instance.