createFromElement Method (ImageViewerItem)

Summary

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

Syntax

JavaScript Syntax

createFromElement = function(element, resolution)

TypeScript Syntax

static createFromElement(element: HTMLElement, resolution: LeadSizeD): ImageViewerItem;

Parameters

element

Source HTML Element or SVG Element.

resolution

The resolution to use of 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 create an item from an HTML Element or SVG Element. It is the equivalent of the following code:

var item = new lt.Controls.ImageViewerItem(); 
item.element = element; 
item.resolution = resolution; // Optional

Any User Defined HTML is allowable for the Element property in ImageViewer-ElementsMode, but the elements can only be interacted with if HTML Pointer Events is supported.

Element may still be null after this method completes; CreateFromElement can be used as a shortcut for either CreateFromImage or CreateFromCanvas. Passing a valid HTML Image Element to CreateFromElement will create an ImageViewerItem with the Image property set, just as it does with CreateFromImage. Similarly, passing a valid HTML5 Canvas Element to CreateFromElement will create an ImageViewerItem with the Canvas property set, just as it does with CreateFromCanvas. 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.

The item is not added to an ImageViewer using this method. You should use the Items collection to add or insert the item before it can be displayed. If an ImageViewer instance exists at the time this method is called, consider using AddFromElement or InsertFromElement instead.

Requirements

Target Platforms

See Also