4D v14

SVG_New_image

Home

 
4D v14
SVG_New_image

SVG_New_image 


 

SVG_New_image ( parentSVGObject ; path {; x ; y {; width ; height}} ) -> Function result 
Parameter Type   Description
parentSVGObject  SVG_Ref in Reference of parent element
path  String in Address of picture
Longint in Coordinate on X axis of upper left corner
Longint in Coordinate on Y axis of upper left corner
width  Longint in Width of picture
height  Longint in Height of picture
Function result  SVG_Ref in SVG object reference

The SVG_New_image command can be used to reference a picture at the url address in the SVG container designated by parentSVGObject and returns its reference. If parentSVGObject is not an SVG document, an error is generated.

The url parameter specifies the location of the picture and can take several forms:

  • A local URL (a pathname in the form: file://…): in this case, the picture will only be displayed if the file is actually accessible at the time the picture is rendered. This local URL can be relative (in the form: “#Pictures/myPicture.png”); in this case the command prefixes the pathname with that of the Resources folder of the host database. If the width and height parameters are omitted, they will be calculated by the command (to be avoided since this is slower than when the sizes are known). In the case of a relative path, if it is not valid, an error is generated.
  • A non-local URL (http://mySite.com/pictures/myPicture.jpeg ). In this case, no verification is carried out concerning the validity of the link and an error will be generated if the width and height parameters are omitted.
  • A relative URL ("../picture.png"). This is particularly useful in client/server mode, when files are stored in the "Resources" folder. Relatives URLs can begin with:
    • "/", to indicate the "~/Resources/SVG/" path
    • "./", to indicate the "~/Resources/" path
    • "../", to indicate the database folder.

The optional x and y parameters can be used to specify the position of the upper left corner of the picture in the SVG containers (default value 0).

The width and height parameters specify the size of the rectangle in which the picture will be displayed and thus determine the size and aspect ratio of the picture. These parameter are only optional in the case of a picture referenced by a relative path in the Resources folder of the host database. If width and/or height equal 0 then the picture is not rendered.

Place the ‘logo4D.png’ picture located in the ‘Pictures’ folder of the ‘Resources’ folder:

 svgRef:=SVG_New
 objectRef:=SVG_New_image(svgRef;"#Pictures/logo4D.png")

Place the ‘4dlogo.gif’ picture that can be accessed in the ’pictures’ directory of the ‘4d.com’ site:

 svgRef:=SVG_New
 objectRef:=SVG_New_image(svgRef;"http://www.4d.com/pictures/4dlogo.gif";20;20;39;53)

Here are a few examples for accessing pictures using relative URLs:

 SVG_New_image($Dom_svg;"./images/picture.png";10;10)
  // base is the "Resources" folder
  // XML code will be xlink:href="../images/picture.png"

 SVG_New_image($Dom_svg;"../picture.png";70;180)
  // base is the database's folder
  // XML code will be xlink:href="../../picture.png"

 SVG_New_image($Dom_svg;"/sample pictures/picture.png";110;90;100;100)
  // base is the "SVG" folder in the "Resources" folder
  // XML code will be xlink:href="sample%20pictures/picture.gif"

 
PROPERTIES 

Product: 4D
Theme: Drawing
Number: 65969

 
HISTORY 

New
Created: Composant 4D SVG v11.3
Modified: 4D v14

 
SEE ALSO 

SVG_New_embedded_image
SVG_Open_picture

 
ARTICLE USAGE

4D SVG Component ( 4D v14)

Inherited from : SVG_New_image ( 4D v13)