IgxForOfDirective

Constructors

new IgxForOfDirective(): IgxForOfDirective

Returns IgxForOfDirective

Properties

_virtScrollPosition

Internal track for scroll top that is being virtualized

_virtScrollPosition: number = 0

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:282

beforeViewDestroyed

beforeViewDestroyed: EventEmitter<EmbeddedViewRef<any>>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:236

cdr

cdr: ChangeDetectorRef

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:93

chunkLoad

An event that is emitted after a new chunk has been loaded.

<ng-template igxFor [igxForOf]="data" [igxForScrollOrientation]="'horizontal'" (chunkLoad)="loadChunk($event)"></ng-template>

loadChunk(e){
alert("chunk loaded!");
}

chunkLoad: EventEmitter<IForOfState>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:199

chunkPreload

An event that is emitted on chunk loading to emit the current state information - startIndex, endIndex, totalCount. Can be used for implementing remote load on demand for the igxFor data.

<ng-template igxFor [igxForOf]="data" [igxForScrollOrientation]="'horizontal'" (chunkPreload)="chunkPreload($event)"></ng-template>

chunkPreload(e){
alert("chunk is loading!");
}

chunkPreload: EventEmitter<IForOfState>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:251

contentSizeChange

An event that is emitted after the rendered content size of the igxForOf has been changed.

contentSizeChange: EventEmitter<any>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:219

dataChanged

An event that is emitted after data has been changed.

<ng-template igxFor [igxForOf]="data" [igxForScrollOrientation]="'horizontal'" (dataChanged)="dataChanged($event)"></ng-template>

dataChanged(e){
alert("data changed!");
}

dataChanged: EventEmitter<IForOfDataChangeEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:233

igxForContainerSize

Sets the px-affixed size of the container along the axis of scrolling. For "horizontal" orientation this value is the width of the container and for "vertical" is the height.

<ng-template igxFor let-item [igxForOf]="data" [igxForContainerSize]="'500px'"
     [igxForScrollOrientation]="'horizontal'">
</ng-template>

igxForContainerSize: any

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:167

igxForItemSize

Sets the px-affixed size of the item along the axis of scrolling. For "horizontal" orientation this value is the width of the column and for "vertical" is the height or the row.

<ng-template igxFor let-item [igxForOf]="data" [igxForScrollOrientation]="'horizontal'" [igxForItemSize]="'50px'"></ng-template>

igxForItemSize: any

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:185

igxForScrollContainer

Optionally pass the parent igxFor instance to create a virtual template scrolling both horizontally and vertically.

<ng-template #scrollContainer igxFor let-rowData [igxForOf]="data"
      [igxForScrollOrientation]="'vertical'"
      [igxForContainerSize]="'500px'"
      [igxForItemSize]="'50px'"
      let-rowIndex="index">
      <div [style.display]="'flex'" [style.height]="'50px'">
          <ng-template #childContainer igxFor let-item [igxForOf]="data"
              [igxForScrollOrientation]="'horizontal'"
              [igxForScrollContainer]="parentVirtDir"
              [igxForContainerSize]="'500px'">
                  <div [style.min-width]="'50px'">{{rowIndex}} : {{item.text}}</div>
          </ng-template>
      </div>
</ng-template>

igxForScrollContainer: any

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:155

igxForScrollOrientation

Specifies the scroll orientation. Scroll orientation can be "vertical" or "horizontal".

<ng-template igxFor let-item [igxForOf]="data" [igxForScrollOrientation]="'horizontal'"></ng-template>

igxForScrollOrientation: string = 'vertical'

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:133

igxForSizePropName

Sets the property name from which to read the size in the data object.

igxForSizePropName: any

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:123

state

The current state of the directive. It contains startIndex and chunkSize. state.startIndex - The index of the item at which the current visible chunk begins. state.chunkSize - The number of items the current visible chunk holds. These options can be used when implementing remote virtualization as they provide the necessary state information.

const gridState = this.parentVirtDir.state;

state: IForOfState

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:267

igxForOf

igxForOf: U & T[]

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:108, projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:112

igxForTotalItemCount

igxForTotalItemCount: number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:318, projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:321

igxForTrackBy

igxForTrackBy: TrackByFunction<T>

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:1197, projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:1212

scrollPosition

scrollPosition: number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:373, projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:376

totalItemCount

totalItemCount: number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:331, projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:335

Accessors

displayContainer

get displayContainer(): HTMLElement

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:350

Returns HTMLElement

virtualHelper

get virtualHelper(): HTMLElement

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:354

Returns HTMLElement

Methods

addScroll

Shifts the scroll thumb position.

this.parentVirtDir.addScroll(5);

addScroll(add: number): boolean

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:642

Parameters

add: number
negative value to scroll previous and positive to scroll next;

Returns boolean

addScrollTop

Shifts the scroll thumb position.

this.parentVirtDir.addScroll(5);

addScrollTop(add: number): boolean

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:630

Parameters

add: number

Returns boolean

getIndexAtScroll

Returns the index of the element at the specified offset.

this.parentVirtDir.getIndexAtScroll(100);

getIndexAtScroll(scrollOffset: number): number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:830

Parameters

scrollOffset: number

Returns number

getItemCountInView

Returns the total number of items that are fully visible.

this.parentVirtDir.getItemCountInView();

getItemCountInView(): number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:774

Returns number

getScroll

Returns a reference to the scrollbar DOM element. This is either a vertical or horizontal scrollbar depending on the specified igxForScrollOrientation.

dir.getScroll();

getScroll(): HTMLElement

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:791

Returns HTMLElement

getScrollForIndex

Returns the scroll offset of the element at the specified index.

this.parentVirtDir.getScrollForIndex(1);

getScrollForIndex(index: number, bottom: boolean): number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:818

Parameters

index: number
bottom: boolean

Returns number

getSizeAt

Returns the size of the element at the specified index.

this.parentVirtDir.getSizeAt(1);

getSizeAt(index: number): number

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:800

Parameters

index: number

Returns number

isIndexOutsideView

Returns whether the target index is outside the view.

this.parentVirtDir.isIndexOutsideView(10);

isIndexOutsideView(index: number): boolean

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:839

Parameters

index: number

Returns boolean

isScrollable

isScrollable(): boolean

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:420

Returns boolean

ngAfterViewInit

A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

ngAfterViewInit(): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:515

Returns void

scrollNext

Scrolls by one item into the appropriate next direction. For "horizontal" orientation that will be the right column and for "vertical" that is the lower row.

this.parentVirtDir.scrollNext();

scrollNext(): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:721

Returns void

scrollNextPage

Scrolls by one page into the appropriate next direction. For "horizontal" orientation that will be one view to the right and for "vertical" that is one view to the bottom.

this.parentVirtDir.scrollNextPage();

scrollNextPage(): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:745

Returns void

scrollPrev

Scrolls by one item into the appropriate previous direction. For "horizontal" orientation that will be the left column and for "vertical" that is the upper row.

this.parentVirtDir.scrollPrev();

scrollPrev(): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:734

Returns void

scrollPrevPage

Scrolls by one page into the appropriate previous direction. For "horizontal" orientation that will be one view to the left and for "vertical" that is one view to the top.

this.parentVirtDir.scrollPrevPage();

scrollPrevPage(): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:756

Returns void

scrollTo

Scrolls to the specified index.

this.parentVirtDir.scrollTo(5);

scrollTo(index: number): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:694

Parameters

index: number

Returns void

verticalScrollHandler

verticalScrollHandler(event: any): void

Defined in projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts:416

Parameters

event: any