Interface ReactSpreadsheetData<Snapshot>

Extension of SpreadsheetData interface so that it's compatible with React's useSyncExternalStore hook

Additional properties are optional, so anything that implements SpreadsheetData is compatible with something that accepts ReactSpreadsheetData.

interface ReactSpreadsheetData<Snapshot> {
    getServerSnapshot?: () => Snapshot;
    getCellFormat(
        snapshot: Snapshot,
        row: number,
        column: number,
    ): undefined | string;
    getCellValue(snapshot: Snapshot, row: number, column: number): CellValue;
    getColumnCount(snapshot: Snapshot): number;
    getColumnItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping;
    getLoadStatus(snapshot: Snapshot): Result<boolean, StorageError>;
    getRowCount(snapshot: Snapshot): number;
    getRowItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping;
    getSnapshot(): Snapshot;
    isValidCellValueAndFormat(
        row: number,
        column: number,
        value: CellValue,
        format: undefined | string,
    ): Result<void, ValidationError>;
    setCellValueAndFormat(
        row: number,
        column: number,
        value: CellValue,
        format: undefined | string,
    ): ResultAsync<void, SpreadsheetDataError>;
    subscribe(onDataChange: () => void): () => void;
}

Type Parameters

Snapshot

Hierarchy (View Summary)

SpreadsheetData<Snapshot>
- ReactSpreadsheetData

Index

Methods

getCellFormat getCellValue getColumnCount getColumnItemOffsetMapping getLoadStatus getRowCount getRowItemOffsetMapping getSnapshot isValidCellValueAndFormat setCellValueAndFormat subscribe

Properties

getServerSnapshot?

Methods

getCellFormat

getCellFormat(
    snapshot: Snapshot,
    row: number,
    column: number,
): undefined | string
Format of specified cell using 0-based row and column indexes
Parameters
- snapshot: Snapshot
- row: number
- column: number
Returns undefined | string
Inherited from SpreadsheetData.getCellFormat
- Defined in infinisheet-types/src/SpreadsheetData.ts:92

getCellValue

getCellValue(snapshot: Snapshot, row: number, column: number): CellValue
Value of specified cell using 0-based row and column indexes
Parameters
- snapshot: Snapshot
- row: number
- column: number
Returns CellValue
Inherited from SpreadsheetData.getCellValue
- Defined in infinisheet-types/src/SpreadsheetData.ts:89

getColumnCount

getColumnCount(snapshot: Snapshot): number
Number of columns in the spreadsheet
Parameters
- snapshot: Snapshot
Returns number
Inherited from SpreadsheetData.getColumnCount
- Defined in infinisheet-types/src/SpreadsheetData.ts:83

getColumnItemOffsetMapping

getColumnItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping
ItemOffsetMapping which describes sizes and offsets to start of columns
Parameters
- snapshot: Snapshot
Returns ItemOffsetMapping
Inherited from SpreadsheetData.getColumnItemOffsetMapping
- Defined in infinisheet-types/src/SpreadsheetData.ts:86

getLoadStatus

getLoadStatus(snapshot: Snapshot): Result<boolean, StorageError>
Return load status at the time the snapshot was created

On Success returns true if load has completed, false if still in progress On Err returns most recent error reported by the storage system
Parameters
- snapshot: Snapshot
Returns Result<boolean, StorageError>
Inherited from SpreadsheetData.getLoadStatus
- Defined in infinisheet-types/src/SpreadsheetData.ts:74

getRowCount

getRowCount(snapshot: Snapshot): number
Number of rows in the spreadsheet
Parameters
- snapshot: Snapshot
Returns number
Inherited from SpreadsheetData.getRowCount
- Defined in infinisheet-types/src/SpreadsheetData.ts:77

getRowItemOffsetMapping

getRowItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping
ItemOffsetMapping which describes sizes and offsets to start of rows
Parameters
- snapshot: Snapshot
Returns ItemOffsetMapping
Inherited from SpreadsheetData.getRowItemOffsetMapping
- Defined in infinisheet-types/src/SpreadsheetData.ts:80

getSnapshot

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

Returns Snapshot
Inherited from SpreadsheetData.getSnapshot
- Defined in infinisheet-types/src/SpreadsheetData.ts:66

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
Inherited from SpreadsheetData.isValidCellValueAndFormat
- Defined in infinisheet-types/src/SpreadsheetData.ts:104

setCellValueAndFormat

setCellValueAndFormat(
    row: number,
    column: number,
    value: CellValue,
    format: undefined | string,
): ResultAsync<void, SpreadsheetDataError>
Set value and format of specified cell
Parameters
- row: number
- column: number
- value: CellValue
- format: undefined | string
Returns ResultAsync<void, SpreadsheetDataError>
Ok if the change was successfully applied
Inherited from SpreadsheetData.setCellValueAndFormat
- Defined in infinisheet-types/src/SpreadsheetData.ts:98

subscribe(onDataChange: () => void): () => void
Subscribe to data changes
Parameters
- onDataChange: () => void
Returns () => void
Inherited from SpreadsheetData.subscribe
- Defined in infinisheet-types/src/SpreadsheetData.ts:63

Properties

`Optional`getServerSnapshot

getServerSnapshot?: () => Snapshot

Used by useSyncExternalStore to support server side rendering

Interface ReactSpreadsheetData<Snapshot>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Properties

Methods

getCellFormat

Parameters

Returns undefined | string

getCellValue

Parameters

Returns CellValue

getColumnCount

Parameters

Returns number

getColumnItemOffsetMapping

Parameters

Returns ItemOffsetMapping

getLoadStatus

Parameters

Returns Result<boolean, StorageError>

getRowCount

Parameters

Returns number

getRowItemOffsetMapping

Parameters

Returns ItemOffsetMapping

getSnapshot

Returns Snapshot

isValidCellValueAndFormat

Parameters

Returns Result<void, ValidationError>

setCellValueAndFormat

Parameters

Returns ResultAsync<void, SpreadsheetDataError>

subscribe

Parameters

Returns () => void

Properties

OptionalgetServerSnapshot

Settings

On This Page

`Optional`getServerSnapshot