Class CropItem

Single crop detection returned by the crop product.

Index

Constructors

Properties

extractionResponse? location objectType

Methods

extractFromInputSource toString

Constructors

constructor

new CropItem(serverResponse: StringDict): CropItem
Parameters
- serverResponse: StringDict
Returns CropItem
- Defined in src/v2/product/crop/cropItem.ts:23

Properties

`Optional`extractionResponse

extractionResponse?: product.ExtractionResponse

The extraction response associated with the crop.

location

location: FieldLocation

Location that includes cropping coordinates for the detected object, within the source document.

objectType

objectType: string

Type or classification of the detected object.

Methods

extractFromInputSource

extractFromInputSource(
inputSource: LocalInputSource,
quality?: number,
): Promise<ExtractedImage>
Extracts a single crop from an input.
Parameters
- inputSource: LocalInputSource
  The input file to extract from.
- quality: number = 1
  Optional quality parameter for image extraction, default is undefined (full quality).
Returns Promise<ExtractedImage>
- Defined in src/v2/product/crop/cropItem.ts:41

toString

toString(): string
Returns a readable crop item summary.

Returns string
- Defined in src/v2/product/crop/cropItem.ts:32