Id Images
Defined under the namespace Scandit.Datacapture.Id
- IdImages
class IdImagesAdded in version 7.0.0
A class that contains the extracted images from a document.
- face
get face(): string | null
Added in version 7.0.0
Returns a bitmap corresponding to a photo of the document’s holder. This method is only supported for documents whose Visual Inspection Zone (VIZ) has been captured.
By default, this method returns the image as a base64-encoded string. If DataCaptureContextSettings.frameDataSettings is configured to use the filesystem cache, it returns the path to the cached file instead.
- getCroppedDocument(side)
getCroppedDocument(side: IdSide): string | null
Added in version 7.0.0
Returns a bitmap of a cropped image of the specified document side. This method is only supported for documents whose Visual Inspection Zone (VIZ) has been captured.
By default, this method returns the image as a base64-encoded string. If DataCaptureContextSettings.frameDataSettings is configured to use the filesystem cache, it returns the path to the cached file instead.
- frame
get frame(): string | null
Added in version 7.0.0
Returns a bitmap corresponding the full frame the document was captured on.
By default, this method returns the image as a base64-encoded string. If DataCaptureContextSettings.frameDataSettings is configured to use the filesystem cache, it returns the path to the cached file instead.
- getFrame(side)
getFrame(side: IdSide): string | null
Added in version 7.0.0
Returns a bitmap of the full frame the specified document side was captured on.
By default, this method returns the image as a base64-encoded string. If DataCaptureContextSettings.frameDataSettings is configured to use the filesystem cache, it returns the path to the cached file instead.