@sscovil/grid v1.0.0

Grid

The Grid object provides a 2D interface for a flat array, so elements can be accessed using x and y coordinates. Helper functions have been provided to convert an array index to GridCoords and vice versa; and items can be retrieved or added to the array using either of the two.

Additionally, Grid provides methods for retrieving all coordinates, indices, or items adjacent to a given index or coordinate, based on the number of rows and cols it was initialized with.

This package includes TypeScript type declarations, has full test coverage, and has no dependencies.

Installation

Yarn

yarn add @sscovil/grid

NPM

npm install @sscovil/grid

Usage

ES Module Syntax

import Grid from '@sscovil/grid'

CommonJS Syntax

const Grid = require('@sscovil/grid')

Examples

Say you want a grid with three columns and four rows, with cells containing letters A through L.

To create this as a Grid object, you can do the following:

const rows = 4
const cols = 3
const items: string[] = new Array(rows * cols)

for (let i = 0; i < items.length; i++) {
  items[i] = String.fromCharCode(65 + i) // set array values to letters A through L
}

const grid = new Grid<string>(rows, cols, items)

In the Grid object, the x coordinate would be 0 for the first column, 1, for the second column, and 2 for the third column. Likewise, the y coordinate would be 0 for the first row, 1 for the second row, 2 for the third row, and 3 for the fourth row.

To get grid coordinates of H:

const xy = grid.coordsOf('H')

expect(xy).toEqual({ x: 1, y: 2 })

To get the array index of H:

const index = grid.indexOf('H')

expect(index).toEqual(7)

To get H using its grid coordinates:

const valueAtCoords = grid.get({ x: 1, y: 2 })

expect(valueAtCoords).toBe('H')

To get H using its array index:

const valueAtIndex = grid.get(7)

expect(valueAtIndex).toBe('H')

To change the value of H using its grid coordinates:

grid.set({ x: 1, y: 2 }, 'FOO')

expect(grid.get(7)).toBe('FOO')
expect(grid.get({ x: 1, y: 2 })).toBe('FOO')

To change the value of H using its array index:

grid.set(7, 'BAR')

expect(grid.get(7)).toBe('BAR')
expect(grid.get({ x: 1, y: 2 })).toBe('BAR')

To get all the values adjacent to H by its coordinate:

const adjacentByCoords = grid.getAdjacent({ x: 1, y: 2 })

expect(adjacentByCoords).toEqual(['D', 'E', 'F', 'G', 'I', 'J', 'K', 'L'])

To get all the items adjacent to H by its array index:

const adjacentByIndex = grid.getAdjacent(7)

expect(adjacentByIndex).toEqual(['D', 'E', 'F', 'G', 'I', 'J', 'K', 'L'])

To get all adjacent coordinates of H by its grid coordinate:

const adjacentCoords = grid.getAdjacentCoords({ x: 1, y: 2 })

expect(adjacentCoords).toEqual([
  { x: 0, y: 1 },
  { x: 1, y: 1 },
  { x: 2, y: 1 },
  { x: 0, y: 2 },
  { x: 2, y: 2 },
  { x: 0, y: 3 },
  { x: 1, y: 3 },
  { x: 2, y: 3 },
])

To get all adjacent indices of H by its array index:

const adjacentIndices = grid.getAdjacentIndices(7)

expect(adjacentIndices).toEqual([3, 4, 5, 6, 8, 9, 10, 11])

To get the coordinate of H by its array index:

const xy = grid.getCoords(7)
const invalidXY = grid.getCoords(70) // assuming grid is not this big

expect(xy).toEqual({ x: 1, y: 2 })
expect(invalidXY).toEqual({ x: -1, y: -1 })

To get the index of H by its grid coordinate:

const index = grid.getIndex({ x: 1, y: 2 })
const invalidIndex = grid.getIndex({ x: 10, y: 20 }) // assuming grid is not this big

expect(index).toBe(7)
expect(invalidIndex).toBe(-1)

To check if a coordinate is within the range of the grid:

const validXY = grid.isValidCoords({ x: 1, y: 2 })
const invalidXY = grid.isValidCoords({ x: 10, y: 20 }) // assuming grid is not this big

expect(validXY).toBe(true)
expect(invalidXY).toBe(false)

To check if an array index is within the range of the grid:

const validIndex = grid.isValidIndex(7)
const invalidIndex = grid.isValidIndex(70) // assuming grid is not this big

expect(validIndex).toBe(true)
expect(invalidIndex).toBe(false)

The items property is the array used to store data in the grid, and can be directly accessed:

const allItems = grid.items.map((item) => item)
const notEmpty = grid.items.filter((item) => item !== undefined)

Avoid directly modifying the items array; use the get and set methods instead.

API Reference

Constructor

Grid()

Creates a new Grid object. Requires two numeric arguments: rows and cols. Accepts an array as an optional third argument. If provided, the array elements will be used to populate the items array of the Grid instance.

Static Methods

Grid.isGridCoords()

Returns true if the argument implements the GridCoords interface, or false otherwise.

Grid.isEqualCoords()

Returns true if both arguments implement the GridCoords interface and have equal x and y values.

Instance Properties

Grid.prototype.rows

Read-only value that reflects the number of rows in the grid.

Grid.prototype.cols

Read-only value that reflects the number of columns in the grid.

Grid.prototype.size

Computed value that equals the number of rows multiplied by the number of columns in the grid.

Grid.prototype.items

Array used to store items in the grid. Avoid directly modifying the array; use the get and set methods instead.

Instance Methods

Grid.prototype.coordsOf()

Returns the grid coordinate of the item provided as an argument if present in the grid, or { x: -1, y: -1 } otherwise. This uses Array.prototype.indexOf() under the hood, so it behaves the same way.

Grid.prototype.get()

Returns the item located at the grid coordinate or array index provided as an argument.

Grid.prototype.getAdjacent()

Returns an array of up to eight items located around the grid coordinate or array index provided as an argument. Items at the corners of a grid will only have three adjacent items; and items along the edges of the grid will only have five.

Grid.prototype.getAdjacentCoords()

Returns an array of up to eight grid coordinates adjacent to the coordinate provided as an argument. Items at the corners of a grid will only have three adjacent coordinates; and items along the edges of the grid will only have five.

Grid.prototype.getAdjacentIndices()

Returns an array of up to eight array indices adjacent to the index provided as an argument. Items at the corners of a grid will only have three adjacent indices; and items along the edges of the grid will only have five.

Grid.prototype.getCoords()

Returns the grid coordinate of the array index provided as an argument if valid, or { x: -1, y: -1 } otherwise.

Grid.prototype.getIndex()

Returns the array index of the grid coordinate provided as an argument if valid, or -1 otherwise.

Grid.prototype.indexOf()

Returns the array index of the item provided as an argument if present in the grid, or -1 otherwise. This uses Array.prototype.indexOf() under the hood, so it behaves the same way.

Grid.prototype.isValidCoords()

Returns true if the argument implements the GridCoords interface and is within the range of the grid items array, or false otherwise.

Grid.prototype.isValidIndex()

Returns true if the argument is within the range of the grid items array.

Grid.prototype.set()

Sets the value of the item located at the grid coordinate or array index provided as the first argument, using the value of the second argument.

Interfaces

GridCoords

Any object that contains x and y properties with numeric values implements the GridCoords interface.

interface GridCoords {
  x: number
  y: number
}

Running Tests

Yarn

yarn test

NPM

npm test