Add a shape on an Excel worksheet

This REST API indicates to add a shape on an Excel worksheet.

RSET API

 
PUT http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/shapes

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path	document name.
sheetName	string	path	worksheet name.
shapeDTO		body
drawingType	string	query	shape object type
upperLeftRow	integer	query	Upper left row index.
upperLeftColumn	integer	query	Upper left column index.
top	integer	query	Represents the vertical offset of Spinner from its left row, in unit of pixel.
left	integer	query	Represents the horizontal offset of Spinner from its left column, in unit of pixel.
width	integer	query	Represents the height of Spinner, in unit of pixel.
height	integer	query	Represents the width of Spinner, in unit of pixel.
folder	string	query	Document’s folder.
storageName	string	query	storage name.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to make calls to Cloud API with cURL.

Request

 
curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes?DrawingType=arc&upperLeftRow=1&upperLeftColumn=1&top=1&left=1&width=100&height=100" \
-X PUT \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

{
"Code": 200,
"Status": "OK"
}

Cloud SDK Family

Using an SDK is the best way to speed up the development. An SDK takes care of low-level details and lets you 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 make calls to Aspose.Cells web services using various SDKs:

	// For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-dotnet/
	namespace Aspose.Cells.Cloud.SDK.Example
	{
	using Aspose.Cells.Cloud.SDK.Api;
	using Aspose.Cells.Cloud.SDK.Request;
	using System;

	public partial class CellsApiExample
	{
	public void PutWorksheetShapeExample()
	{
	CellsApi cellsApi = new CellsApi(Environment.GetEnvironmentVariable("CellsCloudTestClientId"), Environment.GetEnvironmentVariable("CellsCloudTestClientSecret"));
	PutWorksheetShapeRequest request = new PutWorksheetShapeRequest { name = "Book1.xlsx", sheetName="Sheet1", upperLeftColumn=1, upperLeftRow=1, DrawingType="button", height =10, left=12, top=10, width =10, folder = "TestData/In" };
	cellsApi.PutWorksheetShape(request);
	}
	}
	}

view raw Example-PutWorksheetShape.cs hosted with ❤ by GitHub

Java

	package com.aspose.cloud.cells.api;
	import com.aspose.cloud.cells.client.*;
	import com.aspose.cloud.cells.model.*;
	import com.aspose.cloud.cells.request.*;
	import java.io.IOException;
	import org.junit.Test;
	import java.util.ArrayList;
	import java.util.List;
	import java.io.File;
	import java.util.HashMap;

	public class Example {
	private CellsApi api;
	public Example(){
	try {
	api = new CellsApi(
	System.getenv("CellsCloudClientId"),
	System.getenv("CellsCloudClientSecret"),
	"v3.0",
	System.getenv("CellsCloudApiBaseUrl")
	);
	} catch (ApiException e) {
	e.printStackTrace();
	}
	}
	public void Run(){
	try{
	String remoteFolder = "TestData/In";

	String localName = "Book1.xlsx";
	String remoteName = "Book1.xlsx";

	UploadFileRequest uploadFileRequest = new UploadFileRequest();
	uploadFileRequest.setPath( remoteFolder + "/" + remoteName );
	uploadFileRequest.setStorageName( "");
	HashMap<String,File> files = new HashMap<String,File>();
	files.put( localName , new File(localName ));
	uploadFileRequest.setUploadFiles(files);
	api.uploadFile(uploadFileRequest);

	PutWorksheetShapeRequest request = new PutWorksheetShapeRequest();
	request.setName(remoteName);
	request.setSheetName("Sheet1");
	request.setShapeDTO(null);
	request.setDrawingType("button");
	request.setUpperLeftRow(1);
	request.setUpperLeftColumn(1);
	request.setTop(10);
	request.setLeft(10);
	request.setWidth(100);
	request.setHeight(90);
	request.setFolder(remoteFolder);
	request.setStorageName("");


	CellsCloudResponse response = api.putWorksheetShape(request);


	} catch (ApiException e) {
	e.printStackTrace();
	}catch (IOException e) {
	e.printStackTrace();
	}
	}
	}

view raw Example-PutWorksheetShape.java hosted with ❤ by GitHub

Perl

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-perl/
	use strict;
	use warnings;
	use utf8;
	use File::Slurp;
	use MIME::Base64;
	use AsposeCellsCloud::CellsApi;
	my $config = AsposeCellsCloud::Configuration->new( client_id => $ENV{'ProductClientId'}, client_secret => $ENV{'ProductClientSecret'});
	my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));

	my $remoteFolder = 'TestData/In';
	my $remoteName = 'Book1.xlsx';
	my $shape_dto = AsposeCellsCloud::Object::Shape->new();
	my $request = AsposeCellsCloud::Request::PutWorksheetShapeRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet1';
	$request->{shape_dto} = $shape_dto;
	$request->{drawing_type} = 'arc';
	$request->{upper_left_row} = 1;
	$request->{upper_left_column} = 1;
	$request->{top} = 10;
	$request->{left} = 10;
	$request->{width} = 100;
	$request->{height} = 100;
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->put_worksheet_shape(request=> $request);

view raw Example-PutWorksheetShape.pl hosted with ❤ by GitHub

Swift

Get a shape by index on an Excel worksheet Update a shape on an Excel worksheet