Constructors

Section titled "Constructors"

IgxTransactionService

new IgxTransactionService(): IgxTransactionService

Returns IgxTransactionService

Properties

Section titled "Properties"

onStateUpdate

Section titled "onStateUpdate"

Inherited from: IgxBaseTransactionService

Event fired when transaction state has changed - add transaction, commit all transactions, undo and redo

 
onStateUpdate: EventEmitter<StateUpdateEvent>

Defined in projects/igniteui-angular/core/src/services/transaction/base-transaction.ts:44

cloneStrategy

Section titled "cloneStrategy"

Inherited from: IgxBaseTransactionService

Gets/Sets the data clone strategy used to clone data

 
cloneStrategy: IDataCloneStrategy

Defined in projects/igniteui-angular/core/src/services/transaction/base-transaction.ts:10, projects/igniteui-angular/core/src/services/transaction/base-transaction.ts:14

Accessors

Section titled "Accessors"

canRedo

Section titled "canRedo" 
get canRedo(): boolean

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:22

Returns boolean

canUndo

Section titled "canUndo" 
get canUndo(): boolean

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:15

Returns boolean

enabled

Section titled "enabled"

Returns whether transaction is enabled for this service

get enabled(): boolean

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:81

Returns boolean

Methods

Section titled "Methods"

add

Section titled "add"

Adds provided transaction with recordRef if any

add(transaction: T, recordRef: any): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:32

Parameters

  • transaction: T

    Transaction to be added
  • recordRef: any

    Reference to the value of the record in the data source related to the changed item

Returns void

clear

Section titled "clear"

Clears all transactions

clear(id: any): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:163

Parameters

  • id: any

    Optional record id to clear transactions for

Returns void

commit

Section titled "commit"

Applies all transactions over the provided data

commit(data: any[], id: any): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:144

Parameters

  • data: any[]

    Data source to update
  • id: any

    Optional record id to commit transactions for

Returns void

endPending

Section titled "endPending"

Clears all pending transactions and aggregated pending state. If commit is set to true commits pending states as single transaction

endPending(commit: boolean): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:118

Parameters

  • commit: boolean

    Should commit the pending states

Returns void

getAggregatedChanges

Section titled "getAggregatedChanges"

Returns aggregated changes from all transactions

getAggregatedChanges(mergeChanges: boolean): T[]

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:58

Parameters

  • mergeChanges: boolean

    If set to true will merge each state's value over relate recordRef and will record resulting value in the related transaction

Returns T[]

getAggregatedValue

Section titled "getAggregatedValue"

Returns value of the required id including all uncommitted changes

getAggregatedValue(id: any, mergeChanges: boolean): any

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:93

Parameters

  • id: any

    The id of the record to return value for
  • mergeChanges: boolean

    If set to true will merge state's value over relate recordRef and will return merged value

Returns any

getState

Section titled "getState"

Returns the state of the record with provided id

getState(id: any, pending: boolean): S

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:74

Parameters

  • id: any

    The id of the record
  • pending: boolean

    Should get pending state

Returns S

getTransactionLog

Section titled "getTransactionLog"

Returns all recorded transactions in chronological order

getTransactionLog(id: any): T[]

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:44

Parameters

  • id: any

    Optional record id to get transactions for

Returns T[]

redo

Section titled "redo"

Applies the last undone transaction if any

redo(): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:206

Returns void

startPending

Section titled "startPending"

Inherited from: IgxBaseTransactionService

Starts pending transactions. All transactions passed after call to startPending will not be added to transaction log

startPending(): void

Defined in projects/igniteui-angular/core/src/services/transaction/base-transaction.ts:152

Returns void

undo

Section titled "undo"

Remove the last transaction if any

undo(): void

Defined in projects/igniteui-angular/core/src/services/transaction/igx-transaction.ts:184

Returns void