DsImageViewer

Document Solutions Image Viewer - v8.0.0 / DsImageViewer

Class: DsImageViewer

Document Solutions Image Viewer (DsImageViewer) is a fast JavaScript based client-side Image Viewer that runs in all major browsers.

Example

var viewer = new DsImageViewer("#root");

Hierarchy

GcImageViewer

↳ DsImageViewer

Methods

Accessors

Properties

toggleSidebar

Constructors

constructor

Methods

findControl

▸ Static findControl(selector): undefined | GcImageViewer

Gets the viewer instance using the host element or host element selector

Example

var viewer = DsImageViewer.findControl("#root");

Parameters

Name	Type
`selector`	`string` \| `HTMLElement`

Returns

undefined | GcImageViewer

Inherited from

GcImageViewer.findControl

executeTask

▸ executeTask(task, settings?): Promise<void>

Starts long-running operation and displays progress window while operation is running.

Parameters

Name	Type
`task`	(`callbacks`: `TaskCallbacks`) => `Promise`<`void`>
`settings?`	`TaskSettings`

Returns

Promise<void>

Inherited from

GcImageViewer.executeTask

showPanel

▸ showPanel(panelKey, visible?): void

Updates the panel visibility.

Parameters

Name	Type
`panelKey`	`PanelHandle`
`visible?`	`boolean`

Returns

void

Inherited from

GcImageViewer.showPanel

updatePanel

▸ updatePanel(panelKey, settings): void

Updates panel settings such as visibility, label or "enabled" status.

Parameters

Name	Type
`panelKey`	`PanelHandle`
`settings`	`Partial`<`PanelSettings`>

Returns

void

Inherited from

GcImageViewer.updatePanel

getPanelState

▸ getPanelState(panelKey): null | PanelSettings

Gets the current panel state.

Parameters

Name	Type
`panelKey`	`PanelHandle`

Returns

null | PanelSettings

Inherited from

GcImageViewer.getPanelState

layoutPanels

▸ layoutPanels(layout): void

Orders and filters panel items. '*' indicates "the rest of panels". 'sep'/'separator' indicated menu separator.

Parameters

Name	Type
`layout`	`string`[]

Returns

void

Inherited from

GcImageViewer.layoutPanels

bringPanelToFront

▸ bringPanelToFront(panelKey): void

Deprecated

use expandPanel() instead

Parameters

Name	Type
`panelKey`	`PanelHandle`

Returns

void

Inherited from

GcImageViewer.bringPanelToFront

setActiveTopPanel

▸ setActiveTopPanel(id): void

Updates activeTopPanelId for to show/hide panel with setting.location = 'top' (id = null to hide panel)

Parameters

Name	Type
`id`	`null` \| `string`

Returns

void

Inherited from

GcImageViewer.setActiveTopPanel

setActiveBottomPanel

▸ setActiveBottomPanel(id): void

Updates activeBottomPanelId for to show/hide panel with setting.location = 'bottom' (id = null to hide panel)

Parameters

Name	Type
`id`	`null` \| `string`

Returns

void

Inherited from

GcImageViewer.setActiveBottomPanel

resetDocument

▸ resetDocument(): Promise<void>

Resets report and cancel current session if any.

Returns

Promise<void>

Inherited from

GcImageViewer.resetDocument

load

▸ load(moniker, token?): Promise<LoadResult>

Loads the report (no UI), so caller has to process load result and report error if any.

Parameters

Name	Type
`moniker`	`DocumentMoniker`
`token?`	`CancellationToken`

Returns

Promise<LoadResult>

Inherited from

GcImageViewer.load

toggleFullscreen

▸ toggleFullscreen(fullscreen?): void

Toggle full screen mode.

Parameters

Name	Type
`fullscreen?`	`boolean`

Returns

void

Inherited from

GcImageViewer.toggleFullscreen

toggleToolbar

▸ toggleToolbar(show?): void

Toggle toolbar visibility.

Parameters

Name	Type
`show?`	`boolean`

Returns

void

Inherited from

GcImageViewer.toggleToolbar

ensurePaintLayer

▸ ensurePaintLayer(): IImageLayer

Create at least one image layer which will be used for painting.

Returns

IImageLayer

Inherited from

GcImageViewer.ensurePaintLayer

removeLayer

▸ removeLayer(layerOrIndex): void

Remove and dispose image layer given by argument layerOrIndex.

Parameters

Name	Type	Description
`layerOrIndex`	`string` \| `number` \| `IImageLayer`	Image layer or image layer index or image layer name.

Returns

void

Inherited from

GcImageViewer.removeLayer

removeLayers

▸ removeLayers(): void

Remove and dispose all image layers.

Returns

void

Inherited from

GcImageViewer.removeLayers

applyOptions

▸ applyOptions(): void

Call this method in order to apply changed options.

Example

viewer.applyOptions();

Returns

void

Inherited from

GcImageViewer.applyOptions

applyToolbarLayout

▸ applyToolbarLayout(): void

Call this method in order to apply changes in @see:toolbarLayout.

Example

viewer.toolbarLayout.viewer.default = ["open", "save"];
viewer.applyToolbarLayout();

Example

   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();

Returns

void

Inherited from

GcImageViewer.applyToolbarLayout

addPlugin

▸ addPlugin(plugin): boolean

Add plug-in instance which is used to add new functionality to the DsImageViewer.

Example

var viewer = new DsImageViewer("#root");
var rotationPlugin = new RotationPlugin();
viewer.addPlugin(rotationPlugin);

Parameters

Name	Type
`plugin`	`IViewerPlugin`

Returns

boolean

Inherited from

GcImageViewer.addPlugin

addKeyboardListener

▸ addKeyboardListener(uniqueKey, handler): void

Add window keyboard listener.

Parameters

Name	Type
`uniqueKey`	`string`
`handler`	`WindowKeyboardListener`

Returns

void

Inherited from

GcImageViewer.addKeyboardListener

removeKeyboardListener

▸ removeKeyboardListener(uniqueKey): void

Remove window keyboard listener.

Parameters

Name	Type
`uniqueKey`	`string`

Returns

void

Inherited from

GcImageViewer.removeKeyboardListener

configurePluginMainToolbar

▸ configurePluginMainToolbar(pos, buttonsToInsert): void

Used preliminarily by the plugin developers to configure the main toolbar layout.

Example

// Apply a custom layout to insert "zoomIn" and "zoomOut" buttons at position 2 for the "PaintTools" plugin.
viewer.configurePluginMainToolbar(2, ["zoomIn", "zoomOut"]);

Parameters

Name	Type	Description
`pos`	`undefined` \| `number` \| `boolean`	The position where the buttons should be inserted. Use `false` or `-1` to skip insertion. Undefined means the position will be determined automatically.
`buttonsToInsert`	`string`[]	An array of button keys to be inserted.

Returns

void

void

Inherited from

GcImageViewer.configurePluginMainToolbar

getEventCanvasPoint

▸ getEventCanvasPoint(event): 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

Name	Type	Description
`event`	`PointerEvent` \| `MouseEvent`	DOM Pointer or Mouse event object.

Returns

PointLocation

Inherited from

GcImageViewer.getEventCanvasPoint

dataUrlToImageData

▸ dataUrlToImageData(dataUrl, destinationSize?): Promise<ImageData>

Load image data using given data url.

Parameters

Name	Type
`dataUrl`	`string`
`destinationSize?`	`Object`
`destinationSize.width`	`number`
`destinationSize.height`	`number`

Returns

Promise<ImageData>

Inherited from

GcImageViewer.dataUrlToImageData

confirm

▸ confirm(confirmationText?, level?, title?, buttons?): Promise<boolean | ConfirmButton>

Display confirmation dialog.

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
}

Parameters

Name	Type
`confirmationText?`	`string` \| `Element`
`level?`	`"error"` \| `"info"` \| `"warning"`
`title?`	`string`
`buttons?`	`ConfirmButton`[]

Returns

Promise<boolean | ConfirmButton>

Inherited from

GcImageViewer.confirm

removePlugin

▸ removePlugin(pluginId): void

Remove plug-in instance from the DsImageViewer.

Example

var viewer = new DsImageViewer("#root");
var rotationPlugin = new RotationPlugin();
viewer.addPlugin(rotationPlugin);

viewer.removePlugin(rotationPlugin.id);

Parameters

Name	Type	Description
`pluginId`	`string` \| `IViewerPlugin`	Plugin id or plugin instance.

Returns

void

Inherited from

GcImageViewer.removePlugin

showAbout

▸ showAbout(): void

Show about dialog.

Returns

void

Inherited from

GcImageViewer.showAbout

findPlugin

▸ findPlugin(pluginId): null | IViewerPlugin

Finds a viewer plugin by its id.

Example

// find imageFilters plugin:
var imageFilters = viewer.findPlugin("imageFilters");
// find pageTools plugin:
var pageTools = viewer.findPlugin("pageTools");

Parameters

Name	Type
`pluginId`	`string`

Returns

null | IViewerPlugin

Inherited from

GcImageViewer.findPlugin

removePlugins

▸ removePlugins(): void

Remove all plug-ins.

Example

viewer.removePlugins();

Returns

void

Inherited from

GcImageViewer.removePlugins

clearUndo

▸ clearUndo(): void

Clear undo storage.

Returns

void

Inherited from

GcImageViewer.clearUndo

executeCommand

▸ executeCommand(command): Promise<void>

Execute a new command.

Parameters

Name	Type	Description
`command`	`UndoCommandSupport`	Instance of a CommandBase.

Returns

Promise<void>

Inherited from

GcImageViewer.executeCommand

newImage

▸ newImage(options?): Promise<any>

Create new empty image.

Example

await viewer.newImage({ width: 300, height: 300, fileName: "myImage.png" });

Parameters

Name	Type
`options?`	{ `width?`: `number` ; `height?`: `number` } & `OpenParameters`

Returns

Promise<any>

Inherited from

GcImageViewer.newImage

open

▸ open(file?, openParameters?): Promise<any>

Open Image document.

Example

viewer.open("Images/HelloWorld.png");

Parameters

Name	Type	Description
`file?`	`any`	URL to Image document(string) or binary data(Typed array - Uint8Array).
`openParameters?`	`ImageFormatCode` \| `ImageFormatName` \| `OpenParameters`	Loading parameters object.

Returns

Promise<any>

Inherited from

GcImageViewer.open

dispose

▸ dispose(): void

Use this method to close and release resources occupied by the DsImageViewer.

Returns

void

Inherited from

GcImageViewer.dispose

showActivitySpinner

▸ showActivitySpinner(container?): void

Show activity spinner.

Example

viewer.showActivitySpinner();

Parameters

Name	Type
`container?`	`HTMLElement`

Returns

void

Inherited from

GcImageViewer.showActivitySpinner

hideActivitySpinner

▸ hideActivitySpinner(): void

Hide activity spinner.

Example

viewer.hideActivitySpinner();

Returns

void

Inherited from

GcImageViewer.hideActivitySpinner

startAnimation

▸ startAnimation(): void

Start GIF animation.

Example

DsImageViewer.findControl("#root").startAnimation();

Returns

void

Inherited from

GcImageViewer.startAnimation

stopAnimation

▸ stopAnimation(): void

Stop GIF animation. *

Example

DsImageViewer.findControl("#root").stopAnimation();

Returns

void

Inherited from

GcImageViewer.stopAnimation

toggleAnimation

▸ toggleAnimation(): void

Toggle GIF animation.

Example

DsImageViewer.findControl("#root").toggleAnimation();

Returns

void

Inherited from

GcImageViewer.toggleAnimation

undo

▸ undo(): Promise<void>

Undo changes.

Example

if(viewer.hasUndo) {
  viewer.undo();
}

Returns

Promise<void>

Inherited from

GcImageViewer.undo

redo

▸ redo(): Promise<void>

Redo changes.

Example

if(viewer.hasRedo) {
  viewer.redo();
}

Returns

Promise<void>

Inherited from

GcImageViewer.redo

getEvent

▸ getEvent(eventName): EventFan<any>

Get event object.

Example

viewer.getEvent("CustomEvent").register(function(args) {
  console.log(args);
});

Parameters

Name	Type
`eventName`	`EventName`

Returns

EventFan<any>

Inherited from

GcImageViewer.getEvent

triggerEvent

▸ triggerEvent(eventName, args?): void

Trigger event.

Example

// Listen CustomEvent:
viewer.getEvent("CustomEvent").register(function(args) {
  console.log(args);
});
// Trigger CustomEvent:
viewer.triggerEvent("CustomEvent", { arg1: 1, arg2: 2});

Parameters

Name	Type
`eventName`	`EventName`
`args?`	`any`

Returns

void

Inherited from

GcImageViewer.triggerEvent

getOriginalImageDataUrl

▸ getOriginalImageDataUrl(): string

Get unmodified current image data url.

Returns

string

Inherited from

GcImageViewer.getOriginalImageDataUrl

getImageDataUrl

▸ getImageDataUrl(): string

Get current image data url.

Returns

string

Inherited from

GcImageViewer.getImageDataUrl

setImageDataUrl

▸ setImageDataUrl(dataUrl): Promise<void>

Modify current image data url.

Parameters

Name	Type
`dataUrl`	`any`

Returns

Promise<void>

Inherited from

GcImageViewer.setImageDataUrl

showSecondToolbar

▸ showSecondToolbar(toolbarKey): Promise<void>

Displays a second toolbar specified by the toolbarKey argument.

Example

// Show the page tools toolbar
viewer.showSecondToolbar("page-tools");

Parameters

Name	Type	Description
`toolbarKey`	`SecondToolbarType`	The key identifying the specific second toolbar to show.

Returns

Promise<void>

Inherited from

GcImageViewer.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.

Example

// Hide the second toolbar
viewer.hideSecondToolbar();

Example

// Hide a specific second toolbar by passing its key
viewer.hideSecondToolbar("page-tools");

Parameters

Name	Type	Description
`toolbarKey?`	`SecondToolbarType`	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.

Inherited from

GcImageViewer.hideSecondToolbar

openLocalFile

▸ openLocalFile(): any

Show the file open dialog where the user can select the Image file.

Example

viewer.openLocalFile();

Returns

any

Inherited from

GcImageViewer.openLocalFile

download

▸ download(fileName?, original?): void

Downloads the Image document loaded in the Viewer to the local disk.

Deprecated

Deprecated since v1.2.0-a6 in favor of the save method.

Parameters

Name	Type	Description
`fileName?`	`string`	the destination file name.
`original?`	`boolean`	Flag indicating whether to use the original image for save. Defaults to `false`.

Returns

void

Inherited from

GcImageViewer.download

save

▸ save(options?, original?): void

Saves the Image document loaded in the Viewer to the local disk.

Example

// Example: Save the modified image without using specific options.
const viewer = DsImageViewer.findControl("#root");
viewer.save();

Example

// Example: Save the modified image as "image.png".
const viewer = DsImageViewer.findControl("#root");
viewer.save({ fileName: "image.png" });

Example

// 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

// Example: Save the modified image in PNG format.
const viewer = DsImageViewer.findControl("#root");
viewer.save({ convertToFormat: "image/png" });

Example

// 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" });

Parameters

Name	Type	Description
`options?`	`string` \| `SaveOptions`	The save options, including the destination file name and other settings.
`original?`	`boolean`	Flag indicating whether to use the initial version of the image for save. Defaults to `false`.

Returns

void

Inherited from

GcImageViewer.save

showMessage

▸ showMessage(message, details?, severity?): void

Shows the message for the user.

Parameters

Name	Type	Default value
`message`	`string`	`undefined`
`details`	`string`	`""`
`severity`	`"error"` \| `"warn"` \| `"info"` \| `"debug"`	`"info"`

Returns

void

Inherited from

GcImageViewer.showMessage

Accessors

hostElement

• get hostElement(): Element

Gets the main window's host element

Returns

Element

Inherited from

GcImageViewer.hostElement

errorHandler

• get errorHandler(): ErrorHandler

Gets or sets callback that is invoked when an error occurs in the process of displaying the report

Returns

ErrorHandler

Inherited from

GcImageViewer.errorHandler

onViewerStateChange

• get onViewerStateChange(): EventFan<ChangedEventArgs>

Indicates the viewer state was changed.

Returns

EventFan<ChangedEventArgs>

Inherited from

GcImageViewer.onViewerStateChange

• get toolbar(): Toolbar

Gets toolbar API

Returns

Toolbar

Inherited from

GcImageViewer.toolbar

viewerState

• get viewerState(): Model

Gets currently viewed document state

Returns

Model

Inherited from

GcImageViewer.viewerState

zoom

• get zoom(): ZoomSettings

Zoom settings.

Example

// Set zoom to 50%.
viewer.zoom = { mode: 0, factor: 0.5 };

Example

// Zoom mode - fit image width
viewer.zoom = { mode: 1 };

Example

// Zoom mode - fit whole image
viewer.zoom = { mode: 2 };

Returns

ZoomSettings

Inherited from

GcImageViewer.zoom

backgroundColor

• get backgroundColor(): string

Gets or sets viewer background color, default value = 'transparent'

Returns

string

Inherited from

GcImageViewer.backgroundColor

pageDecoration

• get pageDecoration(): PageDecoration

Gets or sets page view decoration mode.

Returns

PageDecoration

Inherited from

GcImageViewer.pageDecoration

isFullscreen

• get isFullscreen(): boolean

Gets a value indicating full screen mode.

Returns

boolean

Inherited from

GcImageViewer.isFullscreen

isToolbarHidden

• get isToolbarHidden(): boolean

Gets a value indicating whether the toolbar is hidden.

Returns

boolean

Inherited from

GcImageViewer.isToolbarHidden

imageFormat

• get imageFormat(): ImageFormatCode

Gets a format type of the opened image.

Returns

ImageFormatCode

Inherited from

GcImageViewer.imageFormat

hasImage

• get hasImage(): boolean

Indicates whether the viewer has opened the image.

Example

 var hasImageFlag = viewer.hasImage;

Returns

boolean

Inherited from

GcImageViewer.hasImage

adaptiveNaturalSize

• 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

Name	Type
`width`	`number`
`height`	`number`

Inherited from

GcImageViewer.adaptiveNaturalSize

actualSize

• get actualSize(): Object

Gets the actual display size of the active image, including the active zoom value.

Returns

Object

Name	Type
`width`	`number`
`height`	`number`

Inherited from

GcImageViewer.actualSize

language

• 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').

Inherited from

GcImageViewer.language

layers

• get layers(): IImageLayer[]

Image layers. Used for painting.

Returns

IImageLayer[]

Inherited from

GcImageViewer.layers

naturalSize

• 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

Name	Type
`width`	`number`
`height`	`number`

Inherited from

GcImageViewer.naturalSize

openParameters

• get openParameters(): undefined | OpenParameters

The Open parameters that were used to open an image.

Returns

undefined | OpenParameters

Inherited from

GcImageViewer.openParameters

options

• get options(): Partial<ViewerOptions>

Viewer options

Returns

Partial<ViewerOptions>

Inherited from

GcImageViewer.options

toolbarLayout

• 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

ImageToolbarLayout

Inherited from

GcImageViewer.toolbarLayout

undoStorage

• get undoStorage(): UndoStorage

Command based undo state storage.

Example

const isUndoInProgress = viewer.undoStorage.undoInProgress;

Returns

UndoStorage

Inherited from

GcImageViewer.undoStorage

hasUndo

• get hasUndo(): boolean

Gets a value indicating whether the image viewer can undo changes.

Example

if(viewer.hasUndo) {
  viewer.undo();
}

Returns

boolean

Inherited from

GcImageViewer.hasUndo

hasRedo

• get hasRedo(): boolean

Gets a value indicating whether the image viewer can redo changes.

Example

if(viewer.hasRedo) {
  viewer.redo();
}

Returns

boolean

Inherited from

GcImageViewer.hasRedo

undoIndex

• get undoIndex(): number

Gets current undo level index.

Example

alert("The current Undo level index is " + viewer.undoIndex);

Returns

number

Inherited from

GcImageViewer.undoIndex

undoCount

• get undoCount(): number

Gets total undo levels count.

Example

alert("Undo levels count is " + viewer.undoCount);

Returns

number

Inherited from

GcImageViewer.undoCount

version

• get version(): string

Returns the current version of the DS Image viewer.

Example

alert("The DsImageViewer version is " + viewer.version);

Returns

string

Inherited from

GcImageViewer.version

frameIndex

• 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

Inherited from

GcImageViewer.frameIndex

framesCount

• 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

Inherited from

GcImageViewer.framesCount

eventBus

• 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

IEventBus

Inherited from

GcImageViewer.eventBus

onAfterOpen

• 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>

Inherited from

GcImageViewer.onAfterOpen

onBeforeOpen

• get onBeforeOpen(): EventFan<BeforeOpenEventArgs>

Occurs immediately before the document 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>

Inherited from

GcImageViewer.onBeforeOpen

onError

• 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>

Inherited from

GcImageViewer.onError

onImagePaint

• get onImagePaint(): EventFan<ImagePaintEventArgs>

The event raised when appearance image element changed.

Returns

EventFan<ImagePaintEventArgs>

Inherited from

GcImageViewer.onImagePaint

isAnimationStarted

• 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

Inherited from

GcImageViewer.isAnimationStarted

Properties

toggleSidebar

• toggleSidebar: (show?: boolean) => void

Type declaration

▸ (show?): void

Sets of toggles sidebar's panels visibility

Parameters

Name	Type
`show?`	`boolean`

Returns

void

Inherited from

GcImageViewer.toggleSidebar

Constructors

constructor

• new DsImageViewer(element, options?)

DsImageViewer constructor.

Parameters

Name	Type	Description
`element`	`string` \| `HTMLElement`	Required. HTML element or CSS selector.
`options`	`Partial`<`ViewerOptions`>	Optional. Viewer options.

Inherited from

GcImageViewer.constructor

DsImageViewer

Class: DsImageViewer

Hierarchy

Table of contents

Methods

Accessors

Properties

Constructors

Methods

findControl

Parameters

Returns

Inherited from

executeTask

Parameters

Returns

Inherited from

showPanel

Parameters

Returns

Inherited from

updatePanel

Parameters

Returns

Inherited from

getPanelState

Parameters

Returns

Inherited from

layoutPanels

Parameters

Returns

Inherited from

bringPanelToFront

Parameters

Returns

Inherited from

setActiveTopPanel

Parameters

Returns

Inherited from

setActiveBottomPanel

Parameters

Returns

Inherited from

resetDocument

Returns

Inherited from

load

Parameters

Returns

Inherited from

toggleFullscreen

Parameters

Returns

Inherited from

toggleToolbar

Parameters

Returns

Inherited from

ensurePaintLayer

Returns

Inherited from

removeLayer

Parameters

Returns

Inherited from

removeLayers

Returns

Inherited from

applyOptions

Returns

Inherited from

applyToolbarLayout

Returns

Inherited from

addPlugin

Parameters

Returns

Inherited from