insertFromImage Method

Summary

Inserts a new item from an HTML Image Element.

Syntax

JavaScript Syntax

ImageViewerItems.prototype.insertFromImage = function(index, image, resolution)

TypeScript Syntax

insertFromImage(index: number, image: HTMLImageElement, resolution: LeadSizeD): ImageViewerItem;

index

0-based index of the item.

image

Source image element.

resolution

The resolution to use for the image in dots/inch (DPI). A value of 0,0 or Empty means to use the default image resolution of 96 pixels.

The newly created item, if successful.

Remarks

This method allows you to quickly insert an item from an HTML Image Element. It is the equivalent of the following code:

var item = new lt.Controls.ImageViewerItem(); 
item.image = image; 
item.resolution = resolution; // Optional 
imageViewer.items.insert(index, item);

InsertFromElement can be used as a shortcut for InsertFromImage or InsertFromCanvas. Passing a valid HTML Image Element to InsertFromElement will create an ImageViewerItem with the Image property set, just as it does with InsertFromImage. Similarly, passing a valid HTML5 Canvas Element to InsertFromElement will create an ImageViewerItem with the Canvas property set, just as it does with InsertFromCanvas. The item can have a value in only one of Image, Element or Canvas. Setting one value will automatically delete the values of the others.

To add the ImageViewerItem at the end of the collection, see AddFromImage or AddFromElement. To create an item without adding it to any ImageViewer, refer to CreateFromImage or CreateFromElement.

If image is null, then an empty item is added.

Requirements

Help Version 19.0.2017.10.27

Leadtools.Controls Assembly