January 2023 - Yagisanatode

GWAOw! 5 – Insert Special Characters by Sheets Help

In this episode of GWAOw!!! we look at Insert Special Characters by Sheets Help.

About Insert Special Characters for Google Sheets.

As the name suggests, the Insert Special Character Add-on allows you to access the complete list of special characters like maths symbols, shapes and arrows, currency symbols, dingbat and Greek and Coptic symbols from the sidebar of your Google sheets.

This is all accessible from the convenience of the sidebar within your selected Google Sheet.

https://youtu.be/1msdhSy1woQ

GWAOw! 5 – Insert Special Characters by Sheets Help (https://youtu.be/1msdhSy1woQ)

Features

The Insert Special Character Google Workspace Add-on comes with some handy features. You can:

Modify the colour and size of the characters before installing them.
Insert Multiple characters into one cell.
Filter the character list by:
1. Arrows
2. Geometric Shapes
3. Currencies
4. Maths Symbols
5. Dingbats
6. Greek and Coptic Symbols
Use the search bar to search for a specific character.

Pricing

The add-on comes with a 7-day free trial followed by a very reasonable one-time $7 purchase, but…I spoke to Adam from Sheets Help and managed to get you 20% off.

I don’t know how long the offer will last so I recommend that if you find this Add-on useful, take advantage of the discount while it is still available.

Use the code SPECIAL20 at checkout to get the discount. You can find the code in the description below this video.

About Sheets Help

Along with their recent publication of the Google Workspace Add-on Insert Special Characters for Google Sheets, Sheets Help provides a wide variety of tutorials, tips and tools to help you with your next project.

Get the Add-on

Check it out on the Google Workspace Marketplace: Insert Special Characters

Or learn more from the add-on’s homepage.

Performance of Google Apps Script Text Finder Class on 2 Approaches to Searching Large Datasets

Inspired by research into a recent blog post, the Google Apps Script Text Finder Class’ Find All (findAll()) and Find Next (findNext()) methods were benchmarked over two different datasets containing 50,000 rows. The first dataset contained 1,000 cells matching the search text. The second dataset contained 100 matching cells.

For each dataset, a test was conducted to retrieve either the first 10 matching cells or the first 100 matching cells. The Find All and Find Next approaches were tested and compared on each test.

It was expected that Find Next would perform best on the condition where the dataset contained a large number of found items and only a small number of first cells needed to be reported. The benchmark results suggest that this hypothesis is most likely.

	First number of cells to retrieve	Test	Function	Avg. run time over 100 runs.	Fastest Function	Fastest Avg. Time	Avg. time Difference
1000 items to find	10	1	v2 findAll	1626.24	v3 findNext	1368.45	257.79
	10	1	v3 findNext	1368.45
	50	2	v2 findAll	1578.19	v2 findAll	1578.19	4993.61
	50	2	v3 findNext	6571.8
100 items to find	10	3	v2 findAll	360.94	v2 findAll	360.94	975.16
	10	3	v3 findNext	1336.1
	50	4	v2 findAll	377.13	v2 findAll	377.13	6175.59
	50	4	v3 findNext	6552.72

Table: The average time in milliseconds of 100 runs of each test of Apps Script Text Finder findAll() and findNext() methods. Image link for mobile-friendly viewers.

Method

Sample Data

Two columns of data 50,000 rows deep were generated for this test. Each cell in each column consisted of a number; either 1, 2, 3, 4 or 5. An equal spread of numbers 1 through 4 where added to each row. Each column differs by the number of 5s in each row:

Col A: 1,000 5’s
Col B: 100 5’s

Each column was then selected and randomised with: Data > Randomise range.

Test

Two functions are compared to test their performance based on four test conditions based on 100 runs of each test:

Retrieve the first 10 cells containing the search text where the range contains 1,000 matching search items.
Retrieve the first 50 cells containing the search text where the range contains 1,000 matching search items.
Retrieve the first 10 cells containing the search text where the range contains 100 matching search items.
Retrieve the first 50 cells containing the search text where the range contains 100 matching search items.

The time in milliseconds was recorded using the JavaScript Date.now() method before and after the functions were run. The difference in time in milliseconds was then appended to an array and added to a Google Sheet column for each test type. This culminated in 8 sets of 100 results.

The average of each test was then recorded and used to compare performance.

Note: Performance.now() is not available in Google Apps Script.

Code

All code and results can be found copied from this sheet:

Analysis of Google Apps Script Create Finder Class Retrieve n found values

To explore the code and run your own independent tests, make a copy of the Google Sheet: File > Make a copy.

More detailed breakdowns of the code for each test function can be found in the source tutorial.

Note! There is no v1. The version numbers refer to the tutorial related to this post.

Main Test RUN

This function ran all the test conditions. Modify colPastePosition to add the culminated times to the desired columns. Then uncomment the desired run.

function testRun(){
  const sheetName = "Test Data"
  const text = 5;
  const n_small = 10;
  const n_big = 50;
  const rangeLoc_1000items = "A2:A";
  const rangeLoc_100items = "B2:B";

  let start, end

  const colPastePosition = 10;


  const times = [];

  for(let i = 0; i < 100; i++){

    start = Date.now();

    // Test 1: 1000 items to find. Return first ten, V2.
    const results = test_v2(sheetName, text, n_small, rangeLoc_1000items);

    // // Test 2: 1000 items to find. Return first ten, V3.
    // const results = test_v3(sheetName, text, n_small, rangeLoc_1000items);

    // // Test 3: 1000 items to find. Return first 50, V2.
    // const results = test_v2(sheetName, text, n_big, rangeLoc_1000items);

    // // Test 4: 100 items to find. Return first 50, V3.
    // const results = test_v3(sheetName, text, n_big, rangeLoc_1000items);

    // // Test 5: 100 items to find. Return first ten, V2.
    // const results = test_v2(sheetName, text, n_small, rangeLoc_100items);

    // // Test 6: 100 items to find. Return first ten, V3.
    // const results = test_v3(sheetName, text, n_small, rangeLoc_100items);

    // // Test 7: 100 items to find. Return first 50, V2.
    // const results = test_v2(sheetName, text, n_big, rangeLoc_100items);

    // // Test 8: 100 items to find. Return first 50, V3.
    // const results = test_v3(sheetName, text, n_big, rangeLoc_100items);

    end = Date.now();

    times.push([end - start])



  }

  SpreadsheetApp.getActiveSpreadsheet()
    .getSheetByName("Test")
    .getRange(6,colPastePosition,100,1)
    .setValues(times)
  

}

function testRun(){

const sheetName = "Test Data"

const text = 5;

const n_small = 10;

const n_big = 50;

const rangeLoc_1000items = "A2:A";

const rangeLoc_100items = "B2:B";

let start, end

const colPastePosition = 10;

const times = [];

for(let i = 0; i < 100; i++){

start = Date.now();

// Test 1: 1000 items to find. Return first ten, V2.

const results = test_v2(sheetName, text, n_small, rangeLoc_1000items);

// // Test 2: 1000 items to find. Return first ten, V3.

// const results = test_v3(sheetName, text, n_small, rangeLoc_1000items);

// // Test 3: 1000 items to find. Return first 50, V2.

// const results = test_v2(sheetName, text, n_big, rangeLoc_1000items);

// // Test 4: 100 items to find. Return first 50, V3.

// const results = test_v3(sheetName, text, n_big, rangeLoc_1000items);

// // Test 5: 100 items to find. Return first ten, V2.

// const results = test_v2(sheetName, text, n_small, rangeLoc_100items);

// // Test 6: 100 items to find. Return first ten, V3.

// const results = test_v3(sheetName, text, n_small, rangeLoc_100items);

// // Test 7: 100 items to find. Return first 50, V2.

// const results = test_v2(sheetName, text, n_big, rangeLoc_100items);

// // Test 8: 100 items to find. Return first 50, V3.

// const results = test_v3(sheetName, text, n_big, rangeLoc_100items);

end = Date.now();

times.push([end - start])

}

SpreadsheetApp.getActiveSpreadsheet()

.getSheetByName("Test")

.getRange(6,colPastePosition,100,1)

.setValues(times)

}

test_v2 – Google Apps Script Text Finder Class- findAll()

Code breakdown can be found here: link.

This function retrieves the full list of all found cells using the findAll() method from the Text Finder Class. All available found items in the range are then stored in the found variable.

It then relies on a for-loop to iterate through each cell and collect the cell location using the Spreadsheet App Class’ range getA1Notation method. Each cell location is then stored in the locations variable as an array item before returning the array to the initialising function.

The for-loop breaks when the total number of required cell items (the position) equal the index variable (i) in the loop.

/**
 * Finds the first set of matching cells of n in length or less.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - the max number of items to report.
 * @param {string} rangeLoc - A1- Notation of selected range.
 * @return {array} - Array of cell positions of the found match.
 */
function test_v2(sheetName, text, n, rangeLoc){
  const position = n - 1;

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);
  const range = sheet.getRange(rangeLoc)

  const found = range.createTextFinder(text)
    .findAll();

  let locations = [];

  for(let i = 0; i < found.length; i++){

    const cell = found[i];

    locations.push(cell.getA1Notation())


    if( i === position) break;
  
  }

  return locations;

}

/**

* Finds the first set of matching cells of n in length or less.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - the max number of items to report.

* @param {string} rangeLoc - A1- Notation of selected range.

* @return {array} - Array of cell positions of the found match.

function test_v2(sheetName, text, n, rangeLoc){

const position = n - 1;

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const range = sheet.getRange(rangeLoc)

const found = range.createTextFinder(text)

.findAll();

let locations = [];

for(let i = 0; i < found.length; i++){

const cell = found[i];

locations.push(cell.getA1Notation())

if( i === position) break;

}

return locations;

}

test_v3 – Google Apps Script Text Finder Class- findNext()

Code breakdown can be found here: link.

In this function, a call is made to the spreadsheet to retrieve the found cell value each time findNext() method of the Text Finder Class is called. On each iteration, the getA1Notation method is used to retrieve the cell location. This location is then stored as an array value in the locations variable before being returned to the initiating function.

The function used a while-loop to iterate through each next item found until the counter – or the number of required cells to collect – is reached.

/**
 * Finds the first set of matching cells of n in length or less.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - the max number of items to report.
 * @param {string} rangeLoc - A1- Notation of selected range.
 * @return {array} - Array of cell positions of the found match.
 */
function test_v3(sheetName, text, n, rangeLoc){


  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);
  const range = sheet.getRange(rangeLoc)

  const finder = range.createTextFinder(text)

  let locations = [];
  let counter = n;

  while(counter > 0){
    
    let found = "";

      found = finder
        .findNext()
        .getA1Notation();

    locations.push(found);

    --counter;
  };


  return locations

};

/**

* Finds the first set of matching cells of n in length or less.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - the max number of items to report.

* @param {string} rangeLoc - A1- Notation of selected range.

* @return {array} - Array of cell positions of the found match.

function test_v3(sheetName, text, n, rangeLoc){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const range = sheet.getRange(rangeLoc)

const finder = range.createTextFinder(text)

let locations = [];

let counter = n;

while(counter > 0){

let found = "";

found = finder

.findNext()

.getA1Notation();

locations.push(found);

--counter;

};

return locations

};

Results & Discussion

Analysis of Google Apps Script Create Finder Class Retrieve n found values — Performance in Milliseconds to Retrieve the first 10 or 50 Matching Values over a 50,000 Row Range Contain Either 1000 or 100 Matchable items Using the Google Apps Script Spreadsheet App Finder Class.

Test 1: Retrieve the first 10 cells containing the search text where the range contains 1,000 matching search items.

Version 3 –findNext() performed better on average when there were 1000 potential items to find in the range but only the first 10 items need to be selected. Versions 3’s average speed was 1368.45ms compared to version 2’s average run speed of 1826.24ms. This is a performance increase of 257.79ms for version 3.

Version 2’s lower performance is likely due to needing to collect all available found cells before it can extract the top 10 items.

Version 3, makes 10 calls to the Google Sheets in this example. Compared to version 2, this takes relatively less time than collecting all available found cell references to the search item.

TEST 1: 1,000 randomised items to find in 50,000. Return first 10 matches using v2-findAll and v3-findNext functions.

Test 2: Retrieve the first 50 cells containing the search text where the range contains 1,000 matching search items.

Version 2 – findAll() performed significantly better over 100 runs than version 3 when retrieving the top 50 found cells from a possible 1000. Version 2 was, on average, 4993.61ms faster at an average runtime of 1578.19ms compared to version 3’s sluggish 6571.80ms average.

It was expected that test one and test two’s times for version 2 would be similar and there are only 48.05ms between their average runtimes.

Version 3’s poor performance is likely due to its reliance on calling the spreadsheet to collect the cell data on all 50 calls it needs to make.

TEST 2: 1,000 randomised items to find in 50,000. Return first 50 matches using v2-findAll and v3-findNext functions.

Test 3: Retrieve the first 10 cells containing the search text where the range contains 100 matching search items.

Version 2, again, performed better by 975.16ms than version 3 when there was a smaller potential number of items to find in the range and only the first ten items need to be retrieved.

Here the performance margin between the two versions was closer than in the previous test. Version 2’s average run speed was 360.94ms while version 3’s runtime was 1336.10ms.

With a smaller number of retrieved items, the version 2 findAll() function did not have to work as hard to collect the methods related to each range it collects. Whereas version 3 still needed to make 10 performance-intensive calls back to the Google Sheet each time with relatively no performance change to test one.

TEST 3: 100 randomised items to find in 50,000. Return first 10 matches using v2-findAll and v3-findNext functions.

Test 4: Retrieve the first 50 cells containing the search text where the range contains 100 matching search items.

Predictably, version 2 – findAll() performed the best when the expected match sample is small (100 available matches) and the total first set of cells to retrieve was relatively large (50).

Version 2’s average completion time was 377.13ms compared to version 3’s average of 6552.72ms, performing on average 6175.59ms faster. This is by far the largest margin on performance between the two versions.

Here again, version 3 must perform 50 calls to the Google Sheet, each one retrieving the cell range data. Alternatively, version 2 makes one call to the spreadsheet and then retrieves the cell data for all collected values. This is significantly faster than version 3’s approach.

TEST 4: 100 randomised items to find in 50,000. Return first 50 matches using v2-findAll and v3-findNext functions.

Overall

On datasets that may have the potential to contain a large number of matching items, but fewer required results to return, version 3 may be the best option. In all other cases, version 2 is the most optimal approach to finding data in a range.

It is important to note that it can be difficult to accurately measure performance with Apps Script runs because resource allocation to run a script does seem to vary. Nevertheless, with a sample size of 100 runs, it is hoped that average values will be more accurate than a smaller sample.

Grab Your Own Copy of the Google Sheet and Attached Code here

If you have found the tutorial helpful, why not shout me a coffee ☕? I'd really appreciate it.

Need help with Google Workspace development?

Go something to solve bigger than Chat GPT?

I can help you with all of your Google Workspace development needs, from custom app development to integrations and security. I have a proven track record of success in helping businesses of all sizes get the most out of Google Workspace.

Schedule a free consultation today to discuss your needs and get started or learn more about our services here.

~Yagi

Find first, last & nth value in a Google Sheets range with Apps Script

In this tutorial, we will explore how to find the first and last values in a Google Sheets Range using Google Apps Script. Then we will modify our code to find a value at a specific location. We will then find the position of the first set of values in our Google Sheets range. Lastly, we will create a reusable function to find the first or last set of values in a range.

This tutorial accompanies the YouTube tutorial of the same name:

https://youtu.be/herkpwbaBHg

Find first, last & nth value in a Google Sheets range with Apps Script (https://youtu.be/herkpwbaBHg)

The starter sheet for the video tutorial:

Starter Sheet

The code for each section of the tutorial can be found below under each section header along with any explanation, where needed.

In our previous tutorial, we covered how to find all values in a Google Sheet, a sheet table or a range. Check it out here:

Find All Values in Google Sheets with Apps Script

Table of Contents

The Runsies Function

This is an example function that you can use to run your find functions below. All arguments for the functions below are placed in here along with the execution of the desired function.

In the example below we are running the first function.

function findFirst_FindAll(sheetName, text){

  ...

}

function runsies(){
  const sheetName = "Data";
  const text = "19-Feb-2023";

  findFirst_FindAll(sheetName, text)


}

function findFirst_FindAll(sheetName, text){

...

}

function runsies(){

const sheetName = "Data";

const text = "19-Feb-2023";

findFirst_FindAll(sheetName, text)

}

Find the first value or text in a Google Sheets Range using Apps Scripts FindAll method

In this approach, we make use of our previous tutorial’s script and use the findAll method of the createTextFinder Class.

This method returns an array for each found item that can access the Google Apps Script range class methods.

/**
 * Find the first position of the match.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * 
 */
function findFirst_FindAll(sheetName, text){

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const foundValue = sheet.createTextFinder(text)
    .findAll();

  const firstVal = foundValue[0];

  console.log(firstVal.getA1Notation())

  firstVal.activate();
};

/**

* Find the first position of the match.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

function findFirst_FindAll(sheetName, text){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const foundValue = sheet.createTextFinder(text)

.findAll();

const firstVal = foundValue[0];

console.log(firstVal.getA1Notation())

firstVal.activate();

};

Line 15 – Once all items in the range are found, we can select the zeroeth item. Incidentally, we could get the last item in the range with this approach by modifying this line to:

const lastVal = foundValue[foundValue.length - 1];

Of course, you would need to update the variable names too.

Line 17 – Here we log the cell position of the first found item using the SpreadsheetApp Range Class getA1Notation method.

Line 19 – Finally to make it easier to test. We set our selected cell value to activate. This makes the cell active and makes it easy for us to crosscheck in our testing. It also has the benefit of navigating the user on the Google Sheet to the desired cell. Check out the image below for an example:

Note! This approach can be much, much slower than the next option, particularly if your text finder discovers a lot of cells.

If you have found the tutorial helpful, why not shout me a coffee ☕? I'd really appreciate it.

Find the first value or text in a Google Sheets Range using the iterator method

A much more common approach to finding the first position of the matching value is using the findNext() iterator method of the Text Finder Class.

This is considerably faster on large datasets where you expect to find many occurrences of the found item. Why? Because, the find-all approach will collect all cells containing the value, whereas findNext() will only collect the next value to be found.

/**
 * Find the first position of the match.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * 
 */
function findFirstValue(sheetName, text){

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const firstVal = sheet.createTextFinder(text)
    .findNext();

  

  console.log(firstVal.getA1Notation())

  firstVal.activate();
};

/**

* Find the first position of the match.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

function findFirstValue(sheetName, text){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const firstVal = sheet.createTextFinder(text)

.findNext();

console.log(firstVal.getA1Notation())

firstVal.activate();

};

Line 13 – Here we replace findAll() with findNext().

Find the last value or text in Google Sheets Range

In this example, we swap the findNext() method with the findPrevious() method.

Interestingly, if we call the find previous method straight after creating the text finder, It will look for the first item starting in reverse order. This means it will start its search from the bottom of the range.

/**
 * Find the last position of the match.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * 
 */
function findLastValue(sheetName, text){

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const lastVal = sheet.createTextFinder(text)
    .findPrevious();

  

  console.log(lastVal.getA1Notation())

  lastVal.activate();
};

/**

* Find the last position of the match.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

function findLastValue(sheetName, text){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const lastVal = sheet.createTextFinder(text)

.findPrevious();

console.log(lastVal.getA1Notation())

lastVal.activate();

};

Find the position of the nth value in a Google Sheets Range with Apps Script

Here we want to find the nth value in a range. Perhaps the 3rd value or the 10th.

Lines 14-15- In this function, we return the findAll() method and then identify the position of the value in the selectedVal array.

Line 12 – Note that we will need to subtract one from our position value here before we can use it to find the value in the array. Remember, the array will start at zero.

/**
 * Find the cell of the nth match. 
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - position. 
 * 
 */
function findNthValue(sheetName, text, n){

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);
  const position = n - 1;

  const selectedVal = sheet.createTextFinder(text)
    .findAll()[position];

  console.log(selectedVal.getA1Notation())

  selectedVal.activate();
};

/**

* Find the cell of the nth match.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - position.

function findNthValue(sheetName, text, n){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const position = n - 1;

const selectedVal = sheet.createTextFinder(text)

.findAll()[position];

console.log(selectedVal.getA1Notation())

selectedVal.activate();

};

Find the first n values in a Google Sheets Range

In this scenario, we want to find a starting set of values from our range. Maybe we want to grab the top 3 found cells or the first 5.

Line 15 – Here we use the findAll() method again to get a list of all values in the range.

Line 19-29 – Next, we will use a JavaScript ‘for’ loop to iterate over the found cells. We will need to store all the found A1 notation locations in a locations variable on line 19.

Line 25 – On each iteration, we will append the locations with our new cell value.

Line 28 – However, if the index (i) matches the same number as the position variable then we want to break our loop.

/**
 * Finds the first set of matching cells of n in length or less.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - the max number of items to report.
 * 
 */
function findFirstN(sheetName, text, n){
  const position = n - 1;

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const found = sheet.createTextFinder(text)
    .findAll();



  let locations = [];

  for(let i = 0; i < found.length; i++){

    const cell = found[i];

    locations.push(cell.getA1Notation())


    if( i === position) break;
  }

  console.log(locations)

  
};

/**

* Finds the first set of matching cells of n in length or less.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - the max number of items to report.

function findFirstN(sheetName, text, n){

const position = n - 1;

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const found = sheet.createTextFinder(text)

.findAll();

let locations = [];

for(let i = 0; i < found.length; i++){

const cell = found[i];

locations.push(cell.getA1Notation())

if( i === position) break;

}

console.log(locations)

};

Find the first or last values of a selected number in a Google Sheets Range

Finally, we have two functions here. Both functions allow you to find either the first set or last set or cells where the search term is found. Their usage really depends upon the type of data that you are working with.

Both functions take 4 arguments:

sheetName – The name of the sheet tab.
text – The text to search.
n – The number of found cells to collect.
reverse (optional) – If true, conduct the search in reverse.

Again, both functions will return an array containing all found cell locations in A1-notation.

Checkout the post below for a detailed benchmark analysis of each function:

Performance of Google Apps Script Text Finder Class on 2 Approaches to Searching Large Datasets

Find All Approach

This approach is more performant when you don’t expect to find a lot of matching cells in a large range. It is also suitable if you want to extract a larger list of n items starting from the beginning or end of the range.

Why? Because if there are a large number of found variables then the findAll method will take more time to collect the full list of ALL cell locations before we can continue and select the ones we want. Whereas if we use the next option using findNext or findPrevious then each item will be retrieved one at a time, making the second option more performant.

Alternatively, if we want to retrieve say the first 100 items, then the first item would be a better approach. This is because we only make one call to the Google Sheet instead of 100 which is a much slower approach.

Line 16 – Here, we use the findAll() method again.

Line 22 – Note the if-statement here that checks if the reverse parameter is set to true.

Line 24 – If we want to start the search from the bottom of the range, we first set a counter to zero.

Line 25 – Then we run a reverse for loop, starting from the bottom of the found array.

Line 29 – If we find a cell we add it to the locations list like in our previous example.

Lines 31-33 – Finally, we update the counter and then check the counter count against n and break the look if we have a match.

Lines 36 -46 – If there is not reverse argument or the argument is set to false then we want to start our search from the top of the range. Here, we use the same for-loop as the previous chapter.

/**
 * Finds the first set of matching cells of n in length or less.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - the max number of items to report.
 * @param {boolean} [reverse] - list from bottom to top.
 * @return {array} - Array of cell positions of the found match.
 */
function findFirstN_v2(sheetName, text, n, reverse = false){
  const position = n - 1;

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const found = sheet.createTextFinder(text)
    .findAll();



  let locations = [];

  if(reverse){

    let counter = 0; 
    for(let i = found.length - 1; i >=0; i--){

      const cell = found[i];

      locations.push(cell.getA1Notation());

      ++counter;

      if(counter === n) break;

    }
  }else{

    for(let i = 0; i < found.length; i++){

      const cell = found[i];

      locations.push(cell.getA1Notation())


      if( i === position) break;
    }

  }



  return locations

  
};

/**

* Finds the first set of matching cells of n in length or less.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - the max number of items to report.

* @param {boolean} [reverse] - list from bottom to top.

* @return {array} - Array of cell positions of the found match.

function findFirstN_v2(sheetName, text, n, reverse = false){

const position = n - 1;

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const found = sheet.createTextFinder(text)

.findAll();

let locations = [];

if(reverse){

let counter = 0;

for(let i = found.length - 1; i >=0; i--){

const cell = found[i];

locations.push(cell.getA1Notation());

++counter;

if(counter === n) break;

}

}else{

for(let i = 0; i < found.length; i++){

const cell = found[i];

locations.push(cell.getA1Notation())

if( i === position) break;

}

return locations

};

Find Next or Previous Approach

This approach performs better in a large range when there the range contains many found cells, but you may only need to collect only a few of the first or last proceeding items.

/**
 * Finds the first set of matching cells of n in length or less.
 * @param {string} sheetName - the name of the sheet tab. 
 * @param {string|number} text - text to search. 
 * @param {number} n - the max number of items to report.
 * @param {boolean} [reverse] - list from bottom to top.
 * @return {array} - Array of cell positions of the found match.
 */
function findFirstN_v3(sheetName, text, n, reverse = false){


  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);

  const finder = sheet.createTextFinder(text)

  let locations = [];
  let counter = n;

  while(counter > 0){
    
    let found = "";

    if(reverse){
      found = finder
        .findPrevious()
        .getA1Notation();

    }else{
      found = finder
        .findNext()
        .getA1Notation();

    };

    locations.push(found);

    --counter;
  };



  return locations

  
};

/**

* Finds the first set of matching cells of n in length or less.

* @param {string} sheetName - the name of the sheet tab.

* @param {string|number} text - text to search.

* @param {number} n - the max number of items to report.

* @param {boolean} [reverse] - list from bottom to top.

* @return {array} - Array of cell positions of the found match.

function findFirstN_v3(sheetName, text, n, reverse = false){

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const finder = sheet.createTextFinder(text)

let locations = [];

let counter = n;

while(counter > 0){

let found = "";

if(reverse){

found = finder

.findPrevious()

.getA1Notation();

}else{

found = finder

.findNext()

.getA1Notation();

};

locations.push(found);

--counter;

};

return locations

};

Line 15 – To start our search, we only initialise the text finder class.

Line 17 – Set our empty location array.

Line 18 – Creates a counter base on the number (n) of found cell locations that we want to retrieve.

Line 20 – Next, we generate JavaScript while loop to finish once the counter reaches 1. The loop will either find the next or find the previous cell range.

Line 22 – We set the found variable to receive the cell location.

Lines 24-28 – If we have set the item to be reversed we use the findPrevious method and collect each cell location.

Lines 29-34 – Alternatively, we will use the findNext method if reverse is set to false or not included.

Line 36 – Next, we push the cell reference to the locations array.

Line 28 – The last task in the loop is to decrease our counter by one.

Line 43 – Outside our loop, we return the locations array back to the initiating function.

If you have found the tutorial helpful, why not shout me a coffee ☕? I'd really appreciate it.

Need help with Google Workspace development?

Go something to solve bigger than Chat GPT?

Schedule a free consultation today to discuss your needs and get started or learn more about our services here.

Find All Values in Google Sheets with Apps Script

Just like when using the Ctrl + F shortcut in Google Sheets to find values in your spreadsheet, there is a class in Google Apps Script that can do the same thing.

This could be a useful tool as a part of an automation process. For example, finding the location of a value and applying formatting to it or copying the cell’s entire data into a separate location if the value is a part of a larger text in the cell.

This tutorial accompanies the YouTube video tutorial of the same name.

Grab a copy of the starter sheet to play along and get the most out of the video.

Starter Sheet

Find All Apps Script – Starter Sheet

If you have found the tutorial helpful, why not shout me a coffee ☕? I'd really appreciate it.

The Code

Note that for the video tutorials, I have added the variables (e.g. the Sheet Name, Range) inside each function. It is usually good practice to keep these functions independent and call them from other functions. This makes them more reusable.

Instead, we can add the variables we need as parameters for the functions and return the result. See the example below:

/**
 * Activate all values in a range.
 * @param {string} text - the text to search for.
 * @param {string} sheetName - The name of the selected sheet.
 * @returns {array} Location cell of each selection. 
 */
function findAllItemsInASheet(text, sheetName){

  ...


  return locationList;
};


function runsies(){
  findAllItemsInASheet("koala", "Sheet1")
}

/**

* Activate all values in a range.

* @param {string} text - the text to search for.

* @param {string} sheetName - The name of the selected sheet.

* @returns {array} Location cell of each selection.

function findAllItemsInASheet(text, sheetName){

...

return locationList;

};

function runsies(){

findAllItemsInASheet("koala", "Sheet1")

}

These examples use the TextFinder class as a part of the Google Apps Script Sheets App Class.

In these examples, we use the findAll method of this class. This will return an array containing all the cells containing the selected value searched. From here, you can treat each cell as a range and call range methods like:

Get A1 Notation.
Get Sheet – Get Name.
Get Row.

We use the JavaScript Map method to iterate through each item that we find.

Find All Values in All Sheets

This finds all values in all sheets and returns an array containing an object for each sheet containing the sheet name and the cell location.

// Find value over all sheets. 
function findValueOverAllSheets(){
  const text = "koala";
  const ss = SpreadsheetApp.getActiveSpreadsheet();

  const textFinder = ss.createTextFinder(text)

  const allOccurrences = textFinder.findAll();

  const locationList = allOccurrences.map(item => {
    return {sheet:item.getSheet().getName(), cell: item.getA1Notation()}
    
  })

  console.log(locationList)
}

// Find value over all sheets.

function findValueOverAllSheets(){

const text = "koala";

const ss = SpreadsheetApp.getActiveSpreadsheet();

const textFinder = ss.createTextFinder(text)

const allOccurrences = textFinder.findAll();

const locationList = allOccurrences.map(item => {

return {sheet:item.getSheet().getName(), cell: item.getA1Notation()}

})

console.log(locationList)

}

Returns:

[ { sheet: 'Sheet1', cell: 'A3' },
  { sheet: 'Sheet1', cell: 'A4' },
  { sheet: 'Sheet1', cell: 'F14' },
  { sheet: 'Sheet1', cell: 'A16' },
  { sheet: 'Sheet2', cell: 'B4' },
  { sheet: 'Sheet3', cell: 'C6' },
  { sheet: 'Sheet3', cell: 'F8' },
  { sheet: 'Sheet3', cell: 'E15' } ]

[ { sheet: 'Sheet1', cell: 'A3' },

{ sheet: 'Sheet1', cell: 'A4' },

{ sheet: 'Sheet1', cell: 'F14' },

{ sheet: 'Sheet1', cell: 'A16' },

{ sheet: 'Sheet2', cell: 'B4' },

{ sheet: 'Sheet3', cell: 'C6' },

{ sheet: 'Sheet3', cell: 'F8' },

{ sheet: 'Sheet3', cell: 'E15' } ]

Find All Values in Selected Sheets

Finds all the values in a selected sheet and returns an array identifying the cell that each item is found.

// Find value over one sheet. 
function findValueOverOneSheet(){
  const text = "koala";
  const sheetName = "Sheet1";

  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName)

  const textFinder = sheet.createTextFinder(text)

  const allOccurrences = textFinder.findAll();

  const locationList = allOccurrences.map(item =>  item.getA1Notation())

  console.log(locationList)
}

// Find value over one sheet.

function findValueOverOneSheet(){

const text = "koala";

const sheetName = "Sheet1";

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName)

const textFinder = sheet.createTextFinder(text)

const allOccurrences = textFinder.findAll();

const locationList = allOccurrences.map(item => item.getA1Notation())

console.log(locationList)

}

Returns:

[ 'A3', 'A4', 'F14', 'A16' ]

Find All Values in a Selected Range

Finds the values for any item in a selected range and returns the row the item was found on.

Example 1

// Find Value over a range
function findValueOverARange(){
  const text = "koala";
  const sheetName = "Sheet1";
  const rangeLoc = "A2:A16";


  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);
  const range = sheet.getRange(rangeLoc);

  const textFinder = range.createTextFinder(text);

  const allOccurrences = textFinder.findAll();

  const locationList = allOccurrences.map(item => {
    return  item.getRow();
  })


  console.log(locationList);
}

// Find Value over a range

function findValueOverARange(){

const text = "koala";

const sheetName = "Sheet1";

const rangeLoc = "A2:A16";

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const range = sheet.getRange(rangeLoc);

const textFinder = range.createTextFinder(text);

const allOccurrences = textFinder.findAll();

const locationList = allOccurrences.map(item => {

return item.getRow();

})

console.log(locationList);

}

Returns:

[ 3, 4, 16 ]

Example 2

function findValueOverARange_v2(){
  const text = "cheese";
  const sheetName = "Sheet4";
  const rangeLoc = "A1:A";


  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName(sheetName);
  const range = sheet.getRange(rangeLoc);

  const textFinder = range.createTextFinder(text);

  const allOccurrences = textFinder.findAll();

  const locationList = allOccurrences.map(item => {
    return  item.getRow();
  })


  console.log(locationList);
}

function findValueOverARange_v2(){

const text = "cheese";

const sheetName = "Sheet4";

const rangeLoc = "A1:A";

const ss = SpreadsheetApp.getActiveSpreadsheet();

const sheet = ss.getSheetByName(sheetName);

const range = sheet.getRange(rangeLoc);

const textFinder = range.createTextFinder(text);

const allOccurrences = textFinder.findAll();

const locationList = allOccurrences.map(item => {

return item.getRow();

})

console.log(locationList);

}

Returns:

[ 1, 2, 4, 5 ]

The Video

https://youtu.be/SM7qv5sPfPE

Find All in Google Sheets with Apps Script (https://youtu.be/SM7qv5sPfPE)

Need help with Google Workspace development?

Go something to solve bigger than Chat GPT?

Schedule a free consultation today to discuss your needs and get started or learn more about our services here.

How to Share a User on a Published Google Site with Google Apps Script

There are times when you might just want to share a user on a published Google Site as a part of a Google Apps Script Automation. Say you have an internal Google Site for a project and you want to share it with a member as a part of the onboarding process. Alternatively, you might want to share your site as soon as you receive a Stripe payment webhook ping.

To share a user in Google Sites you need to select the share icon from the top menu of the site editor. Then in the dialogue box add the user’s email and choose Published Viewer.

While there is no specific Google Apps Script API to manage Google Sites, we can share permissions and accessibility with Google Drive.

Continue reading “How to Share a User on a Published Google Site with Google Apps Script”

I like to make sure comments are as valuable as possible for you, the reader, and for myself as a reference. This is why I review comments before posting them.

Please don’t be disheartened by the delay. Like you, I have a busy life, but I will be sure to get back to you should your comment add value to the post.

A Learning Tool

This site is as much a learning tool for you as it is for me. I am much more likely to help you if you make an attempt at a problem and post it. That’s how we all learn.

About Insert Special Characters for Google Sheets.

Features

Pricing

About Sheets Help

Get the Add-on

Share this:

Like this:

Method

Sample Data

Test

Code

Main Test RUN

test_v2 – Google Apps Script Text Finder Class- findAll()

test_v3 – Google Apps Script Text Finder Class- findNext()

Results & Discussion

Test 1: Retrieve the first 10 cells containing the search text where the range contains 1,000 matching search items.

Test 2: Retrieve the first 50 cells containing the search text where the range contains 1,000 matching search items.

Test 3: Retrieve the first 10 cells containing the search text where the range contains 100 matching search items.

Test 4: Retrieve the first 50 cells containing the search text where the range contains 100 matching search items.

Overall

Share this:

Like this:

The Runsies Function

Find the first value or text in a Google Sheets Range using Apps Scripts FindAll method

Find the first value or text in a Google Sheets Range using the iterator method

Find the last value or text in Google Sheets Range

Find the position of the nth value in a Google Sheets Range with Apps Script

Find the first n values in a Google Sheets Range

Find the first or last values of a selected number in a Google Sheets Range

Find All Approach

Find Next or Previous Approach

Share this:

Like this:

Starter Sheet

The Code

Find All Values in All Sheets

Find All Values in Selected Sheets

Find All Values in a Selected Range

Example 1

Example 2

The Video

Share this:

Like this:

Share this:

Like this: