matrix.api.md

API Report File for "@fluidframework/matrix"

Do not edit this file. It is a report generated by API Extractor.

import { IChannel } from '@fluidframework/datastore-definitions';
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
import { IChannelFactory } from '@fluidframework/datastore-definitions';
import { IChannelServices } from '@fluidframework/datastore-definitions';
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { IMatrixConsumer } from '@tiny-calc/nano';
import { IMatrixProducer } from '@tiny-calc/nano';
import { IMatrixReader } from '@tiny-calc/nano';
import { IMatrixWriter } from '@tiny-calc/nano';
import { ISegment } from '@fluidframework/merge-tree';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
import { Serializable } from '@fluidframework/datastore-definitions';
import { SharedObject } from '@fluidframework/shared-object-base';
import { SummarySerializer } from '@fluidframework/shared-object-base';

// @public (undocumented)
export interface IRevertible {
    // (undocumented)
    discard(): any;
    // (undocumented)
    revert(): any;
}

// @public (undocumented)
export interface IUndoConsumer {
    // (undocumented)
    pushToCurrentOperation(revertible: IRevertible): any;
}

// @public
export type MatrixItem<T> = Serializable<Exclude<T, null>> | undefined;

// @public
export class SharedMatrix<T = any> extends SharedObject implements IMatrixProducer<MatrixItem<T>>, IMatrixReader<MatrixItem<T>>, IMatrixWriter<MatrixItem<T>> {
    constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
    // (undocumented)
    protected applyStashedOp(content: any): unknown;
    // (undocumented)
    closeMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): void;
    // (undocumented)
    get colCount(): number;
    // (undocumented)
    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedMatrix<T>;
    // (undocumented)
    protected didAttach(): void;
    // (undocumented)
    getCell(row: number, col: number): MatrixItem<T>;
    // (undocumented)
    static getFactory(): SharedMatrixFactory;
    // (undocumented)
    id: string;
    // (undocumented)
    insertCols(colStart: number, count: number): void;
    // (undocumented)
    insertRows(rowStart: number, count: number): void;
    // (undocumented)
    protected loadCore(storage: IChannelStorageService): Promise<void>;
    // (undocumented)
    get matrixProducer(): IMatrixProducer<MatrixItem<T>>;
    // (undocumented)
    protected onConnect(): void;
    // (undocumented)
    protected onDisconnect(): void;
    // (undocumented)
    openMatrix(consumer: IMatrixConsumer<MatrixItem<T>>): IMatrixReader<MatrixItem<T>>;
    openUndo(consumer: IUndoConsumer): void;
    // (undocumented)
    protected processCore(rawMessage: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
    protected processGCDataCore(serializer: SummarySerializer): void;
    // (undocumented)
    removeCols(colStart: number, count: number): void;
    // (undocumented)
    removeRows(rowStart: number, count: number): void;
    // (undocumented)
    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
    // (undocumented)
    get rowCount(): number;
    // (undocumented)
    setCell(row: number, col: number, value: MatrixItem<T>): void;
    // (undocumented)
    setCells(rowStart: number, colStart: number, colCount: number, values: readonly MatrixItem<T>[]): void;
    // (undocumented)
    protected submitLocalMessage(message: any, localOpMetadata?: any): void;
    // (undocumented)
    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
    // (undocumented)
    toString(): string;
    // @internal (undocumented)
    _undoRemoveCols(segment: ISegment): void;
    // @internal (undocumented)
    _undoRemoveRows(segment: ISegment): void;
}

// @public (undocumented)
export class SharedMatrixFactory implements IChannelFactory {
    // (undocumented)
    static readonly Attributes: IChannelAttributes;
    // (undocumented)
    get attributes(): IChannelAttributes;
    // (undocumented)
    create(document: IFluidDataStoreRuntime, id: string): IChannel;
    // (undocumented)
    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IChannel>;
    // (undocumented)
    static Type: string;
    // (undocumented)
    get type(): string;
}

// (No @packageDocumentation comment for this package)