Skip to main content

@fluidframework/matrix Package

Interfaces​

InterfaceAlertsDescription
IRevertibleLegacy
ISharedMatrixLegacy
ISharedMatrixEventsLegacyEvents emitted by Shared Matrix.
IUndoConsumerLegacy

Classes​

ClassAlertsDescription
SharedMatrixFactoryDeprecated, LegacyIChannelFactory for ISharedMatrix.

Types​

TypeAliasAlertsDescription
MatrixItemLegacyA 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.)
SharedMatrixLegacyConvenience alias for ISharedMatrix. Prefer to use ISharedMatrix when referring to SharedMatrix as a type.

Variables​

VariableAlertsModifiersTypeDescription
SharedMatrixLegacyreadonlyimport("@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>>