Skip to main content

getFormat()

returns the number format applied to the value of a cell

getFormat: (cell: string) => string | string[];

Parameters:

cell: string - the id(s) of a cell(s) or a range of cells

Returns:

The format(s) applied to the value of the cell(s).

Example

var format = spreadsheet.getFormat("A1");
// ->"currency"

Starting with v4.1, the reference to a cell can be specified in the following format:

var cellFormat = spreadsheet.getFormat("sheet1!A2"); //-> "number"

where sheet1 is the name of the tab.

In case the name of the tab isn't specified, the method will return the format applied to the value of a cell from the tab that is currently active.

Related articles

Number formatting