In This Topic ▼

createFromImage Method

Summary

Creates a new item from an HTML Image Element.

Syntax

TypeScript

JavaScript

createFromImage = function( 
   image, 
   resolution 
)

static createFromImage( 
   image: HTMLImageElement, 
   resolution: LeadSizeD 
): ImageViewerItem;

Parameters

image

Source image.

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 create 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

Use CreateFromCanvas to create an item from an HTML5 Canvas Element. CreateFromElement can also 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 AddFromImage, AddFromElement, InsertFromImage, or InsertFromElement instead.

Requirements

Target Platforms

Reference

ImageViewerItem Class

ImageViewerItem Members

Leadtools.Controls Namespace

Download our FREE evaluation

Help Version 22.0.2023.2.4

Leadtools.Controls Assembly

Introduction

Getting Started

Namespaces

Leadtools.Controls Namespace

Assemblies