@digitalpersona/core/dist/api/docs/core.faceimage.md

DigitalPersona Web Access Core library

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@digitalpersona/core](./core.md) &gt; [FaceImage](./core.faceimage.md)

## FaceImage class

Face image data.

<b>Signature:</b>

```typescript
export declare class FaceImage 
```

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(ImageData, ImageType)](./core.faceimage.(constructor).md) |  | Constructs a new instance of the <code>FaceImage</code> class |

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [ImageData](./core.faceimage.imagedata.md) |  | <code>Base64UrlString</code> | Base64url-encoded image data. |
|  [ImageType](./core.faceimage.imagetype.md) |  | <code>FaceImageType</code> | Image format. |
|  [Version](./core.faceimage.version.md) |  | <code></code> | Version info. |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [fromCanvas(canvas, quality)](./core.faceimage.fromcanvas.md) | <code>static</code> | Extracts face image from a browser's canvas object. |
|  [fromDataURL(image)](./core.faceimage.fromdataurl.md) | <code>static</code> | Extracts face image from a data URL. Only <code>data:image/jpeg;base64</code> is supported for now. |
|  [toBioSample(format, purpose, sdkVersion)](./core.faceimage.tobiosample.md) |  | Exports the face image data to a [BioSample](./core.biosample.md) object. |