Skip to main content

Cell Info

Functions for obtaining information about A5 cells.

getNumCells​

Returns the number of cells at a given resolution level.

function getNumCells(resolution: number): number;

Parameters​

  • resolution (number) The resolution level

Return value​

  • (number) Number of cells at the given resolution

Example​

import { getNumCells } from 'a5-js';

console.log(getNumCells(0)); // 12
console.log(getNumCells(1)); // 60
console.log(getNumCells(2)); // 240
console.log(getNumCells(3)); // 960

cellArea​

Returns the area of a cell at a given resolution in square meters. Within a resolution level, all cells have exactly the same area.

function cellArea(resolution: number): number;

Parameters​

  • resolution (number) The resolution level

Return value​

  • (number) Area of a cell in square meters

Example​

import { cellArea } from 'a5-js';

console.log(cellArea(20)); // ~30 m²

cellEdgeLengthAvg​

Returns the average edge length of a cell at a given resolution in meters. Individual edge lengths vary from the average by roughly ±10%, depending on the cell's shape and its position on the globe.

function cellEdgeLengthAvg(resolution: number): number;

Parameters​

  • resolution (number) The resolution level

Return value​

  • (number) Average edge length of a cell in meters

Example​

import { cellEdgeLengthAvg } from 'a5-js';

console.log(cellEdgeLengthAvg(2)); // ~1,190,000 m
console.log(cellEdgeLengthAvg(10)); // ~4,680 m