menu

Interface TransactionService<T, S>

Type Parameters

T extends Transaction
S extends State

Hierarchy

Hierarchy (view full)

TransactionService
- HierarchicalTransactionService

Implemented by

IgxBaseTransactionService

Properties

Methods

Properties

canRedo

canRedo: boolean

Returns

if there are any transactions in the Redo stack

canUndo

canUndo: boolean

Returns

if there are any transactions in the Undo stack

cloneStrategy

cloneStrategy: IDataCloneStrategy

Gets/Sets the data clone strategy used to clone data

`Readonly` enabled

enabled: boolean

Returns whether transaction is enabled for this service

`Optional` onStateUpdate

onStateUpdate?: EventEmitter<StateUpdateEvent>

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

Methods

add

add(transaction, recordRef?): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:88
Adds provided transaction with recordRef if any

Parameters
- transaction: T
  Transaction to be added
- Optional recordRef: any
  Reference to the value of the record in the data source related to the changed item
Returns void

clear

clear(id?): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:149
Clears all transactions

Parameters
- Optional id: any
  Optional record id to clear transactions for
Returns void

commit

commit(data, id?): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:142
Applies all transactions over the provided data

Parameters
- data: any[]
  Data source to update
- Optional id: any
  Optional record id to commit transactions for
Returns void

endPending

endPending(commit): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:163
Clears all pending transactions and aggregated pending state. If commit is set to true commits pending states as single transaction

Parameters
- commit: boolean
  Should commit the pending states
Returns void

getAggregatedChanges

getAggregatedChanges(mergeChanges): T[]
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:115
Returns aggregated changes from all transactions

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

getAggregatedValue(id, mergeChanges): any
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:134
Returns value of the required id including all uncommitted changes

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

getState(id, pending?): S
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:124
Returns the state of the record with provided id

Parameters
- id: any
  The id of the record
- Optional pending: boolean
  Should get pending state
Returns S

getTransactionLog

getTransactionLog(id?): T[]
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:96
Returns all recorded transactions in chronological order

Parameters
- Optional id: any
  Optional record id to get transactions for
Returns T[]

redo

redo(): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:106
Applies the last undone transaction if any

Returns void

startPending

startPending(): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:155
Starts pending transactions. All transactions passed after call to startPending will not be added to transaction log

Returns void

undo

undo(): void
- Defined in projects/igniteui-angular/src/lib/services/transaction/transaction.ts:101
Remove the last transaction if any

Returns void