new HandwritingICROptions()
Options for PDFNet.HandwritingICRModule.HandwritingICROptions
Methods
-
addIgnoreZonesForPage(regions, page_num)
-
Adds an Ignore Zone to the IgnoreZonesForPage array. Optional list of page areas to be excluded from analysis. Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, the specified areas will not be analyzed. If neither this nor InclusionZonesForPage is set, the entire page will be analyzed.
Parameters:
Name Type Description regionsArray.<PDFNet.Rect> List of page areas to be excluded from analysis. page_numnumber The page number (1-indexed) to which the regions are applied. Returns:
this object, for call chaining -
addInclusionZonesForPage(regions, page_num)
-
Adds an Inclusion Zone to the InclusionZonesForPage array. Optional list of page areas to be included in analysis (to the exclusion of all other areas). Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, only the areas specified will be analyzed. If neither this nor IgnoreZonesForPage is set, the entire page will be analyzed.
Parameters:
Name Type Description regionsArray.<PDFNet.Rect> List of page areas to be included in analysis. page_numnumber The page number (1-indexed) to which the regions are applied. Returns:
this object, for call chaining -
getPages()
-
Gets the value Pages from the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.
Returns:
The current value for Pages.- Type
- string
-
setPages(value)
-
Sets the value for Pages in the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.
Parameters:
Name Type Description valuestring The new value for Pages Returns:
This object, for call chaining.