constructor

• new IgxTextHighlightDirective(): IgxTextHighlightDirective

  Returns IgxTextHighlightDirective

activeCssClass

<div
  igxTextHighlight
  [activeCssClass]="activeHighlightClass">
</div>
Copy

column

<div
  igxTextHighlight
  [column]="0">
</div>
Copy

cssClass

<div
  igxTextHighlight
  [cssClass]="myClass">
</div>
Copy

groupName

<div
  igxTextHighlight
  [groupName]="myGroupName">
</div>
Copy

metadata

 // Set a property, which would disable the highlight for a given element on a certain condition
 const metadata = new Map<string, any>();
 metadata.set('highlightElement', false);
Copy

<div
  igxTextHighlight
  [metadata]="metadata">
</div>
Copy

row

<div
  igxTextHighlight
  [row]="0">
</div>
Copy

value

• get value(): any

  The underlying value of the element that will be highlighted.

  // get
  const elementValue = this.textHighlight.value;
  Copy

  <!--set-->
  <div
    igxTextHighlight
    [value]="newValue">
  </div>
  Copy

  Returns any

• set value(value: any): void

  Parameters

  • value: any

  Returns void

activateIfNecessary

• activateIfNecessary(): void

  Activates the highlight if it is on the currently active row and column.

  Returns void

clearHighlight

• clearHighlight(): void

  Clears any existing highlight.

  Returns void

highlight

• highlight(text: string, caseSensitive?: boolean, exactMatch?: boolean): number

  Clears the existing highlight and highlights the searched text. Returns how many times the element contains the searched text.

  Parameters

  • text: string

  • caseSensitive: boolean

  • exactMatch: boolean

  Returns number

observe

• observe(): void

  Attaches a MutationObserver to the parentElement and watches for when the container element is removed/readded to the DOM. Should be used only when necessary as using many observers may lead to performance degradation.

  Returns void