generateMarkdownReport Method

Summary

Generates a Markdown Report from the result set.

Syntax
TypeScript
JavaScript
DocumentDifference.prototype.generateMarkdownReport = function( 
   mimetype, 
   options, 
   userData 
) 
generateMarkdownReport( 
   mimetype: string, 
   options: ReportOptions, 
   _userData?_: any 
): JQueryPromise<string>; 

Parameters

mimetype

The mime type of the result document. This must be set to "ext/markdown".

options

The MarkdownReportOptions to use when building the report.

userData

User defined data to pass to the service.

Return Value

A Promise object that may resolve successfully to a string object containing the document.

Example
TypeScript
JavaScript
const url = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
const url2 = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
const loadDocumentOptions = new lt.Document.LoadDocumentOptions(); 
 
lt.Document.DocumentFactory.loadFromUri(url, loadDocumentOptions) 
   .done((document1) => { 
      lt.Document.DocumentFactory.loadFromUri(url2, loadDocumentOptions) 
         .done((document2) => { 
            const options = new lt.Document.Compare.DocumentCompareOptions(); 
            lt.Document.LEADDocument.compare([document1.documentId, document2.documentId], options) 
               .done((diff) => { 
                  diff.generateMarkdownReport("text/markdown", new lt.Document.Compare.MarkdownReportOptions()) 
                     .done((response) => { 
                        const blob = new Blob([response], { type: "text/plain" }); 
                        const link = document.createElement('a'); 
                        link.href = window.URL.createObjectURL(blob); 
                        const fileName = "MarkdownReport.md"; 
                        link.download = fileName; 
                        link.target = "_blank"; 
                        link.rel = "noopener noreferrer"; 
                        document.body.appendChild(link); 
                        link.click(); 
                        link.remove(); 
                     }) 
                     .fail(showServiceError); 
               }) 
               .fail(showServiceError); 
         }) 
         .fail(showServiceError); 
   }) 
   .fail(showServiceError); 
class DocumentDifference_GenerateMarkdownReportExample { 
    public constructor() { 
        lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/v200/LEADTOOLSEVAL.txt", "EVAL", null); 
    } 
 
    public run(buttonID: string) { 
        document.getElementById(buttonID).onclick = this.compareDocument; 
    } 
 
    compareDocument = () => { 
 
        const url = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
        const url2 = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
        const loadDocumentOptions = new lt.Document.LoadDocumentOptions(); 
 
        lt.Document.DocumentFactory.loadFromUri(url, loadDocumentOptions) 
            .done((document1: lt.Document.LEADDocument) => { 
                lt.Document.DocumentFactory.loadFromUri(url2, loadDocumentOptions) 
                    .done((document2: lt.Document.LEADDocument) => { 
                        const options = new lt.Document.Compare.DocumentCompareOptions(); 
                        lt.Document.LEADDocument.compare([document1.documentId, document2.documentId], options) 
                            .done((diff) => { 
                                diff.generateMarkdownReport("text/markdown", new lt.Document.Compare.MarkdownReportOptions()) 
                                .done((response) => { 
                                    const blob = new Blob([response], { type: "text/plain" }); 
                                    const link = document.createElement('a'); 
                                    link.href = window.URL.createObjectURL(blob); 
                                    const fileName = "MarkdownReport.md"; 
                                    link.download = fileName; 
                                    link.target = "_blank"; 
                                    link.rel = "noopener noreferrer"; 
                                    document.body.appendChild(link); 
                                    link.click(); 
                                    link.remove(); 
                                }) 
                                .fail(showServiceError); 
                            }) 
                            .fail(showServiceError); 
                    }) 
                    .fail(showServiceError); 
            }) 
            .fail(showServiceError); 
    } 
} 

Requirements

Target Platforms

Help Version 20.0.2019.4.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly