igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
99 lines (97 loc) • 3.54 kB
TypeScript
import { IgrAxis } from "./igr-axis";
import { CategoryTooltipLayerPosition } from "./CategoryTooltipLayerPosition";
import { IgrAnnotationLayer, IIgrAnnotationLayerProps } from "./igr-annotation-layer";
import { CategoryToolTipLayer } from "./CategoryToolTipLayer";
/**
* Represents an annotation layer that displays grouped tooltips for series that use a category axis.
*/
export declare class IgrCategoryToolTipLayer extends IgrAnnotationLayer<IIgrCategoryToolTipLayerProps> {
protected createImplementation(): CategoryToolTipLayer;
/**
* @hidden
*/
get i(): CategoryToolTipLayer;
constructor(props: IIgrCategoryToolTipLayerProps);
get isToolTipLayer(): boolean;
/**
* Gets whether the series is an annotation layer displayed only when hovering over the chart.
*/
get isAnnotationHoverLayer(): boolean;
/**
* Gets whether the default tooltip behaviors for the chart are disabled if this layer is present.
*/
get isDefaultTooltipBehaviorDisabled(): boolean;
/**
* Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.
*/
get targetAxis(): IgrAxis;
set targetAxis(v: IgrAxis);
private _targetAxisName;
/**
* Gets or sets the name to use to resolve targetAxis from markup.
*/
get targetAxisName(): string;
set targetAxisName(v: string);
/**
* Gets or sets whether to use value interpolation when drawing the tooltips.
*/
get useInterpolation(): boolean;
set useInterpolation(v: boolean);
/**
* Gets or sets the Position to apply to the tooltip containers.
*/
get toolTipPosition(): CategoryTooltipLayerPosition;
set toolTipPosition(v: CategoryTooltipLayerPosition);
/**
* Gets or sets the background of the tooltip containers.
*/
get toolTipBackground(): string;
set toolTipBackground(v: string);
/**
* Gets or sets the border color of the tooltip containers.
*/
get toolTipBorderBrush(): string;
set toolTipBorderBrush(v: string);
/**
* Gets or sets the border thickness of the tooltip containers.
*/
get toolTipBorderThickness(): number;
set toolTipBorderThickness(v: number);
bindAxes(axes: IgrAxis[]): void;
findByName(name: string): any;
protected _styling(container: any, component: any, parent?: any): void;
/**
* Hides any tooltips presented by the layer, if any.
*/
hideToolTips(): void;
}
export interface IIgrCategoryToolTipLayerProps extends IIgrAnnotationLayerProps {
/**
* Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.
*/
targetAxis?: IgrAxis;
/**
* Gets or sets the name to use to resolve targetAxis from markup.
*/
targetAxisName?: string;
/**
* Gets or sets whether to use value interpolation when drawing the tooltips.
*/
useInterpolation?: boolean | string;
/**
* Gets or sets the Position to apply to the tooltip containers.
*/
toolTipPosition?: CategoryTooltipLayerPosition | string;
/**
* Gets or sets the background of the tooltip containers.
*/
toolTipBackground?: string;
/**
* Gets or sets the border color of the tooltip containers.
*/
toolTipBorderBrush?: string;
/**
* Gets or sets the border thickness of the tooltip containers.
*/
toolTipBorderThickness?: number | string;
}