Hyperlinks

#External Links

Add clickable hyperlinks to cells pointing to web addresses:

JSON

{
  "worksheets": [
    {
      "name": "Links",
      "rows": [
        { "cells": [{ "value": "Search Engine" }, { "value": "Code" }] },
        { "cells": [{ "value": "Google" }, { "value": "GitHub" }] }
      ],
      "hyperlinks": [
        {
          "cell": "A2",
          "url": "https://www.google.com",
          "tooltip": "Open Google"
        },
        {
          "cell": "B2",
          "url": "https://github.com",
          "display": "GitHub Repo"
        }
      ]
    }
  ]
}

TypeScript

{
  name: "Links",
  rows: [
    { cells: [{ value: "Search Engine" }, { value: "Code" }] },
    { cells: [{ value: "Google" }, { value: "GitHub" }] },
  ],
  hyperlinks: [
    {
      cell: "A2",
      url: "https://www.google.com",
      tooltip: "Open Google",
    },
    {
      cell: "B2",
      url: "https://github.com",
      display: "GitHub Repo",
    },
  ],
}

#Internal Links

Jump to other sheets within the same workbook:

JSON

{
  "worksheets": [
    {
      "name": "Summary",
      "rows": [{ "cells": [{ "value": "Go to Data" }] }],
      "hyperlinks": [
        {
          "cell": "A1",
          "location": "Data!A1",
          "tooltip": "Jump to Data sheet"
        }
      ]
    },
    {
      "name": "Data",
      "rows": [
        { "cells": [{ "value": "Name" }, { "value": "Value" }] },
        { "cells": [{ "value": "Item A" }, { "value": 100 }] }
      ]
    }
  ]
}

TypeScript

{
  name: "Summary",
  rows: [{ cells: [{ value: "Go to Data" }] }],
  hyperlinks: [
    {
      cell: "A1",
      location: "Data!A1",
      tooltip: "Jump to Data sheet",
    },
  ],
}

#Hyperlink Options Reference

Option	Type	Description
`cell`	`string`	Cell reference, e.g. `"A2"`
`target`	`object`	Link target
`tooltip`	`string`	Hover tooltip
`display`	`string`	Display text (overrides cell value)

#target options

Property	Type	Description
`type`	`string`	`"external"` or `"internal"`
`url`	`string`	External URL (when type is external)
`location`	`string`	Internal location, e.g. `"Sheet2!A1"` (when internal)