Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Region represents a field region on a document image. A region is built from one or more rectangles.

​
Properties

NameTypeAccessDescription
PageIdstringRead-onlyIdentifier of the page that contains the region.
RectanglesRectangle[]Read-onlyThe rectangle set used to make the region.

​
Methods

​
AddRectangle

bool AddRectangle(number topLeftX, number topLeftY, number bottomRightX, number bottomRightY);
Adds a rectangle to the region using the four boundary coordinates. Returns true if the rectangle was added.

​
RemoveRectangle

bool RemoveRectangle(Rectangle rectangle);
Removes the specified rectangle from the region. Returns true if the rectangle was removed.

​
RemoveAll

void RemoveAll();
Removes all rectangles from the region.

​
RegionsCollection

A read-only collection of Region objects for a single field.

​
Methods

​
AddRegion

Region AddRegion(number pageIndex);
Adds a new region to the field on the specified page. Returns the created Region.

​
RemoveRegion

void RemoveRegion(Region region);
Removes the specified region.

​
RemoveAll

void RemoveAll();
Removes all regions from the current field.

Field

Provides access to the field value and its properties.

Rectangle

Top-left and bottom-right coordinates of a rectangular page area.

Object model

Full JavaScript object reference for Custom activity scripts.