goog.dom.annotate

Provided By	`goog.dom.annotate`

No description available.

VIEW SOURCE

Functions

Calls annotateFn for each occurrence of a search term in text nodes under node. Returns the number of hits.

Parameters

`node`	`(Node\|null)`
	A DOM node.
`terms`	`(Array<Array<(string\|boolean)>>\|null)`
	An array of [searchTerm, matchWholeWordOnly] tuples. The matchWholeWordOnly value is a per-term attribute because some terms may be CJK, while others are not. (For correctness, matchWholeWordOnly should always be false for CJK terms.).
`annotateFn`	`function(number, goog.html.SafeHtml): goog.html.SafeHtml`

`opt_ignoreCase`	`*=`
	Whether to ignore the case of the query terms when looking for matches.
`opt_classesToSkip`	`(Array<string>\|null)=`
	Nodes with one of these CSS class names (and its descendants) will be skipped.
`opt_maxMs`	`number=`
	Number of milliseconds after which this function, if still annotating, should stop and return.

Returns

boolean

Whether any terms were annotated.

VIEW SOURCE

Annotates occurrences of query terms in plain text. This process consists of identifying all occurrences of all query terms, calling a provided function to get the appropriate replacement HTML for each occurrence, and HTML-escaping all the text.

Parameters

`text`	`string`
	The plain text to be searched.
`terms`	`(Array<(Array<?>\|null)>\|null)`
	An array of [{string} searchTerm, {boolean} matchWholeWordOnly] tuples. The matchWholeWordOnly value is a per-term attribute because some terms may be CJK, while others are not. (For correctness, matchWholeWordOnly should always be false for CJK terms.).
`annotateFn`	`function(number, goog.html.SafeHtml): goog.html.SafeHtml`

`opt_ignoreCase`	`*=`
	Whether to ignore the case of the query terms when looking for matches.

Returns

(goog.html.SafeHtml|null)

The HTML equivalent of text with terms annotated, or null if the text did not contain any of the terms.

VIEW SOURCE

Properties

A function that takes: (1) the number of the term that is "hit", (2) the HTML (search term) to be annotated, and returns the annotated term as an HTML.

VIEW SOURCE

goog.dom.annotate

Functions

annotateTerms( `node`, `terms`, `annotateFn`, `opt_ignoreCase`, `opt_classesToSkip`, `opt_maxMs` ) `→` `boolean`

annotateText( `text`, `terms`, `annotateFn`, `opt_ignoreCase` ) `→` `(goog.html.SafeHtml|null)`

Properties

AnnotateFn `→` `function(number, goog.html.SafeHtml): goog.html.SafeHtml`

goog.dom.annotate

Functions

annotateTerms( node, terms, annotateFn, opt_ignoreCase, opt_classesToSkip, opt_maxMs ) → boolean

annotateText( text, terms, annotateFn, opt_ignoreCase ) → (goog.html.SafeHtml|null)

Properties

AnnotateFn → function(number, goog.html.SafeHtml): goog.html.SafeHtml

annotateTerms( `node`, `terms`, `annotateFn`, `opt_ignoreCase`, `opt_classesToSkip`, `opt_maxMs` ) `→` `boolean`

annotateText( `text`, `terms`, `annotateFn`, `opt_ignoreCase` ) `→` `(goog.html.SafeHtml|null)`

AnnotateFn `→` `function(number, goog.html.SafeHtml): goog.html.SafeHtml`