DSAuxiliaryRegionElement

The DSAuxiliaryRegionElement class extends the DSRegionObjectElement class and represents an auxiliary region element that contains additional region information detected during processing (e.g., portrait zones, specific document areas).

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

Objective-C
Swift

@interface DSAuxiliaryRegionElement : DSRegionObjectElement

class AuxiliaryRegionElement : RegionObjectElement

Methods

Method	Description
`getName`	Gets the name of this auxiliary region.
`getConfidence`	Gets the confidence level of this auxiliary region detection.
`setName`	Sets the name/type of this auxiliary region.
`setLocation`	Sets the location of this auxiliary region.
`setConfidence`	Sets the confidence level of this auxiliary region detection.

Inherited Methods

The following methods are inherited from class DSRegionObjectElement.

Method	Description
`getLocation`	Gets the location of the region object, represented as a `Quadrilateral`.
`getReferencedElement`	Gets the referenced element that supports the capturing of this element.
`getRegionObjectElementType`	Gets the type of the region object element, defined by the enumeration `DSRegionObjectElementType`.
`getImageData`	Gets the original image that produce this element.

getName

Gets the name of this auxiliary region.

Objective-C
Swift

```
- (NSString *)getName;
```
```
func getName() -> String
```

Return Value

A string representing the region name (e.g., “PortraitZone”, “SignatureArea”).

getConfidence

Gets the confidence level of this auxiliary region detection.

Objective-C
Swift

```
- (NSInteger)getConfidence;
```
```
func getConfidence() -> Int
```

Return Value

The confidence value, typically in the range [0, 100].

setName

Sets the name/type of this auxiliary region.

Objective-C
Swift

```
- (void)setName:(NSString *)name;
```
```
func setName(_ name: String)
```

Parameters

name: The region name to set (e.g., “PortraitZone”, “SignatureArea”).

setLocation

Sets the location of this auxiliary region.

Objective-C
Swift

- (NSInteger)setLocation:(DSQuadrilateral *)location;

func setLocation(_ location: Quadrilateral?) -> Int

Parameters

location: A DSQuadrilateral defining the region boundaries.

Return Value

Returns 0 if successful, otherwise returns an error code.

setConfidence

Sets the confidence level of this auxiliary region detection.

Objective-C
Swift

- (void)setConfidence:(NSInteger)confidence;

```
func setConfidence(_ confidence: Int)
```

Parameters

confidence: The confidence value to set, typically in the range [0, 100].