XL_IMAGE()

 

Version Ref: 6.1 (USP 6.0.02)

 

Syntax:

 

 e = XL_IMAGE(img [, row [, col [, sheet [, xoff [, yoff [, scalex [, scaley 
             [, flag]]]]]]]])
	Add a new image to the XLSX document.

	Parameters -
		img    : Path to image file to use.
		row    : Row to insert the image on (0 indexed).
		col    : Column to insert the image on (0 indexed).
		sheet  : Handle of sheet to insert image. Use blank, "0", or "-1" to use
		         the default sheet.
		xoff   : X-axis offset for the image, in pixels.
		yoff   : Y-axis offset for the image, in pixels.
		scalex : Scale the image along the x-axis. e.g. "1", "0.5" "2". Value
		         cannot be negative.
		scaley : Scale the image along the y-axis. e.g. "1", "0.5" "2". Value
		         cannot be negative.
		flag   : Option of how to position image.
				 "0" - Default positioning.
				 "1" - Move and size image with the cells.
				 "2" - Move but don't size image with the cells.
				 "3" - Don't move or size the image with the cells.
				 "4" - Same as "1" but wait to apply hidden cells.

	Returns "1" on success and "-1" on error. XL_ERROR() can be called to return
	the last error.
	
	Note: The image functions only support PNG, JPEG, and BMP files.