Packages > @fluidframework/matrix
@fluidframework/matrix Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IRevertible |
ALPHA
|
|
| ISharedMatrixEvents |
ALPHA
|
Events emitted by Shared Matrix. |
| IUndoConsumer |
ALPHA
|
Classes
| Class | Alerts | Description |
|---|---|---|
| SharedMatrix |
ALPHA
|
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 |
ALPHA
|
IChannelFactory for SharedMatrix. |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| MatrixItem |
ALPHA
|
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 (ALPHA)
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.)
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;