SpreadJS 13
GC.Spread.Sheets Namespace / Worksheet type
In This Topic
    Worksheet type
    In This Topic
    Represents a worksheet.
    Syntax
    var instance = new GC.Spread.Sheets.Worksheet(name);
    function Worksheet;
    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.
    Inheritance Hierarchy

    Object
       GC.Spread.Sheets.Worksheet

    Constructors
     NameDescription
    public ConstructorRepresents a worksheet.  
    Top
    Fields
     NameDescription
    public FieldIndicates whether to generate columns automatically while binding data context.  
    public FieldThe cellState manager.  
    public FieldChart manager for the sheet.  
    public FieldIndicates the column range group.  
    public FieldComment manager for the sheet.  
    public FieldConditional format manager for the sheet.  
    public FieldIndicates the default row height and column width of the sheet.  
    public FieldFloatingObject manager for the sheet.  
    public FieldIndicates the options of the sheet.  
    public FieldGets the outline column for the sheet.  
    public FieldPicture manager for the sheet.  
    public FieldIndicates the row range group.  
    public FieldShape manager for the sheet.  
    public FieldThe slicer manager.  
    public FieldThe table manager.  
    Top
    Methods
     NameDescription
    public MethodAdds the column or columns to the data model at the specified index.  
    public MethodAdds a custom function.  
    public MethodAdds a custom name.  
    public MethodAdds a style to the Worksheet named styles collection.  
    public MethodAdds rows in this worksheet.  
    public MethodAdds a cell or cells to the selection.  
    public MethodAdds a span of cells to this sheet in the specified sheet area.  
    public MethodAutomatically fits the viewport column.  
    public MethodAutomatically fits the viewport row.  
    public MethodApplies auto merge for a range.  
    public MethodBinds an event to the sheet.  
    public MethodBinds the column using the specified data field.  
    public MethodBinds the columns using the specified data fields.  
    public MethodClears the specified area.  
    public MethodClears all custom functions.  
    public MethodClears custom names.  
    public MethodClears the dirty, insert, and delete status from the current worksheet.  
    public MethodClears the selection.  
    public MethodCopies data from one range to another.  
    public MethodGets or sets the current theme for the sheet.  
    public MethodDeletes the columns in this sheet at the specified index.  
    public MethodDeletes the rows in this worksheet at the specified index.  
    public MethodReturns the editor's status.  
    public MethodStops editing the active cell.  
    public MethodFills the specified range automatically.  
    public MethodLoads the object state from the specified JSON string.  
    public MethodGets or sets the number of frozen columns of the sheet.  
    public MethodGets or sets the number of frozen rows of the sheet.  
    public MethodGets or sets the number of trailing frozen columns of the sheet.  
    public MethodGets or sets the number of trailing frozen rows of the sheet.  
    public MethodGets the active column index for this sheet.  
    public MethodGets the active row index for this sheet.  
    public MethodGets the actual style information for a specified cell in the specified sheet area.  
    public MethodGets an object array from a specified range of cells.  
    public MethodGets the binding path of cell-level binding from the specified cell in the specified sheet area.  
    public MethodGets the specified cell in the specified sheet area.  
    public MethodGets the rectangle of the cell.  
    public MethodGets the cell type.  
    public MethodGets the column count in the specified sheet area.  
    public MethodGets whether a forced page break is inserted before the specified column on this sheet when printing.  
    public MethodGets a value that indicates whether the user can resize a specified column in the specified sheet area.  
    public MethodGets whether a column in the specified sheet area is displayed.  
    public MethodGets the width in pixels or the dynamic size for the specified column in the specified sheet area.  
    public MethodGets delimited text from a range.  
    public MethodGets a custom function.  
    public MethodGets the specified custom name information.  
    public MethodGets all custom name information.  
    public MethodGets the column name at the specified position.  
    public MethodGets the data item.  
    public MethodGets the data source that populates the sheet.  
    public MethodGets the cell data validator.  
    public MethodGets the default style information for the sheet.  
    public MethodGets the deleted row collection.  
    public MethodGets the dependent CellRange information object array of the cell.  
    public MethodGets the dirty cell collection.  
    public MethodGets the dirty row collection.  
    public MethodGets the cell formatter.  
    public MethodGets the formula in the specified cell in this sheet.  
    public MethodGets the formula detail information in the specified cell in this sheet.  
    public MethodSets the hyperlink data for the specified cell in the specified sheet area.  
    public MethodGets the inserted row collection.  
    public MethodGets a style from the Worksheet named styles collection which has the specified name.  
    public MethodGets named styles from the Worksheet.  
    public MethodGets the parent Spread object of the current sheet.  
    public MethodGets the precedent CellRange information object array of the cell.  
    public MethodGets a range of cells in the specified sheet area.  
    public MethodGets the row count in the specified sheet area.  
    public MethodGets the height in pixels or the dynamic size for the specified row in the specified sheet area.  
    public MethodGets whether a forced page break is inserted before the specified row on this sheet when printing.  
    public MethodGets a value that indicates whether users can resize the specified row in the specified sheet area.  
    public MethodGets whether the control displays the specified row.  
    public MethodGets the selections in the current sheet.  
    public MethodGets the spans in the specified range in the specified sheet area.  
    public MethodGets the sparkline for the specified cell.  
    public MethodGets the style information for a specified cell in the specified sheet area.  
    public MethodGets the name of the style for a specified cell in the specified sheet area.  
    public MethodGets the tag value from the specified cell in the specified sheet area.  
    public MethodGets the formatted text in the cell in the specified sheet area.  
    public MethodGets the unformatted data from the specified cell in the specified sheet area.  
    public MethodGets the index of the bottom row in the viewport.  
    public MethodGets the height of the specified viewport row for the active sheet.  
    public MethodGets the index of the left column in the viewport.  
    public MethodGets the index of the right column in the viewport.  
    public MethodGets the index of the top row in the viewport.  
    public MethodGets the width of the specified viewport column for the active sheet.  
    public MethodGroups the sparklines.  
    public MethodGets whether there is a dirty, insert, or delete status for the specified range.  
    public MethodPerforms a hit test.  
    public MethodInvalidates the sheet layout.  
    public MethodGets whether recording the dirty data is suspended.  
    public MethodGets whether the sheet is in edit mode.  
    public MethodGet if sheet paint is suspended.  
    public MethodGets or sets whether display a print line for the sheet.  
    public MethodGets or sets the selected state of the worksheet.  
    public MethodDetermines whether the cell value is valid.  
    public MethodMoves data from one range to another.  
    public MethodGets or sets the name of the worksheet.  
    public MethodGets or sets the print information for the sheet.  
    public MethodRecalculates all the formulas in the sheet.  
    public MethodRemoves a custom function.  
    public MethodRemoves the specified custom name.  
    public MethodRemoves a style from the Worksheet named styles collection which has the specified name.  
    public MethodRemoves the span that contains a specified anchor cell in the specified sheet area.  
    public MethodRemoves the sparkline for the specified cell.  
    public MethodRepaints the specified rectangle.  
    public MethodResets the sheet.  
    public MethodResumes the calculation service.  
    public MethodResumes recording the dirty data.  
    public MethodResumes the event.  
    public MethodResumes the paint.  
    public MethodGets or sets the row filter for the sheet.  
    public MethodScrolls the sheet by specified pixels. When vPixels is positive, worksheet will scroll down; when vPixels is negative, worksheet will scroll up; when vPixels is 0, worksheet won't scroll in vertical direction. When hPixels is positive, worksheet will scroll right; when hPixels is negative, worksheet will scroll left; when hPixels is 0, worksheet won't scroll in horizontal direction. When Workbook's option scrollByPixel is true, worksheet will scroll to new top row/left column index and new top row/left column offset; When Workbook's option scrollByPixel is false, worksheet will scroll to new top row/left column index, and new top row/left column offset will be always 0.  
    public MethodSearches the specified content.  
    public MethodGets or sets whether users can select ranges of items on a sheet.  
    public MethodGets or sets whether users can select cells, rows, or columns on a sheet.  
    public MethodSets the active cell for this sheet.  
    public MethodSets the values in the specified two-dimensional array of objects into the specified range of cells on this sheet.  
    public MethodSets a formula in a specified cell in the specified sheet area.  
    public MethodSets the binding path for cell-level binding in a specified cell in the specified sheet area.  
    public MethodSets the cell type.  
    public MethodSets the column count in the specified sheet area.  
    public MethodSets whether a forced page break is inserted before the specified column on this sheet when printing.  
    public MethodSets whether users can resize the specified column in the specified sheet area.  
    public MethodSets whether a column in the specified sheet area is displayed.  
    public MethodSets the width in pixels or dynamic size for the specified column in the specified sheet area.  
    public MethodSets delimited text (CSV) in the sheet.  
    public MethodSets the data source that populates the sheet.  
    public MethodSets the cell data validator.  
    public MethodSets the default style information for the sheet.  
    public MethodSets the cell formatter.  
    public MethodSets a formula in a specified cell in the specified sheet area.  
    public MethodSets the hyperlink data for the specified cell in the specified sheet area.  
    public MethodSets the row count in the specified sheet area.  
    public MethodSets the height in pixels or dynamic size for the specified row in the specified sheet area.  
    public MethodSets whether a forced page break is inserted before the specified row on this sheet when printing.  
    public MethodSets whether users can resize the specified row in the specified sheet area.  
    public MethodSets whether the control displays the specified row in the specified sheet area.  
    public MethodSets the selection to a cell or a range and sets the active cell to the first cell.  
    public MethodSets the sparkline for a cell.  
    public MethodSets the style information for a specified cell in the specified sheet area.  
    public MethodSets the specified style name for a specified cell in the specified sheet area.  
    public MethodSets the tag value for the specified cell in the specified sheet area.  
    public MethodSets the formatted text in the cell in the specified sheet area.  
    public MethodSets the value for the specified cell in the specified sheet area.  
    public MethodMoves the view of a cell to the specified position in the viewport.  
    public MethodMoves the view of a column to the specified position in the viewport.  
    public MethodGets or sets whether the column outline (range group) is visible.  
    public MethodMoves the view of a row to the specified position in the viewport.  
    public MethodGets or sets whether the row outline (range group) is visible.  
    public MethodSorts a range of cells in this sheet in the data model.  
    public MethodStarts to edit the cell.  
    public MethodSuspends the calculation service.  
    public MethodSuspends recording the dirty data.  
    public MethodSuspends the event.  
    public MethodSuspends the paint.  
    public MethodGets or sets the tag value for the current sheet.  
    public MethodSaves the object state to a JSON string.  
    public MethodRemoves the binding of an event to the sheet.  
    public MethodRemoves the binding of all events to the sheet.  
    public MethodUngroups the sparklines in the specified group.  
    public MethodSets whether the worksheet is displayed.  
    public Method
     
    Top
    See Also