Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrPinRowEventArgsDetail

Event emitted when a row's pin state changes. The event is cancelable

Hierarchy

Hierarchy

  • IgrPinRowEventArgsDetail

Constructors

Accessors

Methods

Constructors

constructor

Accessors

cancel

  • get cancel(): boolean

  • Provides the ability to cancel the event.

    Returns boolean

  • set cancel(v): void

  • Parameters

    • v: boolean

    Returns void

insertAtIndex

  • get insertAtIndex(): number

  • The index at which to pin the row in the pinned rows collection.

    Returns number

  • set insertAtIndex(v): void

  • Parameters

    • v: number

    Returns void

isPinned

  • get isPinned(): boolean

  • Whether or not the row is pinned or unpinned.

    Returns boolean

  • set isPinned(v): void

  • Parameters

    • v: boolean

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

owner

  • get owner(): any

  • Provides reference to the owner component.

    Returns any

  • set owner(v): void

  • Parameters

    • v: any

    Returns void

row

  • get row(): IgrRowType

  • Returns IgrRowType

  • set row(v): void

  • Parameters

    Returns void

rowID

  • get rowID(): any

  • The ID of the row, that was pinned/unpinned. ID is either the primaryKey value or the data record instance.

    Deprecated

    Use the rowKey property instead.

    Returns any

  • set rowID(v): void

  • Parameters

    • v: any

    Returns void

rowKey

  • get rowKey(): any

  • Returns any

  • set rowKey(v): void

  • Parameters

    • v: any

    Returns void

Methods

findByName

  • Parameters

    • name: string

    Returns any

setNativeElement

  • Parameters

    • element: any

    Returns void