igniteui-react-charts/lib/igr-user-annotation-tool-tip-layer.d.ts

Ignite UI React charting components for building rich data visualizations using TypeScript APIs.

import { IgrSeries } from "./igr-series";
import { IgrUserAnnotationToolTipContentUpdatingEventArgs } from "./igr-user-annotation-tool-tip-content-updating-event-args";
import { IgrAnnotationLayer, IIgrAnnotationLayerProps } from "./igr-annotation-layer";
import { UserAnnotationToolTipLayer } from "./UserAnnotationToolTipLayer";
/**
 * Represents an annotation layer that displays tooltips for all target series individually.
*/
export declare class IgrUserAnnotationToolTipLayer extends IgrAnnotationLayer<IIgrUserAnnotationToolTipLayerProps> {
    protected createImplementation(): UserAnnotationToolTipLayer;
    /**
                                 * @hidden
                                 */
    get i(): UserAnnotationToolTipLayer;
    constructor(props: IIgrUserAnnotationToolTipLayerProps);
    /**
     * Gets whether the series is an annotation layer displayed only when hovering over the chart.
    */
    get isAnnotationHoverLayer(): boolean;
    /**
     * Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously.
    */
    get targetSeriesName(): string;
    set targetSeriesName(v: string);
    /**
     * Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.
    */
    get targetSeries(): IgrSeries;
    set targetSeries(v: IgrSeries);
    /**
     * Gets or sets whether to skip past unknown values when searching for series values.
    */
    get skipUnknownValues(): boolean;
    set skipUnknownValues(v: boolean);
    get isUserAnnotationToolTipLayer(): boolean;
    get isToolTipLayer(): boolean;
    findByName(name: string): any;
    protected _styling(container: any, component: any, parent?: any): void;
    /**
     * Hides any tooltips presented by the layer, if any.
    
    */
    hideToolTips(): void;
    /**
     * Hides any tooltips presented by the layer, if any.
    
    */
    hideToolTipsImmediate(): void;
    private _contentUpdating;
    private _contentUpdating_wrapped;
    /**
     * Called when the content is being created or updated.
    */
    get contentUpdating(): (s: IgrUserAnnotationToolTipLayer, e: IgrUserAnnotationToolTipContentUpdatingEventArgs) => void;
    set contentUpdating(ev: (s: IgrUserAnnotationToolTipLayer, e: IgrUserAnnotationToolTipContentUpdatingEventArgs) => void);
}
export interface IIgrUserAnnotationToolTipLayerProps extends IIgrAnnotationLayerProps {
    /**
     * Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously.
    */
    targetSeriesName?: string;
    /**
     * Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.
    */
    targetSeries?: IgrSeries;
    /**
     * Gets or sets whether to skip past unknown values when searching for series values.
    */
    skipUnknownValues?: boolean | string;
    /**
     * Called when the content is being created or updated.
    */
    contentUpdating?: (s: IgrUserAnnotationToolTipLayer, e: IgrUserAnnotationToolTipContentUpdatingEventArgs) => void;
}