Class: Point

Constructor

new Point(x, y)

Creates a new Point

Parameters:

Name	Type	Description
`x`	number	The x coordinate. (Can be any number from 0 to process.stdout.columns)
`y`	number	The y coordinate. (Can be any number from 0 to process.stdout.rows)

Source: geo.js, line 43

Throws:

If the arguments are invalid or out of bounds
Type Error

Example

// Create a new point at (10, 10)
const point = new Point(10, 10);

Members

x :number

The x coordinate

Type:

number

Source: geo.js, line 56

y :number

The y coordinate

Type:

number

Source: geo.js, line 61

Methods

equals(x, yopt) → {boolean}

Determines whether or not the point is equal to another point

Parameters:

Name	Type	Attributes	Description
`x`	PointLike		The point to compare to, or the x coordinate
`y`	number	<optional>	The y coordinate

Source: geo.js, line 79

Returns:

Whether or not the points are equal

Type:: boolean

transform(matrix)

Transforms the point by the given matrix

Parameters:

Name	Type	Description
`matrix`	Matrix	The matrix to transform the point by

Source: geo.js, line 68

(static) center() → {Point}

Creates a new point at the center of the terminal

Source: geo.js, line 87

Returns:

The center point

Type:: Point

(static) centerFor(x, yopt) → {Point}

Parameters:

Name	Type	Attributes	Description
`x`	PointLike		The point or size to center, or the x coordinate
`y`	number	<optional>	The y coordinate

Source: geo.js, line 97

Returns:

Type:: Point

(static) inBounds(px, yopt) → {boolean}

Determines whether or not the given point is within the bounds of the terminal

Parameters:

Name	Type	Attributes	Description
`px`	PointLike		The point or size to check, or the x coordinate
`y`	number	<optional>	The y coordinate

Source: geo.js, line 116

Throws:

If the arguments are invalid
Type Error

Returns:

Whether or not the point is within the bounds of the terminal

Type:: boolean

(static) of(psx, yopt) → {Point}

Creates a new point from the given point, size, array, or coordinates

Parameters:

Name	Type	Attributes	Description
`psx`	Point \| Size \| number \| Array.<number> \| Object		The point or size to create a new point from, or the x coordinate
`y`	number	<optional>	The y coordinate

Source: geo.js, line 126

Returns:

The new point

Type:: Point

(static) zero() → {Point}

Creates a new point at (0, 0)

Source: geo.js, line 105

Returns:

A new point at (0, 0)

Type:: Point