DiscoveryVIP / Apps Script AcademyHelp

26. Formatting ranges

Module 6 · 20 minutes · Lesson 25; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use formatting ranges without changing the wrong data?

Predict

Which values or resources will change, and which should stay unchanged? Write your prediction before execution.

Understand

Formatting changes presentation separately from the underlying value. setBackground accepts a CSS-style color string; setFontWeight accepts normal or bold. Use styling to clarify headings, but never communicate status through color alone. The preview shows a supported subset, while the full recorded format properties remain inspectable.

Example 1: Working automation

Chained formatting methods return the same range, so both styles apply to the header.

function main() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 4: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": null,
  "resource": "formats",
  "value": {
    "People!1:1": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    },
    "People!1:2": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    }
  }
}

Example 2: Investigate a reproducible failure

Predict the effect of "A2:B2" and identify the first mismatch. This example is intentionally faulty.

function main() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A2:B2").setBackground("#dcefe5").setFontWeight("bold");
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: sheet.getRange("A2:B2").setBackground("#dcefe5").setFontWeight("bold");
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 4: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": null,
  "resource": "formats",
  "value": {
    "People!2:1": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    },
    "People!2:2": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    }
  }
}

Example 3: Separate setup from execution and inspect repeat behavior

Call the same named operation twice. Compare outputs and resource counts to learn whether this operation is idempotent. Repeated creation is deliberately visible; real exports require a rerun policy.

function lessonAction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
}
function main() {
  lessonAction();
  lessonAction();
}
Important line explanations
Line 1: function lessonAction() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 4: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 5: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 6: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 7: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 8: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": null,
  "resource": "formats",
  "value": {
    "People!1:1": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    },
    "People!1:2": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    }
  }
}

Example 4: Add a diagnostic boundary around the operation

Observe start, successful completion or a rethrown failure. This optional professional pattern adds error context without swallowing the error or rolling back changes.

function lessonAction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
}
function main() {
  console.log("Start: Formatting ranges");
  try { lessonAction(); console.log("Completed operation"); }
  catch(error) { console.error("Failed operation: " + error.message); throw error; }
}
Important line explanations
Line 1: function lessonAction() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 4: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 5: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 6: console.log("Start: Formatting ranges");
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 7: try { lessonAction(); console.log("Completed operation"); }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 8: catch(error) { console.error("Failed operation: " + error.message); throw error; }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "Start: Formatting ranges",
    "Completed operation"
  ],
  "error": null,
  "resource": "formats",
  "value": {
    "People!1:1": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    },
    "People!1:2": {
      "setBackground": "#dcefe5",
      "setFontWeight": "bold"
    }
  }
}

Build and test

Repair the supplied script so that: Chained formatting methods return the same range, so both styles apply to the header. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A2:B2").setBackground("#dcefe5").setFontWeight("bold");
}

Graduated hints

Hint 1

Inspect the operation containing "A2:B2". Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns "A1:B1". Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses "A1:B1" where the broken source uses "A2:B2". Explain why before applying it.

Reference solution

function main() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  sheet.getRange("A1:B1").setBackground("#dcefe5").setFontWeight("bold");
}

Explain and reflect

Which operation proves the intended result in formatting ranges? Which wrong input would expose a weakness, and what would remain unchanged?

Adapt the input records and formats output to a second realistic case. Write its expected result before running. Demonstrate one invalid case and explain whether the side effects should be rolled back or retried.

Troubleshooting

If the console is empty, inspect the formats preview: this script may work through state changes. If the function is missing, select main. For a service error inspect the first failed timeline entry and its arguments. Use Manual unless investigating a trigger. Changing input data also changes the expected result; restore sample data before the authored checks.

Knowledge check

Explain the key method or operator. Give an exact output for a second input, plus one invalid case. Verify the result in the interactive lesson; written explanations need self or educator review.

Optional AI practice

Explain this concept using the source above. Help implement one small extension and define its tests. Review/debug the source using its actual expected output; cite real method references and never claim execution.

Transfer to Google and authorization guide

Next lesson: Working with formulas