Merge pull request #64 from contributorpw/edits

Author: contributorpw

snippets/sheets/toc_generator/appsscript.json

@@ -0,0 +1,5 @@
+{
+  "timeZone": "Europe/Moscow",
+  "exceptionLogging": "STACKDRIVER",
+  "runtimeVersion": "V8"
+}

snippets/sheets/toc_generator/config.json

@@ -0,0 +1,4 @@
+{
+  "type": "container-bound-sheet",
+  "src": []
+}

snippets/sheets/toc_generator/index.js

@@ -0,0 +1,56 @@
+/**
+ * TOC object
+ * @typedef {Array.<{
+ *   name: string,
+ *   gid: number,
+ *   richTextValueBuilder: GoogleAppsScript.Spreadsheet.RichTextValueBuilder
+ * }>} TOCBuild
+ */
+
+/**
+ * Build a TOC object from the passed book
+ * @param {GoogleAppsScript.Spreadsheet.Spreadsheet} book
+ * @returns {TOCBuild}
+ */
+function tocBuilder_(book = SpreadsheetApp.getActive()) {
+  return book
+    .getSheets()
+    .map((sheet) => ({
+      name: sheet.getName(),
+      gid: sheet.getSheetId(),
+    }))
+    .map(
+      (item) => (
+        (item.richTextValueBuilder = createRichTextValueLink_(
+          item.name,
+          `#gid=${item.gid}`
+        )),
+        item
+      )
+    );
+}
+
+/**
+ * Update the specific Range with the TOC object
+ * @param {TOCBuild} tocBuild
+ * @param {GoogleAppsScript.Spreadsheet.Range} range
+ * @returns {GoogleAppsScript.Spreadsheet.Range} The updated range
+ */
+function tocUpdater_(tocBuild, range) {
+  range
+    .getSheet()
+    .getRange(range.getRow(), range.getColumn(), tocBuild.length, 1)
+    .setRichTextValues(
+      tocBuild.map((item) => [item.richTextValueBuilder.build()])
+    );
+}
+
+/**
+ * Create a RichTextValueBuilder with the text and the linkUrl
+ * @param {string} text
+ * @param {string} linkUrl
+ * @returns {GoogleAppsScript.Spreadsheet.RichTextValueBuilder}
+ */
+function createRichTextValueLink_(text, linkUrl) {
+  return SpreadsheetApp.newRichTextValue().setText(text).setLinkUrl(linkUrl);
+}

snippets/sheets/toc_generator/readme.md

@@ -0,0 +1,26 @@
+---
+title: 'TOC generator for Google Sheets'
+date: '2021-03-18'
+description: 'Generates a table of contents for a specific Spreadsheet'
+tags: ['sheets']
+categories: ['snippets']
+images: ['./snippets/sheets/toc_generator/screenrecord.gif']
+---
+
+{{< toc >}}
+
+## TOC generator for Google Sheets
+
+![Snippet of TOC generator for Google Sheets](./screenrecord.gif)
+
+### Snippet
+
+- {{< externalLink >}}
+- {{< commentLink >}}
+- {{< scrvizLink >}}
+
+{{< codeFromFile "index.js" >}}
+
+### Run it
+
+{{< codeFromFile "run.js" >}}

snippets/sheets/toc_generator/run.js

@@ -0,0 +1,26 @@
+/* global tocBuilder_ tocUpdater_*/
+
+/**
+ * Runs the snippet.
+ * Generates a TOC to 'Sheet27!B2' without 'Sheet27' item.
+ */
+function run() {
+  const excludeSheetNames = ['Sheet27'];
+  const book = SpreadsheetApp.getActive();
+  const tocBuild = tocBuilder_(book).filter(
+    (item) => excludeSheetNames.indexOf(item.name) === -1
+  );
+  const range = book.getRange('Sheet27!B2:B').clearContent();
+  tocUpdater_(tocBuild, range);
+  range.activate();
+}
+
+/**
+ * Create menu for handy use
+ */
+function onOpen() {
+  SpreadsheetApp.getUi()
+    .createMenu('Apps Script Snippets')
+    .addItem('Generate TOC', 'run')
+    .addToUi();
+}