insertFromElement Method

Summary

Inserts a new item from an HTML Element or SVG Element.

Syntax

JavaScript Syntax
ImageViewerItems.prototype.insertFromElement = function(index, element, resolution) 
TypeScript Syntax
insertFromElement(index: number, element: HTMLElement, resolution: LeadSizeD): ImageViewerItem; 

Parameters

index

0-based index of the item.

element

Source HTML Element or SVG 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.

Return Value

The newly created item, if successful.

Remarks

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

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

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

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

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly