Difference between getValue() and getDisplayValue() on google app script
getDisplayValue
returns the value as you see in the screen, therefore always a string, while getValue
returns the value underneath, therefore an object. Which may be a string if the range has text in it.
The difference is more clear if the range has numbers or dates in it. Specially if the spreadsheet locale formats the numbers with commas as decimal separators or if you set custom formats in your ranges.
To elaborate more on the accepted answer.
According to the official documentation.
getDisplayValue():
Returns the displayed value of the top-left cell in the range. The value is a String. The displayed value takes into account date, time and currency formatting formatting, including formats applied automatically by the spreadsheet's locale setting. Empty cells return an empty string.
getValue():
Returns the value of the top-left cell in the range. The value may be of type
Number
,Boolean
,Date
, orString
depending on the value of the cell. Empty cells return an empty string.
Frequently asked questions in stackoverflow - use cases:
- A valid date object in a sheet would return a date object when using
getValue
but astring
(respecting the format) when usinggetDisplayValue
. - A valid boolean value in google sheets (
TRUE
,FALSE
) would returntrue
,false
boolean JavaScript objects when usinggetValue
but strings when usinggetDisplayValue
. This becomes quite handy when you want you useif
conditions. You can simply use the object itselfif(sheet.getRange('A1').getValue())
ifA1
contains a boolean value.
To add more to Henrique's explanation, here is an example from my experience.
I have a column where I enter time in IST
IST
--------
2:00 AM
And when I get the value of that column using,
var myTime = range.getValue();
which actually returned,
Sat Dec 30 1899 01:36:40 GMT+0530 (IST)
But range.getDisplayValue() solved my problem which returned what I have entered, 2:00 AM.