From b33f2fb458721a586135e67fbd39ff6c71a78a0e Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 7 Nov 2024 15:39:46 +0800 Subject: [PATCH] update to internal commit dbe236cb --- _config.yml | 5 +- .../javascript/api-reference/drawinglayer.md | 48 ++++++++++++++++++- programming/javascript/index.md | 4 +- programming/javascript/release-note/index.md | 4 +- programming/javascript/user-guide/index.md | 5 +- 5 files changed, 55 insertions(+), 11 deletions(-) diff --git a/_config.yml b/_config.yml index 62021207..4263d85f 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,4 @@ repositoryUrl: https://github.com/dynamsoft-docs/camera-enhancer-docs-js/blob/main -repositoryUrlJS: https://github.com/dynamsoft-docs/camera-enhancer-docs-js/blob/main repository: dynamsoft-docs/camera-enhancer-docs-js docFullPath: https://www.dynamsoft.com/camera-enhancer/docs/web/ firstLevelUrl: /camera-enhancer/docs/web @@ -69,7 +68,7 @@ defaults: - scope: path: "programming/javascript" values: - category: "js-repo" - edition: "js" + docRootName: "Camera Enhancer JavaScript Edition" + docHomePage: "/camera-enhancer/docs/web/programming/javascript/" url: "https://www.dynamsoft.com" # sitemap root diff --git a/programming/javascript/api-reference/drawinglayer.md b/programming/javascript/api-reference/drawinglayer.md index d47b0b29..9366cbec 100644 --- a/programming/javascript/api-reference/drawinglayer.md +++ b/programming/javascript/api-reference/drawinglayer.md @@ -21,10 +21,12 @@ permalink: /programming/javascript/api-reference/drawinglayer.html | [removeDrawingItems()](#removedrawingitems) | Removes specified `DrawingItem` objects from the layer. | | [setDrawingItems()](#setdrawingitems) | Sets the layer's `DrawingItem` objects, replacing any existing items. | | [getDrawingItems()](#getdrawingitems) | Retrieves `DrawingItem` objects from the layer, optionally filtered by a custom function. | -| [hasDrawingItem()](#hasDrawingItem) | Checks if a specific `DrawingItem` exists within the layer. | +| [hasDrawingItem()](#hasdrawingitem) | Checks if a specific `DrawingItem` exists within the layer. | | [clearDrawingItems()](#cleardrawingitems) | Clears all `DrawingItem` objects from the layer. | | [onSelectionChanged()](#onselectionchanged) | Event triggered whenever there is a change in which `DrawingItem` objects are selected or deselected. | | [renderAll()](#renderall) | Forces a re-render of all `DrawingItem` objects on the layer. | +| [setMode()](#setmode) | Changes the mode of the layer. | +| [getMode()](#getmode) | Returns the current mode. | **Special Notice** @@ -525,3 +527,47 @@ drawingLayer.onSelectionChanged = (selected, deselected) => { //Do something based on the selection change. } ``` + +## setMode + +Changes the mode of the layer. + +```typescript +setMode(newMode: string): void; +``` + +**Parameters** + +`newMode`: specifies the new mode. At present, the allowed values are "editor" and "viewer" and the default is "viewer". + +> Compared with the "viewer" mode, the "editor" mode shows the "corners" and a "rotate control point" for a selected DrawingItem, which, when dragged, modify the original shape in different ways. + +**Code Snippet** + +```javascript +let cameraView = cameraEnhancer.getCameraView(); +//Gets the `DrawingLayer` used by Dynamsoft Label Recognizer. +let drawingLayer = cameraView.getDrawingLayer(3); +drawingLayer.setMode("editor"); +``` + +## getMode + +Returns the current mode. + +```typescript +getMode(): "editor" | "viewer"; +``` + +**Return value** + +The mode of current `DrawingLayer` . + +**Code Snippet** + +```javascript +let cameraView = cameraEnhancer.getCameraView(); +//Gets the `DrawingLayer` used by Dynamsoft Label Recognizer. +let drawingLayer = cameraView.getDrawingLayer(3); +let mode = drawingLayer.getMode(); +``` \ No newline at end of file diff --git a/programming/javascript/index.md b/programming/javascript/index.md index 0d7a8e05..dbe160a6 100644 --- a/programming/javascript/index.md +++ b/programming/javascript/index.md @@ -22,5 +22,5 @@ permalink: /programming/javascript/index.html ## Release Notes * [Version 4.x](release-note/release-notes-4.x.html) -* [Version 3.x](release-note/release-notes-3.x.html) -* [Version 2.x](release-note/release-notes-2.x.html) + diff --git a/programming/javascript/release-note/index.md b/programming/javascript/release-note/index.md index 650e33db..7eb20939 100644 --- a/programming/javascript/release-note/index.md +++ b/programming/javascript/release-note/index.md @@ -15,7 +15,7 @@ permalink: /programming/javascript/release-note/index.html * [4.0.2 (04/01/2024)](release-notes-4.x.html#402-04012024) * [4.0.1 (01/11/2024)](release-notes-4.x.html#401-01112024) * [4.0.0 (08/24/2023)](release-notes-4.x.html#400-08242023) -* [3.3.10 (02/05/2024)](release-notes-3.x.html#3310-02052024) + diff --git a/programming/javascript/user-guide/index.md b/programming/javascript/user-guide/index.md index a3844571..a461c63f 100644 --- a/programming/javascript/user-guide/index.md +++ b/programming/javascript/user-guide/index.md @@ -35,7 +35,6 @@ In this guide, you will learn step by step on how to integrate the Dynamsoft Cam - [Why can't I use my camera?](#why-cant-i-use-my-camera) - [API Documentation](#api-documentation) - [System Requirements](#system-requirements) - - [Release Notes](#release-notes) - [Next Steps](#next-steps) ## Adding the SDK @@ -362,9 +361,9 @@ The following table is a list of supported browsers based on the above requireme Apart from the browsers, the operating systems may impose some limitations of their own that could restrict the use of the SDK. Browser compatibility ultimately depends on whether the browser on that particular operating system supports the features listed above. -## Release Notes + ## Next Steps