API reference ​
Every symbol below is re-exported from the package root and generated straight from its TypeScript declaration, so the types are the contract.
- Addresses & ranges:
CellAddress,CellPosition,columnToNumber,decodeAddress,decodeRange,encodeAddress,GridRect,MAX_COLUMN,MAX_ROW,numberToColumn,RangeAddress - Grid limits:
INVALID_SHEET_NAME_CHARS,MAX_COLUMN_WIDTH,MAX_ROW_HEIGHT,MAX_SHEET_NAME_LENGTH,MAX_TABLE_NAME_LENGTH,TABLE_NAME_PATTERN - Text metrics:
estimateWrappedLines - Cell values:
ArrayFormulaValue,CellValue,cellValueToText,coerceCellValue,DataTableFormulaValue,detectValueType,ERROR_CODES,ErrorCode,ErrorValue,FormulaResult,FormulaValue,isArrayFormulaValue,isDataTableFormulaValue,isErrorCode,isErrorValue,isFormulaValue,isRichTextValue,isSharedFormulaValue,RichTextRun,richTextToPlain,RichTextValue,SharedFormulaValue,ValueType - Cell:
Cell - Workbook:
AddImageOptions,AddWorksheetOptions,DEFAULT_WORKBOOK_VIEW,DefinedName,PreservedTheme,PreservedWorkbookReference,Workbook,WorkbookProperties,WorkbookView - Worksheet:
CellModel,ColumnProperties,isVisibility,OutlineProperties,RowInput,RowProperties,SheetView,Visibility,Worksheet,WorksheetModel,WorksheetProperties,WorksheetState - Styles:
Alignment,Border,BorderEdge,BorderStyle,CellContent,CellStyle,Color,Fill,FillPatternType,Font,FontScheme,FontVerticalAlignment,GradientFill,GradientStop,HorizontalAlignment,isBorderStyle,isFillPatternType,isFontScheme,isFontVerticalAlignment,isHorizontalAlignment,isNamedUnderlineStyle,isVerticalAlignment,PatternFill,Protection,UnderlineStyle,VerticalAlignment - Tables:
isTotalsRowFunction,Table,TableColumn,TableColumnStyle,TableGrid,TableOptions,TableRegion,TableStyleInfo,TotalsRowFunction - Pivot tables:
isDeclarablePivotSourceKind,ParsedPivotField,ParsedPivotSource,ParsedPivotTable,PivotCacheField,PivotItem,PivotMetric,PivotNumericSummary,PivotRecordCell,PivotSourceKind,PivotTable,PivotTableOptions - Images:
AnchoredImage,AnchorPoint,Extent,ImageAnchor,ImageCrop,ImageEditAs,ImageHyperlink,isImageEditAs,isOneCellAnchor,OneCellAnchor,PictureProperties,PortableImage,PX_TO_EMU,TwoCellAnchor,WorkbookImage,WorksheetImages - Protection:
SheetProtection,SheetProtectionCredential,SheetProtectionFlags,SheetProtectionOptions,WorkbookProtection,WorkbookProtectionCredentialAttr - Reading .xlsx:
readXlsx - Streaming reads:
readSheetRows,ReadSheetRowsOptions,readWorkbookStream - Writing .xlsx:
WriteOptions,writeXlsx,writeXlsxAsync - Streaming writes:
CalcProperties,StreamedRow,WorkbookStreamWriter,WorkbookStreamWriterOptions,WorksheetStreamWriter - CSV:
CsvEncoding,CsvReadOptions,CsvWriteOptions,readCsv,writeCsv,writeCsvText - Autofilter:
AutoFilter,CustomFilter,CustomFilterOperator,CustomFilterPredicate,FilterColumn,FilterCriteria,isCustomFilterOperator,ValuesFilter - Axis Handle:
AxisHandle - Color Resolution:
applyTint,ColorResolutionContext,DEFAULT_INDEXED_COLORS,resolveColor,SYSTEM_INDEXED_COLORS - Column:
Column - Comment Thread:
Comment,CommentThread,Mention,MentionRef,Person - Conditional Formatting:
CfIcon,CfIconSetType,CfTimePeriod,CfValueObject,CfValueObjectType,ConditionalFormatting,ConditionalFormattingOperator,ConditionalFormattingRule,ConditionalFormattingType,DataBarAxisPosition,DataBarDirection,IconSetType,isCfIconSetType,isCfTimePeriod,isCfValueObjectType,isConditionalFormattingOperator,isConditionalFormattingType,isDataBarAxisPosition,isDataBarDirection,isIconSetType - Csv Errors:
CsvParseError - Customui Errors:
CustomUiParseError - Customui Ribbon:
CUSTOMUI_2006_NAMESPACE,CUSTOMUI_2007_REL_TYPE,CUSTOMUI_2009_NAMESPACE,CUSTOMUI_2010_REL_TYPE,CustomUiDocument,isCustomUiRelType,parseCustomUi,Ribbon,RibbonControl,RibbonControlKind,RibbonDialect,RibbonGroup,RibbonTab - Data Validation:
DataValidation,DataValidationEntry,DataValidationErrorStyle,DataValidationImeMode,DataValidationOperator,DataValidationType,isDataValidationErrorStyle,isDataValidationImeMode,isDataValidationOperator,isDataValidationType - Date:
DateEpoch - Errors:
AuthoringError,InternalError,XlsxError,XlsxErrorCode - Grid Shift:
AxisSplice - Hyperlink:
Hyperlink - Opc Errors:
PackageReadError,UnsupportedFormat,UnsupportedFormatError - Opc Read Options:
ReadPackageOptions - Page Setup:
HeaderFooter,isPageOrder,isPageOrientation,PageBreak,PageMargins,PageOrder,PageOrientation,PageSetup,PrintOptions - Preserved:
PreservedPart,PreservedRelationship,PreservedRootReference,PreservedWorksheetReference - Range:
Range - Row:
Row - Table Style:
isTableStyleElementType,STRIPE_ELEMENT_TYPES,TABLE_STYLE_ELEMENT_TYPES,TableStyle,TableStyleElement,TableStyleElementType - Theme:
DEFAULT_THEME_COLOR_SCHEME,DEFAULT_THEME_FONTS,isThemeColorSlot,THEME_COLOR_SLOTS,ThemeColorScheme,ThemeColorSlot,ThemeFontScheme,ThemeOverrides - Vba Errors:
VbaAuthorError,VbaParseError - Vba Project:
parseVbaProject,VbaModule,VbaModuleKind,VbaProject,VbaProjectSignature,VbaProjectSignatureKind - Vba Project Editor:
addVbaReference,removeVbaModule,VbaLibraryReference - Workbook Styles:
DifferentialStyle,NamedCellStyle,TableStyleDefinition,TableStyleNamespace,TableStyleTable - Worksheet Pictures:
PixelAnchor - Xlsb Errors:
XlsbParseError - Xlsb Read:
readXlsb - Xlsx Edit Vba:
editXlsxVbaAddReference,editXlsxVbaRemoveModule - Xlsx Errors:
XlsxParseError - Xlsx Theme Xml:
DEFAULT_THEME_XML,parseThemeColorScheme,parseThemeFontScheme - Xml Errors:
XmlParseError