@fluidframework/sequence Package

Packages > @fluidframework/sequence

Classes

List of classes contained in this package or namespace
Class Description
Interval
IntervalCollection
IntervalCollectionValueType
IntervalCollectionView
PaddingSegment
RunSegment
SequenceDeltaEvent The event object returned on sequenceDelta events.The properties of this object and its sub-objects represent a point in time state at the time the operation was applied. They will not take into any future modifications performed to the underlying sequence and merge tree.For group ops, each op will get it's own event, and the group op property will be set on the op args.Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
SequenceEvent Base class for SequenceDeltaEvent and SequenceMaintenanceEvent.The properties of this object and its sub-objects represent a point in time state at the time the operation was applied. They will not take into any future modifications performed to the underlying sequence and merge tree.
SequenceInterval
SequenceIntervalCollectionValueType
SequenceMaintenanceEvent The event object returned on maintenance events.The properties of this object and its sub-objects represent a point in time state at the time the operation was applied. They will not take into any future modifications performed to the underlying sequence and merge tree.
SharedIntervalCollection
SharedIntervalCollectionFactory The factory that defines the SharedIntervalCollection
SharedNumberSequence The SharedNumberSequence holds a sequence of numbers. Each number will be stored at a position within the sequence. See the sequence readme for details on working with sequences.
SharedNumberSequenceFactory
SharedObjectSequence The SharedObjectSequence holds a sequence of serializable objects. Each object will be stored at a position within the sequence. See the sequence readme for details on working with sequences.
SharedObjectSequenceFactory
SharedSegmentSequence
SharedSequence
SharedString The Shared String is a specialized data structure for handling collaborative text. It is based on a more general Sequence data structure but has additional features that make working with text easier.In addition to text, a Shared String can also contain markers. Markers can be used to store metadata at positions within the text, like the details of an image or Fluid object that should be rendered with the text.
SharedStringFactory
SparseMatrix
SparseMatrixFactory
SubSequence

Functions

List of functions contained in this package or namespace
Function Description
positionToRowCol(position)

Interfaces

List of interfaces contained in this package or namespace
Interface Description
IIntervalHelpers
IJSONRunSegment
ISequenceDeltaRange
ISerializableInterval
ISerializedInterval
ISharedIntervalCollection
ISharedSegmentSequenceEvents
ISharedString Fluid object interface describing access methods on a SharedString

Variables

List of variables contained in this package or namespace
Variable Description
maxCellPosition
maxCol
maxCols
maxRow
maxRows
rowColToPosition

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
DeserializeCallback
MatrixSegment
SharedStringSegment
SparseMatrixItem

Functions

positionToRowCol

Signature:

export declare function positionToRowCol(position: number): {
    row: number;
    col: number;
};

Parameters

List of parameters
Parameter Type Description
position number

Returns:

{ row: number; col: number; }

Variables

maxCellPosition

Signature:

maxCellPosition: number

maxCol

Signature:

maxCol = 2097152

maxCols

Signature:

maxCols: number

maxRow

Signature:

maxRow = 4294967295

maxRows

Signature:

maxRows: number

rowColToPosition

Signature:

rowColToPosition: (row: number, col: number) => number

Type Aliases

DeserializeCallback

Signature:

export declare type DeserializeCallback = (properties: MergeTree.PropertySet) => void;

MatrixSegment

Signature:

export declare type MatrixSegment = RunSegment | PaddingSegment;

SharedStringSegment

Signature:

export declare type SharedStringSegment = MergeTree.TextSegment | MergeTree.Marker;

SparseMatrixItem

Signature:

export declare type SparseMatrixItem = Jsonable<JsonablePrimitive | IFluidHandle>;