import { Base, Nullable$1, Type, Stream, IConvertible, Point, IList$1, ICollection$1, IEnumerable$1, IEnumerator$1, IEnumerator, IDisposable, BaseError, IEnumerable, ValueType, IFormatProvider, IComparable$1, EnumeratorWrapper, IEquatable$1, IComparable } from "igniteui-webcomponents-core";
import { WorkItem } from "./WorkItem";
import { List$1 } from "igniteui-webcomponents-core";
import { WorkbookThemeColorType } from "./WorkbookThemeColorType";
import { WorksheetCellFormatOptions } from "./WorksheetCellFormatOptions";
import { WorksheetTableStyleArea } from "./WorksheetTableStyleArea";
import { FontSuperscriptSubscriptStyle } from "./FontSuperscriptSubscriptStyle";
import { FontUnderlineStyle } from "./FontUnderlineStyle";
import { DiagonalBorders } from "./DiagonalBorders";
import { Color } from "igniteui-webcomponents-core";
import { CellBorderLineStyle } from "./CellBorderLineStyle";
import { FillPatternStyle } from "./FillPatternStyle";
import { WorksheetCellFormatType } from "./WorksheetCellFormatType";
import { WorkbookFormat } from "./WorkbookFormat";
import { BuiltInStyleType } from "./BuiltInStyleType";
import { CultureInfo, Calendar, DateTimeFormat } from "igniteui-webcomponents-core";
import { Encoding } from "igniteui-webcomponents-core";
import { Rect } from "igniteui-webcomponents-core";
import { WBitmap } from "./WBitmap";
import { ImageHolder } from "./ImageHolder";
import { ExcelImage } from "./ExcelImage";
import { ImageFormat } from "./ImageFormat";
import { CalendarType } from "./CalendarType";
import { StringComparer } from "igniteui-webcomponents-core";
import { Dictionary$2 } from "igniteui-webcomponents-core";
import { FontFamilyInternal } from "./FontFamilyInternal";
import { HashSet$1 } from "igniteui-webcomponents-core";
import { IComparer$1 } from "igniteui-webcomponents-core";
import { WeakReference } from "igniteui-webcomponents-core";
import { Uri } from "igniteui-webcomponents-core";
import { ST_IconSetType } from "./ST_IconSetType";
import { CellIconInfo } from "./CellIconInfo";
import { Guid } from "igniteui-webcomponents-core";
import { CellFormatValue } from "./CellFormatValue";
import { CellFormatValueChangedOptions } from "./CellFormatValueChangedOptions";
import { ArgumentExceptionExtension } from "./ArgumentExceptionExtension";
import { ArgumentOutOfRangeExceptionExtension } from "./ArgumentOutOfRangeExceptionExtension";
import { Regex } from "igniteui-webcomponents-core";
import { StringBuilder } from "igniteui-webcomponents-core";
import { PropertyTableBase_PropertyValue } from "./PropertyTableBase_PropertyValue";
import { PropertyType } from "./PropertyType";
import { XColorType } from "./XColorType";
import { FormatConditionIconSet } from "./FormatConditionIconSet";
import { Size } from "igniteui-webcomponents-core";
import { WorkItem$1 } from "./WorkItem$1";
import { WorkbookOptionsBase } from "./WorkbookOptionsBase";
import { IPackageFactory } from "./IPackageFactory";
import { StructuredStorageManager } from "./StructuredStorageManager";
import { IPackage } from "./IPackage";
import { CellReferenceMode } from "./CellReferenceMode";
import { HorizontalCellAlignment } from "./HorizontalCellAlignment";
import { TextFormatMode } from "./TextFormatMode";
import { VerticalCellAlignment } from "./VerticalCellAlignment";
import { WorksheetColumnWidthUnit } from "./WorksheetColumnWidthUnit";
import { ImageData } from "./ImageData";
import { BorderThickness } from "./BorderThickness";
import { Tuple$3 } from "igniteui-webcomponents-core";
import { FormulaType } from "./FormulaType";
import { FullColorExtInfo } from "./FullColorExtInfo";
import { GradStopInfo } from "./GradStopInfo";
import { XFExtGradientInfo } from "./XFExtGradientInfo";
import { XFPropColorInfo } from "./XFPropColorInfo";
import { ChartType } from "./ChartType";
import { PreventTextFormattingTypes } from "./PreventTextFormattingTypes";
import { SeriesType } from "./SeriesType";
import { SortMethod } from "./SortMethod";
import { FormatConditionIcon } from "./FormatConditionIcon";
import { FileMode } from "./FileMode";
import { SheetType } from "./SheetType";
import { IRegionAddress } from "./IRegionAddress";
import { ExcelChangeAction } from "./ExcelChangeAction";
import { DateInterval } from "./DateInterval";
import { FirstDayOfWeek } from "./FirstDayOfWeek";
import { FirstWeekOfYear } from "./FirstWeekOfYear";
import { WorksheetPermissions } from "./WorksheetPermissions";
import { CalculationMode } from "./CalculationMode";
import { DateSystem } from "./DateSystem";
import { WorkbookPasswordInfo } from "./WorkbookPasswordInfo";
import { Precision } from "./Precision";
import { ChartDeserializationCache } from "./ChartDeserializationCache";
import { BinaryData } from "./BinaryData";
import { KeyValuePair$2 } from "igniteui-webcomponents-core";
import { PivotCacheInfo } from "./PivotCacheInfo";
import { OleDataSpacesEncryptionMode } from "./OleDataSpacesEncryptionMode";
import { SortedList$2 } from "./SortedList$2";
import { RoundTripControlData } from "./RoundTripControlData";
import { ST_TotalsRowFunction } from "./ST_TotalsRowFunction";
import { ValueTuple$2 } from "./ValueTuple$2";
import { IDictionary$2 } from "igniteui-webcomponents-core";
import { Stack$1 } from "igniteui-webcomponents-core";
import { Directory } from "./Directory";
import { ReferenceActionCode } from "./ReferenceActionCode";
import { WorksheetVisibility } from "./WorksheetVisibility";
import { IgSize } from "igniteui-webcomponents-core";
import { FontScheme } from "./FontScheme";
import { ExtPropType } from "./ExtPropType";
import { ColorableItem } from "./ColorableItem";
import { XFPropType } from "./XFPropType";
import { ReadOnlyCollection$1 } from "igniteui-webcomponents-core";
import { WorkbookColorTransform } from "./WorkbookColorTransform";
import { CellShiftType } from "./CellShiftType";
import { WorkbookMetadataItem } from "./WorkbookMetadataItem";
import { WorksheetCellBlock_DataType } from "./WorksheetCellBlock_DataType";
import { ShiftAddressResult } from "./ShiftAddressResult";
import { ISheetBackground } from "./ISheetBackground";
import { WorkbookFontProxy_PropertyIds } from "./WorkbookFontProxy_PropertyIds";
import { AxisGroup } from "./AxisGroup";
import { SeriesChartTypeGroup } from "./SeriesChartTypeGroup";
import { StackedType } from "./StackedType";
import { AxisGroupValidationResult } from "./AxisGroupValidationResult";
import { ShapePositioningMode } from "./ShapePositioningMode";
import { ICalloutRule } from "./ICalloutRule";
import { ShapeType } from "./ShapeType";
import { ST_ShapeType } from "./ST_ShapeType";
import { PredefinedShapeType } from "./PredefinedShapeType";
import { PositioningOptions } from "./PositioningOptions";
import { IgRect } from "igniteui-webcomponents-core";
import { IgPoint } from "igniteui-webcomponents-core";
import { IEscherRecord } from "./IEscherRecord";
import { LineStyle } from "./LineStyle";
import { BorderLineStyle } from "./BorderLineStyle";
import { ApplyFormulaFlags } from "./ApplyFormulaFlags";
import { ReferenceShiftType } from "./ReferenceShiftType";
import { EvaluationResult$1 } from "./EvaluationResult$1";
import { IExcelCalcReferenceCollection } from "./IExcelCalcReferenceCollection";
import { ExcelCalcErrorCode } from "./ExcelCalcErrorCode";
import { HorizontalTitleAlignment } from "./HorizontalTitleAlignment";
import { TextHorizontalOverflow } from "./TextHorizontalOverflow";
import { ElementPosition } from "./ElementPosition";
import { ReadingOrder } from "./ReadingOrder";
import { TextDirection } from "./TextDirection";
import { VerticalTitleAlignment } from "./VerticalTitleAlignment";
import { TextVerticalOverflow } from "./TextVerticalOverflow";
import { UpDownBarType } from "./UpDownBarType";
import { BarShape } from "./BarShape";
import { DisplayBlanksAs } from "./DisplayBlanksAs";
import { Excel2007ChartData } from "./Excel2007ChartData";
import { Tuple$2 } from "igniteui-webcomponents-core";
import { ChartTypeContext } from "./ChartTypeContext";
import { MarkerStyle } from "./MarkerStyle";
import { AxisPosition } from "./AxisPosition";
import { XValuesDataType } from "./XValuesDataType";
import { SeriesValuesType } from "./SeriesValuesType";
import { AxisType } from "./AxisType";
import { WallType } from "./WallType";
import { AxisCrosses } from "./AxisCrosses";
import { TickMark } from "./TickMark";
import { DisplayUnit } from "./DisplayUnit";
import { DataLabelPosition } from "./DataLabelPosition";
import { TickLabelPosition } from "./TickLabelPosition";
import { WorksheetView } from "./WorksheetView";
import { PaneLocation } from "./PaneLocation";
import { ObjectDisplayStyle } from "./ObjectDisplayStyle";
import { ScrollBars } from "./ScrollBars";
import { DataValidationOperatorType } from "./DataValidationOperatorType";
import { DataValidationType } from "./DataValidationType";
import { DataValidationErrorStyle } from "./DataValidationErrorStyle";
import { DataValidationImeMode } from "./DataValidationImeMode";
import { Token } from "./Token";
import { TokenClass } from "./TokenClass";
import { NameType } from "./NameType";
import { GetCellTextResult } from "./GetCellTextResult";
import { WorksheetTableColumnArea } from "./WorksheetTableColumnArea";
import { MutableItemRange } from "./MutableItemRange";
import { FormatConditionType } from "./FormatConditionType";
import { FormatConditionNotificationType } from "./FormatConditionNotificationType";
import { IWorksheetElementResizeContext } from "./IWorksheetElementResizeContext";
import { IndexRange } from "./IndexRange";
import { WorksheetElementResizeState } from "./WorksheetElementResizeState";
import { BiffSheetType } from "./BiffSheetType";
import { CellShiftResult } from "./CellShiftResult";
import { PivotTableInfo } from "./PivotTableInfo";
import { WorksheetItemPosition } from "./WorksheetItemPosition";
import { CellShiftInitializeFormatType } from "./CellShiftInitializeFormatType";
import { ValueFormatter_SectionType } from "./ValueFormatter_SectionType";
import { DataValidationCriteria } from "./DataValidationCriteria";
import { OneConstraintDataValidationOperator } from "./OneConstraintDataValidationOperator";
import { TwoConstraintDataValidationOperator } from "./TwoConstraintDataValidationOperator";
import { SummaryInformation } from "./SummaryInformation";
import { DocumentSummaryInformation } from "./DocumentSummaryInformation";
import { VerticalTextAlignment } from "./VerticalTextAlignment";
import { HorizontalTextAlignment } from "./HorizontalTextAlignment";
import { CT_TextBodyPropertiesBase } from "./CT_TextBodyPropertiesBase";
import { IShallowCloneable } from "./IShallowCloneable";
import { ValueFormatterOptions } from "./ValueFormatterOptions";
import { BuiltInName } from "./BuiltInName";
import { Orientation } from "./Orientation";
import { PageNumbering } from "./PageNumbering";
import { PaperSize } from "./PaperSize";
import { PrintErrors } from "./PrintErrors";
import { PrintNotes } from "./PrintNotes";
import { PageOrder } from "./PageOrder";
import { ScalingType } from "./ScalingType";
import { WorksheetProtectedSelectionMode } from "./WorksheetProtectedSelectionMode";
import { WorksheetProtectionType } from "./WorksheetProtectionType";
import { ObjectPool$1 } from "./ObjectPool$1";
import { LoadOnDemandTree_BinaryTreeNode$1 } from "./LoadOnDemandTree_BinaryTreeNode$1";
import { IBinaryTreeNodeOwner$1 } from "./IBinaryTreeNodeOwner$1";
import { LoadOnDemandTree$1 } from "./LoadOnDemandTree$1";
import { ILoadOnDemandTreeOwner$1 } from "./ILoadOnDemandTreeOwner$1";
import { ISortable } from "./ISortable";
import { WorksheetSortType } from "./WorksheetSortType";
import { WorksheetTableArea } from "./WorksheetTableArea";
import { StructuredTableReferenceKeywordType } from "./StructuredTableReferenceKeywordType";
import { AverageFilterType } from "./AverageFilterType";
import { ConditionalOperator } from "./ConditionalOperator";
import { DatePeriodFilterType } from "./DatePeriodFilterType";
import { RelativeDateRangeOffset } from "./RelativeDateRangeOffset";
import { RelativeDateRangeDuration } from "./RelativeDateRangeDuration";
import { TopOrBottomFilterType } from "./TopOrBottomFilterType";
import { IWorksheetImage } from "./IWorksheetImage";
import { StyleCategory } from "./StyleCategory";
import { NodeState } from "./NodeState";
import { UltraCalcOperatorFunction } from "./UltraCalcOperatorFunction";
import { UltraCalcException } from "./UltraCalcException";
import { ValueFormatterFlags } from "./ValueFormatterFlags";
import { ValueFormatter_WellKnownPartType } from "./ValueFormatter_WellKnownPartType";
import { IValueFormatterSectionInfo } from "./IValueFormatterSectionInfo";
import { ValueFormatter_CompareOperator } from "./ValueFormatter_CompareOperator";
import { ValueFormatter_LiteralType } from "./ValueFormatter_LiteralType";
import { ValueFormatter_NumberSection } from "./ValueFormatter_NumberSection";
import { WorksheetCellBlock_DataTypeEncoded } from "./WorksheetCellBlock_DataTypeEncoded";
import { WorksheetRowSerializationCache } from "./WorksheetRowSerializationCache";
import { SheetSerializationCache } from "./SheetSerializationCache";
import { FtCmo } from "./FtCmo";
import { WhitespaceType } from "./WhitespaceType";
import { AttrTokenBase_AttrType } from "./AttrTokenBase_AttrType";
import { FormulaParser_TextSpan } from "./FormulaParser_TextSpan";
import { FormulaParser_PositionInfo } from "./FormulaParser_PositionInfo";
import { ISelectorFunctionOptimizationToken } from "./ISelectorFunctionOptimizationToken";
import { DataBarFillType } from "./DataBarFillType";
import { DataBarDirection } from "./DataBarDirection";
import { FormatConditionOperator } from "./FormatConditionOperator";
import { FormatConditionTopBottom } from "./FormatConditionTopBottom";
import { FormatConditionAboveBelow } from "./FormatConditionAboveBelow";
import { FormatConditionTimePeriod } from "./FormatConditionTimePeriod";
import { FormatConditionTextOperator } from "./FormatConditionTextOperator";
import { ColorScaleType } from "./ColorScaleType";
import { LoadOnDemandTree_ChangeAdjustmentPoint$1 } from "./LoadOnDemandTree_ChangeAdjustmentPoint$1";
import { LoadOnDemandTree_ChangeHistoryItem$1 } from "./LoadOnDemandTree_ChangeHistoryItem$1";
import { LoadOnDemandTree_ChangeHistoryItemAdd$1 } from "./LoadOnDemandTree_ChangeHistoryItemAdd$1";
import { BuiltInStyleInfo } from "./BuiltInStyleInfo";
import { LoadOnDemandTree_ChangeHistoryItemRemove$1 } from "./LoadOnDemandTree_ChangeHistoryItemRemove$1";
import { SparklineDisplayBlanksAs } from "./SparklineDisplayBlanksAs";
import { SparklineType } from "./SparklineType";
import { SparklineAxisMinMax } from "./SparklineAxisMinMax";
import { SortDirection } from "./SortDirection";
import { ST_SortBy } from "./ST_SortBy";
import { LengthType } from "./LengthType";
import { ST_DynamicFilterType } from "./ST_DynamicFilterType";
import { ExcelComparisonOperator } from "./ExcelComparisonOperator";
import { ST_FilterOperator } from "./ST_FilterOperator";
import { FixedDateGroup_DateRange } from "./FixedDateGroup_DateRange";
import { FixedDateGroupType } from "./FixedDateGroupType";
import { ST_DateTimeGrouping } from "./ST_DateTimeGrouping";
import { DateRange } from "./DateRange";
import { FormatConditionValueType } from "./FormatConditionValueType";
import { ColorScaleCriterionThreshold } from "./ColorScaleCriterionThreshold";
import { ConditionValueInfo } from "./ConditionValueInfo";
import { DataBarAxisPosition } from "./DataBarAxisPosition";
import { ThresholdComparison } from "./ThresholdComparison";
import { IconCriterionInfo } from "./IconCriterionInfo";
import { DataBarNegativeBarColorType } from "./DataBarNegativeBarColorType";
import { GridLineType } from "./GridLineType";
import { TimeUnit } from "./TimeUnit";
import { CategoryType } from "./CategoryType";
import { ScaleType } from "./ScaleType";
import { ChartsheetProtectionType } from "./ChartsheetProtectionType";
import { ParentLabelLayout } from "./ParentLabelLayout";
import { GetXValuesResult } from "./GetXValuesResult";
import { GeographicMapProjection } from "./GeographicMapProjection";
import { GeographicMappingArea } from "./GeographicMappingArea";
import { GeographicMapLabels } from "./GeographicMapLabels";
import { GeographicMapSeriesColor } from "./GeographicMapSeriesColor";
import { TrendlinePolynomialOrder } from "./TrendlinePolynomialOrder";
import { TrendlineType } from "./TrendlineType";
import { ErrorBarDirection } from "./ErrorBarDirection";
import { EndStyleCap } from "./EndStyleCap";
import { ErrorValueType } from "./ErrorValueType";
import { LegendPosition } from "./LegendPosition";
import { IntervalClosedSide } from "./IntervalClosedSide";
import { SeriesValuesColorBy } from "./SeriesValuesColorBy";
import { BoxAndWhiskerSettings } from "./BoxAndWhiskerSettings";
import { PictureType } from "./PictureType";
import { TickLabelAlignment } from "./TickLabelAlignment";
import { DdeItem } from "./DdeItem";
import { OleItem } from "./OleItem";
import { CT_Transform2D } from "./CT_Transform2D";
import { CT_GroupTransform2D } from "./CT_GroupTransform2D";
import { LbsDropData } from "./LbsDropData";
import { FtPioGrbit } from "./FtPioGrbit";
import { FtNts } from "./FtNts";
import { FtCf } from "./FtCf";
import { FtGmo } from "./FtGmo";
import { FtCbls } from "./FtCbls";
import { FtRbo } from "./FtRbo";
import { FtSbs } from "./FtSbs";
import { FtCblsData } from "./FtCblsData";
import { FtEdoData } from "./FtEdoData";
import { FtGboData } from "./FtGboData";
import { PictFmlaEmbedInfo } from "./PictFmlaEmbedInfo";
import { CalcArgumentSource } from "./CalcArgumentSource";
import { CalcArgumentFlags } from "./CalcArgumentFlags";
/**
* @hidden
*/
export declare class DefaultStyleHelper extends Base {
static $t: Type;
static a(a: List$1
* The units of 1/256s of the average character width are based on the font height of the normal style.
* [[IWorkbookFont]] describes font used in excel workbook.
* If many parts of excel workbook have same and complex (more than one property in common) font formatting, use this method in following manner:
*
*
Use of this procedure will simplify you code for complex font formats and increase speed of resulting program. It will not reduce total number of font formats in a workbook as font formats are internally cached no matter which method is used.
* @return The created excel font object. */ createNewWorkbookFont(): IWorkbookFont; /** * Creates new worksheet cell format. *[[IWorksheetCellFormat]] describes cell specific formatting (font, number format, appearance etc.). Total number of different cell formats in excel workbook is limited to [[Workbook.maxExcelCellFormatCount]]. * If many parts of excel workbook have same and complex (more than one property in common) cell formatting, use this method in following manner: *
Use of this procedure will simplify you code for complex cell formats and increase speed of resulting program. It will not reduce total number of cell formats in a workbook as cell formats are internally cached no matter which method is used.
* @return The cell format which was created. */ createNewWorksheetCellFormat(): IWorksheetCellFormat; /** * @hidden */ _ce(a: WorksheetCellFormatType): WorksheetCellFormatData; /** * Gets the table with the specified name. ** Table names are compared case-insensitively. *
* @param name The name of the table to get. * @return A [[WorksheetTable]] instance if a table exists with the specified name; Otherwise null. */ getTable(name: string): WorksheetTable; /** * Converts pixels to units of 1/256s of the average character width. ** The units of 1/256s of the average character width are based on the font height of the normal style. *
* @param pixels The number of pixels. * @return The number of units of 1/256s of the average character width equivalent to the 'pixels' value. * @see [[characterWidth256thsToPixels]] * @see [[WorksheetColumn.width]] * @see [[Worksheet.defaultColumnWidth]] */ pixelsToCharacterWidth256ths(pixels: number): number; /** * Protects the Workbook without a password. *When a Workbook is protected without a password, the end user may unprotect the Workbook in Excel without * having to supply a password. To programatically unprotect a Workbook, one may use the [[unprotect]] method.
*When a Workbook is protected, the values of the properties of the [[WorkbookProtection]] instance from * this Workbook's [[protection]] property indicate the disabled operations.
*Note: If [[isProtected]] is already true, the method will be ignored.
* @param allowEditStructure Optional boolean indicating the new value for the [[WorkbookProtection.allowEditStructure]]. * @param allowEditWindows Optional boolean indicating the new value for the [[WorkbookProtection.allowEditWindows]]. * @see [[hasProtectionPassword]] * @see [[isProtected]] * @see [[protection]] * @see [[WorkbookProtection]] * @see [[unprotect]] */ protect(allowEditStructure?: boolean, allowEditWindows?: boolean): void; /** * Recalculates all dirty formulas pending a calculation on the workbook. ** This can be used when the [[calculationMode]] is Manual. In Manual mode, when cells are dirtied, formulas referencing * those cells will not be recalculated until Recalculate is called or [[recalculateBeforeSave]] is True and the workbook is saved. *
** To force a recalculation of non-dirty formulas, use the [[recalculate]] overload and specify True for the includeNonDirtyFormulas * parameter. *
* @see [[calculationMode]] * @see [[recalculateBeforeSave]] */ recalculate(): void; /** * Recalculates all formulas on the workbook. ** This can be used when the [[calculationMode]] is Manual. In Manual mode, when cells are dirtied, formulas referencing * those cells will not be recalculated until Recalculate is called or [[recalculateBeforeSave]] is True and the workbook is saved. *
* @param includeNonDirtyFormulas True to recalculate all formulas on the workbook regardless of whether they had a pending evaluation. False to only calculate dirty formulas. * @see [[calculationMode]] * @see [[recalculateBeforeSave]] */ recalculate(includeNonDirtyFormulas: boolean): void; /** * @hidden */ _recalculate(): void; /** * @hidden */ _recalculate1(a: boolean): void; /** * Recalculates all formulas on the workbook. ** This can be used when the [[calculationMode]] is Manual. In Manual mode, when cells are dirtied, formulas referencing * those cells will not be recalculated until Recalculate is called or [[recalculateBeforeSave]] is True and the workbook is saved. *
* @param includeNonDirtyFormulas True to recalculate all formulas on the workbook regardless of whether they had a pending evaluation. False to only calculate dirty formulas. * @see [[calculationMode]] * @see [[recalculateBeforeSave]] */ recalculateAsync(includeNonDirtyFormulas: boolean): void; /** * Indicates if the workbook is currently performing a calculation operation. */ get isPerformingAsyncCalculations(): boolean; /** * @hidden */ _h8(): void; /** * Requests that any current calculation operation be cancelled. */ cancelAsyncCalculations(): void; /** * @hidden */ _i0(a: boolean, b: boolean, c?: boolean): void; /** * Registers a single [[ExcelCalcFunction]] instance. ** Users can build custom functions used in formulas by sub-classing the [[ExcelCalcFunction]] class. * Once the derived class is instantiated it must be registered by using the RegisterUserDefinedFunction method before being available and referenced by a formulas. *
* @param userDefinedFunction User defined function instance to register * @return Returns true if the type was registered successfully, else false if the registration failed */ registerUserDefinedFunction(userDefinedFunction: ExcelCalcFunction): boolean; /** * Registers a custom function. * @param name The name of the function * @param minArgs The minimum number of arguments * @param maxArgs The maximum number of arguments * @param evaluate The function used to perform the calculation that gets an [[ExcelCalcNumberStack]] and the number of arguments on the stack for the function and returns an [[ExcelCalcValue]] that represents the result of the formula * @return Returns true if the type was registered successfully, else false if the registration failed */ registerUserDefinedFunction(name: string, minArgs: number, maxArgs: number, evaluate: (arg1: ExcelCalcNumberStack, arg2: number) => ExcelCalcValue): boolean; /** * @hidden */ _registerUserDefinedFunction(a: ExcelCalcFunction): boolean; /** * @hidden */ _registerUserDefinedFunction1(a: string, b: number, c: number, d: (arg1: ExcelCalcNumberStack, arg2: number) => ExcelCalcValue): boolean; /** * Resumes the calculation of formulas. ** If calculations were not suspended when this is called, it will have no effect. *
** For each call to [[suspendCalculations]], a call to ResumeCalculations must be made. As soon as the number of calls to * ResumeCalculations equals the number of calls to SuspendCalculations, calculations will be resumed. *
* @see [[suspendCalculations]] */ resumeCalculations(): void; /** * Writes the workbook to a Uint8Array. ** The workbook will be written in the format specified by the [[currentFormat]]. *
* @param saveOptions The options to use to save the stream or null to use the default options. * @param successCallback The function to call when the Workbook has been successfully saved into a Uint8Array or base-64 encoded string. * @param failCallback The function to call when saving the Workbook has caused an error. * @throws [[InvalidOperationException]] The workbook has no worksheets in its [[worksheets]] collection. * @throws [[InvalidOperationException]] No worksheet in this workbook's Worksheets collection has its DisplayOptions.Visibility * set to Visible. * @throws [[InvalidOperationException]] A [[CustomView]] in the workbook's [[customViews]] collection has all worksheets hidden. * At least one worksheet must be visible in all custom views. * @see [[isSaving]] */ save(saveOptions: WorkbookSaveOptions, successCallback: (arg1: any) => void, failCallback: (arg1: BaseError) => void): void; /** * Writes the workbook to a Uint8Array. ** The workbook will be written in the format specified by the [[currentFormat]]. *
* @param successCallback The function to call when the Workbook has been successfully saved into a Uint8Array or base-64 encoded string. * @param failCallback The function to call when saving the Workbook has caused an error. * @throws [[InvalidOperationException]] The workbook has no worksheets in its [[worksheets]] collection. * @throws [[InvalidOperationException]] No worksheet in this workbook's Worksheets collection has its DisplayOptions.Visibility * set to Visible. * @throws [[InvalidOperationException]] A [[CustomView]] in the workbook's [[customViews]] collection has all worksheets hidden. * At least one worksheet must be visible in all custom views. * @see [[isSaving]] */ save(successCallback: (arg1: any) => void, failCallback: (arg1: BaseError) => void): void; /** * @hidden */ _save1(a: (arg1: any) => void, b: (arg1: BaseError) => void): void; /** * @hidden */ _save(a: WorkbookSaveOptions, b: (arg1: any) => void, c: (arg1: BaseError) => void): void; private _isSaving; /** * Gets the value indicating whether the [[Workbook]] is currently being saved. */ get isSaving(): boolean; set isSaving(a: boolean); /** * @hidden */ _i9(a: Stream, b?: WorkbookSaveOptions): void; /** * Sets the current format of the workbook. * @param format The file format to use when imposing format restrictions and saving. * @throws [[InvalidEnumArgumentException]] 'format' is not defined in the [[WorkbookFormat]] enumeration. * @throws [[InvalidOperationException]] The workbook already contains data which exceeds the limits imposed by 'format'. * @see [[currentFormat]] */ setCurrentFormat(format: WorkbookFormat): void; /** * Temporarily suspends the calculation of formulas. ** This should be used when adding many formulas or modifying large amounts of data on a workbook at once so formulas are not calculated * each time cells are dirtied. *
** For each call to SuspendCalculations, a call to [[resumeCalculations]] must be made. As soon as the number of calls to * ResumeCalculations equals the number of calls to SuspendCalculations, calculations will be resumed. *
* @see [[resumeCalculations]] */ suspendCalculations(): void; /** * Removes the Workbook protection. * @see [[isProtected]] * @see [[hasProtectionPassword]] * @see [[protect]] */ unprotect(): void; /** * Loads a workbook from a File. ** When loading the workbook, the contents of the file will be examined to try to determine the format. * The [[currentFormat]] of the resulting workbook will indicate the format the workbook was loaded from. *
* @param file The file from which to load the workbook. * @param loadOptions The options to use to load the stream or null to use the default options. * @param successCallback The function to call when the Workbook has been successfully loaded. * @param failCallback The function to call when loading the Workbook has resulted in an error. * @throws [[ArgumentException]] 'file' does not contain valid Microsoft Excel file contents. * @throws [[ArgumentException]] The file format cannot be determined from the specified stream. * @throws [[InvalidOperationException]] The format of the workbook data is in an unsupported format. * @throws [[NotSupportedException]] The workbook being loaded is in an Excel 2007 format and the CLR 2.0 Excel assembly is being used. The overload taking an * [[IPackageFactory]] must be used in this case so the Excel 2007 file package can be accessed. * @throws [[DocumentEncryptedException]] Occurs when the workbook is encrypted. * @return The workbook loaded from the stream. */ static load(file: File, loadOptions: WorkbookLoadOptions, successCallback: (arg1: Workbook) => void, failCallback: (arg1: any) => void): void; /** * Loads a workbook from a File. ** When loading the workbook, the contents of the file will be examined to try to determine the format. * The [[currentFormat]] of the resulting workbook will indicate the format the workbook was loaded from. *
* @param file The file from which to load the workbook. * @param successCallback The function to call when the Workbook has been successfully loaded. * @param failCallback The function to call when loading the Workbook has resulted in an error. * @throws [[ArgumentException]] 'file' does not contain valid Microsoft Excel file contents. * @throws [[ArgumentException]] The file format cannot be determined from the specified stream. * @throws [[InvalidOperationException]] The format of the workbook data is in an unsupported format. * @throws [[NotSupportedException]] The workbook being loaded is in an Excel 2007 format and the CLR 2.0 Excel assembly is being used. The overload taking an * [[IPackageFactory]] must be used in this case so the Excel 2007 file package can be accessed. * @throws [[DocumentEncryptedException]] Occurs when the workbook is encrypted. * @return The workbook loaded from the stream. */ static load(file: File, successCallback: (arg1: Workbook) => void, failCallback: (arg1: any) => void): void; /** * Loads a workbook from a Uint8Array or base64 encoded string. ** When loading the workbook, the contents of the file will be examined to try to determine the format. * The [[currentFormat]] of the resulting workbook will indicate the format the workbook was loaded from. *
* @param data The data from which to load the workbook. * @param loadOptions The options to use to load the stream or null to use the default options. * @param successCallback The function to call when the Workbook has been successfully loaded. * @param failCallback The function to call when loading the Workbook has resulted in an error. * @throws [[ArgumentException]] 'data' does not contain valid Microsoft Excel file contents. * @throws [[ArgumentException]] The file format cannot be determined from the specified stream. * @throws [[InvalidOperationException]] The format of the workbook data is in an unsupported format. * @throws [[NotSupportedException]] The workbook being loaded is in an Excel 2007 format and the CLR 2.0 Excel assembly is being used. The overload taking an * [[IPackageFactory]] must be used in this case so the Excel 2007 file package can be accessed. * @throws [[DocumentEncryptedException]] Occurs when the workbook is encrypted. * @return The workbook loaded from the stream. */ static load(data: string | Uint8Array, loadOptions: WorkbookLoadOptions, successCallback: (arg1: Workbook) => void, failCallback: (arg1: BaseError) => void): void; /** * Loads a workbook from a Uint8Array or base64 encoded string. ** When loading the workbook, the contents of the file will be examined to try to determine the format. * The [[currentFormat]] of the resulting workbook will indicate the format the workbook was loaded from. *
* @param data The data from which to load the workbook. * @param successCallback The function to call when the Workbook has been successfully loaded. * @param failCallback The function to call when loading the Workbook has resulted in an error. * @throws [[ArgumentException]] 'data' does not contain valid Microsoft Excel file contents. * @throws [[ArgumentException]] The file format cannot be determined from the specified stream. * @throws [[InvalidOperationException]] The format of the workbook data is in an unsupported format. * @throws [[NotSupportedException]] The workbook being loaded is in an Excel 2007 format and the CLR 2.0 Excel assembly is being used. The overload taking an * [[IPackageFactory]] must be used in this case so the Excel 2007 file package can be accessed. * @throws [[DocumentEncryptedException]] Occurs when the workbook is encrypted. * @return The workbook loaded from the stream. */ static load(data: string | Uint8Array, successCallback: (arg1: Workbook) => void, failCallback: (arg1: BaseError) => void): void; /** * @hidden */ static _load2(a: File, b: (arg1: Workbook) => void, c: (arg1: any) => void): void; /** * @hidden */ static _load1(a: File, b: WorkbookLoadOptions, c: (arg1: Workbook) => void, d: (arg1: any) => void): void; /** * @hidden */ static _load4(a: Stream, b: (arg1: Workbook) => void, c: (arg1: BaseError) => void): void; /** * @hidden */ static _load3(a: Stream, b: WorkbookLoadOptions, c: (arg1: Workbook) => void, d: (arg1: BaseError) => void): void; /** * @hidden */ static _bt(a: Stream, b?: WorkbookLoadOptions): Workbook; /** * @hidden */ private static _q; /** * Returns the WorkbookFormat based on the file extension of the specified file. * @param fileName The filename of an excel file. * @return The workbook format based on the file extension of the file, or null if the correct format cannot be determined. */ static getWorkbookFormat(fileName: string): WorkbookFormat | null; /** * @hidden */ static _getWorkbookFormat$i(a: string): Nullable$1* If this is set to a value of Manual, the [[recalculateBeforeSave]] property will determine * if formulas are recalculated just before saving the file. Otherwise, that property is ignored. *
* The value which indicates how a formula will be recalculated when a referenced value changes. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the [[calculationMode]] enumeration. * @see [[recalculateBeforeSave]] */ get calculationMode(): CalculationMode; set calculationMode(a: CalculationMode); /** * Gets or sets the value which indicates the way cells in the workbook are referenced. ** The value of this property will affect the row and columns labels of the workbook when opened in Microsoft Excel. * In addition, it will affect the display of formulas referencing different cells. *
* The value which indicates the way cells in the workbook are referenced. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the [[cellReferenceMode]] enumeration. */ get cellReferenceMode(): CellReferenceMode; set cellReferenceMode(a: CellReferenceMode); /** * Gets or sets the culture to use as the current culture for the workbook when doing any culture-aware conversions * or comparisons. ** Note: The culture is not saved or loaded in workbook files, so this is only used at when accessing and * manipulating objects owned or associated with the Workbook. *
* The current culture for the workbook or Null to use the thread's current culture. */ get culture(): string | CultureInfo; set culture(a: string | CultureInfo); /** * @hidden */ get _culture$i(): CultureInfo; /** * @hidden */ set _culture$i(a: CultureInfo); /** * Gets the current format of the workbook. This is the format which will be used when saving and imposing format restrictions. * @see [[setCurrentFormat]] */ get currentFormat(): WorkbookFormat; /** * Gets the [[WorksheetTableStyle]] at the specified index. * @param index The index at which to get the WorksheetTableStyle. * @throws [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]]. * @return The WorksheetTableStyle instance at the specified index. */ customTableStyles(index: number): WorksheetTableStyle; /** * Gets the [[WorksheetTableStyle]] with the specified name. ** Table style names are compared case-insensitively. *
* @param name The name of the WorksheetTableStyle to find. * @return The WorksheetTableStyle instance with the specified name or null if a table style with that name does not exist. */ customTableStyles(name: string): WorksheetTableStyle; /** * Gets the collection of custom table styles in the workbook. * @see [[defaultTableStyle]] * @see [[standardTableStyles]] */ customTableStyles(): CustomTableStyleCollection; /** * @hidden */ get _customTableStyles$i(): CustomTableStyleCollection; /** * Gets the custom view at the specified index. * The custom view at the specified index. * @param index The zero-based index of the custom view to get. * @throws [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or * equal to [[count]]. */ customViews(index: number): CustomView; /** * Gets the collection of custom views for the workbook. ** Each custom view stores display settings and optionally print settings, which can later be applied to the workbook * and its worksheets as one operation, through both the Microsoft Excel UI and the Excel assembly by calling the * [[CustomView.apply]] method. *
* The collection of custom views for the workbook. * @see [[CustomView]] */ customViews(): CustomViewCollection; /** * @hidden */ get _customViews$i(): CustomViewCollection; /** * @hidden */ get _cr(): boolean; /** * Gets or sets the date system used internally by Microsoft Excel. * The date system used internally by Microsoft Excel. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the [[dateSystem]] enumeration. */ get dateSystem(): DateSystem; set dateSystem(a: DateSystem); /** * Gets or sets the default style for tables in the workbook. ** This can be set to any [[WorksheetTableStyle]] in the [[customTableStyles]] or [[standardTableStyles]] collection. *
** This will never return a null value. If it is set to null, it will be reset to the TableStyleMedium2 table style. *
** If this value is changed, it will not be applied to existing tables in the workbook. Only newly created tables will use * default table style on the workbook. *
* @throws [[ArgumentException]] The specified value is not in the [[customTableStyles]] or [[standardTableStyles]] collections. * @see [[customTableStyles]] * @see [[standardTableStyles]] * @see [[WorksheetTable.style]] */ get defaultTableStyle(): WorksheetTableStyle; set defaultTableStyle(a: WorksheetTableStyle); /** * Gets the properties associated with the workbook document. ** The document properties are pieces of information which provide details on the content of the workbook, * such as the author, title, and subject of the workbook. *
* The properties associated with the workbook document. */ get documentProperties(): DocumentProperties; /** * @hidden */ get _cs(): boolean; /** * The editing culture affects certain language specific features such as formatting of dates. * or comparisons. ** Note: The EditingCulture is not saved or loaded in workbook files, so this is only used at when accessing and * manipulating objects owned or associated with the Workbook. *
* @see [[culture]] */ get editingCulture(): string | CultureInfo; set editingCulture(a: string | CultureInfo); /** * @hidden */ get _editingCulture$i(): CultureInfo; /** * @hidden */ set _editingCulture$i(a: CultureInfo); /** * Returns a boolean indicating if the Workbook has been protected with a password. *When protecting a Workbook, a password is optional. The HasProtectionPassword will return true if the * Workbook is currently protected (see [[isProtected]]) and a password was specified when it was protected. To protect * a Workbook without a password, one may use the [[protect]] * method that doesn't take a password.
* @see [[isProtected]] * @see [[protection]] * @see [[WorkbookProtection]] * @see [[protect]] * @see [[unprotect]] */ get hasProtectionPassword(): boolean; /** * Returns a boolean indicating if the Workbook has been protected. *The IsProtected property will return true if the Workbook is currently protected. When a Workbook is protected * certain operations related to the Worksheets displayed or their order or the properties of the windows for the Workbook may be * restricted based on the values of the [[protection]].
* @see [[hasProtectionPassword]] * @see [[protection]] * @see [[WorkbookProtection]] * @see [[protect]] * @see [[unprotect]] */ get isProtected(): boolean; /** * Gets a value indicating whether the specified function will be recognized and solved by Microsoft Excel when the workbook is saved out. * @param functionName The case-insensitive name of the function. * @return True if the function will be recognized in Microsoft Excel; False otherwise. */ isValidFunctionName(functionName: string): boolean; /** * Gets or sets the value which indicates whether iterations are allowed while calculating formulas containing * circular references. ** When iterative calculations are enabled, a formula is allowed to use circular references, * or directly or indirectly reference the cell to which it belongs. Microsoft Excel stops iteratively * calculating formulas after iterating [[maxRecursionIterations]] times or when all formula * values change by less than [[maxChangeInIteration]] between two iterations. *
*
* When iterative calculations are disabled, circular references are not allowed, and a formula which
* references the cell to which it belongs, directly or indirectly, will cause Microsoft Excel to show an
* error message and the cell will contain a
* This property is only valid when [[iterativeCalculationsEnabled]] is True. Otherwise it is ignored. *
** When iterative calculations, or circular references, are enabled, this property determines the maximum change in * all values of a formula between two iterations that will cause the formula to exit iterative calculations. Iterative * calculations will also be stopped if the formula iterates [[maxRecursionIterations]] times. *
* The maximum change of the values in a formula between iterations which will exit from iteration. * @see [[iterativeCalculationsEnabled]] * @see [[maxRecursionIterations]] */ get maxChangeInIteration(): number; set maxChangeInIteration(a: number); /** * Gets the maximum number of columns allowed in each worksheet based on the [[currentFormat]]. */ get maxColumnCount(): number; /** * Gets or sets the maximum number of times formulas should be iteratively calculated. ** This property is only valid when [[iterativeCalculationsEnabled]] is True. Otherwise it is ignored. *
** When iterative calculations, or circular references, are enabled, this property determines the number of iterations * allowed when calculating iteratively. *
* The maximum number of times formulas should be iteratively calculated. * @throws [[ArgumentOutOfRangeException]] The assigned value is outside the valid range of 1 and 32767. * @see [[iterativeCalculationsEnabled]] * @see [[maxChangeInIteration]] */ get maxRecursionIterations(): number; set maxRecursionIterations(a: number); /** * Gets the maximum number of rows allowed in each worksheet based on the [[currentFormat]]. */ get maxRowCount(): number; /** * Gets the named reference at the specified index. * The named reference at the specified index. * @param index The zero-based index of the named reference to get. * @throws [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or * equal to [[count]]. */ namedReferences(index: number): NamedReference; /** * Gets the collection of named references in the workbook. ** Named references are typically used to refer to cells or ranges of cells by name. * The named reference names are used by formulas instead of explicitly naming the * cells or cell ranges. *
* The collection of named references in the workbook. * @see [[NamedReference]] */ namedReferences(): NamedReferenceCollection; /** * @hidden */ get _namedReferences$i(): NamedReferenceCollection; /** * @hidden */ get _cw(): boolean; /** * Gets or sets a color in the palette. ** When a color is set in the palette, [[isCustom]] will return True. The palette can than be reset with the * [[reset]] method. *
** Colors added to the palette must be opaque. *
* @param index The index of the color to get or set in the palette. * @throws [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than 55. * @throws [[ArgumentException]] The value assigned is an empty color, a system color, or is not opaque. * @see [[isCustom]] * @see [[reset]] */ palette(index: number, value?: string | Color): string; /** * Gets the color palette used when the saved file is opened in Microsoft Excel 2003 and earlier versions. ** When the file is opened in Microsoft Excel 2003 and earlier versions, the actual colors used in cells and shapes may not be displayed. * Instead, the closest color in the palette will be displayed instead. Therefore, the palette can be customized if necessary to keep the * colors as accurate as possible in older versions of Excel. *
*/ palette(): WorkbookColorPalette; /** * @hidden */ get _palette$i(): WorkbookColorPalette; /** * Gets or sets the precision to use when obtaining a cell's value. ** The precision determines whether to use the actual value of the cell or the display value of the cell. * These are typically the same, but the format of a cell could cause a loss of precision in the displayed * value. For example, if a cell's value is 18.975, and a currency format is used for the cell, the display * value will be 18.98. *
* The precision to use when obtaining a cell's value. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the enumeration. */ get precision(): Precision; set precision(a: Precision); /** * @hidden */ _dh: boolean; /** * Returns an object that provides information used when the Workbook has been protected. * @see [[hasProtectionPassword]] * @see [[isProtected]] * @see [[WorkbookProtection]] * @see [[protect]] * @see [[unprotect]] */ get protection(): WorkbookProtection; /** * Gets or sets the value which indicates whether the workbook should recalculate all formulas before saving. ** This property only applies if the [[calculationMode]] is set to Manual. Otherwise, it is ignored. *
* The value which indicates whether the workbook should recalculate all formulas before saving. * @see [[recalculate]] * @see [[calculationMode]] */ get recalculateBeforeSave(): boolean; set recalculateBeforeSave(a: boolean); /** * Gets or sets the value which indicates whether to save values linked from external workbooks. ** This value will only be used when the workbook is opened in Microsoft Excel. When referencing external values * and saving a workbook through the Excel assembly, external linked values will never be saved. *
* The value which indicates whether to save values linked from external workbooks. */ get saveExternalLinkedValues(): boolean; set saveExternalLinkedValues(a: boolean); /** * Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used. * @throws [[ArgumentException]] Occurs when the specified value is not empty and does not have two positive values. */ get screenDpi(): IgSize; set screenDpi(a: IgSize); /** * @hidden */ get _screenDpi$i(): Size; /** * @hidden */ set _screenDpi$i(a: Size); /** * @hidden */ private _jc; /** * @hidden */ static _jk(a: Size): void; /** * @hidden */ private static _c3; /** * Gets the sheet at the specified index. * The sheet at the specified index. * @param index The zero-based index of the sheet to get. * @throws [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or equal to [[count]]. */ sheets(index: number): Sheet; /** * Gets the sheet with the specified name. ** Sheet names are compared case-insensitively. *
* The sheet with the specified name. * @param name The name of the sheet to get. * @throws [[InvalidOperationException]] A sheet with the specified name does not exist in the collection. * @see [[Sheet.name]] */ sheets(name: string): Sheet; /** * Gets the collection of sheets in the workbook. *
* Use
* In Microsoft Excel 2003, carriage return characters are displayed as boxes. Most of the time, this should not be seen * and removing the carriage return characters has no adverse effect on the layout of the text within a cell. Therefore, * this property is True by default. *
* True if the saved workbook file should not contain the carriage return characters from cell values; False to export the * string values as they have been set on the cells. */ get shouldRemoveCarriageReturnsOnSave(): boolean; set shouldRemoveCarriageReturnsOnSave(a: boolean); /** * Gets the [[WorksheetTableStyle]] at the specified index. * @param index The index at which to get the WorksheetTableStyle. * @throws [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]]. * @return The WorksheetTableStyle instance at the specified index. */ standardTableStyles(index: number): WorksheetTableStyle; /** * Gets the [[WorksheetTableStyle]] with the specified name. ** Table style names are compared case-insensitively. *
* @param name The name of the WorksheetTableStyle to find. * @return The WorksheetTableStyle instance with the specified name or null if a table style with that name does not exist. */ standardTableStyles(name: string): WorksheetTableStyle; /** * Gets the read-only collection of preset table styles in the workbook. * @see [[defaultTableStyle]] * @see [[customTableStyles]] */ standardTableStyles(): StandardTableStyleCollection; /** * @hidden */ get _standardTableStyles$i(): StandardTableStyleCollection; /** * Gets the style at the specified index. * The style at the specified index. * @param index The zero-based index of the style to get. * @throws [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or equal to [[count]]. */ styles(index: number): WorkbookStyle; /** * Gets the style with the specified name. ** Style names are compared case-insensitively. *
* The style with the specified name or null if no style with that name exists. * @param name The name of the style to get. * @throws [[ArgumentNullException]] 'name' is null. */ styles(name: string): WorkbookStyle; /** * Gets the collection of custom styles in the workbook. ** Use this collection to add custom styles to Excel workbook. The user can apply those styles to different * parts of excel workbook and thereby set complex formatting with ease. *
* The collection of custom styles in the workbook. * @see [[WorkbookStyle]] */ styles(): WorkbookStyleCollection; /** * @hidden */ get _styles$i(): WorkbookStyleCollection; /** * Gets or sets the default Dpi to use when calculating row and column sizes for the workbook. If empty, the resolved system Dpi will be used. */ static get systemDpi(): IgSize; static set systemDpi(a: IgSize); /** * @hidden */ static get _systemDpi$i(): Size; /** * @hidden */ static set _systemDpi$i(a: Size); /** * Gets or sets the value indicating whether the format strings should be validated when they are set. ** This value is False by default to maintain backward compatibility. *
** When True, format strings will be validated when a [[IWorksheetCellFormat.formatString]] property is set. An invalid * format string will cause an exception. When False, invalid format strings will be allowed, but if the display text of a cell is * requested, an exception will be thrown at that time. If invalid format strings are allowed and the workbook is saved and opened * in Microsoft Excel, it will show an error. *
* @see [[IWorksheetCellFormat.formatString]] * @see [[WorksheetCell.getText]] * @see [[WorksheetCell.getText]] * @see [[WorksheetRow.getCellText]] * @see [[WorksheetRow.getCellText]] */ get validateFormatStrings(): boolean; set validateFormatStrings(a: boolean); /** * Gets the options which control various workbook level display properties. ** The window options control properties of the child MDI window showing the workbook in Microsoft Excel. * They also control display options of the workbook which do not change based on the selected worksheet. *
* The options which control various workbook level display properties. * @see [[CustomView.windowOptions]] */ get windowOptions(): WorkbookWindowOptions; /** * Gets the worksheet at the specified index. * The worksheet at the specified index. * @param index The zero-based index of the worksheet to get. * @throws [[ArgumentOutOfRangeException]] 'index' is less than zero or 'index' is greater than or equal to [[count]]. */ worksheets(index: number): Worksheet; /** * Gets the worksheet with the specified name. ** Worksheet names are compared case-insensitively. *
* The worksheet with the specified name. * @param name The name of the worksheet to get. * @throws [[InvalidOperationException]] A worksheet with the specified name does not exist in the collection. * @see [[Sheet.name]] */ worksheets(name: string): Worksheet; /** * Gets the collection of worksheets in the workbook. *
* Use
* Depending on where the format is exposed, it will have a different meaning. For example, a cell's format just applies to itself, * but a row or column's format applies to all cells in that row or column. There are also style formats, which can be the parent of * other formats, meaning they provide defaults for values not set on the format. And finally, there are differential formats, such * as the format for areas in a table, which provide default values for cells which exist in the associated area. *
* @see [[WorksheetCell.cellFormat]] * @see [[RowColumnBase.cellFormat]] * @see [[WorksheetMergedCellsRegion.cellFormat]] * @see [[WorkbookStyle.styleFormat]] * @see [[WorksheetTable.areaFormats]] * @see [[WorksheetTableColumn.areaFormats]] * @see [[WorksheetTableStyle.areaFormats]] * @see [[WorksheetCell.getResolvedCellFormat]] * @see [[RowColumnBase.getResolvedCellFormat]] * @see [[WorksheetMergedCellsRegion.getResolvedCellFormat]] */ export interface IWorksheetCellFormat { setFormatting(source: IWorksheetCellFormat): void; alignment: HorizontalCellAlignment; bottomBorderColorInfo: WorkbookColorInfo; bottomBorderStyle: CellBorderLineStyle; diagonalBorderColorInfo: WorkbookColorInfo; diagonalBorders: DiagonalBorders; diagonalBorderStyle: CellBorderLineStyle; fill: CellFill; readonly font: IWorkbookFont; formatOptions: WorksheetCellFormatOptions; formatString: string; hidden: boolean | null; _hidden$i: Nullable$1* By default when an exact duplicate of a formula string is encountered during the load, the previously parsed formula * will be cloned rather than reparsing the string to create an entirely new formula. *
*Note: This property does not apply to the loading of the xls formats.
*/ get isDuplicateFormulaParsingOptimized(): boolean; set isDuplicateFormulaParsingOptimized(a: boolean); /** * Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used. * @throws [[ArgumentException]] Occurs when the specified value is not empty and does not have two positive values. */ get screenDpi(): IgSize; set screenDpi(a: IgSize); /** * @hidden */ get _screenDpi$i(): Size; /** * @hidden */ set _screenDpi$i(a: Size); /** * Returns a list of user defined functions that should be registered before the workbook is loaded. */ get userDefinedFunctions(): IList$1When the associated Worksheet is protected, the ranges with a password * will be marked as protected until they are unprotected.
*/ get isProtected(): boolean; set isProtected(a: boolean); /** * Returns a collection of ranges that may be edited when the worksheet is protected. */ get ranges(): ICollection$1Note: If the range is not currently protected (i.e. [[isProtected]] returns * false) the method will not do anything.
* @see [[isProtected]] * @see [[hasPassword]] */ unprotect(): void; } /** * @hidden */ export declare class MathUtilities extends Base { static $t: Type; static get l(): CultureInfo; static q(a: number, b: CultureInfo): string; private static p; private static n; static r(a: number, b: CultureInfo): string; static b(a: string, b: IFormatProvider, c: number): { ret: boolean; p2: number; }; static c(a: string, b: IFormatProvider, c: number): { ret: boolean; p2: number; }; private static d; private static e; static m(a: number): number; static o(a: number): number; static f(a: number): number; private static a; static g(a: number, b: number): number; private static h; static i(a: number): number; static j(a: number): number; static k(a: number, b: number): number; } /** * Abstract base class for the fill of a cell. * @see [[IWorksheetCellFormat.fill]] * @see [[CellFillPattern]] * @see [[CellFillGradient]] * @see [[CellFillLinearGradient]] * @see [[CellFillRectangularGradient]] */ export declare abstract class CellFill extends Base { static $t: Type; /** * @hidden */ private static _a; /** * @hidden */ abstract _r(a: WorksheetCellFormatData, b: List$1* 'backgroundColorInfo' and 'patternColorInfo' can be specified as null to use the default colors. *
* @param backgroundColorInfo A [[WorkbookColorInfo]] which describes the background color of the cell, which will only be seen if the * 'patternStyle' is not None. * @param patternColorInfo A [[WorkbookColorInfo]] which describes the pattern color of the cell, which will only be seen if the * 'patternStyle' is not None or Solid. * @param patternStyle The fill pattern for the cell. * @throws [[InvalidEnumArgumentException]] 'patternStyle' is Default or not defined in the [[FillPatternStyle]] enumeration. * @see [[CellFillPattern]] */ static createPatternFill(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle): CellFillPattern; /** * Creates a solid color or pattern fill that can be applied to a cell. * @param backgroundColor The background color of the cell, which will only be seen if the 'patternStyle' is not None. * @param patternColor The pattern color of the cell, which will only be seen if the 'patternStyle' is not None or Solid. * @param patternStyle The fill pattern for the cell. * @throws [[ArgumentException]] 'backgroundColor' or 'patternColor' are the empty color or have a non-opaque alpha channel. * @throws [[InvalidEnumArgumentException]] 'patternStyle' is Default or not defined in the [[FillPatternStyle]] enumeration. * @see [[CellFillPattern]] */ static createPatternFill(backgroundColor: string | Color, patternColor: string | Color, patternStyle: FillPatternStyle): CellFillPattern; /** * @hidden */ static _createPatternFill1(a: Color, b: Color, c: FillPatternStyle): CellFillPattern; /** * @hidden */ static _createPatternFill(a: WorkbookColorInfo, b: WorkbookColorInfo, c: FillPatternStyle): CellFillPattern; /** * Creates a rectangular gradient that can be applied to a cell's fill. * @param colorInfo1 A [[WorkbookColorInfo]] which describes the color at the inner rectangle (cell center) of the gradient. * @param colorInfo2 A [[WorkbookColorInfo]] which describes the color at the outer rectangle (cell edges) of the gradient. * @throws [[ArgumentException]] 'colorInfo1' or 'colorInfo2' is an automatic or a system color. * @see [[CellFillRectangularGradient]] */ static createRectangularGradientFill(colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillRectangularGradient; /** * Creates a rectangular gradient that can be applied to a cell's fill. ** The rectangular gradient is defined by specifying an inner rectangle and a set of gradient stops. The gradient goes from the * edges of the inner rectangle to the edges of the cell. If the inner rectangle does not have a height or width of 0, the color * of the first gradient stop will be filled in the center of the inner rectangle. *
** The inner rectangle is defined by the 'left', 'top', 'right', and * 'bottom' parameters. They are relative values ranging from 0.0 to 1.0 and they go from the top/left to the * bottom/right. So, for example, to specify a gradient that goes out from the center, all values would be 0.5. Or to specify a * gradient which goes out from the bottom-left corner of the cell, the following values would be used: left = 0.0, top = 1.0, * right = 0.0, bottom = 1.0. *
* @param left The left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param top The top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param right The right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param bottom The bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param stops Two or more gradient stops which describe the color transitions and their positions within the gradient. * @throws [[ArgumentOutOfRangeException]] 'left', 'top', 'right', or 'bottom' are less than 0.0 or * greater than 1.0. * @throws [[ArgumentException]] 'stops' contains less than two gradient stops. There must be at least two stops to define the gradient. * @see [[CellFillRectangularGradient]] */ static createRectangularGradientFill(left: number, top: number, right: number, bottom: number, ...stops: CellFillGradientStop[]): CellFillRectangularGradient; /** * Creates a rectangular gradient that can be applied to a cell's fill. ** The rectangular gradient is defined by specifying an inner rectangle and a set of gradient stops. The gradient goes from the * edges of the inner rectangle to the edges of the cell. If the inner rectangle does not have a height or width of 0, the color * of the first gradient stop will be filled in the center of the inner rectangle. *
** The inner rectangle is defined by the 'left', 'top', 'right', and * 'bottom' parameters. They are relative values ranging from 0.0 to 1.0 and they go from the top/left to the * bottom/right. So, for example, to specify a gradient that goes out from the center, all values would be 0.5. Or to specify a * gradient which goes out from the bottom-left corner of the cell, the following values would be used: left = 0.0, top = 1.0, * right = 0.0, bottom = 1.0. *
* @param left The left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param top The top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param right The right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param bottom The bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param colorInfo1 A [[WorkbookColorInfo]] which describes the color at the inner rectangle of the gradient. * @param colorInfo2 A [[WorkbookColorInfo]] which describes the color at the outer rectangle (cell edges) of the gradient. * @throws [[ArgumentException]] 'colorInfo1' or 'colorInfo2' is an automatic or a system color. * @throws [[ArgumentOutOfRangeException]] 'left', 'top', 'right', or 'bottom' are less than 0.0 or * greater than 1.0. * @see [[CellFillRectangularGradient]] */ static createRectangularGradientFill(left: number, top: number, right: number, bottom: number, colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillRectangularGradient; /** * Creates a rectangular gradient that can be applied to a cell's fill. ** The rectangular gradient is defined by specifying an inner rectangle and a set of gradient stops. The gradient goes from the * edges of the inner rectangle to the edges of the cell. If the inner rectangle does not have a height or width of 0, the color * of the first gradient stop will be filled in the center of the inner rectangle. *
** The inner rectangle is defined by the 'left', 'top', 'right', and * 'bottom' parameters. They are relative values ranging from 0.0 to 1.0 and they go from the top/left to the * bottom/right. So, for example, to specify a gradient that goes out from the center, all values would be 0.5. Or to specify a * gradient which goes out from the bottom-left corner of the cell, the following values would be used: left = 0.0, top = 1.0, * right = 0.0, bottom = 1.0. *
* @param left The left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param top The top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param right The right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). * @param bottom The bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). * @param color1 The color at the inner rectangle of the gradient. * @param color2 The color at the outer rectangle (cell edges) of the gradient. * @throws [[ArgumentOutOfRangeException]] 'left', 'top', 'right', or 'bottom' are less than 0.0 or * greater than 1.0. * @throws [[ArgumentException]] 'color1' or 'color2' are empty or system colors or have a non-opaque alpha channel. * @see [[CellFillRectangularGradient]] */ static createRectangularGradientFill(left: number, top: number, right: number, bottom: number, color1: string | Color, color2: string | Color): CellFillRectangularGradient; /** * Creates a rectangular gradient that can be applied to a cell's fill. * @param color1 The color at the inner rectangle (cell center) of the gradient. * @param color2 The color at the outer rectangle (cell edges) of the gradient. * @throws [[ArgumentException]] 'color1' or 'color2' are empty or system colors or have a non-opaque alpha channel. * @see [[CellFillRectangularGradient]] */ static createRectangularGradientFill(color1: string | Color, color2: string | Color): CellFillRectangularGradient; /** * @hidden */ static _createRectangularGradientFill4(a: Color, b: Color): CellFillRectangularGradient; /** * @hidden */ static _createRectangularGradientFill3(a: number, b: number, c: number, d: number, e: Color, f: Color): CellFillRectangularGradient; /** * @hidden */ static _createRectangularGradientFill(a: WorkbookColorInfo, b: WorkbookColorInfo): CellFillRectangularGradient; /** * @hidden */ static _createRectangularGradientFill2(a: number, b: number, c: number, d: number, e: WorkbookColorInfo, f: WorkbookColorInfo): CellFillRectangularGradient; /** * @hidden */ static _createRectangularGradientFill1(a: number, b: number, c: number, d: number, ...e: CellFillGradientStop[]): CellFillRectangularGradient; /** * Creates a solid color fill that can be applied to a cell. * @param solidColorInfo A [[WorkbookColorInfo]] which describes the solid color of the fill. * @see [[CellFillPattern]] */ static createSolidFill(solidColorInfo: WorkbookColorInfo): CellFillPattern; /** * Creates a solid color fill that can be applied to a cell. * @param solidColor The solid color of the fill. * @throws [[ArgumentException]] 'solidColor' is the empty color or has a non-opaque alpha channel. * @see [[CellFillPattern]] */ static createSolidFill(solidColor: string | Color): CellFillPattern; /** * @hidden */ static _createSolidFill1(a: Color): CellFillPattern; /** * @hidden */ static _createSolidFill(a: WorkbookColorInfo): CellFillPattern; /** * @hidden */ static _q(a: WorkbookColorInfo): { p0?: WorkbookColorInfo; }; /** * @hidden */ static _p(a: Color): WorkbookColorInfo; /** * Gets the default cell fill, which is no background color. */ static get noColor(): CellFill; } /** * An immutable object which represents a solid or pattern fill for a cell. * @see [[IWorksheetCellFormat.fill]] */ export declare class CellFillPattern extends CellFill { static $t: Type; private readonly _v; private readonly _w; private readonly _t; constructor(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle); constructor(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle, owningFormat: WorksheetCellFormatData); constructor(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle, owningFormat: WorksheetCellFormatData, isCreatedInternally: boolean); constructor(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle, doesReverseColorsForSolidFill: boolean, isCreatedInternally: boolean); constructor(backgroundColorIndex: number, foregroundColorIndex: number, patternStyle: FillPatternStyle, owningFormat: WorksheetCellFormatData); constructor(..._rest: any[]); /** * Determines whether the [[CellFillPattern]] is equal to the specified object. * @param obj The object to test for equality. * @return True if the object is equal to this instance; False otherwise. */ equals(obj: any): boolean; /** * Gets the hash code for the [[CellFillPattern]]. * @return A number which can be used to hash this instance. */ getHashCode(): number; /** * @hidden */ _r(a: WorksheetCellFormatData, b: List$1* When used in a [[CellFillLinearGradient]], a value of 0.0 is at the beginning of the gradient and 1.0 is at the end of the * gradient. When used in a [[CellFillRectangularGradient]], a value of 0.0 is at the inner rectangle and 1.0 is at the outer * edges of the cell. *
* @see [[colorInfo]] */ get offset(): number; } /** * An immutable object which represents a color in a Microsoft Excel workbook. * @see [[IWorksheetCellFormat.bottomBorderColorInfo]] * @see [[IWorksheetCellFormat.diagonalBorderColorInfo]] * @see [[IWorksheetCellFormat.leftBorderColorInfo]] * @see [[IWorksheetCellFormat.rightBorderColorInfo]] * @see [[IWorksheetCellFormat.topBorderColorInfo]] * @see [[IWorkbookFont.colorInfo]] * @see [[CellFillPattern.backgroundColorInfo]] * @see [[CellFillPattern.patternColorInfo]] * @see [[CellFillGradientStop.colorInfo]] */ export declare class WorkbookColorInfo extends Base { static $t: Type; /** * @hidden */ private static readonly _a; private readonly _ag; private readonly _i; private readonly _v; private readonly _w; private _j; constructor(); constructor(color: string | Color); constructor(color: string | Color, tint: number); constructor(color: string | Color, transform: WorkbookColorTransform); constructor(themeColorType: WorkbookThemeColorType); constructor(themeColorType: WorkbookThemeColorType, tint: number); constructor(themeColorType: WorkbookThemeColorType, transform: WorkbookColorTransform); constructor(color: string | Color, themeColorType: WorkbookThemeColorType | null, tint: number | null, isLoading: boolean, preventUsingAutomaticColor?: boolean); constructor(color: string | Color, themeColorType: WorkbookThemeColorType | null, tint: number | null, transform: WorkbookColorTransform, isLoading: boolean, preventUsingAutomaticColor?: boolean); constructor(workbook: Workbook, index: number); constructor(..._rest: any[]); /** * Determines whether the [[WorkbookColorInfo]] is equal to the specified object. * @param obj The object to test for equality. * @return True if the object is equal to this instance; False otherwise. */ equals(obj: any): boolean; /** * Gets the hash code for the [[WorkbookColorInfo]]. * @return A number which can be used to hash this instance. */ getHashCode(): number; /** * Gets the string representation of the [[WorkbookColorInfo]]. * @return */ toString(): string; /** * Gets the actual color which will be seen in Microsoft Excel if the [[WorkbookColorInfo]] is used. * @throws [[ArgumentNullException]] The [[themeColorType]] is not null. When the ThemeColorType is set, the [[getResolvedColor]] method must be called with * a non-null [[Workbook]]. * @return A Color which combines the [[color]] and [[tint]] if it is set. */ getResolvedColor(): string; /** * Gets the actual color which will be seen in Microsoft Excel if the [[WorkbookColorInfo]] is used. * @param workbook The workbook in which the WorkbookColorInfo is used. * @throws [[ArgumentNullException]] 'workbook' is null and [[themeColorType]] is not null. When the ThemeColorType is set, the method must be called with a * non-null [[Workbook]]. * @return A Color which combines the [[color]], [[themeColorType]], and/or [[tint]], depending on what is set. */ getResolvedColor(workbook: Workbook): string; /** * @hidden */ _getResolvedColor(): Color; /** * @hidden */ _getResolvedColor1(a: Workbook): Color; /** * @hidden */ _aj(a: Workbook, b?: boolean, c?: boolean): Color; /** * @hidden */ _y(a: Workbook, b: ColorableItem): number; /** * @hidden */ _o(a: Workbook, b: ColorableItem): boolean; /** * @hidden */ _g(a: Workbook, b?: boolean): WorkbookColorInfo; /** * @hidden */ _h(a: WorkbookColorTransform): WorkbookColorInfo; /** * @hidden */ private static _u; /** * @hidden */ private static _ad; /** * @hidden */ private static _ae; /** * @hidden */ private static _af; /** * Gets the automatic color, which is the window text system color. * @see [[isAutomatic]] */ static get automatic(): WorkbookColorInfo; /** * Gets the base color associated of the [[WorkbookColorInfo]]. * @see [[tint]] */ get color(): string | Color; /** * @hidden */ get _color$i(): Nullable$1When protecting a Sheet, a password is optional. The HasProtectionPassword will return true if the * Sheet is currently protected (see [[isProtected]]) and a password was specified when it was protected.
* @see [[isProtected]] * @see@see [[sheetProtection]] * @see [[Worksheet.protect]] * @see [[unprotect]] */ get hasProtectionPassword(): boolean; /** * @hidden */ get _t(): boolean; /** * Returns a boolean indicating if the Worksheet has been protected. *The IsProtected property will return true if the Worksheet is currently protected. When a Worksheet is protected * only unprotected cells may be edited. In addition, other operations may be limited based on the properties of the * [[WorksheetProtection]] which may be accessed using the Protection property.
* @see [[hasProtectionPassword]] * @see [[sheetProtection]] * @see [[WorksheetProtection]] * @see@see [[Worksheet.protection]] * @see [[Chartsheet.protection]] * @see [[unprotect]] */ get isProtected(): boolean; /** * @hidden */ get _w(): boolean; /** * @hidden */ set _w(a: boolean); /** * Gets or sets the sheet name. *The sheet name is case-insensitively unique in the workbook.
** The sheet name is shown in the tab for the worksheet. In addition, the worksheet name can be used by formulas * from other worksheets to refer to cells in this worksheet. *
* The sheet name. * @throws [[ArgumentNullException]] The value assigned is null or empty. * @throws [[ArgumentException]] The value assigned contains the invalid characters: ':', '\', '/', '?', '*', '[', or ']'. * @throws [[ArgumentException]] The value assigned exceeds 31 characters in length. * @throws [[ArgumentException]] The value assigned is being used as the name of another sheet (sheet names are case-insensitively compared). */ get name(): string; set name(a: string); /** * @hidden */ private _at; /** * @hidden */ abstract get _g(): PrintOptionsBase; /** * Gets the value which indicates whether this worksheet is selected. ** If the worksheet has been removed from its parent [[Workbook.worksheets]] collection, this will always return False. *
* The value which indicates whether this worksheet is selected. * @see [[WindowOptions]] * @see */ get selected(): boolean; /** * @hidden */ abstract get _p(): WorksheetShapeCollection; /** * @hidden */ get _am(): number; /** * Gets the zero-based index of this sheet in its parent [[Workbook.sheets]] collection. ** Negative one indicates the sheet has been removed from its parent collection. *
* The zero-based index of this sheet in its parent Sheets collection. * @see [[SheetCollection.indexOf]] * @see [[moveToSheetIndex]] */ get sheetIndex(): number; /** * @hidden */ abstract get _i(): SheetProtection; /** * Gets or sets the [[WorkbookColorInfo]] to use for the associated sheet's tab in the tab bar of Microsoft Excel. ** If the tab bar is not visible, this color will not be seen. *
* The WorkbookColorInfo to use for the associated sheet's tab in the tab bar of Microsoft Excel. * @see [[WindowOptions.tabBarVisible]] */ get tabColorInfo(): WorkbookColorInfo; set tabColorInfo(a: WorkbookColorInfo); /** * Returns a value indicating the type of sheet */ abstract get type(): SheetType; /** * @hidden */ get _ak(): string; /** * @hidden */ set _ak(a: string); /** * Gets the [[workbook]] that owns the worksheet. * The Workbook that owns the worksheet. */ get workbook(): Workbook; /** * @hidden */ protected get__ag(): number; /** * @hidden */ get _ag(): number; /** * @hidden */ private static _b; /** * @hidden */ abstract _d(a: CustomView): DisplayOptionsBase; /** * @hidden */ abstract _f(): PrintOptionsBase; /** * Moves the sheet to a new position in the owning workbook's collections of sheets. * @param index The new 0-based index to where the sheet should be moved. * @throws [[InvalidOperationException]] The sheet has previously been removed from its workbook. * @throws [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to the number of sheets in the owning workbook. * @see [[Workbook.sheets]] * @see [[SheetCollection.indexOf]] * @see [[sheetIndex]] */ moveToSheetIndex(index: number): void; /** * @hidden */ _ao(a: WorkbookFormat): void; /** * @hidden */ _ap(): void; /** * @hidden */ _aq(): void; /** * @hidden */ _ar(): void; /** * @hidden */ _as(a: WorksheetVisibility, b: WorksheetVisibility): void; /** * Removes the Sheet protection. * @see [[isProtected]] * @see [[hasProtectionPassword]] * @see [[Worksheet.protect]] */ unprotect(): void; /** * @hidden */ static readonly _ab: number; /** * @hidden */ static _aw(a: string, b: string): void; /** * @hidden */ _av(a: FormatLimitErrors, b: WorkbookFormat): void; } /** * @hidden */ export interface IWorksheetShapeOwner extends ISheetProvider { onChildShapeBoundsChanged(a: WorksheetShape, b: WorksheetCellAddress, c: WorksheetCellAddress, d: boolean): void; onShapeAdded(a: WorksheetShape): void; onShapeRemoved(a: WorksheetShape): void; readonly areChildrenTopMost: boolean; readonly ChildShapes: WorksheetShapeCollection; } /** * @hidden */ export declare let IWorksheetShapeOwner_$type: Type; /** * A sheet in a Mirosoft Excel workbook that displays a single chart. */ export declare class Chartsheet extends Sheet implements IWorksheetShapeOwner, ISheetBackground { static $t: Type; /** * @hidden */ private static readonly _a8; /** * @hidden */ private static readonly _a9; /** * @hidden */ private static _ax; private readonly _a6; private _be; private _az; private _a1; private readonly _a3; private _ba; static staticInit(): void; constructor(a: string, b: Workbook, c: number); /** * @hidden */ _d(a: CustomView): DisplayOptionsBase; /** * @hidden */ _f(): PrintOptionsBase; /** * @hidden */ protected get__e(): DisplayOptionsBase; /** * @hidden */ get _e(): DisplayOptionsBase; /** * @hidden */ _ao(a: WorkbookFormat): void; /** * @hidden */ protected get__g(): PrintOptionsBase; /** * @hidden */ get _g(): PrintOptionsBase; /** * @hidden */ protected get__p(): WorksheetShapeCollection; /** * @hidden */ get _p(): WorksheetShapeCollection; /** * @hidden */ protected get__i(): SheetProtection; /** * @hidden */ get _i(): SheetProtection; /** * Returns Chartsheet */ protected get_type(): SheetType; /** * Returns Chartsheet */ get type(): SheetType; /** * Returns the [[WorksheetChart]] displayed in this chartsheet. */ get chart(): WorksheetChart; /** * Gets the object which controls the display of the chartsheet. ** The display options include any settings which affect the display of the chartsheet when viewed in Microsoft Excel. * These settings will not affect the printed chartsheet or the data stored in the chartsheet. *
* The object which controls the display of the chartsheet. * @see [[CustomView.getSheetDisplayOptions]] */ get displayOptions(): ChartsheetDisplayOptions; /** * @hidden */ get _bf(): WBitmap; /** * @hidden */ set _bf(a: WBitmap); /** * @hidden */ private _bd; /** * @hidden */ get _bb(): any; /** * @hidden */ set _bb(a: any); /** * @hidden */ _a7: ImageFormat; /** * Gets the object which controls how the chartsheet prints. * The object which controls how the chartsheet prints. * @see [[CustomView.getSheetPrintOptions]] */ get printOptions(): ChartsheetPrintOptions; /** * Returns an object that provides information used when the Chartsheet has been protected. * @see@see@see [[ChartsheetProtection]] * @see [[protect]] * @see */ get protection(): ChartsheetProtection; /** * @hidden */ private static _ay; /** * Protects the chartsheet without a password. *When a Chartsheet is protected without a password, the end user may unprotect the Chartsheet in Excel without * having to supply a password. To programatically unprotect a Chartsheet, one may use the Unprotect() method.
*The optional parameters are used to update the property values of the [[ChartsheetProtection]] instance from * this Worksheet's [[protection]] property. If the parameter is null, the current value of the associated property will * be retained; otherwise the property will be updated with the specified value. For example, if the [[ChartsheetProtection.allowEditObjects]] * is currently true and the 'allowEditObjects' is null, then the property will continue to be true but if the * 'allowEditObjects' is false the [[ChartsheetProtection.allowEditObjects]] will be changed to false.
*Note: If IsProtected is already true, the method will be ignored.
* @param allowEditObjects Optional boolean indicating the new value for the [[ChartsheetProtection.allowEditObjects]]. * @param allowEditContents Optional boolean indicating the new value for the ChartsheetProtection.AllowEditScenarios. * @see@see@see [[protection]] * @see [[ChartsheetProtection]] * @see */ protect(allowEditObjects?: boolean, allowEditContents?: boolean): void; /** * @hidden */ _protect$i(a?: Nullable$1* This property is only applicable to doughnut charts. *
** The valid range for this property is 0 through 90, inclusive. *
* @see [[WorksheetChart.doughnutHoleSize]] */ get doughnutHoleSize(): number | null; set doughnutHoleSize(a: number | null); /** * @hidden */ get _doughnutHoleSize$i(): Nullable$1* This property is only applicable to pie and doughnut charts. *
** The valid range for this property is between 0 and 360, inclusive. *
* @see [[WorksheetChart.firstSliceAngle]] */ get firstSliceAngle(): number | null; set firstSliceAngle(a: number | null); /** * @hidden */ get _firstSliceAngle$i(): Nullable$1* This property is only applicable for bar charts. *
** The valid range for this property is between 0 and 500, inclusive. *
* @see [[WorksheetChart.gapWidth]] */ get gapWidth(): number | null; set gapWidth(a: number | null); /** * @hidden */ get _gapWidth$i(): Nullable$1* This property is only applicable for bar charts. *
** The valid range for this property is between -100 and 100, inclusive. *
* @see [[WorksheetChart.seriesOverlap]] */ get seriesOverlap(): number | null; set seriesOverlap(a: number | null); /** * @hidden */ get _seriesOverlap$i(): Nullable$1* This collection is used to apply chart-specific properties to [[Series]] which * appear within a combo chart. *
* @see [[ComboChartGroup]] * @see [[WorksheetChart.comboChartGroups]] */ export declare class ComboChartGroupCollection extends ChartObject implements IEnumerable$1* This method returns an object which provides a way to set chart-specific * properties for a [[Series]] that is displayed within a combo chart. *
** For example, to change the [[WorksheetChart.gapWidth]] property for * each series associated with a bar chart contained within a combo chart, set the * [[ComboChartGroup.gapWidth]] property of the instance returned from * this method. *
** If a [[ComboChartGroup]] instance corresponding to the specified * 'chartType' and 'axisGroup' already exists, * that instance is returned; otherwise a new instance is created and that instance * is returned. *
* @param chartType A [[ChartType]] constant which identifies the combo chart group. * @param axisGroup An [[AxisGroup]] constant which identifies the combo chart group. * @return A new or existing [[ComboChartGroup]] instance. * @see [[ComboChartGroup]] * @see [[remove]] * @throws [[NotSupportedException]] The specified 'chartType' is not supported within a combo chart. * See documentation for the WorksheetChart.* Atomic shapes are singular shape entities, such as an image, a polygon, or text. * Compound shapes are groupings of shapes, and are represented by [[WorksheetShapeGroup]] * instances. *
** Currently, not all shape information is customizable (such as shape rotation). However, * for round-tripping purposes, when a shape is loaded from an Excel file, this * information in maintained with the shape. See [[clearUnknownData]] for more * information about unsupported data. *
*/ export declare abstract class WorksheetShape extends Base implements IRegionAddress, IChangeInfoContext { static $t: Type; /** * @hidden */ private static readonly _bo; /** * @hidden */ private static readonly _bq; /** * @hidden */ private static readonly _br; /** * @hidden */ private static readonly _bs; /** * @hidden */ private static readonly _bu; /** * @hidden */ private static readonly _bv; /** * @hidden */ private static readonly _bw; /** * @hidden */ private static readonly _bx; /** * @hidden */ private static readonly _bp; /** * @hidden */ private static readonly _bt; /** * @hidden */ static readonly _cg: number; /** * @hidden */ static readonly _ch: number; /** * @hidden */ static readonly _ci: number; /** * @hidden */ static readonly _cj: number; /** * @hidden */ static readonly _cl: number; /** * @hidden */ static readonly _ck: number; /** * @hidden */ static readonly _cm: number; /** * @hidden */ private static _a; /** * @hidden */ private static _bf; /** * @hidden */ private static _bg; private _an; private _u; private _ac; private _dj; private _dq; private _o; private _w; private _ag; private _ai; private _ae; private _dl; private _b2; private _bd; private _bh; private _bj; private _bl; private _g; private _b5; private _cc; private _ce; private _e; private _cn; private _at; private _av; private _i; private _l; private _ba; /** * @hidden */ _cb: number; static staticInit(): void; constructor(a: number); constructor(a: number, b: boolean); constructor(a: number, b: WorksheetShape); constructor(a: number, ..._rest: any[]); /** * Clears the cached unknown shape data which was read in from a parsed excel file. ** This method will only be needed until all shape information is supported and customizable. * After all shape data can be controlled, this method will become obsolete. Currently, all * unsupported data will be stored with the shape for round-tripping purposes. For example, * if an Excel file with complex and unsupported shapes is loaded into a * [[Workbook]] instance, some cell values are changed, and it is saved to * the same file, the complex shapes will still exist in the workbook. However, if a * loaded shape needs to be modified before it is saved back, this method * allows for that unsupported data to be removed while all supported data is maintained. *
** Note: This method only clears unsupported data. In future versions of the product, * as more shape data is supported, this method will have different effects on the shape, * until eventually all data is supported and this method will have no effect on the shape. *
* @throws [[InvalidOperationException]] This method is called on an [[UnknownShape]] instance. */ clearUnknownData(): void; /** * Creates a shape which is predefined in Microsoft Excel. * @param shapeType The type of shape to create. * @throws [[InvalidEnumArgumentException]] 'shapeType' is not defined in the [[PredefinedShapeType]] enumeration. * @return A [[WorksheetShape]]-derived instance representing the predefined shape. */ static createPredefinedShape(shapeType: PredefinedShapeType): WorksheetShape; /** * @hidden */ static _al(a: PredefinedShapeType, b: boolean): WorksheetShape; /** * Gets the bounds of the shape in twips (1/20th of a point). ** The bounds returned by this method are only valid with the current configuration of the worksheet. * If any rows or columns before or within the shape are resized, these bounds will no longer reflect the * position of the shape. *
* @throws [[InvalidOperationException]] The [[topLeftCornerCell]] or [[bottomRightCornerCell]] are null, in which case the shape has no bounds. * @return The bounds of the shape on its worksheet. * @see [[setBoundsInTwips]] */ getBoundsInTwips(): IgRect; /** * Gets the bounds of the shape in twips (1/20th of a point). ** The bounds returned by this method are only valid with the current configuration of the worksheet. * If any rows or columns before or within the shape are resized, these bounds will no longer reflect the * position of the shape. *
* @param options The options to use when getting the bounds of the shape. * @throws [[InvalidOperationException]] The [[topLeftCornerCell]] or [[bottomRightCornerCell]] are null, in which case the shape has no bounds. * @return The bounds of the shape on its worksheet. * @see [[setBoundsInTwips]] */ getBoundsInTwips(options: PositioningOptions): IgRect; /** * @hidden */ _getBoundsInTwips(): Rect; /** * @hidden */ _getBoundsInTwips1(a: PositioningOptions): Rect; /** * Sets the bounds of the shape in twips (1/20th of a point). ** The shape will only be positioned at the specified bounds while the worksheet remains in the current configuration. * Depending on the [[positioningMode]] of the shape, it may change bounds if any rows or columns before or within the shape are resized. *
* @throws [[ArgumentNullException]] 'sheet' is null. * @param sheet The worksheet on which the shape should be placed. * @param bounds The new bounds where the shape should be placed. */ setBoundsInTwips(sheet: Sheet, bounds: IgRect): void; /** * Sets the bounds of the shape in twips (1/20th of a point). ** The shape will only be positioned at the specified bounds while the worksheet remains in the current configuration. * Depending on the [[positioningMode]] of the shape, it may change bounds if any rows or columns before or within the shape are resized. *
* @throws [[ArgumentNullException]] s * * 'sheet' is null. * @param sheet The sheet on which the shape should be placed. * @param bounds The new bounds where the shape should be placed. * @param options The options to use when setting the bounds of the shape. */ setBoundsInTwips(sheet: Sheet, bounds: IgRect, options: PositioningOptions): void; /** * @hidden */ _setBoundsInTwips(a: Sheet, b: Rect): void; /** * @hidden */ _setBoundsInTwips1(a: Sheet, b: Rect, c: PositioningOptions): void; /** * @hidden */ private static _da; /** * @hidden */ private _c9; /** * @hidden */ _de(a: WorksheetShapePosition): void; /** * @hidden */ abstract _am* Note: some shapes, such as connectors or groups, cannot have a fill set. For these shapes, the value on this property * will be ignored and lost when the workbook is saved. *
* A [[ShapeFill]]-derived instance describing the fill of the shape, or null for no fill. * @see [[ShapeFill.fromColor]] * @see [[ShapeFillSolid]] * @see [[outline]] */ get fill(): ShapeFill; set fill(a: ShapeFill); /** * @hidden */ get _k(): ShapeFill; /** * Gets or sets the cell where the bottom-right corner of the shape resides. ** This anchor cell, along with the [[topLeftCornerCell]], determines where the shape will be * positioned on the worksheet. In addition, the [[bottomRightCornerPosition]] and * [[topLeftCornerPosition]] properties allow for finer control of the shape's position. *
* The cell where the bottom-right corner of the shape resides. * @throws [[ArgumentException]] The value assigned is a cell whose worksheet is not the same as this shape's worksheet. * @throws [[ArgumentNullException]] The value assigned is null and this shape already exists on a worksheet or group. * @see [[bottomRightCornerPosition]] * @see [[topLeftCornerCell]] * @see [[topLeftCornerPosition]] */ get bottomRightCornerCell(): WorksheetCell; set bottomRightCornerCell(a: WorksheetCell); /** * Gets or sets the position in the [[bottomRightCornerCell]] of the shape's bottom-right corner, * expressed in percentages. ** These percentages are expressed as distance across the associated dimension of the cell, starting at the * top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas * (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location * in the cell which is centered horizontally, and a tenth of the way down from the top. *
* The position in the bottom-right corner cell of the shape's bottom-right corner. * @throws [[ArgumentOutOfRangeException]] Either coordinate of the value assigned is outside the range of 0.0 to 100.0. * @see [[bottomRightCornerCell]] * @see [[topLeftCornerCell]] * @see [[topLeftCornerPosition]] */ get bottomRightCornerPosition(): IgPoint; set bottomRightCornerPosition(a: IgPoint); /** * @hidden */ get _bottomRightCornerPosition$i(): Point; /** * @hidden */ set _bottomRightCornerPosition$i(a: Point); /** * Gets or sets the value which indicates whether the shape is flipped horizontally along the vertical center line. * @throws [[InvalidOperationException]] The value is set to True and this shape doesn't allow flipping or rotating, such as a [[WorksheetChart]]. */ get flippedHorizontally(): boolean; set flippedHorizontally(a: boolean); /** * Gets or sets the value which indicates whether the shape is flipped vertically along the horizontal center line. * @throws [[InvalidOperationException]] The value is set to True and this shape doesn't allow flipping or rotating, such as a [[WorksheetChart]]. */ get flippedVertically(): boolean; set flippedVertically(a: boolean); /** * Gets or sets the outline to use for the shape. ** Note: some shapes, such as comments or groups, cannot have a outline set. For these shapes, the value on this property * will be ignored and lost when the workbook is saved. *
* A [[ShapeOutline]]-derived instance describing the outline of the shape, or null for no outline. * @see [[ShapeOutline.fromColorInfo]] * @see [[ShapeOutlineSolid]] * @see [[fill]] */ get outline(): ShapeOutline; set outline(a: ShapeOutline); /** * @hidden */ get _n(): ShapeOutline; /** * Gets or sets the way shapes will be repositioned in excel when cells before or within the shape are resized. ** This value will not be saved for shapes contained in a [[WorksheetShapeGroup]], which inherit their * positioning mode from their parent group. *
* The way shapes will be repositioned in excel when cells before or within the shape are resized. * @throws [[InvalidEnumArgumentException]] The value assigned is not defined in the [[ShapePositioningMode]] enumeration. */ get positioningMode(): ShapePositioningMode; set positioningMode(a: ShapePositioningMode); /** * @hidden */ get _q(): ShapePositioningMode; /** * @hidden */ get _b6(): number; /** * @hidden */ set _b6(a: number); /** * Gets or sets the cell where the top-left corner of the shape resides. ** This anchor cell, along with the [[bottomRightCornerCell]], determines where the shape will be * positioned on the worksheet. In addition, the [[bottomRightCornerPosition]] and * [[topLeftCornerPosition]] properties allow for finer control of the shape's position. *
* The cell where the top-left corner of the shape resides. * @throws [[ArgumentException]] The value assigned is a cell whose worksheet is not the same as this shape's worksheet. * @throws [[ArgumentNullException]] The value assigned is null and this shape already exists on a worksheet or group. * @see [[bottomRightCornerCell]] * @see [[bottomRightCornerPosition]] * @see [[topLeftCornerPosition]] */ get topLeftCornerCell(): WorksheetCell; set topLeftCornerCell(a: WorksheetCell); /** * Gets or sets the position in the [[topLeftCornerCell]] of the shape's top-left corner, * expressed in percentages. ** These percentages are expressed as distance across the associated dimension of the cell, starting at the * top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas * (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location * in the cell which is centered horizontally, and a tenth of the way down from the top. *
* The position in the top-left corner cell of the shape's top-left corner. * @throws [[ArgumentOutOfRangeException]] Either coordinate of the value assigned is outside the range of 0.0 to 100.0. * @see [[bottomRightCornerCell]] * @see [[bottomRightCornerPosition]] * @see [[topLeftCornerCell]] */ get topLeftCornerPosition(): IgPoint; set topLeftCornerPosition(a: IgPoint); /** * @hidden */ get _topLeftCornerPosition$i(): Point; /** * @hidden */ set _topLeftCornerPosition$i(a: Point); /** * Gets or sets the value indicating whether the shape is visible on the worksheet. * The value indicating whether the shape is visible on the worksheet. */ get visible(): boolean; set visible(a: boolean); /** * Gets the worksheet on which the shape resides. * The worksheet on which the shape resides. */ protected get_sheet(): Sheet; /** * Gets the worksheet on which the shape resides. * The worksheet on which the shape resides. */ get sheet(): Sheet; /** * Gets the worksheet on which the shape resides. * The worksheet on which the shape resides. */ get worksheet(): Worksheet; /** * @hidden */ get _ad(): WorksheetCellAddress; /** * @hidden */ get _af(): WorksheetCellAddress; /** * @hidden */ get _v(): Worksheet; /** * @hidden */ get _f(): ICalloutRule; /** * @hidden */ set _f(a: ICalloutRule); /** * @hidden */ protected get__aq(): boolean; /** * @hidden */ get _aq(): boolean; /** * @hidden */ protected get__ar(): boolean; /** * @hidden */ get _ar(): boolean; /** * @hidden */ protected get__as(): boolean; /** * @hidden */ get _as(): boolean; /** * @hidden */ get _bi(): List$1* A point is a graphical unit equal to 1/72", i.e., there are 72 points in one inch. *
*/ get widthInPoints(): number; set widthInPoints(a: number); /** * @hidden */ protected get__ai(): Nullable$1* The color of the border is controlled by the [[ChartLineBase.fill]] property. *
** The width of the border lines are controlled by the [[ChartLineBase.widthInPoints]] property. *
*/ export declare class ChartBorder extends ChartLineBase { static $t: Type; /** * @hidden */ private static readonly _aq; /** * @hidden */ private static readonly _ar; private _an; static staticInit(): void; constructor(); constructor(owner: IChartObject); constructor(..._rest: any[]); /** * Returns or sets the line style for the border, i.e., * solid, dashed, dotted, etc. */ get lineStyle(): BorderLineStyle; set lineStyle(a: BorderLineStyle); /** * @hidden */ protected get__ai(): Nullable$1* Formulas provide a way to show dynamic values in a cell. The value could be based any number of factors, such as * the values of other cells and the time of day. Those alternate cells can even exist in different workbook files * on the user's machine or on the internet. *
** See Microsoft Excel help for more information on formulas. *
** Use one of the Parse or TryParse overloads to create a new formula. *
*/ export declare abstract class Formula extends Base { static $t: Type; /** * @hidden */ static readonly _be: number; /** * @hidden */ static readonly _bd: number; /** * @hidden */ private static readonly _bf; /** * @hidden */ private static readonly _bc; /** * @hidden */ private static _a; private _a8; private _q; private _a9; /** * @hidden */ _d: FormulaToken[]; private _r; static staticInit(): void; constructor(a: number, b: number, c: FormulaType); constructor(a: number, b: ArrayFormula); constructor(a: number, b: WorksheetDataTable); constructor(a: number, b: Formula, c?: boolean); constructor(a: number, ..._rest: any[]); /** * Converts the formula to a string representation, similar to the string with which it was created. * This uses the [[CellReferenceMode]] with which the formula was created to create cell * reference strings. * @return The string representing the formula. */ toString(): string; /** * Converts the formula to a string representation, similar to the string with which it was created. * @param cellReferenceMode The cell reference mode used to create cell reference strings. * @return The string representing the formula. */ toString(cellReferenceMode: CellReferenceMode): string; /** * Converts the formula to a string representation, similar to the string with which it was created. * @param cellReferenceMode The cell reference mode used to create cell reference strings. * @param culture The culture used to generate the formula string. * @return The string representing the formula. */ toString(cellReferenceMode: CellReferenceMode, culture: string | CultureInfo): string; /** * @hidden */ _toString(): string; /** * Applies the formula to all specified regions of cells. ** This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula. *
** After this method returns, the [[WorksheetCell.formula]] of all cells in all specified regions will * return the formula. *
* @param regions The regions of cells to apply the formula to. * @throws [[ArgumentNullException]] 'regions' is null. * @throws [[ArgumentException]] 'regions' has a length of 0. * @throws [[ArgumentException]] Not all regions specified are from the same worksheet. * @throws [[InvalidOperationException]] One or more regions specified contain array formulas or data tables which extend outside the region. * @see [[applyTo]] * @see [[applyTo]] * @see [[WorksheetCell.applyFormula]] * @see [[WorksheetRegion.applyFormula]] */ applyTo(regions: WorksheetRegion[]): void; /** * Applies the formula to the specified cell. ** This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula. *
** After this method returns, the [[WorksheetCell.formula]] of the specified cell will return the formula. *
* @param cell The cell to apply the formula to. * @throws [[ArgumentNullException]] 'cell' is null. * @throws [[InvalidOperationException]] 'cell' is part of an array formula or data table which is not confined to just the cell. * @see [[WorksheetCell.value]] * @see [[applyTo]] * @see [[applyTo]] * @see [[WorksheetCell.applyFormula]] * @see [[WorksheetRegion.applyFormula]] * @see [[WorksheetRegion.applyArrayFormula]] */ applyTo(cell: WorksheetCell): void; /** * Applies the formula to the specified region of cells. ** This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula. *
** After this method returns, the [[WorksheetCell.formula]] of all cells in the specified region will * return the formula. *
* @param region The region of cells to apply the formula to. * @throws [[ArgumentNullException]] 'region' is null. * @throws [[InvalidOperationException]] 'region' contains an array formula or data table which extends outside the region. * @see [[applyTo]] * @see [[applyTo]] * @see [[WorksheetCell.applyFormula]] * @see [[WorksheetRegion.applyFormula]] * @see [[WorksheetRegion.applyArrayFormula]] */ applyTo(region: WorksheetRegion): void; /** * @hidden */ _applyTo2(a: WorksheetCell): void; /** * @hidden */ _bp(a: WorksheetRow, b: number, c?: ApplyFormulaFlags): void; /** * @hidden */ _applyTo3(a: WorksheetRegion): void; /** * @hidden */ _applyTo(a: WorksheetRegion[]): void; /** * @hidden */ _toString1(a: CellReferenceMode): string; /** * @hidden */ _toString2(a: CellReferenceMode, b: CultureInfo): string; /** * @hidden */ _bq(a: WorksheetRow, b: number, c: WorksheetRow, d: number, e?: ApplyFormulaFlags): void; /** * @hidden */ _bm(a: WorksheetRegion[], b: WorksheetRow, c: number, d?: ApplyFormulaFlags): void; /** * @hidden */ _br(a: WorksheetRow, b: number, c: WorksheetCellBlock): void; /** * @hidden */ _ad(a: Workbook, b: WorksheetRow, c: number, d: Point): boolean; /** * @hidden */ abstract _g(): Formula; /** * @hidden */ _b6(a: Workbook): void; /** * @hidden */ _b5(a: FormulaContext): void; /** * @hidden */ protected get__i(): Formula; /** * @hidden */ get _i(): Formula; /** * @hidden */ _bs(a: Workbook, b: WorksheetTable): void; /** * @hidden */ _bt(a: Workbook): void; /** * @hidden */ static _u(a: Formula, b: WorksheetCell): SingleTargetFormula; /** * @hidden */ _bu(): void; /** * @hidden */ _ae(): boolean; /** * @hidden */ _af(): boolean; /** * @hidden */ _c(a: Workbook, b: Worksheet): WorksheetRegionAddress[]; /** * @hidden */ _bv(a: Worksheet, b: WorkbookReferenceBase, c: Worksheet, d: Nullable$1* The formatting of the string is controlled in a similar fashion as it would be in Microsoft Excel. In Excel, the user * must select a portion of the text and set the various formatting properties of that selected text. *
*
* With the FormattedString, a portion of the string is "selected" by calling either
* Getting the formatting properties of a [[FormattedStringFont]] will return the formatting of the first * character in font's selection range. This is similar to Excel, which will update the formatting interface to * reflect the formatting of the first character in a selection range when a cell's text is selected. *
*/ export declare class FormattedString extends Base implements IWorksheetCellOwnedValue, IComparable$1* This will return the same value as [[unformattedString]]. *
* @return The String that represents this FormattedString. */ toString(): string; /** * @hidden */ get sheet(): Sheet; /** * @hidden */ get source(): any; /** * @hidden */ compareTo(other: FormattedString): number; /** * @hidden */ get owner(): any; /** * @hidden */ get workbook(): Workbook; /** * @hidden */ getOwnerAt(startIndex: number): IFormattedRunOwner; /** * @hidden */ onFormattingChanged(): void; /** * @hidden */ setWorkbook(workbook: Workbook): void; /** * @hidden */ get isOwnedByAllCellsAppliedTo(): boolean; /** * @hidden */ setOwningCell(row: WorksheetRow, columnIndex: number): void; /** * @hidden */ _setOwningCell(a: WorksheetRow, b: number): void; /** * @hidden */ verifyNewOwner(ownerRow: WorksheetRow, ownerColumnIndex: number): void; /** * @hidden */ _verifyNewOwner1(a: IFormattedStringOwner): void; /** * @hidden */ _w(): void; /** * @hidden */ _x(): void; /** * @hidden */ private _y; /** * Creates a new [[FormattedString]] that is a copy of this one. ** This should be used if the same formatted string needs to be used in multiple cells. * The FormattedString class can only exist as the [[WorksheetCell.value]] * of one cell at a time. If the FormattedString is already the value of a cell, and needs * to be set as the value of another cell, clone the FormattedString and set the returned * clone as value of the cell. *
** The cloned FormattedString only takes its original configuration for this instance. * If this instance is cloned and than changed, the clone will not be changed as well; it will * remain as it was when it was cloned. *
* @return A new FormattedString that is a copy of this one. */ clone(): FormattedString; /** * @hidden */ private static _aa; /** * @hidden */ private static _b; /** * @hidden */ _e(): FormattedStringElement; /** * Gets the font which controls the formatting properties in the string from the specified start index to * the end of the string. ** If the start index is greater than or equal to the length of the unformatted string, no exception * will be thrown. It will be thrown later when one of the formatting properties of the returned * [[FormattedStringFont]] is set. *
* @param startIndex The index of the first character the returned font controls. * @throws [[ArgumentOutOfRangeException]] 'startIndex' is less than zero. * @return A FormattedStringFont instance which controls the formatting of the end portion of the string. */ getFont(startIndex: number): FormattedStringFont; /** * Gets the font which controls the formatting properties in the string from the specified start index for * the specified number of characters. ** If the start index is greater than or equal to the length of the unformatted string, no exception * will be thrown. It will be thrown later when one of the formatting properties of the returned * [[FormattedStringFont]] is set. *
* @param startIndex The index of the first character the returned font controls. * @param length The number of characters after the start index controlled by the returned font. * @throws [[ArgumentOutOfRangeException]] 'startIndex' is less than zero. * @throws [[ArgumentOutOfRangeException]] 'length' is less than one. A zero length string cannot be controlled by a formatting font. * @return A FormattedStringFont instance which controls the formatting of a portion of the string. */ getFont(startIndex: number, length: number): FormattedStringFont; /** * @hidden */ _getFont(a: number): FormattedStringFont; /** * @hidden */ _getFont1(a: number, b: number): FormattedStringFont; /** * Gets the collection of formatting runs representing contiguous blocks of similar formatting starting at the beginning of the string. */ private _getFormattingRuns; getFormattingRuns(): IEnumerable$1* If the new unformatted string assigned is shorter than the old unformatted string, all formatting * outside the range of the new value will be lost. *
* The unformatted string. * @throws [[ArgumentNullException]] The value assigned is a null string. */ get unformattedString(): string; set unformattedString(a: string); /** * @hidden */ private _ad; /** * @hidden */ get _m(): StringElement; /** * @hidden */ get _owner(): IFormattedStringOwner; /** * @hidden */ set _owner(a: IFormattedStringOwner); /** * @hidden */ get _t(): number; /** * @hidden */ get _sheet(): Sheet; /** * @hidden */ get _workbook(): Workbook; } /** * Represents the text area of a chart element. * @see [[ChartTitle]] * @see [[DisplayUnitLabel]] */ export declare class ChartTextAreaBase extends ChartObject implements IFormattedStringOwner { static $t: Type; /** * @hidden */ private static readonly _bl; /** * @hidden */ private static readonly _bm; /** * @hidden */ private static readonly _bn; /** * @hidden */ private static readonly _bo; /** * @hidden */ private static readonly _bp; /** * @hidden */ private static readonly _bq; /** * @hidden */ private static readonly _bs; /** * @hidden */ private static readonly _bt; /** * @hidden */ private static readonly _bu; /** * @hidden */ private static readonly _bw; /** * @hidden */ private static readonly _bv; /** * @hidden */ private static readonly _bx; /** * @hidden */ private static readonly _by; /** * @hidden */ private static readonly _bz; /** * @hidden */ private static readonly _b0; /** * @hidden */ static readonly _br: number; /** * @hidden */ static readonly _ai: HorizontalTitleAlignment; /** * @hidden */ static readonly _ar: TextHorizontalOverflow; /** * @hidden */ static readonly _bg: number; /** * @hidden */ static readonly _af: ElementPosition; /** * @hidden */ static readonly _al: ReadingOrder; /** * @hidden */ static readonly _bh: number; /** * @hidden */ static readonly _ao: TextDirection; /** * @hidden */ static readonly _ax: VerticalTitleAlignment; /** * @hidden */ static readonly _au: TextVerticalOverflow; /** * @hidden */ static readonly _ba: boolean; /** * @hidden */ private static _w; private _z; private _a8; private _ab; private _a4; private _b1; private _ah; private _aq; private _bd; private _ae; private _ak; private _be; private _az; private _an; private _bf; private _aw; private _at; private _a9; static staticInit(): void; constructor(a: IChartObject); /** * @hidden */ _a(a: number): ChangeInfo; /** * @hidden */ _m(a: (arg1: Sheet, arg2: Formula) => void): void; /** * @hidden */ _i(a: Worksheet, b: WorksheetRegionAddress): boolean; /** * @hidden */ _o(a: (arg1: IChartObject, arg2: any) => void, b: CellShiftOperation, c: ICellShiftOperationOverride): void; /** * @hidden */ _k(a: any): any; /** * @hidden */ _t(a: Worksheet): void; /** * Determines the appearance of the border drawn around * the text area, as well as whether a border appears. */ get border(): ChartBorder; set border(a: ChartBorder); /** * Defines the font properties for each formatted run in the * [[text]] that has no more specific setting. Read-only. ** Use this object to apply font formatting to the entire run of text * which comprises the chart or axis title. *
** Font formatting can be applied to individual runs of text using the * [[FormattedString.getFont]] method of the object * returned from the [[text]] property. Any such formatting * overrides that which is defined by the DefaultFont settings. *
** This property returns null by default, indicating that no fill is applied. *
** To apply a solid color fill, assign an instance of the * [[ChartSolidFill]] class to this property. *
** To apply a gradient fill, assign an instance of the * [[ChartGradientFill]] class to this property. *
* @see [[ChartSolidFill]] * @see [[ChartGradientFill]] */ get fill(): ChartFillBase; set fill(a: ChartFillBase); /** * @hidden */ protected get__ad(): ChartFillBase; /** * @hidden */ get _ad(): ChartFillBase; /** * The formula used to get the text displayed within the text area. (read-only). ** The value of this property is expressed as a fractional value between 0 and 1 * which represents the ratio of the offset to the width of the chart element. *
** For example, a value of 0 positions the text area as close as possible to the * edge of the chart element; a value of 1 positions it as close as possible to the opposite * edge. All values in between 0 and 1 represent a scalar which, when applied to the width of * the entire chart element, yields the offset. *
* @see [[position]] */ protected get_left(): number; protected set_left(a: number): void; /** * The left position of the text area (ignored unless [[position]] is set to 'Custom'). ** The value of this property is expressed as a fractional value between 0 and 1 * which represents the ratio of the offset to the width of the chart element. *
** For example, a value of 0 positions the text area as close as possible to the * edge of the chart element; a value of 1 positions it as close as possible to the opposite * edge. All values in between 0 and 1 represent a scalar which, when applied to the width of * the entire chart element, yields the offset. *
* @see [[position]] */ get left(): number; set left(a: number); /** * Determines whether the position of the text area is automatic or custom * as specified by the [[left]] and [[top]] properties. */ protected get_position(): ElementPosition; protected set_position(a: ElementPosition): void; /** * Determines whether the position of the text area is automatic or custom * as specified by the [[left]] and [[top]] properties. */ get position(): ElementPosition; set position(a: ElementPosition); /** * Determines the reading order */ get readingOrder(): ReadingOrder; set readingOrder(a: ReadingOrder); /** * Determines the rotation of the text area, expressed in degrees. */ get rotation(): number; set rotation(a: number); /** * Returns or sets a [[FormattedString]] object which defines * the text to be displayed by the associated chart element. ** Because mixed font settings are supported for chart element text, * a special object is required to customize the text. *
** For the simple case where all the text has the same formatting, * create an instance of the [[FormattedString]] class, * specifiying the text as the value of the 'unformattedString' * parameter. *
** To apply font attributes to a given run of text, i.e., a substring * within the text, use the [[FormattedString.getFont]] * method, and set the applicable properties of the [[FormattedStringFont]] * instance returned from the GetFont method. *
* @see [[FormattedString..ctor]] * @see [[FormattedString.getFont]] */ protected get_text(): FormattedString; protected set_text(a: FormattedString): void; /** * Returns or sets a [[FormattedString]] object which defines * the text to be displayed by the associated chart element. ** Because mixed font settings are supported for chart element text, * a special object is required to customize the text. *
** For the simple case where all the text has the same formatting, * create an instance of the [[FormattedString]] class, * specifiying the text as the value of the 'unformattedString' * parameter. *
** To apply font attributes to a given run of text, i.e., a substring * within the text, use the [[FormattedString.getFont]] * method, and set the applicable properties of the [[FormattedStringFont]] * instance returned from the GetFont method. *
* @see [[FormattedString..ctor]] * @see [[FormattedString.getFont]] */ get text(): FormattedString; set text(a: FormattedString); /** * Determines the orientation and direction in which text flows. *Note that the [[rotation]] property is only applicable when this property is set to Horizontal.
* @see [[rotation]] */ get textDirection(): TextDirection; set textDirection(a: TextDirection); /** * The top position of the text area (ignored unless [[position]] is set to 'Custom'). ** The value of this property is expressed as a fractional value between 0 and 1 * which represents the ratio of the offset to the height of the associated chart * element. *
** For example, a value of 0 positions the title as close as possible to the * edge of the associated chart element; a value of 1 positions it as close as possible to the opposite * edge. All values in between 0 and 1 represent a scalar which, when applied to the height of * the entire chart element, yields the offset. *
* @see [[position]] */ protected get_top(): number; protected set_top(a: number): void; /** * The top position of the text area (ignored unless [[position]] is set to 'Custom'). ** The value of this property is expressed as a fractional value between 0 and 1 * which represents the ratio of the offset to the height of the associated chart * element. *
** For example, a value of 0 positions the title as close as possible to the * edge of the associated chart element; a value of 1 positions it as close as possible to the opposite * edge. All values in between 0 and 1 represent a scalar which, when applied to the height of * the entire chart element, yields the offset. *
* @see [[position]] */ get top(): number; set top(a: number); /** * Determines the vertical alignment of the text area. */ get verticalAlignment(): VerticalTitleAlignment; set verticalAlignment(a: VerticalTitleAlignment); /** * Determines whether text is allowed to continue vertically * outside the bounds of the containing element. */ get verticalOverflow(): TextVerticalOverflow; set verticalOverflow(a: TextVerticalOverflow); /** * Determines whether text is wrapped when it would exceed * the bounds of the containing element. */ get wrapText(): boolean; set wrapText(a: boolean); /** * Assigns a new [[Formula]] to this instance. * @param formula The string representation of the formula used to get the [[text]]. * @param cellReferenceMode A [[CellReferenceMode]] value which specifies whether the 'formula' parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the [[Workbook.cellReferenceMode]] property is used. * @see [[text]] */ setFormula(formula: string, cellReferenceMode?: CellReferenceMode): void; /** * @hidden */ _setFormula1(a: string, b?: Nullable$1* This property is applicable only to the following chart types: *
**
* Use this property to set the bar shape for all series bars. *
** To set the shape for a particular series bar, use the [[Series.barShape]] property. *
* @see [[Series.barShape]] * @see [[chartType]] */ get barShape(): BarShape | null; set barShape(a: BarShape | null); /** * @hidden */ get _barShape$i(): Nullable$1* All chart types are supported by the [[WorksheetChart]] type; * no derived classes exist or are necessary to support different chart types. *
** Note that changing the chart type may cause related property values * to be changed. *
** For example, when transitioning from a chart type which supports * line markers, The [[Series.markerStyle]] property is changed * to reflect the new chart style. *
*
* Using another example, when transitioning from a chart type which does
* not support
* The properties of the [[WorksheetChart]] class which apply only to a specific chart type * are not applicable for combo charts. For example, the [[gapWidth]] property, * which applies to bar charts, is not used for bar charts which appear within a combo chart. The reason * for this is that combo charts support multiple occurrences of the same chart type, * making the WorksheetChart-level properties ambiguous in the context of a combo chart. *
** This class makes it possible to set chart-specific properties for one or more occurrences of * a particular chart type, for a particular axis group. *
** For example, consider a combo chart with two ClusteredColumn series, one on the primary * axis and another on the secondary. * To set the [[gapWidth]] property for the chart on the primary axis, add an item to * this collection with a [[chartType]] of ClusteredColumn, and an [[AxisGroup]] * of Primary. On the [[ComboChartGroup]] instance returned from the collection's Add method, * set the GapWidth property to the desired value. *
*
* When the chart is serialized, this collection is checked against each series in the combo chart.
* If the
* This property is only applicable to doughnut charts. *
** The valid range for this property is 0 through 90, inclusive. *
*/ get doughnutHoleSize(): number; set doughnutHoleSize(a: number); /** * Returns or sets a [[ChartDropLines]] instance which determines * the appearance for a stock chart's drop lines. ** This property is only applicable for stock charts. *
** High/low lines are not displayed by default; to enable them, * assign a [[ChartDropLines]]to this property. * to null. *
*/ get dropLines(): ChartDropLines; set dropLines(a: ChartDropLines); /** * Returns a [[Wall]] object that allows the user to * format the bottom wall of a 3-D chart. Read-only. * @see [[backWall]] * @see [[sideWall]] * @see [[wallDefault]] */ get floor(): Wall; /** * Returns or sets the gap depth in a 3-D chart, expressed * as a percentage of the marker width. The value of this property must * be between 0 and 500. * @see [[gapWidth]] */ get gapDepth(): number; set gapDepth(a: number); /** * @hidden */ get _i1(): Nullable$1* This property is only applicable to pie and doughnut charts. *
** The valid range for this property is 0 through 360, inclusive. Fractional * angles are not supported; nor are negative angles. *
** By default, the first slice begins at the "12 o'clock" position of the * pie chart, i.e., the top center point of the encompassing circle. *
** Use this property to offset the origin of the first slice; for example, a * value of 30 positions the first slice at the 1 o'clock position, 60 at the * 2 o'clock position, 90 for 3 o'clock, etc. *
** Larger values move along the circumference of the emcompassing circle * in a clockwise direction, with a value of 0 or 360 both coinciding with * the 12 o'clock position. *
*/ get firstSliceAngle(): number; set firstSliceAngle(a: number); /** * Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). */ get heightPercent(): number; set heightPercent(a: number); /** * Returns or sets a [[ChartHighLowLines]] instance which determines * the appearance for a stock chart's high/low lines. ** This property is only applicable for stock charts. *
** High/low lines depict the high and low prices for a stock chart. *
** High/low lines are displayed by default; to disable them, set this property * to null. *
*/ get highLowLines(): ChartHighLowLines; set highLowLines(a: ChartHighLowLines); /** * Returns or sets a [[legend]] object which represents * the legend for the chart. */ get legend(): Legend; set legend(a: Legend); /** * Returns or sets a value that represents the perspective * for the 3-D chart view, expressed in degrees. ** This property supports values within the inclusive range of 0 and 120. *
*/ get perspective(): number; set perspective(a: number); /** * Returns a PlotArea object that represents the plot area of a chart. Read-only. */ get plotArea(): PlotArea; /** * True if only visible cells are plotted. False if both visible and hidden cells are plotted. */ get plotVisibleOnly(): boolean; set plotVisibleOnly(a: boolean); /** * True if the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts. */ get rightAngleAxes(): boolean; set rightAngleAxes(a: boolean); /** * Returns or sets the rotation of a 3-D chart view around the X-axis, expressed in degrees. ** This property controls the viewing perspective by rotating the * chart around the horizontal axis, such that the top of the chart * appears to move closer or further away. *
** This property is only applicable to 3D charts. *
* @see [[rotationY]] */ get rotationX(): number; set rotationX(a: number); /** * Returns or sets the rotation of a 3-D chart view around the Y-axis, expressed in degrees. ** This property controls the viewing perspective by rotating the * chart around the vertical axis, such that the left edge of the chart * appears to move closer or further away. *
** This property is only applicable to 3D charts. *
* @see [[rotationX]] */ get rotationY(): number; set rotationY(a: number); /** * Returns or sets the size of the second plot area in a 'bar of pie' * or 'pie of pie' chart, expressed as a percentage of the first plot * area's size. *
* This property is only applicable for the BarOfPie and PieOfPie
*
* This property supports values in the range of 5 to 200, inclusively. *
*/ get secondPlotSize(): number; set secondPlotSize(a: number); /** * Indexer * @param index A zero based index * @return */ seriesCollection(index: number): Series; /** * Returns the series collection (read-only) */ seriesCollection(): SeriesCollection; /** * @hidden */ get _seriesCollection$i(): SeriesCollection; /** * Determines the
* This property is only applicable for the BarOfPie and PieOfPie
*
* This property is only applicable for 2D bar charts. *
* @see [[gapDepth]] * @see [[gapWidth]] */ get seriesOverlap(): number; set seriesOverlap(a: number); /** * Returns a [[Wall]] object that allows the user to * format the side wall of a 3-D chart. Read-only. * @see [[floor]] * @see [[backWall]] * @see [[wallDefault]] */ get sideWall(): Wall; /** * Returns or sets a [[UpDownBars]] instance which determines * the appearance for a stock chart's up/down bars. ** This property is only applicable for stock charts. *
** Up/down bars depict gains or losses across a series for a stock chart. *
*/ get upDownBars(): UpDownBars; set upDownBars(a: UpDownBars); /** * Returns or sets a boolean value indicating whether the fill colors * for* This property defaults to true, causing fill colors for * series and data points to be automatically selected by Excel. *
** The automatically selected color can always be overridden for individual series * and/or data points using the [[Series.fill]], [[Series.line]], * and [[DataPoint.fill]] properties. *
** In cases where VaryColors is set to true, but a fill is explicitly assigned, * the assigned fill is used for the associated series or data point, while series * or data points which have no explicitly assigned fill will have a fill color * automatically selected. *
* @see [[Series.fill]] * @see [[Series.line]] * @see [[DataPoint.fill]] */ get varyColors(): boolean; set varyColors(a: boolean); /** * Returns a [[Wall]] object which represents the back and side * walls, and floor of the chart. Applicable only for 3-D charts. ** Use this property to apply the same settings for the back wall, side wall, and floor. *
** Use the [[backWall]] property to control the appearance of the back wall. *
** Use the [[sideWall]] property to control the appearance of the side wall. *
** Use the [[floor]] property to control the appearance of the bottom wall. *
** The BackWall, SideWall, and Floor properties take precedence over this property. *
* @see [[backWall]] * @see [[sideWall]] * @see [[floor]] */ get wallDefault(): Wall; /** * Gets the worksheet on which the shape resides. */ protected get_sheet(): Sheet; /** * @hidden */ get _e0(): ChartSolidFill; /** * @hidden */ get _e1(): ChartSolidFill; /** * @hidden */ get _ez(): ChartSolidFill; /** * @hidden */ get _er(): ChartEmptyFill; /** * @hidden */ get _ge(): boolean; /** * @hidden */ _gh: boolean; /** * @hidden */ get _gx(): boolean; /** * @hidden */ get _gy(): boolean; /** * @hidden */ get _gw(): boolean; /** * @hidden */ get _gz(): boolean; /** * Sets the source data range for a combo chart. ** Combo charts support multiple chart types within the main chart, with each different * chart type being associated with one or more [[Series]]. *
** Use this method to populate the [[seriesCollection]] for a combo chart. *
** For example, given a 'dataRange' which yields three series, the caller * can specify an array with three elements as the value of the 'seriesChartTypes' * parameter. Each array element is then applied to the corresponding series, in the same order * in which they appear in the array. *
** Duplicate ChartType values can appear in the 'seriesChartTypes' array, * in which case the corresponding series appear within the same chart. For example, specifying * an array with ClusteredColumn, Line, and Line results in a combo chart * with the first series appearing in a clustered column chart, and the remaining series appearing * in a line chart. *
** Specifying null for the value of the 'seriesChartTypes' parameter * is treated the same as a two-element array containing 'ColumnClustered' and 'Line', * resulting in a clustered column chart for the first series, and a line chart for the * remaining series. *
** If fewer values are present in the 'seriesChartTypes' array than the * number of series yielded from the specified 'dataRange', the remaining * series acquire the same ChartType and AxisGroup as the last element in the seriesChartTypes * array. If more values are present in the array than the number of series yielded, these values * are ignored. *
** Certain chart type values are invalid for a combo chart; if any of these chart types * are present in the array, an exception is thrown, listing the invalid chart types. *
** The following table lists the ChartType values which are supported in combo charts, * grouped by series type: *
**
SeriesType | ChartType (supported in combo charts) |
---|---|
Area | Area, AreaStacked, AreaStacked100 | *
Bar | ColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, BarOfPie | *
Line | Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100 | *
Pie | Pie, PieExploded, PieOfPie, Doughnut, DoughnutExploded | *
Radar | Radar, RadarFilled, RadarMarkers | *
Scatter | XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers | *
Bubble | Not Supported | *
Surface | Not Supported | *
* Combo charts support a maximum of two axis groups. If the combination of values in the * 'seriesChartTypes' array necessitates more than two axis groups, an exception * is thrown. *
** Combo charts require a minimum of two [[Series]]. If the specified 'dataRange' * yields less that two series, an exception is thrown. *
** If the combination of series used in a combo chart is indistinguishable from a non-combo * chart, the chart may not be recognized by Excel as a combo chart. For example, adding two * series, one of type Radar and one of type RadarMarkers, is a valid combination. * When opened in Excel, however, such a chart will not be recognized as a combo chart, since the * combination of series does not necessitate multiple chart elements. All relevant property values * are persisted, however, and there is no distinguishable difference between the original chart * and the serialized one. *
* @param dataRange The data range for the combo chart * @param seriesChartTypes An array of [[chartType]] constants which specify the chart type for each series * yielded from the specified 'dataRange'. * @param plotByRows Optional. True to plot by rows where each row is a separate series or false to plot by columns where each column is a separate series. The default is false. * @param cellReferenceMode Optional. Determines how to parse the dataRange. * @see [[Series]] * @see [[Axis]] * @see [[Series.chartType]] * @see [[Series.axisGroup]] * @throws [[BaseError]] The current value of the [[chartType]] property is not Combo. * @throws [[NotSupportedException]] The specified 'seriesChartTypes' array contains one or more values which are not * supported within a combo chart. * @throws [[NotSupportedException]] The specified 'seriesChartTypes' array contains a combination of values which * would require more than the maximum allowable number of axes (two). */ setComboChartSourceData(dataRange: string, seriesChartTypes: ChartType[], plotByRows?: boolean, cellReferenceMode?: CellReferenceMode): void; /** * @hidden */ _setComboChartSourceData$i(a: string, b: ChartType[], c?: boolean, d?: Nullable$1* For combo charts, this method always displays the first series in a clustered column chart, * with all subsequent series displayed in line charts. Use the [[setComboChartSourceData]] * to customize the series charts for a combo chart. *
* @param dataRange The data range for the chart * @param plotByRows Optional. True to plot by rows where each row is a separate series or false to plot by columns where each column is a separate series. The default is false. * @param cellReferenceMode Optional. Determines how to parse the dataRange. */ setSourceData(dataRange: string, plotByRows?: boolean, cellReferenceMode?: CellReferenceMode): void; /** * @hidden */ _setSourceData$i(a: string, b?: boolean, c?: Nullable$1
* If a property of a font has a default value, value of the previous font in resolution chain is used. The resolution priority
* is the following:
*
*
* For example, if a column font is set to blue and bold and a row font is set to italic and not bold, the font in the cell at
* the intersection of the row and column would have blue, italic text in the saved workbook.
*
* Custom views provide a way to save display options and optionally print options for the workbook and each worksheet in the workbook. * These options can be different from the options currently set on the workbook and worksheets. *
** Multiple custom views can be saved with a workbook, and the options from a custom view can be applied to its associated workbook by * calling the [[apply]] method on it. *
* @see [[Workbook.customViews]] */ export declare class CustomView extends Base { static $t: Type; private _j; private _u; private _n; private _l; private _w; private _b; private _p; private _s; private _t; private _q; private _r; constructor(a: Workbook, b: boolean, c: boolean); /** * Applies all options from the custom view to the associated workbook and its worksheets. ** There is no state of the workbook indicating the custom view currently applied, so applying a custom view * simply copies over all options saved with it to the workbook and its worksheet. If an applied custom view * is then changed, those changes will not be updated on the workbook or worksheets. Instead, the custom view will need * to be applied again for those changes to be reflected on the workbook or worksheet. *
* @throws [[InvalidOperationException]] The custom view has previously been removed from its associated workbook. */ apply(): void; /** * Gets the display options associated with the specified worksheet. ** Setting properties on the returned [[DisplayOptions]] instance will not change the actual * display of the worksheet. After setting properties, the [[apply]] method of the * [[CustomView]] will apply them to the worksheet. *
* @param worksheet The worksheet whose associated display options are to be retrieved. * @param createIfNull True to create the display options if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. * @throws [[ArgumentNullException]] 'worksheet' is null. * @return Null if the worksheet does not belong to the workbook associated with this custom view; * otherwise, the display options associated with the worksheet. * @see [[Worksheet.displayOptions]] */ getDisplayOptions(worksheet: Worksheet, createIfNull?: boolean): CustomViewDisplayOptions; /** * Gets the display options associated with the specified sheet. ** Setting properties on the returned [[DisplayOptionsBase]] instance will not change the actual * display of the sheet. After setting properties, the [[apply]] method of the * [[CustomView]] will apply them to the sheet. *
* @param sheet The sheet whose associated display options are to be retrieved. * @param createIfNull True to create the display options if it has not yet been allocated. The options will be initialized based on the current state of the Sheet. Note the options should only have been null if there were no options for the Sheet when the Workbook was loaded. * @throws [[ArgumentNullException]] 'sheet' is null. * @return Null if the sheet does not belong to the workbook associated with this custom view; * otherwise, the display options associated with the worksheet. * @see [[Worksheet.displayOptions]] * @see [[Chartsheet.displayOptions]] */ getSheetDisplayOptions(sheet: Sheet, createIfNull?: boolean): DisplayOptionsBase; /** * @hidden */ _e(a: Worksheet, b: boolean): WorksheetFilterSettings; /** * Gets the hidden columns associated with the specified worksheet. ** Adding columns on the returned [[HiddenColumnCollection]] instance will not actually hide * columns in the worksheet. After modifying the hidden columns in this collection, the [[apply]] * method of the [[CustomView]] will hide or unhide the columns. *
* @param worksheet The worksheet whose associated hidden columns are to be retrieved. * @param createIfNull True to create the hidden column if it has not yet been allocated of the Worksheet. The options will be initialized based on the current state. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[saveHiddenRowsAndColumns]] is true. * @throws [[ArgumentNullException]] 'worksheet' is null. * @return Null if [[saveHiddenRowsAndColumns]] is False or if the worksheet does not belong to the workbook * associated with this custom view; otherwise, the collection of hidden columns associated with the worksheet. * @see [[RowColumnBase.hidden]] * @see [[saveHiddenRowsAndColumns]] */ getHiddenColumns(worksheet: Worksheet, createIfNull?: boolean): HiddenColumnCollection; /** * Gets the hidden rows associated with the specified worksheet. ** Adding rows on the returned [[HiddenRowCollection]] instance will not actually hide * rows in the worksheet. After modifying the hidden rows in this collection, the [[apply]] * method of the [[CustomView]] will hide or unhide the rows. *
* @param worksheet The worksheet whose associated hidden rows are to be retrieved. * @param createIfNull True to create the hidden column if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[saveHiddenRowsAndColumns]] is true. * @throws [[ArgumentNullException]] 'worksheet' is null. * @return Null if [[saveHiddenRowsAndColumns]] is False or if the worksheet does not belong to the workbook * associated with this custom view; otherwise, the collection of hidden rows associated with the worksheet. * @see [[RowColumnBase.hidden]] * @see [[saveHiddenRowsAndColumns]] */ getHiddenRows(worksheet: Worksheet, createIfNull?: boolean): HiddenRowCollection; /** * Gets the print options associated with the specified worksheet. ** Setting properties on the returned [[PrintOptions]] instance will not change the actual * print settings of the worksheet. After setting properties, the [[apply]] method of the * [[CustomView]] will apply them to the worksheet. *
* @param worksheet The worksheet whose associated print options are to be retrieved. * @param createIfNull True to create the print options if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[savePrintOptions]] is true. * @throws [[ArgumentNullException]] 'worksheet' is null. * @return Null if [[savePrintOptions]] is False or if the worksheet does not belong to the workbook associated * with this custom view; otherwise, the print options associated with the worksheet. * @see [[Worksheet.printOptions]] * @see [[savePrintOptions]] */ getPrintOptions(worksheet: Worksheet, createIfNull?: boolean): PrintOptions; /** * Gets the print options associated with the specified sheet. ** Setting properties on the returned [[PrintOptionsBase]] instance will not change the actual * print settings of the sheet. After setting properties, the [[apply]] method of the * [[CustomView]] will apply them to the sheet. *
* @param sheet The sheet whose associated print options are to be retrieved. * @param createIfNull True to create the print options if it has not yet been allocated. The options will be initialized based on the current state of the Sheet. Note the options should only have been null if there were no options for the Sheet when the Workbook was loaded. Also this will not allocate the collection unless the [[savePrintOptions]] is true. * @throws [[ArgumentNullException]] 'sheet' is null. * @return Null if [[savePrintOptions]] is False or if the sheet does not belong to the workbook associated * with this custom view; otherwise, the print options associated with the sheet. * @see [[Worksheet.printOptions]] * @see [[Chartsheet.printOptions]] * @see [[savePrintOptions]] */ getSheetPrintOptions(sheet: Sheet, createIfNull?: boolean): PrintOptionsBase; /** * @hidden */ _z(): void; /** * @hidden */ _aa(a: Sheet): void; /** * @hidden */ _ab(a: Sheet): void; /** * @hidden */ _ac(a: boolean): void; /** * @hidden */ _ad(a: boolean): void; /** * @hidden */ _ae(a: FormatLimitErrors, b: WorkbookFormat): void; /** * Gets or sets the name of the custom view. ** The name of the custom view is displayed in the custom views dialog of Microsoft Excel and must be * case-insensitively unique to other custom views in the workbook. *
* The name of the custom view. * @throws [[ArgumentNullException]] The value assigned is a null or empty. * @throws [[ArgumentException]] The value assigned is the name of another custom view in this custom view's associated workbook (custom view * names are compared case-insensitively). */ get name(): string; set name(a: string); /** * Gets the value indicating whether hidden row and column settings are saved with the custom view. ** If the value is False, the return value of [[getHiddenColumns]] and [[getHiddenRows]] * will always be null, regardless of the worksheet specified. *
* The value indicating whether hidden row and column settings are saved with the custom view. * @see [[getHiddenColumns]] * @see [[getHiddenRows]] * @see [[HiddenColumnCollection]] * @see [[HiddenRowCollection]] */ get saveHiddenRowsAndColumns(): boolean; /** * Gets the value indicating whether print options are saved with the custom view. ** If the value is False, the return value of [[getPrintOptions]] will always be null, * regardless of the worksheet specified. *
* The value indicating whether print options are saved with the custom view. * @see [[getPrintOptions]] * @see [[PrintOptions]] */ get savePrintOptions(): boolean; /** * Gets the window options for the workbook associated with the custom view. ** Setting properties on the returned [[windowOptions]] instance will not change the actual * window options of the associated workbook. After setting properties, the [[apply]] method * of the [[CustomView]] will apply them to the workbook. *
* The window options for the workbook associated with the custom view.. * @see */ get windowOptions(): CustomViewWindowOptions; /** * @hidden */ get _v(): Guid; /** * @hidden */ set _v(a: Guid); /** * @hidden */ get _k(): Workbook; } /** * Abstract base class which exposes the various display options available for a sheet which can be * saved with both a sheet and its custom view. ** This class provides a way to control how a sheet is displayed when it is viewed in Microsoft Excel. *
*/ export declare abstract class DisplayOptionsBase extends Base implements IChangeInfoContext { static $t: Type; /** * @hidden */ private static readonly _l; /** * @hidden */ private static readonly _m; /** * @hidden */ private static readonly _k; /** * @hidden */ private static readonly _a; private _f; private _h; constructor(a: Sheet); /** * Resets the display options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank sheet. *
*/ reset(): void; /** * Resets the display options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank sheet. *
*/ protected resetCore(): void; /** * @hidden */ _d(): DisplayOptionsBase; /** * @hidden */ abstract _e(): DisplayOptionsBase; /** * @hidden */ _n(a: DisplayOptionsBase): void; /** * @hidden */ _o(): void; /** * @hidden */ _p(a: WorksheetVisibility, b: WorksheetVisibility): void; /** * @hidden */ _s(a: DisplayOptionsBase): void; /** * @hidden */ _t(a: FormatLimitErrors, b: WorkbookFormat): void; /** * @hidden */ private static _c; /** * @hidden */ private static _b; /** * Gets or sets the visibility of the sheet. ** The visibility determines whether the sheet's tab will appear in the tab bar at the * bottom of Microsoft Excel. *
* The visibility of the worksheet. * @throws [[InvalidEnumArgumentException]] The value assigned is not defined in the [[WorksheetVisibility]] enumeration. */ get visibility(): WorksheetVisibility; set visibility(a: WorksheetVisibility); /** * @hidden */ abstract get _j(): boolean; /** * @hidden */ get _sheet(): Sheet; /** * @hidden */ get workbook(): Workbook; /** * @hidden */ get sheet(): Sheet; /** * @hidden */ get source(): any; } /** * Abstract base class which exposes the various display options available for a worksheet which can be * saved with both a worksheet and a custom view. ** This class provides a way to control how a worksheet is displayed when it is viewed in Microsoft Excel. *
* @see [[CustomViewDisplayOptions]] * @see [[WorksheetDisplayOptions]] */ export declare abstract class DisplayOptions extends DisplayOptionsBase { static $t: Type; /** * @hidden */ static readonly _a5: number; /** * @hidden */ static readonly _a6: number; /** * @hidden */ static readonly _a4: number; /** * @hidden */ private static readonly _a7; /** * @hidden */ private static readonly _bb; /** * @hidden */ private static readonly _bc; /** * @hidden */ private static readonly _bd; /** * @hidden */ private static readonly _be; /** * @hidden */ private static readonly _bf; /** * @hidden */ private static readonly _bg; /** * @hidden */ private static readonly _bh; /** * @hidden */ private static readonly _bi; /** * @hidden */ private static readonly _bj; /** * @hidden */ private static readonly _bk; /** * @hidden */ private static readonly _ba; /** * @hidden */ private static readonly _u; private _ad; private _x; private _a2; private _a8; private _ak; private _bl; private _bn; private _aq; private _as; private _au; private _aw; private _ay; private _a0; private _ab; private _ah; private _af; private _z; constructor(a: Worksheet); /** * Resets the display options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet. *
*/ protected resetCore(): void; /** * @hidden */ _n(a: DisplayOptionsBase): void; /** * @hidden */ _br(a: WorksheetView): void; /** * @hidden */ private static _w; /** * @hidden */ private static _v; /** * Gets the settings which control the frozen panes in the worksheet. ** For these settings to be saved in the workbook file, [[panesAreFrozen]] must be True. *
** Note: Frozen and unfrozen panes cannot be used simultaneously, so depending on whether the panes are * frozen or unfrozen, these settings may not be used. *
* The settings which control the frozen panes in the worksheet.. * @see [[panesAreFrozen]] * @see [[unfrozenPaneSettings]] */ get frozenPaneSettings(): FrozenPaneSettings; /** * Gets or sets the color of the gridlines on the worksheet. ** If the workbook is using a standard palette, the color set may be changed if it is not in the palette. * In this case, the closest color in the standard palette will be used. *
* The color of the gridlines on the worksheet. * @throws [[InvalidOperationException]] The workbook is using a custom palette and setting this color would cause the custom palette to use * too many colors. */ get gridlineColor(): string | Color; set gridlineColor(a: string | Color); /** * @hidden */ get _gridlineColor$i(): Color; /** * @hidden */ set _gridlineColor$i(a: Color); /** * @hidden */ private _bq; /** * Gets or sets the value which indicates if the panes in the worksheet are frozen. ** Depending on the value of this property, either the [[frozenPaneSettings]] or the * [[unfrozenPaneSettings]] will be used for the worksheet. The unused settings are * ignored and are not saved with the workbook stream. *
* The value which indicates if the panes in the worksheet are frozen. * @see [[frozenPaneSettings]] * @see [[unfrozenPaneSettings]] */ get panesAreFrozen(): boolean; set panesAreFrozen(a: boolean); /** * Gets or sets the value which indicates whether the expansion indicators should be shown below grouped, * or indented rows. */ get showExpansionIndicatorBelowGroupedRows(): boolean | null; set showExpansionIndicatorBelowGroupedRows(a: boolean | null); /** * @hidden */ get _showExpansionIndicatorBelowGroupedRows$i(): Nullable$1* If this value is True, the formula string will be displayed in the cell. If the value is * False, the result of the formula will be displayed in the cell. *
* The value which indicates whether formulas are shown in cells. */ get showFormulasInCells(): boolean; set showFormulasInCells(a: boolean); /** * Gets or sets the value which indicates whether gridlines are shown between cells. * The value which indicates whether gridlines are shown between cells. * @see [[PrintOptions.printGridlines]] */ get showGridlines(): boolean; set showGridlines(a: boolean); /** * Gets or sets the value which indicates whether outline symbols are shown for outlined columns and rows. ** If the outline symbols are displayed, they provide a visual representation of the outline levels or rows * and columns in Microsoft Excel. In addition, the outline symbols include the expansion indicators which * allow for the expanding and collapsing of outline groups. *
* The value which indicates whether outline symbols are shown for outlined columns and rows. * @see [[RowColumnBase.outlineLevel]] */ get showOutlineSymbols(): boolean; set showOutlineSymbols(a: boolean); /** * Gets or sets the value which indicates whether to display row and column headers. ** The row and column headers show the identifier of the row or column. They also allow the user to easily select * all cells in a row or column by clicking them. *
* The value which indicates whether to display row and column headers. * @see [[PrintOptions.printRowAndColumnHeaders]] */ get showRowAndColumnHeaders(): boolean; set showRowAndColumnHeaders(a: boolean); /** * Gets or sets the value which indicates whether to show rulers in the page layout view. ** When this value is True, one ruler will display above the column headers of the active page * in page layout view. Another ruler will also display before the row headers of the active page. *
** Note: This property will only affect the worksheet view if the [[view]] is * PageLayout. *
** Note: The [[WorksheetView]] value of PageLayout is only supported in Excel 2007. * If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will * default to Normal view. *
* The value which indicates whether to show rulers in the page layout view. * @see [[view]] */ get showRulerInPageLayoutView(): boolean; set showRulerInPageLayoutView(a: boolean); /** * Gets or sets the value which indicates whether zero values are shown in cells. ** If this value is True, cells with a value of zero will display their values; otherwise, * those cells will display as blanks. *
* The value which indicates whether zero values are shown in cells. */ get showZeroValues(): boolean; set showZeroValues(a: boolean); /** * Gets the settings which control the unfrozen panes in the worksheet. ** For these settings to be saved in the workbook file, [[panesAreFrozen]] must be False. *
** Note: Frozen and unfrozen panes cannot be used simultaneously, so depending on whether the panes are * frozen or unfrozen, these settings may not be used. *
* The settings which control the unfrozen panes in the worksheet. * @see [[panesAreFrozen]] * @see [[frozenPaneSettings]] */ get unfrozenPaneSettings(): UnfrozenPaneSettings; /** * Gets or sets the current view of the worksheet. ** The view determines the overall display of the worksheet in Microsoft Excel. *
** Note: The [[WorksheetView]] value of PageLayout is only supported in Excel 2007. * If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will * default to Normal view. *
* The current view of the worksheet. * @throws [[InvalidEnumArgumentException]] The value assigned is not defined in the WorksheetView enumeration. * @see [[CustomViewDisplayOptions.magnificationInCurrentView]] * @see [[WorksheetDisplayOptions.magnificationInNormalView]] * @see [[WorksheetDisplayOptions.magnificationInPageBreakView]] * @see [[WorksheetDisplayOptions.magnificationInPageLayoutView]] */ get view(): WorksheetView; set view(a: WorksheetView); /** * @hidden */ get _aa(): PaneLocation; /** * @hidden */ set _aa(a: PaneLocation); /** * @hidden */ get _a9(): number; /** * @hidden */ set _a9(a: number); /** * @hidden */ get _aj(): boolean; /** * @hidden */ get _ag(): WorksheetSelection; /** * @hidden */ get _ao(): boolean; /** * @hidden */ get _ap(): boolean; /** * @hidden */ get _a3(): boolean; /** * @hidden */ set _a3(a: boolean); /** * @hidden */ get _ae(): Worksheet; /** * Removes any saved selection information. */ clearSelection(): void; /** * @hidden */ _o(): void; /** * @hidden */ _am(): boolean; /** * @hidden */ _an(): boolean; /** * @hidden */ _bs(): void; } /** * Class which exposes the worksheet display options which can only be controlled through the custom view. * @see [[CustomView.getDisplayOptions]] * @see [[WorksheetDisplayOptions]] */ export declare class CustomViewDisplayOptions extends DisplayOptions { static $t: Type; /** * @hidden */ private static readonly _b1; /** * @hidden */ private static readonly _b2; /** * @hidden */ private static readonly _bu; private _bz; /** * @hidden */ readonly _bx: CustomView; constructor(a: Worksheet, b: CustomView); /** * @hidden */ _e(): DisplayOptionsBase; /** * @hidden */ _n(a: DisplayOptionsBase): void; /** * @hidden */ protected get__j(): boolean; /** * @hidden */ get _j(): boolean; /** * Resets the display options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet. *
*/ protected resetCore(): void; /** * @hidden */ private static _bw; /** * @hidden */ private static _bv; /** * Gets or sets the magnification level of the worksheet in the current [[DisplayOptions.view]]. ** Magnifications are stored as percentages of the normal viewing magnification. A value of 100 indicates normal magnification * whereas a value of 200 indicates a zoom that is twice the normal viewing magnification. *
* The magnification level of the worksheet in the current View. * @throws [[ArgumentOutOfRangeException]] The assigned value is outside the valid range of magnification levels for a worksheet. The level must be between 10 and 400. * @see [[WorksheetDisplayOptions.magnificationInNormalView]] * @see [[WorksheetDisplayOptions.magnificationInPageBreakView]] * @see [[WorksheetDisplayOptions.magnificationInPageLayoutView]] */ get magnificationInCurrentView(): number; set magnificationInCurrentView(a: number); /** * @hidden */ _by: boolean; } /** * A collection of [[CustomView]] instances in a workbook. */ export declare class CustomViewCollection extends Base implements IList$1* This class provides a way to control how a workbook is displayed when it is viewed in Microsoft Excel. *
* @see [[CustomViewWindowOptions]] * @see [[WorkbookWindowOptions]] */ export declare abstract class WindowOptions extends Base implements IChangeInfoContext { static $t: Type; /** * @hidden */ static readonly _r: number; /** * @hidden */ private static readonly _u; /** * @hidden */ private static readonly _t; /** * @hidden */ private static readonly _v; /** * @hidden */ private static readonly _w; /** * @hidden */ private static readonly _x; /** * @hidden */ private static readonly _aa; /** * @hidden */ private static readonly _s; /** * @hidden */ private static readonly _a; private _l; private _e; private _g; private _i; private _p; private _y; constructor(a: Workbook); /** * @hidden */ abstract _d(a: Sheet): DisplayOptionsBase; /** * Resets the window options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank workbook. *
*/ reset(): void; /** * @hidden */ _ab(a: WindowOptions, b: boolean): void; /** * @hidden */ _ad(): void; /** * @hidden */ _ae(a: Sheet, b: boolean): void; /** * @hidden */ private static _c; /** * @hidden */ private static _b; /** * @hidden */ private _af; /** * Gets or sets the way the objects and shapes are displayed in the workbook. * The way the objects and shapes are displayed in the workbook. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the [[objectDisplayStyle]] enumeration. * @see [[WorksheetShape]] * @see [[Worksheet.shapes]] */ get objectDisplayStyle(): ObjectDisplayStyle; set objectDisplayStyle(a: ObjectDisplayStyle); /** * Gets or sets the scroll bars shown in the workbook window. ** The vertical scroll bar occupies the entire height of the application if it is visible. *
** The horizontal scroll bar occupies the width of the application not used by the worksheet * tab bar, if it is visible. Otherwise, it occupies the entire width of the application. *
* The scroll bars shown in the workbook window. * @throws [[InvalidEnumArgumentException]] The assigned value is not defined in the [[scrollBars]] enumeration. * @see [[tabBarWidth]] * @see [[tabBarVisible]] */ get scrollBars(): ScrollBars; set scrollBars(a: ScrollBars); /** * Gets or sets the selected worksheet of the workbook. ** If this is an instance of [[CustomViewWindowOptions]] and the SelectedWorksheet value is null, the * workbook's selected worksheet will not be changed when the associated [[CustomView]] is applied. *
** Note: If the selected worksheet does not have its [[DisplayOptionsBase.visibility]] set to Visible * when the workbook is saved, another worksheet will be selected. *
* The selected worksheet of the workbook. * @throws [[ArgumentNullException]] The assigned value is null and this is an instance of [[WorkbookWindowOptions]] whose associated * [[workbook]] has at least one [[Worksheet]]. * @throws [[ArgumentException]] The assigned value does not belong to the workbook associated with this instance of [[WindowOptions]]. */ get selectedSheet(): Sheet; set selectedSheet(a: Sheet); /** * @hidden */ get _k(): Sheet; /** * Gets or sets the selected worksheet of the workbook. ** If this is an instance of [[CustomViewWindowOptions]] and the SelectedWorksheet value is null, the * workbook's selected worksheet will not be changed when the associated [[CustomView]] is applied. *
** Note: If the selected worksheet does not have its [[DisplayOptionsBase.visibility]] set to Visible * when the workbook is saved, another worksheet will be selected. *
* The selected worksheet of the workbook. * @throws [[ArgumentNullException]] The assigned value is null and this is an instance of [[WorkbookWindowOptions]] whose associated * [[workbook]] has at least one [[Worksheet]]. * @throws [[ArgumentException]] The assigned value does not belong to the workbook associated with this instance of [[WindowOptions]]. */ get selectedWorksheet(): Worksheet; set selectedWorksheet(a: Worksheet); /** * Gets or sets the value indicating whether the worksheet tab bar is visible. ** If the value is False, the [[tabBarWidth]] will not be used, but it will still * be serialized with the workbook. *
* The value indicating whether the worksheet tab bar is visible. * @see [[tabBarWidth]] * @see [[WorkbookWindowOptions.firstVisibleTabIndex]] */ get tabBarVisible(): boolean; set tabBarVisible(a: boolean); /** * Gets or sets the width of the worksheet tab bar, expressed in 1/1000ths of the application width. ** This value is only used if [[tabBarVisible]] is True. Regardless of whether the tab bar is * visible, the width value is always saved with the workbook. *
** A value of 1000 indicates the worksheet tab bar occupies the entire width of the application, while * a value of 0 indicates the worksheet tab bar has no width. *
** All space not occupied by the worksheet tab bar will be used by the horizontal scroll bar, if it is visible. *
* The width of the worksheet tab bar, expressed in 1/1000ths of the application width. * @throws [[ArgumentOutOfRangeException]] The value assigned is outside the valid range of 0 and 1000. * @see [[tabBarVisible]] * @see [[scrollBars]] * @see [[WorkbookWindowOptions.firstVisibleTabIndex]] */ get tabBarWidth(): number; set tabBarWidth(a: number); /** * @hidden */ abstract get _o(): boolean; /** * @hidden */ get _workbook(): Workbook; /** * @hidden */ get workbook(): Workbook; /** * @hidden */ get sheet(): Sheet; /** * @hidden */ get source(): any; } /** * Represents the workbook window options which are saved with custom views. ** The properties explicitly defined on this class and not inherited from the base class, * [[WindowOptions]], are options that can be saved with a custom view, but * not with a workbook. Therefore, these properties will not be applied when the * [[CustomView.apply]] method is called. *
* @see [[CustomView.windowOptions]] * @see [[WorkbookWindowOptions]] */ export declare class CustomViewWindowOptions extends WindowOptions { static $t: Type; /** * @hidden */ static readonly _ar: Rect; private _ag; private _ap; private _ah; private _aj; private _al; private _an; constructor(a: CustomView); /** * @hidden */ protected get__o(): boolean; /** * @hidden */ get _o(): boolean; /** * @hidden */ _d(a: Sheet): DisplayOptionsBase; /** * Resets the window options to their default settings. ** The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank workbook. *
*/ reset(): void; /** * Gets or sets the pixel bounds of the workbook's MDI child window when [[CustomView]] * owning these window options is applied. ** Note: This property will have no affect on the workbook if [[maximized]] is True. However, in this case, * the value of this property will still be saved with the workbook. *
** Note: This setting cannot be saved with a [[Workbook]] in the Excel file. It can only be saved * with a CustomView. Therefore, there is no corresponding property in [[WorkbookWindowOptions]] and * calling on the associated CustomView will not apply this property. Only by * applying the custom view through the Microsoft Excel user interface will the setting on this property be applied. *
* The pixel bounds of the workbook's MDI child window when CustomView owning these * window options is applied. * @throws [[ArgumentException]] The left or top of the value assigned is outside the bounds of -32768 and 32767. * @throws [[ArgumentException]] The width or height of the value assigned is outside the bounds of 0 and 65535. * @see [[CustomView.apply]] */ get boundsInPixels(): IgRect; set boundsInPixels(a: IgRect); /** * @hidden */ get _boundsInPixels$i(): Rect; /** * @hidden */ set _boundsInPixels$i(a: Rect); /** * Gets or sets the value indicating whether the workbook's MDI child window will be maximized * when the [[CustomView]] owning these window options is applied. ** Note: This setting cannot be saved with a [[Workbook]] in the Excel file. It can only be saved * with a CustomView. Therefore, there is no corresponding property in [[WorkbookWindowOptions]] and * calling on the associated CustomView will not apply this property. Only by * applying the custom view through the Microsoft Excel user interface will the setting on this property be applied. *
* The value indicating whether the workbook's MDI child window will be maximized when the CustomView owning these * window options is applied. * @see [[CustomView.apply]] * @see [[WorkbookWindowOptions.minimized]] */ get maximized(): boolean; set maximized(a: boolean); /** * Gets or sets the value indicating whether Microsoft Excel will display the formula bar when * the [[CustomView]] owning these window options is applied. ** Note: This setting cannot be saved with a [[Workbook]] in the Excel file. It can only be saved * with a CustomView. Therefore, there is no corresponding property in [[WorkbookWindowOptions]] and * calling [[CustomView.apply]] on the associated CustomView will not apply this property. Only by * applying the custom view through the Microsoft Excel user interface will the setting on this property be applied. *
* The value indicating whether Microsoft Excel will display the formula bar when the CustomView owning these window * options is applied. * @see [[CustomView.apply]] */ get showFormulaBar(): boolean; set showFormulaBar(a: boolean); /** * Gets or sets the value indicating whether Microsoft Excel will display the status bar when * the [[CustomView]] owning these window options is applied. ** Note: This setting cannot be saved with a [[Workbook]] in the Excel file. It can only be saved * with a CustomView. Therefore, there is no corresponding property in [[WorkbookWindowOptions]] and * calling on the associated CustomView will not apply this property. Only by * applying the custom view through the Microsoft Excel user interface will the setting on this property be applied. *
* The value indicating whether Microsoft Excel will display the status bar when the CustomView owning these window * options is applied. * @see [[CustomView.apply]] */ get showStatusBar(): boolean; set showStatusBar(a: boolean); /** * @hidden */ get _ao(): number; /** * @hidden */ set _ao(a: number); } /** * Base class for all data validations rules which can be applied to a cell. * @see [[Worksheet.dataValidationRules]] * @see [[AnyValueDataValidationRule]] * @see [[ListDataValidationRule]] * @see [[CustomDataValidationRule]] * @see [[OneConstraintDataValidationRule]] * @see [[TwoConstraintDataValidationRule]] */ export declare abstract class DataValidationRule extends Base implements IChangeInfoContext { static $t: Type; /** * @hidden */ private static readonly _aa; /** * @hidden */ private static readonly _ab; /** * @hidden */ private static readonly _ac; /** * @hidden */ private static readonly _ae; /** * @hidden */ private static readonly _af; /** * @hidden */ private static readonly _ah; /** * @hidden */ private static readonly _ai; /** * @hidden */ private static readonly _ad; /** * @hidden */ private static readonly _ag; /** * @hidden */ private static readonly _a; private _aj; private _al; private _d; private _an; private _ap; private _i; private _v; private _x; private _f; constructor(); /** * Creates a copy of this rule which can be applied to other worksheets. */ clone(): DataValidationRule; /** * @hidden */ abstract _n(a: string): SingleTargetFormula; /** * @hidden */ abstract _o(a: string): SingleTargetFormula; /** * @hidden */ abstract _at(a: SingleTargetFormula, b: string): void; /** * @hidden */ abstract _au(a: SingleTargetFormula, b: string): void; /** * @hidden */ abstract _z(a: WorksheetCellAddress): boolean; /** * @hidden */ abstract _aw(a: DataValidationRuleCollection, b: WorksheetReferenceCollection): void; /** * @hidden */ static _s(a: Formula, b: Formula): boolean; /** * @hidden */ static _t(a: string, b: string): boolean; /** * Indicates if this rule is structurally equivalent to another. * @param other The rule to compare against * @return Returns true if the specified 'other' has the same settings as this rule. */ isEquivalentTo(other: DataValidationRule): boolean; /** * @hidden */ _ar(a: DataValidationRuleCollection, b: WorksheetReferenceCollection): void; /** * @hidden */ _as(): void; /** * @hidden */ _av(a: string, b: string, c: number): void; /** * @hidden */ private static _c; /** * @hidden */ private static _b; /** * @hidden */ abstract get _r(): boolean; /** * @hidden */ abstract set _r(a: boolean); /** * @hidden */ abstract get _l(): DataValidationOperatorType; /** * @hidden */ abstract get _m(): DataValidationType; /** * Gets or sets the description which appears in the dialog box when an invalid value is applied to a cell * in Microsoft Excel. ** This value is only used when [[showErrorMessageForInvalidValue]] is True. *
** Note: the title cannot be more than 225 characters. *
* The description to show the user or null to use a default error description. * @throws [[ArgumentException]] Occurs when the specified value is longer than 225 characters. * @see [[errorMessageTitle]] */ get errorMessageDescription(): string; set errorMessageDescription(a: string); /** * Gets or sets the title which appears in the dialog box when an invalid value is applied to a cell * in Microsoft Excel. ** This value is only used when [[showErrorMessageForInvalidValue]] is True. *
** Note: the title cannot be more than 32 characters. *
* The title to show the user or null to use a default error dialog title. * @throws [[ArgumentException]] Occurs when the specified value is longer than 32 characters. * @see [[errorMessageDescription]] */ get errorMessageTitle(): string; set errorMessageTitle(a: string); /** * Gets or sets the value which indicates whether the value is allowed when it is invalid and which options are given to * the user in the error dialog shown by Microsoft Excel. ** This value is only used when [[showErrorMessageForInvalidValue]] is True. *
* @throws [[InvalidEnumArgumentException]] Occurs when the value is not a member of the [[DataValidationErrorStyle]] enumeration. * @see [[showErrorMessageForInvalidValue]] */ get errorStyle(): DataValidationErrorStyle; set errorStyle(a: DataValidationErrorStyle); /** * Gets or sets the description of the Japanese input rules. * @throws [[InvalidEnumArgumentException]] Occurs when the value is not a member of the [[DataValidationImeMode]] enumeration. */ get imeMode(): DataValidationImeMode; set imeMode(a: DataValidationImeMode); /** * Gets or sets the description in the tooltip which appears when the user selects the cell in Microsoft Excel. ** This value is only used when [[showInputMessage]] is True. *
** Note: the description cannot be more than 255 characters. *
* The description to show the user in the tooltip. * @throws [[ArgumentException]] Occurs when the specified value is longer than 255 characters. * @see [[inputMessageTitle]] */ get inputMessageDescription(): string; set inputMessageDescription(a: string); /** * Gets or sets the title in the tooltip which appears when the user selects the cell in Microsoft Excel. ** This value is only used when [[showInputMessage]] is True. *
** Note: the title cannot be more than 32 characters. *
* The title to show the user in the tooltip. * @throws [[ArgumentException]] Occurs when the specified value is longer than 32 characters. * @see [[inputMessageDescription]] */ get inputMessageTitle(): string; set inputMessageTitle(a: string); /** * Gets or sets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data * is entered in the cell. ** When the value is False, invalid data can be entered into cells, but when the user chooses to subsequently circle * invalid values in Microsoft Excel, the cell will be circled. *
* True to show the error dialog for invalid cell data; False otherwise. * @see [[errorMessageDescription]] * @see [[errorMessageTitle]] * @see [[errorStyle]] */ get showErrorMessageForInvalidValue(): boolean; set showErrorMessageForInvalidValue(a: boolean); /** * Gets or sets the value which indicates whether to show the user an input prompt tooltip when the user selects * the cell in Microsoft Excel. ** The input prompt will only be shown if this value is True and the [[inputMessageDescription]] is not null. *
* @see [[inputMessageDescription]] * @see [[inputMessageTitle]] */ get showInputMessage(): boolean; set showInputMessage(a: boolean); /** * @hidden */ protected get__k(): FormulaType; /** * @hidden */ get _k(): FormulaType; /** * @hidden */ get _j(): DataValidationRuleCollection; /** * @hidden */ get _workbook(): Workbook; /** * @hidden */ get _q(): Worksheet; /** * @hidden */ get workbook(): Workbook; /** * @hidden */ get sheet(): Sheet; /** * @hidden */ get source(): any; } /** * Represents a data validation rule which allows any value to be set on the target cells. * This would be used to provide an input message to the user when the cell was selected. * @see [[Worksheet.dataValidationRules]] * @see [[DataValidationRuleCollection.add]] * @see [[DataValidationRuleCollection.add]] */ export declare class AnyValueDataValidationRule extends DataValidationRule { static $t: Type; constructor(); /** * @hidden */ protected get__r(): boolean; /** * @hidden */ protected set__r(a: boolean): void; /** * @hidden */ get _r(): boolean; /** * @hidden */ set _r(a: boolean); /** * @hidden */ _n(a: string): SingleTargetFormula; /** * @hidden */ _o(a: string): SingleTargetFormula; /** * @hidden */ protected get__l(): DataValidationOperatorType; /** * @hidden */ get _l(): DataValidationOperatorType; /** * @hidden */ _at(a: SingleTargetFormula, b: string): void; /** * @hidden */ _au(a: SingleTargetFormula, b: string): void; /** * @hidden */ _z(a: WorksheetCellAddress): boolean; /** * @hidden */ protected get__m(): DataValidationType; /** * @hidden */ get _m(): DataValidationType; /** * @hidden */ _aw(a: DataValidationRuleCollection, b: WorksheetReferenceCollection): void; } /** * Base class for all data validations rules which prevent certain values form being applied to a cell. * @see [[ListDataValidationRule]] * @see [[CustomDataValidationRule]] * @see [[OneConstraintDataValidationRule]] * @see [[TwoConstraintDataValidationRule]] */ export declare abstract class LimitedValueDataValidationRule extends DataValidationRule { static $t: Type; /** * @hidden */ private static readonly _bd; /** * @hidden */ private static readonly _be; /** * @hidden */ private static readonly _ax; private _a6; constructor(); /** * @hidden */ protected get__r(): boolean; /** * @hidden */ protected set__r(a: boolean): void; /** * @hidden */ get _r(): boolean; /** * @hidden */ set _r(a: boolean); /** * Indicates if this rule is structurally equivalent to another. * @param other The rule to compare against * @return Returns true if the specified 'other' has the same settings as this rule. */ isEquivalentTo(other: DataValidationRule): boolean; /** * @hidden */ _z(a: WorksheetCellAddress): boolean; /** * @hidden */ _az(a: SingleTargetFormula, b: WorksheetCellAddress, c?: boolean): ExcelCalcValue; /** * @hidden */ _bg(a: SingleTargetFormula, b: WorksheetReferenceCollection): { p0?: SingleTargetFormula; }; /** * @hidden */ _a9(a: FormulaToken, b: boolean, c: boolean, d: boolean, e: WorkbookFormat): boolean; /** * @hidden */ static _ba(a: FormulaToken, b: boolean, c: boolean, d: boolean): boolean; /** * @hidden */ _bf(a: () => string, b: WorkbookFormat): Nullable$1* The formula will indicate the value is invalid by evaluating to False, 0, any [[ErrorValue]] (such as #VALUE!), * or any string other than "True" (case-insensitive). * True, "True" (case-insensitive), null, and non-zero numeric values will indicate a valid value has been applied. *
** The address passed in is only needed if relative addresses are used in the the formula. For example, consider the formula * applied is =B1, and the data validation rule is applied to the region A1:A5. If you get the formula for A1, the formula * =B1 will be returned. If you get the formula for A2, =B2 will be returned. Similarly, for cell A5, =B5 will be returned. * However, if the formula contains no references or all absolute references, the 'address' is ignored. So * in the previous example, if the original formula was =$B$1, the same formula will be returned regardless of the specified * address. *
** 'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the * top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. * Any reference is allowed. *
** The cell reference mode with which to parse 'address' will be assumed to be A1, unless the data validation * rule is applied to a worksheet which is in a workbook, in which case the [[Workbook.cellReferenceMode]] will be used. *
* @param address The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of * the worksheet. * @throws [[ArgumentException]] Occurs when 'address' is not a valid cell or regions address. * @return A formula used to validate the value applied to a cell. * @see [[getFormula]] * @see [[setFormula]] * @see [[setFormula]] */ getFormula(address: string): string; /** * Gets the formula used to validate the value applied to a cell. ** The formula will indicate the value is invalid by evaluating to False, 0, any [[ErrorValue]] (such as #VALUE!), * or any string other than "True" (case-insensitive). * True, "True" (case-insensitive), null, and non-zero numeric values will indicate a valid value has been applied. *
** The address passed in is only needed if relative addresses are used in the the formula. For example, consider the formula * applied is =B1, and the data validation rule is applied to the region A1:A5. If you get the formula for A1, the formula * =B1 will be returned. If you get the formula for A2, =B2 will be returned. Similarly, for cell A5, =B5 will be returned. * However, if the formula contains no references or all absolute references, the 'address' is ignored. So * in the previous example, if the original formula was =$B$1, the same formula will be returned regardless of the specified * address. *
** 'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the * top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. * Any reference is allowed. *
* @param address The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of * the worksheet. * @param format The workbook format with which to parse 'address'. * @param cellReferenceMode The cell reference mode with which to parse 'address'. * @param culture The culture to use when generating the formula string. * @throws [[ArgumentException]] Occurs when 'address' is not a valid cell or regions address. * @throws [[InvalidEnumArgumentException]] Occurs when 'format' is not defined in the [[WorkbookFormat]] enumeration. * @throws [[InvalidEnumArgumentException]] Occurs when 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration. * @return A formula used to validate the value applied to a cell. * @see [[getFormula]] * @see [[setFormula]] * @see [[setFormula]] */ getFormula(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: string | CultureInfo): string; /** * @hidden */ _getFormula(a: string): string; /** * @hidden */ _getFormula1(a: string, b: WorkbookFormat, c: CellReferenceMode, d: CultureInfo): string; /** * Sets the formula used to validate the value applied to a cell. ** The formula will indicate the value is invalid by evaluating to False, 0, any [[ErrorValue]] (such as #VALUE!), * or any string other than "True" (case-insensitive). * True, "True" (case-insensitive), null, and non-zero numeric values will indicate a valid value has been applied. *
** The address passed in is only needed if relative addresses are used in the the formula. When the data validation rule is * applied to cells or regions, the references in the formula used by each individual cell will be shifted by the offset of * the cell to the passed in 'address'. For example, consider the formula specified is =B1 and the specified * address is A1. If the data validation rule is then applied to the A5 cell, the formula is will use is =B5. However, if the * references in the formula are absolute, such as =$B$1, the same formula will be applied regardless of the specified address. *
** 'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the * top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. * Any reference is allowed. *
** The cell reference mode with which to parse 'address' will be assumed to be A1, unless the data validation * rule is applied to a worksheet which is in a workbook, in which case the [[Workbook.cellReferenceMode]] will be used. *
* @param formula The validation formula to use for the rule. * @param address The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of * the worksheet. * @throws [[ArgumentNullException]] Occurs when 'formula' is null and the rule is currently applied to a [[Worksheet]]. * @throws [[FormulaParseException]] Occurs when 'formula' is not a valid formula. * @throws [[ArgumentException]] Occurs when 'address' is not a valid cell or regions address. * @see [[getFormula]] * @see [[getFormula]] * @see [[setFormula]] */ setFormula(formula: string, address: string): void; /** * Sets the formula used to validate the value applied to a cell. ** The formula will indicate the value is invalid by evaluating to False, 0, any [[ErrorValue]] (such as #VALUE!), * or any string other than "True" (case-insensitive). * True, "True" (case-insensitive), null, and non-zero numeric values will indicate a valid value has been applied. *
** The address passed in is only needed if relative addresses are used in the the formula. When the data validation rule is * applied to cells or regions, the references in the formula used by each individual cell will be shifted by the offset of * the cell to the passed in 'address'. For example, consider the formula specified is =B1 and the specified * address is A1. If the data validation rule is then applied to the A5 cell, the formula is will use is =B5. However, if the * references in the formula are absolute, such as =$B$1, the same formula will be applied regardless of the specified address. *
** 'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the * top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. * Any reference is allowed. *
* @param formula The validation formula to use for the rule. * @param address The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of * the worksheet. * @param format The workbook format with which to parse 'address'. * @param cellReferenceMode The cell reference mode with which to parse 'address'. * @param culture The culture to use when parsing the formula string. * @throws [[ArgumentNullException]] Occurs when 'formula' is null and the rule is currently applied to a [[Worksheet]]. * @throws [[FormulaParseException]] Occurs when 'formula' is not a valid formula. * @throws [[ArgumentException]] Occurs when 'address' is not a valid cell or regions address. * @throws [[InvalidEnumArgumentException]] Occurs when 'format' is not defined in the [[WorkbookFormat]] enumeration. * @throws [[InvalidEnumArgumentException]] Occurs when 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration. * @see [[getFormula]] * @see [[getFormula]] * @see [[setFormula]] */ setFormula(formula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: string | CultureInfo): void; /** * @hidden */ _setFormula(a: string, b: string): void; /** * @hidden */ _setFormula1(a: string, b: string, c: WorkbookFormat, d: CellReferenceMode, e: CultureInfo): void; /** * @hidden */ _bo(a: string, b: WorkbookFormat, c: CellReferenceMode, d: CultureInfo): SingleTargetFormula; /** * @hidden */ private _bv; /** * @hidden */ private static _bm; /** * @hidden */ private static _bl; } /** * Represents an error value in Microsoft Excel. */ export declare class ErrorValue extends Base { static $t: Type; /** * @hidden */ static readonly _v: number; /** * @hidden */ static readonly _u: number; /** * @hidden */ static readonly _ab: number; /** * @hidden */ static readonly _w: number; /** * @hidden */ static readonly _aa: number; /** * @hidden */ static readonly _z: number; /** * @hidden */ static readonly _s: number; /** * @hidden */ static readonly _t: number; /** * @hidden */ private static _h; /** * @hidden */ private static _f; /** * @hidden */ private static _q; /** * @hidden */ private static _k; /** * @hidden */ private static _o; /** * @hidden */ private static _m; /** * @hidden */ private static _b; /** * @hidden */ private static _d; /** * @hidden */ private static readonly _ac; private _x; constructor(a: number); /** * Gets the string representation of the error value. * @return The string representation of the error value. */ toString(): string; /** * @hidden */ static _j(a: number): ErrorValue; /** * @hidden */ _a(): ExcelCalcErrorValue; /** * Gets the ErrorValue representing the #N/A error. ** This error occurs when a value isn't available for some part of a formula. *
* The ErrorValue representing the #N/A error. */ static get argumentOrFunctionNotAvailable(): ErrorValue; /** * Gets the ErrorValue representing a circularity error. ** There is no error constant for a circularity in Microsoft Excel and a circularity cannot be the result of a formula in Microsoft Excel. * However, for run-time purposes, after loading or before saving a workbook, this error value will be used for the result of formulas * which cause circular references when the owning workbook has [[Workbook.iterativeCalculationsEnabled]] set to False. *
** In Microsoft Excel, setting a circular reference formula on a cell will show an error dialog the first time the problem occurs. Subsequent * formulas violating the circular reference restriction will just evaluate to zero. Therefore, when this value is encountered in a cell, it * can be treated as a zero for calculation purposes. This error value will be returned though so an actual zero value in a cell can be * differentiated from a circularity error. *
** Note: Because there is no circularity error constant in Microsoft Excel, this error value cannot be assigned to a cell manually. * Attempting to assign this error value to a cell will result in an InvalidOperationException to be thrown. This error value will only be * valid as the result of a formula which has been applied to a cell. *
* The ErrorValue representing a circularity error. */ static get circularity(): ErrorValue; /** * Gets the ErrorValue representing the #DIV/0! error. ** This error occurs when a number is divided by zero. *
* The ErrorValue representing the #DIV/0! error. */ static get divisionByZero(): ErrorValue; /** * Gets the ErrorValue representing the #NULL! error. ** This error occurs when there is an intersection of two references that do not contain any common cells. * The intersection operator is a space between two references. *
* The ErrorValue representing the #NULL! error. */ static get emptyCellRangeIntersection(): ErrorValue; /** * Gets the ErrorValue representing the #REF! error. ** This error occurs when a cell reference or cell range reference is not valid. *
* The ErrorValue representing the #REF! error. */ static get invalidCellReference(): ErrorValue; /** * Gets the ErrorValue representing the #NUM! error. ** This error occurs when there are invalid numeric values in a formula. *
* The ErrorValue representing the #NUM! error. */ static get valueRangeOverflow(): ErrorValue; /** * Gets the ErrorValue representing the #NAME? error. ** This error occurs when text in a formula is not recognized. *
* The ErrorValue representing the #NAME? error. */ static get wrongFunctionName(): ErrorValue; /** * Gets the ErrorValue representing the #VALUE! error. ** This error occurs when an incorrect argument or operand is used in a function. *
* The ErrorValue representing the #VALUE! error. */ static get wrongOperandType(): ErrorValue; /** * @hidden */ get _y(): number; } /** * @hidden */ export declare class StringElement extends GenericCacheElement implements IComparable$1* Any default properties of the cell's format will take their value from this format when getting a resolved format. *
* The default cell format for cells in this row or column. */ get cellFormat(): IWorksheetCellFormat; /** * @hidden */ get _hasCellFormat(): boolean; /** * Gets or sets the value indicating whether the row or column is hidden. * The Hidden state also controls the expanded state of rows or columns in outline groups. Basically, an outline group * simply provides an easy way to hide and unhide all rows or columns in the group at the same time, via the expansion * indicator. * The value indicating whether the row or column is hidden. * @throws [[InvalidOperationException]] From the stter if the object was removed from the worksheet. * @see [[outlineLevel]] * @see [[CustomView.getHiddenColumns]] * @see [[CustomView.getHiddenRows]] */ get hidden(): boolean; set hidden(a: boolean); /** * @hidden */ _aa(a: boolean, b?: boolean): void; /** * Gets the 0-based index of the row or column in the worksheet. * The 0-based index of the row or column in the worksheet. */ abstract get index(): number; /** * Gets or sets the outline level for the row or column. ** Microsoft Excel supports hierarchical grouping of rows and columns with a maximum of seven levels of hierarchy. * To create a group, set adjacent rows or columns to same outline level. When rows or columns are grouped, an * outline indicator will provide a visual representation of the outline level. In addition, an outline group has * an expansion indicator at one end of the group, which allows the user to easily hide and unhide all rows or column * in the group with a single click. *
* The outline level for the row or column. * @throws [[ArgumentOutOfRangeException]] The value assigned is outside the valid outline level range of 0 and 7. * @throws [[InvalidOperationException]] From the stter if the object was removed from the worksheet. * @see [[hidden]] */ get outlineLevel(): number; set outlineLevel(a: number); /** * @hidden */ private _ab; /** * Gets the worksheet to which the row or column belongs. * The worksheet to which the row or column belongs. */ get worksheet(): Worksheet; /** * @hidden */ get _cellFormatInternal(): WorksheetCellFormatProxy; /** * @hidden */ abstract get _a(): ChangeInfo[]; /** * @hidden */ protected get__j(): boolean; /** * @hidden */ get _j(): boolean; /** * @hidden */ abstract get _l(): boolean; /** * @hidden */ abstract set _l(a: boolean); /** * @hidden */ abstract get _n(): number; /** * @hidden */ abstract set _n(a: number); /** * @hidden */ _ac(a: FormatLimitErrors, b: WorkbookFormat): void; /** * @hidden */ abstract get _m(): boolean; } /** * @hidden */ export interface IWorksheetRegionAddressContext { getRegionAddress(): WorksheetRegionAddress; } /** * @hidden */ export declare let IWorksheetRegionAddressContext_$type: Type; /** * Represents a row in a Microsoft Excel worksheet. */ export declare class WorksheetRow extends RowColumnBase implements IChangeInfoContext, IWorksheetRegionAddressContext { static $t: Type; /** * @hidden */ static readonly _cz: number; /** * @hidden */ static readonly _c6: number; /** * @hidden */ private static readonly _c3; /** * @hidden */ private static readonly _c7; /** * @hidden */ private static readonly _ae; private _ba; private _cs; private _af; private _bx; private _ag; private _ai; private _ao; private _cu; private _c4; private _cj; private _cl; private _bu; private _ck; constructor(a: Worksheet, b: number); /** * @hidden */ protected get__a(): ChangeInfo[]; /** * @hidden */ get _a(): ChangeInfo[]; /** * @hidden */ _h(a: GenericCachedCollectionEx$1* 'formula' is parsed based on the [[CellReferenceMode]] of the [[Workbook]] * to which the row belongs. If the row's [[Worksheet]] has been removed from its parent collection, * the A1 CellReferenceMode will be used to parse the formula. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @param formula The formula to parse and apply to the cell. * @param cellReferenceMode The mode used to interpret cell references in the formula. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[ArgumentNullException]] 'formula' is null or empty. * @throws [[FormulaParseException]] 'formula' is not a valid formula. * @throws [[InvalidOperationException]] The cell is part of an array formula or data table which is not confined to just the cell. * @throws [[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @see [[getCellFormula]] * @see [[WorksheetCell.applyFormula]] */ applyCellFormula(columnIndex: number, formula: string, cellReferenceMode?: CellReferenceMode): void; /** * @hidden */ _applyCellFormula$i(a: number, b: string, c?: Nullable$1* The cells in the left-most column and top-most row of the data table will return null for the associated data table. *
** If a data table is associated with the cell, getting the value of the cell with [[getCellValue]] * will return the calculated value for the cell. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The data table to which the cell belongs or null if the cell does not belong to a data table. * @see [[Worksheet.dataTables]] * @see [[WorksheetDataTableCollection.add]] * @see [[getCellValue]] * @see [[WorksheetCell.associatedDataTable]] */ getCellAssociatedDataTable(columnIndex: number): WorksheetDataTable; /** * @hidden */ _bn(a: number): WorksheetDataTable; /** * Gets the merged cells region which contains the cell at the specified index, or null if the cell is not merged. * @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The merged cells region which contains the cell at the specified index, or null if the cell is not merged. * @see [[WorksheetCell.associatedMergedCellsRegion]] */ getCellAssociatedMergedCellsRegion(columnIndex: number): WorksheetMergedCellsRegion; /** * @hidden */ _bs(a: number): WorksheetMergedCellsRegion; /** * Gets the [[WorksheetTable]] to which the cell at the specified index belongs. ** A cell belongs to a table if it exists in any area of the table. It can be a header cell, total cell, or a cell in the data area. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @see [[WorksheetTable]] * @see [[Worksheet.tables]] */ getCellAssociatedTable(columnIndex: number): WorksheetTable; /** * @hidden */ _bw(a: number): WorksheetTable; /** * Gets the bounds of the cell at the specified column index in twips (1/20th of a point). ** The bounds returned by this method are only valid with the current configuration of the worksheet. * If any rows or columns before the cell are resized, these bounds will no longer reflect the * position of the cell. *
* @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The bounds of the cell at the specified column index on its worksheet. * @see [[WorksheetCell.getBoundsInTwips]] */ getCellBoundsInTwips(columnIndex: number): IgRect; /** * Gets the bounds of the cell at the specified column index in twips (1/20th of a point). ** The bounds returned by this method are only valid with the current configuration of the worksheet. * If any rows or columns before the cell are resized, these bounds will no longer reflect the * position of the cell. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @param options The options to use when getting the bounds of the cell. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The bounds of the cell at the specified column index on its worksheet. * @see [[WorksheetCell.getBoundsInTwips]] */ getCellBoundsInTwips(columnIndex: number, options: PositioningOptions): IgRect; /** * @hidden */ _getCellBoundsInTwips(a: number): Rect; /** * @hidden */ _ew(a: number): Rect; /** * @hidden */ _getCellBoundsInTwips1(a: number, b: PositioningOptions): Rect; /** * @hidden */ _ex(a: number, b: PositioningOptions): Rect; /** * Gets or sets the comment applied to the cell at the specified column index. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The comment applied to the cell. * @see [[WorksheetCell.comment]] */ getCellComment(columnIndex: number): WorksheetCellComment; /** * @hidden */ _bd(a: number): WorksheetCellComment; /** * Gets the display text in the cell at the specified index. ** The display text is based on the value of the cell and the format string applied to the cell. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @see [[getCellValue]] * @see [[IWorksheetCellFormat.formatString]] */ getCellText(columnIndex: number): string; /** * Gets the text in the cell at the specified index. ** The text is based on the value of the cell and the format string applied to the cell. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @param textFormatMode The format mode to use when getting the cell text. * @throws [[InvalidEnumArgumentException]] 'textFormatMode' is not defined in the [[TextFormatMode]] enumeration. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @see [[getCellValue]] * @see [[IWorksheetCellFormat.formatString]] */ getCellText(columnIndex: number, textFormatMode: TextFormatMode): string; /** * @hidden */ _getCellText(a: number): string; /** * @hidden */ _getCellText1(a: number, b: TextFormatMode): string; /** * @hidden */ _di(a: number, b: TextFormatMode): string; /** * @hidden */ _az(a: GetCellTextParameters): GetCellTextResult; /** * @hidden */ _a0(a: WorksheetCellBlock, b: GetCellTextParameters): GetCellTextResult; /** * Gets the cell conditional format for the cell at the specified column index. ** Use this method to set cell formatting specific to the cell. If you will be applying the format to numerous cells, * see the [[Workbook.createNewWorksheetCellFormat]] method for performance considerations. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The cell formatting for the cell at the specified column index. * @see [[getResolvedCellFormat]] * @see [[WorksheetCell.cellFormat]] * @see [[tryGetCellFormat]] */ getCellFormat(columnIndex: number): IWorksheetCellFormat; /** * Gets the formula which has been applied to the cell at the specified column index. ** If a formula has been applied to the cell, getting the value with the [[getCellValue]] method will return the * calculated value of the formula. *
* @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return The formula which has been applied to the cell or null if no formula has been applied. * @see [[Formula.applyTo]] * @see [[Formula.applyTo]] * @see [[Formula.applyTo]] * @see [[applyCellFormula]] * @see [[WorksheetRegion.applyFormula]] * @see [[WorksheetRegion.applyArrayFormula]] * @see [[WorksheetCell.formula]] */ getCellFormula(columnIndex: number): Formula; /** * @hidden */ _av(a: number): Formula; /** * @hidden */ _bp(a: number): WorksheetHyperlink; /** * Gets the effective hyperlink on the cell at the specified index. ** If multiple hyperlinks are applied to the cell, the last one in the [[Worksheet.hyperlinks]] * collection will be used. *
** If the cell has one or more hyperlinks in the [[Worksheet.hyperlinks]] collection as well * as a formula containing a HYPERLINK function, the last hyperlink from the collection will be used. *
** If the cell has a hyperlink due to the HYPERLINK function being used in a formula, the returned value will be sealed. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @see [[Worksheet.hyperlinks]] * @see [[WorksheetHyperlink]] * @see [[WorksheetHyperlink.isSealed]] */ getCellHyperlink(columnIndex: number): WorksheetHyperlink; /** * Gets the value of the cell at the specified column index. ** If this cell belongs to a merged cell region and it is the top-left cell of the region, getting and setting the value * will get and set the value of the associated merged cell region. Getting the value of other cells in a merged cell region * will always return null. Setting the value of other cells in a merged cell region will have no effect. *
** If a formula has been applied to the cell or a data table is associated with the cell, getting the Value will return the * calculated value of the cell. *
*
* The types supported for the value are:
*
*
* If any cell format properties are the default values on the cell, the values from the owning row's cell format will be used. * If those are default, then the values from the owning column's cell format will be used. Otherwise, the workbook default values * will be used. *
* @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @return A format object describing the actual formatting that will be used when displayed the cell in Microsoft Excel. * @see [[getCellFormat]] * @see [[RowColumnBase.cellFormat]] * @see [[WorksheetCell.getResolvedCellFormat]] */ getResolvedCellFormat(columnIndex: number): IWorksheetCellFormat; /** * @hidden */ _getResolvedCellFormat1(a: number): IWorksheetCellFormat; /** * @hidden */ _a3(a: number): IWorksheetCellFormat; /** * Sets the comment applied to the cell at the specified column index. * @param columnIndex The 0-based index of the cell within the [[WorksheetRow]]. * @param comment The comment to apply to the cell. * @throws [[ArgumentOutOfRangeException]] 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet. * @throws [[InvalidOperationException]] The value applied only has only one anchor cell set. It should have both or neither anchor cells set. * @throws [[InvalidOperationException]] The value has its [[WorksheetShape.topLeftCornerCell]] and [[WorksheetShape.bottomRightCornerCell]] * anchors set but they are from different worksheets. * @throws [[InvalidOperationException]] If the row was removed from the worksheet. * @see [[WorksheetCell.comment]] */ setCellComment(columnIndex: number, comment: WorksheetCellComment): void; /** * @hidden */ _eb(a: number, b: WorksheetCellComment): void; /** * Sets the value of a cell at the specified column index. ** If this cell belongs to a merged cell region and it is the top-left cell of the region, getting and setting the value * will get and set the value of the associated merged cell region. Getting the value of other cells in a merged cell region * will always return null. Setting the value of other cells in a merged cell region will have no effect. *
** If a formula has been applied to the cell or a data table is associated with the cell, getting the Value will return the * calculated value of the cell. *
*
* The types supported for the value are:
*
*