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

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

import { BaseManager } from '../../util/baseManager';
import type { SeriesNodeDatum } from '../series/seriesTypes';
export interface HighlightNodeDatum extends SeriesNodeDatum<unknown> {
    readonly xKey?: string;
    readonly yKey?: string;
    readonly colorValue?: number;
    readonly cumulativeValue?: number;
    readonly aggregatedValue?: number;
    readonly domain?: [number, number];
}
export interface HighlightChangeEvent {
    readonly type: 'highlight-change';
    readonly previousHighlight?: HighlightNodeDatum;
    readonly currentHighlight?: HighlightNodeDatum;
    readonly callerId: string;
}
/**
 * Manages the actively highlighted series/datum for a chart. Tracks the requested highlights from
 * distinct dependents and handles conflicting highlight requests.
 */
export declare class HighlightManager extends BaseManager<'highlight-change', HighlightChangeEvent> {
    private readonly highlightStates;
    private activeHighlight?;
    updateHighlight(callerId: string, highlightedDatum?: HighlightNodeDatum): void;
    getActiveHighlight(): HighlightNodeDatum | undefined;
    private isEqual;
}