PageToolsPluginAPI

Interface: PageToolsPluginAPI

Defines Page Tools Plugin API.

Properties

id

id: PluginType;

Unique plug-in identifier.

Inherited from

ImageViewerPluginAPI.id

paintLayer

readonly paintLayer: ImageLayer;

Gets the paint layer containing the HTML canvas for drawing the image.

Inherited from

ImageViewerPluginAPI.paintLayer

isReady

readonly isReady: boolean;

Returns true if the image is loaded into the viewer and the image format is supported by the Image Filters plugin.

Inherited from

ImageViewerPluginAPI.isReady

naturalSize

readonly naturalSize: Size;

Natural image size.

Inherited from

ImageViewerPluginAPI.naturalSize

options

options: PageToolsPluginOptions;

Plugin options

totalRotation

readonly totalRotation: number;

Gets current rotation in degrees.

Methods

initialize()

initialize(viewer): void;

The method is called when the GcImageViewer component is initialized.

Parameters

viewer

ImageViewerAPI

Returns

void

Inherited from

ImageViewerPluginAPI.initialize

isImageFormatSupported()

isImageFormatSupported(imageFormat, allowUnknown?): boolean;

Determines whether the specified image format is supported for modifications.

Parameters

imageFormat

The image format to check, either as an enum value or string.

string | ImageFormatCode

allowUnknown?

boolean

If true, allows unknown formats (ImageFormatCode.Default) to be considered supported.

Returns

boolean

True if the format is supported for modifications, false otherwise.

Remarks

The following formats are explicitly not supported:

TIFF (ImageFormatCode.TIFF)
SVG (ImageFormatCode.SVG)
ICO (ImageFormatCode.ICO)
GIF (ImageFormatCode.GIF)

Examples

// Check if PNG is supported
const supported = isImageFormatSupported(ImageFormatCode.PNG);

// Check if an unknown format is supported (returns false by default)
const supported = isImageFormatSupported('custom-format');

// Check if an unknown format is supported (returns true when allowUnknown is true)
const supported = isImageFormatSupported('custom-format', true);

Inherited from

ImageViewerPluginAPI.isImageFormatSupported

dispose()

dispose(): void;

Cleans up resources and disposes the plugin.

Returns

void

Inherited from

ImageViewerPluginAPI.dispose

removePaintLayer()

removePaintLayer(): void;

Removes and disposes the active paint layer. If no paint layer exists, this method does nothing.

Returns

void

Inherited from

ImageViewerPluginAPI.removePaintLayer

rotate()

rotate(angle): Promise<boolean>;

Rotate image.

Parameters

angle

number

Angle to rotate an image.

Returns

Promise<boolean>

crop()

crop(
   x, 
   y, 
   width, 
   height): Promise<boolean>;

Crop image.

Parameters

x

number

Leftmost point of a new image rectangle

y

number

Topmost point of a new image rectangle

width

number

Width a new image rectangle

height

number

Height a new image rectangle

Returns

Promise<boolean>

Whether transformation was applied successfully or not.

resize()

resize(
   width, 
   height, 
   keepAspectRatio): Promise<boolean>;

Resize image.

Parameters

width

number

New image width.

height

number

New image height

keepAspectRatio

boolean

Explicitly defines a need of keeping an original image aspect ratio. Defaults to true.

Returns

Promise<boolean>

flip()

flip(horizontal, vertical): Promise<boolean>;

Flip image.

Parameters

horizontal

boolean

Flip horizontally. True by default.

vertical

boolean

Returns

Promise<boolean>

Whether transformation was applied successfully or not.

flipHorizontal()

flipHorizontal(): Promise<boolean>;

Flip image horizontally.

Returns

Promise<boolean>

Whether transformation was applied successfully or not.

flipVertical()

flipVertical(): Promise<boolean>;

Flip image vertically.

Returns

Promise<boolean>

Whether transformation was applied successfully or not.