Skip to main content
Version: v1

SubSequence Class

Signature​

export declare class SubSequence<T> extends BaseSegment

Extends: BaseSegment

Type Parameters​

ParameterDescription
T

Constructors​

ConstructorDescription
(constructor)(items)Constructs a new instance of the SubSequence class

Static Properties​

PropertyTypeDescription
typeStringstring

Static Methods​

MethodReturn TypeDescription
fromJSONObject(spec)SubSequence<U>
is(segment)segment is SubSequence<any>

Properties​

PropertyTypeDescription
itemsSerializable<T>[]
typestring

Methods​

MethodReturn TypeDescription
append(segment)void
canAppend(segment)boolean
clone(start, end)SubSequence<T>
createSplitSegmentAt(pos)SubSequence<T>
removeRange(start, end)boolean
toJSONObject()IJSONRunSegment<T>
toString()string

Constructor Details​

(constructor)​

Constructs a new instance of the SubSequence class

Signature​

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

Parameters​

ParameterTypeDescription
itemsSerializable<T>[]

Property Details​

items​

Signature​

items: Serializable<T>[];

Type: Serializable<T>[]

type​

Signature​

readonly type: string;

Type: string

typeString​

Signature​

static readonly typeString: string;

Type: string

Method Details​

append​

Signature​

append(segment: ISegment): void;

Parameters​

ParameterTypeDescription
segmentISegment

canAppend​

Signature​

canAppend(segment: ISegment): boolean;

Parameters​

ParameterTypeDescription
segmentISegment

Returns​

Return type: boolean

clone​

Signature​

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

Parameters​

ParameterModifiersTypeDescription
startoptionalnumber
endoptionalnumber

Returns​

Return type: SubSequence<T>

createSplitSegmentAt​

Signature​

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

Parameters​

ParameterTypeDescription
posnumber

Returns​

Return type: SubSequence<T>

fromJSONObject​

Signature​

static fromJSONObject<U>(spec: Serializable): SubSequence<U>;
Type Parameters​
ParameterDescription
U

Parameters​

ParameterTypeDescription
specSerializable

Returns​

Return type: SubSequence<U>

is​

Signature​

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

Parameters​

ParameterTypeDescription
segmentISegment

Returns​

Return type: segment is SubSequence<any>

removeRange​

Signature​

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

Parameters​

ParameterTypeDescription
startnumber
endnumber

Returns​

Return type: boolean

toJSONObject​

Signature​

toJSONObject(): IJSONRunSegment<T>;

Returns​

Return type: IJSONRunSegment<T>

toString​

Signature​

toString(): string;

Returns​

Return type: string