@fluidframework/matrix Package

Packages > @fluidframework/matrix

Interfaces

Interface Description
IRevertible
IUndoConsumer

Classes

Class Description
SharedMatrix

A SharedMatrix holds a rectangular 2D array of values. Supported operations include setting values and inserting/removing rows and columns.

Matrix values may be any Fluid serializable type, which is the set of JSON serializable types extended to include IFluidHandles.

Fluid's SharedMatrix implementation works equally well for dense and sparse matrix data and physically stores data in Z-order to leverage CPU caches and prefetching when reading in either row or column major order. (See README.md for more details.)

SharedMatrixFactory

Types

TypeAlias Description
MatrixItem A matrix cell value may be undefined (indicating an empty cell) or any serializable type, excluding null. (However, nulls may be embedded inside objects and arrays.)

Type Details

MatrixItem

A matrix cell value may be undefined (indicating an empty cell) or any serializable type, excluding null. (However, nulls may be embedded inside objects and arrays.)

Signature

export declare type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;