startSheetIndex Method

Gets or sets the index of the first sheet to display in the spreadsheet.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Spread(host, options);
var returnValue; // Type: Object
returnValue = instance.startSheetIndex(value);

function startSheetIndex( 
   value : number
) : Object;

Parameters

value: The index of the first sheet to display in the spreadsheet.

Return Value

The index of the first sheet displayed in the spreadsheet.

Example

This example puts three sheets in a spreadsheet, specifies the first sheet to display, and sets the tab color for the sheets.

Javascript

spread.setSheetCount(3);
spread.startSheetIndex(0);
spread.getSheet(0).sheetTabColor("red");
spread.getSheet(1).sheetTabColor("#FFFF00");
spread.getSheet(2).sheetTabColor("Accent 4");

Remarks

The default value is 0.

Reference

Spread type