| FoxitPDFSDKforWeb v11.1.0 Archives Foxit PDF SDK for Web

Public Attributes | List of all members
OverlayComparisonOptions Interface Reference
PDFViewCtrl » overlayComparison

Options for OverlayComparisonService.compareImageData. More...

## Public Attributes
Partial< CombinePixelsOptions > | combinePixelsOptions
| Options to handle pixel-diff and combine-pixels algorithms, All properties of CombinePixelsOptions interface are optional. More...
ImageData | sourceBitmap
| The source image bitmap data， which can be obtained via PDFPage.render method. More...
ImageData | targetBitmap
| The target image bitmap data， which can be obtained via PDFPage.render method. More...
Partial< OverlayComparisonTransformationOptions > | transformation
| Transformation options of source image bitmap data. More...

## Detailed Description

Options for OverlayComparisonService.compareImageData.

See also
  OverlayComparisonService.compareImageData

Since
  9.0.0

## Member Data Documentation

## ◆ combinePixelsOptions

Partial<CombinePixelsOptions> OverlayComparisonOptions::combinePixelsOptions

Options to handle pixel-diff and combine-pixels algorithms, All properties of CombinePixelsOptions interface are optional.

Note
  This property is optional

Since
  9.0.0

## ◆ sourceBitmap

ImageData OverlayComparisonOptions::sourceBitmap

The source image bitmap data， which can be obtained via PDFPage.render method.

Since
  9.0.0

## ◆ targetBitmap

ImageData OverlayComparisonOptions::targetBitmap

The target image bitmap data， which can be obtained via PDFPage.render method.

Since
  9.0.0

## ◆ transformation

Partial<OverlayComparisonTransformationOptions> OverlayComparisonOptions::transformation

Transformation options of source image bitmap data.

Note
  This property is optional

Since
  9.0.0

@2026 Foxit Software Incorporated. All rights reserved.