EditSession

Defined in: core/src/events/session.ts:85

The edit session of a chart (edit.* of the facade), see createEditSession. At most one session is open at a time. Its methods need no this.

Properties

begin

readonly begin: () => SessionBeginResult

Defined in: core/src/events/session.ts:87

Opens a session on the current data.

Returns

SessionBeginResult

---

commit

readonly commit: () => SessionCommitResult

Defined in: core/src/events/session.ts:89

Closes the session and keeps the data; returns the aggregated changes.

Returns

SessionCommitResult

---

dispose

readonly dispose: () => void

Defined in: core/src/events/session.ts:102

Stops tracking: no more events; begin, commit and rollback resolve cancelled. The store is left as it is (an open session stays in it). Idempotent.

Returns

void

---

getChanges

readonly getChanges: () => SessionChanges | undefined

Defined in: core/src/events/session.ts:93

The aggregated changes since begin() (selectSessionChanges); undefined when closed.

Returns

SessionChanges | undefined

---

isDirty

readonly isDirty: boolean

Defined in: core/src/events/session.ts:97

Whether a session is open and has changes.

---

isOpen

readonly isOpen: boolean

Defined in: core/src/events/session.ts:95

Whether a session is open.

---

rollback

readonly rollback: () => SessionRollbackResult

Defined in: core/src/events/session.ts:91

Closes the session and returns to its base; never vetoed by the before-hooks.

Returns

SessionRollbackResult