Aspose.Cells FOSS for TypeScript API Reference

API reference for Aspose.Cells FOSS for TypeScript v1.0.0. 108 public types organized by module.

Core API

Class	Description
`AllConnectorShapeInfo`	Class in the Cells TYPESCRIPT API.
`AllShapeInfo`	Class in the Cells TYPESCRIPT API.
`ArrowShapeType`	ArrowShapeType enumerates the possible visual styles for arrow shapes, supporting consistent rendering across exported documents.
`AutoFilter`	AutoFilter.clear() removes all filter column definitions from the AutoFilter instance.
`BasicShapeInfoType`	BasicShapeInfoType enables developers to specify the fundamental type of a shape in a worksheet.
`BasicShapeSubType`	BasicShapeSubType represents a more detailed categorization of basic shapes for advanced diagramming.
`BentConnectorShapeType`	BentConnectorShapeType enumeration defines the possible geometric configurations for bent connectors, such as straight, elbow, or curved variants.
`BraceShapeType`	Class in the Cells TYPESCRIPT API.
`Cell`	Cell constructor(row, col, value?) creates a cell positioned at the given row and column, optionally initializing its value.
`CellValue`	Class in the Cells TYPESCRIPT API.
`CellValue`	Class in the Cells TYPESCRIPT API.
`Cells`	Class with 6 methods and 1 property.
`Chart`	Chart.setPositionWithOffset lets you position a chart using absolute pixel offsets and explicit height and width values.
`ChartCollection`	ChartCollection.length and ChartCollection.count both expose the total number of charts stored in the collection.
`ChartLoader`	ChartLoader.loadCharts(filePath) asynchronously reads a spreadsheet file and returns a Promise that resolves to an array of ChartInfo objects representing each chart in the file.
`ChartRenderer`	ChartRenderer.renderChart(chart, worksheet) generates an SVG string representation of the supplied ChartInfo placed into the given worksheet context.
`ChartType`	ChartType is used to specify the kind of chart (e.g., bar, line) when creating a chart object.
`CircleVariantShapeType`	Class in the Cells TYPESCRIPT API.
`Comment`	Class with 2 methods and 7 properties.
`CommentCollection`	Class with 6 methods and 1 property.
`ConditionalFormat`	Class with 5 methods.
`ConditionalFormatCollection`	ConditionalFormatCollection enables applying multiple conditional formatting rules across cell ranges, allowing visual data cues such as color scales.
`CurvedConnectorShapeType`	Class in the Cells TYPESCRIPT API.
`DOMParser`	DOMParser.parseFromString(xml, type) parses an XML string and returns a Document object for further manipulation.
`DataRelationship`	DataRelationship.worksheetRels(sheetIndex) returns the relationship XML string for the specified worksheet.
`DataValidation`	DataValidation objects let you specify validation rules, including type, operator, two formulas, and UI options like allowBlank, showDropDown, and custom messages.
`DataValidationCollection`	DataValidationCollection.add() creates a new DataValidation object that can be configured and added to a worksheet.
`EllipseShapeType`	Class in the Cells TYPESCRIPT API.
`ExpDrawing`	ExpDrawing.generateGuid() returns a new GUID string that can be used as a unique identifier for drawing elements.
`HtmlDocument`	HtmlDocument.load(filePath) asynchronously reads an HTML file and resolves to an HtmlDocument instance.
`HtmlExporter`	HtmlExporter can convert a Workbook into an HTML frameset or generate HTML for an individual worksheet, supporting web‑based presentation of spreadsheet data.
`HtmlReader`	Class with 9 methods and 6 properties.
`HtmlTable`	HtmlTable.parse(html, cssClasses) parses a single HTML table string into an HtmlTable object, applying optional CSS class filters.
`HtmlWriter`	Class with 2 methods.
`Hyperlink`	Hyperlink support lets you add, retrieve, and serialize cell hyperlinks within worksheets via the Hyperlink and HyperlinkCollection classes.
`HyperlinkCollection`	HyperlinkCollection.add(row, col, address, display, tooltip) creates a new Hyperlink object attached to a specific cell.
`ImpDrawing`	Class with 1 method and 5 properties.
`LineShapeType`	Class in the Cells TYPESCRIPT API.
`MathSymbolShapeType`	Class in the Cells TYPESCRIPT API.
`PolygonShapeType`	Class in the Cells TYPESCRIPT API.
`QuadrilateralShapeType`	Class in the Cells TYPESCRIPT API.
`RectangleShapeType`	Class in the Cells TYPESCRIPT API.
`RectangleVariantShapeType`	Class in the Cells TYPESCRIPT API.
`SealShapeType`	Class in the Cells TYPESCRIPT API.
`Shape3DType`	Class in the Cells TYPESCRIPT API.
`SpecialShapeType`	Class in the Cells TYPESCRIPT API.
`StarShapeType`	Class in the Cells TYPESCRIPT API.
`StraightConnectorShapeType`	Class in the Cells TYPESCRIPT API.
`Style`	Style objects let developers define cell appearance, including font, fill, border, alignment, number format, and protection settings.
`TriangleShapeType`	Class in the Cells TYPESCRIPT API.
`Workbook`	The Workbook class provides a high‑level entry point to load existing spreadsheet files, manipulate worksheets, and save to formats such as XLSX and HTML.
`Worksheet`	Class with 24 methods and 23 properties.
`WorksheetCollection`	WorksheetCollection offers collection‑wide operations such as adding, removing, moving worksheets, and applying shared styles across the workbook.

Interfaces

Interface	Description
`Alignment`	Alignment class provides horizontal, vertical, and wrapText properties to control text alignment within a cell style.
`ArrowShapeInfo`	ArrowShapeInfo.type holds a value from the ArrowShapeType enumeration that specifies the arrow’s visual style.
`AxisInfo`	AxisInfo provides comprehensive axis configuration for charts, allowing control over position, labels, tick marks, and scaling.
`BentConnectorShapeInfo`	BentConnectorShapeInfo.type property specifies the connector’s shape type using the BentConnectorShapeType enumeration.
`Border`	Border.left, Border.right, Border.top, and Border.bottom properties return the individual border definitions for a cell.
`BorderLine`	BorderLine objects expose a style property and a color property to define the line style and its color for a cell border edge.
`BraceShapeInfo`	BraceShapeInfo provides a read‑only `type` property indicating the shape of a brace, represented by the `BraceShapeType` enumeration.
`CellCoordinates`	CellCoordinates.row and .col expose zero‑based row and column indices of a cell location.
`CellCoordinates`	CellCoordinates.row and .col expose zero‑based row and column indices of a cell location.
`CellRange`	CellRange.startRow, startCol, endRow, and endCol define the rectangular area of a cell range.
`CellRange`	CellRange.startRow, startCol, endRow, and endCol define the rectangular area of a cell range.
`CellStyle`	CellStyle lets you define alignment, font, colors, and borders for individual cells, supporting rich formatting of spreadsheet content.
`ChartArea`	Interface with 4 properties.
`ChartInfo`	ChartInfo provides a read‑only snapshot of a chart’s configuration, including type, title, series, legend position, axis positions, plot area, and dimensions.
`ChartSeries`	Interface with 3 properties.
`CircleVariantShapeInfo`	CircleVariantShapeInfo exposes a `type` property that identifies the specific circle variant shape used in a drawing.
`ColorScaleRule`	ColorScaleRule lets developers define a three‑color gradient for conditional formatting using `minColor`, `midColor`, and `maxColor` properties.
`Comment`	Interface with 4 properties.
`ConditionalFormatRule`	The ConditionalFormatRule class lets you define conditional formatting by specifying its type, formulas, operator, style, color scale, icon set, or data bar.
`CurvedConnectorShapeInfo`	Interface with 3 properties.
`DataBarRule`	Interface with 4 properties.
`DataValidation`	DataValidation objects let you specify validation rules, including type, operator, two formulas, and UI options like allowBlank, showDropDown, and custom messages.
`EllipseShapeInfo`	Interface with 1 property.
`Fill`	Interface with 3 properties.
`FilterColumn`	FilterColumn objects describe a single filter column with the column index (col), an array of filter values (filters), and an optional blank flag.
`Font`	The Font class provides properties to style text, including name, size, bold, italic, underline, color, and strikeout.
`HtmlParseOptions`	Interface with 2 properties.
`HtmlSaveOptions`	HtmlSaveOptions includes the boolean property includeStyles to control whether CSS styles are embedded in the exported HTML.
`Hyperlink`	Hyperlink support lets you add, retrieve, and serialize cell hyperlinks within worksheets via the Hyperlink and HyperlinkCollection classes.
`IconSetRule`	Interface with 2 properties.
`ImageInfo`	Interface with 5 properties.
`LegendInfo`	Interface with 2 properties.
`LineShapeInfo`	Interface with 3 properties.
`MathSymbolShapeInfo`	Interface with 1 property.
`PictureInfo`	PictureInfo properties row and col indicate the cell position where the picture is anchored in the worksheet.
`PictureShapeInfo`	Interface with 2 properties.
`PlotArea`	Interface with 4 properties.
`PolygonShapeInfo`	Interface with 1 property.
`Protection`	Protection class properties locked and hidden control cell‑level protection settings when applied to a style.
`QuadrilateralShapeInfo`	QuadrilateralShapeInfo exposes a type property that must be set to a value from QuadrilateralShapeType to define the specific quadrilateral shape.
`RectangleShapeInfo`	RectangleShapeInfo.type lets developers choose a rectangle variant using the RectangleShapeType enumeration.
`RectangleVariantShapeInfo`	RectangleVariantShapeInfo.type provides access to the RectangleVariantShapeType enumeration for defining variant rectangle shapes.
`SealShapeInfo`	SealShapeInfo.type allows a seal shape to be specified via the SealShapeType enumeration.
`SeriesInfo`	SeriesInfo stores chart series metadata, including the series `name`, display `color`, and data `values` array.
`Shape3DInfo`	Shape3DInfo.type lets developers assign a three‑dimensional shape using the Shape3DType enumeration.
`ShapeAnchor`	ShapeAnchor provides fine‑grained placement data (column/row indices, offsets, and absolute X/Y transformation values) for any shape.
`ShapeFill`	ShapeFill describes how a shape is painted, supporting solid colors, scheme colors, gradient stops, gradient angle, and luminance adjustments.
`ShapeInfo`	ShapeInfo aggregates common shape metadata—including name, type, and cell‑based anchor coordinates—so a shape can be positioned relative to worksheet cells.
`SpecialShapeInfo`	SpecialShapeInfo.type provides access to the SpecialShapeType enumeration for defining special‑purpose shapes.
`StarShapeInfo`	StarShapeInfo.type enables selection of a star shape using the StarShapeType enumeration.
`StraightConnectorShapeInfo`	StraightConnectorShapeInfo.type together with the boolean flags hasArrowStart and hasArrowEnd lets developers create connector lines with optional arrowheads at either end.
`Style`	Style objects let developers define cell appearance, including font, fill, border, alignment, number format, and protection settings.
`TriangleShapeInfo`	Interface with 1 property.

Enumerations

Enumeration	Description
`EncryptionType`	Enum with 1 member.
`SaveFormat`	SaveFormat enum provides the set of file formats that can be used with Workbook.save: XLSX, CSV, JSON, MARKDOWN, and HTML.

Aspose.Cells FOSS for TypeScript API Reference

Core API

Interfaces

Enumerations

See Also