overlayComparison

This module contains the API related to the overlay comparison function. More...

Classes
interface	BlendColorResolverOptions
	Options of BlendColorResolver callback. More...
interface	CombinePixelsOptions
	Options to handle pixel-diff and combine-pixels algorithms. More...
interface	ImageData
	Image data used for overlay comparison, which can be obtained through PDFPage.render or CanvasRenderingContext2D.getImageData or CanvasRenderingContext2D.createImageData. More...
interface	OverlayComparisonOptions
	Options for OverlayComparisonService.compareImageData. More...
class	OverlayComparisonOptionsService
class	OverlayComparisonService
	Overlay comparison function entry, this instance must be obtained through PDFViewer.getOverlayComparisonService method. More...
interface	OverlayComparisonTransformationOptions
	Transformation parameters of the target image data. More...

Enumerations
enum	DiffColor {   RED = 0xFF0000, GREEN = 0x00FF00, BLUE = 0x0000FF, MAGENTA = 0xFF00FF,   YELLOW = 0xFFFF00, CYAN = 0x00FFFF }
	Diff color enumeration of source and target documents for overlay comparisons. More...

Variables
type	BlendColorResolver = (options: BlendColorResolverOptions) => number|Color
	Callback function for calculating pixel point blending colors. More...
type	CombinePixelsOptionsKey = keyof CombinePixelsOptions
	Union type of CombinePixelsOptions property name. More...
type	OnOptionChangeCallback = (newValue:CombinePixelsOptions[CombinePixelsOptionsKey])=>void
	A callback to handle the changes of CombinePixelsOptions. More...

Detailed Description

This module contains the API related to the overlay comparison function.

See also

OverlayComparisonService.compareImageData The critical API.

Since

9.0.0

Enumeration Type Documentation

DiffColor

enum DiffColor

Diff color enumeration of source and target documents for overlay comparisons.

Since

9.0.0

See also

CombinePixelsOptions

Enumerator
RED	0xFF0000
GREEN	0x00FF00
BLUE	0x0000FF
MAGENTA	0xFF00FF
YELLOW	0xFFFF00
CYAN	0x00FFFF

Variable Documentation

BlendColorResolver

type BlendColorResolver = (options: BlendColorResolverOptions) => number|Color

Callback function for calculating pixel point blending colors.

Parameters

options

BlendColorResolverOptions -

Returns

number|Color - The calculated color, either as an ARGB number, or as a Color instance.

Since

9.0.0

CombinePixelsOptionsKey

type CombinePixelsOptionsKey = keyof CombinePixelsOptions

Union type of CombinePixelsOptions property name.

Since

9.0.0

See also

OverlayComparisonOptionsService.onChange

OnOptionChangeCallback

type OnOptionChangeCallback = (newValue:CombinePixelsOptions[CombinePixelsOptionsKey])=>void

A callback to handle the changes of CombinePixelsOptions.

Parameters

newValue

CombinePixelsOptions[CombinePixelsOptionsKey] - The new option value that has changed.

See also

OverlayComparisonOptionsService.onChange

Since

9.0.0