addFromElement Method (ImageViewerItems)

Summary

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

Syntax

JavaScript Syntax
ImageViewerItems.prototype.addFromElement = function(_element_, resolution) 
TypeScript Syntax
addFromElement(_element_: HTMLElement, resolution: LeadSizeD): ImageViewerItem; 

Parameters

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

Element is passed; AddFromElement can be used as a shortcut for AddFromCanvas or AddFromImage. Passing a valid HTML5 Canvas Element to AddFromElement will create an ImageViewerItem with the Canvas property set, just as it does with AddFromCanvas. Similarly, passing a valid HTML Image Element to AddFromElement will create an ImageViewerItem with the Image property set, just as it does with AddFromImage. 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 InsertFromElement. 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

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools.Controls Assembly
Click or drag to resize