addFromImage Method

Summary

Adds a new item from an HTML Image Element.

Syntax

JavaScript Syntax

ImageViewerItems.prototype.addFromImage = function(image, resolution)

TypeScript Syntax

addFromImage(image: HTMLImageElement, resolution: LeadSizeD): ImageViewerItem;

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 add 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.add(item);

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

AddFromElement can be used as a shortcut for AddFromImage or AddFromCanvas. Passing a valid HTML Image Element to AddFromElement will create an ImageViewerItem with the Image property set, just as it does with AddFromImage. Similarly, passing a valid HTML5 Canvas Element to AddFromElement will create an ImageViewerItem with the Canvas property set, just as it does with AddFromCanvas. 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 a specific location, see InsertFromImage or InsertFromElement. To create an item without adding it to any ImageViewer, refer to CreateFromImage or CreateFromElement.

Example

JavaScript Example

var img = new Image(200, 200); 
this._imageViewer.items.addFromImage(img, lt.LeadSizeD.create(96, 96));

Requirements

Help Version 19.0.2017.10.27

Leadtools.Controls Assembly