Represents a sheet.
Syntax
var instance = new GcSpread.Sheets.Sheet(name);
function Sheet;
Inheritance Hierarchy
Object
GcSpread.Sheets.Sheet
Constructors
| Name | Description | |
|---|---|---|
 | Sheet Constructor | Represents a sheet. |
Fields
| Name | Description | |
|---|---|---|
 | autoGenerateColumns | Indicates whether to generate columns automatically while binding data context. |
| colRangeGroup | Indicates the column range group. |
| defaults | Indicates the default row height and column width of the sheet. |
| keyMap | Indicates shortcut keys for default behaviours, such as navigating left after pressing the left arrow key. |
| rowRangeGroup | Indicates the row range group. |
Methods
| Name | Description | |
|---|---|---|
 | addColumns | Adds the column or columns to the data model at the specified index. |
| addCustomFunction | Adds the specified user-defined custom function to the collection. |
| addCustomFunctionDescription | Adds a custom function description. |
| addCustomName | Adds a custom name for the specified area. |
| addFloatingObject | Adds a custom floating object to the sheet. |
| addKeyMap | Adds the shortcut key for the specified action to the sheet. |
| addNamedStyle | Adds a style to the sheet named styles collection. |
| addPicture | Adds a picture to the sheet. |
| addRows | Adds rows in this sheet. |
| addSelection | Adds a cell or cells to the selection. |
| addSlicer | Adds a slicer to the sheet. |
| addSpan | Adds a span of cells to this sheet in the specified sheet area. |
| addTable | Adds a range table with a specified size to the sheet. |
| addTableByDataSource | Adds a range table with a specified data source to the sheet. |
| allowCellOverflow | Gets or sets a value that indicates whether data can overflow into adjacent empty cells. |
| allowEditorReservedLocations | Gets or sets whether cell editor reserved mouse locations are allowed. |
| allowUndo | Gets or sets a value that indicates whether to allow undo actions. |
| autoFitColumn | Automatically fits the viewport column. |
| autoFitRow | Automatically fits the viewport row. |
| bind | Binds an event to the sheet. |
| bindColumn | Binds the column using the specified data field. |
| bindColumns | Binds the columns using the specified data fields. |
| clear | Clears the specified area. |
| clearCustomFunctionDescriptions | Clears all custom function descriptions. |
| clearCustomFunctions | Removes all user-defined custom functions (FunctionInfo object) on this sheet. |
| clearCustomNames | Clears the custom name collection. |
| clearPendingChanges | Clears the dirty, insert, and delete status from the current sheet. |
| clearSelection | Clears the selection. |
| clipBoardOptions | Gets or sets the clipboard options. |
| copyTo | Copies data from one range to another. |
| currentTheme | Gets or sets the current theme for the sheet. |
| deleteColumns | Deletes the columns in this sheet at the specified index. |
| deleteRows | Deletes the rows in this sheet at the specified index. |
| doCommand | Performs an action and adds it to the undo list if the action can be undone. |
| editorStatus | Returns the editor's status. |
| endEdit | Stops editing the active cell. |
| fillAuto | Fills the specified range automatically. When the value is a string, the value is copied to other cells. When the value is a number, the new value is generated by the TREND formula. |
| fillAutobyDirection | Fills the specified range in the specified direction. |
| fillDate | Fills the specified range when the source value type is date. The next value is generated by adding the step value to the current value. The step value is affected by the fill date unit. |
| fillGrowth | Fills the specified range growth trend when the source value type is number. The next value is generated by the step and stop values. The next value is computed by multiplying the step value with the current cell. |
| fillLinear | Fills the specified range linear trend when the source value type is number. The next value is generated by the step and stop values. The next value is computed by adding the step value to the current cell value. |
| findFloatingObject | Finds the custom floating object with the specified name. |
| findPicture | Finds the picture with specified name. |
| findTable | Gets the table of the specified cell. |
| findTableByName | Gets the table with a specified name. |
| fromJSON | Loads the object state from the specified JSON string. |
| frozenlineColor | Gets or sets a color string used to represent the frozen line color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on. |
| getActiveColumnIndex | Gets the active column index for this sheet. |
| getActiveRowIndex | Gets the active row index for this sheet. |
| getActualStyle | Gets the actual style information for a specified cell in the specified sheet area. |
| getArray | Gets an object array from a specified range of cells. |
| getBindingPath | Gets the binding path of cell-level binding from the specified cell in the specified sheet area. |
| getCalcService | Gets the calculation service of the Spread component. |
| getCell | Gets the specified cell in the specified sheet area. |
| getCellRect | Gets the rectangle of the cell. |
| getCells | Gets a range of cells in the specified sheet area. |
| getCellType | Gets the cell type. |
| getColumn | Gets the specified column in the specified sheet area. |
| getColumnCount | Gets the column count in the specified sheet area. |
| getColumnHeaderAutoText | Gets a value that indicates whether the column header displays letters or numbers or is blank. |
| getColumnHeaderAutoTextIndex | Gets which column header row displays the automatic text when there are multiple column header rows. |
| getColumnHeaderVisible | Gets a value that indicates whether the column header is visible. |
| getColumnPageBreak | Gets whether a forced page break is inserted before the specified column on this sheet when printing. |
| getColumnResizable | Gets a value that indicates whether the user can resize a specified column in the specified sheet area. |
| getColumns | Gets a range of columns in the specified sheet area. |
| getColumnVisible | Gets whether a column in the specified sheet area is displayed. |
| getColumnWidth | Gets the width in pixels for the specified column in the specified sheet area. |
| getComment | Gets the comment for the specified cell. |
| getComments | Gets all the comments on the sheet. |
| getConditionalFormats | Gets the conditional format for the sheet. |
| getCsv | Gets delimited text from a range. |
| getCustomFunction | Gets the specified user-defined custom function. |
| getCustomFunctionDescription | Gets a custom function description. |
| getCustomName | Finds the specified custom name. |
| getCustomNames | Gets information for all custom names. |
| getDataColumnName | Gets the column name at the specified position. |
| getDataItem | Gets the data item. |
| getDataSource | Gets the data source that populates the sheet. |
| getDataValidator | Gets the cell data validator. |
| getDefaultStyle | Gets the default style information for the sheet. |
| getDeleteRows | Gets the deleted row collection. |
| getDirtyCells | Gets the dirty cell collection. |
| getDirtyRows | Gets the dirty row collection. |
| getFloatingObjects | Gets the custom floating objects. |
| getFloatingObjectZIndex | Gets the z-index of the floating object. |
| getFormatter | Gets the cell formatter. |
| getFormula | Gets the formula in the specified cell in this sheet. |
| getFormulaInformation | Gets the formula in the specified cell in this sheet. |
| getFrozenColumnCount | Gets the number of frozen columns. |
| getFrozenRowCount | Gets the number of frozen rows. |
| getFrozenTrailingColumnCount | Gets the number of trailing frozen columns. |
| getFrozenTrailingRowCount | Gets the number of trailing frozen rows. |
| getGridlineOptions | Gets the grid line's options. |
| getInsertRows | Gets the inserted row collection. |
| getIsProtected | Gets a value that indicates whether cells on this sheet that are marked as protected cannot be edited. |
| getName | Gets the name of this sheet. |
| getNamedStyle | Gets a style from the sheet named styles collection which has the specified name. |
| getNamedStyles | Get named styles from the sheet. |
| getParent | Gets the parent Spread object of the current sheet. |
| getPictures | Gets the pictures. |
| getRow | Gets the specified row in the specified sheet area. |
| getRowCount | Gets the row count in the specified sheet area. |
| getRowHeaderAutoText | Gets a value that indicates whether the row header displays letters or numbers or is blank. |
| getRowHeaderAutoTextIndex | Gets which row header column displays the automatic text when there are multiple row header columns. |
| getRowHeaderVisible | Gets a value that indicates whether the row header is visible. |
| getRowHeight | Gets the height in pixels for the specified row in the specified sheet area. |
| getRowPageBreak | Gets whether a forced page break is inserted before the specified row on this sheet when printing. |
| getRowResizable | Gets a value that indicates whether users can resize the specified row in the specified sheet area. |
| getRows | Gets a range of rows in the specified sheet area. |
| getRowVisible | Gets whether the control displays the specified row. |
| getSelections | Gets the selections in the current sheet. |
| getSlicer | Gets a slicer in the sheet by the name. |
| getSlicers | Gets all slicers for the sheet. |
| getSlicersFromTable | Gets all slicers for the specified table. |
| getSpans | Gets the spans in the specified range in the specified sheet area. |
| getSparkline | Gets the sparkline for the specified cell. |
| getStyle | Gets the style information for a specified cell in the specified sheet area. |
| getStyleName | Gets the name of the style for a specified cell in the specified sheet area. |
| getTables | Gets the sheet tables. |
| getTag | Gets the tag value from the specified cell in the specified sheet area. |
| getText | Gets the formatted text in the cell in the specified sheet area. |
| getValue | Gets the unformatted data from the specified cell in the specified sheet area. |
| getViewportBottomRow | Gets the index of the bottom row in the viewport. |
| getViewportHeight | Gets the height of the specified viewport row for the active sheet. |
| getViewportLeftColumn | Gets the index of the left column in the viewport. |
| getViewportRightColumn | Gets the index of the right column in the viewport. |
| getViewportTopRow | Gets the index of the top row in the viewport. |
| getViewportWidth | Gets the width of the specified viewport column for the active sheet. |
| groupSparkline | Groups the sparklines. |
| hasFormula | Gets whether there is a formula in the specified cell in this sheet. |
| hasPendingChanges | Gets whether there is a dirty, insert, or delete status for the specified range. |
| hitTest | Performs a hit test. |
| invalidateLayout | Invalidates the sheet layout. |
| isColumnBound | Gets whether the specified column is bound to a data source. |
| isEditing | Gets whether the sheet is in edit mode. |
| isPaintSuspended | Gets or sets a property that indicates whether to refresh manually or automatically after changing Spread settings. |
| isValid | Determines whether the cell value is valid. |
| moveTable | Changes the table location. |
| moveTableByName | Changes the table location. |
| moveTo | Moves data from one range to another. |
| printInfo | Gets or sets the print information for the sheet. |
| protectionOption | Gets or sets a value that indicates the elements that you want users to be able to change. |
| recalcAll | Recalculates all the formulas in the sheet. |
| referenceStyle | Gets or sets the style for cell and range references in cell formulas on this sheet. |
| removeCustomFunction | Removes the specified user-defined custom function. |
| removeCustomFunctionDescription | Removes a custom function description. |
| removeCustomName | Removes a custom name from the custom name collection. |
| removeFloatingObject | Removes the custom floating object with the specified name. |
| removeKeyMap | Removes the shortcut key for the specified action. |
| removeNamedStyle | Removes a style from the sheet named styles collection which has the specified name. |
| removePicture | Removes the picture with the specified name. |
| removeSlicer | Removes a slicer from the sheet. |
| removeSpan | Removes the span that contains a specified anchor cell in the specified sheet area. |
| removeSparkline | Removes the sparkline for the specified cell. |
| removeTable | Removes a specified table. |
| removeTableByName | Removes the table with the specified name. |
| repaint | Repaints the specified rectangle. |
| reset | Resets the sheet. |
| resizeTable | Changes the table size. |
| resizeTableByName | Changes the table size. |
| resumeCalcService | Resumes the calculation service. |
| resumeEvent | Resumes the event. |
| rowFilter | Gets or sets the row filter for the sheet. |
| search | Searches the specified content. |
| selectionBackColor | Gets or sets the selection's background color for the sheet. |
| selectionBorderColor | Gets or sets the selection's border color for the sheet. |
| selectionPolicy | Gets or sets whether users can select ranges of items. |
| selectionUnit | Gets or sets whether users can select cells, rows, or columns. |
| setActiveCell | Sets the active cell for this sheet. |
| setArray | Sets the values in the specified two-dimensional array of objects into the specified range of cells on this sheet. |
| setArrayFormula | Sets a formula in a specified cell in the specified sheet area. |
| setBindingPath | Sets the binding path for cell-level binding in a specified cell in the specified sheet area. |
| setBorder | Sets the border for the specified area. |
| setCellType | Sets the cell type. |
| setColumnCount | Sets the column count in the specified sheet area. |
| setColumnHeaderAutoText | Sets a value that indicates whether the column header displays letters or numbers or is blank. |
| setColumnHeaderAutoTextIndex | Sets which column header row displays the automatic text when there are multiple column header rows. |
| setColumnHeaderVisible | Sets a value that indicates whether the column header is visible. |
| setColumnPageBreak | Sets whether a forced page break is inserted before the specified column on this sheet when printing. |
| setColumnResizable | Sets whether users can resize the specified column in the specified sheet area. |
| setColumnVisible | Sets whether a column in the specified sheet area is displayed. |
| setColumnWidth | Sets the width in pixels for the specified column in the specified sheet area. |
| setComment | Sets a comment for the specified cell. |
| setCsv | Sets delimited text (CSV) in the sheet. |
| setDataSource | Sets the data source that populates the sheet. |
| setDataValidator | Sets the cell data validator. |
| setDefaultStyle | Sets the default style information for the sheet. |
| setFloatingObjectZIndex | Sets the z-index of the floating object. |
| setFormatter | Sets the cell formatter. |
| setFormula | Sets a formula in a specified cell in the specified sheet area. |
| setFrozenColumnCount | Sets the number of frozen columns. |
| setFrozenRowCount | Set the number of frozen rows. |
| setFrozenTrailingColumnCount | Sets the number of trailing frozen columns. |
| setFrozenTrailingRowCount | Sets the number of trailing frozen rows. |
| setGridlineOptions | Sets the grid line's options. |
| setIsProtected | Sets a value that indicates whether cells on this sheet that are marked as protected cannot be edited. |
| setName | Sets the name of this sheet. |
| setRowCount | Sets the row count in the specified sheet area. |
| setRowHeaderAutoText | Sets a value that indicates whether the row header displays letters or numbers or is blank. |
| setRowHeaderAutoTextIndex | Sets which row header column displays the automatic text when there are multiple row header columns. |
| setRowHeaderVisible | Sets a value that indicates whether the row header is visible. |
| setRowHeight | Sets the height in pixels for the specified row in the specified sheet area. |
| setRowPageBreak | Sets whether a forced page break is inserted before the specified row on this sheet when printing. |
| setRowResizable | Sets whether users can resize the specified row in the specified sheet area. |
| setRowVisible | Sets whether the control displays the specified row in the specified sheet area. |
| setSelection | Sets the selection to a cell or a range and sets the active cell to the first cell. |
| setSparkline | Sets the sparkline for a cell. |
| setStyle | Sets the style information for a specified cell in the specified sheet area. |
| setStyleName | Sets the specified style name for a specified cell in the specified sheet area. |
| setTag | Sets the tag value for the specified cell in the specified sheet area. |
| setText | Sets the formatted text in the cell in the specified sheet area. |
| setValue | Sets the value for the specified cell in the specified sheet area. |
| sheetTabColor | Gets or sets a color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on. |
| showCell | Moves the view of a cell to the specified position in the viewport. |
| showColumn | Moves the view of a column to the specified position in the viewport. |
| showColumnRangeGroup | Gets or sets whether the column range group is visible. |
| showRow | Moves the view of a row to the specified position in the viewport. |
| showRowRangeGroup | Gets or sets whether the row range group is visible. |
| sortRange | Sorts a range of cells in this sheet in the data model. |
| startEdit | Starts to edit the cell. |
| suspendCalcService | Suspends the calculation service. |
| suspendEvent | Suspends the event. |
| tag | Gets or sets the tag value for the current sheet. |
| toJSON | Saves the object state to a JSON string. |
| unbind | Removes the binding of an event to the sheet. |
| unbindAll | Removes the binding of all events to the sheet. |
| undoManager | Gets the undo manager. |
| ungroupSparkline | Ungroups the sparklines in the specified group. |
| visible | Sets whether the sheet is displayed. |
| zoom | Gets or sets the zoom factor for the sheet. |
See Also