igniteui-webcomponents-charts
Version:
Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.
46 lines (45 loc) • 2.33 kB
TypeScript
import { IgcCategoryAxisBaseComponent } from "./igc-category-axis-base-component";
import { IgcAnnotationLayerComponent } from "./igc-annotation-layer-component";
import { CategoryHighlightLayer } from "./CategoryHighlightLayer";
/**
* Represents an annotation layer that targets a category axis, or all category axes in the chart.
* If the axis contains any series that are aligned between major gridlines of the axis (column, waterfall, etc) this will render a shape that fills the current category.
* Otherwise it will render a band with an adjustable thickness at the closest gridline to the pointer position.
* Setting UseIterpolation to true will cause the x position in the latter case to become affixed to the x position of the pointer.
*/
export declare class IgcCategoryHighlightLayerComponent extends IgcAnnotationLayerComponent {
protected createImplementation(): CategoryHighlightLayer;
/**
* @hidden
*/
get i(): CategoryHighlightLayer;
constructor();
connectedCallback(): void;
disconnectedCallback(): void;
private static _observedAttributesIgcCategoryHighlightLayerComponent;
static get observedAttributes(): string[];
static htmlTagName: string;
protected static _isElementRegistered: boolean;
static register(): void;
/**
* Gets whether the series is an annotation layer displayed only when hovering over the chart.
*/
get isAnnotationHoverLayer(): boolean;
/**
* Gets or sets the axis to target this annotation to. If null, this annotation targets all category axes simultaneously.
*/
get targetAxis(): IgcCategoryAxisBaseComponent;
set targetAxis(v: IgcCategoryAxisBaseComponent);
/**
* Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position.
*/
get useInterpolation(): boolean;
set useInterpolation(v: boolean);
/**
* Gets or sets the width to use for the highlight region if drawing a band rather than filling a category.
*/
get bandHighlightWidth(): number;
set bandHighlightWidth(v: number);
findByName(name: string): any;
protected _styling(container: any, component: any, parent?: any): void;
}