Skip to content

update to internal commit 7bf8aae6 #73

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.

Sign up for GitHub

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
Nov 4, 2025
Merged

update to internal commit 7bf8aae6 #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions programming/javascript/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,15 @@ breadcrumbText: API Reference

### UI

| Name | Description |
| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| [convertToPageCoordinates](./ui.md#convertToPageCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the whole page. |
| [convertToClientCoordinates](./ui.md#convertToClientCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the viewport. |
| [setCameraView](./ui.md#setCameraView) | Sets the `CameraView` instance to be used with the `CameraEnhancer`. |
| [getCameraView](./ui.md#getCameraView) | Retrieves the current `CameraView` instance associated with the `CameraEnhancer`. |
| [getVideoEl](./ui.md#getVideoEl) | Retrieves the HTMLVideoElement used by the `CameraEnhancer` for displaying the camera feed. |
| Name | Description |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [convertToPageCoordinates](./ui.md#convertToPageCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the whole page. |
| [convertToClientCoordinates](./ui.md#convertToClientCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the viewport. |
| [convertToScanRegionCoordinates](./ui.md#convertToScanRegionCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the scan region. |
| [convertToContainCoordinates](./ui.md#convertToClientCoordinates) | Converts coordinates from the `fit: cover` to `fit: contain` mode. |
| [setCameraView](./ui.md#setCameraView) | Sets the `CameraView` instance to be used with the `CameraEnhancer`. |
| [getCameraView](./ui.md#getCameraView) | Retrieves the current `CameraView` instance associated with the `CameraEnhancer`. |
| [getVideoEl](./ui.md#getVideoEl) | Retrieves the HTMLVideoElement used by the `CameraEnhancer` for displaying the camera feed. |

### Auxiliary

Expand Down
28 changes: 28 additions & 0 deletions programming/javascript/api-reference/ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ permalink: /programming/javascript/api-reference/ui.html
| [convertToScanRegionCoordinates](#convertToScanRegionCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the scan region. |
| [convertToPageCoordinates](#convertToPageCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the whole page. |
| [convertToClientCoordinates](#convertToClientCoordinates) | Converts coordinates from the video's coordinate system to coordinates relative to the viewport. |
| [convertToContainCoordinates](#convertToClientCoordinates) | Converts coordinates from the `fit: cover` to `fit: contain` mode. |
| [setCameraView](#setCameraView) | Sets the `CameraView` instance to be used with the `CameraEnhancer`. |
| [getCameraView](#getCameraView) | Retrieves the current `CameraView` instance associated with the `CameraEnhancer`. |
| [getVideoEl](#getVideoEl) | Retrieves the HTMLVideoElement used by the `CameraEnhancer` for displaying the camera feed. |
Expand Down Expand Up @@ -101,6 +102,33 @@ cameraEnhancer.convertToClientCoordinates({x: 0, y: 0});

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

## convertToContainCoordinates

Converts coordinates from the `fit: cover` to `fit: contain` mode.
This is useful for positioning HTML elements in relation to the video element on the screen, regardless of page scrolling.

```typescript
convertToContainCoordinates(point: Point): Point;
```

**Parameters**

`point`: a `Point` object representing the x and y coordinates within the video's coordinate system.

**Return value**

A `Point` object representing the converted x and y coordinates relative to the viewport.

**Code Snippet**

```javascript
cameraEnhancer.convertToContainCoordinates({x: 0, y: 0});
```

**See also**

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

## setCameraView

Sets the `CameraView` instance to be used with the `CameraEnhancer`.
Expand Down