Class IgrPinColumnCancellableEventArgsDetail

The event arguments before a column's pin state is changed. insertAtIndexspecifies at which index in the pinned/unpinned area the column is inserted. Can be changed in the columnPin event. isPinned returns the actual pin state of the column. When pinning/unpinning is successful, the value of isPinned will change accordingly when read in the "-ing" and "-ed" event.

Hierarchy

Hierarchy

  • IgrPinColumnCancellableEventArgsDetail

Constructors

Accessors

  • get cancel(): boolean
  • Provides the ability to cancel the event.

    Returns boolean

  • set cancel(v): void
  • Parameters

    • v: boolean

    Returns void

  • get insertAtIndex(): number
  • If pinned, specifies at which index in the pinned area the column is inserted. If unpinned, specifies at which index in the unpinned area the column is inserted.

    Returns number

  • set insertAtIndex(v): void
  • Parameters

    • v: number

    Returns void

  • get isPinned(): boolean
  • Returns the actual pin state of the column. If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event.

    Returns boolean

  • set isPinned(v): void
  • Parameters

    • v: boolean

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

Methods

  • Parameters

    • name: string

    Returns any

  • Parameters

    • element: any

    Returns void