@segment/a1-notation/README.md

Work with A1 notation like "A1" or "A1:B2"

# A1 notation

### About
This library is for working with A1 notations such as "A1" or "A1:B2". The library is exported as a UMD module.

### Install
```
npm i @segment/a1-notation -d
```
Or
```
yarn add @segment/a1-notation
```

### Download
[4]: dist/index.next.min.js
[5]: dist/index.umd.js

[ESNext.min(5 KB)][4], [UMD(22 KB)][5]

### What is the difference?

[11]: https://www.google.com/search?q=js+umd+is
[12]: src/converters.ts#L13
[13]: src/converters.ts#L30

* **converter 1** or **converter 2**? The difference is in the algorithm of convertation. You can compare [the first method][12] with [the second method][13].
* **"ES5" or "ESNext"?** ES5 has already converted to ES5 standard with all needed polyfills. ESNext uses the original syntax of the code.
* **"UMD"?** UMD - Unified Module Definition, more in [Google][11].
* **".min"?** Minified version.
* **Default version** in npm is UMD ESNext. This version is not transpiled and minified, so you need to transpile and minify it.

## Initialization
```js
import A1 from '@segment/a1-notation';
// or
const A1 = require('@segment/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](docs/method-static-isValid.md#isvalid)
- [static getCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getcol)
- [static getLastCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getlastcol)
- [static getRow(a1: string): number](docs/method-static-get.md#getrow)
- [static getLastRow(a1: string): number](docs/method-static-get.md#getlastrow)
- [static getWidth(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getwidth)
- [static getHeight(a1: string): number](docs/method-static-get.md#getheight)
- [static toCol(col: number): string](docs/method-static-to.md#tocol)
- [static toRow(row: number): string](docs/method-static-to.md#torow)
- [constructor](docs/constructor.md#constructor)
- [get(): string](docs/method-get.md#get)
- [toString(): string](docs/method-get.md#tostring)
- [toJSON(): result](docs/method-get.md#tojson)
- [getCol(): number](docs/method-get.md#getcol)
- [getLastCol(): number](docs/method-get.md#getlastcol)
- [getRow(): number](docs/method-get.md#getrow)
- [getLastRow(): number](docs/method-get.md#getlastrow)
- [getWidth(): number](docs/method-get.md#getwidth)
- [getHeight(): number](docs/method-get.md#getheight)
- [setCol(val: string | number): this](docs/method-set.md#setcol)
- [setLastCol(val: string | number): this](docs/method-set.md#setlastcol)
- [setRow(val: string | number): this](docs/method-set.md#setrow)
- [setLastRow(val: string | number): this](docs/method-set.md#setlastrow)
- [copy(): A1](docs/method-copy.md#copy)
- [addX(count: number): this](docs/method-add.md#addx)
- [addY(count: number): this](docs/method-add.md#addy)
- [add(countX: number, countY: number): this](docs/method-add.md#add)
- [removeX(count: number): this](docs/method-remove.md#removex)
- [removeY(count: number): this](docs/method-remove.md#removey)
- [remove(countX: number, countY: number): this](docs/method-remove.md#remove)
- [shiftX(offset: number): this](docs/method-shift.md#shiftx)
- [shiftY(offset: number): this](docs/method-shift.md#shifty)
- [shift(offsetX: number, offsetY: number): this](docs/method-shift.md#shift)

## License
[MIT](LICENSE)

## Changelog
[The latest updates](CHANGELOG.md)