Returns valueIfTrue if condition returns true; returns valueIfFalse otherwise.

Syntax

if( condition, valueIfTrue, valueIfFalse )

condition: (Boolean) A test that determines whether valueIfTrue or valueIfFalse will be returned.

valueIfTrue: (Any Type) The value to be returned if condition returns true.

valueIfFalse: (Any Type) The value to be returned if condition returns false.

Returns

Any Type

Notes

Unlike most functions, if() does not always evaluate all of its parameters. When passed a single condition, the function evaluates the condition and then only the value parameter that is returned.

When null values are passed to the condition parameter, they are considered to be false.

When a list is passed to the condition parameter, it is treated as a list of conditions and the value parameters will be treated as lists of values to return. This means that when passed an empty list, if() always returns an empty list. When passed a list containing a single boolean and lists in the value parameters, only the first item of the selected list will be returned.

Examples

if(isleapyear(1996), 1, 0) returns 1

if(isleapyear(1997), 1, 0) returns 0

if(null, 1, 0) returns 0

if(true, 1, error("Doesn't get evaluated")) returns 1 (because the parameter with error() does not get evaluated)

if(true, { 2, 4, 6 }, { 1, 3, 5 }) returns { 2, 4, 6 }

if({true, false, true}, { 2, 4, 6 }, { 1, 3, 5 }) returns { 2, 3, 6 }

if({true}, { 2, 4, 6 }, { 1, 3, 5 }) returns { 2 }

if({}, { 2, 4, 6}, { 1, 3, 5 }) returns {}