Worksheet
Overview
Worksheet is a class in Aspose.Cells FOSS for TypeScript.
This class declares 24 methods for Worksheet objects in TypeScript programs.
Available methods include: addComment, addConditionalFormat, addDataValidation, addHyperlink, addImage, addShape, constructor, getCell, getCell2, getCellByRef, getColumnWidth, getRowHeight, and 12 additional methods.
Public members are accessible to any TypeScript application after installing the Aspose.Cells FOSS for TypeScript package.
Properties: autoFilter, cell, cells, charts, comments, conditionalFormats, and 17 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
cell | : string | Read | Gets the cell. |
link | : Hyperlink | Read | Gets the link. |
startRow | : number | Read | Gets the start row. |
startCol | : number | Read | Gets the start col. |
endRow | : number | Read | Gets the end row. |
endCol | : number | Read | Gets the end col. |
range | : string | Read | Gets the range. |
rules | : ConditionalFormatRule[] | Read | Gets the rules. |
name | string | Read/Write | Gets the name. |
index | number | Read | Gets the index. |
cells | `` | Read | Gets the cells. |
value | CellValue | undefined | Read/Write | Gets the value. |
dataValidations | `` | Read | Gets the data validations. |
comments | `` | Read | Gets the comments. |
hyperlinks | `` | Read | Gets the hyperlinks. |
autoFilter | `` | Read | Gets the auto filter. |
conditionalFormats | `` | Read | Gets the conditional formats. |
mergedCells | `` | Read | Gets the merged cells. |
defaultColumnWidth | number | undefined | Read/Write | Gets the default column width. |
defaultRowHeight | number | undefined | Read/Write | Gets the default row height. |
shapes | ShapeInfo[] | Read | Gets the shapes. |
charts | ChartCollection | Read | Gets the charts. |
images | ImageInfo[] | Read | Gets the images. |
Methods
| Signature | Description |
|---|---|
constructor(name: string, index: number) | Calls constructor(name, index) on this Worksheet instance. |
getCell(row: number, col: number) → Cell | undefined | Calls getCell(row, col) on this Worksheet instance. |
getCellByRef(ref: string) → Cell | undefined | Calls getCellByRef(ref) on this Worksheet instance. |
getCell2(key: string) → Cell | Calls getCell2(key) on this Worksheet instance. |
putValue(key: string, value: CellValue) → Cell | Calls putValue(key, value) on this Worksheet instance. |
addDataValidation(validation: DataValidation, range: string) | Calls addDataValidation(validation, range) on this Worksheet instance. |
addComment(comment: Comment) | Calls addComment(comment) on this Worksheet instance. |
addHyperlink(cellRef: string, hyperlink: Hyperlink) | Calls addHyperlink(cellRef, hyperlink) on this Worksheet instance. |
setAutoFilter(range: string) | Sets the auto filter value. |
removeAutoFilter() | Calls removeAutoFilter on this Worksheet instance. |
addConditionalFormat(range: string, rules: ConditionalFormatRule[]) | Calls addConditionalFormat(range, rules) on this Worksheet instance. |
mergeCells(range: string) | Calls mergeCells(range) on this Worksheet instance. |
unmergeCells(range: string) | Calls unmergeCells(range) on this Worksheet instance. |
setColumnWidth(column: number, width: number) | Sets the column width value. |
getColumnWidth(column: number) → number | undefined | Calls getColumnWidth(column) on this Worksheet instance. |
setRowHeight(row: number, height: number) | Sets the row height value. |
getRowHeight(row: number) → number | undefined | Calls getRowHeight(row) on this Worksheet instance. |
setRowHidden(row: number, hidden: boolean) | Sets the row hidden value. |
isRowHidden(row: number) → boolean | Calls isRowHidden(row) on this Worksheet instance. |
setCellStyle(cellRef: string, style: any) | Sets the cell style value. |
addShape(shape: ShapeInfo) | Calls addShape(shape) on this Worksheet instance. |
addImage(image: ImageInfo) | Calls addImage(image) on this Worksheet instance. |
toXml(drawingIndex: number) → string | Calls toXml(drawingIndex) on this Worksheet instance. |
getXml(drawingIndex: number) → string | Calls getXml(drawingIndex) on this Worksheet instance. |
