Interface: IPersistentHighlightSet

Object used to display PersistentHighlight Sets in the UI

Properties

count

count: number

The total number of term hits of the highlight set

---

expanded

expanded: boolean

The initial expanded state of the highlight set

---

hasEditPermission

hasEditPermission: boolean

Whether the user has edit highlight set permissions

---

id

readonlyid: string

Unique Identifier for the highlight set

---

order

readonlyorder: number

The order the Persistent Highlight Sets will be rendered

---

persistentHighlightSetArtifactId

readonlypersistentHighlightSetArtifactId: number

Persistent Highlight Set's Artifact ID

---

persistentHighlightTerms

readonlypersistentHighlightTerms: IPersistentHighlightTerm[]

The Persistent Highlight Term's for this Highlight Set

---

renderedTermCount

renderedTermCount: number

The total number of rendered terms in the view

---

selected

selected: boolean

The selected state of the highlight set

---

setName

readonlysetName: string

The Highlight Set's Name

---

syntax

syntax: string

The search syntax for the Persistent Highlight Set (phsTerms or dtSearch)

---

visible

visible: boolean

The initial visibility state of the highlight set