GcImageViewer
Class: GcImageViewer
Document Solutions Image Viewer is a fast JavaScript based client-side Image Viewer that runs in all major browsers.
Note that DsImageViewer is the new name for GcImageViewer, with the same API.
During this transition period we are publishing both versions, but it is recommended that you switch to using DsImageViewer when possible.
Example
var viewer = new DsImageViewer("#root");
Extends
ReportViewer
Extended by
Implements
Constructors
Constructor
new GcImageViewer(element, options): GcImageViewer;
DsImageViewer constructor.
Parameters
element
Required. HTML element or CSS selector.
string | HTMLElement
options
Partial<ViewerOptions> = {}
Optional. Viewer options.
Returns
GcImageViewer
Overrides
ReportViewer.constructor
Accessors
imageFormat
Get Signature
get imageFormat(): ImageFormatCode;
Gets a format type of the opened image.
Returns
Implementation of
hasImage
Get Signature
get hasImage(): boolean;
Indicates whether the viewer has opened the image.
Example
var hasImageFlag = viewer.hasImage;
Returns
boolean
Implementation of
adaptiveNaturalSize
Get Signature
get adaptiveNaturalSize(): object;
Gets the active image DPI adaptive natural size. This is the image size that will be used to display the image at 100%. The adaptiveNaturalSize property is used for the actual size calculations.
Returns
object
width
width: number;
height
height: number;
actualSize
Get Signature
get actualSize(): object;
Gets the actual display size of the active image, including the active zoom value.
Returns
object
width
width: number;
height
height: number;
language
Get Signature
get language(): string;
language - A property that retrieves the standardized language key based on the provided language option.
The language key is determined by the options.language setting.
Returns
string
Standardized language key (e.g., 'en', 'ja').
layers
Get Signature
get layers(): IImageLayer[];
Image layers. Used for painting.
Returns
Implementation of
naturalSize
Get Signature
get naturalSize(): object;
Gets the active image natural size. The natural size is the image's width/height if drawn with nothing constraining its width/height, this is the number of CSS pixels wide the image will be.
Returns
object
width
width: number;
height
height: number;
Implementation of
openParameters
Get Signature
get openParameters(): undefined | OpenParameters;
The Open parameters that were used to open an image.
Returns
undefined | OpenParameters
options
Get Signature
get options(): Partial<ViewerOptions>;
Viewer options
Returns
Partial<ViewerOptions>
toolbarLayout
Get Signature
get toolbarLayout(): ImageToolbarLayout;
Defines the layout of the toolbar.
Description
The full list of the viewer specific toolbar items:
'open', '$navigation', 'navigation-auto', '$split', 'zoom', '$fullscreen', 'save', 'about'
Example
// Customize the toolbar layout:
viewer.toolbarLayout.viewer.default = ["open", "$zoom", "$fullscreen", "save", "print", "about"];
viewer.applyToolbarLayout();
Returns
Set Signature
set toolbarLayout(toolbarLayout): void;
Defines the layout of the toolbar.
Description
The full list of the viewer specific toolbar items:
'open', '$navigation', '$split', 'zoom', '$fullscreen', 'save', 'about'
Example
// Customize the toolbar layout:
viewer.toolbarLayout.viewer.default = ["open", "$zoom", "$fullscreen", "save", "print", "about"];
viewer.applyToolbarLayout();
Parameters
toolbarLayout
Returns
void
Defines the layout of the toolbar.
Description
The full list of the viewer specific toolbar items:
'open', '$navigation', '$split', 'zoom', '$fullscreen', 'save', 'about'
Example
// Customize the toolbar layout:
viewer.toolbarLayout.viewer.default = ["open", "$zoom", "$fullscreen", "save", "print", "about"];
viewer.applyToolbarLayout();
Implementation of
undoStorage
Get Signature
get undoStorage(): UndoStorage;
Command based undo state storage.
Example
const isUndoInProgress = viewer.undoStorage.undoInProgress;
Returns
Implementation of
hasUndo
Get Signature
get hasUndo(): boolean;
Gets a value indicating whether the image viewer can undo changes.
Example
if(viewer.hasUndo) {
viewer.undo();
}
Returns
boolean
hasRedo
Get Signature
get hasRedo(): boolean;
Gets a value indicating whether the image viewer can redo changes.
Example
if(viewer.hasRedo) {
viewer.redo();
}
Returns
boolean
undoIndex
Get Signature
get undoIndex(): number;
Gets current undo level index.
Example
alert("The current Undo level index is " + viewer.undoIndex);
Returns
number
undoCount
Get Signature
get undoCount(): number;
Gets total undo levels count.
Example
alert("Undo levels count is " + viewer.undoCount);
Returns
number
version
Get Signature
get version(): string;
Returns the current version of the DS Image viewer.
Example
alert("The DsImageViewer version is " + viewer.version);
Returns
string
frameIndex
Get Signature
get frameIndex(): number;
Gets or sets the active frame index. This is applicable for multi-frame images such as TIFF and ICO.
When setting this value, it will also be used as the initial frame index when opening a new image.
Example
var viewer = new DsImageViewer('#root');
viewer.frameIndex = 9;
viewer.open('Test.ico');
Returns
number
framesCount
Get Signature
get framesCount(): number;
Gets total frames count for the active image. Applicable for TIFF, ICO images.
Example
var viewer = new DsImageViewer('#root');
viewer.onAfterOpen.register(function() {
alert("The image opened. Total number of frames: " + viewer.framesCount);
});
viewer.open('Test.png');
Returns
number
eventBus
Get Signature
get eventBus(): IEventBus;
Image viewer event bus.
Example
viewer.eventBus.on("after-open", function(args) {
console.log("Image opened.", args);
});
viewer.open('Test.png');
Returns
Implementation of
onAfterOpen
Get Signature
get onAfterOpen(): EventFan<EventArgs>;
The event raised when the user changes the viewer theme.
Example
var viewer = new DsImageViewer('#root');
viewer.onAfterOpen.register(function() {
alert("The image opened.");
});
viewer.open('Test.png');
Returns
EventFan<EventArgs>
onBeforeOpen
Get Signature
get onBeforeOpen(): EventFan<BeforeOpenEventArgs>;
Occurs immediately before the image opens.
Example
var viewer = new DsImageViewer('#root');
viewer.onBeforeOpen.register(function(args) {
alert("A new image will be opened,\n payload type(binary or URL): " + args.type +",\n payload(bytes or string): " + args.payload);
});
viewer.open('Test.png');
Returns
EventFan<BeforeOpenEventArgs>
Implementation of
onError
Get Signature
get onError(): EventFan<ErrorEventArgs>;
The event indicating error.
Example
function handleError(args) {
console.error(args);
}
var viewer = new DsImageViewer('#root');
viewer.onError.register(handleError);
viewer.open('Test.png');
Returns
EventFan<ErrorEventArgs>
onImagePaint
Get Signature
get onImagePaint(): EventFan<ImagePaintEventArgs>;
The event raised when appearance image element changed.
Returns
EventFan<ImagePaintEventArgs>
isAnimationStarted
Get Signature
get isAnimationStarted(): boolean;
Gets a value indicating whether the image animation has started.
Example
// Toggle image animation:
const viewer = DsImageViewer.findControl("#root");
if(viewer.isAnimationStarted) {
viewer.stopAnimation();
} else {
viewer.startAnimation();
}
Returns
boolean
Methods
findControl()
static findControl(selector): undefined | GcImageViewer;
Gets the viewer instance using the host element or host element selector
Parameters
selector
string | HTMLElement
Returns
undefined | GcImageViewer
Example
var viewer = DsImageViewer.findControl("#root");
ensurePaintLayer()
ensurePaintLayer(): IImageLayer;
Create at least one image layer which will be used for painting.
Returns
Implementation of
removeLayer()
removeLayer(layerOrIndex): void;
Remove and dispose image layer given by argument layerOrIndex.
Parameters
layerOrIndex
Image layer or image layer index or image layer name.
string | number | IImageLayer
Returns
void
Implementation of
removeLayers()
removeLayers(): void;
Remove and dispose all image layers.
Returns
void
Implementation of
applyOptions()
applyOptions(): void;
Call this method in order to apply changed options.
Returns
void
Example
viewer.applyOptions();
applyToolbarLayout()
applyToolbarLayout(): void;
Call this method in order to apply changes in @see:toolbarLayout.
Returns
void
Examples
viewer.toolbarLayout.viewer.default = ["open", "save"];
viewer.applyToolbarLayout();
var viewer = new DsImageViewer(document.querySelector("#viewer"));
var toolbar = viewer.toolbar;
var toolbarLayout = viewer.toolbarLayout;
toolbar.addItem({
key: 'custom-action',
icon: { type: "svg", content: '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path style="fill: #205F78;" d="M20.25 12l-2.25 2.25 2.25 2.25-3.75 3.75-2.25-2.25-2.25 2.25-2.25-2.25-2.25 2.25-3.75-3.75 2.25-2.25-2.25-2.25 2.25-2.25-2.25-2.25 3.75-3.75 2.25 2.25 2.25-2.25 2.25 2.25 2.25-2.25 3.75 3.75-2.25 2.25 2.25 2.25z"></path></svg>' },
title: 'Custom action',
checked: false, enabled: false,
action: function () {
alert("Implement your action here.");
},
onUpdate: function (args) {
return {
enabled: true,
checked: false,
title: 'Custom action title'
}
}
});
toolbarLayout.viewer.default.splice(0, 0, "custom-action");
viewer.applyToolbarLayout();
Implementation of
IImageViewer.applyToolbarLayout
addPlugin()
addPlugin(plugin): boolean;
Adds a plugin instance to the DsImageViewer.
This method is now intended for internal and officially supported plugins only.
Custom or third-party plugins are no longer supported starting from version 9.0.
The plugin system remains available for internal use to provide optional viewer features,
such as ImageFiltersPlugin, PageToolsPlugin, and PaintToolsPlugin.
Attempting to register non-official plugins may lead to undefined behavior and is not supported by the product team.
Parameters
plugin
The plugin instance implementing IViewerPlugin.
Returns
boolean
true if added successfully; otherwise false.
Example
// ✅ Supported (built-in plugin)
const viewer = new DsImageViewer("#root");
viewer.addPlugin(new ImageFiltersPlugin());
// ❌ Not supported (custom plugin)
viewer.addPlugin(new CustomPlugin()); // Custom plugins are no longer supported
addKeyboardListener()
addKeyboardListener(uniqueKey, handler): void;
Add window keyboard listener.
Parameters
uniqueKey
string
handler
Returns
void
Implementation of
IImageViewer.addKeyboardListener
removeKeyboardListener()
removeKeyboardListener(uniqueKey): void;
Remove window keyboard listener.
Parameters
uniqueKey
string
Returns
void
Implementation of
IImageViewer.removeKeyboardListener
configurePluginMainToolbar()
configurePluginMainToolbar(pos, buttonsToInsert): void;
Used preliminarily by the plugin developers to configure the main toolbar layout.
Parameters
pos
The position where the buttons should be inserted. Use false or -1 to skip insertion. Undefined means the position will be determined automatically.
undefined | number | boolean
buttonsToInsert
string[]
An array of button keys to be inserted.
Returns
void
void
Example
// Apply a custom layout to insert "zoomIn" and "zoomOut" buttons at position 2 for the "PaintTools" plugin.
viewer.configurePluginMainToolbar(2, ["zoomIn", "zoomOut"]);
Implementation of
IImageViewer.configurePluginMainToolbar
getEventCanvasPoint()
getEventCanvasPoint(event, includeDpi): PointLocation;
Retrieves the point location from the pointer event provided by the 'event' parameter. The returned point is relative to the active canvas element
Parameters
event
DOM Pointer or Mouse event object.
PointerEvent | MouseEvent
includeDpi
boolean = false
Returns
Implementation of
IImageViewer.getEventCanvasPoint
setCursor()
setCursor(cursorType): IImageViewer;
Sets the cursor style for the image viewer
Parameters
cursorType
The cursor style to apply
Returns
Examples
// Set rotate cursor during image rotation
viewer.setCursor('rotate');
// Set resize cursor when hovering over edges
viewer.setCursor('nwse-resize');
See
GlobalCursorType for all available cursor options
Implementation of
resetCursor()
resetCursor(): IImageViewer;
Resets the cursor to default style
Returns
Examples
// Reset cursor when operation completes
viewer.resetCursor();
// Reset cursor on mouse leave
viewerElement.addEventListener('mouseleave', () => {
viewer.resetCursor();
});
Implementation of
toggleCursor()
toggleCursor(cursorType): IImageViewer;
Toggles between specified cursor and default style
Parameters
cursorType
Cursor style to apply, or false to reset
false | GlobalCursorType
Returns
Examples
// Toggle grab cursor during drag operations
viewer.toggleCursor(isDragging ? 'grab' : false);
// Toggle zoom cursor based on modifier key
document.addEventListener('keydown', (e) => {
if (e.ctrlKey) {
viewer.toggleCursor('zoom-in');
}
});
Implementation of
dataUrlToImageData()
dataUrlToImageData(dataUrl, destinationSize?): Promise<ImageData>;
Load image data using given data url.
Parameters
dataUrl
string
destinationSize?
width
number
height
number
Returns
Promise<ImageData>
Implementation of
IImageViewer.dataUrlToImageData
confirm()
confirm(
confirmationText?,
level?,
title?,
buttons?): Promise<boolean | ConfirmButton>;
Display confirmation dialog.
Parameters
confirmationText?
string | Element
level?
"info" | "warning" | "error"
title?
string
buttons?
Returns
Promise<boolean | ConfirmButton>
Example
const confirmResult = await viewer.confirm("Apply changes?", "info", "Confirm action", ["Yes", "No", "Cancel"]);
if (confirmResult === "Yes") {
// put your code here
} else if (confirmResult === "No") {
// put your code here
} else {
// put your code here
}
Implementation of
removePlugin()
removePlugin(pluginId): void;
Removes a plugin instance from the DsImageViewer.
This method remains available for internal and officially supported plugins only. Custom or third-party plugins are no longer supported starting from version 9.0.
Parameters
pluginId
Plugin id or plugin instance.
Returns
void
Example
// ✅ Supported
viewer.removePlugin("ImageFiltersPlugin");
// ❌ Not supported
viewer.removePlugin("CustomPluginId");
showAbout()
showAbout(): void;
Show about dialog.
Returns
void
findPlugin()
findPlugin(pluginId): null | IViewerPlugin;
Finds a viewer plugin by its id.
Parameters
pluginId
string
Returns
null | IViewerPlugin
Example
// find imageFilters plugin:
var imageFilters = viewer.findPlugin("imageFilters");
// find pageTools plugin:
var pageTools = viewer.findPlugin("pageTools");
Implementation of
removePlugins()
removePlugins(): void;
Remove all plug-ins.
Returns
void
Example
viewer.removePlugins();
clearUndo()
clearUndo(): void;
Clear undo storage.
Returns
void
executeCommand()
executeCommand(command): Promise<void>;
Execute a new command.
Parameters
command
Instance of a CommandBase.
Returns
Promise<void>
newImage()
newImage(options?): Promise<any>;
Create new empty image.
Parameters
options?
object & OpenParameters
Returns
Promise<any>
Example
await viewer.newImage({ width: 300, height: 300, fileName: "myImage.png" });
open()
open(file?, openParameters?): Promise<any>;
Open Image document.
Parameters
file?
any
URL to Image document(string) or binary data(Typed array - Uint8Array).
openParameters?
Loading parameters object.
ImageFormatCode | OpenParameters | ImageFormatName
Returns
Promise<any>
Example
viewer.open("Images/HelloWorld.png");
Overrides
ReportViewer.open
dispose()
dispose(): void;
Use this method to close and release resources occupied by the DsImageViewer.
Returns
void
Overrides
ReportViewer.dispose
showActivitySpinner()
showActivitySpinner(container?): void;
Show activity spinner.
Parameters
container?
HTMLElement
Returns
void
Example
viewer.showActivitySpinner();
Implementation of
IImageViewer.showActivitySpinner
hideActivitySpinner()
hideActivitySpinner(): void;
Hide activity spinner.
Returns
void
Example
viewer.hideActivitySpinner();
Implementation of
IImageViewer.hideActivitySpinner
startAnimation()
startAnimation(): void;
Start GIF animation.
Returns
void
Example
DsImageViewer.findControl("#root").startAnimation();
stopAnimation()
stopAnimation(): void;
Stop GIF animation. *
Returns
void
Example
-
- DsImageViewer.findControl("#root").stopAnimation();
-
toggleAnimation()
toggleAnimation(): void;
Toggle GIF animation.
Returns
void
Example
DsImageViewer.findControl("#root").toggleAnimation();
undo()
undo(): Promise<void>;
Undo changes.
Returns
Promise<void>
Example
if(viewer.hasUndo) {
viewer.undo();
}
redo()
redo(): Promise<void>;
Redo changes.
Returns
Promise<void>
Example
if(viewer.hasRedo) {
viewer.redo();
}
getEvent()
getEvent(eventName): EventFan<any>;
Get event object.
Parameters
eventName
Returns
EventFan<any>
Example
viewer.getEvent("CustomEvent").register(function(args) {
console.log(args);
});
triggerEvent()
triggerEvent(eventName, args?): void;
Trigger event.
Parameters
eventName
args?
any
Returns
void
Example
// Listen CustomEvent:
viewer.getEvent("CustomEvent").register(function(args) {
console.log(args);
});
// Trigger CustomEvent:
viewer.triggerEvent("CustomEvent", { arg1: 1, arg2: 2});
getOriginalImageDataUrl()
getOriginalImageDataUrl(): string;
Get unmodified current image data url.
Returns
string
Implementation of
IImageViewer.getOriginalImageDataUrl
getImageDataUrl()
getImageDataUrl(): string;
Get current image data url.
Returns
string
Implementation of
setImageDataUrl()
setImageDataUrl(dataUrl): Promise<void>;
Modify current image data url.
Parameters
dataUrl
any
Returns
Promise<void>
Implementation of
showSecondToolbar()
showSecondToolbar(toolbarKey): Promise<void>;
Displays a second toolbar specified by the toolbarKey argument.
Parameters
toolbarKey
The key identifying the specific second toolbar to show.
Returns
Promise<void>
Example
// Show the page tools toolbar
viewer.showSecondToolbar("page-tools");
Implementation of
IImageViewer.showSecondToolbar
hideSecondToolbar()
hideSecondToolbar(toolbarKey?): Promise<void>;
Hides the second toolbar. This method deactivates any active editor mode associated with the second toolbar and then hides the toolbar itself.
Parameters
toolbarKey?
Optional. The key identifying the specific second toolbar to hide. If provided, only hides the specified toolbar if it exists.
Returns
Promise<void>
A Promise that resolves once the second toolbar is successfully hidden.
Examples
// Hide the second toolbar
viewer.hideSecondToolbar();
// Hide a specific second toolbar by passing its key
viewer.hideSecondToolbar("page-tools");
Implementation of
IImageViewer.hideSecondToolbar
openLocalFile()
openLocalFile(): any;
Show the file open dialog where the user can select the Image file.
Returns
any
Example
viewer.openLocalFile();
download()
download(fileName?, original?): void;
Downloads the Image document loaded in the Viewer to the local disk.
Parameters
fileName?
string
the destination file name.
original?
boolean
Flag indicating whether to use the original image for save. Defaults to false.
Returns
void
Deprecated
Deprecated since v1.2.0-a6 in favor of the save method.
save()
save(options?, original?): void;
Saves the Image document loaded in the Viewer to the local disk.
Parameters
options?
The save options, including the destination file name and other settings.
string | SaveOptions
original?
boolean
Flag indicating whether to use the initial version of the image for save. Defaults to false.
Returns
void
Examples
// Example: Save the modified image without using specific options.
const viewer = DsImageViewer.findControl("#root");
viewer.save();
// Example: Save the modified image as "image.png".
const viewer = DsImageViewer.findControl("#root");
viewer.save({ fileName: "image.png" });
// Example: Download the original version of the image as "original_image.jpg".
const viewer = DsImageViewer.findControl("#root");
viewer.save({ fileName: "original_image.jpg", original: true });
// Example: Save the modified image in PNG format.
const viewer = DsImageViewer.findControl("#root");
viewer.save({ convertToFormat: "image/png" });
// Example: Save the modified image with a custom file name and in JPEG format.
const viewer = DsImageViewer.findControl("#root");
viewer.save({ fileName: "custom_name", convertToFormat: "image/jpeg" });
Implementation of
showMessage()
showMessage(
message,
details,
severity): void;
Shows the message for the user.
Parameters
message
string
details
string = ""
severity
"info" | "error" | "warn" | "debug"
Returns
void