ImageFilter

ImageFilter implements IImageFilter.

This class is used to configure Dynamsoft.DDV.Elements.Filter. Please refer to How to configure image filter.

The APIs for this class include:

constuctor()

Constuctor of ImageFilter instance.

Syntax

constuctor(image?: VImageData);

Parameters

image: The image which will be filtered. Please refer to VImageData.

defaultFilterType

Configure the default image filter type.

readonly defaultFilterType: string;

Return Value

The image filter type. Please refer to EnumImageFilterType.

querySupported()

Query supported image filter types and their label string, then create the completed Filter Element.

Syntax

querySupported(): ImageFilterItem[];

Return Value

The array of image filter method. Please refer to ImageFilterItem.

applyFilter()

Apply the specified image filter type to image(s).

Syntax

applyFilter(type: string): Promise<Blob>;
applyFilter(image: VImageData, type: string): Promise<Blob>;

Parameters

type: The image filter type. Please refer to EnumImageFilterType. image: The image which will be filtered. Please refer to VImageData.

Return Value

A Promise object which will be resolved with Blob of the filtered image.

destroy()

Destroy the instance.

Syntax

destroy(): void;