Class $.wijmo.wijspread.Sheet
Constructor Attributes | Constructor Name and Description |
---|---|
Represents a sheet.
|
Field Attributes | Field Name and Description |
---|---|
Indicates whether to automatically generate columns while binding data context.
|
|
Indicates the border color.
|
|
Indicates the border width.
|
|
Indicates the auto text style of the column header.
|
|
Indicates which column header row for the sheet displays the automatic text when there are multiple column header rows.
|
|
Indicates whether the column header is visible.
|
|
Indicates the column range group.
|
|
Indicates the number of nonscrolling columns on the leading edge of this sheet.
|
|
Indicates the number of nonscrolling rows on the leading edge of this sheet.
|
|
Indicates the grid line of this sheet.
|
|
Indicates whether cells in this sheet that are marked as protected cannot be edited.
|
|
Indicates shortcut keys for default behaviours, such as navigating left after pressing the left arrow key.
|
|
Indicates the auto text style of the row header.
|
|
Indicates which row header column on this sheet displays the automatic text when there are multiple row header columns.
|
|
Indicates whether the row header is visible.
|
|
Indicates the row range group.
|
Method Attributes | Method Name and Description |
---|---|
addColumns(col, count)
Adds the column or columns to the data model at the specified index.
|
|
Adds the specified user-defined custom function to the collection.
|
|
addCustomName(name, formula, baseRow, baseCol)
Adds a custom name for the specified area.
|
|
addKeyMap(keyCode, ctrl, shift, alt, action)
Adds the shortcut key for the specified action to the sheet.
|
|
addRows(row, count)
Adds rows in this sheet.
|
|
addSelection(row, column, rowCount, columnCount)
Adds a cell or cells to the selection.
|
|
addSpan(row, column, rowCount, colCount, sheetArea)
Adds a span of cells to this sheet in the specified sheet area.
|
|
allowCellOverflow(value)
Gets or sets a value that indicates whether data can overflow into adjacent empty cells.
|
|
allowUndo(value)
Gets or sets a value that indicates whether to allow undo actions.
|
|
autoFitColumn(column)
Automatically fits the viewport column.
|
|
autoFitRow(row)
Automatically fits the viewport row.
|
|
bind(type, data, fn)
Binds an event to the sheet.
|
|
bindColumn(index, column)
Binds the column using the specified data field.
|
|
bindColumns(columns)
Binds the columns using the specified data fields.
|
|
canUserDragDrop(value)
Gets or sets whether to allow the user to drag and drop cell range data to another range.
|
|
canUserDragFill(value)
Gets or sets whether to allow the user to drag fill a range of cells.
|
|
clear(row, column, rowCount, columnCount, area, type)
Clears the specified area.
|
|
Removes all user-defined custom functions (FunctionInfo object) on this sheet.
|
|
Clears the custom name collection.
|
|
Clears the selection.
|
|
clipBoardOptions(value)
Gets and sets the clipboard options.
|
|
copyTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option)
Copies data from one range to another.
|
|
currentTheme(value)
Gets or sets the current theme for the sheet.
|
|
deleteColumns(col, count)
Deletes the columns in this sheet at the specified index.
|
|
deleteRows(row, count)
Deletes the rows in this sheet at the specified index.
|
|
doCommand(action)
Performs an action and adds it to the undo list if the action can be undone.
|
|
doKeyDown(event)
Processes key down event.
|
|
doKeyUp(event)
Processes key up event.
|
|
endEdit(ignoreValueChange)
Stops editing the active cell.
|
|
fillAuto(startRange, wholeRange, series)
Fills the specified range automatically.
|
|
fillAutobyDirection(startRange, wholeRange, direction)
Fills the specified range in the specified direction.
|
|
fillDate(startRange, wholeRange, series, unit, step, stop)
Fills the specified range when the source value type is date.
|
|
fillGrowth(startRange, wholeRange, series, step, stop)
Fills the specified range growth trend when the source value type is number.
|
|
fillLinear(startRange, wholeRange, series, step, stop)
Fills the specified range linear trend when the source value type is number.
|
|
Gets the active column index for this sheet.
|
|
Gets the active row index for this sheet.
|
|
getActualStyle(row, column, sheetArea, sheetStyleOnly)
Gets the actual style information for a specified cell in the specified sheet area.
|
|
getCell(row, col, sheetArea)
Gets the cell in the specified sheet area.
|
|
getCells(row, col, row2, col2, sheetArea)
Gets a range of cells in the specified sheet area.
|
|
getColumn(index, sheetArea)
Gets the specified column in the specified sheet area.
|
|
getColumnCount(sheetArea)
Gets the column count in the specified sheet area.
|
|
Gets a value that indicates whether the column header displays letters or numbers or is blank.
|
|
Gets which column header row displays the automatic text when there are multiple column header rows.
|
|
Gets a value that indicates whether the column header is visible.
|
|
getColumnResizable(col, sheetArea)
Gets a value that indicates whether the user can resize a specified column in the specified sheet area.
|
|
getColumns(index, index2, sheetArea)
Gets a range of columns in the specified sheet area.
|
|
getColumnVisible(col, sheetArea)
Gets whether a column in the specified sheet area is displayed.
|
|
getColumnWidth(col, sheetArea)
Gets the width in pixels for the specified column in the specified sheet area.
|
|
Gets the conditional format for the sheet.
|
|
getCsv(row, column, rowCount, columnCount, rowDelimiter, columnDelimiter)
Gets delimited text from a range.
|
|
getCustomFunction(name)
Gets the specified user-defined custom function.
|
|
getCustomName(name)
Finds the specified custom name.
|
|
getDataColumnName(column)
Gets the column name at the specified position.
|
|
Gets the data context to bind.
|
|
getDataItem(row)
Gets the data item.
|
|
Gets the data source that populates the sheet.
|
|
getDataValidator(row, col, sheetArea)
Gets the cell data validator.
|
|
getDefaultStyle(sheetArea)
Gets the default style information for the sheet.
|
|
getFormatter(row, col, sheetArea)
Gets the cell formatter.
|
|
getFormula(row, col, sheetArea)
Gets the formula in the specified cell in this sheet.
|
|
Gets the number of frozen columns.
|
|
Gets the number of frozen rows.
|
|
Gets the grid line's options.
|
|
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.
|
|
getRow(index, sheetArea)
Gets the specified row in the specified sheet area.
|
|
getRowCount(sheetArea)
Gets the row count in the specified sheet area.
|
|
Gets a value that indicates whether the row header displays letters or numbers or is blank.
|
|
Gets which row header column displays the automatic text when there are multiple row header columns.
|
|
Gets a value that indicates whether the row header is visible.
|
|
getRowHeight(row, sheetArea)
Gets the height using the specified unit type for the specified row in the specified sheet area.
|
|
getRowResizable(row, sheetArea)
Gets a value that indicates whether users can resize the specified row in the specified sheet area.
|
|
getRows(index, index2, sheetArea)
Gets a range of rows in the specified sheet area.
|
|
getRowVisible(row, sheetArea)
Gets whether the control displays the specified row.
|
|
Gets the selections in the current sheet.
|
|
getSpans(range, sheetArea)
Gets the spans in the specified range in the specified sheet area.
|
|
getSparkline(row, col)
Gets the sparkline for the specified cell.
|
|
getStyle(row, column, sheetArea)
Gets the style information for a specified cell in the specified sheet area.
|
|
getText(row, col, sheetArea)
Gets the formatted text in the cell in the specified sheet area.
|
|
getValue(row, col, sheetArea)
Gets the unformatted data from the specified cell in the specified sheet area.
|
|
getViewportBottomRow(rowViewportIndex)
Gets the index of the bottom row in the viewport.
|
|
getViewportLeftColumn(columnViewportIndex)
Gets the index of the left column in the viewport.
|
|
getViewportRightColumn(columnViewportIndex)
Gets the index of the right column in the viewport.
|
|
getViewportTopRow(rowViewportIndex)
Gets the index of the top row in the viewport.
|
|
groupSparkline(sparklines)
Groups the sparklines.
|
|
hasFormula(row, col, sheetArea)
Gets whether there is a formula in the specified cell in this sheet.
|
|
hitTest(x, y, forMove)
Performs a hit test.
|
|
Invalidates the sheet layout.
|
|
isColumnBound(column)
Gets whether the specified column is bound to a data source.
|
|
Gets whether the sheet is in edit mode.
|
|
isPaintSuspended(value)
Gets or sets a property that indicates whether to refresh manually or automatically
after changing Spread UI settings.
|
|
isValid(row, column, value)
Determines whether the cell value is valid.
|
|
moveTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option)
Moves data from one range to another.
|
|
Recalculates all the formulas in the sheet.
|
|
referenceStyle(value)
Gets or sets the style for cell and range references in cell formulas on this sheet.
|
|
removeCustomFunction(name)
Removes the specified user-defined custom function.
|
|
removeCustomName(name)
Removes a custom name from the custom name collection.
|
|
removeKeyMap(keyCode, ctrl, shift, alt, action)
Removes the shortcut key for the specified action.
|
|
removeSpan(row, col, sheetArea)
Removes the span that contains a specified anchor cell from a range of cells in the specified sheet area.
|
|
removeSparkline(row, col)
Removes the sparkline for the specified cell.
|
|
repaint(clipRect)
Repaints the specified rectangle.
|
|
reset()
Resets the worksheet.
|
|
Resumes the calculation service.
|
|
Resumes the event.
|
|
rowFilter(value)
Gets or sets the row filter for the sheet.
|
|
search(searchCondition)
Searches the specified content.
|
|
setActiveCell(row, col, rowViewportIndex, rowViewportIndex)
Sets the active cell for this sheet.
|
|
setBorder(cellRange, border, option, sheetArea)
Sets the border for the specified area.
|
|
setColumnCount(colCount, sheetArea)
Sets the column count in the specified sheet area.
|
|
setColumnHeaderAutoText(autoText)
Sets a value that indicates whether the column header displays letters or numbers or is blank.
|
|
setColumnHeaderAutoTextIndex(autoTextIndex)
Sets which column header row displays the automatic text when there are multiple column header rows.
|
|
setColumnHeaderVisible(visible)
Sets a value that indicates whether the column header is visible.
|
|
setColumnResizable(col, value, sheetArea)
Sets whether users can resize the specified column in the specified sheet area.
|
|
setColumnVisible(col, value, sheetArea)
Sets whether a column in the specified sheet area is displayed.
|
|
setColumnWidth(col, value, sheetArea)
Sets the width using the specified unit type for the specified column in the specified sheet area.
|
|
setCsv(row, column, text, rowDelimiter, columnDelimiter, flags)
Sets delimited text (CSV) in the sheet.
|
|
setDataContext(datacontext)
Sets the data context to bind.
|
|
setDataSource(data, reset)
Sets the data source that populates the sheet.
|
|
setDataValidator(row, col, value, sheetArea)
Sets the cell data validator.
|
|
setDefaultStyle(style, sheetArea)
Sets the default style information for the sheet.
|
|
setFormatter(row, col, value, sheetArea)
Sets the cell formatter.
|
|
setFormula(row, col, value, sheetArea)
Sets a formula in a specified cell in the specified sheet area.
|
|
setFrozenCount(rowCount, colCount)
Sets the frozen row count and frozen column count.
|
|
setGridlineOptions(options)
Sets the grid line's options.
|
|
setIsProtected(isProtected)
Sets a value that indicates whether cells on this sheet that are marked as protected cannot be edited.
|
|
setName(name)
Sets the name of this sheet.
|
|
setRowCount(rowCount, sheetArea)
Sets the row count in the specified sheet area.
|
|
setRowHeaderAutoText(autoText)
Sets a value that indicates whether the row header displays letters or numbers or is blank.
|
|
setRowHeaderAutoTextIndex(autoTextIndex)
Sets which row header column displays the automatic text when there are multiple row header columns.
|
|
setRowHeaderVisible(visible)
Sets a value that indicates whether the row header is visible.
|
|
setRowHeight(row, value, sheetArea)
Sets the height using the specified unit type for the specified row in the specified sheet area.
|
|
setRowResizable(row, value, sheetArea)
Sets whether users can resize the specified row in the specified sheet area.
|
|
setRowVisible(row, value, sheetArea)
Sets whether the control displays the specified row in the specified sheet area.
|
|
setStyle(row, column, value, sheetArea)
Sets the style information for a specified cell in the specified sheet area.
|
|
setText(row, col, value, sheetArea)
Sets the formatted text in the cell in the specified sheet area.
|
|
setValue(row, col, value, sheetArea, ignoreRecalc)
Sets the value for the specified cell in the specified sheet area.
|
|
showCell(row, col, verticalPosition, horizontalPosition)
Moves the view of a cell to the specified position in the viewport.
|
|
showColumn(col, horizontalPosition)
Moves the view of a column to the specified position in the viewport.
|
|
showRow(row, verticalPosition)
Moves the view of a row to the specified position in the viewport.
|
|
sortRange(row, column, rowCount, columnCount, byRows, sortInfo)
Sorts a range of cells in this sheet in the data model.
|
|
startEdit(selectAll, defaultText)
Starts to edit the cell.
|
|
Suspends the calculation service.
|
|
Suspends the event.
|
|
unbind(type, fn)
Removes the binding of an event to the sheet.
|
|
Removes the binding of all events to the sheet.
|
|
Gets the undo manager.
|
|
ungroupSparkline(group)
Ungroups the sparklines in the specified group.
|
|
zoom(factor)
Zooms the view of the control.
|
Field Detail
autoGenerateColumns
Indicates whether to automatically generate columns while binding data context.
var test = [ {"Series0":2,"Series1":1}, {"Series0":4,"Series1":2}, {"Series0":3,"Series1":4} ]; sheet.autoGenerateColumns=true; sheet.setDataSource(test, true);
borderColor
Indicates the border color.
borderWidth
Indicates the border width.
colHeaderAutoText
Indicates the auto text style of the column header.
sheet.setRowCount(2,$.wijmo.wijspread.SheetArea.colHeader); sheet.setColumnCount(2,$.wijmo.wijspread.SheetArea.rowHeader); sheet.setValue(0, 2,"Column",$.wijmo.wijspread.SheetArea.colHeader); sheet.rowHeaderAutoTextIndex = 1; sheet.rowHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.letters; sheet.colHeaderAutoTextIndex = 1; sheet.colHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.numbers;
colHeaderAutoTextIndex
Indicates which column header row for the sheet displays the automatic text when there are multiple column header rows.
sheet.setRowCount(2,$.wijmo.wijspread.SheetArea.colHeader); sheet.setColumnCount(2,$.wijmo.wijspread.SheetArea.rowHeader); sheet.setValue(0, 2,"Column",$.wijmo.wijspread.SheetArea.colHeader); sheet.rowHeaderAutoTextIndex = 1; sheet.rowHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.letters; sheet.colHeaderAutoTextIndex = 1; sheet.colHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.numbers;
colHeaderVisible
Indicates whether the column header is visible.
colRangeGroup
Indicates the column range group.
sheet.setRowCount(34); sheet.setValue(0,0,"Western"); sheet.setValue(0,1,"Western"); sheet.setValue(0,2,"Western"); sheet.setValue(1,0,"A"); sheet.setValue(1,1,"B"); sheet.setValue(1,2,"C"); sheet.setValue(2,0,"A"); sheet.setValue(2,1,"B"); sheet.setValue(2,2,"C"); sheet.rowRangeGroup.group(0,2); sheet.colRangeGroup.group(0,1); sheet.rowRangeGroup.expand(0,false); sheet.colRangeGroup.expand(0,false); spread.repaint();
frozenColCount
Indicates the number of nonscrolling columns on the leading edge of this sheet.
frozenRowCount
Indicates the number of nonscrolling rows on the leading edge of this sheet.
gridline
Indicates the grid line of this sheet.
sheet.gridline.showHorizontalGridline=true; sheet.gridline.showVerticalGridline= false; sheet.gridline.color= "#FF2235"; sheet.isPaintSuspended(false); sheet.repaint();
isProtected
Indicates whether cells in this sheet that are marked as protected cannot be edited.
sheet.getCell(1,1).locked(false); sheet.setValue(1,1,"unLocked"); sheet.getColumn(3).locked(false); sheet.getRow(5).locked(false); sheet.isProtected = true;
keyMap
Indicates shortcut keys for default behaviours, such as navigating left after pressing the left arrow key.
rowHeaderAutoText
Indicates the auto text style of the row header.
sheet.setRowCount(2,$.wijmo.wijspread.SheetArea.colHeader); sheet.setColumnCount(2,$.wijmo.wijspread.SheetArea.rowHeader); sheet.setValue(0, 2,"Column",$.wijmo.wijspread.SheetArea.colHeader); sheet.rowHeaderAutoTextIndex = 1; sheet.rowHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.letters; sheet.colHeaderAutoTextIndex = 1; sheet.colHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.numbers;
rowHeaderAutoTextIndex
Indicates which row header column on this sheet displays the automatic text when there are multiple row header columns.
sheet.setRowCount(2,$.wijmo.wijspread.SheetArea.colHeader); sheet.setColumnCount(2,$.wijmo.wijspread.SheetArea.rowHeader); sheet.setValue(0, 2,"Column",$.wijmo.wijspread.SheetArea.colHeader); sheet.rowHeaderAutoTextIndex = 1; sheet.rowHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.letters; sheet.colHeaderAutoTextIndex = 1; sheet.colHeaderAutoText = $.wijmo.wijspread.HeaderAutoText.numbers;
rowHeaderVisible
Indicates whether the row header is visible.
rowRangeGroup
Indicates the row range group.
sheet.setRowCount(34); sheet.setValue(0,0,"Western"); sheet.setValue(0,1,"Western"); sheet.setValue(0,2,"Western"); sheet.setValue(1,0,"A"); sheet.setValue(1,1,"B"); sheet.setValue(1,2,"C"); sheet.setValue(2,0,"A"); sheet.setValue(2,1,"B"); sheet.setValue(2,2,"C"); sheet.rowRangeGroup.group(0,2); sheet.colRangeGroup.group(0,1); sheet.rowRangeGroup.expand(0,false); sheet.colRangeGroup.expand(0,false); spread.repaint();
Method Detail
addColumns(col, count)
Adds the column or columns to the data model at the specified index.
sheet.setValue(0, 0, "value"); sheet.addRows(0, 2); sheet.addColumns(0, 2); sheet.setRowHeight(0, 50.0,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnWidth(0, 150.0,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(0).backColor("Gray"); sheet.getColumn(0).backColor ("Brown");
- Parameters:
- {number} col
- Column index at which to add the new columns.
- {number} count
- The number of columns to add.
addCustomFunction(fn)
Adds the specified user-defined custom function to the collection.
// Type =factorial(5) in a cell to see the result function FactorialFunction() { this.name = "FACTORIAL"; this.maxArgs = 1; this.minArgs = 1; } FactorialFunction.prototype = new $.wijmo.wijspread.Calc.Functions.Function(); FactorialFunction.prototype.evaluate = function (args) { var result = 1; if (args.length === 1 && !isNaN(parseInt(args[0]))) { for (var i = 1; i < args[0]; i++) { result = i * result; } return result; } return "#VALUE!"; } var factorial = new FactorialFunction(); activeSheet.addCustomFunction(factorial);
- Parameters:
- {Calc.Functions.Function} fn
- The function to add.
addCustomName(name, formula, baseRow, baseCol)
Adds a custom name for the specified area.
sheet.setValue(0, 0, 1); sheet.setValue(0, 1, 2); sheet.setValue(0, 2, 3); sheet.addCustomName("customName1","=12", 0, 0); sheet.addCustomName("customName2","Average(20,45)", 0, 0); sheet.addCustomName("customName3", "=A1:C1", 0, 0); sheet.setFormula(1, 0, "customName1"); sheet.setFormula(1, 1, "customName2"); sheet.setFormula(1, 2, "sum(customName3)");
- Parameters:
- {string} name
- The custom name.
- {string} formula
- The formula to set.
- {number} baseRow
- The base row of the custom name.
- {number} baseCol
- The base column of the custom name.
addKeyMap(keyCode, ctrl, shift, alt, action)
Adds the shortcut key for the specified action to the sheet.
sheet.addKeyMap("M".charCodeAt(0),true,true,false, $.wijmo.wijspread.SpreadActions.navigationLeft);
- Parameters:
- {number} keyCode
- The unicode for the key.
- {boolean} ctrl
- true if the action uses the Ctrl key; otherwise, false.
- {boolean} shift
- true if the action uses the Shift key; otherwise, false.
- {boolean} alt
- true if the action uses the Alt key; otherwise, false.
- {ActionBase} action
- The action to add.
addRows(row, count)
Adds rows in this sheet.
sheet.setValue(0, 0, "value"); sheet.addRows(0, 2); sheet.addColumns(0, 2); sheet.setRowHeight(0, 50.0,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnWidth(0, 150.0,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(0).backColor("Gray"); sheet.getColumn(0).backColor ("Brown");
- Parameters:
- {number} row
- The index of the starting row.
- {number} count
- The row count.
addSelection(row, column, rowCount, columnCount)
Adds a cell or cells to the selection.
sheet.setValue(0,0, 1,3); sheet.setValue(1,0, 50,3); sheet.setValue(2,0, 100,3); sheet.setValue(3,0, 2,3); sheet.setValue(4,0, 60,3); sheet.setValue(5,0, 90,3); sheet.setValue(6,0, 3,3); sheet.setValue(7,0, 40,3); sheet.setValue(8,0, 70,3); sheet.setValue(9,0, 5,3); sheet.setValue(10,0, 35,3); sheet.addSelection(0,0,11,1); sheet.getConditionalFormats().add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());
- Parameters:
- {number} row
- The row index of the first cell to add.
- {number} column
- The column index of the first cell to add.
- {number} rowCount
- The number of rows to add.
- {number} columnCount
- The number of columns to add.
addSpan(row, column, rowCount, colCount, sheetArea)
Adds a span of cells to this sheet in the specified sheet area.
sheet.setRowCount(4,1); sheet.setColumnCount(4,2); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.colHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.rowHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.viewport);
- Parameters:
- {number} row
- The row index of the cell at which to start the span.
- {number} column
- The column index of the cell at which to start the span.
- {number} rowCount
- The number of rows to span.
- {number} colCount
- The number of columns to span.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
{boolean}
allowCellOverflow(value)
Gets or sets a value that indicates whether data can overflow into adjacent empty cells.
sheet.allowCellOverflow(true); sheet.getCell(0,3, $.wijmo.wijspread.SheetArea.viewport).hAlign($.wijmo.wijspread.HorizontalAlign.left); sheet.getCell(1,3, $.wijmo.wijspread.SheetArea.viewport).hAlign($.wijmo.wijspread.HorizontalAlign.center); sheet.getCell(2,3, $.wijmo.wijspread.SheetArea.viewport).hAlign($.wijmo.wijspread.HorizontalAlign.right); sheet.getCell(3,3, $.wijmo.wijspread.SheetArea.viewport).hAlign($.wijmo.wijspread.HorizontalAlign.general); sheet.setValue(0,3,"Horizontal Align is left",3); sheet.setValue(1,3,"Horizontal Align is center",3); sheet.setValue(2,3,"Horizontal Align is right",3); sheet.setValue(3,3,"Horizontal Align is general",3);
- Parameters:
- {boolean} value
- Whether data can overflow.
- Returns:
- {boolean} true if data can overflow; otherwise, false.
{boolean}
allowUndo(value)
Gets or sets a value that indicates whether to allow undo actions.
- Parameters:
- {boolean} value
- Whether to allow undo actions.
- Returns:
- {boolean} true if undo actions are allowed; otherwise, false.
autoFitColumn(column)
Automatically fits the viewport column.
activeSheet.setValue(0, 1, "testing"); activeSheet.autoFitColumn(1);
- Parameters:
- {number} column
- The column index.
autoFitRow(row)
Automatically fits the viewport row.
activeSheet.setValue(0, 1, "testing\r\nmultiple\r\nlines"); activeSheet.getCell(0,1).wordWrap(true); activeSheet.autoFitRow(0);
- Parameters:
- {number} row
- The row index.
bind(type, data, fn)
Binds an event to the sheet.
sheet.bind($.wijmo.wijspread.Events.LeftColumnChanged,function(event,data) { var str = "----------------------------------------\n"; var title = "Event [LeftColumnChanged ] Fired"; str = str.substr(0, 4) + title + str.substr(4 + title.length); if (typeof data == "object") { for (var key in data) { str += key + " : " + data[key] + "\n"; } } else { str += data + "\n"; } alert(str); }); sheet.bind($.wijmo.wijspread.Events.TopRowChanged,function(event,data) { var str = "----------------------------------------\n"; var title = "Event [TopRowChanged] Fired"; str = str.substr(0, 4) + title + str.substr(4 + title.length); if (typeof data == "object") { for (var key in data) { str += key + " : " + data[key] + "\n"; } } else { str += data + "\n"; } alert(str); });
- Parameters:
- {$.wijmo.wijspread.Events} type
- The event type.
- {object} data
- Optional. Specifies additional data to pass along to the function.
- {object} fn
- Specifies the function to run when the event occurs.
bindColumn(index, column)
Binds the column using the specified data field.
var test = [ {"Series0":2,"Series1":1}, {"Series0":4,"Series1":2}, {"Series0":3,"Series1":4} ]; sheet.setDataSource(test); sheet.bindColumn(1,"Series0"); sheet.bindColumn(0,"Series1");
- Parameters:
- {number} index
- The column index.
- {string} column
- The data field.
bindColumns(columns)
Binds the columns using the specified data fields.
- Parameters:
- {Array} columns
- The array of column info with data fields.
{boolean}
canUserDragDrop(value)
Gets or sets whether to allow the user to drag and drop cell range data to another range.
- Parameters:
- {boolean} value
- true if the user is allowed to drag and drop; otherwise, false.
- Returns:
- {boolean} true if the user is allowed to drag and drop; otherwise, false.
{boolean}
canUserDragFill(value)
Gets or sets whether to allow the user to drag fill a range of cells.
- Parameters:
- {boolean} value
- true if the user is allowed to drag fill; otherwise, false.
- Returns:
- {boolean} true if the user is allowed to drag fill; otherwise, false.
clear(row, column, rowCount, columnCount, area, type)
Clears the specified area.
- Parameters:
- {number} row
- The start index.
- {number} column
- The start column.
- {number} rowCount
- The number or rows to clear.
- {number} columnCount
- The number of columns to clear.
- {$.wijmo.wijspread.SheetArea} area
- The area to clear.
- {$.wijmo.wijspread.StorageType} type
- The clear type.
clearCustomFunctions()
Removes all user-defined custom functions (FunctionInfo object) on this sheet.
clearCustomNames()
Clears the custom name collection.
clearSelection()
Clears the selection.
sheet.addSelection(4, 0, 2, 2); sheet.clearSelection();
{$.wijmo.wijspread.ClipboardPasteOptions}
clipBoardOptions(value)
Gets and sets the clipboard options.
- Parameters:
- {$.wijmo.wijspread.ClipboardPasteOptions} value
- The clipborad option.
- Returns:
- {$.wijmo.wijspread.ClipboardPasteOptions} The clipboard option.
copyTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option)
Copies data from one range to another.
- Parameters:
- {number} fromRow
- The source row.
- {number} fromColumn
- The source column.
- {number} toRow
- The target row.
- {number} toColumn
- The target column.
- {number} rowCount
- The row count.
- {number} columnCount
- The column count.
- {$.wijmo.wijspread.CopyToOption} option
- The copy option.
currentTheme(value)
Gets or sets the current theme for the sheet.
sheet.currentTheme($.wijmo.wijspread.SpreadThemes.Civic);
- Parameters:
- {string} value
- The theme name.
deleteColumns(col, count)
Deletes the columns in this sheet at the specified index.
- Parameters:
- {number} col
- The index of the first column to delete.
- {number} count
- The number of columns to delete.
deleteRows(row, count)
Deletes the rows in this sheet at the specified index.
- Parameters:
- {number} row
- The index of the first row to delete.
- {number} count
- The number of rows to delete.
doCommand(action)
Performs an action and adds it to the undo list if the action can be undone.
- Parameters:
- action
- The action.
doKeyDown(event)
Processes key down event.
- Parameters:
- event
doKeyUp(event)
Processes key up event.
- Parameters:
- event
{boolean}
endEdit(ignoreValueChange)
Stops editing the active cell.
- Parameters:
- {boolean} ignoreValueChange
- If set to true, does not apply the edited text to the cell.
- Returns:
- {boolean} true when able to stop cell editing successfully; otherwise, false.
fillAuto(startRange, wholeRange, series)
Fills the specified range automatically.
sheet.setValue(0, 0, new Date(2011, 1, 1)); sheet.setValue(0, 1, new Date(2011, 2, 9)); sheet.setValue(0, 2, 5); sheet.setValue(0, 3, 10); sheet.setValue(0, 4, 1); var start = new $.wijmo.wijspread.Range(0, 0, 1, 1); var r = new $.wijmo.wijspread.Range(0, 0, 4, 1); sheet.fillDate(start,r, $.wijmo.wijspread.FillSeries.Column,$.wijmo.wijspread.FillDateUnit.Day, 2); start = new $.wijmo.wijspread.Range(0, 1, 1, 1); var r2 = new $.wijmo.wijspread.Range(0, 1, 4, 1); sheet.fillDate(start,r2, $.wijmo.wijspread.FillSeries.Column, $.wijmo.wijspread.FillDateUnit.Day, 1, new Date(2011, 2, 11)); start = new $.wijmo.wijspread.Range(0, 2, 1, 1); var r3 = new $.wijmo.wijspread.Range(0, 2, 4, 1); sheet.fillAuto(start,r3, $.wijmo.wijspread.FillSeries.Column); start = new $.wijmo.wijspread.Range(0, 3, 1, 1); var r4 = new $.wijmo.wijspread.Range(0, 3, 4, 1); sheet.fillGrowth(start,r4, $.wijmo.wijspread.FillSeries.Column, 2, 55); start = new $.wijmo.wijspread.Range(0, 4, 1, 1); var r5 = new $.wijmo.wijspread.Range(0, 4, 4, 1); sheet.fillLinear(start,r5, $.wijmo.wijspread.FillSeries.Column, 3, 20); remark: 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.
- Parameters:
- {$.wijmo.wijspread.Range} startRange
- The fill start range.
- {$.wijmo.wijspread.Range} wholeRange
- The fill whole range.
- {$.wijmo.wijspread.FillSeries} series
- The fill direction.
fillAutobyDirection(startRange, wholeRange, direction)
Fills the specified range in the specified direction.
- Parameters:
- {$.wijmo.wijspread.Range} startRange
- The fill start range.
- {$.wijmo.wijspread.Range} wholeRange
- The fill whole range.
- {$.wijmo.wijspread.FillDirection} direction
- The fill direction.
fillDate(startRange, wholeRange, series, unit, step, stop)
Fills the specified range when the source value type is date.
sheet.setValue(0, 0, new Date(2011, 1, 1)); sheet.setValue(0, 1, new Date(2011, 2, 9)); sheet.setValue(0, 2, 5); sheet.setValue(0, 3, 10); sheet.setValue(0, 4, 1); var start = new $.wijmo.wijspread.Range(0, 0, 1, 1); var r = new $.wijmo.wijspread.Range(0, 0, 4, 1); sheet.fillDate(start,r, $.wijmo.wijspread.FillSeries.Column,$.wijmo.wijspread.FillDateUnit.Day, 2); start = new $.wijmo.wijspread.Range(0, 1, 1, 1); var r2 = new $.wijmo.wijspread.Range(0, 1, 4, 1); sheet.fillDate(start,r2, $.wijmo.wijspread.FillSeries.Column, $.wijmo.wijspread.FillDateUnit.Day, 1, new Date(2011, 2, 11)); start = new $.wijmo.wijspread.Range(0, 2, 1, 1); var r3 = new $.wijmo.wijspread.Range(0, 2, 4, 1); sheet.fillAuto(start,r3, $.wijmo.wijspread.FillSeries.Column); start = new $.wijmo.wijspread.Range(0, 3, 1, 1); var r4 = new $.wijmo.wijspread.Range(0, 3, 4, 1); sheet.fillGrowth(start,r4, $.wijmo.wijspread.FillSeries.Column, 2, 55); start = new $.wijmo.wijspread.Range(0, 4, 1, 1); var r5 = new $.wijmo.wijspread.Range(0, 4, 4, 1); sheet.fillLinear(start,r5, $.wijmo.wijspread.FillSeries.Column, 3, 20); remark: The next value is generated by adding the step value to the current value. The step value is affected by the fill date unit.
- Parameters:
- {$.wijmo.wijspread.Range} startRange
- The fill start range.
- {$.wijmo.wijspread.Range} wholeRange
- The fill whole range.
- {$.wijmo.wijspread.FillSeries} series
- The fill direction.
- {$.wijmo.wijspread.FillDateUnit} unit
- The fill date unit.
- {number} step
- The fill date step value.
- {Date} stop
- Stops when the fill value exceeds the stop value.
fillGrowth(startRange, wholeRange, series, step, stop)
Fills the specified range growth trend when the source value type is number.
sheet.setValue(0, 0, new Date(2011, 1, 1)); sheet.setValue(0, 1, new Date(2011, 2, 9)); sheet.setValue(0, 2, 5); sheet.setValue(0, 3, 10); sheet.setValue(0, 4, 1); var start = new $.wijmo.wijspread.Range(0, 0, 1, 1); var r = new $.wijmo.wijspread.Range(0, 0, 4, 1); sheet.fillDate(start,r, $.wijmo.wijspread.FillSeries.Column,$.wijmo.wijspread.FillDateUnit.Day, 2); start = new $.wijmo.wijspread.Range(0, 1, 1, 1); var r2 = new $.wijmo.wijspread.Range(0, 1, 4, 1); sheet.fillDate(start,r2, $.wijmo.wijspread.FillSeries.Column, $.wijmo.wijspread.FillDateUnit.Day, 1, new Date(2011, 2, 11)); start = new $.wijmo.wijspread.Range(0, 2, 1, 1); var r3 = new $.wijmo.wijspread.Range(0, 2, 4, 1); sheet.fillAuto(start,r3, $.wijmo.wijspread.FillSeries.Column); start = new $.wijmo.wijspread.Range(0, 3, 1, 1); var r4 = new $.wijmo.wijspread.Range(0, 3, 4, 1); sheet.fillGrowth(start,r4, $.wijmo.wijspread.FillSeries.Column, 2, 55); start = new $.wijmo.wijspread.Range(0, 4, 1, 1); var r5 = new $.wijmo.wijspread.Range(0, 4, 4, 1); sheet.fillLinear(start,r5, $.wijmo.wijspread.FillSeries.Column, 3, 20); remark: 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.
- Parameters:
- {$.wijmo.wijspread.Range} startRange
- The fill start range.
- {$.wijmo.wijspread.Range} wholeRange
- The fill whole range.
- {$.wijmo.wijspread.FillSeries} series
- The fill direction.
- {number} step
- The fill step value.
- {number} stop
- The fill stop value.
fillLinear(startRange, wholeRange, series, step, stop)
Fills the specified range linear trend when the source value type is number.
sheet.setValue(0, 0, new Date(2011, 1, 1)); sheet.setValue(0, 1, new Date(2011, 2, 9)); sheet.setValue(0, 2, 5); sheet.setValue(0, 3, 10); sheet.setValue(0, 4, 1); var start = new $.wijmo.wijspread.Range(0, 0, 1, 1); var r = new $.wijmo.wijspread.Range(0, 0, 4, 1); sheet.fillDate(start,r, $.wijmo.wijspread.FillSeries.Column,$.wijmo.wijspread.FillDateUnit.Day, 2); start = new $.wijmo.wijspread.Range(0, 1, 1, 1); var r2 = new $.wijmo.wijspread.Range(0, 1, 4, 1); sheet.fillDate(start,r2, $.wijmo.wijspread.FillSeries.Column, $.wijmo.wijspread.FillDateUnit.Day, 1, new Date(2011, 2, 11)); start = new $.wijmo.wijspread.Range(0, 2, 1, 1); var r3 = new $.wijmo.wijspread.Range(0, 2, 4, 1); sheet.fillAuto(start,r3, $.wijmo.wijspread.FillSeries.Column); start = new $.wijmo.wijspread.Range(0, 3, 1, 1); var r4 = new $.wijmo.wijspread.Range(0, 3, 4, 1); sheet.fillGrowth(start,r4, $.wijmo.wijspread.FillSeries.Column, 2, 55); start = new $.wijmo.wijspread.Range(0, 4, 1, 1); var r5 = new $.wijmo.wijspread.Range(0, 4, 4, 1); sheet.fillLinear(start,r5, $.wijmo.wijspread.FillSeries.Column, 3, 20); remark: 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.
- Parameters:
- {$.wijmo.wijspread.Range} startRange
- The fill start range.
- {$.wijmo.wijspread.Range} wholeRange
- The fill whole range.
- {$.wijmo.wijspread.FillSeries} series
- The fill direction.
- {number} step
- The fill step value.
- {number} stop
- The fill stop value.
{number}
getActiveColumnIndex()
Gets the active column index for this sheet.
sheet.setActiveCell(5,5); alert(sheet.getActiveColumnIndex()); alert(sheet.getActiveRowIndex()); spread.bind($.wijmo.wijspread.Events.EnterCell, function (event, data) { alert(data.col); alert(data.row); }); spread.bind($.wijmo.wijspread.Events.LeaveCell, function (event, data) { alert(data.col); alert(data.row); });
- Returns:
- {number} The column index of the active cell.
{number}
getActiveRowIndex()
Gets the active row index for this sheet.
sheet.setActiveCell(5,5); alert(sheet.getActiveColumnIndex()); alert(sheet.getActiveRowIndex()); spread.bind($.wijmo.wijspread.Events.EnterCell, function (event, data) { alert(data.col); alert(data.row); }); spread.bind($.wijmo.wijspread.Events.LeaveCell, function (event, data) { alert(data.col); alert(data.row); });
- Returns:
- {number} The row index of the active cell.
{$.wijmo.wijspread.Style}
getActualStyle(row, column, sheetArea, sheetStyleOnly)
Gets the actual style information for a specified cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} column
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- {boolean} sheetStyleOnly
- If true, the row filter and the conditional format style are not applied to the return style; otherwise, the return style only contains the cell's inherited style.
- Returns:
- {$.wijmo.wijspread.Style} Returns the cell style of the specified cell.
{$.wijmo.wijspread.Cell}
getCell(row, col, sheetArea)
Gets the cell in the specified sheet area.
activeSheet.getCell(1,1).text("cell object");
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If you do not provide this parameter, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Cell} The cell.
{$.wijmo.wijspread.Cell}
getCells(row, col, row2, col2, sheetArea)
Gets a range of cells in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {number} row2
- The second row index.
- {number} col2
- The second column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If you do not provide this parameter, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Cell} The cells.
{$.wijmo.wijspread.Col}
getColumn(index, sheetArea)
Gets the specified column in the specified sheet area.
activeSheet.getColumn(3).width("60");
- Parameters:
- {number} index
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Col} The column.
{number}
getColumnCount(sheetArea)
Gets the column count in the specified sheet area.
for (var i = 0; i < sheet.getColumnCount(); i++) { sheet.setValue(1,i, i); } sheet.getRow(1).backColor("Gray"); sheet.getRow(1).foreColor("Red"); sheet.getRow(1).formatter("0.00"); sheet.getRow(1).borderBottom(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getRow(1).borderTop(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getRow(1).borderLeft(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getRow(1).borderRight( new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getRow(1).font("italic bold 12px/30px arial,sans-serif");
- Parameters:
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {number} The number of columns.
{$.wijmo.wijspread.HeaderAutoText}
getColumnHeaderAutoText()
Gets a value that indicates whether the column header displays letters or numbers or is blank.
- Returns:
- {$.wijmo.wijspread.HeaderAutoText} A value that indicates what the column header displays.
{number}
getColumnHeaderAutoTextIndex()
Gets which column header row displays the automatic text when there are multiple column header rows.
- Returns:
- {number} The row index of the column header that displays the automatic text.
{boolean}
getColumnHeaderVisible()
Gets a value that indicates whether the column header is visible.
- Returns:
- {boolean} true if the column header is visible; otherwise, false.
{boolean}
getColumnResizable(col, sheetArea)
Gets a value that indicates whether the user can resize a specified column in the specified sheet area.
sheet.setRowCount(10); sheet.setColumnCount(7); sheet.setValue(0, 0,"Western"); sheet.setValue(0, 1,"Western"); sheet.setValue(0, 2,"Western"); sheet.setValue(1, 0,"A"); sheet.setValue(1, 1,"B"); sheet.setValue(1, 2,"C"); sheet.setColumnResizable(0,true, $.wijmo.wijspread.SheetArea.colHeader); sheet.setRowResizable(0,true, $.wijmo.wijspread.SheetArea.rowHeader); alert( sheet.getColumnResizable(0)); alert( sheet.getRowResizable(0, $.wijmo.wijspread.SheetArea.rowHeader));
- Parameters:
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} true if the user can resize the specified column; otherwise, false.
{$.wijmo.wijspread.Col}
getColumns(index, index2, sheetArea)
Gets a range of columns in the specified sheet area.
- Parameters:
- {number} index
- The column index.
- {number} index2
- The second column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Col} The columns.
{boolean}
getColumnVisible(col, sheetArea)
Gets whether a column in the specified sheet area is displayed.
- Parameters:
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} true if the column is visible in the sheet area; otherwise, false.
{number}
getColumnWidth(col, sheetArea)
Gets the width in pixels for the specified column in the specified sheet area.
- Parameters:
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {number} The column width in pixels.
{$.wijmo.wijspread.ConditionalFormats}
getConditionalFormats()
Gets the conditional format for the sheet.
sheet.setValue(0,0, 1,3); sheet.setValue(1,0, 50,3); sheet.setValue(2,0, 100,3); sheet.setValue(3,0, 2,3); sheet.setValue(4,0, 60,3); sheet.setValue(5,0, 90,3); sheet.setValue(6,0, 3,3); sheet.setValue(7,0, 40,3); sheet.setValue(8,0, 70,3); sheet.setValue(9,0, 5,3); sheet.setValue(10,0, 35,3); sheet.addSelection(0,0,11,1); sheet.getConditionalFormats().add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());
- Returns:
- {$.wijmo.wijspread.ConditionalFormats} The conditional format for the sheet.
getCsv(row, column, rowCount, columnCount, rowDelimiter, columnDelimiter)
Gets delimited text from a range.
- Parameters:
- {number} row
- The start row.
- {number} column
- The start column.
- {number} rowCount
- The row count.
- {number} columnCount
- The column count.
- {string} rowDelimiter
- The row delimiter that is appended to the end of the row.
- {string} columnDelimiter
- The column delimiter that is appended to the end of the column.
getCustomFunction(name)
Gets the specified user-defined custom function.
- Parameters:
- {string} name
- The name of the user-defined custom function.
getCustomName(name)
Finds the specified custom name.
- Parameters:
- {string} name
- The custom name.
{string}
getDataColumnName(column)
Gets the column name at the specified position.
- Parameters:
- {number} column
- The column index for which the name is requested.
- Returns:
- {string} The column name for data binding.
getDataContext()
Gets the data context to bind.
{Array}
getDataItem(row)
Gets the data item.
- Parameters:
- {number} row
- The row index.
- Returns:
- {Array} The row data.
getDataSource()
Gets the data source that populates the sheet.
{$.wijmo.wijspread.DefaultDataValidator}
getDataValidator(row, col, sheetArea)
Gets the cell data validator.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.DefaultDataValidator} Returns the cell data validator for the specified cell.
getDefaultStyle(sheetArea)
Gets the default style information for the sheet.
- Parameters:
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
{string}
getFormatter(row, col, sheetArea)
Gets the cell formatter.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. iIf this parameter is not given, it will default to viewport.
- Returns:
- {string} Returns the cell formatter for the specified cell.
{string}
getFormula(row, col, sheetArea)
Gets the formula in the specified cell in this sheet.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {string} Returns the formula string.
{number}
getFrozenColumnCount()
Gets the number of frozen columns.
- Returns:
- {number} The number of frozen columns.
{number}
getFrozenRowCount()
Gets the number of frozen rows.
- Returns:
- {number} The number of frozen rows.
{object}
getGridlineOptions()
Gets the grid line's options.
- Returns:
- {object} The grid line options.
{boolean}
getIsProtected()
Gets a value that indicates whether cells on this sheet that are marked as protected cannot be edited.
- Returns:
- {boolean} A value that indicates whether cells on this sheet that are marked as protected cannot be edited.
{string}
getName()
Gets the name of this sheet.
- Returns:
- {string} The sheet name.
{$.wijmo.wijspread.Row}
getRow(index, sheetArea)
Gets the specified row in the specified sheet area.
activeSheet.getRow(2).height("60");
- Parameters:
- {number} index
- The row index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Row} The row.
{number}
getRowCount(sheetArea)
Gets the row count in the specified sheet area.
for (var i = 0; i < sheet.getRowCount(); i++) { sheet.setValue(i,1, i); } sheet.getColumn(1).backColor("Gray"); sheet.getColumn(1).foreColor("Red"); sheet.getColumn(1).formatter("0.00"); sheet.getColumn(1).borderBottom(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getColumn(1).borderTop(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getColumn(1).borderLeft(new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getColumn(1).borderRight( new $.wijmo.wijspread.LineBorder("Green", $.wijmo.wijspread.LineStyle.thin)); sheet.getColumn(1).font("italic bold 12px/30px arial,sans-serif");
- Parameters:
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {number} The number of rows.
{$.wijmo.wijspread.HeaderAutoText}
getRowHeaderAutoText()
Gets a value that indicates whether the row header displays letters or numbers or is blank.
- Returns:
- {$.wijmo.wijspread.HeaderAutoText} A value that indicates what the row header displays.
{number}
getRowHeaderAutoTextIndex()
Gets which row header column displays the automatic text when there are multiple row header columns.
- Returns:
- {number} The column index of the row header that displays the automatic text.
{boolean}
getRowHeaderVisible()
Gets a value that indicates whether the row header is visible.
- Returns:
- {boolean} true if the row header is visible; otherwise, false.
{boolean}
getRowHeight(row, sheetArea)
Gets the height using the specified unit type for the specified row in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} The row height in the specified units.
{boolean}
getRowResizable(row, sheetArea)
Gets a value that indicates whether users can resize the specified row in the specified sheet area.
sheet.setRowCount(10); sheet.setColumnCount(7); sheet.setValue(0, 0,"Western"); sheet.setValue(0, 1,"Western"); sheet.setValue(0, 2,"Western"); sheet.setValue(1, 0,"A"); sheet.setValue(1, 1,"B"); sheet.setValue(1, 2,"C"); sheet.setColumnResizable(0,true, $.wijmo.wijspread.SheetArea.colHeader); sheet.setRowResizable(0,true, $.wijmo.wijspread.SheetArea.rowHeader); alert( sheet.getColumnResizable(0)); alert( sheet.getRowResizable(0, $.wijmo.wijspread.SheetArea.rowHeader));
- Parameters:
- {number} row
- The row index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} true if the users can resize the specified row; otherwise, false.
{$.wijmo.wijspread.Row}
getRows(index, index2, sheetArea)
Gets a range of rows in the specified sheet area.
- Parameters:
- {number} index
- The row index.
- {number} index2
- The second row index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Row} The rows.
{boolean}
getRowVisible(row, sheetArea)
Gets whether the control displays the specified row.
- Parameters:
- {number} row
- The row index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} true if the row is visible in the sheet area; otherwise, false.
{object}
getSelections()
Gets the selections in the current sheet.
- Returns:
- {object} The selections.
{Array}
getSpans(range, sheetArea)
Gets the spans in the specified range in the specified sheet area.
sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.viewport); var spans =sheet.getSpans(); for(var i=0;i<spans.length;i++) { alert(spans[i].row.toString() + spans[i].col.toString()); }
- Parameters:
- {$.wijmo.wijspread.Range} range
- The cell range.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {Array} The span information.
{$.wijmo.wijspread.Sparkline}
getSparkline(row, col)
Gets the sparkline for the specified cell.
var cellr = new $.wijmo.wijspread.Range(0, 0, 1, 5); var ex = new $.wijmo.wijspread.SparklineSetting(); ex.SeriesColor = "Aquamarine"; sheet.setValue(0, 0, 2); sheet.setValue(0, 1, 5); sheet.setValue(0, 2, 4); sheet.setValue(0, 3, -1); sheet.setValue(0, 4, 3); sheet.setSparkline(0, 5, cellr, $.wijmo.wijspread.DataOrientation.Horizontal, $.wijmo.wijspread.SparklineType.column, ex); alert(sheet.getSparkline(0, 5).toString()); sheet.removeSparkline(0, 5);
- Parameters:
- {number} row
- The row.
- {number} col
- The column.
- Returns:
- {$.wijmo.wijspread.Sparkline} The sparkline for the cell.
{$.wijmo.wijspread.Style}
getStyle(row, column, sheetArea)
Gets the style information for a specified cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} column
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {$.wijmo.wijspread.Style} Returns the cell style of the specified cell.
{string}
getText(row, col, sheetArea)
Gets the formatted text in the cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {string} Returns the formatted text of the cell.
{object}
getValue(row, col, sheetArea)
Gets the unformatted data from the specified cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} col
- The col index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {object} Returns the value of the cell.
{number}
getViewportBottomRow(rowViewportIndex)
Gets the index of the bottom row in the viewport.
- Parameters:
- {number} rowViewportIndex
- The index of the row viewport.
- Returns:
- {number} The index of the bottom row in the viewport.
{number}
getViewportLeftColumn(columnViewportIndex)
Gets the index of the left column in the viewport.
- Parameters:
- {number} columnViewportIndex
- The index of the column viewport.
- Returns:
- {number} The index of the left column in the viewport.
{number}
getViewportRightColumn(columnViewportIndex)
Gets the index of the right column in the viewport.
- Parameters:
- {number} columnViewportIndex
- The index of the column viewport.
- Returns:
- {number} The index of the right column in the viewport.
{number}
getViewportTopRow(rowViewportIndex)
Gets the index of the top row in the viewport.
- Parameters:
- {number} rowViewportIndex
- The index of the row viewport.
- Returns:
- {number} The index of the top row in the viewport.
{$.wijmo.wijspread.SparklineGroup}
groupSparkline(sparklines)
Groups the sparklines.
sheet.setValue(0, 0, "Data Range is A2-A9"); sheet.setValue(1, 0, 1); sheet.setValue(2, 0, -2); sheet.setValue(3, 0, -1); sheet.setValue(4, 0, 6); sheet.setValue(5, 0, 4); sheet.setValue(6, 0, -4); sheet.setValue(7, 0, 3); sheet.setValue(8, 0, 8); var data = new $.wijmo.wijspread.Range(1, 0, 8, 1); var setting = new $.wijmo.wijspread.SparklineSetting(); var s1= sheet.setSparkline(13, 0, data , $.wijmo.wijspread.DataOrientation.Vertical , $.wijmo.wijspread.SparklineType.line , setting ); var s2 =sheet.setSparkline(13, 3, data , $.wijmo.wijspread.DataOrientation.Vertical , $.wijmo.wijspread.SparklineType.column , setting ); var s3= sheet.setSparkline(13, 6, data , $.wijmo.wijspread.DataOrientation.Vertical , $.wijmo.wijspread.SparklineType.winloss , setting ); var group = sheet.groupSparkline([s1,s2,s3]);
- Parameters:
- {Array} sparklines
- The sparklines to group.
- Returns:
- {$.wijmo.wijspread.SparklineGroup} The group.
{boolean}
hasFormula(row, col, sheetArea)
Gets whether there is a formula in the specified cell in this sheet.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- Returns:
- {boolean} true if the cell contains a formula; otherwise, false.
{object}
hitTest(x, y, forMove)
Performs a hit test.
- Parameters:
- {number} x
- The x-coordinate.
- {number} y
- The y-coordinate.
- {boolean} forMove
- true if the result is for move; otherwise, false.
- Returns:
- {object} The hit test information.
invalidateLayout()
Invalidates the sheet layout.
{number}
isColumnBound(column)
Gets whether the specified column is bound to a data source.
- Parameters:
- {number} column
- The column index.
- Returns:
- {number} true if the column is bound; otherwise, false.
{boolean}
isEditing()
Gets whether the sheet is in edit mode.
- Returns:
- {boolean} true if the sheet is in edit mode; otherwise, false.
{object}
isPaintSuspended(value)
Gets or sets a property that indicates whether to refresh manually or automatically
after changing Spread UI settings.
If the sheet's parent (a Spread or Canvas) exists, the sheet inherits this setting from the parent.
var cellrange =new $.wijmo.wijspread.Range(0, 0, 5, 1); var hideRowFilter =new $.wijmo.wijspread.HideRowFilter(sheet,cellrange); sheet.rowFilter(hideRowFilter); sheet.isPaintSuspended(false); sheet.repaint();
- Parameters:
- {boolean} value
- Whether to automatically refresh the UI.
- Returns:
- {object} If you call this function without a parameter, it returns a boolean indicating whether to automantically refresh or not. Otherwise, it returns the current Spread object.
{boolean}
isValid(row, column, value)
Determines whether the cell value is valid.
- Parameters:
- {number} row
- The row index.
- {number} column
- The column index.
- {object} value
- The cell value.
- Returns:
- {boolean} true if the value is valid; otherwise, false.
moveTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option)
Moves data from one range to another.
- Parameters:
- {number} fromRow
- The source row.
- {number} fromColumn
- The source column.
- {number} toRow
- The target row.
- {number} toColumn
- The target column.
- {number} rowCount
- The row count.
- {number} columnCount
- The column count.
- {$.wijmo.wijspread.CopyToOption} option
- The copy option.
recalcAll()
Recalculates all the formulas in the sheet.
{$.wijmo.wijspread.ReferenceStyle}
referenceStyle(value)
Gets or sets the style for cell and range references in cell formulas on this sheet.
- Parameters:
- {$.wijmo.wijspread.ReferenceStyle} value
- The reference style.
- Returns:
- {$.wijmo.wijspread.ReferenceStyle} The reference style.
removeCustomFunction(name)
Removes the specified user-defined custom function.
- Parameters:
- {string} name
- The name of the custom function to remove.
removeCustomName(name)
Removes a custom name from the custom name collection.
- Parameters:
- {string} name
- The custom name.
removeKeyMap(keyCode, ctrl, shift, alt, action)
Removes the shortcut key for the specified action.
- Parameters:
- {number} keyCode
- The unicode for the key.
- {boolean} ctrl
- true if the action uses the Ctrl key; otherwise, false.
- {boolean} shift
- true if the action uses the Shift key; otherwise, false.
- {boolean} alt
- true if the action uses the Alt key; otherwise, false.
- {ActionBase} action
- The action to remove.
removeSpan(row, col, sheetArea)
Removes the span that contains a specified anchor cell from a range of cells in the specified sheet area.
sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.viewport); var spans =sheet.getSpans(); for(var i=0;i<spans.length;i++) { sheet.removeSpan(spans[i].row,spans[i].col,$.wijmo.wijspread.SheetArea.viewport); }
- Parameters:
- {number} row
- The row index of the anchor cell for the span (at which spanned cells start).
- {number} col
- The column index of the anchor cell for the span (at which spanned cells start).
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
removeSparkline(row, col)
Removes the sparkline for the specified cell.
var cellr = new $.wijmo.wijspread.Range(0, 0, 1, 5); var ex = new $.wijmo.wijspread.SparklineSetting(); ex.SeriesColor = "Aquamarine"; sheet.setValue(0, 0, 2); sheet.setValue(0, 1, 5); sheet.setValue(0, 2, 4); sheet.setValue(0, 3, -1); sheet.setValue(0, 4, 3); sheet.setSparkline(0, 5, cellr, $.wijmo.wijspread.DataOrientation.Horizontal, $.wijmo.wijspread.SparklineType.column, ex); alert(sheet.getSparkline(0, 5).toString()); sheet.removeSparkline(0, 5);
- Parameters:
- {number} row
- The row.
- {number} col
- The column.
repaint(clipRect)
Repaints the specified rectangle.
var cellrange =new $.wijmo.wijspread.Range(0, 0, 5, 1); var hideRowFilter =new $.wijmo.wijspread.HideRowFilter(sheet,cellrange); sheet.rowFilter(hideRowFilter); sheet.isPaintSuspended(false); sheet.repaint();
- Parameters:
- {$.wijmo.wijspread.Rect} clipRect
- The rectangle to repaint.
reset()
Resets the worksheet.
resumeCalcService()
Resumes the calculation service.
resumeEvent()
Resumes the event.
{$.wijmo.wijspread.HideRowFilter}
rowFilter(value)
Gets or sets the row filter for the sheet.
activeSheet.rowFilter(new $.wijmo.wijspread.HideRowFilter(new UI.Range(1,1,10,3));
- Parameters:
- {$.wijmo.wijspread.HideRowFilter} value
- The row filter for the sheet.
- Returns:
- {$.wijmo.wijspread.HideRowFilter} The row filter for the sheet.
{$.wijmo.wijspread.SearchResult}
search(searchCondition)
Searches the specified content.
- Parameters:
- {$.wijmo.wijspread.SearchCondition} searchCondition
- The search condition.
- Returns:
- {$.wijmo.wijspread.SearchResult} The search result.
setActiveCell(row, col, rowViewportIndex, rowViewportIndex)
Sets the active cell for this sheet.
sheet.setActiveCell(5,5); alert(sheet.getActiveColumnIndex()); alert(sheet.getActiveRowIndex()); spread.bind($.wijmo.wijspread.Events.EnterCell, function (event, data) { alert(data.col); alert(data.row); }); spread.bind($.wijmo.wijspread.Events.LeaveCell, function (event, data) { alert(data.col); alert(data.row); });
- Parameters:
- {number} row
- The row index of the cell.
- {number} col
- The column index of the cell.
- {number} rowViewportIndex
- The row viewport index of cell.
- {number} rowViewportIndex
- The column viewport index of cell.
setBorder(cellRange, border, option, sheetArea)
Sets the border for the specified area.
sheet.getCell(1, 1).borderTop(new $.wijmo.wijspread.LineBorder("#F0F8FF",$.wijmo.wijspread.LineStyle.double)); sheet.getCell(1, 1).borderLeft(new $.wijmo.wijspread.LineBorder("#F0F8FF",$.wijmo.wijspread.LineStyle.hair)); sheet.getCell(1, 1).borderRight(new $.wijmo.wijspread.LineBorder("#FAEBD7",$.wijmo.wijspread.LineStyle.dashDot)); sheet.getCell(1, 1).borderBottom(new $.wijmo.wijspread.LineBorder("#00FFFF",$.wijmo.wijspread.LineStyle.medium)); var r = new $.wijmo.wijspread.Range(2, 2, 2, 2); sheet.setBorder(r, new $.wijmo.wijspread.LineBorder("#7FFFD4",$.wijmo.wijspread.LineStyle.medium), {all:true},3); sheet.getColumn(5).borderTop(new $.wijmo.wijspread.LineBorder("#F0FFFF",$.wijmo.wijspread.LineStyle.medium)); sheet.getColumn(5).borderLeft(new $.wijmo.wijspread.LineBorder("#F5F5DC",$.wijmo.wijspread.LineStyle.medium)); sheet.getColumn(5).borderRight(new $.wijmo.wijspread.LineBorder("#FF02FF", $.wijmo.wijspread.LineStyle.dashDot)); sheet.getColumn(5).borderBottom (new $.wijmo.wijspread.LineBorder("#FFE4C4",$.wijmo.wijspread.LineStyle.thin)); sheet.setBorder(r, new $.wijmo.wijspread.LineBorder("#8A2BE2",$.wijmo.wijspread.LineStyle.thick), { all:true },3); sheet.getRow(5).borderTop( new $.wijmo.wijspread.LineBorder("#A52A2A",$.wijmo.wijspread.LineStyle.mediumDashed)); sheet.getRow(5).borderLeft( new $.wijmo.wijspread.LineBorder("#FF02FF",$.wijmo.wijspread.LineStyle.medium)); sheet.getRow(5).borderRight(new $.wijmo.wijspread.LineBorder("#5F9EA0", $.wijmo.wijspread.LineStyle.dashDot)); sheet.getRow(5).borderBottom (new $.wijmo.wijspread.LineBorder("#6495ED",$.wijmo.wijspread.LineStyle.dotted));
- Parameters:
- {$.wijmo.wijspread.Range} cellRange
- The cell area.
- {$.wijmo.wijspread.LineBorder} border
- The border line.
- {object} option
- Determines which part of the cell range to set. For example, {all:true}, {left:true, right:true}. option.all: boolean type, specifies all directions for the border. option.left: boolean type, specifies the left border. option.top: boolean type, specifies the top border. option.right: boolean type, specifies the right border. option.bottom: boolean type, specifies the bottom border. option.outline: boolean type, specifies the left, top, right, and bottom borders. option.inside: boolean type, specifies the inner horizontal and vertical borders. option.innerHorizontal: boolean type, specifies the horizontal border. option.innerVertical: boolean type, specifies the vertical border.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area.
setColumnCount(colCount, sheetArea)
Sets the column count in the specified sheet area.
sheet.setRowCount(4,1); sheet.setColumnCount(4,2); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.colHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.rowHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.viewport);
- Parameters:
- {number} colCount
- The column count.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setColumnHeaderAutoText(autoText)
Sets a value that indicates whether the column header displays letters or numbers or is blank.
activeSheet.setColumnHeaderAutoText($.wijmo.wijspread.HeaderAutoText.numbers);
- Parameters:
- {$.wijmo.wijspread.HeaderAutoText} autoText
- A value that indicates what the column header displays.
setColumnHeaderAutoTextIndex(autoTextIndex)
Sets which column header row displays the automatic text when there are multiple column header rows.
activeSheet.setRowCount(3, $.wijmo.wijspread.SheetArea.colHeader); activeSheet.setColumnHeaderAutoTextIndex(1);
- Parameters:
- {number} autoTextIndex
- The row index of the column header that displays the automatic text.
setColumnHeaderVisible(visible)
Sets a value that indicates whether the column header is visible.
activeSheet.setColumnHeaderVisible(false);
- Parameters:
- {boolean} visible
- Whether the column header is visible.
setColumnResizable(col, value, sheetArea)
Sets whether users can resize the specified column in the specified sheet area.
sheet.setRowResizable(3,false,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnResizable(3,false,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(1,$.wijmo.wijspread.SheetArea.viewport).resizable(false); sheet.getColumn(1,$.wijmo.wijspread.SheetArea.viewport).resizable(false);
- Parameters:
- {number} col
- The column index.
- {boolean} value
- Set to true to allow users to resize the column.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setColumnVisible(col, value, sheetArea)
Sets whether a column in the specified sheet area is displayed.
- Parameters:
- {number} col
- The column index.
- {boolean} value
- Set to true to display the column.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setColumnWidth(col, value, sheetArea)
Sets the width using the specified unit type for the specified column in the specified sheet area.
sheet.setValue(0, 0, "value"); sheet.addRows(0, 2); sheet.addColumns(0, 2); sheet.setRowHeight(0, 50.0,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnWidth(0, 150.0,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(0).backColor("Gray"); sheet.getColumn(0).backColor ("Brown");
- Parameters:
- {number} col
- The column index.
- {number} value
- The width.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setCsv(row, column, text, rowDelimiter, columnDelimiter, flags)
Sets delimited text (CSV) in the sheet.
- Parameters:
- {number} row
- The start row.
- {number} column
- The start column.
- {string} text
- The delimited text.
- {string} rowDelimiter
- The row delimiter.
- {string} columnDelimiter
- The column delimiter.
- {$.wijmo.wijspread.TextFileOpenFlags} flags
- The import flags.
setDataContext(datacontext)
Sets the data context to bind.
- Parameters:
- {object} datacontext
- The data context.
setDataSource(data, reset)
Sets the data source that populates the sheet.
var test = [ {"Series0":2,"Series1":1}, {"Series0":4,"Series1":2}, {"Series0":3,"Series1":4} ]; sheet.autoGenerateColumns=true; sheet.setDataSource(test, true);
- Parameters:
- {object} data
- The data source.
- {boolean} reset
- true if the sheet is reset; otherwise, false.
setDataValidator(row, col, value, sheetArea)
Sets the cell data validator.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.DefaultDataValidator} value
- The data validator.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setDefaultStyle(style, sheetArea)
Sets the default style information for the sheet.
- Parameters:
- style
- The style to set.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setFormatter(row, col, value, sheetArea)
Sets the cell formatter.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {string} value
- The formatter string.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setFormula(row, col, value, sheetArea)
Sets a formula in a specified cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {string} value
- The formula to place in the specified cell.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setFrozenCount(rowCount, colCount)
Sets the frozen row count and frozen column count.
sheet.setRowCount(10); sheet.setColumnCount(8); sheet.setFrozenCount(1,1);
- Parameters:
- {number} rowCount
- The number of rows to freeze.
- {number} colCount
- The number of columns to freeze.
setGridlineOptions(options)
Sets the grid line's options.
activeSheet.setGridlineOptions({color:"red", showVerticalGridline: true, showHorizontalGridline: false});
- Parameters:
- {object} options
- The grid line options.
setIsProtected(isProtected)
Sets a value that indicates whether cells on this sheet that are marked as protected cannot be edited.
activeSheet.setIsProtected(true);
- Parameters:
- {boolean} isProtected
- A value that indicates whether cells on this sheet that are marked as protected cannot be edited.
setName(name)
Sets the name of this sheet.
- Parameters:
- {string} name
- The sheet name.
setRowCount(rowCount, sheetArea)
Sets the row count in the specified sheet area.
sheet.setRowCount(4,1); sheet.setColumnCount(4,2); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.colHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.rowHeader); sheet.addSpan(0,0,3,3,$.wijmo.wijspread.SheetArea.viewport);
- Parameters:
- {number} rowCount
- The row count.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setRowHeaderAutoText(autoText)
Sets a value that indicates whether the row header displays letters or numbers or is blank.
activeSheet.setRowHeaderAutoText($.wijmo.wijspread.HeaderAutoText.letters);
- Parameters:
- {$.wijmo.wijspread.HeaderAutoText} autoText
- A value that indicates what the row header displays.
setRowHeaderAutoTextIndex(autoTextIndex)
Sets which row header column displays the automatic text when there are multiple row header columns.
activeSheet.setColumnCount(3, $.wijmo.wijspread.SheetArea.rowHeader); activeSheet.setRowHeaderAutoTextIndex(1);
- Parameters:
- {number} autoTextIndex
- The column index of the row header that displays the automatic text.
setRowHeaderVisible(visible)
Sets a value that indicates whether the row header is visible.
activeSheet.setRowHeaderVisible(false);
- Parameters:
- {boolean} visible
- Whether the row header is visible.
setRowHeight(row, value, sheetArea)
Sets the height using the specified unit type for the specified row in the specified sheet area.
sheet.setValue(0, 0, "value"); sheet.addRows(0, 2); sheet.addColumns(0, 2); sheet.setRowHeight(0, 50.0,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnWidth(0, 150.0,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(0).backColor("Gray"); sheet.getColumn(0).backColor ("Brown");
- Parameters:
- {number} row
- The row index.
- {number} value
- The height.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setRowResizable(row, value, sheetArea)
Sets whether users can resize the specified row in the specified sheet area.
sheet.setRowResizable(3,false,$.wijmo.wijspread.SheetArea.viewport); sheet.setColumnResizable(3,false,$.wijmo.wijspread.SheetArea.viewport); sheet.getRow(1,$.wijmo.wijspread.SheetArea.viewport).resizable(false); sheet.getColumn(1,$.wijmo.wijspread.SheetArea.viewport).resizable(false);
- Parameters:
- {number} row
- The row index.
- {boolean} value
- Set to true to let the users resize the specified row.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setRowVisible(row, value, sheetArea)
Sets whether the control displays the specified row in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {boolean} value
- Set to true to display the specified row.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setStyle(row, column, value, sheetArea)
Sets the style information for a specified cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} column
- The column index.
- {$.wijmo.wijspread.Style} value
- The cell style.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setText(row, col, value, sheetArea)
Sets the formatted text in the cell in the specified sheet area.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {object} value
- The text for the specified cell.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
setValue(row, col, value, sheetArea, ignoreRecalc)
Sets the value for the specified cell in the specified sheet area.
sheet.setValue(0,2,"ColumnHeader", $.wijmo.wijspread.SheetArea.colHeader); sheet.setValue(2,0,"RowHeader", $.wijmo.wijspread.SheetArea.rowHeader); sheet.setValue(2,0,"viewport", $.wijmo.wijspread.SheetArea.viewport);
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {object} value
- The value to set for the specified cell.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If this parameter is not given, it will default to viewport.
- {boolean} ignoreRecalc
- Whether to ignore recalculate or not.
showCell(row, col, verticalPosition, horizontalPosition)
Moves the view of a cell to the specified position in the viewport.
- Parameters:
- {number} row
- The row index.
- {number} col
- The column index.
- {$.wijmo.wijspread.VerticalPosition} verticalPosition
- The vertical position in which to display the cell.
- {$.wijmo.wijspread.HorizontalPosition} horizontalPosition
- The horizontal position in which to display the cell.
showColumn(col, horizontalPosition)
Moves the view of a column to the specified position in the viewport.
- Parameters:
- {number} col
- The column index.
- {$.wijmo.wijspread.HorizontalPosition} horizontalPosition
- The horizontal position in which to display the column.
showRow(row, verticalPosition)
Moves the view of a row to the specified position in the viewport.
- Parameters:
- {number} row
- The row index.
- {$.wijmo.wijspread.HorizontalPosition} verticalPosition
- The vertical position in which to display the row.
{boolean}
sortRange(row, column, rowCount, columnCount, byRows, sortInfo)
Sorts a range of cells in this sheet in the data model.
sheet.setValue(0,0,"112"); sheet.setValue(1,0,"10"); sheet.setValue(2,0,"223"); sheet.setValue(3,0,"20"); sheet.setValue(4,0,"334"); sheet.setValue(5,0,"30"); sheet.sortRange(0, 0, 6, 1, true, [ {index:0, ascending:true} ]);
- Parameters:
- {number} row
- The index of the starting row of the block of cells to sort.
- {number} column
- The index of the starting column of the block of cells to sort.
- {number} rowCount
- The number of rows in the block of cells.
- {number} columnCount
- The number of columns in the block of cells.
- {boolean} byRows
- Set to true to sort by rows; false to sort by columns.
- {Array} sortInfo
- The SortInfo object with sort criteria and information about how to perform the sort. For example, [{index:0,ascending:true}] sortInfo.index: number type, The index of the column or row on which to sort. sortInfo.ascending: boolean type, whether the sort order is ascending.
- Returns:
- {boolean} true if the data is successfully sorted; otherwise, false.
startEdit(selectAll, defaultText)
Starts to edit the cell.
- Parameters:
- {boolean} selectAll
- true if the editing selects all the text in the cell; otherwise, false.
- {string} defaultText
- The default text to display while editing the cell.
suspendCalcService()
Suspends the calculation service.
suspendEvent()
Suspends the event.
unbind(type, fn)
Removes the binding of an event to the sheet.
- Parameters:
- {$.wijmo.wijspread.Events} type
- The event type.
- {object} fn
- Specifies the function for which to remove the binding.
unbindAll()
Removes the binding of all events to the sheet.
undoManager()
Gets the undo manager.
ungroupSparkline(group)
Ungroups the sparklines in the specified group.
- Parameters:
- {$.wijmo.wijspread.SparklineGroup} group
- The group.
zoom(factor)
Zooms the view of the control.
spread.allowUserZoom = false; sheet.zoom(3);
- Parameters:
- {number} factor
- The zoom factor.