In this article:

All | Text | Date | Number | Aggregate | Filters | Lookups | Period | Queries | Math | System | Financial | Conditional | Common | Special

All | Text | Date | Number | Aggregate | Filters | Lookups | Period | Queries | Math | System | Financial | Conditional | Common | Special

These functions perform a lookup on a data range using the provided value and return the result.

Returns the cell reference for the given row and column.

ADDRESS(row, column)

Example:

ADDRESS(2, 3) = "C2"

Returns the number of cells in the given cell range or data array.

CELLS(data)

Example:

CELLS(A1:C4) = 12

Returns the value in the cell with the given cell reference. You can optionally provide the sheet name (as text), else the default sheet (the first or only sheet) will be used.

This is only relevant in models and enables you to obtain the value in a cell by setting a dynamic reference to that cell. This enables you to dynamically change the reference to a cell within a formula without having to change the formula itself.

Please be aware that sheet and cell references made via CELLVALUE are not adjusted when sheets are renamed and/or rows or columns are inserted or deleted. CELLVALUE enables you to set your own dynamic references to cell positions within a model, and is therefore never adjusted.

CELLVALUE(cell, sheet)

Example:

CELLVALUE("C2") = 25

CELLVALUE("C2", "Sheet1") = 25

Returns the value of the given index in the given cell range, data array, or comma-delimited list of values.

CHOOSE(data, index)

Returns the number of columns in the given cell range or data array. The range must contain only one row.

COLUMNS(data)

Example:

COLUMNS(A1:E1) = 5

Compares the values in the 2 given cell ranges or data arrays, and returns the
outcome defined by the *type* parameter. Both ranges need to be of comparable
size. The common use-case for this function is to understand the difference in
values between 2 ranges.

COMPARE(data, range, type)

Type:

0 - returns true if the values in both ranges are the
same, else returns false (default)

1 - returns the number of values that
differ between both ranges

2 - returns the changed values as a comma-delimited
list

3 - returns the changed values and the compared values as a
comma-delimited list

Example:

COMPARE(A1:A5, B1:B5, 3) = "Peter Smith
(John Smith)"

Returns a list with sorted distinct values that occur in the given cell range, data array, or comma-delimited list of values.

DISTINCT(data)

Example:

data = "a,a,b,a,c,b,c,b,a"

DISTINCT(data) = "a,b,c"

Returns the value or text that resides between the 2 given keys. This function is useful to extract words from texts, or to extract values from within HTML or XML tags.

EXTRACT(data, key, endkey)

Example:

data = "<product>coffee</product>
"

EXTRACT(data, "<product>", "</product>") = "coffee"

Returns the starting position of a given text string (the *key* parameter) within
another text string (the *data* parameter).

FIND(data, key)

Example:

data = "this text"

FIND(data, "tex") = 6

Returns the first non-blank and non-zero value in the given cell range of data array.

FIRSTVALUE(data)

Example:

FIRSTVALUE("", "a", "", "b", "") = "a"

Looks up the given *key* value in the given horizontal cell range or data array
(*data*), and returns the value in the same column in the second horizontal cell
range or data array (*range*).

The lookup will always try an exact match on the *key* value, and return an empty
text when no exact match is found. If you want to find the nearest or approximate
match when no exact match is found, you need to set the *type* parameter.

HLOOKUP(data, range, key, type)

Type:

0 - exact match only (default)

1
- find the next value just after the given key

2 - find the previous value just before the
given key

3 - case-insensitive fuzzy match by ignoring all characters other than A-Z and 0-9

Returns a single value from the given cell range or data array, based on the given index. The index is a sequential result of the combined row and column position. For example, a range with 3 rows and 2 columns has 6 indices (3 * 2). The value on row 2 and column 1 has index 3 (1 * 2 + 1), whilst the value on row 3 and column 2 has index 6 (2 * 2 + 2), and so on.

INDEX(data, index)

Returns the value in the cell with the given cell reference, or with the given row and column. You can optionally provide the sheet name (as text), else the default sheet (the first or only sheet) will be used.

This is only relevant in models and enables you to indirectly obtain the value in a cell by setting a dynamic reference to that cell. This enables you to dynamically change the reference to a cell within a formula without having to change the formula itself.

Please be aware that sheet and cell references made via INDIRECT are not adjusted when sheets are renamed and/or rows or columns are inserted or deleted. INDIRECT enables you to set your own dynamic references to cell positions within a model, and is therefore never adjusted.

INDIRECT(cell) or INDIRECT(row, column, sheet)

Example:

INDIRECT("C2") = 25

INDIRECT(2, 3) = 25

INDIRECT(2, 3,
"Sheet1") = 25

Returns a specific property value from a JSON-formatted text. You can specify the nodes(s) that represent the values you want. You can specify nested nodes by a period, e.g. mydata.product.description. You can also specify array positions, e.g. mydata.products.0.id

JSON(data, key)

Example:

data =
{"mydata":{"product":{"id":"1","description":"coffee","price":"10"}}}

JSON(data,
"mydata.product.description") = "coffee"

Returns a text label for the given index by looking it up in the given cell range, data array, or comma-delimited list of values.

LABEL(data, index)

Example:

LABEL("Jan,Feb,Mar", 2) = "Feb"

Returns the last non-blank and non-zero value in the given cell range of data array.

LASTVALUE(data)

Example:

LASTVALUE("", "a", "", "b", "") = "b"

Looks up the given *key* value in the given cell range or data array (*data*), and
returns the value on the same row in the second cell range or data array
(*range*).

The lookup will always try an exact match on the *key* value, and return an empty
text when no exact match is found. If you want to find the nearest or approximate
match when no exact match is found, you need to set the *type* parameter.

LOOKUP(data, range, key, type)

Type:

0 - exact match only
(default)

1 - find the next value just after the given key

2 - find the previous value
just before the given key

3 - case-insensitive fuzzy match by ignoring all characters other
than A-Z and 0-9

Compares each item in the given cell range or data array ("data") to a condition, and returns the value on the first row in the second cell range or data array ("range") that matches the condition.

MATCH(data, range, condition)

Returns the range of values, or the value at the given **index**, of the given
**planner**. See the PLANNER function below for further reference. No calculation
is performed: the function simply returns the value(s), which you can use in your own formula.

If you omit *index*, the function returns a range with all values.

PLAN(planner, index)

Examples:

PLAN("Months", 6) = 0.0833 * (1 / 12)*

The PLAN function works in conjunction with the **Cell editor
Planner** and enables you to define a pattern of values, and use those in formulas.

When you want to use a PLAN function, you first need to define a **Cell editor Planner**. See the PLANNER function for
more details.

Returns a proportion of **data** using the relative value at the given
**index** of the given **planner**. The returned value is calculated
as follows:

data * (value of given planner index / sum of all planner values)

If the given index does not exist in the planner, the function will use the given
ratio (which can be a cell reference, a formula, or a given value) and will return
the result of data * ratio.

If neither the index or a ratio exists, the
function will return 0 (zero).

PLANNER(data, planner, index, ratio)

Examples:

PLANNER(1000, "Months", 6) = 83.33 * (1000 * 1 / 12)*

PLANNER(1000, "Weeks445", 6) = 96.15 * (1000 * 5 / 52)*

PLANNER(1000, "Summmer", 6) = 111.11 *(1000 * 4 / 36)*

PLANNER(1000, "", 0, B3/C3) = 200.00 *(1000 * 1 / 10*

The PLANNER function works in conjunction with the **Cell editor
Planner** and enables you to distribute a given value across a range of cells
in a model, based on a defined pattern that can be selected by the user. For
example, this can be used to divide an given amount over a range of periods, or
across products etc.

When you want to use a PLANNER function, you first need to define a **Cell editor Planner**.

The below example defines 3 patterns for a cell editor: 6 equal months, a Summer pattern, and a Winter pattern:

The absolute values of the numeric patterns are irrelevant, what matters is each relative value as a proportion of the sum of all values. You can define as many indices in the patterns as you need.

You can also use one of the below aliases for common patterns:

- @month - every month (1,1,1,1,1,1,1,1,1,1,1,1)
- @quarter - every quarter (0,0,1,0,0,1,0,0,1,0,0,1)
- @soquarter - start of quarter (1,0,0,1,0,0,1,0,0,1,0,0)
- @halfyear - every half year (0,0,0,0,0,1,0,0,0,0,0,1)
- @sohalfyear - start of half year (1,0,0,0,0,0,1,0,0,0,0,0)
- @year - every year (0,0,0,0,0,0,0,0,0,0,0,1)
- @soyear - start of year (1,0,0,0,0,0,0,0,0,0,0,0)
- @period445 - 445 week-based (4,4,5,4,4,5,4,4,5,4,4,5)

In addition to defined static planners, you can also refer to a data query. Your data query can include multiple rows, with each row being treated as a separate planner. The first column on every row needs to contain the planner name, and the other columns need to contain the numeric patterns.

Returns the rank (starting at 1) of a given number within the list of numbers in the given cell range or data array. You can decide if/how the list will be sorted.

RANK(data, number, type)

Type:

"asc" - ascending sort (default)

"desc" -
descending sort

"none" - no sort

Example:

RANK(A1:A4, 45, "asc") =
3

Returns the number of rows in the given cell range or data array. The range must contain only one column.

ROWS(data)

Example:

ROWS(A1:A4) = 4

Updates a specific value within a JSON-formatted text that was created by WRAP. The key is numeric in order of the values passed to WRAP (e.g. 1, 2, 3 etc). Use WRAP to create the JSON-formatted text, or UNWRAP to extract the data again.

SETWRAP(data, value, key)

Example:

SETWRAP(data, 25, 2)

Returns the corresponding value that matches the given key in the given cell range or data array, or comma-delimited list of values. The list must contain the keys and their corresponding values as separate consequtive items. If no value is found, either the key is returned, or an empty value if you set that parameter to true.

SWITCH(data, key, empty)

Returns the type of value in the given data. If the optional "type" parameter is given, returns true if the data matches the expected type.

TYPE(data, type)

Type:

array = a data array or cell range

blank =
the following values are considered blank: absent data, empty string "", a single space " ", a
"0" text, and a 0 number

error = a formula error

period = a
period YYYY-MM

date = a date YYYY-MM-DD

number = a
numerical value

boolean = a boolean value

email = an email address

phone
= a phone number

url = a website URL

wrap =
a JSON-formatted text (see WRAP function)

text = a text
string

Example:

TYPE(123) = "number"

TYPE(123, "number") = true

Returns a list with sorted unique values that occur in the given cell range, data array, or comma-delimited list of values.

UNIQUE(data)

Example:

data = "a,a,b,a,c,b,c,b,a"

UNIQUE(data) = "a,b,c"

Returns a specific value from a JSON-formatted text that was created by WRAP. The key is numeric in order of the values passed to WRAP (e.g. 1, 2, 3 etc). Use WRAP to create the JSON-formatted text.

UNWRAP(data, key)

Example:

UNWRAP(data, 2)

Looks up the given *key* value in the given vertical cell range or data array, and
returns the value on the same row in the second horizontal cell range or data array
(*range*).

The lookup will always try an exact match on the *key* value, and return an empty
text when no exact match is found. If you want to find the nearest or approximate
match when no exact match is found, you need to set the *type* parameter.

VLOOKUP(data, range, key, type)

Type:

0 - exact match only (default)

1
- find the next value just after the given key

2 - find the previous value just before the
given key

3 - case-insensitive fuzzy match by ignoring all characters other than A-Z
and 0-9

Returns data from a web service on the Internet or Intranet. Only connections over https://
are allowed.

If the data is returned in JSON format, you can specify the JSON node(s)
that contains the required value(s). You can specify nested nodes by a period, e.g.
mydata.product.description. You can also specify array positions, e.g.
mydata.products.[0].id

If you don't specify any node, the entire JSON data will be
returned as text and you can use the JSON function to extract the necessary value(s) from that
data.

If the data is returned in text, XML, or HTML format, you can use standard
lookup and text functions (e.g. FIND, EXTRACT, LEFT, MID, RIGHT etc) to extract the required
value(s).

WEBSERVICE(url, key)

Example:

WEBSERVICE("https://api.exchangeratesapi.io/latest", "rates.USD")

Views the content of a web page on the Internet or Intranet. You can optionally define the width and height of the window that contains the content.

Please note that for security reasons this is allowed for approved websites only, and only for https:// connections. By default, you can only link to pages on https://www.xlreporting.com. If you want to link to an external website or to your company intranet, please contact us.

WEBVIEW(url, width, height)

Example:

WEBVIEW("https://www.xlreporting.com")

Wraps a given cell range or data array into a JSON-formatted text. Ideal for storing complex data into a single value, for example when saving into a data set column. Each value is given a sequential numeric key starting at 1 (e.g. 1, 2, 3 etc) in order of the values passed. Use UNWRAP to extract the data again, or SETWRAP to update a specific value.

WRAP(data)

Example:

WRAP(A3:B3)

WRAP(A3, B3, C3)

Looks up the given *key* value in the given cell range or data array (*data*), and
returns the value on the same row in the second cell range or data array (*range*).

The lookup will always try an exact match on the *key* value, and return an empty text (or
the optional *notfound* value) when no exact match is found. If you want to find the
nearest or approximate match when no exact match is found, you need to set the *type*
parameter.

XLOOKUP(data, range, key, notfound, type)

Type:

0 - exact match only
(default)

1 - find the next value just after the given key

2 - find the previous value
just before the given key

3 - case-insensitive fuzzy match by ignoring all characters other
than A-Z and 0-9