In This Topic ▼

runAnalysis Method

Summary

Performs analysis on a document.

Syntax

TypeScript

JavaScript

runAnalysis = function( 
   documentId, 
   options 
)

static runAnalysis( 
   documentId: string, 
   options: DocumentAnalyzerRunOptions 
): JQueryPromise<AnalysisResult[]>;

documentId

The ID corresponding to the document that should be analyzed.

options

The DocumentAnalyzerRunOptions to use when analyzing the document.

A JQuery promise that will resolve successfully to a collection of AnalysisResult objects. If DocumentAnalyzerRunOptions.returnResults is set to false, the promise will resolve to an empty array instead.

Requirements

Help Version 22.0.2023.2.1

Leadtools.Document Assembly