In This Topic ▼

ensureItemVisible Method

Summary

Ensures that an item is visible in the viewer.

Syntax

TypeScript

JavaScript

ImageViewer.prototype.ensureItemVisible = function( 
   item 
)

ensureItemVisible( 
   item: ImageViewerItem 
): void;

Parameters

item

The reference item. This parameter cannot be null.

Remarks

To go to an item, use GotoItem, to go to an item by its index, use GotoItemByIndex.

The "GoTo" methods scrolls the viewer so the top-left portion of the item is visible in the current control boundary without changing the other transformation properties.

To ensure that an item is visible, use EnsureItemVisible, to ensure an item is visible giving its index, use EnsureItemVisibleByIndex.

The "Ensure" methods scrolls the viewer the minimum required to ensure the item is fully visible in the current control boundary without changing the other transformation property. If the item is already fully visible, then nothing happens. If the item is larger than the current control boundary, then the viewer will scrolls the minimum amount required where any of the edges (top-left, top-right, bottom-left or bottom-right) is visible.

For more information refer to Image Viewer Layouts, Image Viewer Appearance, Image Viewer Items, Image Viewer Transformation, and Image Viewer Bounds and Transform.

Example

For an example, refer to GotoItemByIndex.

Requirements

Target Platforms