Class PageToolsPlugin

PageToolsPlugin class. Adds the "Page tools" button.

Example

<script src="gcimageviewer.js"></script></head>
<script src="plugins/pageTools.js"></script>
<script>
  var viewer = new DsImageViewer("#root");
  viewer.addPlugin(new PageToolsPlugin());
</script>

Param

Hierarchy

  • ImageViewerPluginBase
    • PageToolsPlugin

Accessors

paintLayer isReady naturalSize totalRotation

Methods

removePaintLayer rotate isImageFormatSupported crop resize flip flipHorizontal flipVertical

Properties

id options

Constructors

constructor

Accessors

paintLayer

  • get paintLayer(): IImageLayer

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

    Returns IImageLayer

isReady

  • get isReady(): boolean

  • Returns true if the image is loaded into the viewer and the image format is supported by the Page Tools plugin.

    Returns boolean

naturalSize

  • get naturalSize(): { width: number; height: number }

  • Natural image size.

    Returns { width: number; height: number }

    • width: number
    • height: number

totalRotation

  • get totalRotation(): number

  • Gets current rotation in degrees.

    Returns number

Methods

removePaintLayer

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

    Returns

    Returns void

rotate

  • Rotate image.

    Parameters

    • rotation: number

    Returns Promise<boolean>

isImageFormatSupported

  • Checks if the image format specified by the imageFormat parameter is supported.

    Parameters

    Returns boolean

crop

  • Crop image.

    Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns Promise<boolean>

resize

  • Resize image.

    Parameters

    • width: number
    • height: number
    • keepAspectRatio: boolean = true

    Returns Promise<boolean>

flip

  • Flip image.

    Parameters

    • horizontal: boolean = true
    • vertical: boolean = false

    Returns Promise<boolean>

flipHorizontal

  • Flip image horizontally.

    Returns Promise<boolean>

flipVertical

  • Flip image vertically.

    Returns Promise<boolean>

Properties

Readonly id

id: PluginType = "pageTools"

Unique plugin identifier.

options

options: PageToolsPluginOptions

Plugin options

Constructors

constructor

Settings

Member Visibility

Theme