Auxiliary APIs

ifSaveOriginalImageInACanvas

Whether to save the original image into a < canvas> element. The original image refers to the actual image the library tried to read labels from.

Note that the result is an HTMLCanvasElement element and you can insert it into the DOM to show the image.

ifSaveOriginalImageInACanvas: boolean;

Default value

false

Code snippet

recognizer.ifSaveOriginalImageInACanvas = true;
let results = await recognizer.recognize(source);
document.body.append(recognizer.getOriginalImageInACanvas());

getOriginalImageInACanvas

An HTMLCanvasElement that holds the original image. The original image refers to the actual image the library tried to read labels from.

getOriginalImageInACanvas(): HTMLCanvasElement | OffscreenCanvas

Code snippet

recognizer.ifSaveOriginalImageInACanvas = true;
let results = await recognizer.recognize(source);
document.body.append(recognizer.getOriginalImageInACanvas());

See also

• HTMLCanvasElement
• OffscreenCanvas

onResourcesLoadStarted

This event is triggered when the resource file (.data) for a particular template starts to load.

static onResourcesLoadStarted = (resourcePath: string) => {};

Code snippet

Dynamsoft.DLR.LabelRecognizer.onResourcesLoadStarted = (resourcePath) => {
  console.log("Loading " + resourcePath);
}
recognizer.updateRuntimeSettingsFromString("MRZ");

onResourcesLoadProgress

This event is triggered multiple times when the resource file (.data) for a particular template is being loaded.

static onResourcesLoadProgress = (resourcePath: string, progress: {loaded: number, total: number}) => {};

Code snippet

Dynamsoft.DLR.LabelRecognizer.onResourcesLoadProgress = (resourcePath, progress) => {
    console.log(resourcePath + "loading progress: " + progress.loaded + "/" + progress.total);
}
recognizer.updateRuntimeSettingsFromString("MRZ");

onResourcesLoaded

This event is triggered when the resource file (.data) for a particular template finishes loading.

static onResourcesLoaded = (resourcePath: string) => {};

Code snippet

Dynamsoft.DLR.LabelRecognizer.onResourcesLoaded = (resourcePath) => {
  console.log("Finished loading " + resourcePath);
}
recognizer.updateRuntimeSettingsFromString("MRZ");