addFromSvgUrl Method

Summary

Adds a new item from a URL pointing to an SVG or XML/XHTML document structure.

Syntax

JavaScript Syntax

ImageViewerItems.prototype.addFromSvgUrl = function(url, resolution)

TypeScript Syntax

addFromSvgUrl(url: string, resolution: LeadSizeD): ImageViewerItem;

Parameters

url

URL pointing to an SVG or XML/XHTML document structure.

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 will load the data from url and add a new ImageViewerItem. This is done through the use of ImageLoader, meaning a ImageLoading event will be fired when the image loading is about to begin. When loading from AddFromSvgUrl or InsertFromSvgUrl, the image will load with AjaxXml, which only works for SVG Elements or XML/XHTML Elements. To intercept and change this loading style, attach a callback to the ImageLoading event. The HTML Image Element will be set to the Element property when finished. The image data is loaded in the background and ImageSize is updated as described in Url.

When loading from AddFromSvgUrl or InsertFromSvgUrl, the image will load with AjaxXml, which only works for SVG Elements or XML/XHTML Elements.

This method is a shortcut for the following:

var item = new lt.Controls.ImageViewerItem(); 
item.loadUrlMode = lt.ImageLoaderUrlMode.ajaxXml; 
item.Url = url; 
imageViewer.items.add(item);

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

Example

JavaScript Example

    
// Attach to the loading-done event 
this._imageViewer.imageLoading.add(function (sender, e) => { 
   e.imageLoader.done.add(function () { 
      // Force pointer events everywhere except the background (so we can pan/zoom on the background) 
      // Note: ElementInsertionHelper is not *guaranteed* to work with all SVG elements 
      lt.Controls.ElementInsertionHelper.forcePointerEventsFromRoot(e.item.element); 
      lt.Controls.ElementInsertionHelper.removePointerEvents([e.item.element]); 
   }); 
}); 
 
// Add this SVG element as a true SVG, and use the callback above for it 
this._imageViewer.items.addFromUrl("http://demo.leadtools.com/images/svg/lazio.svg", lt.LeadSizeD.create(96, 96));

Requirements

Target Platforms

Reference

ImageViewerItems Class

ImageViewerItems Members

Leadtools.Controls Namespace

Help Version 19.0.2017.10.27

Leadtools.Controls Assembly

Introduction

Getting Started

Namespaces

Leadtools.Controls Namespace

Assemblies