In This Topic ▼

start Method

Summary

Starts internal comparison operations.

Syntax

TypeScript

JavaScript

CompareView.prototype.start = function()

start(): void;

Remarks

Based off the tick-rate that was set with the setCompareTickrate function, the CompareView object will perform the following workflow:

Check an internal cache to see if any new page's text has been cached since the last tick. If no new pages were cached, then the CompareView will not proceed.
Build a string-representation and text-map of all the pages for both LEADDocuments that are in the DocumentViewers.
Call the Document Service StringCompare API endpoint.
Parse the returns from the service into a DocumentDifference object on the client-side.
Update the differences object with the new diff set.
Create and add new AnnTextHiliteObjects for each diff region in the viewer. For more information, refer to metadataKey.

Requirements

Help Version 23.0.2024.2.29

Leadtools.Document.Viewer Assembly