Namespace PositionHelpers

Index

Functions

Functions

getRoundedPosition

getRoundedPosition(position: Position): { x: number; y: number }

- Defined in helpers/position/position.ts:62
Rounds the value of a Position.

Parameters
- position: Position
  
  A Position.
Returns { x: number; y: number }
The Position with x and y rounded.
- x: number
- y: number

isPositionWithinGrid

isPositionWithinGrid(grid: any[][], position: Position): boolean

- Defined in helpers/position/position.ts:73
Whether a Position is within the boundaries a two dimensional array.

Parameters
- grid: any[][]
  
  A two dimensional array.
- position: Position
  
  A Position.
Returns boolean
true if the Position is within the boundaries of the grid.

positionToString

positionToString(position: Position, separator?: string): string

- Defined in helpers/position/position.ts:10
Converts a Position to a string value.

Parameters
- position: Position
  
  A Position.
- Optional separator: string
  
  An optional separator, default is ,.
Returns string
A string representation of the Position.

stringToPosition

stringToPosition(position: string, separator?: string): Position

- Defined in helpers/position/position.ts:24
Converts a Position represented as a string to a Position value.

throws
On invalid string value.

Parameters
- position: string
  
  A Position.
- Optional separator: string
  
  An optional separator, default is ,.
Returns Position
A Position.

Generated using TypeDoc