Interface: IPersistentHighlightTerm

Object used to display PersistentHighlight Terms in the UI

Properties

backgroundColor

readonlybackgroundColor: string

Color code for the background of the highlight term

---

count

count: number

The amount of terms highlighted by the viewer

---

foregroundColor

readonlyforegroundColor: string

Color code for the foreground of the highlight term

---

id

readonlyid: string

Unique Identifier for the highlight term

---

isElasticSearchTerm?

optionalisElasticSearchTerm: boolean

Indicates if a term is using Elasticsearch syntax.

---

isNew?

optionalisNew: boolean

The term is newly added and should display even if zero hits

---

isZeroHitStrTerm?

optionalisZeroHitStrTerm: boolean

The term is from a search term report and has 0 hits

---

persistentHighlightSetArtifactId

readonlypersistentHighlightSetArtifactId: number

The Persistent Highlight Set's Artifact ID that this highlight term belongs to

---

persistentHighlightTermArtifactId

readonlypersistentHighlightTermArtifactId: number

Persistent Highlight Term's Artifact ID

---

searchData?

optionalsearchData: string

For some terms, like Elasticsearch, the "term" is just for display. This property stores the actual request data required to execute in whatever format that specific executor choses.

---

selected

selected: boolean

The selected state of the highlight term Note: this does not imply the term checkbox is checked

---

syntax

readonlysyntax: string

The search syntax for the highlight term.

---

term

readonlyterm: string

Highlight Term's values

---

visible

visible: boolean

The initial visibility state of the highlight term