Error processing SSI file
LEADTOOLS JavaScript (Leadtools.Controls)

InsertFromCanvas Method

Show in webframe
0-based index of the item.
Source HTML5 Canvas Element.
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.
Inserts a new item from an HTML5 Canvas Element.
Syntax
 function Leadtools.Controls.ImageViewerItems.insertFromCanvas( 
   index ,
   canvas ,
   resolution 
)

Parameters

ParameterTypeDescription
indexint0-based index of the item.
canvasCanvasElementSource HTML5 Canvas Element.
resolutionLeadSizeDThe 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

TypeDescription
ImageViewerItem The newly created item, if successful.
Remarks

This method allows you to quickly insert an item from an HTML5 Canvas Element. It is the equivalant of the following code:


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

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 AddFromCanvas or AddFromElement. To create an item without adding it to any ImageViewer, refer to CreateFromCanvas or CreateFromElement.

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

See Also

Reference

ImageViewerItems Object
ImageViewerItems Members

Error processing SSI file