A1 notation

About

This library is for working with A1 notations such as "A1" or "A1:B2". It's published for both ESM (import) and CommonJS (require), so it works on new and old Node alike.

Install

npm i @flighter/a1-notation -d

Or

yarn add @flighter/a1-notation

Download

Browser IIFE, minified (5 KB), ESM, CommonJS

What is the difference?

• converter 1 or converter 2? The difference is in the algorithm of convertation. You can compare the first method with the second method.
• Browser IIFE? Minified bundle for a direct <script> tag (exposes a global A1).
• ESM/CommonJS? Both are the same code, published untranspiled/unminified so your own bundler can process them; import/require resolve to the right one automatically via package.json#exports.

Initialization

// ESM
import A1 from '@flighter/a1-notation';

// CommonJS
const A1 = require('@flighter/a1-notation');

API

Note: A1 string could be represented in any register. A1 === a1, A1:B2 === a1:b2 === A1:b2 === a1:B2

• static isValid(a1: string): boolean
• static getCol(a1: string, converter: 1 | 2 = 1): number
• static getLastCol(a1: string, converter: 1 | 2 = 1): number
• static getRow(a1: string): number
• static getLastRow(a1: string): number
• static getWidth(a1: string, converter: 1 | 2 = 1): number
• static getHeight(a1: string): number
• static toCol(col: number): string
• static toRow(row: number): string
• constructor
• get(): string
• toString(): string
• toJSON(): result
• getCol(): number
• getLastCol(): number
• getRow(): number
• getLastRow(): number
• getWidth(): number
• getHeight(): number
• setCol(val: string | number): this
• setLastCol(val: string | number): this
• setRow(val: string | number): this
• setLastRow(val: string | number): this
• copy(): A1
• addX(count: number): this
• addY(count: number): this
• add(countX: number, countY: number): this
• removeX(count: number): this
• removeY(count: number): this
• remove(countX: number, countY: number): this
• shiftX(offset: number): this
• shiftY(offset: number): this
• shift(offsetX: number, offsetY: number): this

License

MIT

Changelog

The latest updates