Class RotationPlugin

RotationPlugin class. Adds the "Rotate Image" button.

Deprecated

Deprecated in favor of PageToolsPlugin.

Description

Available options are:

  • rotatePosition - position of the "Rotate Image" button.
  • flipHorizontalPosition - position of the "Flip horizontal" button.
  • flipVerticalPosition - position of the "Flip vertical" button.

Example

<script src="gcimageviewer.js"></script></head>
<script src="plugins/rotation.js"></script>
<script>
  var viewer = new GcImageViewer("#root");
  viewer.addPlugin(new RotationPlugin());
</script>

Param

Hierarchy

  • ImageViewerPluginBase
    • RotationPlugin

Accessors

in17n isReady naturalSize paintLayer viewer

Methods

removePaintLayer getRotation setRotation isImageFormatSupported flip flipHorizontal flipVertical

Properties

id options

Constructors

constructor

Accessors

in17n

  • get in17n(): i18n

  • Gets the internationalization (i18n) instance from the viewer.

    Returns

    The i18n instance.

    Returns i18n

isReady

  • get isReady(): boolean

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

    Returns boolean

naturalSize

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

  • Natural image size.

    Returns { width: number; height: number }

    • width: number
    • height: number

paintLayer

  • get paintLayer(): IImageLayer

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

    Returns IImageLayer

viewer

  • get viewer(): IImageViewer

  • Gets the image viewer instance.

    Returns

    The image viewer instance.

    Returns IImageViewer

Methods

removePaintLayer

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

    Returns

    Returns void

getRotation

  • Specifies the rotation in degrees.

    Returns number

setRotation

  • Specifies the rotation in degrees.

    Parameters

    • val: number

    Returns Promise<boolean>

isImageFormatSupported

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

    Parameters

    Returns 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 = "rotation"

Unique plugin identifier.

options

options: RotationPluginOptions

Plugin options

Constructors

constructor

Settings

Member Visibility

Theme