SpreadJS 13
GC.Spread.Sheets Namespace / Worksheet type / options Field
In This Topic
    options Field
    In This Topic
    Indicates the options of the sheet.
    Syntax
    var instance = new GC.Spread.Sheets.Worksheet(name);
    var value; // Type: Object
    value = instance.options;
    var options : Object;
    Example
    sheet.setRowCount(2,GC.Spread.Sheets.SheetArea.colHeader);
    sheet.setColumnCount(2,GC.Spread.Sheets.SheetArea.rowHeader);
    sheet.setValue(0, 2,"Column",GC.Spread.Sheets.SheetArea.colHeader);
    sheet.options.colHeaderAutoTextIndex = 1;
    sheet.options.colHeaderAutoText = GC.Spread.Sheets.HeaderAutoText.numbers;
    Remarks

    This table lists the Worksheet options.

    Name Type Description
    allowCellOverflow boolean Specifies whether data can overflow into adjacent empty cells, optional.
    sheetTabColor string A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on, optional.
    frozenlineColor string A color string used to represent the frozen line color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on, optional.
    clipBoardOptions GC.Spread.Sheets.ClipboardPasteOptions The clipboard option, optional.
    gridline object The grid line's options, optional.
    gridline.color string The grid line color, optional.
    gridline.showVerticalGridline boolean Specifies whether to show the vertical grid line, optional.
    gridline.showHorizontalGridline boolean Specifies whether to show the horizontal grid line, optional.
    rowHeaderVisible boolean Specifies whether the row header is visible, optional.
    colHeaderVisible boolean Specifies whether the column header is visible, optional.
    rowHeaderAutoText GC.Spread.Sheets.HeaderAutoText Specifies whether the row header displays letters or numbers or is blank, optional.
    colHeaderAutoText GC.Spread.Sheets.HeaderAutoText Specifies whether the column header displays letters or numbers or is blank, optional.
    rowHeaderAutoTextIndex number Specifies which row header column displays the automatic text when there are multiple row header columns, optional.
    colHeaderAutoTextIndex number Specifies which column header row displays the automatic text when there are multiple column header rows, optional.
    isProtected boolean Specifies whether cells on this sheet that are marked as protected cannot be edited, optional.
    protectionOptions object A value that indicates the elements that you want users to be able to change, optional.
    protectionOptions.allowSelectLockedCells boolean Specifies whether the user can select locked cells, optional.
    protectionOptions.allowSelectUnlockedCells boolean Specifies whether the user can select unlocked cells, optional.
    protectionOptions.allowSort boolean Specifies whether the user can sort ranges, optional.
    protectionOptions.allowFilter boolean Specifies whether the user can filter ranges, optional.
    protectionOptions.allowEditObjects boolean Specifies whether the user can edit floating objects, optional.
    protectionOptions.allowResizeRows boolean Specifies whether the user can resize columns, optional.
    protectionOptions.allowDragInsertRows boolean Specifies whether the user can perform the drag operation to insert rows.
    protectionOptions.allowDragInsertColumns boolean Specifies whether the user can perform the drag operation to insert columns.
    protectionOptions.allowInsertRows boolean Specifies whether the user can insert rows.
    protectionOptions.allowInsertColumns boolean Specifies whether the user can insert columns.
    protectionOptions.allowDeleteRows boolean Specifies whether the user can delete rows.
    protectionOptions.allowDeleteColumns boolean Specifies whether the user can delete columns.
    selectionBackColor string The selection's background color for the sheet, optional.
    selectionBorderColor string The selection's border color for the sheet, optional.
    sheetAreaOffset Object The sheetAreaOffset's options, optional.
    sheetAreaOffset.left number The offset left of sheet from host, optional.
    sheetAreaOffset.top number The offset top of sheet from host, optional.
    See Also

    Reference

    Worksheet type