| Name | Description | |
|---|---|---|
 | WebImageViewerJS | Initializes a new instance of the WebImageViewerJS class. |
WebImageViewerJS Class Members
In This Topic
The following tables list the members exposed by WebImageViewerJS.
Public Constructors
Methods
| Name | Description | |
|---|---|---|
 | beginInit | Begins the viewer initialization. |
| disableAutoScrollToFocusedImage | Disables the automatic scrolling to the focused image when focused index is changed. |
| dispose | Disposes the viewer. |
| enableAutoScrollToFocusedImage | Enables the automatic scrolling to the focused image when focused index is changed. |
| endInit | Ends the viewer initialization. |
| focus | Sets the focus to the viewer. |
| get_CenterImage | Gets a value indicating whether the image is centered in the viewer. |
| get_ChangeFocusedImageWhenScrolling | Gets a value indicating whether image viewer should change the focused image when viewer is scrolling. |
| get_ContextMenuFunc | Gets a handler for "contextmenu" event of the viewer. |
| get_Control | Gets the parent DOM element of viewer. |
| get_ControlId | Gets an identifier of the parent DOM element of viewer. |
| get_DisplayMode | Gets current display mode of image viewer. |
| get_FocusedImage | Gets a focused image. |
| get_FocusedImageAppearance | Gets the appearance of the focused image. |
| get_FocusedIndex | Gets the index of focused image. |
| get_HScroll | Gets a value indicating whether the horizontal scroll bar is visible. |
| get_ImageAnchor | Gets the anchor style of the image in the image viewer. |
| get_ImageAppearance | Gets the appearance of the image. |
| get_ImageCacheManager | Gets the image cache manager associated with the viewer. |
| get_Images | Gets the image collection associated with the viewer. |
| get_ImageSizeMode | Gets a value indicating how an image is positioned within the viewer. |
| get_IsAutoScrollToFocusedImageEnabled | Gets a value indicating whether the viewer must automatically scroll to the focused image in multipage display mode. |
| get_IsDisposed | Gets a value indicating whether the control has been disposed of. |
| get_IsMultipageDisplayMode | Gets a value indicating whether viewer displays images in multipage display mode. |
| get_MasterViewer | Gets the main (master) viewer for the viewer. |
| get_MaxGetImageInfoCount | Gets the maximum count of items, which can be processed by one "GetImageInfo" request. |
| get_MultipageDisplayImagePadding | Gets the image padding in multipage display mode. |
| get_MultipageDisplayLayoutDirection | Gets the images layout direction in multipage display mode. |
| get_MultipageDisplayMode | Gets the multipage display mode. |
| get_MultipageDisplayRowCount | Gets the count of displayed images in row or column in multipage display mode. |
| get_ProgressImage | Gets an image which should be used for animating image loading. |
| get_RenderingSettings | Gets the rendering settings of this image viewer. |
| get_ResizeTimeout | Gets the timeout, in milliseconds, which are used for resizing content in the image viewer. |
| get_SyncCacheWithImages | Gets a value indicating whether viewer must synchronize the image cache with image collection state. |
| get_TilesFormat | Gets a format in which the viewer want to receive image tiles. |
| get_TileSize | Gets the image tile size in image viewer. |
| get_UseCache | Gets a value indicating whether rendered image tiles must be saved in cache on server. |
| get_UseImageAppearancesInSinglePageMode | Gets a value indicating whether the image viewer must use the image appearances only in single-page mode. |
| get_UseVectorRendering | Gets a value indicating whether the image viewer must use vector rendering for vector documents. |
| get_VectorContentBackgroundColor | Gets a CSS-color that is used for filling page when image viewer renders page using vector rendering. |
| get_ViewRotationAngle | Gets the rotation angle, in degrees, for all images in image viewer. |
| get_VisualTool | Gets the current visual tool of the viewer. |
| get_VScroll | Gets a value indicating whether the vertical scroll bar is visible. |
| get_Zoom | Gets the image zoom in the viewer. |
| getCustomViewRotationAngle | Returns the custom rotation angle for single image in image viewer. |
| getImageByLocation | Returns an image by location. |
| getImageIndexByLocation | Returns the image index by location. |
| getImageInfo | Returns size and resolution of image. |
| getNearestImage | Returns an image, which location is closest to the point, with coordinates in the image viewer space. |
| getScrollPosition | Returns the scroll position in the image viewer. |
| invalidate | Invalidates the specified region of image viewer. |
| renderImages | Sends a request for asynchronous rendering of tiles of the specified images. |
| scrollTo | Scrolls the image viewer to the specified point on image viewer. |
| scrollToImagePoint | Scrolls the image viewer to the specified point on image viewer and tries to center the specified point in the viewer if possible. |
| set_CenterImage | Sets a value indicating whether the image is centered in the viewer. |
| set_ChangeFocusedImageWhenScrolling | Sets a value indicating whether image viewer should change the focused image when viewer is scrolling. |
| set_ContextMenuFunc | Sets a handler for "contextmenu" event of the viewer. |
| set_DisplayMode | Sets current display mode of image viewer. |
| set_FocusedImageAppearance | Sets the appearance of the focused image. |
| set_FocusedIndex | Sets the index of focused image. |
| set_HScroll | Sets a value indicating whether the horizontal scroll bar is visible. |
| set_ImageAnchor | Sets the anchor style of the image in the image viewer. |
| set_ImageAppearance | Sets the appearance of the image. |
| set_ImageCacheManager | Sets the image cache manager of viewer. |
| set_ImageSizeMode | Sets a value indicating how an image is positioned within the viewer. |
| set_MasterViewer | Sets the main (master) viewer for the viewer. |
| set_MaxGetImageInfoCount | Sets the maximum count of items, which can be processed by 1 "GetImageInfo" request. |
| set_MultipageDisplayImagePadding | Sets the image padding in multipage display mode. |
| set_MultipageDisplayLayoutDirection | Sets the images layout direction in multipage display mode. |
| set_MultipageDisplayMode | Sets the multipage display mode. |
| set_MultipageDisplayRowCount | Sets the count of displayed images in row or column in multipage display mode. |
| set_ProgressImage | Sets an image which should be used for animating image loading. |
| set_RenderingSettings | Sets the rendering settings of this image viewer. |
| set_ResizeTimeout | Sets the timeout, in milliseconds, which are used for resizing content in the image viewer. |
| set_SyncCacheWithImages | Sets a value indicating whether viewer must synchronize the image cache with image collection state. |
| set_TilesFormat | Sets a format in which the viewer want to receive image tiles. |
| set_TileSize | Sets the image tile size in the viewer. |
| set_UseCache | Sets a value indicating whether rendered image tiles must be saved in cache on server. |
| set_UseImageAppearancesInSinglePageMode | Sets a value indicating whether the image viewer must use the image appearances only in single-page mode. |
| set_UseVectorRendering | Sets a value indicating whether the image viewer must use vector rendering for vector documents. |
| set_VectorContentBackgroundColor | Sets a CSS-color that is used for filling page when image viewer renders page using vector rendering. |
| set_ViewRotationAngle | Sets the rotation angle, in degrees, for all images in image viewer. |
| set_VisualTool | Sets the current visual tool of the viewer. |
| set_VScroll | Sets a value indicating whether the vertical scroll bar is visible. |
| set_Zoom | Sets the image zoom in the viewer. |
| setCustomViewRotationAngle | Sets the custom rotation angle, in degrees, for single image in image viewer. |
| setFocusedIndexAsync | Sets the index of focused image. |
| setFocusedIndexByLocation | Changes the FocusedIndex property to the index of image, which is located in specified point. |
| setTileSize | Sets the image tile size in the viewer. |
| transformPointFromControlToImage | Transforms point from coordinate space of visible area of the image viewer to an image coordinate space. |
| transformPointFromControlToScreen | Transforms point from the coordinate space of visible area of the image viewer to the browser (screen) coordinate space. |
| transformPointFromControlToViewer | Transforms point from the coordinate space of visible area of the image viewer to the coordinate space of client area of the image viewer. |
| transformPointFromImageToControl | Transforms point from an image coordinate space to the coordinate space of visible area of the image viewer. |
| transformPointFromImageToViewer | Transforms point from the image coordinate space to the coordinate space of client area of the image viewer. |
| transformPointFromScreenToControl | Transforms point from the browser (screen) coordinate space to the coordinate space of visible area of the image viewer. |
| transformPointFromScreenToViewer | Transforms point from the browser (screen) coordinate space to the coordinate space of client area of the image viewer. |
| transformPointFromViewerToControl | Transforms point from the coordinate space of client area of the image viewer to the coordinate space of visible area of the image viewer. |
| transformPointFromViewerToImage | Transforms point from the coordinate space of client area of the image viewer to the image coordinate space. |
| transformPointFromViewerToScreen | Transforms point from the coordinate space of client area of the image viewer to the browser (screen) coordinate space. |
| update | Updates the image viewer. |
| zoomToRectangle | Zooms the viewer to the specified rectangle of current image. |
Events
| Name | Description | |
|---|---|---|
 | customViewRotationAngleChanged | Occurs when the rotation angle of focused image view is changed. |
| disposed | Occurs when viewer is disposed. |
| focusedIndexChanged | Occurs when focused index is changed. |
| imageContextMenu | Occurs when the contextmenu event is fired for image. |
| imageInfoLoaded | Occurs when image information is loaded. |
| imageInfoLoading | Occurs when image information is loading. |
| imageInfoLoadingException | Occurs when error occurs during getting information about image. |
| imagePainted | Occurs when image visible area is painted. |
| imagePainting | Occurs when image painting is started. |
| imagePaintingException | Occurs when image rendering is failed. |
| imageTilePainted | Occurs when image tile is painted. |
| viewRotationAngleChanged | Occurs when the rotation angle of all image views is changed. |
| viewRotationAngleChanging | Occurs when the rotation angle of all image views is changing. |
| visualToolChanged | Occurs when visual tool is changed. |
| visualToolChanging | Occurs when visual tool is changing. |
| zoomChanged | Occurs when zoom is changed. |
See Also