API Reference

GitHubdream-num/univer

FRangeHyperlinkMixin

GitHubEdit on GitHub
packages@univerjs/sheets-hyper-link

APIs

Deprecated use range.setRichTextValueForCell(range.getValue(true).copy().cancelLink(id)) instead

Signature

cancelHyperLink(id: string): boolean

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1')
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/')
fRange.setRichTextValueForCell(richText)

// Cancel hyperlink after 3 seconds
setTimeout(() => {
  const cellValue = fRange.getValue(true)
  const hyperlinks = cellValue.getLinks()
  const id = hyperlinks[0].rangeId
  const newRichText = cellValue.copy().cancelLink(id)
  fRange.setRichTextValueForCell(newRichText)
}, 3000)

Deprecated use range.setRichTextValueForCell(range.getValue(true).getLinks()) instead

Signature

getHyperLinks(): ICellHyperLink[]

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a hyperlink to Univer on cell A1
const fRange = fWorksheet.getRange('A1')
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/')
fRange.setRichTextValueForCell(richText)

// Get hyperlinks from cell A1
console.log(fRange.getValue(true).getLinks())

getUrl

Create a hyperlink url to this range

Signature

getUrl(): string

Returns

  • (string) — The url of this range

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1')
const url = fRange.getUrl()
console.log(url)

Deprecated use range.setRichTextValueForCell(univerAPI.newRichText().insertLink(label, url)) instead

Signature

setHyperLink(url: string, label?: string): Promise<boolean>

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a hyperlink to Univer on cell A1
const fRange = fWorksheet.getRange('A1')
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/')
fRange.setRichTextValueForCell(richText)

Deprecated use range.setRichTextValueForCell(range.getValue(true).copy().updateLink(id, url)) instead

Signature

updateHyperLink(id: string, url: string, label?: string): Promise<boolean>

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1')
const richText = univerAPI.newRichText().insertLink('Univer', 'https://univer.ai/')
fRange.setRichTextValueForCell(richText)

// Update hyperlink after 3 seconds
setTimeout(() => {
  const cellValue = fRange.getValue(true)
  const hyperlinks = cellValue.getLinks()
  const id = hyperlinks[0].rangeId
  const newUrl = 'https://insight.univer.ai/'
  const newRichText = cellValue.copy().updateLink(id, newUrl)
  fRange.setRichTextValueForCell(newRichText)
}, 3000)

Table of Contents

APIs
cancelHyperLink
getHyperLinks
getUrl
setHyperLink
updateHyperLink
Capalyze