LOOKUP

Looks up a value either from a one-row or one-column range. Provided for backwards compatibility.

Syntax

expression.LOOKUP(arg1, arg2, arg3);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
arg1	Required	number | string | boolean | ApiRange | ApiName		A value that is searched for in the first vector. It can be a number, text, a logical value, or a name or reference to a value.
arg2	Required	ApiRange | ApiName		A range that contains only one row or one column of text, numbers, or logical values, placed in ascending order.
arg3	Optional	ApiRange | ApiName		A range that contains only one row or column. It must be the same size as the first vector.

Returns

number | string | boolean

Example

• Code
• Result

let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
let ids = ["ID", 1, 2, 3, 4, 5];
let clients = ["Client", "John Smith", "Ella Tompson", "Mary Shinoda", "Lily-Ann Bates", "Clara Ray"];
let phones = ["Phone number", "12054097166", "13343943678", "12568542099", "12057032298", "12052914781"];

for (let i = 0; i < ids.length; i++) {
    worksheet.GetRange("A" + (i + 1)).SetValue(ids[i]);
}
for (let j = 0; j < clients.length; j++) {
    worksheet.GetRange("B" + (j + 1)).SetValue(clients[j]);
}
for (let n = 0; n < phones.length; n++) {
    worksheet.GetRange("C" + (n + 1)).SetValue(phones[n]);
}

worksheet.GetRange("E1").SetValue("Name");
worksheet.GetRange("E2").SetValue("Ella Tompson");
worksheet.GetRange("F1").SetValue("Phone number");
let range1 = worksheet.GetRange("B2:B5");
let range2 = worksheet.GetRange("C2:C5");
worksheet.GetRange("F2").SetValue(func.LOOKUP("Ella Tompson", range1, range2));