Class EventSourcedSpreadsheetData

Event sourced implementation of SpreadsheetData

Implements

SpreadsheetData<EventSourcedSnapshot>

Index

Constructors

Methods

getCellFormat getCellValue getColumnCount getColumnItemOffsetMapping getRowCount getRowItemOffsetMapping getSnapshot isValidCellValueAndFormat setCellValueAndFormat subscribe

Constructors

constructor

new EventSourcedSpreadsheetData(
eventLog: EventLog<SetCellValueAndFormatLogEntry>,
): EventSourcedSpreadsheetData
Parameters
- eventLog: EventLog<SetCellValueAndFormatLogEntry>
Returns EventSourcedSpreadsheetData
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:56

Methods

getCellFormat

getCellFormat(
    snapshot: EventSourcedSnapshot,
    row: number,
    column: number,
): undefined | string
Format of specified cell using 0-based row and column indexes
Parameters
- snapshot: EventSourcedSnapshot
- row: number
- column: number
Returns undefined | string
Implementation of SpreadsheetData.getCellFormat
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:110

getCellValue

getCellValue(
    snapshot: EventSourcedSnapshot,
    row: number,
    column: number,
): CellValue
Value of specified cell using 0-based row and column indexes
Parameters
- snapshot: EventSourcedSnapshot
- row: number
- column: number
Returns CellValue
Implementation of SpreadsheetData.getCellValue
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:105

getColumnCount

getColumnCount(snapshot: EventSourcedSnapshot): number
Number of columns in the spreadsheet
Parameters
- snapshot: EventSourcedSnapshot
Returns number
Implementation of SpreadsheetData.getColumnCount
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:97

getColumnItemOffsetMapping

getColumnItemOffsetMapping(_snapshot: EventSourcedSnapshot): ItemOffsetMapping
ItemOffsetMapping which describes sizes and offsets to start of columns
Parameters
- _snapshot: EventSourcedSnapshot
Returns ItemOffsetMapping
Implementation of SpreadsheetData.getColumnItemOffsetMapping
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:101

getRowCount

getRowCount(snapshot: EventSourcedSnapshot): number
Number of rows in the spreadsheet
Parameters
- snapshot: EventSourcedSnapshot
Returns number
Implementation of SpreadsheetData.getRowCount
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:89

getRowItemOffsetMapping

getRowItemOffsetMapping(_snapshot: EventSourcedSnapshot): ItemOffsetMapping
ItemOffsetMapping which describes sizes and offsets to start of rows
Parameters
- _snapshot: EventSourcedSnapshot
Returns ItemOffsetMapping
Implementation of SpreadsheetData.getRowItemOffsetMapping
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:93

getSnapshot

getSnapshot(): EventSourcedSnapshot
Return a snapshot to use when accessing values at a consistent point in time

Returns EventSourcedSnapshot
Implementation of SpreadsheetData.getSnapshot
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:85

isValidCellValueAndFormat

isValidCellValueAndFormat(
    _row: number,
    _column: number,
    _value: CellValue,
    _format: undefined | string,
): Result<void, ValidationError>
Check whether value and format are valid to set for specified cell
Parameters
- _row: number
- _column: number
- _value: CellValue
- _format: undefined | string
Returns Result<void, ValidationError>
Ok if the value and format are valid
Implementation of SpreadsheetData.isValidCellValueAndFormat
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:142

setCellValueAndFormat

setCellValueAndFormat(
    row: number,
    column: number,
    value: CellValue,
    format: undefined | string,
): Result<void, SpreadsheetDataError>
Set value and format of specified cell
Parameters
- row: number
- column: number
- value: CellValue
- format: undefined | string
Returns Result<void, SpreadsheetDataError>
Ok if the change was successfully applied
Implementation of SpreadsheetData.setCellValueAndFormat
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:115

subscribe(onDataChange: () => void): () => void
Subscribe to data changes
Parameters
- onDataChange: () => void
Returns () => void
Implementation of SpreadsheetData.subscribe
- Defined in event-sourced-spreadsheet-data/src/EventSourcedSpreadsheetData.ts:72

Class EventSourcedSpreadsheetData

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EventSourcedSpreadsheetData

Methods

getCellFormat

Parameters

Returns undefined | string

getCellValue

Parameters

Returns CellValue

getColumnCount

Parameters

Returns number

getColumnItemOffsetMapping

Parameters

Returns ItemOffsetMapping

getRowCount

Parameters

Returns number

getRowItemOffsetMapping

Parameters

Returns ItemOffsetMapping

getSnapshot

Returns EventSourcedSnapshot

isValidCellValueAndFormat

Parameters

Returns Result<void, ValidationError>

setCellValueAndFormat

Parameters

Returns Result<void, SpreadsheetDataError>

subscribe

Parameters

Returns () => void

Settings

On This Page