From 8e64915acd33a73639f7c4b7915f1259872763fd Mon Sep 17 00:00:00 2001 From: Justin Date: Tue, 14 Jul 2026 09:44:47 +0800 Subject: [PATCH 1/2] Remove commented-out API method documentation from acquisition and drawingitem references --- .../javascript/api-reference/acquisition.md | 42 ++++++++++++------- .../javascript/api-reference/drawingitem.md | 6 +-- programming/javascript/api-reference/index.md | 15 ------- 3 files changed, 30 insertions(+), 33 deletions(-) diff --git a/programming/javascript/api-reference/acquisition.md b/programming/javascript/api-reference/acquisition.md index cfbdf4f8..b7c118be 100644 --- a/programming/javascript/api-reference/acquisition.md +++ b/programming/javascript/api-reference/acquisition.md @@ -14,33 +14,34 @@ permalink: /programming/javascript/api-reference/acquisition.html | Name | Description | | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| [addImageToBuffer](#addImageToBuffer) | Adds an image to the internal buffer. | -| [clearBuffer](#clearBuffer) | Clears all images from the buffer, resetting the state for new image fetching. | + + | [fetchImage](#fetchImage) | Fetches the current frame from the camera's video feed. | -| [getBufferOverflowProtectionMode](#getBufferOverflowProtectionMode) | Retrieves the current mode for handling buffer overflow. | + | [getColourChannelUsageType](#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. | | [getImage](#getImage) | Retrieves a buffered image, of type `DSImageData`. | -| [getImageCount](#getImageCount) | Retrieves the current number of images in the buffer. | -| [getImageFetchInterval](#getImageFetchInterval) | Retrieves the current interval at which images are continuously fetched from the camera's video feed. | -| [getMaxImageCount](#getMaxImageCount) | Retrieves the maximum number of images that can be buffered. | + + + | [getPixelFormat](#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. | | [getScanRegion](#getScanRegion) | Retrieves the current scan region set within the camera's view. | -| [hasImage](#hasImage) | Checks if an image with the specified ID is present in the buffer. | + | [hasNextImageToFetch](#hasNextImageToFetch) | Determines whether there are more images available to fetch. | | [isBufferEmpty](#isBufferEmpty) | Determines whether the buffer is currently empty. | -| [setBufferOverflowProtectionMode](#setBufferOverflowProtectionMode) | Sets the behavior for handling new incoming images when the buffer is full. | + | [setColourChannelUsageType](#setColourChannelUsageType) | Sets the usage type for color channels in images. | -| [setErrorListener](#setErrorListener) | Sets an error listener to receive notifications about errors that occur during image source operations. | -| [setImageFetchInterval](#setImageFetchInterval) | Sets the interval at which images are continuously fetched from the camera's video feed. | -| [setMaxImageCount](#setMaxImageCount) | Sets the maximum number of images that can be buffered at any time. | -| [setNextImageToReturn](#setNextImageToReturn) | Sets the processing priority of a specific image so that it is returned the next time `getImage()` is called. | + + + + | [setPixelFormat](#setPixelFormat) | Sets the pixel format for the images fetched from the camera. | | [setScanRegion](#setScanRegion) | Sets the scan region within the camera's view which limits the frame acquisition to a specific area of the video feed. | | [singleFrameMode](#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. | -| [startFetching](#startFetching) | Starts the process of fetching images. | -| [stopFetching](#stopFetching) | Stops the process of fetching images. | + + | [takePhoto](#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. | + ## fetchImage @@ -115,6 +117,7 @@ document.body.appendChild(image.toCanvas()); [DCEFrame](interface/dceframe.md) + ## getColourChannelUsageType @@ -195,6 +199,7 @@ document.body.appendChild(image.toCanvas()); [DCEFrame](interface/dceframe.md) + ## getPixelFormat @@ -314,6 +320,7 @@ let region = cameraEnhancer.getScanRegion(); [DSRect](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/basic-structures/ds-rect.html) + ## hasNextImageToFetch @@ -384,6 +392,7 @@ if(cameraEnhancer.isBufferEmpty()) { } ``` + ## setColourChannelUsageType @@ -436,6 +446,7 @@ cameraEnhancer.setColourChannelUsageType(Dynamsoft.Core.EnumColourChannelUsageTy [EnumColourChannelUsageType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/colour-channel-usage-type.html?lang=js) + ## setPixelFormat @@ -658,6 +670,7 @@ singleFrameMode: "disabled" | "camera" | "image"; > As shown in the code snippet above, `singleFrameMode` should be set before calling `open()`. + ## takePhoto diff --git a/programming/javascript/api-reference/drawingitem.md b/programming/javascript/api-reference/drawingitem.md index 144cc598..f8ad4c06 100644 --- a/programming/javascript/api-reference/drawingitem.md +++ b/programming/javascript/api-reference/drawingitem.md @@ -24,7 +24,6 @@ In this version, the subclasses include: | Name | Description | | --------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [coordinateBase](#coordinatebase) | Returns or sets the coordinate system base. | | [drawingLayerId](#drawinglayerid) | Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to. | | [drawingStyleId](#drawingstyleid) | Returns or sets the numeric ID for the `DrawingStyle` that applies to this `DrawingItem`. | | [mediaType](#mediatype) | Returns an enumeration value which indicates the type of this `DrawingItem` (e.g., image, line, text). | @@ -39,7 +38,7 @@ In this version, the subclasses include: | [deleteNote()](#deletenote) | Deletes a `Note` object specified by its name. | | [clearNotes()](#clearnotes) | Deletes all `Note` objects on this `DrawingItem`. | -## coordinateBase + ## drawingLayerId Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to. diff --git a/programming/javascript/api-reference/index.md b/programming/javascript/api-reference/index.md index 1359a00a..9894507c 100644 --- a/programming/javascript/api-reference/index.md +++ b/programming/javascript/api-reference/index.md @@ -75,31 +75,17 @@ breadcrumbText: API Reference | Name | Description | | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| [addImageToBuffer](./acquisition.md#addImageToBuffer) | Adds an image to the internal buffer. | -| [clearBuffer](./acquisition.md#clearBuffer) | Clears all images from the buffer, resetting the state for new image fetching. | | [fetchImage](./acquisition.md#fetchImage) | Fetches the current frame from the camera's video feed. | -| [getBufferOverflowProtectionMode](./acquisition.md#getBufferOverflowProtectionMode) | Retrieves the current mode for handling buffer overflow. | | [getColourChannelUsageType](./acquisition.md#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. | | [getImage](./acquisition.md#getImage) | Retrieves a buffered image, of type `DSImageData`. | -| [getImageCount](./acquisition.md#getImageCount) | Retrieves the current number of images in the buffer. | -| [getImageFetchInterval](./acquisition.md#getImageFetchInterval) | Retrieves the current interval at which images are continuously fetched from the camera's video feed. | -| [getMaxImageCount](./acquisition.md#getMaxImageCount) | Retrieves the maximum number of images that can be buffered. | | [getPixelFormat](./acquisition.md#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. | | [getScanRegion](./acquisition.md#getScanRegion) | Retrieves the current scan region set within the camera's view. | -| [hasImage](./acquisition.md#hasImage) | Checks if an image with the specified ID is present in the buffer. | | [hasNextImageToFetch](./acquisition.md#hasNextImageToFetch) | Determines whether there are more images available to fetch. | | [isBufferEmpty](./acquisition.md#isBufferEmpty) | Determines whether the buffer is currently empty. | -| [setBufferOverflowProtectionMode](./acquisition.md#setBufferOverflowProtectionMode) | Sets the behavior for handling new incoming images when the buffer is full. | | [setColourChannelUsageType](./acquisition.md#setColourChannelUsageType) | Sets the usage type for color channels in images. | -| [setErrorListener](./acquisition.md#setErrorListener) | Sets an error listener to receive notifications about errors that occur during image source operations. | -| [setImageFetchInterval](./acquisition.md#setImageFetchInterval) | Sets the interval at which images are continuously fetched from the camera's video feed. | -| [setMaxImageCount](./acquisition.md#setMaxImageCount) | Sets the maximum number of images that can be buffered at any time. | -| [setNextImageToReturn](./acquisition.md#setNextImageToReturn) | Sets the processing priority of a specific image so that it is returned the next time `getImage()` is called. | | [setPixelFormat](./acquisition.md#setPixelFormat) | Sets the pixel format for the images fetched from the camera. | | [setScanRegion](./acquisition.md#setScanRegion) | Sets the scan region within the camera's view which limits the frame acquisition to a specific area of the video feed. | | [singleFrameMode](./acquisition.md#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. | -| [startFetching](./acquisition.md#startFetching) | Starts the process of fetching images. | -| [stopFetching](./acquisition.md#stopFetching) | Stops the process of fetching images. | | [takePhoto](./acquisition.md#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. | ### UI @@ -185,7 +171,6 @@ breadcrumbText: API Reference | Name | Description | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [coordinateBase](./drawingitem.md#coordinatebase) | Returns or sets the coordinate system base. | | [drawingLayerId](./drawingitem.md#drawinglayerid) | Returns the numeric ID for the `DrawingLayer` this `DrawingItem` belongs to. | | [drawingStyleId](./drawingitem.md#drawingstyleid) | Returns or sets the numeric ID for the `DrawingStyle` that applies to this `DrawingItem`. | | [mediaType](./drawingitem.md#mediatype) | Returns an enumeration value which indicates the type of this `DrawingItem` (e.g., image, line, text). | From a8492f5360ca973f5e26b79dd37943c5090ce0f5 Mon Sep 17 00:00:00 2001 From: Justin Date: Tue, 14 Jul 2026 09:49:16 +0800 Subject: [PATCH 2/2] Remove commented-out API method documentation from acquisition reference --- .../javascript/api-reference/acquisition.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/programming/javascript/api-reference/acquisition.md b/programming/javascript/api-reference/acquisition.md index b7c118be..8410e8cc 100644 --- a/programming/javascript/api-reference/acquisition.md +++ b/programming/javascript/api-reference/acquisition.md @@ -14,31 +14,17 @@ permalink: /programming/javascript/api-reference/acquisition.html | Name | Description | | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | - - | [fetchImage](#fetchImage) | Fetches the current frame from the camera's video feed. | - | [getColourChannelUsageType](#getColourChannelUsageType) | Retrieves the current usage type for color channels in images. | | [getImage](#getImage) | Retrieves a buffered image, of type `DSImageData`. | - - - | [getPixelFormat](#getPixelFormat) | Retrieves the current pixel format used for images fetched from the camera. | | [getScanRegion](#getScanRegion) | Retrieves the current scan region set within the camera's view. | - | [hasNextImageToFetch](#hasNextImageToFetch) | Determines whether there are more images available to fetch. | | [isBufferEmpty](#isBufferEmpty) | Determines whether the buffer is currently empty. | - | [setColourChannelUsageType](#setColourChannelUsageType) | Sets the usage type for color channels in images. | - - - - | [setPixelFormat](#setPixelFormat) | Sets the pixel format for the images fetched from the camera. | | [setScanRegion](#setScanRegion) | Sets the scan region within the camera's view which limits the frame acquisition to a specific area of the video feed. | | [singleFrameMode](#singleFrameMode) | Controls the single-frame mode of the `CameraEnhancer`. | - - | [takePhoto](#takePhoto) | Initiates a sequence to capture a single frame/image, halting the video stream temporarily. |