igniteui-react-core
Version:
Ignite UI React Core.
72 lines (71 loc) • 2.43 kB
TypeScript
import { HighlightingState } from "./HighlightingState";
import { HighlightingInfo as HighlightingInfo_internal } from "./HighlightingInfo";
import { ContentChildrenManager } from "./ContentChildrenManager";
/**
* Contains contextual information about a highlighting.
*/
export declare class IgrHighlightingInfo {
protected createImplementation(): HighlightingInfo_internal;
protected _implementation: any;
protected mounted: boolean;
get nativeElement(): HTMLElement;
/**
* @hidden
*/
get i(): HighlightingInfo_internal;
protected onImplementationCreated(): void;
protected _contentChildrenManager: ContentChildrenManager;
constructor();
protected _provideImplementation(i: any): void;
/**
* The index of the first highlighted item.
*
* You can use `StartIndex` to get or set the first highlighted item for the series.
*/
get startIndex(): number;
set startIndex(v: number);
/**
* The index of the last highlighted item.
*
* You can use the `EndIndex` to get or set the last highlighted item for the series.
*/
get endIndex(): number;
set endIndex(v: number);
/**
* The state of the highlighting.
*
* You can use the `State` to get or set the transitioning state of the highlighting, between In, Out, or Static.
*/
get state(): HighlightingState;
set state(v: HighlightingState);
/**
* A number between 0 and 1 representing the progress of the highlighting.
*
* You can use the `Progress` property to set a number between 0 and 1 representing the progress of the highlighting.
*/
get progress(): number;
set progress(v: number);
/**
* True if this HighlightingInfo represents a marker highlighting.
*
* You can set the `IsMarker` to True if the HighlightingInfo represents a marker highlighting. Otherwise set to false.
*/
get isMarker(): boolean;
set isMarker(v: boolean);
/**
* True if this HighlightingInfo represents a full selection of the data.
*/
get isFullRange(): boolean;
set isFullRange(v: boolean);
/**
* TODO
*/
get isExclusive(): boolean;
set isExclusive(v: boolean);
/**
* The context for the highlight.
*/
get context(): any;
set context(v: any);
findByName(name: string): any;
}