Skip to main content

@fluidframework/matrix Package

Interfaces

Interface Alerts Description
IRevertible Legacy
ISharedMatrix Legacy
ISharedMatrixEvents Legacy Events emitted by Shared Matrix.
IUndoConsumer Legacy

Classes

Class Alerts Description
SharedMatrixFactory Deprecated, Legacy IChannelFactory for ISharedMatrix.

Types

TypeAlias Alerts Description
MatrixItem Legacy 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.)
SharedMatrix Legacy Convenience alias for ISharedMatrix. Prefer to use ISharedMatrix when referring to SharedMatrix as a type.

Variables

Variable Alerts Modifiers Type Description
SharedMatrix Legacy readonly import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMatrix<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMatrix<any>> Entrypoint for ISharedMatrix creation.

Variable Details

SharedMatrix

Entrypoint for ISharedMatrix creation.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/matrix/legacy.

For more information about our API support guarantees, see here.

Signature

SharedMatrix: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMatrix<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMatrix<any>>

Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedMatrix<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedMatrix<any>>