SpreadJS 13
GC.Spread.Sheets Namespace / Workbook type / startSheetIndex Method
The index of the first sheet to display in the spreadsheet.
In This Topic
    startSheetIndex Method
    In This Topic
    Gets or sets the index of the first sheet to display in the spreadsheet.
    Syntax
    var instance = new GC.Spread.Sheets.Workbook(host,
                                                options,
                                                options.sheetCount,
                                                options.font,
                                                options.allowUserDragMerge,
                                                options.allowUserDragDrop,
                                                options.allowUserDragFill,
                                                options.allowUserZoom,
                                                options.allowUserResize,
                                                options.allowUndo,
                                                options.allowSheetReorder,
                                                options.allowContextMenu,
                                                options.allowUserDeselect,
                                                options.defaultDragFillType,
                                                options.showDragFillSmartTag,
                                                options.showHorizontalScrollbar,
                                                options.showVerticalScrollbar,
                                                options.scrollbarShowMax,
                                                options.scrollbarMaxAlign,
                                                options.tabStripVisible,
                                                options.tabStripRatio,
                                                options.tabEditable,
                                                options.newTabVisible,
                                                options.tabNavigationVisible,
                                                options.cutCopyIndicatorVisible,
                                                options.cutCopyIndicatorBorderColor,
                                                options.backColor,
                                                options.backgroundImage,
                                                options.backgroundImageLayout,
                                                options.grayAreaBackColor,
                                                options.showResizeTip,
                                                options.showDragDropTip,
                                                options.showDragFillTip,
                                                options.showScrollTip,
                                                options.scrollIgnoreHidden,
                                                options.highlightInvalidData,
                                                options.useTouchLayout,
                                                options.hideSelection,
                                                options.resizeZeroIndicator,
                                                options.allowUserEditFormula,
                                                options.enableFormulaTextbox,
                                                options.autoFitType,
                                                options.referenceStyle,
                                                options.calcOnDemand,
                                                options.allowCopyPasteExcelStyle,
                                                options.allowExtendPasteRange,
                                                options.copyPasteHeaderOptions,
                                                options.scrollByPixel,
                                                options.scrollPixel,
                                                options.allowAutoCreateHyperlink,
                                                options.columnResizeMode,
                                                options.rowResizeMode,
                                                options.customList,
                                                options.scrollbarAppearance);
    var returnValue; // Type: any
    returnValue = instance.startSheetIndex(value);
    function startSheetIndex( 
       value : number
    ) : any;

    Parameters

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

    Return Value

    If no value is set, returns the index of the first sheet displayed in the spreadsheet; otherwise, returns 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.
    spread.setSheetCount(3);
    spread.startSheetIndex(0);
    spread.getSheet(0).options.sheetTabColor = "red";
    spread.getSheet(1).options.sheetTabColor = "#FFFF00";
    spread.getSheet(2).options.sheetTabColor = "Accent 4";
    Remarks
    The default value is 0.
    See Also

    Reference

    Workbook type