TextArea Object

Parameter Name	Description
`TextArea.Name`	The name of the TextArea object.
`TextArea.FirstPoint`	The first point of the text area, which is usually the top-left corner.
`TextArea.SecondPoint`	The second point of the text area, which is usually the top-right corner.
`TextArea.ThirdPoint`	The third point of the text area, which is usually the bottom-right corner.
`TextArea.FourthPoint`	The fourth point of the text area, which is usually the bottom-left corner.
`TextArea.CharacterModelName`	Sets the name of a white list of recognizable characters.
`TextArea.GrayscaleTransformationModes`	Sets the mode and priority for the grayscale image conversion.
`TextArea.LetterHeightRange`	Sets the range of letter height (in pixel or a percentage value relative to the height of the text area).
`TextArea.LinesCount`	Sets the text lines count of the text area.
`TextArea.LineSpecificationNameArray`	Specifies the name array of the LineSpecification objects which is relative to current TextArea.
`TextArea.LineStringRegExPattern`	Specifies the regular expression pattern of each line string text in current text area to recognize.
`TextArea.TextAreaNameArray`	Specifies the name array of the TextAreas which is relative to current text area.
`TextArea.TextRegExPattern`	Specifies the regular expression pattern of the text to recognize.

Name

The name of the TextArea object.

Remarks
It must be a unique name.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	Name	string	It must be a mandatory setting value.

Json Parameter Example

{
    "Name":"TextArea1"
}

FirstPoint

The first point of the text area, which is usually the top-left corner.

Remarks
View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
The ordinate origin is the top-left corner of the ReferenceRegion.
The value of x is a percentage value relative to the width of the ReferenceRegion.
The value of y is a percentage value relative to the height of the ReferenceRegion.
The allowed values for x/y: [-10000, 10000]

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	FirstPoint	int array	[0, 0]

Json Parameter Example

{
    "FirstPoint":[0, 10]
}

SecondPoint

The second point of the text area, which is usually the top-right corner.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	SecondPoint	int array	[100, 0]

Json Parameter Example

{
    "SecondPoint":[10, 10]
}

ThirdPoint

The third point of the text area, which is usually the bottom-right corner.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	ThirdPoint	int array	[100, 100]

Json Parameter Example

{
    "ThirdPoint":[0, 10]
}

FourthPoint

The fourth point of the text area, which is usually the bottom-left corner.

-Remarks

View the texts in 0 degree, the first point is the top-left point of the area defined by TextArea, and the other three points are in a clockwise direction.
The ordinate origin is the top-left corner of the ReferenceRegion.
The value of x is a percentage value relative to the width of the ReferenceRegion.
The value of y is a percentage value relative to the height of the ReferenceRegion.
The allowed values for x/y: [-10000, 10000]

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	FourthPoint	int array	[0, 100]

Json Parameter Example

{
    "FourthPoint":[10, 20]
}

CharacterModelName

Sets the name of a white list of recognizable characters.

Remarks
If you set a character model, the result will only contain characters within the model.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	CharacterModelName	string	””

Json Parameter Example

{
    "CharacterModelName":"CharacterModel_Name1"
}

LinesCount

Sets the text lines count of the text area.

Remarks
0: line count is not certain.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Value Range	Default Value
TextArea	LinesCount	int	[0, 200]	0

Json Parameter Example

{
    "LinesCount":1
}

LineSpecificationNameArray

Specifies the name array of the LineSpecification objects which is relative to current text area.

Remarks
An array item is a name of any available LineSpecification.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	LineSpecificationNameArray	string Array	`null`

Json Parameter Example

{
    "LineSpecificationNameArray":[
        "LineSpecification1",
        "LineSpecification2"
    ]
}

GrayscaleTransformationModes

Please check LabelRecognitionParameter.GrayscaleTransformationModes for reference.

LetterHeightRange

Sets the range of letter height (in pixel or a percentage value relative to the height of the text area).

Remarks

Format: [MinHeight, MaxHeight, ByPercentage]
The allowed values for MinHeight/MaxHeight:
ByPercentage=0, [1, 0x7fffffff]
ByPercentage=1, [1, 100]
The allowed values for ByPercentage: [0,1]

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	LetterHeightRange	int array	[1,100,1]

Json Parameter Example

{
    "LetterHeightRange":[40,60,1]
}

TextRegExPattern

Specifies the regular expression pattern of the text to recognize.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	TextRegExPattern	string	””

Json Parameter Example

{
    "TextRegExPattern":""
}

LineStringRegExPattern

Specifies the regular expression pattern of each line string text in current text area to recognize.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	LineStringRegExPattern	string	””

Json Parameter Example

{
    "LineStringRegExPattern":""
}

TextAreaNameArray

Specifies the name array of the TextArea objects which is relative to current text area.

Remarks
An array item is a name of any available TextArea.

As Json Parameter

Json Object	Json Parameter Name	Value Type	Default Value
TextArea	TextAreaNameArray	string Array	`null`

Json Parameter Example

{
    "TextAreaNameArray":[
        "TextArea1",
        "TextArea2"
    ]
}