Get worksheet from an Excel worksheet

This REST API indicates get worksheet description or export worksheet to kinds of format file.

You can export formats: XLS, XLSX, XLSB, CSV, TSV, XLSM, ODS, TXT, PDF, OTS, XPS, DIF, PNG, JPEG,GIF, BMP, WMF,TIFF, EMF, NUMBERS, FODS.

RSET API

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

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path	The document name.
sheetName	string	path	The worksheet name.
format	string	query	The exported file format.
verticalResolution	integer	query	Sets the vertical resolution for generated images, in dots per inch.
horizontalResolution	integer	query	Sets the horizontal resolution for generated images, in dots per inch.
area	string	query	Exported area.
pageIndex	integer	query	Exported page index.
folder	string	query	The document 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 "http://api.aspose.com/v3.0/cells/myWorkbook.xlsx/worksheets/Sheet1?format=gif" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response


{
stream
}

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 GetWorksheetWithFormat1Example()
	{
	CellsApi cellsApi = new CellsApi(Environment.GetEnvironmentVariable("CellsCloudTestClientId"), Environment.GetEnvironmentVariable("CellsCloudTestClientSecret"));
	GetWorksheetWithFormatRequest request = new GetWorksheetWithFormatRequest
	{
	name = "Book1.xlsx",
	sheetName = "Sheet1",
	format = "png",
	folder = "TestData/In"
	};
	cellsApi.GetWorksheetWithFormat(request);
	}
	}
	}

view raw Examples-DotNET-CSharp-Worksheet-ConvertWorksheetToImage-1.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);
	GetWorksheetsRequest request = new GetWorksheetsRequest();

	request.setName(remoteName);
	request.setFolder(remoteFolder);
	request.setStorageName("");
	CellsCloudResponse response = api.getWorksheets(request);

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

view raw Examples-Java-worksheet-ConvertWorksheetToImage-convert-worksheet-to-image.java hosted with ❤ by GitHub

PHP

	<?php
	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-php
	require_once('vendor\autoload.php');
	use \Aspose\Cells\Cloud\Api\CellsApi;
	use \Aspose\Cells\Cloud\Request\GetWorksheetWithFormatRequest;

	class Worksheet {

	public $instance;

	public function __construct() {
	$this->instance = new CellsApi(getenv("CellsCloudClientId"),getenv("CellsCloudClientSecret"),"v3.0",getenv("CellsCloudApiBaseUrl"));
	}

	public function getWorkSheetWithFormat() {
	$remoteFolder = "TestData/In";

	$localName = "Book1.xlsx";
	$remoteName = "Book1.xlsx";
	$request = new GetWorksheetWithFormatRequest();
	$request->setName( $remoteName);
	$request->setSheetName( "Sheet1");
	$request->setFormat( "png");
	$request->setPageIndex( 0);
	$request->setFolder( $remoteFolder);
	$request->setStorageName( "");
	$this->instance->getWorksheetWithFormat($request);
	}
	}

	$worksheet = new Worksheet();
	$worksheet->getWorkSheetWithFormat();

	?>

view raw Examples-PHP-Worksheet-GetWorkSheetWithFormat-.php hosted with ❤ by GitHub

Ruby

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby
	require 'aspose_cells_cloud'

	class Worksheet

	include AsposeCellsCloud

	def initialize
	#Get client_id and client_secret from https://cloud.aspose.com
	@instance = AsposeCellsCloud::CellsApi.new($client_id,$client_secret,$api_version,$baseurl)
	end

	# Read worksheet in specified format
	def read_worksheet_in_specified_format
	name = $BOOK1
	sheet_name = $SHEET1
	format = 'PNG'
	vertical_resolution = 100
	horizontal_resolution = 90
	folder = $TEMPFOLDER
	result = @instance.upload_file( folder+"/"+name, ::File.open(File.expand_path("data/"+name),"r") {\|io\| io.read(io.size) })
	expect(result.uploaded.size).to be > 0
	result = @instance.cells_worksheets_get_worksheet(name, sheet_name, {:format=>format, :vertical_resolution=>vertical_resolution, :horizontal_resolution=>horizontal_resolution, :folder=>folder})

	end

	end

	worksheet = Worksheet.new()
	puts worksheet.read_worksheet_in_specified_format

view raw Examples-Ruby-Worksheet-read_worksheet_in_specified_format-.rb hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-python
	import os

	from asposecellscloud.apis.cells_api import CellsApi
	from asposecellscloud.models import *
	from asposecellscloud.requests import *

	api = CellsApi(os.getenv('CellsCloudClientId'),os.getenv('CellsCloudClientSecret'),"v3.0",os.getenv('CellsCloudApiBaseUrl'))
	request = GetWorksheetsRequest( 'Book1.xlsx',folder= 'PythonTest',storage_name= '')
	api.get_worksheets(request)

view raw ConvertWorkSheetToImage.py hosted with ❤ by GitHub

Node.js

	const { CellsApi, UploadFileRequest, CellsWorksheets_GetWorksheetRequest } = require("asposecellscloud");
	const clientId = process.env.CellsCloudClientId;
	const clientSecret = process.env.CellsCloudClientSecret;
	const ApiURL = process.env.CellsCloudApiBaseUrl;
	const fs = require('fs');
	const path = require('path');
	const cellsApi = new CellsApi(clientId, clientSecret,"v3.0",ApiURL);
	const localPath = "D:/aspose-cells-cloud-node/TestData/"

	const filename = "Book1.xlsx";
	const data =fs.createReadStream(path.join(localPath, filename));

	const req = new UploadFileRequest({
	path: "Temp/" + filename,
	file: data
	});
	cellsApi.uploadFile(req)
	.then((result) => {

	const req = new CellsWorksheets_GetWorksheetRequest();
	req.name = filename;
	req.sheetName = "Sheet1";
	req.verticalResolution = 100;
	req.horizontalResolution = 90;
	req.format = "png";
	req.folder = "Temp";
	cellsApi.cellsWorksheetsGetWorksheet(req)
	.then((result) => {
	console.log("successful")

	}).catch((error) => {
	console.error('Unhandled Promise Rejection:', error);
	})
	})

view raw Examples-Node.js-SDK-Worksheet-ConvertWorksheetToImage-1.js hosted with ❤ by GitHub

Android

Swift

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 $request = AsposeCellsCloud::Request::GetWorksheetWithFormatRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet1';
	$request->{format} = 'png';
	$request->{page_index} = 0;
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->get_worksheet_with_format(request=> $request);

view raw Examples-Perl-Worksheet-ConvertWorksheetToImage-1.pl hosted with ❤ by GitHub

Export an area form an Excel worksheet