Skip to content
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
125 changes: 125 additions & 0 deletions programming/cplusplus/api-reference/localized-text-lines-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down Expand Up @@ -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.

112 changes: 112 additions & 0 deletions programming/dotnet/api-reference/localized-text-lines-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ class LocalizedTextLinesUnit : IntermediateResultUnit, IEnumerable<LocalizedText
| [`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.|
| [`GetAuxiliaryRegionElements`](#getauxiliaryregionelements) | Gets all auxiliary region elements. |
| [`SetAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets 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. |

### GetCount

Expand Down Expand Up @@ -152,3 +157,110 @@ Returns 0 if successful, otherwise returns a negative value.
**See Also**

[LocalizedTextLineElement]({{ site.dlr_dotnet_api }}localized-text-line-element.html)

### GetAuxiliaryRegionElements

Gets all auxiliary region elements.

```csharp
AuxiliaryRegionElement[] GetAuxiliaryRegionElements()
```

**Return value**

Returns an array of `AuxiliaryRegionElement` objects.

**See Also**

[AuxiliaryRegionElement]({{ site.dcvb_dotnet_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.

```csharp
int SetAuxiliaryRegionElement(int index, AuxiliaryRegionElement element, double[] matrixToOriginalImage)
```

**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 a negative value.

**See Also**

[AuxiliaryRegionElement]({{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html)

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

### AddAuxiliaryRegionElement

Adds a new auxiliary region element to this unit.

```csharp
int AddAuxiliaryRegionElement(AuxiliaryRegionElement element, double[] matrixToOriginalImage)
```

**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 a negative value.

**See Also**

[AuxiliaryRegionElement]({{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html)

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

### RemoveAuxiliaryRegionElement

Removes the auxiliary region element at the specified index.

```csharp
int RemoveAuxiliaryRegionElement(int index)
```

**Parameters**

`[in] 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.

### RemoveAllAuxiliaryRegionElements

Removes all auxiliary region elements from this unit.

```csharp
void RemoveAllAuxiliaryRegionElements()
```

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

110 changes: 107 additions & 3 deletions programming/java/api-reference/localized-text-lines-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ public class LocalizedTextLinesUnit extends IntermediateResultUnit
| [`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.|
| [`getAuxiliaryRegionElements`](#getauxiliaryregionelements) | Gets all auxiliary region elements. |
| [`setAuxiliaryRegionElement`](#setauxiliaryregionelement) | Sets 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. |

### getCount

Expand Down Expand Up @@ -148,12 +153,111 @@ public void setLocalizedTextLine(int index, LocalizedTextLineElement element, do

[LocalizedTextLineElement]({{ site.dlr_java_api }}localized-text-line-element.html)

`matrix_to_original_image` The matrix to original image.
### getAuxiliaryRegionElements

Gets all auxiliary region elements.

```java
public AuxiliaryRegionElement[] getAuxiliaryRegionElements()
```

**Return value**

Returns 0 if successful, otherwise returns a negative value.
Returns an array of `AuxiliaryRegionElement` objects.

**See Also**

[LocalizedTextLineElement]({{ site.dlr_java_api }}localized-text-line-element.html)
[AuxiliaryRegionElement]({{ site.dcvb_java_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.

```java
public void setAuxiliaryRegionElement(int index, AuxiliaryRegionElement element) throws LabelRecognizerException
public void setAuxiliaryRegionElement(int index, AuxiliaryRegionElement element, double[] matrixToOriginalImage) throws LabelRecognizerException
```

**Parameters**

`index` The zero-based index where the element should be set.

`element` The auxiliary region element to set.

`matrixToOriginalImage` The transformation matrix from the current image to the original image (optional).

**Exceptions**

[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)

**See Also**

[AuxiliaryRegionElement]({{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html)

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

### addAuxiliaryRegionElement

Adds a new auxiliary region element to this unit.

```java
public void addAuxiliaryRegionElement(AuxiliaryRegionElement element) throws LabelRecognizerException
public void addAuxiliaryRegionElement(AuxiliaryRegionElement element, double[] matrixToOriginalImage) throws LabelRecognizerException
```

**Parameters**

`element` The auxiliary region element to add.

`matrixToOriginalImage` The transformation matrix from the current image to the original image (optional).

**Exceptions**

[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)

**See Also**

[AuxiliaryRegionElement]({{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html)

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

### removeAuxiliaryRegionElement

Removes the auxiliary region element at the specified index.

```java
public void removeAuxiliaryRegionElement(int index) throws LabelRecognizerException
```

**Parameters**

`index` The zero-based index of the auxiliary region element to remove.

**Exceptions**

[`LabelRecognizerException`]({{ site.dlr_java_api }}label-recognizer-exception.html)

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

### removeAllAuxiliaryRegionElements

Removes all auxiliary region elements from this unit.

```java
public void removeAllAuxiliaryRegionElements()
```

**Remarks**

Introduced in Dynamsoft Capture Vision version 3.4.1000.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `BufferedCharacterItemSet` class represents a collection of buffered charact

## Definition

*Module:* dynamsoft_label_recognizer
*Module:* dlr

```python
class BufferedCharacterItemSet
Expand Down
Loading