scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
28 lines (27 loc) • 1.3 kB
TypeScript
import { IAnnotation } from "../../Charting/Visuals/Annotations/IAnnotation";
import { EChart2DModifierType } from "../../types/ChartModifierType";
import { IPointerEventsMediatorModifierOptions, PointerEventsMediatorModifier } from "./PointerEventsMediatorModifier";
/**
* Options for the {@link AnnotationHoverModifier}.
*/
export interface IAnnotationHoverModifierOptions extends IPointerEventsMediatorModifierOptions<IAnnotation> {
}
/**
* Enables hover detection on annotations.
* Accepts {@link IAnnotationHoverModifierOptions}
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/selection/annotation-hover/}
*/
export declare class AnnotationHoverModifier extends PointerEventsMediatorModifier<IAnnotation> {
readonly type = EChart2DModifierType.AnnotationHover;
/**
* Creates an instance of the AnnotationHoverModifier
* @param options Optional parameters of type {@link IAnnotationHoverModifierOptions} used to configure the modifier
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/selection/annotation-hover/}
*/
constructor(options?: IAnnotationHoverModifierOptions);
getAllTargets(): IAnnotation[];
}