ISharedString Interface

Packages > @fluidframework/sequence > ISharedString

Fluid object interface describing access methods on a SharedString

Signature:

export interface ISharedString extends SharedSegmentSequence<SharedStringSegment> 

Extends: SharedSegmentSequence<SharedStringSegment>

Methods

List of methods of this class
Method Description
insertMarker(pos, refType, props)
insertText(pos, text, props)
posFromRelativePos(relativePos)

Methods

insertMarker

Signature:

insertMarker(pos: number, refType: MergeTree.ReferenceType, props?: MergeTree.PropertySet): any;

Parameters

List of parameters
Parameter Type Description
pos number
refType MergeTree.ReferenceType
props MergeTree.PropertySet

Returns:

any

insertText

Signature:

insertText(pos: number, text: string, props?: MergeTree.PropertySet): any;

Parameters

List of parameters
Parameter Type Description
pos number
text string
props MergeTree.PropertySet

Returns:

any

posFromRelativePos

Signature:

posFromRelativePos(relativePos: MergeTree.IRelativePosition): any;

Parameters

List of parameters
Parameter Type Description
relativePos MergeTree.IRelativePosition

Returns:

any