Interface: IHyperlink

Properties

alt?

readonlyoptionalalt: string

The alternate text for the hyperlink

---

artifactId?

readonlyoptionalartifactId: number

An optional artifact ID associated with the hyperlink

---

external

readonlyexternal: boolean

Returns true if the hyperlink points to an external resource, false if it points to a bookmark within the same document

---

id

readonlyid: string

An identifier for the note.

---

manuallyAdded

readonlymanuallyAdded: boolean

Returns true if the hyperlink was added via the API after the document was loaded

---

name?

readonlyoptionalname: string

An optional user facing name for the hyperlink

---

range?

readonlyoptionalrange: HyperlinkRangeMemento

The viewer content range affected by this hyperlink

---

target?

readonlyoptionaltarget: string

The target frame for the hyperlink

---

type

readonlytype: HyperlinkType

The hyperlink type

---

url

readonlyurl: string

The URL for the hyperlink (may be an empty string)

---

userData

readonlyuserData: UserDataMap

A map that may be used by the calling code to associate data with the note. The calling code may place any data in the UserDataMap, and that data will follow the note around until it is destroyed.