SubSequence Class

Packages > fluid-framework > SubSequence

Signature:

export declare class SubSequence<T> extends BaseSegment 

Extends:

Type parameters:

T

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(items) Constructs a new instance of the SubSequence class

Properties

List of properties for this class
Property Modifiers Type Description
items
type
typeString static

Methods

List of methods on this class
Method Modifiers Description
append(segment)
canAppend(segment)
clone(start, end)
createSplitSegmentAt(pos)
fromJSONObject(spec) static
is(segment) static
removeRange(start, end)
toJSONObject()
toString()

Constructors

SubSequence.(constructor)

Constructs a new instance of the SubSequence class

Signature:

constructor(items: Serializable<T>[]);

Parameters

List of parameters
Parameter Type Description
items

Properties

items

Signature:

items: Serializable<T>[];

type

Signature:

readonly type: string;

typeString

Signature:

static readonly typeString: string;

Methods

append

Signature:

append(segment: ISegment): void;

Parameters

List of parameters
Parameter Type Description
segment

Returns:

canAppend

Signature:

canAppend(segment: ISegment): boolean;

Parameters

List of parameters
Parameter Type Description
segment

Returns:

clone

Signature:

clone(start?: number, end?: number): SubSequence<T>;

Parameters

List of parameters
Parameter Type Description
start
end

Returns:

SubSequence

createSplitSegmentAt

Signature:

protected createSplitSegmentAt(pos: number): SubSequence<T>;

Parameters

List of parameters
Parameter Type Description
pos

Returns:

SubSequence

fromJSONObject

Signature:

static fromJSONObject<U>(spec: Serializable): SubSequence<U>;

Parameters

List of parameters
Parameter Type Description
spec

Returns:

SubSequence

is

Signature:

static is(segment: ISegment): segment is SubSequence<any>;

Parameters

List of parameters
Parameter Type Description
segment

Returns:

SubSequence

removeRange

Signature:

removeRange(start: number, end: number): boolean;

Parameters

List of parameters
Parameter Type Description
start
end

Returns:

toJSONObject

Signature:

toJSONObject(): IJSONRunSegment<T>;

Returns:

IJSONRunSegment

toString

Signature:

toString(): string;

Returns: