Class IgxTransactionService<T, S>

Type Parameters

T extends Transaction
S extends State

Hierarchy

Hierarchy (view full)

IgxBaseTransactionService<T, S>
- IgxTransactionService

Constructors

Properties

Accessors

Methods

Constructors

constructor

new IgxTransactionService<T, S>(): IgxTransactionService<T, S>
Inherited from IgxBaseTransactionService.constructor
Type parameters
Type Parameters
- T extends Transaction
- S extends State
Returns IgxTransactionService<T, S>

Properties

onStateUpdate

onStateUpdate: EventEmitter<StateUpdateEvent> = ...

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

Accessors

canRedo

get canRedo(): boolean
Overrides IgxBaseTransactionService.canRedo
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:22
Returns boolean

canUndo

get canUndo(): boolean
Overrides IgxBaseTransactionService.canUndo
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:15
Returns boolean

cloneStrategy

get cloneStrategy(): IDataCloneStrategy
Inherited from IgxBaseTransactionService.cloneStrategy
- Defined in projects/igniteui-angular/src/lib/services/transaction/base-transaction.ts:10
Gets/Sets the data clone strategy used to clone data

Returns IDataCloneStrategy
set cloneStrategy(strategy): void
Inherited from IgxBaseTransactionService.cloneStrategy
- Defined in projects/igniteui-angular/src/lib/services/transaction/base-transaction.ts:14
Gets/Sets the data clone strategy used to clone data

Parameters
- strategy: IDataCloneStrategy
Returns void

enabled

get enabled(): boolean
Overrides IgxBaseTransactionService.enabled
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:81
Returns whether transaction is enabled for this service

Returns boolean

Methods

add

add(transaction, recordRef?): void
Overrides IgxBaseTransactionService.add
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:32
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
Overrides IgxBaseTransactionService.clear
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:163
Clears all transactions

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

commit

commit(data, id?): void
Overrides IgxBaseTransactionService.commit
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:144
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
Overrides IgxBaseTransactionService.endPending
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:118
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[]
Overrides IgxBaseTransactionService.getAggregatedChanges
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:58
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
Overrides IgxBaseTransactionService.getAggregatedValue
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:93
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
Overrides IgxBaseTransactionService.getState
- Defined in projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts:74
Returns the state of the record with provided id

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

getTransactionLog

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

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

redo

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

Returns void

startPending

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

Returns void

undo

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

Returns void

Class IgxTransactionService<T, S>

Type Parameters

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Type Parameters

Returns IgxTransactionService<T, S>

Properties

onStateUpdate

Accessors

canRedo

Returns boolean

canUndo

Returns boolean

cloneStrategy

Returns IDataCloneStrategy

Parameters

strategy: IDataCloneStrategy

Returns void

enabled

Returns boolean

Methods

add

Parameters

transaction: T

Optional recordRef: any

Returns void

clear

Parameters

Optional id: any

Returns void

commit

Parameters

data: any[]

Optional id: any

Returns void

endPending

Parameters

commit: boolean

Returns void

getAggregatedChanges

Parameters

mergeChanges: boolean

Returns T[]

getAggregatedValue

Parameters

id: any

mergeChanges: boolean

Returns any

getState

Parameters

id: any

pending: boolean = false

Returns S

getTransactionLog

Parameters

Optional id: any

Returns T[]

redo

Returns void

startPending

Returns void

undo

Returns void