Point

A point representing a location (x, y) in two-dimensional coordinate space.

Name	Type	Default	Description
x	number		The X coordinate of the point.
y	number		The Y coordinate of the point.

Constructors

Point

(x?: number, y?: number)

Creates a point with the specified coordinates.

Parameters

x?

number

The X coordinate of the point.

y?

number

The Y coordinate of the point.

Methods

addObserver
Adds an observer to be notified for changes.
Parameters observer GeometryObserver The observer to add.
Returns Point The current Arc instance.

clone
Creates a new instance with the same coordinates.
Returns Point A new Point instance with the same coordinates.

create
Creates a Point instance with the specified coordinates.
Parameters x number The X coordinate of the point y number The Y coordinate of the point.
Returns Point The new Point instance.

create
Creates a Point instance with the specified coordinates.
Parameters coords number[] An array of X and Y coordinates.
Returns Point The new Point instance.

create
Returns the supplied Point instance.
Parameters point Point An existing Point instance.
Returns Point The supplied Point instance.

distanceTo
Calculates the distance to another point.
Parameters point Point The point to calculate the distance to.
Returns number The straight-line distance to the given point.

equals
Compares this point with another instance.
Parameters other Point The point to compare with.
Returns boolean true if the point coordinates match. Otherwise, returns false.

getX
Gets the x coordinate value.
Returns number The current X-coordinate value.

getY
Gets the Y-coordinate value.
Returns number The current Y-coordinate value.

max
Returns the Point with maximum X and Y coordinates.
Parameters points Point[] The points to evaluate.
Returns Point The Point with maximum X and Y coordinates.

maxPoint
Returns a Point with the largest representable coordinates.
Returns Point A new Point instance with maximum coordinates.

min
Returns the Point with minimum X and Y coordinates.
Parameters points Point[] The points to evaluate.
Returns Point The Point with minimum X and Y coordinates.

minPoint
Returns a Point with the smallest representable coordinates.
Returns Point A new Point instance with minimum coordinates.

move
Moves the point to the specified X and Y coordinates.
Parameters x number The new X coordinate. y number The new Y coordinate.
Returns Point The current point instance.

observers
Returns the list of observers.
Returns GeometryObserver[] The current observers.

removeObserver
Stops notifying the specified observer for changes.
Parameters observer GeometryObserver The observer to remove.
Returns Point The current Arc instance.

resume
Resumes the notification to all observers for changes.
Returns Point The current Arc instance.

rotate
Rotates the point around the given center.
Parameters angle number The angle in decimal degrees. Measured in a clockwise direction with 0 (zero) pointing "right". Negative values or values greater than 360 are normalized. center number[] | Point The rotation center. Can be a Point instance or an [x, y] array.
Returns Point The current Point instance.

round
Rounds the point coordinates to the specified number of fractional digits.
Parameters digits number The number of fractional digits.
Returns Point The current Point instance.

scale
Scales the point coordinates along the X and Y axis.
Parameters scaleX number The X scale multiplier. scaleY number The Y scale multiplier.
Returns Point The current Point instance.

scaleCopy
Scales the point coordinates on a copy of the current point. The callee coordinates will remain unchanged.
Parameters scaleX number The X scale multiplier. scaleY number The Y scale multiplier.
Returns Point The current Point instance.

setX
Sets the X coordinate to a new value.
Parameters value number The new X coordinate value.
Returns Point The current Point instance.

setY
Sets the Y coordinate to a new value.
Parameters value number The new Y coordinate value.
Returns Point The current Point instance.

suspend
Suspends the change notifications to all observers.
Returns Point The current Arc instance.

toArray
Returns the point coordinates as an [X, Y] array.
Parameters digits? number The number of fractional digits.
Returns number[] An array representation of the point. For example, [10, 20].

toString
Formats the point value to a string.
Parameters digits? number The number of fractional digits. separator? string The separator to place between coordinates.
Returns string A string representation of the point. For example, "10, 20".

transform
Applies a transformation to the point coordinates. The current coordinates will be overridden.
Parameters tansformation Transformation The transformation to apply.
Returns Point The current Point instance.

transformCopy
Applies a transformation on a copy of the current point. The callee coordinates will remain unchanged.
Parameters tansformation Transformation The transformation to apply.
Returns Point The new Point instance.

translate
Translates the point along the X and Y axis.
Parameters dx number The distance to move along the X axis. dy number The distance to move along the Y axis.
Returns Point The current Point instance.

translateWith
Translates the point by using a Point instance as a vector of translation.
Parameters vector number[] | Point The vector of translation. Can be either a Point instance or an [x, y] array.
Returns Point The current point instance.