region

The region object defines a sub-section of the input data. Its properties vary according to the type of data.

This object is available when triggering document boundaries On script; see Setting boundaries using JavaScript.

Methods

The following table describes the methods of the region object. This object is available in Boundaries scripts, with all file types.

Method Description Return Type
found

Field that contains a boolean value indicating if the last call to boundaries.find() was successful.
Since the find() method always returns a region, regardless of search results, it is necessary to examine the value of found to determine the actual result of the operation.

Boolean

range

Read-only object containing the physical coordinates of the region.

Physical location of the region: x1 (left), y1 (top), x2 (right), y2 (bottom), expressed in characters for a text file or in millimeters for a PDF file.
For a CSV file, it is the name of the column that defines the region.

createRegion()

Creates a region by setting the physical coordinates of the region object.

A region that has the specified coordinates.

 
  • Last Topic Update: 27, June, 2017 06:10 AM
  • Last Published: 23, May, 2019 01:55 PM