Skip to content

update to internal commit 19d834ad #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: default-layout
title: Interface DetectedQuadResultItem - Dynamsoft Document Normalizer JS Edition API Reference
description: This page shows the JS edition of the interface DetectedQuadResultItem.
keywords: detected quad, JS
needAutoGenerateSidebar: true
noTitleIndex: true
---

# DetectedQuadResultItem

The `DetectedQuadResultItem` interface extends the `CapturedResultItem` interface and represents a detected quadrilateral result item.

```ts
interface DetectedQuadResultItem extends CapturedResultItem {
location: Quadrilateral;
confidenceAsDocumentBoundary: number;
}
```

## location

The location of the detected quadrilateral within the original image, represented as a quadrilateral shape.

## confidenceAsDocumentBoundary

A confidence score measuring the certainty that the detected quadrilateral represents the boundary of a document.

**See Also**

[CapturedResultItem](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/captured-result-item.html)

[Quadrilateral](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/quadrilateral.html)
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The `DetectedQuadResultItem` interface extends the `CapturedResultItem` interfac
interface DetectedQuadResultItem extends CapturedResultItem {
location: Quadrilateral;
confidenceAsDocumentBoundary: number;
crossVerificationStatus: EnumCrossVerificationStatus;
}
```

Expand All @@ -26,8 +27,14 @@ The location of the detected quadrilateral within the original image, represente

A confidence score measuring the certainty that the detected quadrilateral represents the boundary of a document.

## crossVerificationStatus

Indicates whether the DetectedQuadResultItem has passed cross verification.

**See Also**

[CapturedResultItem](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/captured-result-item.html)

[Quadrilateral](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/quadrilateral.html)
[Quadrilateral](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/quadrilateral.html)

[EnumCrossVerificationStatus]({{ site.enums }}core/cross-verification-status.html?lang=js)
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: default-layout
title: Interface LogicLinesUnit - Dynamsoft Document Normalizer JS Edition API Reference
description: This page shows the JS edition of the interface LogicLinesUnit.
keywords: logic lines, JS
needAutoGenerateSidebar: true
noTitleIndex: true
---

# LogicLinesUnit

The `LogicLinesUnit` interface extends the `IntermediateResultUnit` interface and represents a unit of line segments.

```ts
interface LogicLinesUnit extends IntermediateResultUnit {
logicLines: Array<LineSegment>;
}
```

## logicLines

An array of line segment detected within the image.

**See Also**

[IntermediateResultUnit](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/intermediate-results/intermediate-result-unit.html)

[LineSegment](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/line-segment.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
layout: default-layout
title: Interface NormalizedImageResultItem - Dynamsoft Document Normalizer JS Edition API Reference
description: This page shows the JS edition of the interface NormalizedImageResultItem.
keywords: normalized image result, JS
needAutoGenerateSidebar: true
noTitleIndex: true
---

# NormalizedImageResultItem

The `NormalizedImageResultItem` interface extends the `CapturedResultItem` interface and represents a normalized image result item.

```ts
interface NormalizedImageResultItem extends CapturedResultItem {
imageData: DSImageData;
location: Quadrilateral;
toCanvas(): HTMLCanvasElement;
toImage(MIMEType: "image/png" | "image/jpeg"): HTMLImageElement;
toBlob(MIMEType: "image/png" | "image/jpeg"): Promise<Blob>;
saveToFile(name: string, download?: boolean): Promise<File>;
}
```

## imageData

The image data for the normalized image result.

**See Also**

[DSImageData](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/ds-image-data.html)

## location

The location where the normalized image was extracted from within the original image, represented as a quadrilateral.

**See Also**

[Quadrilateral](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/quadrilateral.html)

## toCanvas

Converts the normalized image data into an HTMLCanvasElement for display or further manipulation in web applications.

**See Also**

[HTMLCanvasElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement)

## toImage

Converts the normalized image data into an HTMLImageElement of a specified MIME type ('image/png' or 'image/jpeg').

**See Also**

[HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement)

## toBlob

Converts the normalized image data into a Blob object of a specified MIME type ('image/png' or 'image/jpeg').

**See Also**

[Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob)

## saveToFile

Saves the normalized image to a File object in memory, optionally downloading it to the user's device.

**Parameters**

`name`: the name to assign to the File object.

`download` optional. If true, triggers the download of the file once created; otherwise, retains the file in memory.

**See Also**

[File](https://developer.mozilla.org/en-US/docs/Web/API/File)
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The `NormalizedImageResultItem` interface extends the `CapturedResultItem` inter
interface NormalizedImageResultItem extends CapturedResultItem {
imageData: DSImageData;
location: Quadrilateral;
crossVerificationStatus: EnumCrossVerificationStatus;
toCanvas(): HTMLCanvasElement;
toImage(MIMEType: "image/png" | "image/jpeg"): HTMLImageElement;
toBlob(MIMEType: "image/png" | "image/jpeg"): Promise<Blob>;
Expand All @@ -38,6 +39,14 @@ The location where the normalized image was extracted from within the original i

[Quadrilateral](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/quadrilateral.html)

## crossVerificationStatus

Indicates whether the NormalizedImageResultItem has passed cross verification.

**See Also**

[EnumCrossVerificationStatus]({{ site.enums }}core/cross-verification-status.html?lang=js)

## toCanvas

Converts the normalized image data into an HTMLCanvasElement for display or further manipulation in web applications.
Expand Down
Loading