From 2a088ac69f3c2fd8efc67d1cf8595a7c8f1b0fc2 Mon Sep 17 00:00:00 2001 From: Mark Date: Wed, 4 Feb 2026 14:18:05 +0800 Subject: [PATCH] fix module name and updates for v3.4.1000 --- .../localized-text-lines-unit.md | 125 ++++++++++++++++ .../localized-text-lines-unit.md | 112 +++++++++++++++ .../localized-text-lines-unit.md | 110 +++++++++++++- .../buffered-character-item-set.md | 2 +- .../api-reference/buffered-character-item.md | 2 +- .../python/api-reference/character-cluster.md | 2 +- .../python/api-reference/character-result.md | 2 +- .../api-reference/label-recognizer-module.md | 2 +- .../localized-text-line-element.md | 2 +- .../localized-text-lines-unit.md | 135 +++++++++++++++++- .../python/api-reference/raw-text-line.md | 2 +- .../api-reference/raw-text-lines-unit.md | 2 +- .../recognized-text-line-element.md | 2 +- .../recognized-text-lines-result.md | 2 +- .../recognized-text-lines-unit.md | 2 +- .../api-reference/text-line-result-item.md | 2 +- 16 files changed, 490 insertions(+), 16 deletions(-) diff --git a/programming/cplusplus/api-reference/localized-text-lines-unit.md b/programming/cplusplus/api-reference/localized-text-lines-unit.md index 5bbcae2..e5ece84 100644 --- a/programming/cplusplus/api-reference/localized-text-lines-unit.md +++ b/programming/cplusplus/api-reference/localized-text-lines-unit.md @@ -36,6 +36,12 @@ class CLocalizedTextLinesUnit : public CIntermediateResultUnit | [`RemoveLocalizedTextLine`](#removelocalizedtextline) | Removes the localized text line at the specified index.| | [`AddLocalizedTextLine`](#addlocalizedtextline) | Adds a localized text line.| | [`SetLocalizedTextLine`](#setlocalizedtextline) | Sets the localized text line at the specified index.| +| [`GetAuxiliaryRegionElementsCount`](#getauxiliaryregionelementscount) | Gets the count of auxiliary region elements in this unit.| +| [`GetAuxiliaryRegionElement`](#getauxiliaryregionelement) | Gets the auxiliary region element at the specified index.| +| [`SetAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets or replaces the auxiliary region element at the specified index.| +| [`AddAuxiliaryRegionElement`](#addauxiliaryregionelement) | Adds a new auxiliary region element to this unit.| +| [`RemoveAuxiliaryRegionElement`](#removeauxiliaryregionelement) | Removes the auxiliary region element at the specified index.| +| [`RemoveAllAuxiliaryRegionElements`](#removeallauxiliaryregionelements) | Removes all auxiliary region elements from this unit.| | **Methods Inherited from [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html):** | | | [`GetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Gets the hash ID of the unit.| | [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Gets the hash ID of the original image. | @@ -155,3 +161,122 @@ virtual int SetLocalizedTextLine(int index, const CLocalizedTextLineElement* ele **Return value** Returns 0 if successful, otherwise returns a negative value. + +### GetAuxiliaryRegionElementsCount + +Gets the count of auxiliary region elements in this unit. + +```cpp +virtual int GetAuxiliaryRegionElementsCount() const = 0; +``` + +**Return value** + +Returns the number of auxiliary region elements. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### GetAuxiliaryRegionElement + +Gets the auxiliary region element at the specified index. + +```cpp +virtual const CAuxiliaryRegionElement* GetAuxiliaryRegionElement(int index) const = 0; +``` + +**Parameters** + +`[in] index` The zero-based index of the auxiliary region element to retrieve. + +**Return value** + +Returns a pointer to the `CAuxiliaryRegionElement` object, or NULL if the index is out of range. + +**See Also** + +[CAuxiliaryRegionElement]({{ site.dcvb_cpp_api }}core/intermediate-results/auxiliary-region-element.html) + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### SetAuxiliaryRegionElement + +Sets or replaces the auxiliary region element at the specified index. + +```cpp +virtual int SetAuxiliaryRegionElement(int index, const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0; +``` + +**Parameters** + +`[in] index` The zero-based index where the element should be set. + +`[in] element` The auxiliary region element to set. + +`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image. + +**Return value** + +Returns 0 if successful, otherwise returns an error code. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### AddAuxiliaryRegionElement + +Adds a new auxiliary region element to this unit. + +```cpp +virtual int AddAuxiliaryRegionElement(const CAuxiliaryRegionElement* element, const double matrixToOriginalImage[9] = IDENTITY_MATRIX) = 0; +``` + +**Parameters** + +`[in] element` The auxiliary region element to add. + +`[in] matrixToOriginalImage` The transformation matrix from the current image to the original image. + +**Return value** + +Returns 0 if successful, otherwise returns an error code. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### RemoveAuxiliaryRegionElement + +Removes the auxiliary region element at the specified index. + +```cpp +virtual int RemoveAuxiliaryRegionElement(int index) = 0; +``` + +**Parameters** + +`[in] index` The zero-based index of the auxiliary region element to remove. + +**Return value** + +Returns 0 if successful, otherwise returns an error code. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### RemoveAllAuxiliaryRegionElements + +Removes all auxiliary region elements from this unit. + +```cpp +virtual void RemoveAllAuxiliaryRegionElements() = 0; +``` + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + diff --git a/programming/dotnet/api-reference/localized-text-lines-unit.md b/programming/dotnet/api-reference/localized-text-lines-unit.md index 338cccf..54c879f 100644 --- a/programming/dotnet/api-reference/localized-text-lines-unit.md +++ b/programming/dotnet/api-reference/localized-text-lines-unit.md @@ -34,6 +34,11 @@ class LocalizedTextLinesUnit : IntermediateResultUnit, IEnumerable int: +``` + +**Return value** + +Returns the number of auxiliary region elements. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### get_auxiliary_region_element + +Gets the auxiliary region element at the specified index. + +```python +def get_auxiliary_region_element(self, index: int) -> AuxiliaryRegionElement: +``` + +**Parameters** + +`index` The zero-based index of the auxiliary region element to retrieve. + +**Return value** + +Returns an `AuxiliaryRegionElement` object, or `None` if the index is out of range. + +**See Also** + +[AuxiliaryRegionElement]({{ site.dcvb_python_api }}core/intermediate-results/auxiliary-region-element.html) + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### set_auxiliary_region_element + +Sets or replaces the auxiliary region element at the specified index. + +```python +def set_auxiliary_region_element(self, index: int, element: AuxiliaryRegionElement, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int: +``` + +**Parameters** + +`index` The zero-based index where the element should be set. + +`element` The auxiliary region element to set. + +`matrix_to_original_image` The transformation matrix from the current image to the original image. + +**Return value** + +Returns 0 if successful, otherwise returns a negative value. + +**See Also** + +[AuxiliaryRegionElement]({{ site.dcvb_python_api }}core/intermediate-results/auxiliary-region-element.html) + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### add_auxiliary_region_element + +Adds a new auxiliary region element to this unit. + +```python +def add_auxiliary_region_element(self, element: AuxiliaryRegionElement, matrix_to_original_image: List[float] = IDENTITY_MATRIX) -> int: +``` + +**Parameters** + +`element` The auxiliary region element to add. + +`matrix_to_original_image` The transformation matrix from the current image to the original image. + +**Return value** + +Returns 0 if successful, otherwise returns a negative value. + +**See Also** + +[AuxiliaryRegionElement]({{ site.dcvb_python_api }}core/intermediate-results/auxiliary-region-element.html) + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### remove_auxiliary_region_element + +Removes the auxiliary region element at the specified index. + +```python +def remove_auxiliary_region_element(self, index: int) -> int: +``` + +**Parameters** + +`index` The zero-based index of the auxiliary region element to remove. + +**Return value** + +Returns 0 if successful, otherwise returns a negative value. + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + +### remove_all_auxiliary_region_elements + +Removes all auxiliary region elements from this unit. + +```python +def remove_all_auxiliary_region_elements(self) -> None: +``` + +**Remarks** + +Introduced in Dynamsoft Capture Vision version 3.4.1000. + diff --git a/programming/python/api-reference/raw-text-line.md b/programming/python/api-reference/raw-text-line.md index a17c681..9c43da4 100644 --- a/programming/python/api-reference/raw-text-line.md +++ b/programming/python/api-reference/raw-text-line.md @@ -15,7 +15,7 @@ The class `RawTextLine` represents a recognized raw text line in an image. It ca ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr ```python class RawTextLine diff --git a/programming/python/api-reference/raw-text-lines-unit.md b/programming/python/api-reference/raw-text-lines-unit.md index 2ae6516..a5399f4 100644 --- a/programming/python/api-reference/raw-text-lines-unit.md +++ b/programming/python/api-reference/raw-text-lines-unit.md @@ -11,7 +11,7 @@ The `RawTextLinesUnit` class represents an intermediate result unit containing r ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr ```python class RawTextLinesUnit(IntermediateResultUnit) diff --git a/programming/python/api-reference/recognized-text-line-element.md b/programming/python/api-reference/recognized-text-line-element.md index 18149d8..57b51c8 100644 --- a/programming/python/api-reference/recognized-text-line-element.md +++ b/programming/python/api-reference/recognized-text-line-element.md @@ -11,7 +11,7 @@ The `RecognizedTextLineElement` class represents a line of recognized text in an ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr ```python class RecognizedTextLineElement(RegionObjectElement) diff --git a/programming/python/api-reference/recognized-text-lines-result.md b/programming/python/api-reference/recognized-text-lines-result.md index 75931f8..4fc2401 100644 --- a/programming/python/api-reference/recognized-text-lines-result.md +++ b/programming/python/api-reference/recognized-text-lines-result.md @@ -11,7 +11,7 @@ The `RecognizedTextLinesResult` class represents the result of a text recognitio ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr ```python class RecognizedTextLinesResult diff --git a/programming/python/api-reference/recognized-text-lines-unit.md b/programming/python/api-reference/recognized-text-lines-unit.md index 39cd490..704056a 100644 --- a/programming/python/api-reference/recognized-text-lines-unit.md +++ b/programming/python/api-reference/recognized-text-lines-unit.md @@ -11,7 +11,7 @@ The `RecognizedTextLinesUnit` class represents an intermediate result unit conta ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr ```python class RecognizedTextLinesUnit(IntermediateResultUnit) diff --git a/programming/python/api-reference/text-line-result-item.md b/programming/python/api-reference/text-line-result-item.md index c5cf143..685c852 100644 --- a/programming/python/api-reference/text-line-result-item.md +++ b/programming/python/api-reference/text-line-result-item.md @@ -11,7 +11,7 @@ The `TextLineResultItem` class represents a text line result item recognized by ## Definition -*Module:* dynamsoft_label_recognizer +*Module:* dlr *Inheritance:* [CapturedResultItem]({{ site.dcvb_python_api }}core/basic-classes/captured-result-item.html) -> TextLineResultItem