SegmentGroupCollection Class
Signature
export declare class SegmentGroupCollection
Constructors
| Constructor | Description |
|---|---|
| (constructor)(segment) | Constructs a new instance of the SegmentGroupCollection class |
Properties
| Property | Type | Description |
|---|---|---|
| empty | boolean | |
| size | number |
Methods
| Method | Return Type | Description |
|---|---|---|
| clear() | void | |
| copyTo(segment) | void | |
| dequeue() | SegmentGroup | undefined | |
| enqueue(segmentGroup) | void |
Constructor Details
(constructor)
Constructs a new instance of the SegmentGroupCollection class
Signature
constructor(segment: ISegment);
Parameters
| Parameter | Type | Description |
|---|---|---|
| segment | ISegment |
Property Details
empty
Signature
get empty(): boolean;
Type: boolean
size
Signature
get size(): number;
Type: number
Method Details
clear
Signature
clear(): void;
copyTo
Signature
copyTo(segment: ISegment): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| segment | ISegment |
dequeue
Signature
dequeue(): SegmentGroup | undefined;
Returns
Return type: SegmentGroup | undefined
enqueue
Signature
enqueue(segmentGroup: SegmentGroup): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| segmentGroup | SegmentGroup |