Format range

formatRange changes only the format properties you provide across a structured grid range.

Example

import { automation, onHttpRequest } from "automate.ax"
import { formatRange } from "automate.ax/google-sheets"

export default automation("Format an order header", () => {
  onHttpRequest({ scope: "automation" })

  formatRange({
    spreadsheet: "spreadsheet-id",
    range: {
      sheet: "Orders",
      startRow: 1,
      endRow: 1,
      startColumn: 1,
      endColumn: 4,
    },
    bold: true,
    backgroundColor: "#E8F0FE",
    horizontalAlignment: "center",
    wrap: "wrap",
  })
})

Inputs

spreadsheet and structured one-based range are required. Provide at least one of six-digit backgroundColor/textColor, bold, italic, strikethrough, horizontal (left, center, right) or vertical (top, middle, bottom) alignment, wrap (overflow, clip, wrap), or numberFormat. Number types are text, number, percent, currency, date, time, dateTime, or scientific, with an optional Sheets pattern. account optionally selects the Google account binding.

Output

Returns the resolved zero-based, end-exclusive grid range with numeric sheetId. Existing unspecified formatting remains unchanged.

⌘I

Get started

Concepts

Reference

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output