In This Topic ▼

logServiceError Method

Summary

Handles document service-specific error messages.

Syntax

TypeScript

JavaScript

logServiceError = function()

logServiceError( 
   serviceError: ServiceError, 
   _defaultMessage?_: string 
): string;

Parameters

serviceError

The ServiceError that occurred.

defaultMessage

The default error context provided from LEADVIEW.

Return Value

A string containing the message that should be displayed.

Remarks

The default ILogger for LEADVIEW, displays error messages with as much detail as is available (The controller/method where the exception occurred, the exception message + stack trace, etc.).

Example

RunSettings.ts

RunSettings.html

export class RunSettingsExample { 
    public constructor() { 
        if(lt.RasterSupport.kernelExpired) 
            lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
    } 
 
    public run = (divID: string): void => { 
        const lv = new lt.LEADVIEW.Viewer(); 
        const runSettings: lt.LEADVIEW.RunSettings = { 
            logger: this.createLogger(), 
            author: "Demo Author" 
        } 
 
        // A quick test to make sure the logger was injected successfully is to change the 'rootDivId' to an invalid ID 
        // This will throw a LEADVIEW creation error, which will be bubbled up to the logApplicationError Logger method. 
        lv.run(runSettings, { 
            'rootDivId': divID 
        }); 
    } 
 
    private createLogger = ():lt.LEADVIEW.ILogger => { 
        const logger: lt.LEADVIEW.ILogger = { 
            logApplicationError: (errorType: lt.LEADVIEW.ErrorType, message:string) =>{ 
                alert(`Application Error:\nType:${errorType}\nMessage:${message}`); 
            }, 
            logServiceError: (serviceError: lt.Document.ServiceError, defaultMessage?: string) => { 
                alert(`Service Error:\nType:${serviceError.code}\nMessage:${serviceError.message}`); 
                return serviceError.message; 
            } 
        }; 
 
        return logger; 
    } 
}

<!doctype html> 
<html lang="en"> 
    <title>LV Examples | RunSettings</title> 
    <head> 
        <script src="https://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
 
        <script src="../LT/Leadtools.js"></script> 
        <script src="../LT/Leadtools.Controls.js"></script> 
        <script src="../LT/Leadtools.Annotations.Engine.js"></script> 
        <script src="../LT/Leadtools.Annotations.Designers.js"></script> 
        <script src="../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
        <script src="../LT/Leadtools.Annotations.Automation.js"></script> 
        <script src="../LT/Leadtools.ImageProcessing.Main.js"></script> 
        <script src="../LT/Leadtools.ImageProcessing.Color.js"></script> 
        <script src="../LT/Leadtools.ImageProcessing.Core.js"></script> 
        <script src="../LT/Leadtools.ImageProcessing.Effects.js"></script> 
        <script src="../LT/Leadtools.Document.js"></script> 
        <script src="../LT/Leadtools.Document.Viewer.js"></script> 
        <script src="../LT/Leadtools.LEADVIEW.js" defer></script> 
        <link href="../css/Leadtools.LEADVIEW.css" type="text/css" rel="stylesheet"> 
 
        <!-- All of the LEADVIEW TypeScript examples are served as a bundle --> 
        <script src="../bundle.js" type="text/javascript"></script> 
    </head> 
    <body> 
        <div id="runDemo" style="width: 100%; height: 100vh;"></div> 
    </body> 
 
    <script> 
       window.onload = () => { 
         const example = new window.examples.RunSettingsExample(); 
         example.run("runDemo"); 
      }; 
    </script> 
</html>

Requirements

Target Platforms

Reference

ILogger Class

ILogger Members

lt.LEADVIEW Namespace

Download our FREE evaluation

Help Version 22.0.2023.1.31

Leadtools.LEADVIEW Assembly

Introduction

Getting Started

Namespaces

Leadtools.LEADVIEW Namespace

Assemblies