API Reference › core-geometry› ArraysAndInterfaces › IndexedReadWriteXYCollection

IndexedReadWriteXYCollection Class

Abstract base class extends IndexedXYCollection with methods that modify the collection.

Extends

Extended by

Methods

Name Description
constructor(): IndexedReadWriteXYCollection    
clear(): void Abstract Remove all entries.  
pop(): void Abstract Remove the final point.  
push(point: Readonly<WritableXAndY>): void Abstract Push a (clone of) point onto the collection.  
pushXY(x?: number, y?: number): void Abstract Push a new point (given by xy coordinates) onto the collection.  
reverseInPlace(): void Abstract Reverse the points in place.  

Inherited methods

Name Inherited from Description
crossProductIndexIndexIndex(origin: number, indexA: number, indexB: number): undefined | number Abstract Inherited IndexedXYCollection Return the cross product of vectors from origin point at indexA to target points at indexB and indexC.
crossProductXAndYIndexIndex(origin: Readonly<WritableXAndY>, indexA: number, indexB: number): undefined | number Abstract Inherited IndexedXYCollection Return the cross product of vectors from origin to points at indexA and indexB.
getPoint2dAtCheckedPointIndex(index: number, result?: Point2d): undefined | Point2d Abstract Inherited IndexedXYCollection Get from index as a Point2d.
getVector2dAtCheckedVectorIndex(index: number, result?: Vector2d): undefined | Vector2d Abstract Inherited IndexedXYCollection Get from index as a Vector2d.
getXAtUncheckedPointIndex(pointIndex: number): number Inherited IndexedXYCollection Access x of indexed point.
getYAtUncheckedPointIndex(pointIndex: number): number Inherited IndexedXYCollection Access y of indexed point.
linearCombination(scales: number[], result?: Vector2d | Point2d): XY Inherited IndexedXYCollection Compute the linear combination s of the indexed p_i and given scales s_i.
vectorIndexIndex(indexA: number, indexB: number, result?: Vector2d): undefined | Vector2d Abstract Inherited IndexedXYCollection Return a vector from the point at indexA to the point at indexB.
vectorXAndYIndex(origin: Readonly<WritableXAndY>, indexB: number, result?: Vector2d): undefined | Vector2d Abstract Inherited IndexedXYCollection Return a vector from given origin to the point at indexB.

Inherited properties

Name Type Inherited from Description
length Accessor Abstract Inherited ReadOnly number IndexedXYCollection Read-only property for number of XY in the collection.

Defined in

Last Updated: 18 October, 2025