Import Picture into Excel Worksheet

REST API

POST https://api.aspose.cloud/v3.0/cells/import
POST https://api.aspose.cloud/v3.0/cells/{name}/importdata

The request is an HTTP POST with multipart/related content (see RFC 2046 or RFC 1341).

  • The first part contains a JSON object named ImportPictureOption that describes where and how the picture should be placed.
  • The second part carries the image file (or its Base64‑encoded data).

ImportPictureOption – definition

{
  "UpperLeftRow": 0,
  "UpperLeftColumn": 0,
  "LowerRightRow": 10,
  "LowerRightColumn": 5,
  "Filename": "logo.png",
  "Data": "iVBORw0KGgoAAAANSUhEUgAA...",
  "DestinationWorksheet": "Sheet1",
  "IsInsert": true,
  "ImportDataType": "Picture",
  "Source": { "FileSource": "Storage" }
}

IsInsert is a boolean – true inserts a new picture, false replaces an existing one.

Important parameters

ImportPictureOption

Parameter Name Type Description
UpperLeftRow int Row index of the upper‑left corner where the picture will be placed.
UpperLeftColumn int Column index of the upper‑left corner where the picture will be placed.
LowerRightRow int Row index of the lower‑right corner that defines the picture’s bounds.
LowerRightColumn int Column index of the lower‑right corner that defines the picture’s bounds.
Filename string Name of the picture file.
Data string Base64‑encoded binary data of the picture (optional if the file is sent as the second part).
DestinationWorksheet string Name of the worksheet where the picture will be inserted.
IsInsert boolean true to insert a new picture; false to replace an existing one.
ImportDataType string Type of data being imported (e.g., Picture, IntArray, DoubleArray, StringArray, TwoDimensionIntArray, TwoDimensionDoubleArray, TwoDimensionStringArray, BatchData, csvData).
Source FileSource Indicates the data file’s location when the BatchData parameter is null.

Full multipart request example

POST /v3.0/cells/{fileName}/importdata HTTP/1.1
Host: api.aspose.cloud
Authorization: Bearer <access_token>
Content-Type: multipart/related; boundary=----Boundary

------Boundary
Content-Type: application/json

{
  "UpperLeftRow": 2,
  "UpperLeftColumn": 1,
  "LowerRightRow": 12,
  "LowerRightColumn": 6,
  "Filename": "chart.png",
  "DestinationWorksheet": "Sheet1",
  "IsInsert": true,
  "ImportDataType": "Picture"
}
------Boundary
Content-Type: image/png
Content-Disposition: attachment; filename="chart.png"

<binary image data>
------Boundary--

Example response

{
  "Code": 200,
  "Status": "OK",
  "PictureId": "d9f7c3a2-5b1e-4a9b-8f2c-7e5b6c9a1f3d",
  "Location": "Sheet1!A3:F13"
}

Common error codes

HTTP Status Code Message
400 InvalidRequest Required parameter missing or malformed.
401 AuthenticationFailed Invalid or missing access token.
415 UnsupportedMediaType Incorrect content‑type for multipart request.
500 InternalError Unexpected server error.

Cloud SDK Family

Using an SDK is the best way to accelerate development. An SDK handles low‑level details so you can focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Frequently Asked Questions

Q1: How do I specify the picture location in a worksheet?
A: Use UpperLeftRow, UpperLeftColumn, LowerRightRow, and LowerRightColumn in the ImportPictureOption JSON. The coordinates are zero‑based (row 0 = first row, column 0 = first column).

Q2: What format should the picture data be sent in?
A: You can either upload the image file as the second part of the multipart request or include a Base64‑encoded string in the Data field of the JSON object.

Q3: Can I replace an existing picture?
A: Yes. Set IsInsert to false to replace a picture that already exists at the specified location.

Q4: Do I need to specify the Source parameter?
A: Only when ImportDataType is BatchData. In that case, Source indicates where the batch file is stored (e.g., Aspose Cloud Storage).

Import Data without Using Storage – Aspose.Cells Cloud API Export Excel Chart