Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPersistentHighlightTerm

Object used to display PersistentHighlight Terms in the UI

Hierarchy

  • IPersistentHighlightTerm

Index

Properties

backgroundColor

backgroundColor: string

Color code for the background of the highlight term

count

count: number

The amount of terms highlighted by the viewer

foregroundColor

foregroundColor: string

Color code for the foreground of the highlight term

id

id: string

Unique Identifier for the highlight term

Optional isNew

isNew: boolean

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

Optional isZeroHitStrTerm

isZeroHitStrTerm: boolean

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

persistentHighlightSetArtifactId

persistentHighlightSetArtifactId: number

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

persistentHighlightTermArtifactId

persistentHighlightTermArtifactId: number

Persistent Highlight Term's Artifact ID

selected

selected: boolean

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

syntax

syntax: string

The search syntax for the highlight term.

term

term: string

Highlight Term's values

visible

visible: boolean

The initial visibility state of the highlight term