API > @blocksuite/blocks > PointLocation

Class: PointLocation

Extends

Array< number >

Implements

IVec

Constructors

constructor

new PointLocation( point = ..., tangent = ..., inVec = ..., outVec = ...): PointLocation

Parameters

Parameter	Type
`point`	`IVec`
`tangent`	`IVec`
`inVec`	`IVec`
`outVec`	`IVec`

Returns

PointLocation

Overrides

Array<number>.constructor

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:9

Properties

[unscopables]

readonly [unscopables]: object

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Type declaration

[unscopables].[unscopables]
optional readonly [unscopables]: boolean
Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
[unscopables].length
optional length: boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
[unscopables].[iterator]
optional [iterator]
[unscopables].at
optional at
[unscopables].concat
optional concat
[unscopables].copyWithin
optional copyWithin
[unscopables].entries
optional entries
[unscopables].every
optional every
[unscopables].fill
optional fill
[unscopables].filter
optional filter
[unscopables].find
optional find
[unscopables].findIndex
optional findIndex
[unscopables].findLast
optional findLast
[unscopables].findLastIndex
optional findLastIndex
[unscopables].flat
optional flat
[unscopables].flatMap
optional flatMap
[unscopables].forEach
optional forEach
[unscopables].includes
optional includes
[unscopables].indexOf
optional indexOf
[unscopables].join
optional join
[unscopables].keys
optional keys
[unscopables].lastIndexOf
optional lastIndexOf
[unscopables].map
optional map
[unscopables].pop
optional pop
[unscopables].push
optional push
[unscopables].reduce
optional reduce
[unscopables].reduceRight
optional reduceRight
[unscopables].reverse
optional reverse
[unscopables].shift
optional shift
[unscopables].slice
optional slice
[unscopables].some
optional some
[unscopables].sort
optional sort
[unscopables].splice
optional splice
[unscopables].toLocaleString
optional toLocaleString
[unscopables].toReversed
optional toReversed
[unscopables].toSorted
optional toSorted
[unscopables].toSpliced
optional toSpliced
[unscopables].toString
optional toString
[unscopables].unshift
optional unshift
[unscopables].values
optional values
[unscopables].with
optional with

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Implementation of

IVec.[unscopables]

Inherited from

Array.[unscopables]

_in

_in: IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:6

_out

_out: IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:7

_tangent

_tangent: IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:5

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1318

Implementation of

IVec.length

Inherited from

Array.length

[species]

static readonly [species]: ArrayConstructor

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316

Inherited from

Array.[species]

Accessors

absIn

get absIn(): number[]

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:48

absOut

get absOut(): number[]

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:60

in

get in(): IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:44

packages/blocks/src/surface-block/utils/point-location.ts:52

out

get out(): IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:56

packages/blocks/src/surface-block/utils/point-location.ts:64

tangent

get tangent(): IVec

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:36

packages/blocks/src/surface-block/utils/point-location.ts:40

Methods

[iterator]

[iterator](): IterableIterator< number >

Iterator

Returns

IterableIterator< number >

Implementation of

IVec.[iterator]

Inherited from

Array.[iterator]

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58

at

at(index): undefined | number

Returns the item located at the specified index.

Parameters

Parameter	Type	Description
`index`	`number`	The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | number

Implementation of

IVec.at

Inherited from

Array.at

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2022.array.d.ts:24

clone

clone(): PointLocation

Returns

PointLocation

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:68

concat

concat(...items): number[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Parameter	Type	Description
...`items`	`ConcatArray`< `number` >[]	Additional arrays and/or items to add to the end of the array.

Returns

number[]

Implementation of

IVec.concat

Inherited from

Array.concat

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1342

concat(...items): number[]

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

Parameter	Type	Description
...`items`	(`number` \| `ConcatArray`< `number` >)[]	Additional arrays and/or items to add to the end of the array.

Returns

number[]

Implementation of

IVec.concat

Inherited from

Array.concat

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1348

copyWithin

copyWithin( target, start, end?): PointLocation

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

Parameter	Type	Description
`target`	`number`	If target is negative, it is treated as length+target where length is the length of the array.
`start`	`number`	If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
`end`?	`number`	If not specified, length of the this object is used as its default value.

Returns

PointLocation

Implementation of

IVec.copyWithin

Inherited from

Array.copyWithin

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:62

entries

entries(): IterableIterator< [number, number] >

Returns an iterable of key, value pairs for every entry in the array

Returns

IterableIterator< [number, number] >

Implementation of

IVec.entries

Inherited from

Array.entries

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63

every

every<S>(predicate, thisArg?): this is S[]

Determines whether all the members of an array satisfy the specified test.

Type parameters

Parameter
`S` extends `number`

Parameters

Parameter	Type	Description
`predicate`	`function`	A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Implementation of

IVec.every

Inherited from

Array.every

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1425

every(predicate, thisArg?): boolean

Determines whether all the members of an array satisfy the specified test.

Parameters

Parameter	Type	Description
`predicate`	`function`	A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Implementation of

IVec.every

Inherited from

Array.every

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1434

fill

fill( value, start?, end?): PointLocation

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

Parameter	Type	Description
`value`	`number`	value to fill array section with
`start`?	`number`	index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
`end`?	`number`	index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

PointLocation

Implementation of

IVec.fill

Inherited from

Array.fill

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:51

filter

filter<S>(predicate, thisArg?): S[]

Returns the elements of an array that meet the condition specified in a callback function.

Type parameters

Parameter
`S` extends `number`

Parameters

Parameter	Type	Description
`predicate`	`function`	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Implementation of

IVec.filter

Inherited from

Array.filter

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1461

filter(predicate, thisArg?): number[]

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

Parameter	Type	Description
`predicate`	`function`	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

number[]

Implementation of

IVec.filter

Inherited from

Array.filter

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1467

find

find<S>(predicate, thisArg?): undefined | S

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters

Parameter
`S` extends `number`

Parameters

Parameter	Type	Description
`predicate`	`function`	find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
`thisArg`?	`any`	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Implementation of

IVec.find

Inherited from

Array.find

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:29

find(predicate, thisArg?): undefined | number

Parameters

Parameter	Type
`predicate`	`function`
`thisArg`?	`any`

Returns

undefined | number

Implementation of

IVec.find

Inherited from

Array.find

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:30

findIndex

findIndex(predicate, thisArg?): number

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

Parameter	Type	Description
`predicate`	`function`	find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
`thisArg`?	`any`	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Implementation of

IVec.findIndex

Inherited from

Array.findIndex

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:41

findLast

findLast<S>(predicate, thisArg?): undefined | S

Returns the value of the last element in the array where predicate is true, and undefined otherwise.

Type parameters

Parameter
`S` extends `number`

Parameters

Parameter	Type	Description
`predicate`	`function`	findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.
`thisArg`?	`any`	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Implementation of

IVec.findLast

Inherited from

Array.findLast

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:29

findLast(predicate, thisArg?): undefined | number

Parameters

Parameter	Type
`predicate`	`function`
`thisArg`?	`any`

Returns

undefined | number

Implementation of

IVec.findLast

Inherited from

Array.findLast

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:30

findLastIndex

findLastIndex(predicate, thisArg?): number

Returns the index of the last element in the array where predicate is true, and -1 otherwise.

Parameters

Parameter	Type	Description
`predicate`	`function`	findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
`thisArg`?	`any`	If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Implementation of

IVec.findLastIndex

Inherited from

Array.findLastIndex

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:41

flat

flat<A, D>(this, depth?): FlatArray< A, D >[]

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters

Parameter	Default
`A`	-
`D` extends `number`	`1`

Parameters

Parameter	Type	Description
`this`	`A`	-
`depth`?	`D`	The maximum recursion depth

Returns

FlatArray< A, D >[]

Implementation of

IVec.flat

Inherited from

Array.flat

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:79

flatMap

flatMap<U, This>(callback, thisArg?): U[]

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters

Parameter	Default
`U`	-
`This`	`undefined`

Parameters

Parameter	Type	Description
`callback`	`function`	A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
`thisArg`?	`This`	An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Implementation of

IVec.flatMap

Inherited from

Array.flatMap

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:68

forEach

forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Implementation of

IVec.forEach

Inherited from

Array.forEach

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1449

includes

includes(searchElement, fromIndex?): boolean

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

Parameter	Type	Description
`searchElement`	`number`	The element to search for.
`fromIndex`?	`number`	The position in this array at which to begin searching for searchElement.

Returns

boolean

Implementation of

IVec.includes

Inherited from

Array.includes

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

indexOf

indexOf(searchElement, fromIndex?): number

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

Parameter	Type	Description
`searchElement`	`number`	The value to locate in the array.
`fromIndex`?	`number`	The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Implementation of

IVec.indexOf

Inherited from

Array.indexOf

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1410

join

join(separator?): string

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

Parameter	Type	Description
`separator`?	`string`	A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Implementation of

IVec.join

Inherited from

Array.join

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1353

keys

keys(): IterableIterator< number >

Returns an iterable of keys in the array

Returns

IterableIterator< number >

Implementation of

IVec.keys

Inherited from

Array.keys

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68

lastIndexOf

lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

Parameter	Type	Description
`searchElement`	`number`	The value to locate in the array.
`fromIndex`?	`number`	The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Implementation of

IVec.lastIndexOf

Inherited from

Array.lastIndexOf

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1416

map

map<U>(callbackfn, thisArg?): U[]

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters

Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Implementation of

IVec.map

Inherited from

Array.map

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1455

pop

pop(): undefined | number

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | number

Implementation of

IVec.pop

Inherited from

Array.pop

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1331

push

push(...items): number

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

Parameter	Type	Description
...`items`	`number`[]	New elements to add to the array.

Returns

number

Implementation of

IVec.push

Inherited from

Array.push

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1336

reduce

reduce(callbackfn): number

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

number

Implementation of

IVec.reduce

Inherited from

Array.reduce

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1473

reduce(callbackfn, initialValue): number

Parameters

Parameter	Type
`callbackfn`	`function`
`initialValue`	`number`

Returns

number

Implementation of

IVec.reduce

Inherited from

Array.reduce

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1474

reduce<U>(callbackfn, initialValue): U

Type parameters

Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
`initialValue`	`U`	If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Implementation of

IVec.reduce

Inherited from

Array.reduce

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1480

reduceRight

reduceRight(callbackfn): number

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

number

Implementation of

IVec.reduceRight

Inherited from

Array.reduceRight

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1486

reduceRight(callbackfn, initialValue): number

Parameters

Parameter	Type
`callbackfn`	`function`
`initialValue`	`number`

Returns

number

Implementation of

IVec.reduceRight

Inherited from

Array.reduceRight

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1487

reduceRight<U>(callbackfn, initialValue): U

Type parameters

Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	`function`	A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
`initialValue`	`U`	If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Implementation of

IVec.reduceRight

Inherited from

Array.reduceRight

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1493

reverse

reverse(): number[]

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

number[]

Implementation of

IVec.reverse

Inherited from

Array.reverse

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1358

setVec

setVec(vec): PointLocation

Parameters

Parameter	Type
`vec`	`IVec`

Returns

PointLocation

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:30

shift

shift(): undefined | number

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | number

Implementation of

IVec.shift

Inherited from

Array.shift

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1363

slice

slice(start?, end?): number[]

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

Parameter	Type	Description
`start`?	`number`	The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
`end`?	`number`	The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

number[]

Implementation of

IVec.slice

Inherited from

Array.slice

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1373

some

some(predicate, thisArg?): boolean

Determines whether the specified callback function returns true for any element of an array.

Parameters

Parameter	Type	Description
`predicate`	`function`	A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
`thisArg`?	`any`	An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Implementation of

IVec.some

Inherited from

Array.some

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1443

sort

sort(compareFn?): PointLocation

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

Parameter	Type	Description
`compareFn`?	`function`	Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order. `[11,2,22,1].sort((a, b) => a - b)`

Returns

PointLocation

Implementation of

IVec.sort

Inherited from

Array.sort

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1384

splice

splice(start, deleteCount?): number[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Parameter	Type	Description
`start`	`number`	The zero-based location in the array from which to start removing elements.
`deleteCount`?	`number`	The number of elements to remove.

Returns

number[]

An array containing the elements that were deleted.

Implementation of

IVec.splice

Inherited from

Array.splice

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1391

splice( start, deleteCount, ...items): number[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Parameter	Type	Description
`start`	`number`	The zero-based location in the array from which to start removing elements.
`deleteCount`	`number`	The number of elements to remove.
...`items`	`number`[]	Elements to insert into the array in place of the deleted elements.

Returns

number[]

An array containing the elements that were deleted.

Implementation of

IVec.splice

Inherited from

Array.splice

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1399

toLocaleString

toLocaleString(): string

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Implementation of

IVec.toLocaleString

Inherited from

Array.toLocaleString

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1326

toReversed

toReversed(): number[]

Returns a copy of an array with its elements reversed.

Returns

number[]

Implementation of

IVec.toReversed

Inherited from

Array.toReversed

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:46

toSorted

toSorted(compareFn?): number[]

Returns a copy of an array with its elements sorted.

Parameters

Parameter	Type	Description
`compareFn`?	`function`	Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order. `[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]`

Returns

number[]

Implementation of

IVec.toSorted

Inherited from

Array.toSorted

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:57

toSpliced

toSpliced( start, deleteCount, ...items): number[]

Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

Parameters

Parameter	Type	Description
`start`	`number`	The zero-based location in the array from which to start removing elements.
`deleteCount`	`number`	The number of elements to remove.
...`items`	`number`[]	Elements to insert into the copied array in place of the deleted elements.

Returns

number[]

The copied array.

Implementation of

IVec.toSpliced

Inherited from

Array.toSpliced

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:66

toSpliced(start, deleteCount?): number[]

Copies an array and removes elements while returning the remaining elements.

Parameters

Parameter	Type	Description
`start`	`number`	The zero-based location in the array from which to start removing elements.
`deleteCount`?	`number`	The number of elements to remove.

Returns

number[]

A copy of the original array with the remaining elements.

Implementation of

IVec.toSpliced

Inherited from

Array.toSpliced

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:74

toString

toString(): string

Returns a string representation of an array.

Returns

string

Implementation of

IVec.toString

Inherited from

Array.toString

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1322

unshift

unshift(...items): number

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

Parameter	Type	Description
...`items`	`number`[]	Elements to insert at the start of the array.

Returns

number

Implementation of

IVec.unshift

Inherited from

Array.unshift

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1404

values

values(): IterableIterator< number >

Returns an iterable of values in the array

Returns

IterableIterator< number >

Implementation of

IVec.values

Inherited from

Array.values

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73

with

with(index, value): number[]

Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

Parameters

Parameter	Type	Description
`index`	`number`	The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
`value`	`number`	The value to write into the copied array.

Returns

number[]

The copied array with the updated value.

Implementation of

IVec.with

Inherited from

Array.with

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2023.array.d.ts:85

from

static from<T>(arrayLike): T[]

Creates an array from an array-like object.

Type parameters

Parameter
`T`

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`< `T` >	An array-like object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:70

static from<T, U>( arrayLike, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type parameters

Parameter
`T`
`U`

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`< `T` >	An array-like object to convert to an array.
`mapfn`	`function`	A mapping function to call on every element of the array.
`thisArg`?	`any`	Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:78

static from<T>(iterable): T[]

Creates an array from an iterable object.

Type parameters

Parameter
`T`

Parameters

Parameter	Type	Description
`iterable`	`Iterable`< `T` > \| `ArrayLike`< `T` >	An iterable object to convert to an array.

Returns

T[]

Inherited from

Array.from

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81

static from<T, U>( iterable, mapfn, thisArg?): U[]

Creates an array from an iterable object.

Type parameters

Parameter
`T`
`U`

Parameters

Parameter	Type	Description
`iterable`	`Iterable`< `T` > \| `ArrayLike`< `T` >	An iterable object to convert to an array.
`mapfn`	`function`	A mapping function to call on every element of the array.
`thisArg`?	`any`	Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89

fromVec

static fromVec(vec): PointLocation

Parameters

Parameter	Type
`vec`	`IVec`

Returns

PointLocation

Defined In

packages/blocks/src/surface-block/utils/point-location.ts:23

isArray

static isArray(arg): arg is any[]

Parameters

Parameter	Type
`arg`	`any`

Returns

arg is any[]

Inherited from

Array.isArray

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1505

of

static of<T>(...items): T[]

Returns a new array from a set of elements.

Type parameters

Parameter
`T`

Parameters

Parameter	Type	Description
...`items`	`T`[]	A set of elements to include in the new array object.

Returns

T[]

Inherited from

Array.of

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:84

Class: PointLocation ​

Extends ​

Implements ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined In ​

Properties ​

[unscopables] ​

Type declaration ​

[unscopables].[unscopables] ​

[unscopables].length ​

[unscopables].[iterator] ​

[unscopables].at ​

[unscopables].concat ​

[unscopables].copyWithin ​

[unscopables].entries ​

[unscopables].every ​

[unscopables].fill ​

[unscopables].filter ​

[unscopables].find ​

[unscopables].findIndex ​

[unscopables].findLast ​

[unscopables].findLastIndex ​

[unscopables].flat ​

[unscopables].flatMap ​

[unscopables].forEach ​

[unscopables].includes ​

[unscopables].indexOf ​

[unscopables].join ​

[unscopables].keys ​

[unscopables].lastIndexOf ​

[unscopables].map ​

[unscopables].pop ​

[unscopables].push ​

[unscopables].reduce ​

[unscopables].reduceRight ​

[unscopables].reverse ​

[unscopables].shift ​

[unscopables].slice ​

[unscopables].some ​

[unscopables].sort ​

[unscopables].splice ​

[unscopables].toLocaleString ​

[unscopables].toReversed ​

[unscopables].toSorted ​

[unscopables].toSpliced ​

[unscopables].toString ​

[unscopables].unshift ​

[unscopables].values ​

[unscopables].with ​

Defined In ​

Implementation of ​

Inherited from ​

_in ​

Defined In ​

_out ​

Defined In ​

_tangent ​

Defined In ​

length ​

Defined In ​

Implementation of ​

Inherited from ​

[species] ​

Defined In ​

Inherited from ​

Accessors ​

absIn ​

Defined In ​

absOut ​

Defined In ​

in ​

Defined In ​

out ​

Defined In ​

tangent ​

Defined In ​

Class: PointLocation

Extends

Implements

Constructors

constructor

Parameters

Returns

Overrides

Defined In

Properties

[unscopables]

Type declaration

`[unscopables].[unscopables]`

`[unscopables].length`

`[unscopables].[iterator]`

`[unscopables].at`

`[unscopables].concat`

`[unscopables].copyWithin`

`[unscopables].entries`

`[unscopables].every`

`[unscopables].fill`

`[unscopables].filter`

`[unscopables].find`

`[unscopables].findIndex`

`[unscopables].findLast`

`[unscopables].findLastIndex`

`[unscopables].flat`

`[unscopables].flatMap`

`[unscopables].forEach`

`[unscopables].includes`

`[unscopables].indexOf`

`[unscopables].join`

`[unscopables].keys`

`[unscopables].lastIndexOf`

`[unscopables].map`

`[unscopables].pop`

`[unscopables].push`

`[unscopables].reduce`

`[unscopables].reduceRight`

`[unscopables].reverse`

`[unscopables].shift`

`[unscopables].slice`

`[unscopables].some`

`[unscopables].sort`

`[unscopables].splice`

`[unscopables].toLocaleString`

`[unscopables].toReversed`

`[unscopables].toSorted`

`[unscopables].toSpliced`

`[unscopables].toString`

`[unscopables].unshift`

`[unscopables].values`

`[unscopables].with`

Defined In

Implementation of

Inherited from

_in

Defined In

_out

Defined In

_tangent

Defined In

length

Defined In

Implementation of

Inherited from

[species]

Defined In

Inherited from

Accessors

absIn

Defined In

absOut

Defined In

in

Defined In

out

Defined In

tangent

Defined In