// Copyright (c) 2001-2026 Aspose Pty Ltd. All Rights Reserved. // Powered by Aspose.Cells. /** * Monitor for interruption requests in all time-consuming operations. */ export abstract class AbstractInterruptMonitor { /** * Indicates whether interruption is requested for current operation. * If true then current operation will be interrupted. * Implementation should perform fast and efficient check here, otherwise it may become another bottleneck for the procedure. */ abstract isInterruptionRequested() : boolean; /** * When procedure is interrupted, whether terminate the procedure quietly or throw an Exception. * Default is false, that is, when is true, * a with code will be thrown. */ getTerminateWithoutException() : boolean; } /** * Represents the auto fill type. */ export enum AutoFillType { /** * Copies the value and format of the source area to the target area */ Copy = 1, /** * Automatically fills the target area with the value and format. */ Default = 0, /** * Copies only the format of the source area to the target area. */ Formats = 3, /** * Extend the value in the source area to the target area in the form of a series and copy the format to the target area. */ Series = 2, /** * Copies only the value of the source area to the target area. */ Values = 4, } /** * Represents the settings of the advanced filter. */ export class AdvancedFilter { /** * @deprecated Please use the 'listRange' property instead. * Gets the list range of this advanced filter. */ getListRange() : string; /** * Gets the list range of this advanced filter. */ readonly listRange : string; /** * @deprecated Please use the 'criteriaRange' property instead. * Gets the criteria range of this advanced filter. */ getCriteriaRange() : string; /** * Gets the criteria range of this advanced filter. */ readonly criteriaRange : string; /** * @deprecated Please use the 'copyToRange' property instead. * Gets the range where copying the resut of this advanced filter to. */ getCopyToRange() : string; /** * Gets the range where copying the resut of this advanced filter to. */ readonly copyToRange : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents autofiltering for the specified worksheet. */ export class AutoFilter { /** * @deprecated Please use the 'sorter' property instead. * Gets the data sorter. */ getSorter() : DataSorter; /** * Gets the data sorter. */ readonly sorter : DataSorter; /** * @deprecated Please use the 'range' property instead. * Represents the range to which the specified AutoFilter applies. */ getRange() : string; /** * Represents the range to which the specified AutoFilter applies. */ range : string; /** * @deprecated Please use the 'range' property instead. * Represents the range to which the specified AutoFilter applies. * @param value - The value to set. */ setRange(value: string) : void; /** * @deprecated Please use the 'showFilterButton' property instead. * Indicates whether the AutoFilter button for this column is visible. */ getShowFilterButton() : boolean; /** * Indicates whether the AutoFilter button for this column is visible. */ showFilterButton : boolean; /** * @deprecated Please use the 'showFilterButton' property instead. * Indicates whether the AutoFilter button for this column is visible. * @param value - The value to set. */ setShowFilterButton(value: boolean) : void; /** * @deprecated Please use the 'filterColumns' property instead. * Gets the collection of the filter columns. */ getFilterColumns() : FilterColumnCollection; /** * Gets the collection of the filter columns. */ readonly filterColumns : FilterColumnCollection; /** * Sets the range to which the specified AutoFilter applies. * @param row - Row index. * @param startColumn - Start column index. * @param endColumn - End column Index. */ setRange(row: number, startColumn: number, endColumn: number) : void; /** * Gets the where the this AutoFilter applies to. * @returns * the area this filter applies to */ getCellArea() : CellArea; /** * Gets the where the specified AutoFilter applies. * @param refreshAppliedRange - Whether refresh the applied range. /// For the applied range of auto filter, the last row may change when cells data changes. /// If this flag is true, then the last row of the range will be re-calculated according to current cells data. * @returns * the area this filter applies to */ getCellArea(refreshAppliedRange: boolean) : CellArea; /** * Adds a filter for a filter column. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param criteria - The specified criteria (a string; for example, "101"). /// It only can be null or be one of the cells' value in this column. * * @remarks * MS Excel 2007 supports multiple selection in a filter column. */ addFilter(fieldIndex: number, criteria: string) : void; /** * Adds a date filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param dateTimeGroupingType - The grouping type * @param year - The year. * @param month - The month. * @param day - The day. * @param hour - The hour. * @param minute - The minute. * @param second - The second. * * @remarks * If DateTimeGroupingType is Year, only the param year effects. * If DateTiemGroupingType is Month, only the param year and month effect. */ addDateFilter(fieldIndex: number, dateTimeGroupingType: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void; /** * Removes a date filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param dateTimeGroupingType - The grouping type * @param year - The year. * @param month - The month. * @param day - The day. * @param hour - The hour. * @param minute - The minute. * @param second - The second. * * @remarks * If DateTimeGroupingType is Year, only the param year effects. * If DateTiemGroupingType is Month, only the param year and month effect. */ removeDateFilter(fieldIndex: number, dateTimeGroupingType: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void; /** * Removes a filter for a filter column. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param criteria - The specified criteria (a string; for example, "101"). /// It only can be null or be one of the cells' value in this column. */ removeFilter(fieldIndex: number, criteria: string) : void; /** * Remove the specific filter. * @param fieldIndex - The specific filter index */ removeFilter(fieldIndex: number) : void; /** * Filters a list with specified criteria. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param criteria - The specified criteria (a string; for example, "101"). * * @remarks * Aspose.Cells will remove all other filter setting on this field as Ms Excel 97-2003. */ filter(fieldIndex: number, criteria: string) : void; /** * Filter the top 10 items in the list * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param isTop - Indicates whether filter from top or bottom * @param isPercent - Indicates whether the items is percent or count * @param itemCount - The item count */ filterTop10(fieldIndex: number, isTop: boolean, isPercent: boolean, itemCount: number) : void; /** * Adds a dynamic filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param dynamicFilterType - Dynamic filter type. */ dynamic_Filter(fieldIndex: number, dynamicFilterType: DynamicFilterType) : void; /** * Adds a font color filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param color - The object. */ addFontColorFilter(fieldIndex: number, color: CellsColor) : void; /** * Adds a fill color filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param pattern - The background pattern type. * @param foregroundColor - The foreground color. * @param backgroundColor - The background color. */ addFillColorFilter(fieldIndex: number, pattern: BackgroundType, foregroundColor: CellsColor, backgroundColor: CellsColor) : void; /** * Adds an icon filter. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param iconSetType - The icon set type. * @param iconId - The icon id. * * @remarks * Only supports to add the icon filter. * Not supports checking which row is visible if the filter is icon filter. */ addIconFilter(fieldIndex: number, iconSetType: IconSetType, iconId: number) : void; /** * Match all blank cells in the list. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). */ matchBlanks(fieldIndex: number) : void; /** * Match all not-blank cells in the list. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). */ matchNonBlanks(fieldIndex: number) : void; /** * Filters a list with a custom criterion. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param operatorType1 - The filter operator type * @param criteria1 - The custom criteria */ custom(fieldIndex: number, operatorType1: FilterOperatorType, criteria1: Object) : void; /** * Filters a list with custom criteria. * @param fieldIndex - The integer offset of the field on which you want to base the filter /// (from the left of the list; the leftmost field is field 0). * @param operatorType1 - The filter operator type * @param criteria1 - The custom criteria * @param isAnd - * @param operatorType2 - The filter operator type * @param criteria2 - The custom criteria */ custom(fieldIndex: number, operatorType1: FilterOperatorType, criteria1: Object, isAnd: boolean, operatorType2: FilterOperatorType, criteria2: Object) : void; /** * Unhide all rows. */ showAll() : void; /** * Refresh auto filters to hide or unhide the rows. * @returns * Returns all hidden rows' indexes. */ refresh() : number[]; /** * Gets all hidden rows' indexes. * @param hideRows - If true, hide the filtered rows. * @returns * Returns all hidden rows indexes. */ refresh(hideRows: boolean) : number[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the category of the filter. */ export enum FilterCategory { /** * No Filter. */ None = 0, /** * Caption Filter. */ Label = 1, /** * Number Value Filter. */ NumberValue = 2, /** * Date Value Filter. */ Date = 3, /** * Top10 Value Filter. */ Top10 = 4, } /** * Represents filter value used in the criteria. */ export class FilterValue { /** * Gets the type of this filter value. */ getValueType() : FilterValueType; /** * @deprecated Please use the 'stringValue' property instead. * Gets the string value. */ getStringValue() : string; /** * Gets the string value. */ readonly stringValue : string; /** * @deprecated Please use the 'dateTimeGroupItem' property instead. * Gets date time value. */ getDateTimeGroupItem() : DateTimeGroupItem; /** * Gets date time value. */ readonly dateTimeGroupItem : DateTimeGroupItem; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the multiple filter collection. */ export class FilterValueCollection implements Iterable { /** * Gets by index. * @param index - */ get(index: number) : FilterValue; /** * @deprecated Please use the 'matchBlank' property instead. * Indicates whether to filter by blank. */ getMatchBlank() : boolean; /** * Indicates whether to filter by blank. */ matchBlank : boolean; /** * @deprecated Please use the 'matchBlank' property instead. * Indicates whether to filter by blank. * @param value - The value to set. */ setMatchBlank(value: boolean) : void; /** * Adds a label filter criteria. * @param filter - The filter data. */ add(filter: string) : void; /** * Adds a date filter criteria value. * @param type - The type of date filter. * @param year - The year. * @param month - The month. * @param day - The day. */ add(type: DateTimeGroupingType, year: number, month: number, day: number) : void; /** * Adds a date time filter criteria value. * @param type - The type of date filter. * @param year - The year. * @param month - The month. * @param day - The day. * @param hour - The hour. * @param minute - The minute. * @param second - The second. */ add(type: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents type of filter value. */ export enum FilterValueType { /** * The filter value is datetime. Corresponding value must be . */ IsDateTime = 4, /** * The filter is a label. Corresponding value must be string. */ IsString = 8, } /** * Represents the type of auto fitting merged cells. */ export enum AutoFitMergedCellsType { /** * Ignore merged cells. * * @remarks * Default. */ None = 0, /** * Only expands the height of the first row. */ FirstLine = 1, /** * Only expands the height of the last row. */ LastLine = 2, /** * Expands the height of each row. */ EachLine = 3, } /** * Represents the type of auto fitting wrapped text. */ export enum AutoFitWrappedTextType { /** * Works as MS Excel. */ Default = 0, /** * Auto fit width with the longest paragraph. */ Paragraph = 1, } /** * Enumerates all Monochromatic Palettes used in an Excel chart. */ export enum ChartColorPaletteType { /** * accent1 theme color gradient, dark to light. */ MonochromaticPalette1 = 1, /** * accent2 theme color gradient, dark to light. */ MonochromaticPalette2 = 2, /** * accent3 theme color gradient, dark to light. */ MonochromaticPalette3 = 3, /** * accent4 theme color gradient, dark to light. */ MonochromaticPalette4 = 4, /** * accent5 theme color gradient, dark to light. */ MonochromaticPalette5 = 5, /** * accent6 theme color gradient, dark to light. */ MonochromaticPalette6 = 6, /** * accent7 theme color gradient. */ MonochromaticPalette7 = 7, /** * accent1 theme color gradient, light to dark. */ MonochromaticPalette8 = 8, /** * accent2 theme color gradient, light to dark. */ MonochromaticPalette9 = 9, /** * accent3 theme color gradient, light to dark. */ MonochromaticPalette10 = 10, /** * accent4 theme color gradient, light to dark. */ MonochromaticPalette11 = 11, /** * accent5 theme color gradient, light to dark. */ MonochromaticPalette12 = 12, /** * accent6 theme color gradient, light to dark. */ MonochromaticPalette13 = 13, } /** * Specifies the initial view mode when the generated PDF document is opened. */ export enum PdfZoomBehavior { /** * Uses the PDF viewer's default behavior. */ None = 0, /** * Opens the document at a specific zoom percentage. */ ZoomFactor = 1, /** * Fits the entire page within the viewer window. */ FitPage = 2, /** * Fits the page width within the viewer window. */ FitWidth = 3, /** * Fits the page height within the viewer window. */ FitHeight = 4, } /** * Represents custom settings during rendering. */ export class CustomRenderSettings { /** * Ctor. */ constructor(); /** * Specifies cell border width according to border type. * @param borderType - cell border type * @returns * cell border width * * @remarks * Any negative value will be ignored. */ getCellBorderWidth(borderType: CellBorderType) : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the embedded font type in html. */ export enum HtmlEmbeddedFontType { /** * Not embed font. */ None = 0, /** * Embed WOFF font. */ Woff = 1, } /** * Represents the DataBar render mode. */ export enum DataBarRenderMode { /** * Renders the DataBar using background color. */ BackgroundColor = 1, /** * Renders the DataBar as image. */ Image = 2, } /** * Specifies how HTML <p> elements are rendered when loading HTML. */ export enum HtmlParagraphLayoutMode { /** * Treat <p> inside <td> as inline content in a single cell. */ Normal = 0, /** * Starts a new row for each <p> element. */ AsRow = 1, } /** * Represents the layout mode for HTML rendering. */ export enum HtmlLayoutMode { /** * Renders content like MS Excel. */ Normal = 0, /** * Renders content in print layout mode. */ Print = 1, } /** * Specifies how whitespace is represented in the generated HTML. */ export enum HtmlSpaceMode { /** * Use HTML character entities(such as &nbsp;, &ensp) to represent whitespace */ Character = 0, /** * Uses CSS properties such as padding to represent whitespace. */ Css = 1, } /** * Represents the embedded font type in Svg image. */ export enum SvgEmbeddedFontType { /** * Not Embed font. */ None = 0, /** * Embed WOFF font. */ Woff = 1, } /** * Options for generating Svg image. */ export class SvgImageOptions extends ImageOrPrintOptions { /** * Ctor. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ImageOrPrintOptions); /** * Gets or sets the format of the generated images. * default value: PNG. */ getImageType() : ImageType; /** * Gets or sets the format of the generated images. * default value: PNG. * @param value - The value to set. */ setImageType(value: ImageType) : void; /** * @deprecated Please use the 'fitToViewPort' property instead. * if this property is true, the generated svg will fit to view port. */ getFitToViewPort() : boolean; /** * if this property is true, the generated svg will fit to view port. */ fitToViewPort : boolean; /** * @deprecated Please use the 'fitToViewPort' property instead. * if this property is true, the generated svg will fit to view port. * @param value - The value to set. */ setFitToViewPort(value: boolean) : void; /** * @deprecated Please use the 'cssPrefix' property instead. * Gets and sets the prefix of the css name in svg,the default value is empty string. */ getCssPrefix() : string; /** * Gets and sets the prefix of the css name in svg,the default value is empty string. */ cssPrefix : string; /** * @deprecated Please use the 'cssPrefix' property instead. * Gets and sets the prefix of the css name in svg,the default value is empty string. * @param value - The value to set. */ setCssPrefix(value: string) : void; /** * @deprecated Please use the 'embeddedFontType' property instead. * Gets or sets the type of font that embedded in Svg. * * @remarks * Default value is which indicates that it will not embed font in Svg. */ getEmbeddedFontType() : SvgEmbeddedFontType; /** * Gets or sets the type of font that embedded in Svg. * * @remarks * Default value is which indicates that it will not embed font in Svg. */ embeddedFontType : SvgEmbeddedFontType; /** * @deprecated Please use the 'embeddedFontType' property instead. * Gets or sets the type of font that embedded in Svg. * @param value - The value to set. * * @remarks * Default value is which indicates that it will not embed font in Svg. */ setEmbeddedFontType(value: SvgEmbeddedFontType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the value type of object */ export enum ShapePathPointValueType { /** * Specifies the type of the object is location coordinates. * The object stores the coordinate values of a point. */ Position = 0, /** * Specifies the type of the object is angle markers. * The object stores the start and end angles of the arc. */ Angle = 1, } /** * Represents data information of font file data. */ export class FontFileDataInfo { /** * @deprecated Please use the 'data' property instead. * Gets binary data of font file. */ getData() : Uint8Array; /** * Gets binary data of font file. */ readonly data : Uint8Array; /** * @deprecated Please use the 'formatType' property instead. * Gets font format type of font file. */ getFormatType() : FontFileFormatType; /** * Gets font format type of font file. */ readonly formatType : FontFileFormatType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents font format type. */ export enum FontFileFormatType { /** * Unknown font format type. */ Unknown = 0, /** * TTF font format type. */ Ttf = 1, /** * OTF font format type. */ Otf = 2, /** * TTC font format type. */ Ttc = 3, } /** * Monitor for the user to track the change of formulas during certain operations. * * @remarks * For example, while deleting/inserting range of cells, * formulas of other cells may be changed because of the shift of references. * Please note, methods in the monitor may be invoked multiple times * for one object which contains the formula. */ export abstract class AbstractFormulaChangeMonitor { /** * The event that will be triggered when the formula in a cell is changed. * @param sheetIndex - The sheet index of the changed cell * @param rowIndex - The row index of the changed cell * @param columnIndex - The column index of the changed cell */ onCellFormulaChanged(sheetIndex: number, rowIndex: number, columnIndex: number) : void; /** * The event that will be triggered when the formula of FormatCondition is changed. * @param fc - The FormatCondition object whose formula is changed */ onFormatConditionFormulaChanged(fc: FormatCondition) : void; } /** * Utility for instantiating classes of the Cells model. */ export class CellsFactory { /** * Default Constructor. */ constructor(); /** * Creates a new style. * @returns * Returns a style object. */ createStyle() : Style; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the cell value and corresponding type. */ export class CellValue { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'type' property instead. * Gets or sets the type of cell value. */ getType() : CellValueType; /** * Gets or sets the type of cell value. */ type : CellValueType; /** * @deprecated Please use the 'type' property instead. * Gets or sets the type of cell value. * @param value - The value to set. */ setType(value: CellValueType) : void; /** * @deprecated Please use the 'value' property instead. * Gets or sets the cell value. * * @remarks * The value must be of the correct type of object corresponding to the : * * * Type * Value * * * * null, any other object will be ignored * * * * double * * * * DateTime * * * * string * * * * bool * * * * error string such as "#VALUE!", "#NAME?", ... * * */ getValue() : Object; /** * Gets or sets the cell value. * * @remarks * The value must be of the correct type of object corresponding to the : * * * Type * Value * * * * null, any other object will be ignored * * * * double * * * * DateTime * * * * string * * * * bool * * * * error string such as "#VALUE!", "#NAME?", ... * * */ value : Object; /** * @deprecated Please use the 'value' property instead. * Gets or sets the cell value. * @param value - The value to set. * * @remarks * The value must be of the correct type of object corresponding to the : * * * Type * Value * * * * null, any other object will be ignored * * * * double * * * * DateTime * * * * string * * * * bool * * * * error string such as "#VALUE!", "#NAME?", ... * * */ setValue(value: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents axis bins */ export class AxisBins { /** * Indicates whether grouping data by category is enabled. */ isByCategory : boolean; /** * @deprecated Please use the 'isByCategory' property instead. * Indicates whether grouping data by category is enabled. * @param value - The value to set. */ setIsByCategory(value: boolean) : void; /** * Indicates whether the axis bins are automatic. * * @remarks * If or is called, the value will be false. */ isAutomatic : boolean; /** * @deprecated Please use the 'isAutomatic' property instead. * Indicates whether the axis bins are automatic. * @param value - The value to set. * * @remarks * If or is called, the value will be false. */ setIsAutomatic(value: boolean) : void; /** * @deprecated Please use the 'width' property instead. * Gets or sets the width of the axis bin. */ getWidth() : number; /** * Gets or sets the width of the axis bin. */ width : number; /** * @deprecated Please use the 'width' property instead. * Gets or sets the width of the axis bin. * @param value - The value to set. */ setWidth(value: number) : void; /** * @deprecated Please use the 'count' property instead. * Gets or sets the count of axis bins */ getCount() : number; /** * Gets or sets the count of axis bins */ count : number; /** * @deprecated Please use the 'count' property instead. * Gets or sets the count of axis bins * @param value - The value to set. */ setCount(value: number) : void; /** * @deprecated Please use the 'overflow' property instead. * Gets or sets the overflow of axis bins */ getOverflow() : number; /** * Gets or sets the overflow of axis bins */ overflow : number; /** * @deprecated Please use the 'overflow' property instead. * Gets or sets the overflow of axis bins * @param value - The value to set. */ setOverflow(value: number) : void; /** * @deprecated Please use the 'underflow' property instead. * Gets or sets the underflow of axis bins */ getUnderflow() : number; /** * Gets or sets the underflow of axis bins */ underflow : number; /** * @deprecated Please use the 'underflow' property instead. * Gets or sets the underflow of axis bins * @param value - The value to set. */ setUnderflow(value: number) : void; /** * Reset the overflow * * @remarks * NOTE: This method is now obsolete. * This is an internal method that does not need to be called externally to avoid causing problems. * This property will be removed 12 months later since July 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * This is an internal method. */ resetOverflow() : void; /** * Reset the underflow * * @remarks * NOTE: This method is now obsolete. * This is an internal method that does not need to be called externally to avoid causing problems. * This property will be removed 12 months later since July 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * This is an internal method. */ resetUnderflow() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for calculating a chart. */ export class ChartCalculateOptions { /** * Creates the options for calculating chart. */ constructor(); /** * @deprecated Please use the 'updateAllPoints' property instead. * Whether update all data points when performing the chart calculation. Default: False. * When you want to get the value for each data point in the chart specifically, set it to true. * If this parameter is set to True, the new data points may be generated when chart is calculated. This could make the Excel file larger. */ getUpdateAllPoints() : boolean; /** * Whether update all data points when performing the chart calculation. Default: False. * When you want to get the value for each data point in the chart specifically, set it to true. * If this parameter is set to True, the new data points may be generated when chart is calculated. This could make the Excel file larger. */ updateAllPoints : boolean; /** * @deprecated Please use the 'updateAllPoints' property instead. * Whether update all data points when performing the chart calculation. Default: False. * When you want to get the value for each data point in the chart specifically, set it to true. * If this parameter is set to True, the new data points may be generated when chart is calculated. This could make the Excel file larger. * @param value - The value to set. */ setUpdateAllPoints(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the globalization settings for a chart. */ export class ChartGlobalizationSettings { /** * Default Constructor. */ constructor(); /** * Gets the name of Series in the Chart. */ getSeriesName() : string; /** * Gets the name of Chart Title. */ getChartTitleName() : string; /** * Gets the name of increase for Legend. */ getLegendIncreaseName() : string; /** * Gets the name of Decrease for Legend. */ getLegendDecreaseName() : string; /** * Gets the name of Total for Legend. */ getLegendTotalName() : string; /** * Gets the name of Title for Axis. */ getAxisTitleName() : string; /** * Gets the name of "Other" labels for Chart. */ getOtherName() : string; /** * Gets the Name of Axis Unit. */ getAxisUnitName(type: DisplayUnitType) : string; } /** * Represents the text direction type of the chart. */ export enum ChartTextDirectionType { /** * Horizontal direction type. */ Horizontal = 0, /** * Vertical direction type. */ Vertical = 1, /** * Rotate by a ninety-degree angle. */ Rotate90 = 2, /** * Rotate 270-degree angle. */ Rotate270 = 3, /** * Stacked text. */ Stacked = 4, } /** * Represents the type of data plot by row or column. */ export enum PlotDataByType { /** * Sorted by row. */ Row = 0, /** * By column. */ Column = 1, } /** * Represents the text alignment type for the tick labels on the axis */ export enum TickLabelAlignmentType { /** * Specifies that the text is centered. */ Center = 0, /** * Specifies that the text is left-aligned. */ Left = 1, /** * Specifies that the text is right-aligned.. */ Right = 2, } /** * Represents a tick label in the chart. */ export class TickLabelItem { /** * @deprecated Please use the 'x' property instead. * X coordinates of Ticklabel item as a ratio of chart width. */ getX() : number; /** * X coordinates of Ticklabel item as a ratio of chart width. */ readonly x : number; /** * @deprecated Please use the 'y' property instead. * Y coordinates of Ticklabel item as a ratio of the chart height. */ getY() : number; /** * Y coordinates of Ticklabel item as a ratio of the chart height. */ readonly y : number; /** * @deprecated Please use the 'width' property instead. * Width of Ticklabel item as a ratio of chart width. */ getWidth() : number; /** * Width of Ticklabel item as a ratio of chart width. */ readonly width : number; /** * @deprecated Please use the 'height' property instead. * Height of Ticklabel item as a ratio of chart height. */ getHeight() : number; /** * Height of Ticklabel item as a ratio of chart height. */ readonly height : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents how to export OfficeMath to HTML. */ export enum HtmlOfficeMathOutputType { /** * Converts OfficeMath to HTML as image specified by <img> tag. */ Image = 0, /** * Converts OfficeMath to HTML using MathML. */ MathML = 1, } /** * Specifies the method used to binarize image. */ export enum ImageBinarizationMethod { /** * Specifies threshold method. */ Threshold = 0, /** * Specifies dithering using Floyd-Steinberg error diffusion method. */ FloydSteinbergDithering = 1, } /** * Represents comment title type while rendering when comment is set to display at end of sheet. */ export enum CommentTitleType { /** * Represents comment title cell. */ Cell = 0, /** * Represents comment title comment. */ Comment = 1, /** * Represents comment title note. */ Note = 2, /** * Represents comment title reply. */ Reply = 3, } /** * Font for rendering. */ export class RenderingFont { /** * Initializes a new instance of the * @param fontName - font name * @param fontSize - font size in points */ constructor(fontName: string, fontSize: number); /** * @deprecated Please use the 'name' property instead. * Gets name of the font. */ getName() : string; /** * Gets name of the font. */ readonly name : string; /** * @deprecated Please use the 'size' property instead. * Gets size of the font in points. */ getSize() : number; /** * Gets size of the font in points. */ readonly size : number; /** * @deprecated Please use the 'bold' property instead. * Gets or sets bold for the font. */ getBold() : boolean; /** * Gets or sets bold for the font. */ bold : boolean; /** * @deprecated Please use the 'bold' property instead. * Gets or sets bold for the font. * @param value - The value to set. */ setBold(value: boolean) : void; /** * @deprecated Please use the 'italic' property instead. * Gets or sets italic for the font. */ getItalic() : boolean; /** * Gets or sets italic for the font. */ italic : boolean; /** * @deprecated Please use the 'italic' property instead. * Gets or sets italic for the font. * @param value - The value to set. */ setItalic(value: boolean) : void; /** * @deprecated Please use the 'color' property instead. * Gets or sets color for the font. */ getColor() : Color; /** * Gets or sets color for the font. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets or sets color for the font. * @param value - The value to set. */ setColor(value: Color) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Watermark for rendering. */ export class RenderingWatermark { /** * Creates instance of image watermark. * @param imageData - */ constructor(imageData: Uint8Array); /** * Creates instance of text watermark. * @param text - watermark text * @param renderingFont - watermark font */ constructor(text: string, renderingFont: RenderingFont); /** * @deprecated Please use the 'rotation' property instead. * Gets or sets roation of the watermark in degrees. */ getRotation() : number; /** * Gets or sets roation of the watermark in degrees. */ rotation : number; /** * @deprecated Please use the 'rotation' property instead. * Gets or sets roation of the watermark in degrees. * @param value - The value to set. */ setRotation(value: number) : void; /** * @deprecated Please use the 'scaleToPagePercent' property instead. * Gets or sets scale relative to target page in percent. */ getScaleToPagePercent() : number; /** * Gets or sets scale relative to target page in percent. */ scaleToPagePercent : number; /** * @deprecated Please use the 'scaleToPagePercent' property instead. * Gets or sets scale relative to target page in percent. * @param value - The value to set. */ setScaleToPagePercent(value: number) : void; /** * @deprecated Please use the 'opacity' property instead. * Gets or sets opacity of the watermark in range [0, 1]. */ getOpacity() : number; /** * Gets or sets opacity of the watermark in range [0, 1]. */ opacity : number; /** * @deprecated Please use the 'opacity' property instead. * Gets or sets opacity of the watermark in range [0, 1]. * @param value - The value to set. */ setOpacity(value: number) : void; /** * Indicates whether the watermark is placed behind page contents. */ isBackground : boolean; /** * @deprecated Please use the 'isBackground' property instead. * Indicates whether the watermark is placed behind page contents. * @param value - The value to set. */ setIsBackground(value: boolean) : void; /** * @deprecated Please use the 'text' property instead. * Gets text of the watermark. */ getText() : string; /** * Gets text of the watermark. */ readonly text : string; /** * @deprecated Please use the 'font' property instead. * Gets font of the watermark. */ getFont() : RenderingFont; /** * Gets font of the watermark. */ readonly font : RenderingFont; /** * @deprecated Please use the 'image' property instead. * Gets image of the watermark. */ getImage() : Uint8Array; /** * Gets image of the watermark. */ readonly image : Uint8Array; /** * @deprecated Please use the 'hAlignment' property instead. * Gets or sets horizontal alignment of the watermark to the page. * * @remarks * Only Left, Center, Right is valid. Default is Left. */ getHAlignment() : TextAlignmentType; /** * Gets or sets horizontal alignment of the watermark to the page. * * @remarks * Only Left, Center, Right is valid. Default is Left. */ hAlignment : TextAlignmentType; /** * @deprecated Please use the 'hAlignment' property instead. * Gets or sets horizontal alignment of the watermark to the page. * @param value - The value to set. * * @remarks * Only Left, Center, Right is valid. Default is Left. */ setHAlignment(value: TextAlignmentType) : void; /** * @deprecated Please use the 'vAlignment' property instead. * Gets or sets vertical alignment of the watermark to the page. * * @remarks * Only Top, Center, Bottom is valid. Default is Top. */ getVAlignment() : TextAlignmentType; /** * Gets or sets vertical alignment of the watermark to the page. * * @remarks * Only Top, Center, Bottom is valid. Default is Top. */ vAlignment : TextAlignmentType; /** * @deprecated Please use the 'vAlignment' property instead. * Gets or sets vertical alignment of the watermark to the page. * @param value - The value to set. * * @remarks * Only Top, Center, Bottom is valid. Default is Top. */ setVAlignment(value: TextAlignmentType) : void; /** * @deprecated Please use the 'offsetX' property instead. * Gets or sets offset value to */ getOffsetX() : number; /** * Gets or sets offset value to */ offsetX : number; /** * @deprecated Please use the 'offsetX' property instead. * Gets or sets offset value to * @param value - The value to set. */ setOffsetX(value: number) : void; /** * @deprecated Please use the 'offsetY' property instead. * Gets or sets offset value to */ getOffsetY() : number; /** * Gets or sets offset value to */ offsetY : number; /** * @deprecated Please use the 'offsetY' property instead. * Gets or sets offset value to * @param value - The value to set. */ setOffsetY(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describes a set of sheets. */ export class SheetSet { /** * Creates a sheet set based on exact sheet indexes. * @param sheetIndexes - zero based sheet indexes. * * @remarks * If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering. */ constructor(sheetIndexes: number[]); /** * Creates a sheet set based on exact sheet names. * @param sheetNames - sheet names. * * @remarks * If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering. */ constructor(sheetNames: string[]); /** * @deprecated Please use the 'active' property instead. * Gets a set with active sheet of the workbook. */ static getActive() : SheetSet; /** * Gets a set with active sheet of the workbook. */ static readonly active : SheetSet; /** * @deprecated Please use the 'visible' property instead. * Gets a set with visible sheets of the workbook in their original order. */ static getVisible() : SheetSet; /** * Gets a set with visible sheets of the workbook in their original order. */ static readonly visible : SheetSet; /** * @deprecated Please use the 'all' property instead. * Gets a set with all sheets of the workbook in their original order. */ static getAll() : SheetSet; /** * Gets a set with all sheets of the workbook in their original order. */ static readonly all : SheetSet; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents which kind of rows should be ajusted. * * @remarks */ export enum AdjustFontSizeForRowType { /** * No adjsut. */ None = 0, /** * If the row is empty, change font size to fit row height. */ EmptyRows = 1, } /** * Represents the type when exporting to slides. */ export enum SlideViewType { /** * Exporting as view in MS Excel. */ View = 0, /** * Exporting as printing. */ Print = 1, } /** * Represents the setting of deleting blank cells/rows/columns. */ export class DeleteBlankOptions extends DeleteOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: DeleteOptions); /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'emptyStringAsBlank' property instead. * Indicates whether one cell will be taken as blank when its value is an empty string. * Default value is true. */ getEmptyStringAsBlank() : boolean; /** * Indicates whether one cell will be taken as blank when its value is an empty string. * Default value is true. */ emptyStringAsBlank : boolean; /** * @deprecated Please use the 'emptyStringAsBlank' property instead. * Indicates whether one cell will be taken as blank when its value is an empty string. * Default value is true. * @param value - The value to set. */ setEmptyStringAsBlank(value: boolean) : void; /** * @deprecated Please use the 'emptyFormulaValueAsBlank' property instead. * Whether one cell will be taken as blank when it is a formula and the calculated result is null or empty string. * Default value is false. * * @remarks * Generally user should make sure the formulas have been calculated before deleting operation with this property as true. * Otherwise all newly cretaed formulas by normal apis such as will be taken as blank and may be deleted * because before calculation their calculated results are all null. */ getEmptyFormulaValueAsBlank() : boolean; /** * Whether one cell will be taken as blank when it is a formula and the calculated result is null or empty string. * Default value is false. * * @remarks * Generally user should make sure the formulas have been calculated before deleting operation with this property as true. * Otherwise all newly cretaed formulas by normal apis such as will be taken as blank and may be deleted * because before calculation their calculated results are all null. */ emptyFormulaValueAsBlank : boolean; /** * @deprecated Please use the 'emptyFormulaValueAsBlank' property instead. * Whether one cell will be taken as blank when it is a formula and the calculated result is null or empty string. * Default value is false. * @param value - The value to set. * * @remarks * Generally user should make sure the formulas have been calculated before deleting operation with this property as true. * Otherwise all newly cretaed formulas by normal apis such as will be taken as blank and may be deleted * because before calculation their calculated results are all null. */ setEmptyFormulaValueAsBlank(value: boolean) : void; /** * @deprecated Please use the 'drawingsAsBlank' property instead. * Indicates whether drawing related objects such as picture, shape, chart... will be taken as blank. * Default value is true. * * @remarks * When setting this property as false, * all rows/columns covered by drawing objects will not be taken as blank and will not be deleted. */ getDrawingsAsBlank() : boolean; /** * Indicates whether drawing related objects such as picture, shape, chart... will be taken as blank. * Default value is true. * * @remarks * When setting this property as false, * all rows/columns covered by drawing objects will not be taken as blank and will not be deleted. */ drawingsAsBlank : boolean; /** * @deprecated Please use the 'drawingsAsBlank' property instead. * Indicates whether drawing related objects such as picture, shape, chart... will be taken as blank. * Default value is true. * @param value - The value to set. * * @remarks * When setting this property as false, * all rows/columns covered by drawing objects will not be taken as blank and will not be deleted. */ setDrawingsAsBlank(value: boolean) : void; /** * @deprecated Please use the 'mergedCellsShrinkType' property instead. * Indicates how to process merged cells when deleting blank rows/columns. * * @remarks * For , all cells in it will be taken as blank except the non-blank top-left cell. It is the default value of this property.

* For , all cells in it will be taken as non-blank.

* For , all cells outside the content display area will be taken as blank.

*/ getMergedCellsShrinkType() : MergedCellsShrinkType; /** * Indicates how to process merged cells when deleting blank rows/columns. * * @remarks * For , all cells in it will be taken as blank except the non-blank top-left cell. It is the default value of this property.

* For , all cells in it will be taken as non-blank.

* For , all cells outside the content display area will be taken as blank.

*/ mergedCellsShrinkType : MergedCellsShrinkType; /** * @deprecated Please use the 'mergedCellsShrinkType' property instead. * Indicates how to process merged cells when deleting blank rows/columns. * @param value - The value to set. * * @remarks * For , all cells in it will be taken as blank except the non-blank top-left cell. It is the default value of this property.

* For , all cells in it will be taken as non-blank.

* For , all cells outside the content display area will be taken as blank.

*/ setMergedCellsShrinkType(value: MergedCellsShrinkType) : void; /** * @deprecated Please use the 'startIndex' property instead. * Specifies the start row/column index of the range to check and delete blank row/column. */ getStartIndex() : number; /** * Specifies the start row/column index of the range to check and delete blank row/column. */ startIndex : number; /** * @deprecated Please use the 'startIndex' property instead. * Specifies the start row/column index of the range to check and delete blank row/column. * @param value - The value to set. */ setStartIndex(value: number) : void; /** * @deprecated Please use the 'endIndex' property instead. * Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns. * Default value is -1 and -1 means the maximum range of all objects(cells, drawings, ...) that need to be checked. */ getEndIndex() : number; /** * Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns. * Default value is -1 and -1 means the maximum range of all objects(cells, drawings, ...) that need to be checked. */ endIndex : number; /** * @deprecated Please use the 'endIndex' property instead. * Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns. * Default value is -1 and -1 means the maximum range of all objects(cells, drawings, ...) that need to be checked. * @param value - The value to set. */ setEndIndex(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the strategy to shrink merged cells for operations such as deleting blank rows/columns. */ export enum MergedCellsShrinkType { /** * Leaves the merged cells as it is without any modification. */ None = 0, /** * Shrinks the merged area if needed, by removing rows from the bottom or columns from the right, * while ensuring all content remains visible. */ ShrinkToFit = 1, /** * Only keeps the header rows/columns of the merged area when the top-left cell of the merged area is not blank. */ KeepHeaderOnly = 2, } /** * Represents the data model. */ export class DataModel { /** * @deprecated Please use the 'relationships' property instead. * Gets all relationships of the tables in the data model. */ getRelationships() : DataModelRelationshipCollection; /** * Gets all relationships of the tables in the data model. */ readonly relationships : DataModelRelationshipCollection; /** * @deprecated Please use the 'tables' property instead. * Gets all tables in the data model. */ getTables() : DataModelTableCollection; /** * Gets all tables in the data model. */ readonly tables : DataModelTableCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a single relationship in the spreadsheet data model. */ export class DataModelRelationship { /** * @deprecated Please use the 'foreignKeyTable' property instead. * Gets the name of the foreign key table for this relationship. */ getForeignKeyTable() : string; /** * Gets the name of the foreign key table for this relationship. */ readonly foreignKeyTable : string; /** * @deprecated Please use the 'primaryKeyTable' property instead. * Gets the name of the primary key table for this relationship. */ getPrimaryKeyTable() : string; /** * Gets the name of the primary key table for this relationship. */ readonly primaryKeyTable : string; /** * @deprecated Please use the 'foreignKeyColumn' property instead. * Gets the name of the foreign key table column for this relationship. */ getForeignKeyColumn() : string; /** * Gets the name of the foreign key table column for this relationship. */ readonly foreignKeyColumn : string; /** * @deprecated Please use the 'primaryKeyColumn' property instead. * Gets the name of the primary key table column for this relationship. */ getPrimaryKeyColumn() : string; /** * Gets the name of the primary key table column for this relationship. */ readonly primaryKeyColumn : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the relationships. */ export class DataModelRelationshipCollection implements Iterable { /** * Gets the relationship. * @param index - The index. */ get(index: number) : DataModelRelationship; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents properties of a single table in spreadsheet data model. */ export class DataModelTable { /** * @deprecated Please use the 'id' property instead. * Gets the id of the data model table. */ getId() : string; /** * Gets the id of the data model table. */ readonly id : string; /** * @deprecated Please use the 'name' property instead. * Gets the name of the data model table. */ getName() : string; /** * Gets the name of the data model table. */ readonly name : string; /** * @deprecated Please use the 'connectionName' property instead. * Gets the connection name of the data model table. */ getConnectionName() : string; /** * Gets the connection name of the data model table. */ readonly connectionName : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of the data model table. */ export class DataModelTableCollection implements Iterable { /** * Gets the data model table by position of the collection. * @param index - The position of the collection. */ get(index: number) : DataModelTable; /** * Gets the data model table by the name. * @param name - The name of data model table. */ get(name: string) : DataModelTable; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the preset theme gradient type. */ export enum PresetThemeGradientType { /** * Light gradient */ LightGradient = 0, /** * Top spotlight */ TopSpotlight = 1, /** * Medium gradient */ MediumGradient = 2, /** * Bottom spotlight */ BottomSpotlight = 3, /** * Radial gradient */ RadialGradient = 4, } /** * Represents the shape guide. */ export class BaseShapeGuide { /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * just for vml * Encapsulates a shape guide specifies the presence of a shape * guide that will be used to govern the geometry of the specified shape */ export class VmlShapeGuide extends BaseShapeGuide { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BaseShapeGuide); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the signature type. */ export enum SignatureType { /** * The default value , the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. */ Default = 0, /** * The corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. */ Stamp = 1, /** * The corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. */ Custom = 3, } /** * Type of combining characters. */ export enum EquationCombiningCharacterType { /** * Use unknown type when not found in existing type. */ Unknown = -1, /** * "̇" Unicode: u0307 * Combining Dot Above */ DotAbove = 0, /** * "̈" Unicode: u0308 * Combining Diaeresis */ Diaeresis = 1, /** * "⃛" Unicode: u20db * Combining Three Dots Above */ ThreeDotsAbove = 2, /** * "̂" Unicode: u0302 * Combining Circumflex Accent */ CircumflexAccent = 3, /** * "̌" Unicode: u030c * Combining Caron */ Caron = 4, /** * "́" Unicode: u0301 * Combining Acute Accent */ AcuteAccent = 5, /** * "̀" Unicode: u0300 * Combining Grave Accent */ GraveAccent = 6, /** * "̆" Unicode: u0306 * Combining Combining Breve */ Breve = 7, /** * "̃" Unicode: u0303 * Combining Tilde */ Tilde = 8, /** * "̅" Unicode: u0305 * Combining Overline */ Overline = 9, /** * "̿" Unicode: u033f * Combining Double Overline */ DoubleOverline = 10, /** * "⏞" Unicode: u23de * Combining Top Curly Bracket */ TopCurlyBracket = 11, /** * "⏟" Unicode: u23df * Combining Bottom Curly Bracket */ BottomCurlyBracket = 12, /** * "⃖" Unicode: u20d6 * Combining Left Arrow Above */ LeftArrowAbove = 13, /** * "⃗" Unicode: u20d7 * Combining Right Arrow Above */ RightArrowAbove = 14, /** * "⃡" Unicode: u20e1 * Combining Left Right Arrow Above */ LeftRightArrowAbove = 15, /** * "⃐" Unicode: u20d0 * Combining Left Harpoon Above */ LeftHarpoonAbove = 16, /** * "⃑" Unicode: u20d1 * Combining Right Harpoon Above */ RightHarpoonAbove = 17, /** * "←" Unicode: u2190 * Leftwards Arrow */ LeftwardsArrow = 18, /** * "→" Unicode: u2192 * Rightwards Arrow */ RightwardsArrow = 19, /** * "↔" Unicode: u2194 * Left Right Arrow */ LeftRightArrow = 20, /** * "⇐" Unicode: u21d0 * Leftwards Double Arrow */ LeftwardsDoubleArrow = 21, /** * "⇒" Unicode: u21d2 * Rightwards Double Arrow */ RightwardsDoubleArrow = 22, /** * "⇔" Unicode: u21d4 * Left Right Double Arrow */ LeftRightDoubleArrow = 23, } /** * Mathematical Operators Type */ export enum EquationMathematicalOperatorType { /** * Use unknown type when not found in existing type. */ Unknown = -1, /** * "∀" Unicode:\u2200 */ ForAll = 0, /** * "∁" Unicode:\u2201 */ Complement = 1, /** * "∂" Unicode:\u2202 */ PartialDifferential = 2, /** * "∃" Unicode:\u2203 */ Exists = 3, /** * "∄" Unicode:\u2204 */ NotExists = 4, /** * "∅" Unicode:\u2205 */ EmptySet = 5, /** * "∆" Unicode:\u2206 */ Increment = 6, /** * "∇" Unicode:\u2207 */ Nabla = 7, /** * "∈" Unicode:\u2208 */ ElementOf = 8, /** * "∉" Unicode:\u2209 */ NotAnElementOf = 9, /** * "∊" Unicode:\u220a */ SmallElementOf = 10, /** * "∋" Unicode:\u220b */ Contain = 11, /** * "∌" Unicode:\u220c */ NotContain = 12, /** * "∍" Unicode:\u220d */ SmallContain = 13, /** * "∎" Unicode:\u220e */ EndOfProof = 14, /** * "∏" Unicode:\u220f */ NaryProduct = 15, /** * "∐" Unicode:\u2210 */ NaryCoproduct = 16, /** * "∑" Unicode:\u2211 */ NarySummation = 17, /** * "∧" Unicode:\u2227 */ LogicalAnd = 18, /** * "∨" Unicode:\u2228 */ LogicalOr = 19, /** * "∩" Unicode:\u2229 */ Intersection = 20, /** * "∪" Unicode:\u222a */ Union = 21, /** * "∫" Unicode:\u222b */ Integral = 22, /** * "∬" Unicode:\u222c */ DoubleIntegral = 23, /** * "∭" Unicode:\u222d */ TripleIntegral = 24, /** * "∮" Unicode:\u222e */ ContourIntegral = 25, /** * "∯" Unicode:\u222f */ SurfaceIntegral = 26, /** * "∰" Unicode:\u2230 */ VolumeIntegral = 27, /** * "∱" Unicode:\u2231 */ Clockwise = 28, /** * "∲" Unicode:\u2232 */ ClockwiseContourIntegral = 29, /** * "∳" Unicode:\u2233 */ AnticlockwiseContourIntegral = 30, /** * "⋀" Unicode:\u22c0 */ NaryLogicalAnd = 31, /** * "⋁" Unicode:\u22c1 */ NaryLogicalOr = 32, /** * "⋂" Unicode:\u22c2 */ NaryIntersection = 33, /** * "⋃" Unicode:\u22c3 */ NaryUnion = 34, } /** * This specifies the default vertical justification of equations in the document. */ export enum EquationVerticalJustificationType { /** * top */ Top = 0, /** * center */ Center = 1, /** * bottom */ Bottom = 2, } /** * Specifies the Equation-Array function, an object consisting of one or more equations. */ export class ArrayEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the Function-Apply equation, which consists of a function name and an argument acted upon. * The types of the name and argument components are 'EquationNodeType.FunctionName' and 'EquationNodeType.Base' respectively. */ export class FunctionEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items. */ export class GroupCharacterEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'groupChr' property instead. * Specifies a symbol(default U+23DF). * It is strongly recommended to use attribute ChrType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getGroupChr() : string; /** * Specifies a symbol(default U+23DF). * It is strongly recommended to use attribute ChrType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ groupChr : string; /** * @deprecated Please use the 'groupChr' property instead. * Specifies a symbol(default U+23DF). * It is strongly recommended to use attribute ChrType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setGroupChr(value: string) : void; /** * @deprecated Please use the 'chrType' property instead. * Specify combining characters by type value. */ getChrType() : EquationCombiningCharacterType; /** * Specify combining characters by type value. */ chrType : EquationCombiningCharacterType; /** * @deprecated Please use the 'chrType' property instead. * Specify combining characters by type value. * @param value - The value to set. */ setChrType(value: EquationCombiningCharacterType) : void; /** * @deprecated Please use the 'position' property instead. * This attribute specifies the position of the character in the object */ getPosition() : EquationCharacterPositionType; /** * This attribute specifies the position of the character in the object */ position : EquationCharacterPositionType; /** * @deprecated Please use the 'position' property instead. * This attribute specifies the position of the character in the object * @param value - The value to set. */ setPosition(value: EquationCharacterPositionType) : void; /** * @deprecated Please use the 'vertJc' property instead. * This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. */ getVertJc() : EquationCharacterPositionType; /** * This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. */ vertJc : EquationCharacterPositionType; /** * @deprecated Please use the 'vertJc' property instead. * This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. * @param value - The value to set. */ setVertJc(value: EquationCharacterPositionType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the limit function. */ export class LimLowUppEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies an equation or mathematical expression. All mathematical text of equations or mathematical expressions are contained by this class. */ export class MathematicalEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the Matrix equation, consisting of one or more elements laid out in one or more rows and one or more columns. */ export class MatrixEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'baseJc' property instead. * This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification. */ getBaseJc() : EquationVerticalJustificationType; /** * This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification. */ baseJc : EquationVerticalJustificationType; /** * @deprecated Please use the 'baseJc' property instead. * This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification. * @param value - The value to set. */ setBaseJc(value: EquationVerticalJustificationType) : void; /** * This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible. */ isHidePlaceholder : boolean; /** * @deprecated Please use the 'isHidePlaceholder' property instead. * This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible. * @param value - The value to set. */ setIsHidePlaceholder(value: boolean) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the text options of the shape */ export class TextBoxOptions { /** * @deprecated Please use the 'shapeTextVerticalAlignment' property instead. * It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel. */ getShapeTextVerticalAlignment() : ShapeTextVerticalAlignmentType; /** * It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel. */ shapeTextVerticalAlignment : ShapeTextVerticalAlignmentType; /** * @deprecated Please use the 'shapeTextVerticalAlignment' property instead. * It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel. * @param value - The value to set. */ setShapeTextVerticalAlignment(value: ShapeTextVerticalAlignmentType) : void; /** * @deprecated Please use the 'resizeToFitText' property instead. * Indicates whether to resize the shape to fit the text */ getResizeToFitText() : boolean; /** * Indicates whether to resize the shape to fit the text */ resizeToFitText : boolean; /** * @deprecated Please use the 'resizeToFitText' property instead. * Indicates whether to resize the shape to fit the text * @param value - The value to set. */ setResizeToFitText(value: boolean) : void; /** * @deprecated Please use the 'shapeTextDirection' property instead. * Gets or sets the text display direction within a given text body. * It corresponds to "Format Shape - Text Options - Text Box - Text direction" in Excel */ getShapeTextDirection() : TextVerticalType; /** * Gets or sets the text display direction within a given text body. * It corresponds to "Format Shape - Text Options - Text Box - Text direction" in Excel */ shapeTextDirection : TextVerticalType; /** * @deprecated Please use the 'shapeTextDirection' property instead. * Gets or sets the text display direction within a given text body. * It corresponds to "Format Shape - Text Options - Text Box - Text direction" in Excel * @param value - The value to set. */ setShapeTextDirection(value: TextVerticalType) : void; /** * @deprecated Please use the 'leftMarginPt' property instead. * Gets and sets the left margin in unit of Points. */ getLeftMarginPt() : number; /** * Gets and sets the left margin in unit of Points. */ leftMarginPt : number; /** * @deprecated Please use the 'leftMarginPt' property instead. * Gets and sets the left margin in unit of Points. * @param value - The value to set. */ setLeftMarginPt(value: number) : void; /** * @deprecated Please use the 'rightMarginPt' property instead. * Gets and sets the right margin in unit of Points. */ getRightMarginPt() : number; /** * Gets and sets the right margin in unit of Points. */ rightMarginPt : number; /** * @deprecated Please use the 'rightMarginPt' property instead. * Gets and sets the right margin in unit of Points. * @param value - The value to set. */ setRightMarginPt(value: number) : void; /** * @deprecated Please use the 'topMarginPt' property instead. * Gets and sets the top margin in unit of Points. */ getTopMarginPt() : number; /** * Gets and sets the top margin in unit of Points. */ topMarginPt : number; /** * @deprecated Please use the 'topMarginPt' property instead. * Gets and sets the top margin in unit of Points. * @param value - The value to set. */ setTopMarginPt(value: number) : void; /** * @deprecated Please use the 'bottomMarginPt' property instead. * Returns the bottom margin in unit of Points */ getBottomMarginPt() : number; /** * Returns the bottom margin in unit of Points */ bottomMarginPt : number; /** * @deprecated Please use the 'bottomMarginPt' property instead. * Returns the bottom margin in unit of Points * @param value - The value to set. */ setBottomMarginPt(value: number) : void; /** * @deprecated Please use the 'allowTextToOverflow' property instead. * Whether allow text to overflow shape. */ getAllowTextToOverflow() : boolean; /** * Whether allow text to overflow shape. */ allowTextToOverflow : boolean; /** * @deprecated Please use the 'allowTextToOverflow' property instead. * Whether allow text to overflow shape. * @param value - The value to set. */ setAllowTextToOverflow(value: boolean) : void; /** * @deprecated Please use the 'wrapTextInShape' property instead. * Specifies text wrapping within a shape. * False - No wrapping will occur on text body. * True - Wrapping will occur on text body. */ getWrapTextInShape() : boolean; /** * Specifies text wrapping within a shape. * False - No wrapping will occur on text body. * True - Wrapping will occur on text body. */ wrapTextInShape : boolean; /** * @deprecated Please use the 'wrapTextInShape' property instead. * Specifies text wrapping within a shape. * False - No wrapping will occur on text body. * True - Wrapping will occur on text body. * @param value - The value to set. */ setWrapTextInShape(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel. */ export enum ShapeTextVerticalAlignmentType { /** */ Top = 0, /** */ Middle = 1, /** */ Bottom = 2, /** */ TopCentered = 3, /** */ MiddleCentered = 4, /** */ BottomCentered = 5, /** */ Left = 6, /** */ Center = 7, /** */ Right = 8, /** */ LeftMiddle = 9, /** */ CenterMiddle = 10, /** */ RightMiddle = 11, } /** * Represents the Timeline msodrawing object. */ export class TimelineShape extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of connection */ export enum ExternalConnectionClassType { /** * ODBC or OLE DB */ Database = 0, /** * Web query */ WebQuery = 1, /** * Based on text */ TextBased = 2, /** * Data model */ DataModel = 3, /** */ Unkown = 4, } /** * Definition of custom function for calculating with user's custom engine. */ export class CustomFunctionDefinition { /** * Default Constructor. */ constructor(); /** * Gets the indices of given custom function's parameters that need to be calculated in array mode. * @param functionName - Name of the custom function. * @returns * Indices of the parameters that need to be calculated in array mode for given custom function. * Default is null, there is no parameter which needs to be calculated in array mode for the custom function. * * @remarks * For an expression that needs to be calculated, taking A:A+B:B as an example: * Generally in value mode it will be calculated to a single value according to current cell base. * But in array mode, all values of A1+B1,A2+B2,A3+B3,... will be calculated and used for the calculation. */ getArrayModeParameters(functionName: string) : number[]; } /** * Represents the options of loading .dbf file. */ export class DbfLoadOptions extends LoadOptions { /** * The options. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of loading .dif file. */ export class DifLoadOptions extends LoadOptions { /** * The options. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents options when importing an ebook file. */ export class EbookLoadOptions extends HtmlLoadOptions { /** * Creates an option for loading the ebook file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: HtmlLoadOptions); /** * Creates an option of loading the ebook file. * @param loadFormat - The loading format */ constructor(loadFormat: LoadFormat); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the option when importing a table from HTML. */ export class HtmlTableLoadOption { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'tableIndex' property instead. * Get or set the index of table to import from html. */ getTableIndex() : number; /** * Get or set the index of table to import from html. */ tableIndex : number; /** * @deprecated Please use the 'tableIndex' property instead. * Get or set the index of table to import from html. * @param value - The value to set. */ setTableIndex(value: number) : void; /** * @deprecated Please use the 'id' property instead. * Get or set the id of table to import from html */ getId() : string; /** * Get or set the id of table to import from html */ id : string; /** * @deprecated Please use the 'id' property instead. * Get or set the id of table to import from html * @param value - The value to set. */ setId(value: string) : void; /** * @deprecated Please use the 'name' property instead. * Get or set the name of table to import from html * @deprecated * Please use HtmlTableLoadOption.Id instead */ getName() : string; /** * Get or set the name of table to import from html * @deprecated * Please use HtmlTableLoadOption.Id instead */ name : string; /** * @deprecated Please use the 'name' property instead. * Get or set the name of table to import from html * @param value - The value to set. * @deprecated * Please use HtmlTableLoadOption.Id instead */ setName(value: string) : void; /** * @deprecated Please use the 'originalSheetIndex' property instead. * Get or set the original index of worksheet in the html. */ getOriginalSheetIndex() : number; /** * Get or set the original index of worksheet in the html. */ originalSheetIndex : number; /** * @deprecated Please use the 'originalSheetIndex' property instead. * Get or set the original index of worksheet in the html. * @param value - The value to set. */ setOriginalSheetIndex(value: number) : void; /** * @deprecated Please use the 'targetSheetIndex' property instead. * Get or set the target index of worksheet where the table is to be located. */ getTargetSheetIndex() : number; /** * Get or set the target index of worksheet where the table is to be located. */ targetSheetIndex : number; /** * @deprecated Please use the 'targetSheetIndex' property instead. * Get or set the target index of worksheet where the table is to be located. * @param value - The value to set. */ setTargetSheetIndex(value: number) : void; /** * @deprecated Please use the 'tableToListObject' property instead. * Indicates whether generate list objects from imported table. * The default value is false. */ getTableToListObject() : boolean; /** * Indicates whether generate list objects from imported table. * The default value is false. */ tableToListObject : boolean; /** * @deprecated Please use the 'tableToListObject' property instead. * Indicates whether generate list objects from imported table. * The default value is false. * @param value - The value to set. */ setTableToListObject(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the table options when importing HTML. */ export class HtmlTableLoadOptionCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : HtmlTableLoadOption; /** * @deprecated Please use the 'tableToListObject' property instead. * Indicates whether generate list objects from imported tables. * The default value is false. */ getTableToListObject() : boolean; /** * Indicates whether generate list objects from imported tables. * The default value is false. */ tableToListObject : boolean; /** * @deprecated Please use the 'tableToListObject' property instead. * Indicates whether generate list objects from imported tables. * The default value is false. * @param value - The value to set. */ setTableToListObject(value: boolean) : void; /** * Adds one HtmlTableLoadOption into this collection. * @param item - one HtmlTableLoadOption * @returns * the index of the added item * * @remarks * NOTE: This member is now obsolete. Instead, * please use AddTableLoadOption() method. * This method will be removed 6 months later since December 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use HtmlTableLoadOptionCollection.AddTableLoadOption(HtmlTableLoadOption) method instead. */ add(item: HtmlTableLoadOption) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableIndex - Table index */ add(tableIndex: number) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableId - Table ID */ add(tableId: string) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableIndex - Table index * @param targetSheetIndex - The target index of worksheet in Excel */ add(tableIndex: number, targetSheetIndex: number) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableId - Table ID * @param targetSheetIndex - The target index of worksheet in Excel */ add(tableId: string, targetSheetIndex: number) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableIndex - Table index * @param targetSheetIndex - The target index of worksheet in Excel * @param originalSheetIndex - The original index of worksheet in the html */ add(tableIndex: number, targetSheetIndex: number, originalSheetIndex: number) : number; /** * Add a HtmlTableLoadOption to the list. * @param tableId - Table ID * @param targetSheetIndex - The target index of worksheet in Excel * @param originalSheetIndex - The original index of worksheet in the html */ add(tableId: string, targetSheetIndex: number, originalSheetIndex: number) : number; /** * Adds one HtmlTableLoadOption into this collection. * @param item - one HtmlTableLoadOption * @returns * the index of the added item */ addTableLoadOption(item: HtmlTableLoadOption) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specifies how hyperlinks are handled when loading HTML. */ export enum HyperlinkLoadMode { /** * Only the first hyperlink in a cell is loaded, subsequent ones are ignored. */ Normal = 0, /** * All hyperlinks in a cell are added to . * Note that MS Excel itself supports only one hyperlink per cell, * so this option may produce files that Excel cannot fully render. */ AllowMultiple = 1, } /** * Implementation to provide multiple load options for processes * that use multiple inputs(such as template files). * * @remarks * For example, feature requires * multiple template files to merge. */ export class AbstractLowCodeLoadOptionsProvider { /** * Gets the load options from which to load data of currently processed part. */ getCurrent() : LowCodeLoadOptions; /** * Checks whether there is more input. */ moveNext() : boolean; /** * Releases resources after processing currently part of input. * @param part - the load options used for currently split part. * * @remarks * By default this method just closes the stream specified by the * directly(if the load options * specified a Stream as source). * User may overwrite this method to control how to release resources * according to their requirement and the implementation of * . */ finish(part: LowCodeLoadOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation to provide protection settings */ export class AbstractLowCodeProtectionProvider { /** * Default Constructor. */ constructor(); /** * Gets the password to open spread sheet file. * @returns * Password to open spread sheet file. Empty means no protection for openning the filel. */ getOpenPassword() : string; /** * Gets the password to modify spread sheet file. * @returns * Password to modify the spread sheet file. * Empty means no protection for modifying the file. */ getWritePassword() : string; /** * Gets the password to protect the workbook with specified protection type. * @returns * Password to protect the workbook. */ getWorkbookPassword() : string; /** * Gets the protection type to protect the workbook. * @returns * Protection type to protect the workbook. * means no protection for the workbook. */ getWorkbookProtectionType() : ProtectionType; /** * Gets the password to protect the specified worksheet. * @returns * Password to protect the specified worksheet. */ getWorksheetPassword(sheetName: string) : string; /** * Gets the protection type to protect the specified worksheet. * @returns * Protection type to protect the specified worksheet. * means no protection for the worksheet. */ getWorksheetProtectionType(sheetName: string) : ProtectionType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation to provide multiple save options for processes * that require multiple outputs. For example, * feature requires multiple destinations * to save the split files. */ export class AbstractLowCodeSaveOptionsProvider { /** * Gets the save options from which to get the output settings for currently split part. * Returning null denotes to skip given part. */ getSaveOptions(part: SplitPartInfo) : LowCodeSaveOptions; /** * Releases resources after processing currently split part. * @param part - the save options used for currently split part. * * @remarks * By default this method just closes the stream specified by the * directly(if the save options * specified a Stream as destination). * User may overwrite this method to control how to release resources * according to their requirement and the implementation of * . */ finish(part: LowCodeSaveOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for conversion between html files(html or mht) and other spreadsheet file formats. */ export class HtmlConverter { /** * Converts given template file between html and other formats. * @param templateFile - The template file to be converted * @param resultFile - The resultant file */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for converting template file to images. */ export class ImageConverter { /** * Converts template file to images. * @param templateFile - The template file to be converted to images. * @param resultFile - The resultant file(name pattern) for generated images. * * @remarks * The output files will be build from the specified result file * by appending sequence number of the sheet and split part. * For example, if the specified output file is Image.png, then the generated image * files will be Image_0_0.png, Image_0_1.png, ..., Image_1_0.png, ... */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for conversion between json data structure and other spreadsheet file formats. */ export class JsonConverter { /** * Converts given template file between json and other formats. * @param templateFile - The template file to be converted * @param resultFile - The resultant file */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for saving html in low code way. */ export class LowCodeHtmlSaveOptions extends LowCodeSaveOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LowCodeSaveOptions); /** * Default Constructor. */ constructor(); /** * Gets and sets the format of spreadsheet. * * @remarks * When changing this property, * the save format specified by will be ignored(if it had been specified before). */ getSaveFormat() : SaveFormat; /** * Gets and sets the format of spreadsheet. * @param value - The value to set. * * @remarks * When changing this property, * the save format specified by will be ignored(if it had been specified before). */ setSaveFormat(value: SaveFormat) : void; /** * @deprecated Please use the 'htmlOptions' property instead. * The general options for saving html. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ getHtmlOptions() : HtmlSaveOptions; /** * The general options for saving html. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ htmlOptions : HtmlSaveOptions; /** * @deprecated Please use the 'htmlOptions' property instead. * The general options for saving html. * @param value - The value to set. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ setHtmlOptions(value: HtmlSaveOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for saving image in low code way. */ export class LowCodeImageSaveOptions extends LowCodeSaveOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LowCodeSaveOptions); /** * Default Constructor. */ constructor(); /** * Gets or sets the save format. * * @remarks * If has been specified, setting this property will also * change the value of it. */ getSaveFormat() : SaveFormat; /** * Gets or sets the save format. * @param value - The value to set. * * @remarks * If has been specified, setting this property will also * change the value of it. */ setSaveFormat(value: SaveFormat) : void; /** * @deprecated Please use the 'imageOptions' property instead. * The options for rendering images. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ getImageOptions() : ImageOrPrintOptions; /** * The options for rendering images. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ imageOptions : ImageOrPrintOptions; /** * @deprecated Please use the 'imageOptions' property instead. * The options for rendering images. * @param value - The value to set. * * @remarks * When one instance is specified, * the will be overwritten(if it had been specified before). */ setImageOptions(value: ImageOrPrintOptions) : void; /** * @deprecated Please use the 'saveOptionsProvider' property instead. * Provider of save options for saving generated images. * * @remarks * The output( or ) * specified by this instance will take no effect when this property is specified. * Instead the output of every generated image will be specified by the provider. */ getSaveOptionsProvider() : AbstractLowCodeSaveOptionsProvider; /** * Provider of save options for saving generated images. * * @remarks * The output( or ) * specified by this instance will take no effect when this property is specified. * Instead the output of every generated image will be specified by the provider. */ saveOptionsProvider : AbstractLowCodeSaveOptionsProvider; /** * @deprecated Please use the 'saveOptionsProvider' property instead. * Provider of save options for saving generated images. * @param value - The value to set. * * @remarks * The output( or ) * specified by this instance will take no effect when this property is specified. * Instead the output of every generated image will be specified by the provider. */ setSaveOptionsProvider(value: AbstractLowCodeSaveOptionsProvider) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for loading template file. */ export class LowCodeLoadOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'inputFile' property instead. * Gets and sets the file(with path if needed) of the template. * * @remarks * When setting a non-null and non-empty path to this property, * the previously set value for will be ignored. */ getInputFile() : string; /** * Gets and sets the file(with path if needed) of the template. * * @remarks * When setting a non-null and non-empty path to this property, * the previously set value for will be ignored. */ inputFile : string; /** * @deprecated Please use the 'inputFile' property instead. * Gets and sets the file(with path if needed) of the template. * @param value - The value to set. * * @remarks * When setting a non-null and non-empty path to this property, * the previously set value for will be ignored. */ setInputFile(value: string) : void; /** * @deprecated Please use the 'inputStream' property instead. * Gets and sets the Stream of the template. * * @remarks * When setting a non-null Stream to this property, * the previously set value for will be ignored. */ getInputStream() : Uint8Array; /** * Gets and sets the Stream of the template. * * @remarks * When setting a non-null Stream to this property, * the previously set value for will be ignored. */ inputStream : Uint8Array; /** * @deprecated Please use the 'inputStream' property instead. * Gets and sets the Stream of the template. * @param value - The value to set. * * @remarks * When setting a non-null Stream to this property, * the previously set value for will be ignored. */ setInputStream(value: Uint8Array) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for merging multiple template files into one. */ export class LowCodeMergeOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'saveOptions' property instead. * Save options for saving the split parts. */ getSaveOptions() : LowCodeSaveOptions; /** * Save options for saving the split parts. */ saveOptions : LowCodeSaveOptions; /** * @deprecated Please use the 'saveOptions' property instead. * Save options for saving the split parts. * @param value - The value to set. */ setSaveOptions(value: LowCodeSaveOptions) : void; /** * @deprecated Please use the 'loadOptionsProvider' property instead. * Provider of save options for saving the split parts. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ getLoadOptionsProvider() : AbstractLowCodeLoadOptionsProvider; /** * Provider of save options for saving the split parts. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ loadOptionsProvider : AbstractLowCodeLoadOptionsProvider; /** * @deprecated Please use the 'loadOptionsProvider' property instead. * Provider of save options for saving the split parts. * @param value - The value to set. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ setLoadOptionsProvider(value: AbstractLowCodeLoadOptionsProvider) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for saving pdf in low code way. */ export class LowCodePdfSaveOptions extends LowCodeSaveOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LowCodeSaveOptions); /** * Default Constructor. */ constructor(); /** * The save format for the output. * For converting to pdf, it can only be . */ getSaveFormat() : SaveFormat; /** * The save format for the output. * For converting to pdf, it can only be . * @param value - The value to set. */ setSaveFormat(value: SaveFormat) : void; /** * @deprecated Please use the 'pdfOptions' property instead. * The options for saving Pdf file. */ getPdfOptions() : PdfSaveOptions; /** * The options for saving Pdf file. */ pdfOptions : PdfSaveOptions; /** * @deprecated Please use the 'pdfOptions' property instead. * The options for saving Pdf file. * @param value - The value to set. */ setPdfOptions(value: PdfSaveOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for saving generated results in low code way. */ export class LowCodeSaveOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'outputFile' property instead. * Gets and sets the file(with path if needed) for saving the generated data. * When setting this property with value other than null or empty string, will be ignored. */ getOutputFile() : string; /** * Gets and sets the file(with path if needed) for saving the generated data. * When setting this property with value other than null or empty string, will be ignored. */ outputFile : string; /** * @deprecated Please use the 'outputFile' property instead. * Gets and sets the file(with path if needed) for saving the generated data. * When setting this property with value other than null or empty string, will be ignored. * @param value - The value to set. */ setOutputFile(value: string) : void; /** * @deprecated Please use the 'outputStream' property instead. * Gets and sets the Stream for writing the generated data to. * When setting this property with value other than null, will be ignored. */ getOutputStream() : Uint8Array; /** * Gets and sets the Stream for writing the generated data to. * When setting this property with value other than null, will be ignored. */ outputStream : Uint8Array; /** * @deprecated Please use the 'outputStream' property instead. * Gets and sets the Stream for writing the generated data to. * When setting this property with value other than null, will be ignored. * @param value - The value to set. */ setOutputStream(value: Uint8Array) : void; /** * Gets and sets the save format for the output. * Generally, for specific process in low code way, only some specific formats are allowed. * Please specify the correct format for corresponding process, otherwise unexpected result * or even exception may be caused. */ getSaveFormat() : SaveFormat; /** * Gets and sets the save format for the output. * Generally, for specific process in low code way, only some specific formats are allowed. * Please specify the correct format for corresponding process, otherwise unexpected result * or even exception may be caused. * @param value - The value to set. */ setSaveFormat(value: SaveFormat) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation to provide save options which save split parts to files * and the path of resultant file are named as(it may contains directories): * ++SheetIndex(or SheetName) * ++SplitPartIndex+. */ export class LowCodeSaveOptionsProviderOfAssembling extends AbstractLowCodeSaveOptionsProvider { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: AbstractLowCodeSaveOptionsProvider); /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'pathHeader' property instead. * Header part(before added content of sheet and split part) of file path. */ getPathHeader() : string; /** * Header part(before added content of sheet and split part) of file path. */ pathHeader : string; /** * @deprecated Please use the 'pathHeader' property instead. * Header part(before added content of sheet and split part) of file path. * @param value - The value to set. */ setPathHeader(value: string) : void; /** * @deprecated Please use the 'pathTail' property instead. * Tailing part(after sequence numbers) of file path. * It should include extension of file name. */ getPathTail() : string; /** * Tailing part(after sequence numbers) of file path. * It should include extension of file name. */ pathTail : string; /** * @deprecated Please use the 'pathTail' property instead. * Tailing part(after sequence numbers) of file path. * It should include extension of file name. * @param value - The value to set. */ setPathTail(value: string) : void; /** * @deprecated Please use the 'useSheetName' property instead. * Whether builds the file path with sheet name instead of sheet index. Default value is false. * * @remarks * The sheet name will never be rebuilt automatically. * So when set it to true, please make sure there is no special sheet name * that can cause invalid file path or name. */ getUseSheetName() : boolean; /** * Whether builds the file path with sheet name instead of sheet index. Default value is false. * * @remarks * The sheet name will never be rebuilt automatically. * So when set it to true, please make sure there is no special sheet name * that can cause invalid file path or name. */ useSheetName : boolean; /** * @deprecated Please use the 'useSheetName' property instead. * Whether builds the file path with sheet name instead of sheet index. Default value is false. * @param value - The value to set. * * @remarks * The sheet name will never be rebuilt automatically. * So when set it to true, please make sure there is no special sheet name * that can cause invalid file path or name. */ setUseSheetName(value: boolean) : void; /** * @deprecated Please use the 'sheetPrefix' property instead. * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ getSheetPrefix() : string; /** * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ sheetPrefix : string; /** * @deprecated Please use the 'sheetPrefix' property instead. * Prefix for the index of worksheet. * @param value - The value to set. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ setSheetPrefix(value: string) : void; /** * @deprecated Please use the 'splitPartPrefix' property instead. * Prefix for the index of split part. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ getSplitPartPrefix() : string; /** * Prefix for the index of split part. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ splitPartPrefix : string; /** * @deprecated Please use the 'splitPartPrefix' property instead. * Prefix for the index of split part. * @param value - The value to set. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ setSplitPartPrefix(value: string) : void; /** * @deprecated Please use the 'sheetIndexOffset' property instead. * Offset of sheet's index between what used in file path * and its actual value(). * * @remarks * Only takes effect when is false. */ getSheetIndexOffset() : number; /** * Offset of sheet's index between what used in file path * and its actual value(). * * @remarks * Only takes effect when is false. */ sheetIndexOffset : number; /** * @deprecated Please use the 'sheetIndexOffset' property instead. * Offset of sheet's index between what used in file path * and its actual value(). * @param value - The value to set. * * @remarks * Only takes effect when is false. */ setSheetIndexOffset(value: number) : void; /** * @deprecated Please use the 'splitPartIndexOffset' property instead. * Offset of split part's index between what used in file path * and its actual value(). */ getSplitPartIndexOffset() : number; /** * Offset of split part's index between what used in file path * and its actual value(). */ splitPartIndexOffset : number; /** * @deprecated Please use the 'splitPartIndexOffset' property instead. * Offset of split part's index between what used in file path * and its actual value(). * @param value - The value to set. */ setSplitPartIndexOffset(value: number) : void; /** * @deprecated Please use the 'buildPathWithSheetAlways' property instead. * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index(or name) and corresponding prefix will not be added to the file path. */ getBuildPathWithSheetAlways() : boolean; /** * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index(or name) and corresponding prefix will not be added to the file path. */ buildPathWithSheetAlways : boolean; /** * @deprecated Please use the 'buildPathWithSheetAlways' property instead. * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index(or name) and corresponding prefix will not be added to the file path. * @param value - The value to set. */ setBuildPathWithSheetAlways(value: boolean) : void; /** * @deprecated Please use the 'buildPathWithSplitPartAlways' property instead. * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix will not be added to the file path. */ getBuildPathWithSplitPartAlways() : boolean; /** * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix will not be added to the file path. */ buildPathWithSplitPartAlways : boolean; /** * @deprecated Please use the 'buildPathWithSplitPartAlways' property instead. * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix will not be added to the file path. * @param value - The value to set. */ setBuildPathWithSplitPartAlways(value: boolean) : void; /** * @deprecated Please use the 'saveOptionsTemplate' property instead. * The template for creating instance of save options in . * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ getSaveOptionsTemplate() : LowCodeSaveOptions; /** * The template for creating instance of save options in . * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ saveOptionsTemplate : LowCodeSaveOptions; /** * @deprecated Please use the 'saveOptionsTemplate' property instead. * The template for creating instance of save options in . * @param value - The value to set. * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ setSaveOptionsTemplate(value: LowCodeSaveOptions) : void; /** * Gets the save options from which to get the output settings for currently split part. */ getSaveOptions(part: SplitPartInfo) : LowCodeSaveOptions; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation to provide save options which save split parts to files * and the path of resultant file are defined with placeholders. */ export class LowCodeSaveOptionsProviderOfPlaceHolders extends AbstractLowCodeSaveOptionsProvider { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: AbstractLowCodeSaveOptionsProvider); /** * Instantiates an instance to provide save options according to specified templates. * @param pathTemplate - The template of the resultant file path. * * @remarks * The supported placeholders in file path template: *
    *
  • ${SheetIndex}: will be replaced by the sheet index of the split part
  • *
  • ${SheetName}: will be replaced by the sheet name of the split part
  • *
  • ${SplitPartIndex}: will be replaced by the index of the split part
  • *
  • ${SheetIndexPrefix}: will be replaced by
  • *
  • ${SheetNamePrefix}: will be replaced by
  • *
  • ${SplitPartPrefix}: will be replaced by
  • *
*/ constructor(pathTemplate: string); /** * @deprecated Please use the 'sheetIndexOffset' property instead. * Offset of sheet's index between what used in file path * and its actual value(). */ getSheetIndexOffset() : number; /** * Offset of sheet's index between what used in file path * and its actual value(). */ sheetIndexOffset : number; /** * @deprecated Please use the 'sheetIndexOffset' property instead. * Offset of sheet's index between what used in file path * and its actual value(). * @param value - The value to set. */ setSheetIndexOffset(value: number) : void; /** * @deprecated Please use the 'splitPartIndexOffset' property instead. * Offset of split part's index between what used in file path * and its actual value(). */ getSplitPartIndexOffset() : number; /** * Offset of split part's index between what used in file path * and its actual value(). */ splitPartIndexOffset : number; /** * @deprecated Please use the 'splitPartIndexOffset' property instead. * Offset of split part's index between what used in file path * and its actual value(). * @param value - The value to set. */ setSplitPartIndexOffset(value: number) : void; /** * @deprecated Please use the 'buildPathWithSheetAlways' property instead. * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index and name and corresponding prefix() * will not be added to the file path. */ getBuildPathWithSheetAlways() : boolean; /** * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index and name and corresponding prefix() * will not be added to the file path. */ buildPathWithSheetAlways : boolean; /** * @deprecated Please use the 'buildPathWithSheetAlways' property instead. * Whether add sheet index or name to file path always. * Default value is false, that is, when there is only one sheet, * the sheet index and name and corresponding prefix() * will not be added to the file path. * @param value - The value to set. */ setBuildPathWithSheetAlways(value: boolean) : void; /** * @deprecated Please use the 'buildPathWithSplitPartAlways' property instead. * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix() * will not be added to the file path. */ getBuildPathWithSplitPartAlways() : boolean; /** * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix() * will not be added to the file path. */ buildPathWithSplitPartAlways : boolean; /** * @deprecated Please use the 'buildPathWithSplitPartAlways' property instead. * Whether add split part index to file path always. * Default value is false, that is, when there is only one split part, * the split part index and corresponding prefix() * will not be added to the file path. * @param value - The value to set. */ setBuildPathWithSplitPartAlways(value: boolean) : void; /** * @deprecated Please use the 'sheetNamePrefix' property instead. * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ getSheetNamePrefix() : string; /** * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ sheetNamePrefix : string; /** * @deprecated Please use the 'sheetNamePrefix' property instead. * Prefix for the index of worksheet. * @param value - The value to set. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ setSheetNamePrefix(value: string) : void; /** * @deprecated Please use the 'sheetIndexPrefix' property instead. * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ getSheetIndexPrefix() : string; /** * Prefix for the index of worksheet. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ sheetIndexPrefix : string; /** * @deprecated Please use the 'sheetIndexPrefix' property instead. * Prefix for the index of worksheet. * @param value - The value to set. * * @remarks * If there is only one worksheet and is false, * then this prefix and the sheet index(or name) will not be added to the resultant file path. */ setSheetIndexPrefix(value: string) : void; /** * @deprecated Please use the 'splitPartPrefix' property instead. * Prefix for the index of split part. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ getSplitPartPrefix() : string; /** * Prefix for the index of split part. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ splitPartPrefix : string; /** * @deprecated Please use the 'splitPartPrefix' property instead. * Prefix for the index of split part. * @param value - The value to set. * * @remarks * If there is only one split part and is false, * then this prefix and the split part index(0) will not be added to the resultant file path. */ setSplitPartPrefix(value: string) : void; /** * @deprecated Please use the 'saveOptionsTemplate' property instead. * The template for creating instance of save options in . * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ getSaveOptionsTemplate() : LowCodeSaveOptions; /** * The template for creating instance of save options in . * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ saveOptionsTemplate : LowCodeSaveOptions; /** * @deprecated Please use the 'saveOptionsTemplate' property instead. * The template for creating instance of save options in . * @param value - The value to set. * * @remarks * If the template has been specified, then the created instance will copy * all setting from it and update the output file accordingly. */ setSaveOptionsTemplate(value: LowCodeSaveOptions) : void; /** * Gets the save options from which to get the output settings for currently split part. */ getSaveOptions(part: SplitPartInfo) : LowCodeSaveOptions; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Options for splitting spreadsheet. */ export class LowCodeSplitOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'loadOptions' property instead. * Load options for loading the spreadsheet that will be split. */ getLoadOptions() : LowCodeLoadOptions; /** * Load options for loading the spreadsheet that will be split. */ loadOptions : LowCodeLoadOptions; /** * @deprecated Please use the 'loadOptions' property instead. * Load options for loading the spreadsheet that will be split. * @param value - The value to set. */ setLoadOptions(value: LowCodeLoadOptions) : void; /** * @deprecated Please use the 'saveOptions' property instead. * Save options for saving the split parts. */ getSaveOptions() : LowCodeSaveOptions; /** * Save options for saving the split parts. */ saveOptions : LowCodeSaveOptions; /** * @deprecated Please use the 'saveOptions' property instead. * Save options for saving the split parts. * @param value - The value to set. */ setSaveOptions(value: LowCodeSaveOptions) : void; /** * @deprecated Please use the 'saveOptionsProvider' property instead. * Provider of save options for saving the split parts. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ getSaveOptionsProvider() : AbstractLowCodeSaveOptionsProvider; /** * Provider of save options for saving the split parts. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ saveOptionsProvider : AbstractLowCodeSaveOptionsProvider; /** * @deprecated Please use the 'saveOptionsProvider' property instead. * Provider of save options for saving the split parts. * @param value - The value to set. * * @remarks * If this property is specified, takes no effect * because the output of every split part will be specified by the provider. */ setSaveOptionsProvider(value: AbstractLowCodeSaveOptionsProvider) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for converting template file to pdf. */ export class PdfConverter { /** * Converts given template file to pdf. * @param templateFile - The template file to be converted * @param resultFile - The resultant file, it must be pdf file. */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the information of one input/output for multiple inputs/outputs, * such as current page to be rendered when converting spreadsheet to image. */ export class SplitPartInfo { /** * @deprecated Please use the 'partIndex' property instead. * Index of current part in sequence(0 based). * -1 means there are no multiple parts so the result is single. * * @remarks * If multiple sheets need to be processed and every sheet is processed(split) * separately, the part index always starts from 0 for every sheet. * For example, when converting workbook to images, * it represents the output page index of currently processed sheet. * And -1 denotes there is only one page for current sheet. */ getPartIndex() : number; /** * Index of current part in sequence(0 based). * -1 means there are no multiple parts so the result is single. * * @remarks * If multiple sheets need to be processed and every sheet is processed(split) * separately, the part index always starts from 0 for every sheet. * For example, when converting workbook to images, * it represents the output page index of currently processed sheet. * And -1 denotes there is only one page for current sheet. */ readonly partIndex : number; /** * @deprecated Please use the 'sheetIndex' property instead. * Index of the sheet where current part is in. -1 denotes there is only one sheet. */ getSheetIndex() : number; /** * Index of the sheet where current part is in. -1 denotes there is only one sheet. */ readonly sheetIndex : number; /** * @deprecated Please use the 'sheetName' property instead. * Name of the sheet where current part is in. * * @remarks * May be null for some situations, such as when rendering the whole workbook to tiff image. */ getSheetName() : string; /** * Name of the sheet where current part is in. * * @remarks * May be null for some situations, such as when rendering the whole workbook to tiff image. */ readonly sheetName : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for conversion between different spreadsheet file formats, such as xls, xlsx, xlsb, spreadsheet ml... */ export class SpreadsheetConverter { /** * Converts given template file between spreadsheet file formats. * @param templateFile - The template file to be converted * @param resultFile - The resultant file */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Low code api to lock spreadsheet file. */ export class SpreadsheetLocker { /** * Locks spreadsheet file with specified settings. * @param templateFile - The template file to be locked * @param resultFile - The resultant file * @param openPassword - Password for file encryption * @param writePassword - Password for protection of modifying spreadsheet */ static process(templateFile: string, resultFile: string, openPassword: string, writePassword: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Merges multiple template files into one. */ export class SpreadsheetMerger { /** * Merge given template files. * @param templateFiles - The template files to be merged * @param resultFile - The resultant file */ static process(templateFiles: string[], resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Splits spreadsheet file into multiple parts. */ export class SpreadsheetSplitter { /** * Splits given template file into multiple parts. * @param templateFile - The template file to be split * @param resultFile - The resultant file(name pattern) * * @remarks * The output files will be build from the specified resultant file by * appending sequence number of the sheet and split part. * For example, if the specified output file is Split.xlsx, then the generated * files will be Split_0_0.xlsx, Split_0_1.xlsx, ..., Split_1_0.xlsx, ... */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Converter for conversion between text based formats(csv, tsv, dif...) and other spreadsheet file formats. */ export class TextConverter { /** * Converts given template file between text based files and other formats. * @param templateFile - The template file to be converted * @param resultFile - The resultant file */ static process(templateFile: string, resultFile: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the header type of the table in the markdown file. */ export enum MarkdownTableHeaderType { /** * First row as header of the table. */ FirstRow = 0, /** * Column name (such as A,B,C...) as header of the table. */ ColumnHeader = 1, /** * An empty header row. */ Empty = 2, } /** * Represents the sensitivity label. */ export class SensitivityLabel { /** * @deprecated Please use the 'id' property instead. * Gets and sets the id of sensitivity label. */ getId() : string; /** * Gets and sets the id of sensitivity label. */ id : string; /** * @deprecated Please use the 'id' property instead. * Gets and sets the id of sensitivity label. * @param value - The value to set. */ setId(value: string) : void; /** * Indicates whether the sensitivity label is enabled */ isEnabled : boolean; /** * @deprecated Please use the 'isEnabled' property instead. * Indicates whether the sensitivity label is enabled * @param value - The value to set. */ setIsEnabled(value: boolean) : void; /** * @deprecated Please use the 'assignmentType' property instead. * Gets and sets the assignment method for the sensitivity label. */ getAssignmentType() : SensitivityLabelAssignmentType; /** * Gets and sets the assignment method for the sensitivity label. */ assignmentType : SensitivityLabelAssignmentType; /** * @deprecated Please use the 'assignmentType' property instead. * Gets and sets the assignment method for the sensitivity label. * @param value - The value to set. */ setAssignmentType(value: SensitivityLabelAssignmentType) : void; /** * @deprecated Please use the 'siteId' property instead. * Represents the Azure Active Directory (Azure AD) site identifier corresponding to the sensitivity label policy which describes the sensitivity label. */ getSiteId() : string; /** * Represents the Azure Active Directory (Azure AD) site identifier corresponding to the sensitivity label policy which describes the sensitivity label. */ siteId : string; /** * @deprecated Please use the 'siteId' property instead. * Represents the Azure Active Directory (Azure AD) site identifier corresponding to the sensitivity label policy which describes the sensitivity label. * @param value - The value to set. */ setSiteId(value: string) : void; /** * @deprecated Please use the 'contentMarkType' property instead. * Gets and sets the types of content marking that ought to be applied to a file. */ getContentMarkType() : SensitivityLabelMarkType; /** * Gets and sets the types of content marking that ought to be applied to a file. */ contentMarkType : SensitivityLabelMarkType; /** * @deprecated Please use the 'contentMarkType' property instead. * Gets and sets the types of content marking that ought to be applied to a file. * @param value - The value to set. */ setContentMarkType(value: SensitivityLabelMarkType) : void; /** * Indicates whether the sensitivity label was removed. */ isRemoved : boolean; /** * @deprecated Please use the 'isRemoved' property instead. * Indicates whether the sensitivity label was removed. * @param value - The value to set. */ setIsRemoved(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the assignment method for the sensitivity label. */ export enum SensitivityLabelAssignmentType { /** * Use for any sensitivity label that was not directly applied by the user. */ Standard = 0, /** * Use for any sensitivity label that was directly applied by the user. */ Privileged = 1, } /** * Represents the list of sensitivity labels. */ export class SensitivityLabelCollection { /** * Default Constructor. */ constructor(); /** * Adds a sensitivity label. * @param id - The id of the label. * @param isEnabled - Indicates whether this sensitivity label is enabled. * @param methodType - The assignment method type. * @param siteId - The id of the site. * @param markType - The mark type. */ add(id: string, isEnabled: boolean, methodType: SensitivityLabelAssignmentType, siteId: string, markType: SensitivityLabelMarkType) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the types of content marking that ought to be applied to a file. */ export enum SensitivityLabelMarkType { /** * None */ None = 0, /** * Header */ Header = 1, /** * Footer */ Footer = 2, /** * Watermark */ Watermark = 4, /** * Encryption */ Encryption = 8, } /** * Represents a list of pivot area. */ export class PivotAreaCollection implements Iterable { /** * Gets a object; */ get(index: number) : PivotArea; /** * Adds pivot area. * @param pivotArea - The pivot area. * * @remarks * NOTE: This member is now obsolete. Instead, * please use AddPivotArea() method. * This method will be removed 6 months later since December 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotAreaCollection.AddPivotArea(PivotArea) method instead. */ add(pivotArea: PivotArea) : number; /** * Adds an area based on pivot table view. * @param cellArea - The area based on pivot table view. */ add(cellArea: CellArea) : void; /** * Adds pivot area into this collection. * @param pivotArea - * @returns * index of the added pivot area in this collection */ addPivotArea(pivotArea: PivotArea) : number; /** * Remove one pivot conditional formatted area setting. * @param index - The index */ removeAt(index: number) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a PivotTable Format Condition in PivotFormatCondition Collection. */ export class PivotConditionalFormat { /** * @deprecated Please use the 'pivotAreas' property instead. * Gets all pivot areas. */ getPivotAreas() : PivotAreaCollection; /** * Gets all pivot areas. */ readonly pivotAreas : PivotAreaCollection; /** * @deprecated Please use the 'formatConditions' property instead. * Get conditions for the pivot table conditional format . */ getFormatConditions() : FormatConditionCollection; /** * Get conditions for the pivot table conditional format . */ readonly formatConditions : FormatConditionCollection; /** * @deprecated Please use the 'scopeType' property instead. * Get and set scope type for the pivot table conditional format . */ getScopeType() : PivotConditionFormatScopeType; /** * Get and set scope type for the pivot table conditional format . */ scopeType : PivotConditionFormatScopeType; /** * @deprecated Please use the 'scopeType' property instead. * Get and set scope type for the pivot table conditional format . * @param value - The value to set. */ setScopeType(value: PivotConditionFormatScopeType) : void; /** * @deprecated Please use the 'ruleType' property instead. * Get and set rule type for the pivot table condition format . */ getRuleType() : PivotConditionFormatRuleType; /** * Get and set rule type for the pivot table condition format . */ ruleType : PivotConditionFormatRuleType; /** * @deprecated Please use the 'ruleType' property instead. * Get and set rule type for the pivot table condition format . * @param value - The value to set. */ setRuleType(value: PivotConditionFormatRuleType) : void; /** * Gets all cell areas where this conditional format applies to. */ getCellAreas() : CellArea[]; /** * Adds an area based on pivot table view. * @param ca - The cell area. */ addCellArea(ca: CellArea) : void; /** * Applies the conditional format to range. * Only for the data region. * @param row - The selected row. * @param column - The selected column. * @param scope - The scope */ applyTo(row: number, column: number, scope: PivotConditionFormatScopeType) : void; /** * Adds an area of pivot field. * @param axisType - The region type. * @param fieldName - The name of pivot field. */ addFieldArea(axisType: PivotFieldType, fieldName: string) : void; /** * Adds an area of pivot field. * @param axisType - The region type. * @param field - The pivot field. */ addFieldArea(axisType: PivotFieldType, field: PivotField) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all conditional formats of pivot table. */ export class PivotConditionalFormatCollection implements Iterable { /** * Gets the pivot FormatCondition object at the specific index. * @returns * pivot FormatCondition object. */ get(index: number) : PivotConditionalFormat; /** * Adds a pivot FormatCondition to the collection. * @returns * pivot FormatCondition object index. * * @remarks * not supported */ add() : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the type of a Power Query formula item. */ export enum PowerQueryFormulaItemType { /** * Unknown or default type. */ Unknown = 0, /** * The item is a function (contains => arrow). */ Function = 1, /** * The item is a parameter. */ Parameter = 2, /** * The item is a list (starts with {). */ List = 3, /** * The item is a literal value (string, number, boolean, null). */ Literal = 4, } /** * Represents the type of power query formula. */ export enum PowerQueryFormulaType { /** * Formula power query formula. */ Formula = 0, /** * Function power query formula. */ Function = 1, /** * Parameter power query formula. */ Parameter = 2, } /** * Represents a cell value which contains an error. */ export enum ErrorCellValueType { /** * Represents the value of a cell containing a #VALUE! error. */ Value = 1, /** * Represents the value of a cell containing a #REF! error. */ Ref = 3, /** * Represents the value of a cell containing a #NAME? error. */ Name = 4, /** * Represents the value of a cell containing a #N/A error. */ NA = 6, /** * Represents the value of a cell containing a #BLOCKED! error. */ Blocked = 10, /** * Represents the value of a cell containing a #BUSY! error. */ Busy = 14, /** * Represents the value of a cell containing a #CALC! error. */ Calc = 13, /** * Represents the value of a cell containing a #CONNECT! error. */ Connect = 9, /** * Represents the value of a cell containing a #FIELD! error. */ Field = 12, /** * Represents the value of a cell containing a #SPILL! error. */ Spill = 8, /** * Represents the value of a cell containing a #UNKNOWN! error. */ Unknown = 11, /** * Represents the value of a cell containing a #TIMEOUT! error. */ TimeOut = 19, /** * Represents the value of a cell containing an #EXTERNAL! error. */ External = 18, } /** * Represents the setting for sorting pivot fields. */ export class PivotFieldSortSetting { /** * @deprecated Please use the 'sortType' property instead. * Represents the . */ getSortType() : SortOrder; /** * Represents the . */ readonly sortType : SortOrder; /** * Indicates whether to sort the field by itself or data field. */ readonly isSortByLabels : boolean; /** * @deprecated Please use the 'fieldIndex' property instead. * Represents the index of the field sorted by. * -1 means sorting the PivotField by the labels,others means sorting by the data field. */ getFieldIndex() : number; /** * Represents the index of the field sorted by. * -1 means sorting the PivotField by the labels,others means sorting by the data field. */ readonly fieldIndex : number; /** * @deprecated Please use the 'lineTypeSortedBy' property instead. * The pivot line type sorted by. * * @remarks * Only works when not sorting this field by labels. */ getLineTypeSortedBy() : PivotLineType; /** * The pivot line type sorted by. * * @remarks * Only works when not sorting this field by labels. */ readonly lineTypeSortedBy : PivotLineType; /** * Indicates whether a simple data sort operation will be applied. * * @remarks * The default value is true. */ readonly isSimpleSort : boolean; /** * @deprecated Please use the 'cell' property instead. * Sorts by the values in which row or column. */ getCell() : string; /** * Sorts by the values in which row or column. */ readonly cell : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the type of the PivotLine. */ export enum PivotLineType { /** * Regular PivotLine with pivot items. */ Regular = 0, /** * Subtotal line. */ Subtotal = 1, /** * Grand Total line. */ GrandTotal = 2, /** * Blank line after each group. */ Blank = 3, } /** * The state for refreshing pivot tables. */ export enum PivotRefreshState { /** * Successfully refreshed */ Success = 0, /** * Refresh failed because the data source is external. */ UnsupportedExternalDataSource = 1, } /** * Rerepsents the options of calculating data of the pivot table. */ export class PivotTableCalculateOption { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'refreshData' property instead. * Indicates whether refreshing data source of the pivottable. * * @remarks * If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache. */ getRefreshData() : boolean; /** * Indicates whether refreshing data source of the pivottable. * * @remarks * If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache. */ refreshData : boolean; /** * @deprecated Please use the 'refreshData' property instead. * Indicates whether refreshing data source of the pivottable. * @param value - The value to set. * * @remarks * If it is true, refresh pivot cache from data source,then calculate all pivot tables based same pivot cache. */ setRefreshData(value: boolean) : void; /** * @deprecated Please use the 'refreshCharts' property instead. * Indicates whether refreshing charts are based on this pivot table. */ getRefreshCharts() : boolean; /** * Indicates whether refreshing charts are based on this pivot table. */ refreshCharts : boolean; /** * @deprecated Please use the 'refreshCharts' property instead. * Indicates whether refreshing charts are based on this pivot table. * @param value - The value to set. */ setRefreshCharts(value: boolean) : void; /** * @deprecated Please use the 'reserveMissingPivotItemType' property instead. * Represents how to reserve missing pivot items. * * @remarks * Only works when is true. */ getReserveMissingPivotItemType() : ReserveMissingPivotItemType; /** * Represents how to reserve missing pivot items. * * @remarks * Only works when is true. */ reserveMissingPivotItemType : ReserveMissingPivotItemType; /** * @deprecated Please use the 'reserveMissingPivotItemType' property instead. * Represents how to reserve missing pivot items. * @param value - The value to set. * * @remarks * Only works when is true. */ setReserveMissingPivotItemType(value: ReserveMissingPivotItemType) : void; /** * @deprecated Please use the 'refreshOption' property instead. * Gets and set options for refreshing data source to pivot cache. */ getRefreshOption() : PivotTableRefreshOption; /** * Gets and set options for refreshing data source to pivot cache. */ refreshOption : PivotTableRefreshOption; /** * @deprecated Please use the 'refreshOption' property instead. * Gets and set options for refreshing data source to pivot cache. * @param value - The value to set. */ setRefreshOption(value: PivotTableRefreshOption) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the rich value of the cell. */ export class CellRichValue { /** * Gets the error value type of the cell. */ getErrorValue() : ErrorCellValueType; /** * Gets the image data of the cell. */ getImage() : Uint8Array; /** * Gets the alt text associated with the image. */ getAltText() : string; /** * Gets the alt text associated with the image. * @param value - The value to set. */ setAltText(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Indicates type of loading tables when some tables are in a sheet. */ export enum LoadNumbersTableType { /** */ OneTablePerSheet = 1, /** */ OverrideOtherTables = 2, /** */ TileTables = 4, } /** * Represents the options of loading Apple Numbers files. */ export class NumbersLoadOptions extends LoadOptions { /** * Constructor. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * @deprecated Please use the 'preserveTableName' property instead. * Indicates whether to preserve table names when importing from Numbers. */ getPreserveTableName() : boolean; /** * Indicates whether to preserve table names when importing from Numbers. */ preserveTableName : boolean; /** * @deprecated Please use the 'preserveTableName' property instead. * Indicates whether to preserve table names when importing from Numbers. * @param value - The value to set. */ setPreserveTableName(value: boolean) : void; /** * @deprecated Please use the 'loadTableType' property instead. * Gets and sets the type of loading multiple tables in one worksheet. */ getLoadTableType() : LoadNumbersTableType; /** * Gets and sets the type of loading multiple tables in one worksheet. */ loadTableType : LoadNumbersTableType; /** * @deprecated Please use the 'loadTableType' property instead. * Gets and sets the type of loading multiple tables in one worksheet. * @param value - The value to set. */ setLoadTableType(value: LoadNumbersTableType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Open Document Format version type. */ export enum OpenDocumentFormatVersionType { /** * None strict. * * @remarks * There are some difference between Excel and ODF. * In order to keep the data of Excel file, we can not follow the strict of ODF. */ None = 0, /** * ODF Version 1.1 */ Odf11 = 1, /** * ODF Version 1.2 */ Odf12 = 2, /** * ODF Version 1.3 */ Odf13 = 3, /** * ODF Version 1.4 */ Odf14 = 4, } /** * Represents an item of custom grouped field. */ export class CustomPiovtFieldGroupItem { /** * The constructor of custom group item of pivot field. * @param name - The name of group item * @param itemIndexes - All indexes to the items of base pivot field. */ constructor(name: string, itemIndexes: number[]); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Rrepsents the discrete group of pivot field */ export class PivotDiscreteGroupSettings extends PivotFieldGroupSettings { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PivotFieldGroupSettings); /** * Gets the group type. */ getType() : PivotFieldGroupType; /** * @deprecated Please use the 'items' property instead. * Gets the discrete items. */ getItems() : CustomPiovtFieldGroupItem[]; /** * Gets the discrete items. */ readonly items : CustomPiovtFieldGroupItem[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of filters for */ export class PivotAreaFilterCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets filter from the list by the index. * @param index - The Index */ get(index: number) : PivotAreaFilter; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Indicates the type of rule being used to describe an area or aspect of the PivotTable. */ export enum PivotAreaType { /** * No Pivot area. */ None = 0, /** * Represents a header or item. */ Normal = 1, /** * Represents something in the data area. */ Data = 2, /** * Represents the whole PivotTable. */ All = 3, /** * Represents the blank cells at the top-left of the PivotTable (top-right for RTL sheets). */ Origin = 4, /** * Represents a field button. */ Button = 5, /** * Represents the blank cells at the top-right of the PivotTable (top-left for RTL sheets). */ TopRight = 6, } /** * Specifies what can be selected in a PivotTable during a structured selection. * These constants can be combined to select multiple types. */ export enum PivotTableSelectionType { /** * Data and labels */ DataAndLabel = 0, /** * Only selects data */ DataOnly = 2, /** * Only selects labels */ LabelOnly = 1, } /** * Represents the field grouped by date time range. */ export class PivotDateTimeRangeGroupSettings extends PivotFieldGroupSettings { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PivotFieldGroupSettings); /** * Gets the data time group type. */ getType() : PivotFieldGroupType; /** * @deprecated Please use the 'start' property instead. * Gets the start date time of the group. */ getStart() : Date; /** * Gets the start date time of the group. */ readonly start : Date; /** * @deprecated Please use the 'end' property instead. * Gets the end date time of the group. */ getEnd() : Date; /** * Gets the end date time of the group. */ readonly end : Date; /** * @deprecated Please use the 'interval' property instead. * Gets the internal of the group. */ getInterval() : number; /** * Gets the internal of the group. */ readonly interval : number; /** * @deprecated Please use the 'groupByTypes' property instead. * Gets the types of grouping by date time. */ getGroupByTypes() : PivotGroupByType[]; /** * Gets the types of grouping by date time. */ readonly groupByTypes : PivotGroupByType[]; /** * Check whether the field is grouped by the type. * @param type - The group type */ isGroupedBy(type: PivotGroupByType) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the group setting of pivot field. */ export class PivotFieldGroupSettings { /** * Default Constructor. */ constructor(); /** * Gets the group type of pivot field. */ getType() : PivotFieldGroupType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the group type of pivot field. */ export enum PivotFieldGroupType { /** * No group */ None = 0, /** * Grouped by DateTime range. */ DateTimeRange = 1, /** * Grouped by numberic range. */ NumbericRange = 2, /** * Grouped by discrete points. */ Discrete = 3, } /** * Represents the position type of the pivot base item in the base field when the ShowDataAs calculation is in use. */ export enum PivotItemPositionType { /** * Represents the previous pivot item in the PivotField. */ Previous = 0, /** * Represents the next pivot item in the PivotField. */ Next = 1, /** * Shows values as the different format based the index of pivot item in the PivotField. * * @remarks * Only for getting. */ Custom = 2, } /** * Represents the numberic range group of the pivot field. */ export class PivotNumbericRangeGroupSettings extends PivotFieldGroupSettings { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PivotFieldGroupSettings); /** * Gets the group type. */ getType() : PivotFieldGroupType; /** * @deprecated Please use the 'start' property instead. * Gets the start number of the group. */ getStart() : number; /** * Gets the start number of the group. */ readonly start : number; /** * @deprecated Please use the 'end' property instead. * Gets the end number of the group. */ getEnd() : number; /** * Gets the end number of the group. */ readonly end : number; /** * @deprecated Please use the 'interval' property instead. * Gets the interval of the group. */ getInterval() : number; /** * Gets the interval of the group. */ readonly interval : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the settings about showing values as when the ShowDataAs calculation is in use. */ export class PivotShowValuesSetting { /** * @deprecated Please use the 'calculationType' property instead. * Represents how to show values of a data field in the pivot report. */ getCalculationType() : PivotFieldDataDisplayFormat; /** * Represents how to show values of a data field in the pivot report. */ calculationType : PivotFieldDataDisplayFormat; /** * @deprecated Please use the 'calculationType' property instead. * Represents how to show values of a data field in the pivot report. * @param value - The value to set. */ setCalculationType(value: PivotFieldDataDisplayFormat) : void; /** * @deprecated Please use the 'baseFieldIndex' property instead. * Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use. */ getBaseFieldIndex() : number; /** * Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use. */ baseFieldIndex : number; /** * @deprecated Please use the 'baseFieldIndex' property instead. * Represents the base field for a ShowDataAs calculation when the ShowDataAs calculation is in use. * @param value - The value to set. */ setBaseFieldIndex(value: number) : void; /** * @deprecated Please use the 'baseItemPositionType' property instead. * Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. * Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, * please set PivotField.BaseItemIndex attribute. */ getBaseItemPositionType() : PivotItemPositionType; /** * Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. * Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, * please set PivotField.BaseItemIndex attribute. */ baseItemPositionType : PivotItemPositionType; /** * @deprecated Please use the 'baseItemPositionType' property instead. * Represents type of the base pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. * Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, * please set PivotField.BaseItemIndex attribute. * @param value - The value to set. */ setBaseItemPositionType(value: PivotItemPositionType) : void; /** * @deprecated Please use the 'baseItemIndex' property instead. * Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. */ getBaseItemIndex() : number; /** * Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. */ baseItemIndex : number; /** * @deprecated Please use the 'baseItemIndex' property instead. * Represents the custom index of the pivot item in the base field when the ShowDataAs calculation is in use. * Valid only for data fields. * @param value - The value to set. */ setBaseItemIndex(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of refreshing data source of the pivot table. */ export class PivotTableRefreshOption { /** * Represents the options of refreshing data source of the pivot table. */ constructor(); /** * @deprecated Please use the 'reserveMissingPivotItemType' property instead. * Represents how to reserve missing pivot items. */ getReserveMissingPivotItemType() : ReserveMissingPivotItemType; /** * Represents how to reserve missing pivot items. */ reserveMissingPivotItemType : ReserveMissingPivotItemType; /** * @deprecated Please use the 'reserveMissingPivotItemType' property instead. * Represents how to reserve missing pivot items. * @param value - The value to set. */ setReserveMissingPivotItemType(value: ReserveMissingPivotItemType) : void; /** * Indicates whether to keep pivot items' original order as old data source. * * @remarks * Only applicable for the pivot field which is not sorted. * When refreshing such kind of pivot field, Ms Excel keeps the original order of old data source. * Default value of this property is true, representing the same behavior with Ms Excel. * If user needs the pivot field to be refreshed completely as the data in the new data source, this property should be set as false. */ isKeepOriginalOrder : boolean; /** * @deprecated Please use the 'isKeepOriginalOrder' property instead. * Indicates whether to keep pivot items' original order as old data source. * @param value - The value to set. * * @remarks * Only applicable for the pivot field which is not sorted. * When refreshing such kind of pivot field, Ms Excel keeps the original order of old data source. * Default value of this property is true, representing the same behavior with Ms Excel. * If user needs the pivot field to be refreshed completely as the data in the new data source, this property should be set as false. */ setIsKeepOriginalOrder(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents how to keep the missing pivot items. */ export enum ReserveMissingPivotItemType { /** * Removes old missing pivot items and reserves deleted items of new data source as missing items. */ Default = 0, /** * Reserves all missing items. * * @remarks * In Excel, as long as Excel is not closed, * the missing items generated from the first refresh of the pivot table will be retained, * even if you refresh repeatedly */ All = 1, /** * Removes all missing pivot items. * * @remarks * The order of old missing pivot items will be ignored. */ None = 2, } /** * Represents options of highlighting revsions or changes of shared Excel files. */ export class HighlightChangesOptions { /** * Represents options of highlighting revsions or changes of shared Excel files. * @param highlightOnScreen - Indicates whether highlighting changes on screen. * @param listOnNewSheet - Indicates whether listing changes on a new worksheet. */ constructor(highlightOnScreen: boolean, listOnNewSheet: boolean); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of saving dbf file */ export class DbfSaveOptions extends SaveOptions { /** * The options of saving .dbf file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'exportAsString' property instead. * Indicates whether exporting as string value */ getExportAsString() : boolean; /** * Indicates whether exporting as string value */ exportAsString : boolean; /** * @deprecated Please use the 'exportAsString' property instead. * Indicates whether exporting as string value * @param value - The value to set. */ setExportAsString(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for saving ebook file. */ export class EbookSaveOptions extends HtmlSaveOptions { /** * Creates options for saving ebook file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: HtmlSaveOptions); /** * Creates options for saving ebook file. * @param saveFormat - The file format. /// It should be or . */ constructor(saveFormat: SaveFormat); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Indicates the version of HTML is used when saving to Html formats. */ export enum HtmlVersion { /** * Save the document in compliance with the MS Excel exporting HTML. */ Default = 0, /** * Saves the document in compliance with the XHTML 1.0 Transitional standard. */ XHtml = 1, /** * Saves the document in compliance with the HTML 5 standard. */ Html5 = 2, } /** * Represents the merge type for an empty TD element when exporting a file to HTML. */ export enum MergeEmptyTdType { /** * Display like MS Excel. */ Default = 0, /** * Empty TD elements will not be merged when exporting file to html. * This will generate a significantly larger html file. */ None = 1, /** * Merging empty TD element forcedly when exporting file to html. * The size of html file will be reduced significantly after setting value to true. * If you want to import the html file to excel or export perfect grid lines when saving file to html, * please keep the default value. */ MergeForcely = 2, } /** * Represents the options for saving a OFD(Open Fixed-layout Document) file. */ export class OfdSaveOptions extends PaginatedSaveOptions { /** * Creates the options for saving OFD file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PaginatedSaveOptions); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for pagination. */ export class PaginatedSaveOptions extends SaveOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'defaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. */ getDefaultFont() : string; /** * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. */ defaultFont : string; /** * @deprecated Please use the 'defaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. * @param value - The value to set. */ setDefaultFont(value: string) : void; /** * @deprecated Please use the 'checkWorkbookDefaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * * @remarks * Default is true. */ getCheckWorkbookDefaultFont() : boolean; /** * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * * @remarks * Default is true. */ checkWorkbookDefaultFont : boolean; /** * @deprecated Please use the 'checkWorkbookDefaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * @param value - The value to set. * * @remarks * Default is true. */ setCheckWorkbookDefaultFont(value: boolean) : void; /** * @deprecated Please use the 'checkFontCompatibility' property instead. * Indicates whether to check font compatibility for every character in text. * @param value - The value to set. * * @remarks * The default value is true. * Disable this property may give better performance. * But when the default or specified font of text/character cannot be used to render it, * unreadable characters(such as block) maybe occur in the generated pdf. * For such situation user should keep this property as true so that * alternative font can be searched and used to render the text instead; */ setCheckFontCompatibility(value: boolean) : void; /** * @deprecated Please use the 'checkFontCompatibility' property instead. * Indicates whether to check font compatibility for every character in text. * * @remarks * The default value is true. * Disable this property may give better performance. * But when the default or specified font of text/character cannot be used to render it, * unreadable characters(such as block) maybe occur in the generated pdf. * For such situation user should keep this property as true so that * alternative font can be searched and used to render the text instead; */ getCheckFontCompatibility() : boolean; /** * Indicates whether to check font compatibility for every character in text. * * @remarks * The default value is true. * Disable this property may give better performance. * But when the default or specified font of text/character cannot be used to render it, * unreadable characters(such as block) maybe occur in the generated pdf. * For such situation user should keep this property as true so that * alternative font can be searched and used to render the text instead; */ checkFontCompatibility : boolean; /** * @deprecated Please use the 'isFontSubstitutionCharGranularity' property instead. * Indicates whether to only substitute the font of character when the cell font is not compatibility for it. * @param value - The value to set. * * @remarks * Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first. */ setIsFontSubstitutionCharGranularity(value: boolean) : void; /** * Indicates whether to only substitute the font of character when the cell font is not compatibility for it. * * @remarks * Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first. */ isFontSubstitutionCharGranularity : boolean; /** * @deprecated Please use the 'onePagePerSheet' property instead. * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ getOnePagePerSheet() : boolean; /** * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ onePagePerSheet : boolean; /** * @deprecated Please use the 'onePagePerSheet' property instead. * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. * @param value - The value to set. */ setOnePagePerSheet(value: boolean) : void; /** * @deprecated Please use the 'allColumnsInOnePagePerSheet' property instead. * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be ignored, and the other settings of pagesetup * will still take effect. */ getAllColumnsInOnePagePerSheet() : boolean; /** * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be ignored, and the other settings of pagesetup * will still take effect. */ allColumnsInOnePagePerSheet : boolean; /** * @deprecated Please use the 'allColumnsInOnePagePerSheet' property instead. * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be ignored, and the other settings of pagesetup * will still take effect. * @param value - The value to set. */ setAllColumnsInOnePagePerSheet(value: boolean) : void; /** * @deprecated Please use the 'ignoreError' property instead. * Indicates if you need to hide the error while rendering. * The error can be error in shape, image, chart rendering, etc. */ getIgnoreError() : boolean; /** * Indicates if you need to hide the error while rendering. * The error can be error in shape, image, chart rendering, etc. */ ignoreError : boolean; /** * @deprecated Please use the 'ignoreError' property instead. * Indicates if you need to hide the error while rendering. * The error can be error in shape, image, chart rendering, etc. * @param value - The value to set. */ setIgnoreError(value: boolean) : void; /** * @deprecated Please use the 'outputBlankPageWhenNothingToPrint' property instead. * Indicates whether to output a blank page when there is nothing to print. * * @remarks * Default is true. */ getOutputBlankPageWhenNothingToPrint() : boolean; /** * Indicates whether to output a blank page when there is nothing to print. * * @remarks * Default is true. */ outputBlankPageWhenNothingToPrint : boolean; /** * @deprecated Please use the 'outputBlankPageWhenNothingToPrint' property instead. * Indicates whether to output a blank page when there is nothing to print. * @param value - The value to set. * * @remarks * Default is true. */ setOutputBlankPageWhenNothingToPrint(value: boolean) : void; /** * @deprecated Please use the 'pageIndex' property instead. * Gets or sets the 0-based index of the first page to save. * @param value - The value to set. * * @remarks * Default is 0. */ setPageIndex(value: number) : void; /** * @deprecated Please use the 'pageIndex' property instead. * Gets or sets the 0-based index of the first page to save. * * @remarks * Default is 0. */ getPageIndex() : number; /** * Gets or sets the 0-based index of the first page to save. * * @remarks * Default is 0. */ pageIndex : number; /** * @deprecated Please use the 'pageCount' property instead. * Gets or sets the number of pages to save. * @param value - The value to set. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered.. */ setPageCount(value: number) : void; /** * @deprecated Please use the 'pageCount' property instead. * Gets or sets the number of pages to save. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered.. */ getPageCount() : number; /** * Gets or sets the number of pages to save. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered.. */ pageCount : number; /** * @deprecated Please use the 'printingPageType' property instead. * Indicates which pages will not be printed. * * @remarks * If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. * If you don't want these blank pages, you can use this option to omit them. */ getPrintingPageType() : PrintingPageType; /** * Indicates which pages will not be printed. * * @remarks * If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. * If you don't want these blank pages, you can use this option to omit them. */ printingPageType : PrintingPageType; /** * @deprecated Please use the 'printingPageType' property instead. * Indicates which pages will not be printed. * @param value - The value to set. * * @remarks * If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. * If you don't want these blank pages, you can use this option to omit them. */ setPrintingPageType(value: PrintingPageType) : void; /** * @deprecated Please use the 'gridlineType' property instead. * Gets or sets gridline type. * * @remarks * Default is Dotted type. */ getGridlineType() : GridlineType; /** * Gets or sets gridline type. * * @remarks * Default is Dotted type. */ gridlineType : GridlineType; /** * @deprecated Please use the 'gridlineType' property instead. * Gets or sets gridline type. * @param value - The value to set. * * @remarks * Default is Dotted type. */ setGridlineType(value: GridlineType) : void; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets or sets gridline color. * * @remarks * It will ignore the gridline color settings in the source file. */ getGridlineColor() : Color; /** * Gets or sets gridline color. * * @remarks * It will ignore the gridline color settings in the source file. */ gridlineColor : Color; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets or sets gridline color. * @param value - The value to set. * * @remarks * It will ignore the gridline color settings in the source file. */ setGridlineColor(value: Color) : void; /** * @deprecated Please use the 'textCrossType' property instead. * Gets or sets displaying text type when the text width is larger than cell width. */ getTextCrossType() : TextCrossType; /** * Gets or sets displaying text type when the text width is larger than cell width. */ textCrossType : TextCrossType; /** * @deprecated Please use the 'textCrossType' property instead. * Gets or sets displaying text type when the text width is larger than cell width. * @param value - The value to set. */ setTextCrossType(value: TextCrossType) : void; /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ getDefaultEditLanguage() : DefaultEditLanguage; /** * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ defaultEditLanguage : DefaultEditLanguage; /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * @param value - The value to set. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ setDefaultEditLanguage(value: DefaultEditLanguage) : void; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . */ getSheetSet() : SheetSet; /** * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . */ sheetSet : SheetSet; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * @param value - The value to set. */ setSheetSet(value: SheetSet) : void; /** * @deprecated Please use the 'drawObjectEventHandler' property instead. * Implements this interface to get DrawObject and Bound when rendering. */ getDrawObjectEventHandler() : DrawObjectEventHandler; /** * Implements this interface to get DrawObject and Bound when rendering. */ drawObjectEventHandler : DrawObjectEventHandler; /** * @deprecated Please use the 'drawObjectEventHandler' property instead. * Implements this interface to get DrawObject and Bound when rendering. * @param value - The value to set. */ setDrawObjectEventHandler(value: DrawObjectEventHandler) : void; /** * @deprecated Please use the 'pageSavingCallback' property instead. * Control/Indicate progress of page saving process. */ getPageSavingCallback() : IPageSavingCallback; /** * Control/Indicate progress of page saving process. */ pageSavingCallback : IPageSavingCallback; /** * @deprecated Please use the 'pageSavingCallback' property instead. * Control/Indicate progress of page saving process. * @param value - The value to set. */ setPageSavingCallback(value: IPageSavingCallback) : void; /** * @deprecated Please use the 'emfRenderSetting' property instead. * Setting for rendering Emf metafile. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. * Default value is . */ getEmfRenderSetting() : EmfRenderSetting; /** * Setting for rendering Emf metafile. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. * Default value is . */ emfRenderSetting : EmfRenderSetting; /** * @deprecated Please use the 'emfRenderSetting' property instead. * Setting for rendering Emf metafile. * @param value - The value to set. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. * Default value is . */ setEmfRenderSetting(value: EmfRenderSetting) : void; /** * @deprecated Please use the 'customRenderSettings' property instead. * Gets or sets custom settings during rendering. */ getCustomRenderSettings() : CustomRenderSettings; /** * Gets or sets custom settings during rendering. */ customRenderSettings : CustomRenderSettings; /** * @deprecated Please use the 'customRenderSettings' property instead. * Gets or sets custom settings during rendering. * @param value - The value to set. */ setCustomRenderSettings(value: CustomRenderSettings) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for saving a Pcl file. */ export class PclSaveOptions extends PaginatedSaveOptions { /** * Creates the options for saving pcl file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PaginatedSaveOptions); /** * @deprecated Please use the 'embedFont' property instead. * Indicates whether to embed font into the output Pcl file. * * @remarks * The default value is true. */ getEmbedFont() : boolean; /** * Indicates whether to embed font into the output Pcl file. * * @remarks * The default value is true. */ embedFont : boolean; /** * @deprecated Please use the 'embedFont' property instead. * Indicates whether to embed font into the output Pcl file. * @param value - The value to set. * * @remarks * The default value is true. */ setEmbedFont(value: boolean) : void; /** * Adds information about font that is already added to the printer by manufacturer. * @param fontFullName - Full name of the font (e.g. "Times New Roman Bold Italic") used in the source file. * @param fontPclName - Name of the font that will be used in the output Pcl document. * * @remarks * There are 52 fonts that are to be built in any printer according to Pcl specification. * However manufactures can add some other fonts to their devices. */ addPrinterFont(fontFullName: string, fontPclName: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents what kind of elements should be saved. */ export enum SaveElementType { /** * All data. */ All = 251658239, /** * Only charts. */ Chart = 256, } /** * Settings for the default values of workbook's style properties. */ export class DefaultStyleSettings { /** * @deprecated Please use the 'builtInPreference' property instead. * Indicates whether property for number format is preferable when the style defines both built-in number and custom pattern. * Default value is false, that means by default custom pattern will be used to format values as long as it is not empty for one style. * * @remarks * When loading workbook from existing template file, maybe both built-in number and custom pattern are defined for one style. * This property determine whether we should use the built-in number or the custom pattern when formatting values with the style. */ getBuiltInPreference() : boolean; /** * Indicates whether property for number format is preferable when the style defines both built-in number and custom pattern. * Default value is false, that means by default custom pattern will be used to format values as long as it is not empty for one style. * * @remarks * When loading workbook from existing template file, maybe both built-in number and custom pattern are defined for one style. * This property determine whether we should use the built-in number or the custom pattern when formatting values with the style. */ builtInPreference : boolean; /** * @deprecated Please use the 'builtInPreference' property instead. * Indicates whether property for number format is preferable when the style defines both built-in number and custom pattern. * Default value is false, that means by default custom pattern will be used to format values as long as it is not empty for one style. * @param value - The value to set. * * @remarks * When loading workbook from existing template file, maybe both built-in number and custom pattern are defined for one style. * This property determine whether we should use the built-in number or the custom pattern when formatting values with the style. */ setBuiltInPreference(value: boolean) : void; /** * @deprecated Please use the 'fontName' property instead. * Gets/Sets the default font name for the workbook */ getFontName() : string; /** * Gets/Sets the default font name for the workbook */ fontName : string; /** * @deprecated Please use the 'fontName' property instead. * Gets/Sets the default font name for the workbook * @param value - The value to set. */ setFontName(value: string) : void; /** * @deprecated Please use the 'fontSize' property instead. * Gets/Sets the default standard font size for the workbook. */ getFontSize() : number; /** * Gets/Sets the default standard font size for the workbook. */ fontSize : number; /** * @deprecated Please use the 'fontSize' property instead. * Gets/Sets the default standard font size for the workbook. * @param value - The value to set. */ setFontSize(value: number) : void; /** * @deprecated Please use the 'horizontalAlignment' property instead. * Gets/Sets the default value for horizontal alignment */ getHorizontalAlignment() : TextAlignmentType; /** * Gets/Sets the default value for horizontal alignment */ horizontalAlignment : TextAlignmentType; /** * @deprecated Please use the 'horizontalAlignment' property instead. * Gets/Sets the default value for horizontal alignment * @param value - The value to set. */ setHorizontalAlignment(value: TextAlignmentType) : void; /** * @deprecated Please use the 'verticalAlignment' property instead. * Gets/Sets the default value for vertical alignment */ getVerticalAlignment() : TextAlignmentType; /** * Gets/Sets the default value for vertical alignment */ verticalAlignment : TextAlignmentType; /** * @deprecated Please use the 'verticalAlignment' property instead. * Gets/Sets the default value for vertical alignment * @param value - The value to set. */ setVerticalAlignment(value: TextAlignmentType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Settings of formulas and calculation. */ export class FormulaSettings { /** * @deprecated Please use the 'calculateOnOpen' property instead. * Indicates whether the application is required to perform a full calculation when the workbook is opened. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ getCalculateOnOpen() : boolean; /** * Indicates whether the application is required to perform a full calculation when the workbook is opened. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ calculateOnOpen : boolean; /** * @deprecated Please use the 'calculateOnOpen' property instead. * Indicates whether the application is required to perform a full calculation when the workbook is opened. * @param value - The value to set. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ setCalculateOnOpen(value: boolean) : void; /** * @deprecated Please use the 'calculateOnSave' property instead. * Indicates whether to recalculate the workbook before saving the document, when in manual calculation mode. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ getCalculateOnSave() : boolean; /** * Indicates whether to recalculate the workbook before saving the document, when in manual calculation mode. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ calculateOnSave : boolean; /** * @deprecated Please use the 'calculateOnSave' property instead. * Indicates whether to recalculate the workbook before saving the document, when in manual calculation mode. * @param value - The value to set. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ setCalculateOnSave(value: boolean) : void; /** * @deprecated Please use the 'forceFullCalculation' property instead. * Indicates whether it calculates all formulas every time when a calculation is triggered. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ getForceFullCalculation() : boolean; /** * Indicates whether it calculates all formulas every time when a calculation is triggered. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ forceFullCalculation : boolean; /** * @deprecated Please use the 'forceFullCalculation' property instead. * Indicates whether it calculates all formulas every time when a calculation is triggered. * @param value - The value to set. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most users' applications, we do not calculate any formula in the workbook automatically, * no matter what value has been set for this property. */ setForceFullCalculation(value: boolean) : void; /** * @deprecated Please use the 'calculationMode' property instead. * Gets or sets the mode for workbook calculation in MS Excel. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most user's application, we do not calculate any formula in the workbook automatically, * no matter what mode has been set for this property. * If user needs to calculate formulas, please always call methods on different objects according to requirement: * , , * , ...etc. */ getCalculationMode() : CalcModeType; /** * Gets or sets the mode for workbook calculation in MS Excel. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most user's application, we do not calculate any formula in the workbook automatically, * no matter what mode has been set for this property. * If user needs to calculate formulas, please always call methods on different objects according to requirement: * , , * , ...etc. */ calculationMode : CalcModeType; /** * @deprecated Please use the 'calculationMode' property instead. * Gets or sets the mode for workbook calculation in MS Excel. * @param value - The value to set. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * For performance consideration for most user's application, we do not calculate any formula in the workbook automatically, * no matter what mode has been set for this property. * If user needs to calculate formulas, please always call methods on different objects according to requirement: * , , * , ...etc. */ setCalculationMode(value: CalcModeType) : void; /** * @deprecated Please use the 'calculationId' property instead. * Specifies the version of the calculation engine used to calculate values in the workbook. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * In the case of ms excel, if the value of this property is less than the recalculation engine identifier associated * with the application that opens the resultant file, the application will recalculate the results of all formulas * on this workbook immediately after loading the file. * For performance consideration for most users' applications, we do not calculate any formula on the workbook automatically, * no matter what value has been set for this property. */ getCalculationId() : string; /** * Specifies the version of the calculation engine used to calculate values in the workbook. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * In the case of ms excel, if the value of this property is less than the recalculation engine identifier associated * with the application that opens the resultant file, the application will recalculate the results of all formulas * on this workbook immediately after loading the file. * For performance consideration for most users' applications, we do not calculate any formula on the workbook automatically, * no matter what value has been set for this property. */ calculationId : string; /** * @deprecated Please use the 'calculationId' property instead. * Specifies the version of the calculation engine used to calculate values in the workbook. * @param value - The value to set. * * @remarks * This property is only for saving the settings to resultant spreadsheet file * so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. * In the case of ms excel, if the value of this property is less than the recalculation engine identifier associated * with the application that opens the resultant file, the application will recalculate the results of all formulas * on this workbook immediately after loading the file. * For performance consideration for most users' applications, we do not calculate any formula on the workbook automatically, * no matter what value has been set for this property. */ setCalculationId(value: string) : void; /** * @deprecated Please use the 'enableIterativeCalculation' property instead. * Indicates whether to enable iterative calculation to resolve circular references. */ getEnableIterativeCalculation() : boolean; /** * Indicates whether to enable iterative calculation to resolve circular references. */ enableIterativeCalculation : boolean; /** * @deprecated Please use the 'enableIterativeCalculation' property instead. * Indicates whether to enable iterative calculation to resolve circular references. * @param value - The value to set. */ setEnableIterativeCalculation(value: boolean) : void; /** * @deprecated Please use the 'maxIteration' property instead. * The maximum iterations to resolve a circular reference. */ getMaxIteration() : number; /** * The maximum iterations to resolve a circular reference. */ maxIteration : number; /** * @deprecated Please use the 'maxIteration' property instead. * The maximum iterations to resolve a circular reference. * @param value - The value to set. */ setMaxIteration(value: number) : void; /** * @deprecated Please use the 'maxChange' property instead. * The maximum change to resolve a circular reference. */ getMaxChange() : number; /** * The maximum change to resolve a circular reference. */ maxChange : number; /** * @deprecated Please use the 'maxChange' property instead. * The maximum change to resolve a circular reference. * @param value - The value to set. */ setMaxChange(value: number) : void; /** * @deprecated Please use the 'precisionAsDisplayed' property instead. * Indicates whether the precision of calculated result be set as they are displayed while calculating formulas. */ getPrecisionAsDisplayed() : boolean; /** * Indicates whether the precision of calculated result be set as they are displayed while calculating formulas. */ precisionAsDisplayed : boolean; /** * @deprecated Please use the 'precisionAsDisplayed' property instead. * Indicates whether the precision of calculated result be set as they are displayed while calculating formulas. * @param value - The value to set. */ setPrecisionAsDisplayed(value: boolean) : void; /** * @deprecated Please use the 'enableCalculationChain' property instead. * Indicates whether to enable calculation chain for formulas. * Default is false. * * @remarks * When there are lots of formulas in the workbook and user needs to calculate them repeatedly * with modifying only a small part of them, it may be helpful for performance to enable the calculation chain. * On the other hand, if the chain is enabled, maintaining the model of chain requires extra memory, * and it also requires a bit more cpu time for some other operations such as changing cell's value or formulas. * After changing this property from false to true, the calculation chain will be analyzed and built * at the time of first calculation for the workbook, so the required time for the first calculation * may be more than normal calculation without chain. */ getEnableCalculationChain() : boolean; /** * Indicates whether to enable calculation chain for formulas. * Default is false. * * @remarks * When there are lots of formulas in the workbook and user needs to calculate them repeatedly * with modifying only a small part of them, it may be helpful for performance to enable the calculation chain. * On the other hand, if the chain is enabled, maintaining the model of chain requires extra memory, * and it also requires a bit more cpu time for some other operations such as changing cell's value or formulas. * After changing this property from false to true, the calculation chain will be analyzed and built * at the time of first calculation for the workbook, so the required time for the first calculation * may be more than normal calculation without chain. */ enableCalculationChain : boolean; /** * @deprecated Please use the 'enableCalculationChain' property instead. * Indicates whether to enable calculation chain for formulas. * Default is false. * @param value - The value to set. * * @remarks * When there are lots of formulas in the workbook and user needs to calculate them repeatedly * with modifying only a small part of them, it may be helpful for performance to enable the calculation chain. * On the other hand, if the chain is enabled, maintaining the model of chain requires extra memory, * and it also requires a bit more cpu time for some other operations such as changing cell's value or formulas. * After changing this property from false to true, the calculation chain will be analyzed and built * at the time of first calculation for the workbook, so the required time for the first calculation * may be more than normal calculation without chain. */ setEnableCalculationChain(value: boolean) : void; /** * @deprecated Please use the 'preservePaddingSpaces' property instead. * Indicates whether to preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. * Default value is false. * * @remarks * Generally those spaces and line breaks are jsut for visual purpose, * Preserving them or not does not affect the calculated result. * For performance consideration, if there is no special requirement, * it is better not to preserve them while processing formulas. */ getPreservePaddingSpaces() : boolean; /** * Indicates whether to preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. * Default value is false. * * @remarks * Generally those spaces and line breaks are jsut for visual purpose, * Preserving them or not does not affect the calculated result. * For performance consideration, if there is no special requirement, * it is better not to preserve them while processing formulas. */ preservePaddingSpaces : boolean; /** * @deprecated Please use the 'preservePaddingSpaces' property instead. * Indicates whether to preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. * Default value is false. * @param value - The value to set. * * @remarks * Generally those spaces and line breaks are jsut for visual purpose, * Preserving them or not does not affect the calculated result. * For performance consideration, if there is no special requirement, * it is better not to preserve them while processing formulas. */ setPreservePaddingSpaces(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents pdf embedded font encoding. */ export enum PdfFontEncoding { /** * Represents use Identity-H encoding for all embedded fonts in pdf. */ Identity = 0, /** * Represents prefer to use WinAnsiEncoding for TrueType fonts with characters 32-127, * otherwise, Identity-H encoding will be used for embedded fonts in pdf. */ AnsiPrefer = 1, } /** * Represents the default edit language. */ export enum DefaultEditLanguage { /** * Represents auto detecting edit language according to the text itself. */ Auto = 0, /** * Represents English language. */ English = 1, /** * Represents Chinese, Japanese, and Korean languages. */ CJK = 2, } /** * Setting for rendering Emf metafile. */ export enum EmfRenderSetting { /** * Only rendering Emf records. */ EmfOnly = 0, /** * Prefer rendering EmfPlus records. */ EmfPlusPrefer = 1, } /** * Type of XML Advanced Electronic Signature (XAdES). */ export enum XAdESType { /** * XAdES is off. */ None = 0, /** * Basic XAdES. */ XAdES = 1, } /** * Represents the anchor type. */ export enum ShapeAnchorType { /** * Represents a two cell anchor placeholder */ TwoCellAnchor = 0, /** * Represents a one cell anchor placeholder */ OneCellAnchor = 1, } /** * Specifies the position of a particular subobject within its parent */ export enum EquationCharacterPositionType { /** * At the top of the parent object */ Top = 0, /** * At the bottom of the parent object */ Bottom = 1, } /** * Represents options when parsing formula. */ export class FormulaParseOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'localeDependent' property instead. * Whether the formula is locale formatted. Default is false. */ getLocaleDependent() : boolean; /** * Whether the formula is locale formatted. Default is false. */ localeDependent : boolean; /** * @deprecated Please use the 'localeDependent' property instead. * Whether the formula is locale formatted. Default is false. * @param value - The value to set. */ setLocaleDependent(value: boolean) : void; /** * @deprecated Please use the 'r1C1Style' property instead. * Whether the formula is R1C1 reference style. Default is false. */ getR1C1Style() : boolean; /** * Whether the formula is R1C1 reference style. Default is false. */ r1C1Style : boolean; /** * @deprecated Please use the 'r1C1Style' property instead. * Whether the formula is R1C1 reference style. Default is false. * @param value - The value to set. */ setR1C1Style(value: boolean) : void; /** * @deprecated Please use the 'checkAddIn' property instead. * Whether check addins in existing external links of current workbook for user defined function without external link. * Default is true(if user defined function matches one addin in existing external links, then take it as the addin). */ getCheckAddIn() : boolean; /** * Whether check addins in existing external links of current workbook for user defined function without external link. * Default is true(if user defined function matches one addin in existing external links, then take it as the addin). */ checkAddIn : boolean; /** * @deprecated Please use the 'checkAddIn' property instead. * Whether check addins in existing external links of current workbook for user defined function without external link. * Default is true(if user defined function matches one addin in existing external links, then take it as the addin). * @param value - The value to set. */ setCheckAddIn(value: boolean) : void; /** * @deprecated Please use the 'parse' property instead. * Whether parse given formula. Default is true. * If it is false, then given formula string will be kept as it is for the cell until user call other methods to parse them * or parsed formula data is required by other operations such as calculating formulas. */ getParse() : boolean; /** * Whether parse given formula. Default is true. * If it is false, then given formula string will be kept as it is for the cell until user call other methods to parse them * or parsed formula data is required by other operations such as calculating formulas. */ parse : boolean; /** * @deprecated Please use the 'parse' property instead. * Whether parse given formula. Default is true. * If it is false, then given formula string will be kept as it is for the cell until user call other methods to parse them * or parsed formula data is required by other operations such as calculating formulas. * @param value - The value to set. */ setParse(value: boolean) : void; /** * @deprecated Please use the 'customFunctionDefinition' property instead. * Definition for parsing custom functions. * * @remarks * For some special requirements, such as when calculating custom function in user's custom engine, * some parameters of it need to be caculated in array mode, using this property can mark those parameters * as array mode when parsing the formula. Otherwise user needs to update those custom functions later by * to get the same result. */ getCustomFunctionDefinition() : CustomFunctionDefinition; /** * Definition for parsing custom functions. * * @remarks * For some special requirements, such as when calculating custom function in user's custom engine, * some parameters of it need to be caculated in array mode, using this property can mark those parameters * as array mode when parsing the formula. Otherwise user needs to update those custom functions later by * to get the same result. */ customFunctionDefinition : CustomFunctionDefinition; /** * @deprecated Please use the 'customFunctionDefinition' property instead. * Definition for parsing custom functions. * @param value - The value to set. * * @remarks * For some special requirements, such as when calculating custom function in user's custom engine, * some parameters of it need to be caculated in array mode, using this property can mark those parameters * as array mode when parsing the formula. Otherwise user needs to update those custom functions later by * to get the same result. */ setCustomFunctionDefinition(value: CustomFunctionDefinition) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents options when importing an HTML file. */ export class HtmlLoadOptions extends AbstractTextLoadOptions { /** * Creates an options of loading the file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: AbstractTextLoadOptions); /** * Creates an options of loading the file. * @param loadFormat - The loading format. */ constructor(loadFormat: LoadFormat); /** * @deprecated Please use the 'loadFormulas' property instead. * Indicates whether importing formulas if the original html file contains formulas */ getLoadFormulas() : boolean; /** * Indicates whether importing formulas if the original html file contains formulas */ loadFormulas : boolean; /** * @deprecated Please use the 'loadFormulas' property instead. * Indicates whether importing formulas if the original html file contains formulas * @param value - The value to set. */ setLoadFormulas(value: boolean) : void; /** * @deprecated Please use the 'supportDivTag' property instead. * Indicates whether support the layout of <div> tag when the html file contains it. * The default value is false. */ getSupportDivTag() : boolean; /** * Indicates whether support the layout of <div> tag when the html file contains it. * The default value is false. */ supportDivTag : boolean; /** * @deprecated Please use the 'supportDivTag' property instead. * Indicates whether support the layout of <div> tag when the html file contains it. * The default value is false. * @param value - The value to set. */ setSupportDivTag(value: boolean) : void; /** * @deprecated Please use the 'deleteRedundantSpaces' property instead. * Indicates whether delete redundant spaces when the text wraps lines using <br> tag. * The default value is false. */ getDeleteRedundantSpaces() : boolean; /** * Indicates whether delete redundant spaces when the text wraps lines using <br> tag. * The default value is false. */ deleteRedundantSpaces : boolean; /** * @deprecated Please use the 'deleteRedundantSpaces' property instead. * Indicates whether delete redundant spaces when the text wraps lines using <br> tag. * The default value is false. * @param value - The value to set. */ setDeleteRedundantSpaces(value: boolean) : void; /** * @deprecated Please use the 'autoFitColsAndRows' property instead. * Indicates whether auto-fit columns and rows. The default value is false. */ getAutoFitColsAndRows() : boolean; /** * Indicates whether auto-fit columns and rows. The default value is false. */ autoFitColsAndRows : boolean; /** * @deprecated Please use the 'autoFitColsAndRows' property instead. * Indicates whether auto-fit columns and rows. The default value is false. * @param value - The value to set. */ setAutoFitColsAndRows(value: boolean) : void; /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". */ getHasFormula() : boolean; /** * Indicates whether the text is formula if it starts with "=". */ hasFormula : boolean; /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". * @param value - The value to set. */ setHasFormula(value: boolean) : void; /** * @deprecated Please use the 'progId' property instead. * Gets the program id of creating the file. * Only for MHT files. */ getProgId() : string; /** * Gets the program id of creating the file. * Only for MHT files. */ readonly progId : string; /** * @deprecated Please use the 'tableLoadOptions' property instead. * Get the HtmlTableLoadOptionCollection instance */ getTableLoadOptions() : HtmlTableLoadOptionCollection; /** * Get the HtmlTableLoadOptionCollection instance */ readonly tableLoadOptions : HtmlTableLoadOptionCollection; /** * @deprecated Please use the 'detectLaTeX' property instead. * Indicates whether to detect LaTeX formula in the HTML file. * The default value is false. */ getDetectLaTeX() : boolean; /** * Indicates whether to detect LaTeX formula in the HTML file. * The default value is false. */ detectLaTeX : boolean; /** * @deprecated Please use the 'detectLaTeX' property instead. * Indicates whether to detect LaTeX formula in the HTML file. * The default value is false. * @param value - The value to set. */ setDetectLaTeX(value: boolean) : void; /** * @deprecated Please use the 'paragrahLayoutMode' property instead. * Specifies how HTML <p> elements are rendered when loading HTML. * The default value is . */ getParagrahLayoutMode() : HtmlParagraphLayoutMode; /** * Specifies how HTML <p> elements are rendered when loading HTML. * The default value is . */ paragrahLayoutMode : HtmlParagraphLayoutMode; /** * @deprecated Please use the 'paragrahLayoutMode' property instead. * Specifies how HTML <p> elements are rendered when loading HTML. * The default value is . * @param value - The value to set. */ setParagrahLayoutMode(value: HtmlParagraphLayoutMode) : void; /** * @deprecated Please use the 'hyperlinkLoadMode' property instead. * Specifies how hyperlinks are loaded when loading HTML. */ getHyperlinkLoadMode() : HyperlinkLoadMode; /** * Specifies how hyperlinks are loaded when loading HTML. */ hyperlinkLoadMode : HyperlinkLoadMode; /** * @deprecated Please use the 'hyperlinkLoadMode' property instead. * Specifies how hyperlinks are loaded when loading HTML. * @param value - The value to set. */ setHyperlinkLoadMode(value: HyperlinkLoadMode) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the way are exported to PDF file. */ export enum PdfCustomPropertiesExport { /** * No custom properties are exported. */ None = 0, /** * Custom properties are exported as entries in Info dictionary. * * @remarks * Custom properties with the following names are not exported: * "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "CreationDate", "ModDate", "Trapped". */ Standard = 1, } /** * Represents the type of copying format when inserting rows. */ export enum CopyFormatType { /** * Formats same as above row. */ SameAsAbove = 0, /** * Formats same as below row. */ SameAsBelow = 1, /** * Clears formatting. */ Clear = 2, } /** * Represents the person who creates the threaded comments. */ export class ThreadedCommentAuthor { /** * @deprecated Please use the 'name' property instead. * Gets and sets the name. */ getName() : string; /** * Gets and sets the name. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'userId' property instead. * Gets and sets the id of the user. */ getUserId() : string; /** * Gets and sets the id of the user. */ userId : string; /** * @deprecated Please use the 'userId' property instead. * Gets and sets the id of the user. * @param value - The value to set. */ setUserId(value: string) : void; /** * @deprecated Please use the 'providerId' property instead. * Gets the id of the provider. */ getProviderId() : string; /** * Gets the id of the provider. */ providerId : string; /** * @deprecated Please use the 'providerId' property instead. * Gets the id of the provider. * @param value - The value to set. */ setProviderId(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all persons. */ export class ThreadedCommentAuthorCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets the person who create threaded comments. * @param index - The index */ get(index: number) : ThreadedCommentAuthor; /** * Gets the person who create threaded comments. * @param name - The name of the author. */ get(name: string) : ThreadedCommentAuthor; /** * @deprecated Please use the 'currentPerson' property instead. * Gets and sets the current user. */ getCurrentPerson() : ThreadedCommentAuthor; /** * Gets and sets the current user. */ currentPerson : ThreadedCommentAuthor; /** * @deprecated Please use the 'currentPerson' property instead. * Gets and sets the current user. * @param value - The value to set. */ setCurrentPerson(value: ThreadedCommentAuthor) : void; /** * Gets the index of ThreadedCommentAuthor object * @param author - The ThreadedCommentAuthor object * @returns * The index in the ThreadedCommentAuthor collection */ indexOf(author: ThreadedCommentAuthor) : number; /** * Adds one thread comment person. * @param name - The name of the person. * @param userId - * @param providerId - The id of the provider */ add(name: string, userId: string, providerId: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents Custom xml shape ,such as Ink. */ export class CustomXmlShape extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the threaded comment. */ export class ThreadedComment { /** * @deprecated Please use the 'row' property instead. * Gets the row index of the comment. */ getRow() : number; /** * Gets the row index of the comment. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets the column index of the comment. */ getColumn() : number; /** * Gets the column index of the comment. */ readonly column : number; /** * @deprecated Please use the 'notes' property instead. * Gets and sets the text of the comment. */ getNotes() : string; /** * Gets and sets the text of the comment. */ notes : string; /** * @deprecated Please use the 'notes' property instead. * Gets and sets the text of the comment. * @param value - The value to set. */ setNotes(value: string) : void; /** * @deprecated Please use the 'author' property instead. * Gets the author of the comment. */ getAuthor() : ThreadedCommentAuthor; /** * Gets the author of the comment. */ author : ThreadedCommentAuthor; /** * @deprecated Please use the 'author' property instead. * Gets the author of the comment. * @param value - The value to set. */ setAuthor(value: ThreadedCommentAuthor) : void; /** * @deprecated Please use the 'createdTime' property instead. * Gets and sets the created time of this threaded comment. */ getCreatedTime() : Date; /** * Gets and sets the created time of this threaded comment. */ createdTime : Date; /** * @deprecated Please use the 'createdTime' property instead. * Gets and sets the created time of this threaded comment. * @param value - The value to set. */ setCreatedTime(value: Date) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of threaded comments. */ export class ThreadedCommentCollection implements Iterable { /** * Gets the threaded comment by the specific index. * @param index - The index */ get(index: number) : ThreadedComment; /** * Adds a threaded comment. * @param text - The text of the threaded comment. * @param author - The author of the threaded comment */ add(text: string, author: ThreadedCommentAuthor) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the calculation relevant data about one cell which is being calculated. * * @remarks * All objects provided by this class are for "read" purpose only. * User should not change any data in the Workbook during the formula calculation process, * Otherwise unexpected result or Exception may be caused. */ export class CalculationCell { /** * @deprecated Please use the 'workbook' property instead. * Gets the Workbook object. */ getWorkbook() : Workbook; /** * Gets the Workbook object. */ readonly workbook : Workbook; /** * @deprecated Please use the 'worksheet' property instead. * Gets the Worksheet object where the cell is in. */ getWorksheet() : Worksheet; /** * Gets the Worksheet object where the cell is in. */ readonly worksheet : Worksheet; /** * @deprecated Please use the 'cellRow' property instead. * Gets the row index of the cell. */ getCellRow() : number; /** * Gets the row index of the cell. */ readonly cellRow : number; /** * @deprecated Please use the 'cellColumn' property instead. * Gets the column index of the cell. */ getCellColumn() : number; /** * Gets the column index of the cell. */ readonly cellColumn : number; /** * @deprecated Please use the 'cell' property instead. * Gets the Cell object which is being calculated. */ getCell() : Cell; /** * Gets the Cell object which is being calculated. */ readonly cell : Cell; /** * Sets the calculated value for the cell. * * @remarks * User can set the calculated result by this method to ignore the automatic calculation for the cell. */ setCalculatedValue(v: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents Cell Watch Item in the 'watch window'. */ export class CellWatch { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'row' property instead. * Gets and sets the row of the cell. */ getRow() : number; /** * Gets and sets the row of the cell. */ row : number; /** * @deprecated Please use the 'row' property instead. * Gets and sets the row of the cell. * @param value - The value to set. */ setRow(value: number) : void; /** * @deprecated Please use the 'column' property instead. * Gets and sets the column of the cell. */ getColumn() : number; /** * Gets and sets the column of the cell. */ column : number; /** * @deprecated Please use the 'column' property instead. * Gets and sets the column of the cell. * @param value - The value to set. */ setColumn(value: number) : void; /** * @deprecated Please use the 'cellName' property instead. * Gets and sets the name of the cell. */ getCellName() : string; /** * Gets and sets the name of the cell. */ cellName : string; /** * @deprecated Please use the 'cellName' property instead. * Gets and sets the name of the cell. * @param value - The value to set. */ setCellName(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the collection of cells on this worksheet being watched in the 'watch window'. */ export class CellWatchCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets and sets by index. * @param index - The index. */ get(index: number) : CellWatch; /** * Gets and sets by the name of the cell. * @param cellName - The name of the cell. */ get(cellName: string) : CellWatch; /** * Adds with a row and a column. * @param row - The row index. * @param column - The column index. * @returns * Returns the position of this item in the collection. */ add(row: number, column: number) : number; /** * Adds with the name of the cell. * @param cellName - The name of the cell. */ add(cellName: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Caching options for data access. Multiple options can be combined using the "|" operator. * * @remarks * For some features, accessing large dataset requires a lot of repeated and complicated operations * such as search, calculation, ...etc and those operations will take a lot of extra time. * For common situations, all dependent data remains unchanged during the access, so some caches can be built and used to * improve the access performance. * For this purpose, we provide this API so that user can specify which kind of data access needs * to be optimized by possible caching mechanism. *

* Please note, for different options, different data set may be required to be "read-only". * And performance of accessing data depends on many aspects, the use of caching mechanism * does not guarantee that performance will be improved. For some situations, * such as the dataset to be accessed is small, using cache may cause even more time because * caching itself also needs certain extra time. */ export enum AccessCacheOptions { /** * No cache for any data access. */ None = 0, /** * Apply all possible optimizations for all kinds of data access in the workbook. * All settings and data should not be changed during the optimized access. */ All = -1, /** * Apply possible optimization for getting object(such as Shape)'s position and size. * Row height and column width settings should not be changed during the optimized access. */ PositionAndSize = 3, /** * Apply possible optimization for getting cells' values. * Cells data(data and settings of Cell, Row) should not be changed during * the optimized access, no new Cell/Row objects should be created either(such as * by ). */ CellsData = 9, /** * Apply possible optimization for getting display-related results of * cells(, , , etc.). * Cells data and style-related objects(Cell/Row/Column styles, column width, etc.) should not be changed * during the optimized access. */ CellDisplay = 1048710, /** * Apply possible optimization for getting formulas. * All data and settings which may affect the formula expression(Worksheet's name, Name's text, * table's column, etc.) should not be changed during the optimized access. */ GetFormula = 2097152, /** * Apply possible optimization for setting formulas. * All data and settings which may affect the formula expression(Worksheet's name, Name's text, * table's column, etc.) should not be changed during the optimized access. */ SetFormula = 4194304, /** * Apply possible optimization for calculating formulas. * Cells data should not be changed during the optimized access, none new objects(Cell, Row, etc.) * should be created either(such as by ). */ CalculateFormula = 8388617, /** * Apply possible optimization for getting formatting result of conditional formattings. * All data and settings which may affect the result of conditional formattings(settings of * conditional formattings, dependent cell values, etc.) should not be changed during the optimized access. */ ConditionalFormatting = 16777225, /** * Apply possible optimization for getting validation result. * All data and settings which may affect the result of validation(settings of the validation, * dependent cell values, etc.) should not be changed during the optimized access. */ Validation = 33554441, } /** * Encapsulates the object that represents the frame object which contains text. */ export class ChartTextFrame extends ChartFrame { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ChartFrame); /** * Indicates the text is auto generated. */ isAutoText() : boolean; /** * Indicates the text is auto generated. * @param value - The value to set. */ setIsAutoText(value: boolean) : void; /** * Indicates whether this data label is deleted. */ isDeleted : boolean; /** * @deprecated Please use the 'isDeleted' property instead. * Indicates whether this data label is deleted. * @param value - The value to set. */ setIsDeleted(value: boolean) : void; /** * @deprecated Please use the 'textHorizontalAlignment' property instead. * Gets and sets the text horizontal alignment. */ getTextHorizontalAlignment() : TextAlignmentType; /** * Gets and sets the text horizontal alignment. */ textHorizontalAlignment : TextAlignmentType; /** * @deprecated Please use the 'textHorizontalAlignment' property instead. * Gets and sets the text horizontal alignment. * @param value - The value to set. */ setTextHorizontalAlignment(value: TextAlignmentType) : void; /** * @deprecated Please use the 'textVerticalAlignment' property instead. * Gets or sets the text vertical alignment of text. */ getTextVerticalAlignment() : TextAlignmentType; /** * Gets or sets the text vertical alignment of text. */ textVerticalAlignment : TextAlignmentType; /** * @deprecated Please use the 'textVerticalAlignment' property instead. * Gets or sets the text vertical alignment of text. * @param value - The value to set. */ setTextVerticalAlignment(value: TextAlignmentType) : void; /** * @deprecated Please use the 'rotationAngle' property instead. * Represents the text rotation angle. * * @remarks *
0: Not rotated.
*
255: Top to Bottom.
*
-90: Downward.
*
90: Upward.
*/ getRotationAngle() : number; /** * Represents the text rotation angle. * * @remarks *
0: Not rotated.
*
255: Top to Bottom.
*
-90: Downward.
*
90: Upward.
*/ rotationAngle : number; /** * @deprecated Please use the 'rotationAngle' property instead. * Represents the text rotation angle. * @param value - The value to set. * * @remarks *
0: Not rotated.
*
255: Top to Bottom.
*
-90: Downward.
*
90: Upward.
*/ setRotationAngle(value: number) : void; /** * Indicates whether the text of the chart is automatically rotated. */ readonly isAutomaticRotation : boolean; /** * Gets or sets the text of a frame's title. */ getText() : string; /** * Gets or sets the text of a frame's title. * @param value - The value to set. */ setText(value: string) : void; /** * Gets and sets a reference to the worksheet. */ getLinkedSource() : string; /** * Gets and sets a reference to the worksheet. * @param value - The value to set. */ setLinkedSource(value: string) : void; /** * @deprecated Please use the 'readingOrder' property instead. * Represents text reading order. */ getReadingOrder() : TextDirectionType; /** * Represents text reading order. */ readingOrder : TextDirectionType; /** * @deprecated Please use the 'readingOrder' property instead. * Represents text reading order. * @param value - The value to set. */ setReadingOrder(value: TextDirectionType) : void; /** * Gets and sets the direction of text. */ getDirectionType() : ChartTextDirectionType; /** * Gets and sets the direction of text. * @param value - The value to set. */ setDirectionType(value: ChartTextDirectionType) : void; /** * Gets or sets a value indicating whether the text is wrapped. */ isTextWrapped() : boolean; /** * Gets or sets a value indicating whether the text is wrapped. * @param value - The value to set. */ setIsTextWrapped(value: boolean) : void; /** * Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is * when text within a shape is scaled in order to contain all the text inside. */ isResizeShapeToFitText : boolean; /** * @deprecated Please use the 'isResizeShapeToFitText' property instead. * Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is * when text within a shape is scaled in order to contain all the text inside. * @param value - The value to set. */ setIsResizeShapeToFitText(value: boolean) : void; /** * Returns a Characters object that represents a range of characters within the text. * @param startIndex - The index of the start of the character. * @param length - The number of characters. * @returns * Characters object. */ characters(startIndex: number, length: number) : FontSetting; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Memory usage modes for cells data model. */ export enum MemorySetting { /** * Default mode for cells model. * * @remarks * This mode is applied for all versions. */ Normal = 0, /** * Memory performance preferable. * * @remarks * With this mode the cells data will be maintained in compact format * to decrease the memory cost. On other hand, the compact data also may * cause higher time cost, especially when updating the cells data, * or accessing it randomly. *

* This option is available since v8.0.0. */ MemoryPreference = 1, /** * Memory performance preferable and using file instead of memory * to maintain the cells data. * * @remarks * With this mode the cells data will be maintained in compact format * and the major part of the data will be maintained in temporary file instead of memory. * So when comparing with mode, * this mode may decrease the memory cost more, but the IO operations for accessing * cells data also will cause higher time cost. *

* This option is available since v25.7.0. * * * Some notable limits and recommended operations when using this mode: * * * When this mode is used for any worksheet in one workbook, * should be called at the end of work to release all resources such as the temporary files. * * * Randomly accessing cells will give poor performance because data needs * to be read randomly and repeatedly(so the pointer in the file will be * changed accordingly and IO operations will be required repeatedly). * If possible, please always access the data sequentially(row by row). * * * When the data of one row/cell be changed, data of other cells/rows * may also be influenced(such as the data be shifted/moved to other places * to allocated enough spaces for the changed data). * So every change of every data requires synchronization of other * existing objects(such as Row or Cell object). * So, to get better performance, please do not maintain multiple Rows/Cells * at the same time. Processing them one by one will reduce the data synchronization * for them so the performance can be improved. * * */ FileCache = 2, } /** * Specifies the preset shape geometry that is to be used for a chart. */ export enum DataLabelShapeType { /** * Represents the rectangle shape. */ Rect = 0, /** * Represents the round rectangle shape. */ RoundRect = 1, /** * Represents the ellipse shape. */ Ellipse = 2, /** * Represents the right arrow callout shape. */ RightArrowCallout = 3, /** * Represents the down arrow callout shape. */ DownArrowCallout = 4, /** * Represents the left arrow callout shape. */ LeftArrowCallout = 5, /** * Represents the up arrow callout shape. */ UpArrowCallout = 6, /** * Represents the wedge rectangle callout shape. */ WedgeRectCallout = 7, /** * Represents the wedge round rectangle callout shape. */ WedgeRoundRectCallout = 8, /** * Represents the wedge ellipse callout shape. */ WedgeEllipseCallout = 9, /** * Represents the line callout shape. */ LineCallout = 10, /** * Represents the bent line callout shape. */ BentLineCallout = 11, /** * Represents the line with accent bar callout shape. */ LineWithAccentBarCallout = 12, /** * Represents the bent line with accent bar callout shape. */ BentLineWithAccentBarCallout = 13, /** * This type is only used for special file processing */ Line = 14, } /** * Represents the region type of the map chart. */ export enum MapChartRegionType { /** * Automatic */ Automatic = 0, /** * Contains only data. */ DataOnly = 1, /** * Country region list. */ CountryRegionList = 2, /** * World. */ World = 3, } /** * Represents the projection type of the map chart. */ export enum MapChartProjectionType { /** * Automatic */ Automatic = 0, /** * Mercator */ Mercator = 1, /** * Miller */ Miller = 2, /** * Albers */ Albers = 3, } /** * Represents the layout of map chart's labels. */ export enum MapChartLabelLayout { /** * Only the best fit is used. */ BestFitOnly = 0, /** * Shows all labels. */ ShowAll = 1, /** * There are no labels. */ None = 2, } /** * Represents quartile calculation methods. */ export enum QuartileCalculationType { /** * The quartile calculation includes the median when splitting the dataset into quartiles. */ Exclusive = 0, /** * The quartile calculation excludes the median when splitting the dataset into quartiles. */ Inclusive = 1, } /** * Represents the properties of series layout. * * @remarks * Only applicable to BoxWhisker,Funnel,ParetoLine,Sunburst,Treemap,Waterfall and Histogram chart. */ export class SeriesLayoutProperties { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'showConnectorLines' property instead. * Indicates whether connector lines are displayed between data points. * * @remarks * Only for Waterfall chart. */ getShowConnectorLines() : boolean; /** * Indicates whether connector lines are displayed between data points. * * @remarks * Only for Waterfall chart. */ showConnectorLines : boolean; /** * @deprecated Please use the 'showConnectorLines' property instead. * Indicates whether connector lines are displayed between data points. * @param value - The value to set. * * @remarks * Only for Waterfall chart. */ setShowConnectorLines(value: boolean) : void; /** * @deprecated Please use the 'showMeanLine' property instead. * Indicates whether to show the line connecting all mean points. * * @remarks * Only works for BoxWhisker chart. */ getShowMeanLine() : boolean; /** * Indicates whether to show the line connecting all mean points. * * @remarks * Only works for BoxWhisker chart. */ showMeanLine : boolean; /** * @deprecated Please use the 'showMeanLine' property instead. * Indicates whether to show the line connecting all mean points. * @param value - The value to set. * * @remarks * Only works for BoxWhisker chart. */ setShowMeanLine(value: boolean) : void; /** * @deprecated Please use the 'showOutlierPoints' property instead. * Indicates whether outlier data points are shown. */ getShowOutlierPoints() : boolean; /** * Indicates whether outlier data points are shown. */ showOutlierPoints : boolean; /** * @deprecated Please use the 'showOutlierPoints' property instead. * Indicates whether outlier data points are shown. * @param value - The value to set. */ setShowOutlierPoints(value: boolean) : void; /** * @deprecated Please use the 'showMeanMarker' property instead. * Indicates whether markers denoting the mean are shown. */ getShowMeanMarker() : boolean; /** * Indicates whether markers denoting the mean are shown. */ showMeanMarker : boolean; /** * @deprecated Please use the 'showMeanMarker' property instead. * Indicates whether markers denoting the mean are shown. * @param value - The value to set. */ setShowMeanMarker(value: boolean) : void; /** * @deprecated Please use the 'showInnerPoints' property instead. * Indicates whether to show non-outlier data points. */ getShowInnerPoints() : boolean; /** * Indicates whether to show non-outlier data points. */ showInnerPoints : boolean; /** * @deprecated Please use the 'showInnerPoints' property instead. * Indicates whether to show non-outlier data points. * @param value - The value to set. */ setShowInnerPoints(value: boolean) : void; /** * @deprecated Please use the 'subtotals' property instead. * Represents the index of a subtotal data point. */ getSubtotals() : number[]; /** * Represents the index of a subtotal data point. */ subtotals : number[]; /** * @deprecated Please use the 'subtotals' property instead. * Represents the index of a subtotal data point. * @param value - The value to set. */ setSubtotals(value: number[]) : void; /** * @deprecated Please use the 'quartileCalculation' property instead. * Represents the statistical properties for the series. * * @remarks * Only applicable to BoxWhisker chart. */ getQuartileCalculation() : QuartileCalculationType; /** * Represents the statistical properties for the series. * * @remarks * Only applicable to BoxWhisker chart. */ quartileCalculation : QuartileCalculationType; /** * @deprecated Please use the 'quartileCalculation' property instead. * Represents the statistical properties for the series. * @param value - The value to set. * * @remarks * Only applicable to BoxWhisker chart. */ setQuartileCalculation(value: QuartileCalculationType) : void; /** * @deprecated Please use the 'mapLabelLayout' property instead. * Gets and sets the layout of map labels. */ getMapLabelLayout() : MapChartLabelLayout; /** * Gets and sets the layout of map labels. */ mapLabelLayout : MapChartLabelLayout; /** * @deprecated Please use the 'mapLabelLayout' property instead. * Gets and sets the layout of map labels. * @param value - The value to set. */ setMapLabelLayout(value: MapChartLabelLayout) : void; /** * Indicates whether the interval is closed on the left side. * * @remarks * Only for ParetoLine chart. */ isIntervalLeftClosed : boolean; /** * @deprecated Please use the 'isIntervalLeftClosed' property instead. * Indicates whether the interval is closed on the left side. * @param value - The value to set. * * @remarks * Only for ParetoLine chart. */ setIsIntervalLeftClosed(value: boolean) : void; /** * @deprecated Please use the 'mapChartRegionType' property instead. * Gets and sets the region type of the map. * * @remarks * Only for map chart. */ getMapChartRegionType() : MapChartRegionType; /** * Gets and sets the region type of the map. * * @remarks * Only for map chart. */ mapChartRegionType : MapChartRegionType; /** * @deprecated Please use the 'mapChartRegionType' property instead. * Gets and sets the region type of the map. * @param value - The value to set. * * @remarks * Only for map chart. */ setMapChartRegionType(value: MapChartRegionType) : void; /** * @deprecated Please use the 'mapChartProjectionType' property instead. * Gets and sets the projection type of the map. * * @remarks * Only for map chart. */ getMapChartProjectionType() : MapChartProjectionType; /** * Gets and sets the projection type of the map. * * @remarks * Only for map chart. */ mapChartProjectionType : MapChartProjectionType; /** * @deprecated Please use the 'mapChartProjectionType' property instead. * Gets and sets the projection type of the map. * @param value - The value to set. * * @remarks * Only for map chart. */ setMapChartProjectionType(value: MapChartProjectionType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents conditional formatting condition. */ export class FormatCondition { /** * @deprecated Please use the 'formula1' property instead. * Gets and sets the value or expression associated with conditional formatting. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ getFormula1() : string; /** * Gets and sets the value or expression associated with conditional formatting. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ formula1 : string; /** * @deprecated Please use the 'formula1' property instead. * Gets and sets the value or expression associated with conditional formatting. * @param value - The value to set. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ setFormula1(value: string) : void; /** * @deprecated Please use the 'formula2' property instead. * Gets and sets the value or expression associated with conditional formatting. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ getFormula2() : string; /** * Gets and sets the value or expression associated with conditional formatting. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ formula2 : string; /** * @deprecated Please use the 'formula2' property instead. * Gets and sets the value or expression associated with conditional formatting. * @param value - The value to set. * * @remarks * Please add all areas before setting formula. * For setting formula for this condition, if the input value starts with '=', then it will be taken as formula. * Otherwise it will be taken as plain value(text, number, bool). For text value that starts with '=', user may input it as formula in format: "=\"=...\"". */ setFormula2(value: string) : void; /** * @deprecated Please use the 'operator' property instead. * Gets and sets the conditional format operator type. */ getOperator() : OperatorType; /** * Gets and sets the conditional format operator type. */ operator : OperatorType; /** * @deprecated Please use the 'operator' property instead. * Gets and sets the conditional format operator type. * @param value - The value to set. */ setOperator(value: OperatorType) : void; /** * @deprecated Please use the 'stopIfTrue' property instead. * True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. * Only applies for Excel 2007; */ getStopIfTrue() : boolean; /** * True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. * Only applies for Excel 2007; */ stopIfTrue : boolean; /** * @deprecated Please use the 'stopIfTrue' property instead. * True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. * Only applies for Excel 2007; * @param value - The value to set. */ setStopIfTrue(value: boolean) : void; /** * @deprecated Please use the 'priority' property instead. * The priority of this conditional formatting rule. This value is used to determine which * format should be evaluated and rendered. Lower numeric values are higher priority than * higher numeric values, where '1' is the highest priority. */ getPriority() : number; /** * The priority of this conditional formatting rule. This value is used to determine which * format should be evaluated and rendered. Lower numeric values are higher priority than * higher numeric values, where '1' is the highest priority. */ priority : number; /** * @deprecated Please use the 'priority' property instead. * The priority of this conditional formatting rule. This value is used to determine which * format should be evaluated and rendered. Lower numeric values are higher priority than * higher numeric values, where '1' is the highest priority. * @param value - The value to set. */ setPriority(value: number) : void; /** * @deprecated Please use the 'style' property instead. * Gets or setts style of conditional formatted cell ranges. */ getStyle() : Style; /** * Gets or setts style of conditional formatted cell ranges. */ style : Style; /** * @deprecated Please use the 'style' property instead. * Gets or setts style of conditional formatted cell ranges. * @param value - The value to set. */ setStyle(value: Style) : void; /** * @deprecated Please use the 'type' property instead. * Gets and sets whether the conditional format Type. */ getType() : FormatConditionType; /** * Gets and sets whether the conditional format Type. */ type : FormatConditionType; /** * @deprecated Please use the 'type' property instead. * Gets and sets whether the conditional format Type. * @param value - The value to set. */ setType(value: FormatConditionType) : void; /** * @deprecated Please use the 'iconSet' property instead. * Get the conditional formatting's "IconSet" instance. * The default instance's IconSetType is TrafficLights31. * Valid only for type = IconSet. */ getIconSet() : IconSet; /** * Get the conditional formatting's "IconSet" instance. * The default instance's IconSetType is TrafficLights31. * Valid only for type = IconSet. */ readonly iconSet : IconSet; /** * @deprecated Please use the 'dataBar' property instead. * Get the conditional formatting's "DataBar" instance. * The default instance's color is blue. * Valid only for type is DataBar. */ getDataBar() : DataBar; /** * Get the conditional formatting's "DataBar" instance. * The default instance's color is blue. * Valid only for type is DataBar. */ readonly dataBar : DataBar; /** * @deprecated Please use the 'colorScale' property instead. * Get the conditional formatting's "ColorScale" instance. * The default instance is a "green-yellow-red" 3ColorScale . * Valid only for type = ColorScale. */ getColorScale() : ColorScale; /** * Get the conditional formatting's "ColorScale" instance. * The default instance is a "green-yellow-red" 3ColorScale . * Valid only for type = ColorScale. */ readonly colorScale : ColorScale; /** * @deprecated Please use the 'top10' property instead. * Get the conditional formatting's "Top10" instance. * The default instance's rule highlights cells whose * values fall in the top 10 bracket. * Valid only for type is Top10. */ getTop10() : Top10; /** * Get the conditional formatting's "Top10" instance. * The default instance's rule highlights cells whose * values fall in the top 10 bracket. * Valid only for type is Top10. */ readonly top10 : Top10; /** * @deprecated Please use the 'aboveAverage' property instead. * Get the conditional formatting's "AboveAverage" instance. * The default instance's rule highlights cells that are * above the average for all values in the range. * Valid only for type = AboveAverage. */ getAboveAverage() : AboveAverage; /** * Get the conditional formatting's "AboveAverage" instance. * The default instance's rule highlights cells that are * above the average for all values in the range. * Valid only for type = AboveAverage. */ readonly aboveAverage : AboveAverage; /** * @deprecated Please use the 'text' property instead. * The text value in a "text contains" conditional formatting rule. * Valid only for type = containsText, notContainsText, beginsWith and endsWith. * The default value is null. */ getText() : string; /** * The text value in a "text contains" conditional formatting rule. * Valid only for type = containsText, notContainsText, beginsWith and endsWith. * The default value is null. */ text : string; /** * @deprecated Please use the 'text' property instead. * The text value in a "text contains" conditional formatting rule. * Valid only for type = containsText, notContainsText, beginsWith and endsWith. * The default value is null. * @param value - The value to set. */ setText(value: string) : void; /** * @deprecated Please use the 'timePeriod' property instead. * The applicable time period in a "date occurrin" conditional formatting rule. * Valid only for type is timePeriod. * The default value is TimePeriodType.Today. */ getTimePeriod() : TimePeriodType; /** * The applicable time period in a "date occurrin" conditional formatting rule. * Valid only for type is timePeriod. * The default value is TimePeriodType.Today. */ timePeriod : TimePeriodType; /** * @deprecated Please use the 'timePeriod' property instead. * The applicable time period in a "date occurrin" conditional formatting rule. * Valid only for type is timePeriod. * The default value is TimePeriodType.Today. * @param value - The value to set. */ setTimePeriod(value: TimePeriodType) : void; /** * Gets the value or expression associated with this format condition. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @returns * The value or expression associated with this format condition. */ getFormula1(isR1C1: boolean, isLocal: boolean) : string; /** * Gets the value or expression of the conditional formatting of the cell. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @param row - The row index. * @param column - The column index. * @returns * The value or expression associated with the conditional formatting of the cell. * * @remarks * The given cell must be contained by this conditional formatting, otherwise null will be returned. */ getFormula1(isR1C1: boolean, isLocal: boolean, row: number, column: number) : string; /** * Gets the formula of the conditional formatting of the cell. * @param row - The row index. * @param column - The column index. * @returns * The formula. */ getFormula1(row: number, column: number) : string; /** * Gets the value or expression associated with this format condition. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @returns * The value or expression associated with this format condition. */ getFormula2(isR1C1: boolean, isLocal: boolean) : string; /** * Gets the value or expression of the conditional formatting of the cell. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @param row - The row index. * @param column - The column index. * @returns * The value or expression associated with the conditional formatting of the cell. * * @remarks * The given cell must be contained by this conditional formatting, otherwise null will be returned. */ getFormula2(isR1C1: boolean, isLocal: boolean, row: number, column: number) : string; /** * Gets the formula of the conditional formatting of the cell. * @param row - The row index. * @param column - The column index. * @returns * The formula. */ getFormula2(row: number, column: number) : string; /** * Sets the value or expression associated with this format condition. * @param formula1 - The value or expression associated with this format condition. /// If the input value starts with '=', then it will be taken as formula. Otherwise it will be taken as plain value(text, number, bool). /// For text value that starts with '=', user may input it as formula in format: "=\"=...\"". * @param formula2 - The value or expression associated with this format condition. The input format is same with formula1 * @param isR1C1 - Whether the formula is R1C1 formula. * @param isLocal - Whether the formula is locale formatted. */ setFormulas(formula1: string, formula2: string, isR1C1: boolean, isLocal: boolean) : void; /** * Sets the value or expression associated with this format condition. * @param formula - The value or expression associated with this format condition. /// If the input value starts with '=', then it will be taken as formula. Otherwise it will be taken as plain value(text, number, bool). /// For text value that starts with '=', user may input it as formula in format: "=\"=...\"". * @param isR1C1 - Whether the formula is R1C1 formula. * @param isLocal - Whether the formula is locale formatted. */ setFormula1(formula: string, isR1C1: boolean, isLocal: boolean) : void; /** * Sets the value or expression associated with this format condition. * @param formula - The value or expression associated with this format condition. /// If the input value starts with '=', then it will be taken as formula. Otherwise it will be taken as plain value(text, number, bool). /// For text value that starts with '=', user may input it as formula in format: "=\"=...\"". * @param isR1C1 - Whether the formula is R1C1 formula. * @param isLocal - Whether the formula is locale formatted. */ setFormula2(formula: string, isR1C1: boolean, isLocal: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * PdfBookmarkEntry is an entry in pdf bookmark. * if Text property of current instance is null or "", * current instance will be hidden and children will be inserted on current level. */ export class PdfBookmarkEntry { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'text' property instead. * Title of a bookmark. */ getText() : string; /** * Title of a bookmark. */ text : string; /** * @deprecated Please use the 'text' property instead. * Title of a bookmark. * @param value - The value to set. */ setText(value: string) : void; /** * @deprecated Please use the 'destination' property instead. * The cell to which the bookmark link. */ getDestination() : Cell; /** * The cell to which the bookmark link. */ destination : Cell; /** * @deprecated Please use the 'destination' property instead. * The cell to which the bookmark link. * @param value - The value to set. */ setDestination(value: Cell) : void; /** * @deprecated Please use the 'destinationName' property instead. * Gets or sets name of destination. * * @remarks * If destination name is set, the destination will be defined as a named destination with this name. */ getDestinationName() : string; /** * Gets or sets name of destination. * * @remarks * If destination name is set, the destination will be defined as a named destination with this name. */ destinationName : string; /** * @deprecated Please use the 'destinationName' property instead. * Gets or sets name of destination. * @param value - The value to set. * * @remarks * If destination name is set, the destination will be defined as a named destination with this name. */ setDestinationName(value: string) : void; /** * When this property is true, the bookmarkentry will expand, otherwise it will collapse. */ isOpen : boolean; /** * @deprecated Please use the 'isOpen' property instead. * When this property is true, the bookmarkentry will expand, otherwise it will collapse. * @param value - The value to set. */ setIsOpen(value: boolean) : void; /** * When this property is true, the bookmarkentry will collapse, otherwise it will expand. */ isCollapse : boolean; /** * @deprecated Please use the 'isCollapse' property instead. * When this property is true, the bookmarkentry will collapse, otherwise it will expand. * @param value - The value to set. */ setIsCollapse(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the effect type of reflection. */ export enum ReflectionEffectType { /** * No reflection effect. */ None = 0, /** * Custom reflection effect. */ Custom = 1, /** * Tight reflection, touching. */ TightReflectionTouching = 2, /** * Half reflection, touching. */ HalfReflectionTouching = 3, /** * Full reflection, touching. */ FullReflectionTouching = 4, /** * Tight reflection, 4 pt offset. */ TightReflection4PtOffset = 5, /** * Half reflection, 4 pt offset. */ HalfReflection4PtOffset = 6, /** * Full reflection, 4 pt offset. */ FullReflection4PtOffset = 7, /** * Tight reflection, 8 pt offset. */ TightReflection8PtOffset = 8, /** * Half reflection, 8 pt offset. */ HalfReflection8PtOffset = 9, /** * Full reflection, 8 pt offset. */ FullReflection8PtOffset = 10, } /** * Represents a preset for a type of bevel which can be applied to a shape in 3D. */ export enum BevelPresetType { /** * No bevel */ None = 0, /** * Angle */ Angle = 1, /** * Art deco */ ArtDeco = 2, /** * Circle */ Circle = 3, /** * Convex */ Convex = 4, /** * Cool slant */ CoolSlant = 5, /** * Cross */ Cross = 6, /** * Divot */ Divot = 7, /** * Hard edge */ HardEdge = 8, /** * Relaxed inset */ RelaxedInset = 9, /** * Riblet */ Riblet = 10, /** * Slope */ Slope = 11, /** * Soft round */ SoftRound = 12, } /** * Represents a shape's three-dimensional formatting. */ export class ThreeDFormat { /** * @deprecated Please use the 'bottomBevelWidth' property instead. * Gets and sets the width of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ getBottomBevelWidth() : number; /** * Gets and sets the width of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ bottomBevelWidth : number; /** * @deprecated Please use the 'bottomBevelWidth' property instead. * Gets and sets the width of the bottom bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setBottomBevelWidth(value: number) : void; /** * @deprecated Please use the 'bottomBevelHeight' property instead. * Gets and sets the height of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ getBottomBevelHeight() : number; /** * Gets and sets the height of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ bottomBevelHeight : number; /** * @deprecated Please use the 'bottomBevelHeight' property instead. * Gets and sets the height of the bottom bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setBottomBevelHeight(value: number) : void; /** * @deprecated Please use the 'bottomBevelType' property instead. * Gets and sets the type of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ getBottomBevelType() : BevelType; /** * Gets and sets the type of the bottom bevel, or how far into the shape it is applied. * In unit of Points. */ bottomBevelType : BevelType; /** * @deprecated Please use the 'bottomBevelType' property instead. * Gets and sets the type of the bottom bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setBottomBevelType(value: BevelType) : void; /** * @deprecated Please use the 'topBevelWidth' property instead. * Gets and sets the width of the top bevel, or how far into the shape it is applied. * In unit of Points. */ getTopBevelWidth() : number; /** * Gets and sets the width of the top bevel, or how far into the shape it is applied. * In unit of Points. */ topBevelWidth : number; /** * @deprecated Please use the 'topBevelWidth' property instead. * Gets and sets the width of the top bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setTopBevelWidth(value: number) : void; /** * @deprecated Please use the 'topBevelHeight' property instead. * Gets and sets the height of the top bevel, or how far into the shape it is applied. * In unit of Points. */ getTopBevelHeight() : number; /** * Gets and sets the height of the top bevel, or how far into the shape it is applied. * In unit of Points. */ topBevelHeight : number; /** * @deprecated Please use the 'topBevelHeight' property instead. * Gets and sets the height of the top bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setTopBevelHeight(value: number) : void; /** * @deprecated Please use the 'topBevelType' property instead. * Gets and sets the type of the top bevel, or how far into the shape it is applied. * In unit of Points. */ getTopBevelType() : BevelType; /** * Gets and sets the type of the top bevel, or how far into the shape it is applied. * In unit of Points. */ topBevelType : BevelType; /** * @deprecated Please use the 'topBevelType' property instead. * Gets and sets the type of the top bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setTopBevelType(value: BevelType) : void; /** * @deprecated Please use the 'material' property instead. * Represents the preset material which is combined with the lighting properties to give the * final look and feel of a shape. */ getMaterial() : PresetMaterialType; /** * Represents the preset material which is combined with the lighting properties to give the * final look and feel of a shape. */ material : PresetMaterialType; /** * @deprecated Please use the 'material' property instead. * Represents the preset material which is combined with the lighting properties to give the * final look and feel of a shape. * @param value - The value to set. */ setMaterial(value: PresetMaterialType) : void; /** * @deprecated Please use the 'contourColor' property instead. * Gets and sets the contour color on a shape. */ getContourColor() : CellsColor; /** * Gets and sets the contour color on a shape. */ contourColor : CellsColor; /** * @deprecated Please use the 'contourColor' property instead. * Gets and sets the contour color on a shape. * @param value - The value to set. */ setContourColor(value: CellsColor) : void; /** * @deprecated Please use the 'contourWidth' property instead. * Gets and sets the contour width on the shape, in unit of points. */ getContourWidth() : number; /** * Gets and sets the contour width on the shape, in unit of points. */ contourWidth : number; /** * @deprecated Please use the 'contourWidth' property instead. * Gets and sets the contour width on the shape, in unit of points. * @param value - The value to set. */ setContourWidth(value: number) : void; /** * @deprecated Please use the 'extrusionColor' property instead. * Gets the extrusion color on a shape. */ getExtrusionColor() : CellsColor; /** * Gets the extrusion color on a shape. */ extrusionColor : CellsColor; /** * @deprecated Please use the 'extrusionColor' property instead. * Gets the extrusion color on a shape. * @param value - The value to set. */ setExtrusionColor(value: CellsColor) : void; /** * @deprecated Please use the 'extrusionHeight' property instead. * Gets and sets the extrusion height of the applied to the shape, in unit of points. */ getExtrusionHeight() : number; /** * Gets and sets the extrusion height of the applied to the shape, in unit of points. */ extrusionHeight : number; /** * @deprecated Please use the 'extrusionHeight' property instead. * Gets and sets the extrusion height of the applied to the shape, in unit of points. * @param value - The value to set. */ setExtrusionHeight(value: number) : void; /** * @deprecated Please use the 'z' property instead. * Defines the distance from ground for the 3D shape. */ getZ() : number; /** * Defines the distance from ground for the 3D shape. */ z : number; /** * @deprecated Please use the 'z' property instead. * Defines the distance from ground for the 3D shape. * @param value - The value to set. */ setZ(value: number) : void; /** * @deprecated Please use the 'lightAngle' property instead. * Gets and sets the angle of the extrusion lights. */ getLightAngle() : number; /** * Gets and sets the angle of the extrusion lights. */ lightAngle : number; /** * @deprecated Please use the 'lightAngle' property instead. * Gets and sets the angle of the extrusion lights. * @param value - The value to set. */ setLightAngle(value: number) : void; /** * @deprecated Please use the 'lighting' property instead. * Gets and sets type of light rig. */ getLighting() : LightRigType; /** * Gets and sets type of light rig. */ lighting : LightRigType; /** * @deprecated Please use the 'lighting' property instead. * Gets and sets type of light rig. * @param value - The value to set. */ setLighting(value: LightRigType) : void; /** * @deprecated Please use the 'lightingDirection' property instead. * Gets and sets the direction from which the light rig is oriented in relation to the scene. */ getLightingDirection() : LightRigDirectionType; /** * Gets and sets the direction from which the light rig is oriented in relation to the scene. */ lightingDirection : LightRigDirectionType; /** * @deprecated Please use the 'lightingDirection' property instead. * Gets and sets the direction from which the light rig is oriented in relation to the scene. * @param value - The value to set. */ setLightingDirection(value: LightRigDirectionType) : void; /** * @deprecated Please use the 'perspective' property instead. * Gets and sets the angle at which a ThreeDFormat object can be viewed. */ getPerspective() : number; /** * Gets and sets the angle at which a ThreeDFormat object can be viewed. */ perspective : number; /** * @deprecated Please use the 'perspective' property instead. * Gets and sets the angle at which a ThreeDFormat object can be viewed. * @param value - The value to set. */ setPerspective(value: number) : void; /** * @deprecated Please use the 'rotationX' property instead. * Gets and sets the rotation of the extruded shape around the x-axis in degrees. */ getRotationX() : number; /** * Gets and sets the rotation of the extruded shape around the x-axis in degrees. */ rotationX : number; /** * @deprecated Please use the 'rotationX' property instead. * Gets and sets the rotation of the extruded shape around the x-axis in degrees. * @param value - The value to set. */ setRotationX(value: number) : void; /** * @deprecated Please use the 'rotationY' property instead. * Gets and sets the rotation of the extruded shape around the y-axis in degrees. */ getRotationY() : number; /** * Gets and sets the rotation of the extruded shape around the y-axis in degrees. */ rotationY : number; /** * @deprecated Please use the 'rotationY' property instead. * Gets and sets the rotation of the extruded shape around the y-axis in degrees. * @param value - The value to set. */ setRotationY(value: number) : void; /** * @deprecated Please use the 'rotationZ' property instead. * Gets and sets the rotation of the extruded shape around the z-axis in degrees. */ getRotationZ() : number; /** * Gets and sets the rotation of the extruded shape around the z-axis in degrees. */ rotationZ : number; /** * @deprecated Please use the 'rotationZ' property instead. * Gets and sets the rotation of the extruded shape around the z-axis in degrees. * @param value - The value to set. */ setRotationZ(value: number) : void; /** * @deprecated Please use the 'presetCameraType' property instead. * Gets and sets the extrusion preset camera type. */ getPresetCameraType() : PresetCameraType; /** * Gets and sets the extrusion preset camera type. */ presetCameraType : PresetCameraType; /** * @deprecated Please use the 'presetCameraType' property instead. * Gets and sets the extrusion preset camera type. * @param value - The value to set. */ setPresetCameraType(value: PresetCameraType) : void; /** * Gets hashcode. */ getHashCode() : number; /** * @param obj - */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the dialog box. */ export class Dialog_Box extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents line and arrowhead formatting. */ export class MsoLineFormatHelper { /** * Indicates whether the object is visible. */ isVisible : boolean; /** * @deprecated Please use the 'isVisible' property instead. * Indicates whether the object is visible. * @param value - The value to set. */ setIsVisible(value: boolean) : void; /** * @deprecated Please use the 'style' property instead. * Returns a Style object that represents the style of the specified range. */ getStyle() : MsoLineStyle; /** * Returns a Style object that represents the style of the specified range. */ style : MsoLineStyle; /** * @deprecated Please use the 'style' property instead. * Returns a Style object that represents the style of the specified range. * @param value - The value to set. */ setStyle(value: MsoLineStyle) : void; /** * @deprecated Please use the 'foreColor' property instead. * Gets and sets the border line fore color. */ getForeColor() : Color; /** * Gets and sets the border line fore color. */ foreColor : Color; /** * @deprecated Please use the 'foreColor' property instead. * Gets and sets the border line fore color. * @param value - The value to set. */ setForeColor(value: Color) : void; /** * @deprecated Please use the 'backColor' property instead. * Gets and sets the border line back color. */ getBackColor() : Color; /** * Gets and sets the border line back color. */ backColor : Color; /** * @deprecated Please use the 'backColor' property instead. * Gets and sets the border line back color. * @param value - The value to set. */ setBackColor(value: Color) : void; /** * @deprecated Please use the 'dashStyle' property instead. * Gets or sets the dash style for the specified line. */ getDashStyle() : MsoLineDashStyle; /** * Gets or sets the dash style for the specified line. */ dashStyle : MsoLineDashStyle; /** * @deprecated Please use the 'dashStyle' property instead. * Gets or sets the dash style for the specified line. * @param value - The value to set. */ setDashStyle(value: MsoLineDashStyle) : void; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). */ getTransparency() : number; /** * Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * @deprecated Please use the 'weight' property instead. * Returns or sets the weight of the line ,in units of pt. */ getWeight() : number; /** * Returns or sets the weight of the line ,in units of pt. */ weight : number; /** * @deprecated Please use the 'weight' property instead. * Returns or sets the weight of the line ,in units of pt. * @param value - The value to set. */ setWeight(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all setting of the line. */ export class LineFormat extends FillFormat { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FillFormat); /** * @deprecated Please use the 'compoundType' property instead. * Specifies the line compound type. */ getCompoundType() : MsoLineStyle; /** * Specifies the line compound type. */ compoundType : MsoLineStyle; /** * @deprecated Please use the 'compoundType' property instead. * Specifies the line compound type. * @param value - The value to set. */ setCompoundType(value: MsoLineStyle) : void; /** * @deprecated Please use the 'dashStyle' property instead. * Specifies the line dash type. */ getDashStyle() : MsoLineDashStyle; /** * Specifies the line dash type. */ dashStyle : MsoLineDashStyle; /** * @deprecated Please use the 'dashStyle' property instead. * Specifies the line dash type. * @param value - The value to set. */ setDashStyle(value: MsoLineDashStyle) : void; /** * @deprecated Please use the 'capType' property instead. * Specifies the ending caps. */ getCapType() : LineCapType; /** * Specifies the ending caps. */ capType : LineCapType; /** * @deprecated Please use the 'capType' property instead. * Specifies the ending caps. * @param value - The value to set. */ setCapType(value: LineCapType) : void; /** * @deprecated Please use the 'joinType' property instead. * Specifies the line join type. */ getJoinType() : LineJoinType; /** * Specifies the line join type. */ joinType : LineJoinType; /** * @deprecated Please use the 'joinType' property instead. * Specifies the line join type. * @param value - The value to set. */ setJoinType(value: LineJoinType) : void; /** * @deprecated Please use the 'beginArrowheadStyle' property instead. * Gets and sets the begin arrow type of the line. */ getBeginArrowheadStyle() : MsoArrowheadStyle; /** * Gets and sets the begin arrow type of the line. */ beginArrowheadStyle : MsoArrowheadStyle; /** * @deprecated Please use the 'beginArrowheadStyle' property instead. * Gets and sets the begin arrow type of the line. * @param value - The value to set. */ setBeginArrowheadStyle(value: MsoArrowheadStyle) : void; /** * @deprecated Please use the 'beginArrowheadWidth' property instead. * Gets and sets the begin arrow width type of the line. */ getBeginArrowheadWidth() : MsoArrowheadWidth; /** * Gets and sets the begin arrow width type of the line. */ beginArrowheadWidth : MsoArrowheadWidth; /** * @deprecated Please use the 'beginArrowheadWidth' property instead. * Gets and sets the begin arrow width type of the line. * @param value - The value to set. */ setBeginArrowheadWidth(value: MsoArrowheadWidth) : void; /** * @deprecated Please use the 'beginArrowheadLength' property instead. * Gets and sets the begin arrow length type of the line. */ getBeginArrowheadLength() : MsoArrowheadLength; /** * Gets and sets the begin arrow length type of the line. */ beginArrowheadLength : MsoArrowheadLength; /** * @deprecated Please use the 'beginArrowheadLength' property instead. * Gets and sets the begin arrow length type of the line. * @param value - The value to set. */ setBeginArrowheadLength(value: MsoArrowheadLength) : void; /** * @deprecated Please use the 'endArrowheadStyle' property instead. * Gets and sets the end arrow type of the line. */ getEndArrowheadStyle() : MsoArrowheadStyle; /** * Gets and sets the end arrow type of the line. */ endArrowheadStyle : MsoArrowheadStyle; /** * @deprecated Please use the 'endArrowheadStyle' property instead. * Gets and sets the end arrow type of the line. * @param value - The value to set. */ setEndArrowheadStyle(value: MsoArrowheadStyle) : void; /** * @deprecated Please use the 'endArrowheadWidth' property instead. * Gets and sets the end arrow width type of the line. */ getEndArrowheadWidth() : MsoArrowheadWidth; /** * Gets and sets the end arrow width type of the line. */ endArrowheadWidth : MsoArrowheadWidth; /** * @deprecated Please use the 'endArrowheadWidth' property instead. * Gets and sets the end arrow width type of the line. * @param value - The value to set. */ setEndArrowheadWidth(value: MsoArrowheadWidth) : void; /** * @deprecated Please use the 'endArrowheadLength' property instead. * Gets and sets the end arrow length type of the line. */ getEndArrowheadLength() : MsoArrowheadLength; /** * Gets and sets the end arrow length type of the line. */ endArrowheadLength : MsoArrowheadLength; /** * @deprecated Please use the 'endArrowheadLength' property instead. * Gets and sets the end arrow length type of the line. * @param value - The value to set. */ setEndArrowheadLength(value: MsoArrowheadLength) : void; /** * @deprecated Please use the 'weight' property instead. * Gets or sets the weight of the line in unit of points. */ getWeight() : number; /** * Gets or sets the weight of the line in unit of points. */ weight : number; /** * @deprecated Please use the 'weight' property instead. * Gets or sets the weight of the line in unit of points. * @param value - The value to set. */ setWeight(value: number) : void; /** * Gets the hash code. */ getHashCode() : number; /** * Determines whether this instance has the same value as another specified object. * @param obj - The object to compare with this instance. * @returns * true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false. */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the exported file path provider. */ export interface IFilePathProvider { /** * Gets the full path of the file by Worksheet name when exporting Worksheet to HTML separately. * So the references among the Worksheets can be exported correctly. * @param sheetName - Worksheet name * @returns * the full path of the file */ getFullName(sheetName: string) : string; } /** * Represents the smart art. */ export class SmartArtShape extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * Converting smart art to grouped shapes. */ getResultOfSmartArt() : GroupShape; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the shape of web extension. */ export class WebExtensionShape extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * @deprecated Please use the 'webExtension' property instead. * Gets and set the web extension. */ getWebExtension() : WebExtension; /** * Gets and set the web extension. */ webExtension : WebExtension; /** * @deprecated Please use the 'webExtension' property instead. * Gets and set the web extension. * @param value - The value to set. */ setWebExtension(value: WebExtension) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the preset WordArt styles. */ export enum PresetWordArtStyle { /** * Fill - Black, Text 1, Shadow */ WordArtStyle1 = 1, /** * Fill - Blue, Accent 1, Shadow */ WordArtStyle2 = 2, /** * Fill - Orange, Accent 2, Outline - Accent 2 */ WordArtStyle3 = 3, /** * Fill - White, Outline - Accent 1, Shadow */ WordArtStyle4 = 4, /** * Fill - Gold, Accent 4, Soft Bevel */ WordArtStyle5 = 5, /** * Gradient Fill - Gray */ WordArtStyle6 = 6, /** * Gradient Fill - Blue, Accent 1, Reflection */ WordArtStyle7 = 7, /** * Gradient Fill - Gold, Accent 4, Outline - Accent 4 */ WordArtStyle8 = 8, /** * Fill - White, Outline - Accent 1, Glow - Accent 1 */ WordArtStyle9 = 9, /** * Fill - Gray-50%, Accent 3, Sharp Bevel */ WordArtStyle10 = 10, /** * Fill - Black, Text 1, Outline - Background 1, Hard Shadow - Background 1 */ WordArtStyle11 = 11, /** * Fill - Black, Text 1, Outline - Background 1, Hard Shadow - Accent 1 */ WordArtStyle12 = 12, /** * Fill - Blue, Accent 1, Outline - Background 1, Hard Shadow - Accent 1 */ WordArtStyle13 = 13, /** * Fill - White, Outline - Accent 2, Hard Shadow - Accent 2 */ WordArtStyle14 = 14, /** * Fill - Gray-25%, Background 2, Inner Shadow */ WordArtStyle15 = 15, /** * Pattern Fill - White, Text 2, Dark Upward Diagonal, Shadow */ WordArtStyle16 = 16, /** * Pattern Fill - Gray-50%, Accent 3, Narrow Horizontal, Inner Shadow */ WordArtStyle17 = 17, /** * Fill - Blue, Accent 1, 50%, Hard Shadow - Accent 1 */ WordArtStyle18 = 18, /** * Pattern Fill - Blue, Accent 1, Light Downward Diagonal, Outline - Accent 1 */ WordArtStyle19 = 19, /** * Pattern Fill - Blue-Gray, Text 2, Dark Upward Diagonal, Hard Shadow - Text 2 */ WordArtStyle20 = 20, } /** * This class in the equation node is used to store the actual content(a sequence of mathematical text) of the equation. * Usually a node object per character. */ export class TextRunEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'text' property instead. * Set the content of the text node(Usually a node object per character). */ getText() : string; /** * Set the content of the text node(Usually a node object per character). */ text : string; /** * @deprecated Please use the 'text' property instead. * Set the content of the text node(Usually a node object per character). * @param value - The value to set. */ setText(value: string) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all text paragraph. */ export class TextParagraphCollection implements Iterable { /** * Gets the object at specific index. * @param index - The index. */ get(index: number) : TextParagraph; /** * @deprecated Please use the 'count' property instead. * Gets the count of text paragraphs. */ getCount() : number; /** * Gets the count of text paragraphs. */ readonly count : number; /** * Gets the enumerator of the paragraphs. */ getEnumerator() : TextParagraphEnumerator; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Encapsulates the object that represents fill formatting for a shape. */ export class FillFormat { /** * @deprecated Please use the 'fillType' property instead. * Gets and sets fill type */ getFillType() : FillType; /** * Gets and sets fill type */ fillType : FillType; /** * @deprecated Please use the 'fillType' property instead. * Gets and sets fill type * @param value - The value to set. */ setFillType(value: FillType) : void; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). */ getTransparency() : number; /** * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * @deprecated Please use the 'gradientFill' property instead. * Gets object. */ getGradientFill() : GradientFill; /** * Gets object. */ readonly gradientFill : GradientFill; /** * @deprecated Please use the 'textureFill' property instead. * Gets object. */ getTextureFill() : TextureFill; /** * Gets object. */ readonly textureFill : TextureFill; /** * @deprecated Please use the 'solidFill' property instead. * Gets object. */ getSolidFill() : SolidFill; /** * Gets object. */ readonly solidFill : SolidFill; /** * @deprecated Please use the 'patternFill' property instead. * Gets object. */ getPatternFill() : PatternFill; /** * Gets object. */ readonly patternFill : PatternFill; /** * @deprecated Please use the 'gradientColorType' property instead. * Returns the gradient color type for the specified fill. */ getGradientColorType() : GradientColorType; /** * Returns the gradient color type for the specified fill. */ readonly gradientColorType : GradientColorType; /** * @deprecated Please use the 'gradientStyle' property instead. * Returns the gradient style for the specified fill. */ getGradientStyle() : GradientStyleType; /** * Returns the gradient style for the specified fill. */ readonly gradientStyle : GradientStyleType; /** * @deprecated Please use the 'gradientColor1' property instead. * Returns the gradient color 1 for the specified fill. */ getGradientColor1() : Color; /** * Returns the gradient color 1 for the specified fill. */ readonly gradientColor1 : Color; /** * @deprecated Please use the 'gradientColor2' property instead. * Returns the gradient color 2 for the specified fill. * * @remarks * Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful. */ getGradientColor2() : Color; /** * Returns the gradient color 2 for the specified fill. * * @remarks * Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful. */ readonly gradientColor2 : Color; /** * @deprecated Please use the 'gradientDegree' property instead. * Returns the gradient degree for the specified fill. * Only applies for Excel 2007. * * @remarks * Can only be a value from 0.0 (dark) through 1.0 (light). */ getGradientDegree() : number; /** * Returns the gradient degree for the specified fill. * Only applies for Excel 2007. * * @remarks * Can only be a value from 0.0 (dark) through 1.0 (light). */ readonly gradientDegree : number; /** * @deprecated Please use the 'gradientVariant' property instead. * Returns the gradient variant for the specified fill. * Only applies for Excel 2007. * * @remarks * Can only be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ getGradientVariant() : number; /** * Returns the gradient variant for the specified fill. * Only applies for Excel 2007. * * @remarks * Can only be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ readonly gradientVariant : number; /** * @deprecated Please use the 'presetColor' property instead. * Returns the gradient preset color for the specified fill. */ getPresetColor() : GradientPresetType; /** * Returns the gradient preset color for the specified fill. */ readonly presetColor : GradientPresetType; /** * @deprecated Please use the 'texture' property instead. * Represents the texture type for the specified fill. */ getTexture() : TextureType; /** * Represents the texture type for the specified fill. */ texture : TextureType; /** * @deprecated Please use the 'texture' property instead. * Represents the texture type for the specified fill. * @param value - The value to set. */ setTexture(value: TextureType) : void; /** * @deprecated Please use the 'pattern' property instead. * Represents an area's display pattern. */ getPattern() : FillPattern; /** * Represents an area's display pattern. */ pattern : FillPattern; /** * @deprecated Please use the 'pattern' property instead. * Represents an area's display pattern. * @param value - The value to set. */ setPattern(value: FillPattern) : void; /** * @deprecated Please use the 'pictureFormatType' property instead. * Gets and sets the picture format type. */ getPictureFormatType() : FillPictureType; /** * Gets and sets the picture format type. */ pictureFormatType : FillPictureType; /** * @deprecated Please use the 'pictureFormatType' property instead. * Gets and sets the picture format type. * @param value - The value to set. */ setPictureFormatType(value: FillPictureType) : void; /** * @deprecated Please use the 'scale' property instead. * Gets and sets the picture format scale. */ getScale() : number; /** * Gets and sets the picture format scale. */ scale : number; /** * @deprecated Please use the 'scale' property instead. * Gets and sets the picture format scale. * @param value - The value to set. */ setScale(value: number) : void; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets the picture image data. * * @remarks * If the fill format is not custom texture format, returns null. */ getImageData() : Uint8Array; /** * Gets and sets the picture image data. * * @remarks * If the fill format is not custom texture format, returns null. */ imageData : Uint8Array; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets the picture image data. * @param value - The value to set. * * @remarks * If the fill format is not custom texture format, returns null. */ setImageData(value: Uint8Array) : void; /** * Sets the specified fill to a one-color gradient. * Only applies for Excel 2007. * @param color - One gradient color. * @param degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light). * @param style - Gradient shading style. * @param variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ setOneColorGradient(color: Color, degree: number, style: GradientStyleType, variant: number) : void; /** * Sets the specified fill to a two-color gradient. * Only applies for Excel 2007. * @param color1 - One gradient color. * @param color2 - Two gradient color. * @param style - Gradient shading style. * @param variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ setTwoColorGradient(color1: Color, color2: Color, style: GradientStyleType, variant: number) : void; /** * Sets the specified fill to a two-color gradient. * Only applies for Excel 2007. * @param color1 - One gradient color. * @param transparency1 - The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear). * @param color2 - Two gradient color. * @param transparency2 - The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear). * @param style - Gradient shading style. * @param variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ setTwoColorGradient(color1: Color, transparency1: number, color2: Color, transparency2: number, style: GradientStyleType, variant: number) : void; /** * Sets the specified fill to a preset-color gradient. * Only applies for Excel 2007. * @param presetColor - Preset color type * @param style - Gradient shading style. * @param variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ setPresetColorGradient(presetColor: GradientPresetType, style: GradientStyleType, variant: number) : void; /** * @param obj - */ equals(obj: Object) : boolean; /** * Gets the hash code. */ getHashCode() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies a data model connection */ export class DataModelConnection extends ExternalConnection { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ExternalConnection); /** * Gets the type of this object. */ getClassType() : ExternalConnectionClassType; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data */ getCommand() : string; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data * @param value - The value to set. */ setCommand(value: string) : void; /** * Returns type. */ getCommandType() : OLEDBCommandType; /** * Returns type. * @param value - The value to set. */ setCommandType(value: OLEDBCommandType) : void; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. */ getConnectionString() : string; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. * @param value - The value to set. */ setConnectionString(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of external link. */ export enum ExternalLinkType { /** * Represents the DDE link. */ DDELink = 0, /** * Represents external link. */ External = 1, } /** * Represents the single TrueType font file stored in the file system. */ export class FileFontSource extends FontSourceBase { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FontSourceBase); /** * Ctor. * @param filePath - path to font file */ constructor(filePath: string); /** * @deprecated Please use the 'filePath' property instead. * Path to font file. */ getFilePath() : string; /** * Path to font file. */ readonly filePath : string; /** * Returns the type of the font source. */ getType() : FontSourceType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the folder that contains TrueType font files. */ export class FolderFontSource extends FontSourceBase { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FontSourceBase); /** * Ctor. * @param folderPath - path to fonts folder * @param scanSubfolders - Determines whether or not to scan subfolders. */ constructor(folderPath: string, scanSubfolders: boolean); /** * @deprecated Please use the 'folderPath' property instead. * Path to fonts folder. */ getFolderPath() : string; /** * Path to fonts folder. */ readonly folderPath : string; /** * @deprecated Please use the 'scanSubFolders' property instead. * Determines whether or not to scan the subfolders. */ getScanSubFolders() : boolean; /** * Determines whether or not to scan the subfolders. */ readonly scanSubFolders : boolean; /** * Returns the type of the font source. */ getType() : FontSourceType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies font settings */ export class FontConfigs { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'defaultFontName' property instead. * Gets or sets the default font name. */ static getDefaultFontName() : string; /** * Gets or sets the default font name. */ static defaultFontName : string; /** * @deprecated Please use the 'defaultFontName' property instead. * Gets or sets the default font name. * @param value - The value to set. */ static setDefaultFontName(value: string) : void; /** * @deprecated Please use the 'preferSystemFontSubstitutes' property instead. * Indicate whether to use system font substitutes first or not when a font is not presented and the substitute of this font is not set. * e.g. On Ubuntu, "Arial" font is generally substituted by "Liberation Sans". * Default value is false. */ static getPreferSystemFontSubstitutes() : boolean; /** * Indicate whether to use system font substitutes first or not when a font is not presented and the substitute of this font is not set. * e.g. On Ubuntu, "Arial" font is generally substituted by "Liberation Sans". * Default value is false. */ static preferSystemFontSubstitutes : boolean; /** * @deprecated Please use the 'preferSystemFontSubstitutes' property instead. * Indicate whether to use system font substitutes first or not when a font is not presented and the substitute of this font is not set. * e.g. On Ubuntu, "Arial" font is generally substituted by "Liberation Sans". * Default value is false. * @param value - The value to set. */ static setPreferSystemFontSubstitutes(value: boolean) : void; /** * Indicate whether the font is available. * @param fontName - font name * @returns * true if font is available, otherwise false. */ static isFontAvailable(fontName: string) : boolean; /** * Get data information of font file data. * @param fontName - font name * @param isBold - the font style is bold or not * @param isItalic - the font style is italic or not * @param isExactStyle - whether to match the given bold/italic style exactly * @returns * Data infomation of font file data. */ static getFontFileDataInfo(fontName: string, isBold: boolean, isItalic: boolean, isExactStyle: boolean) : FontFileDataInfo; /** * Font substitute names for given original font name. * @param originalFontName - Original font name. * @param substituteFontNames - List of font substitute names to be used if original font is not presented. */ static setFontSubstitutes(originalFontName: string, substituteFontNames: string[]) : void; /** * Returns an array containing font substitute names to be used if original font is not present. * @param originalFontName - originalFontName * @returns * An array containing font substitute names to be used if original font is not presented. */ static getFontSubstitutes(originalFontName: string) : string[]; /** * Sets the fonts folder * @param fontFolder - The folder that contains TrueType fonts. * @param recursive - Determines whether or not to scan subfolders. */ static setFontFolder(fontFolder: string, recursive: boolean) : void; /** * Sets the fonts folder * @param fontFolders - The folders that contains TrueType fonts. * @param recursive - Determines whether or not to scan subfolders. */ static setFontFolders(fontFolders: string[], recursive: boolean) : void; /** * Sets the font sources. * @param sources - An array of sources that contain TrueType fonts. */ static setFontSources(sources: FontSourceBase[]) : void; /** * Gets a copy of the array that contains the list of sources */ static getFontSources() : FontSourceBase[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This is an abstract base class for the classes that allow the user to specify various font sources */ export class FontSourceBase { /** * Returns the type of the font source. */ getType() : FontSourceType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the type of a font source. */ export enum FontSourceType { /** * represents a single font file. */ FontFile = 0, /** * Represents a folder with font files. */ FontsFolder = 1, /** * Represents a single font in memory. */ MemoryFont = 2, } /** * Font configs for each object. */ export class IndividualFontConfigs { /** * Ctor. */ constructor(); /** * Sets font substitute names for a given original font name. * @param originalFontName - Original font name. * @param substituteFontNames - List of font substitute names to be used if original font is not presented. */ setFontSubstitutes(originalFontName: string, substituteFontNames: string[]) : void; /** * Returns an array containing font substitute names to be used if original font is not presented. * @param originalFontName - originalFontName * @returns * An array containing font substitute names to be used if original font is not presented. */ getFontSubstitutes(originalFontName: string) : string[]; /** * Sets the fonts folder * @param fontFolder - The folder that contains TrueType fonts. * @param recursive - Determines whether or not to scan subfolders. */ setFontFolder(fontFolder: string, recursive: boolean) : void; /** * Sets the font folders * @param fontFolders - The folders that contains TrueType fonts. * @param recursive - Determines whether or not to scan subfolders. */ setFontFolders(fontFolders: string[], recursive: boolean) : void; /** * Sets the font sources. * @param sources - An array of sources that contain TrueType fonts. */ setFontSources(sources: FontSourceBase[]) : void; /** * Gets a copy of the array that contains the list of sources */ getFontSources() : FontSourceBase[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the single TrueType font file stored in memory. */ export class MemoryFontSource extends FontSourceBase { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FontSourceBase); /** * Ctor. * @param fontData - Binary font data. */ constructor(fontData: Uint8Array); /** * @deprecated Please use the 'fontData' property instead. * Binary font data. */ getFontData() : Uint8Array; /** * Binary font data. */ readonly fontData : Uint8Array; /** * Returns the type of the font source. */ getType() : FontSourceType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of loading JSON files */ export class JsonLoadOptions extends LoadOptions { /** * Creates an options of loading the file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * @deprecated Please use the 'startCell' property instead. * Gets and sets the start cell. */ getStartCell() : string; /** * Gets and sets the start cell. */ startCell : string; /** * @deprecated Please use the 'startCell' property instead. * Gets and sets the start cell. * @param value - The value to set. */ setStartCell(value: string) : void; /** * @deprecated Please use the 'layoutOptions' property instead. * The options of import json. */ getLayoutOptions() : JsonLayoutOptions; /** * The options of import json. */ layoutOptions : JsonLayoutOptions; /** * @deprecated Please use the 'layoutOptions' property instead. * The options of import json. * @param value - The value to set. */ setLayoutOptions(value: JsonLayoutOptions) : void; /** * @deprecated Please use the 'multipleWorksheets' property instead. * Indicates whether importing each attribute of JsonObject object as one worksheet when all child nodes are array nodes. */ getMultipleWorksheets() : boolean; /** * Indicates whether importing each attribute of JsonObject object as one worksheet when all child nodes are array nodes. */ multipleWorksheets : boolean; /** * @deprecated Please use the 'multipleWorksheets' property instead. * Indicates whether importing each attribute of JsonObject object as one worksheet when all child nodes are array nodes. * @param value - The value to set. */ setMultipleWorksheets(value: boolean) : void; /** * @deprecated Please use the 'keptSchema' property instead. * Indicates whether keeping schema of this json. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ getKeptSchema() : boolean; /** * Indicates whether keeping schema of this json. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ keptSchema : boolean; /** * @deprecated Please use the 'keptSchema' property instead. * Indicates whether keeping schema of this json. * @param value - The value to set. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ setKeptSchema(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of loading xml. */ export class XmlLoadOptions extends LoadOptions { /** * Represents the options of loading xml file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * Represents the options of loading xml file. * @param type - The load format type. */ constructor(type: LoadFormat); /** * @deprecated Please use the 'startCell' property instead. * Gets and sets the start cell. * * @remarks * Only works when the file is not speadsheetML or mapping xml to Excel. */ getStartCell() : string; /** * Gets and sets the start cell. * * @remarks * Only works when the file is not speadsheetML or mapping xml to Excel. */ startCell : string; /** * @deprecated Please use the 'startCell' property instead. * Gets and sets the start cell. * @param value - The value to set. * * @remarks * Only works when the file is not speadsheetML or mapping xml to Excel. */ setStartCell(value: string) : void; /** * Indicates whether mapping xml to Excel. * The default value is false. */ isXmlMap : boolean; /** * @deprecated Please use the 'isXmlMap' property instead. * Indicates whether mapping xml to Excel. * The default value is false. * @param value - The value to set. */ setIsXmlMap(value: boolean) : void; /** * @deprecated Please use the 'containsMultipleWorksheets' property instead. * Indicates whether importing xml as multiple worksheets. */ getContainsMultipleWorksheets() : boolean; /** * Indicates whether importing xml as multiple worksheets. */ containsMultipleWorksheets : boolean; /** * @deprecated Please use the 'containsMultipleWorksheets' property instead. * Indicates whether importing xml as multiple worksheets. * @param value - The value to set. */ setContainsMultipleWorksheets(value: boolean) : void; /** * @deprecated Please use the 'convertNumericOrDate' property instead. * Indicates whether converting the value in xml file to numeric or date. */ getConvertNumericOrDate() : boolean; /** * Indicates whether converting the value in xml file to numeric or date. */ convertNumericOrDate : boolean; /** * @deprecated Please use the 'convertNumericOrDate' property instead. * Indicates whether converting the value in xml file to numeric or date. * @param value - The value to set. */ setConvertNumericOrDate(value: boolean) : void; /** * @deprecated Please use the 'numberFormat' property instead. * Gets and sets the format of numeric value. */ get_NumberFormat() : string; /** * Gets and sets the format of numeric value. */ numberFormat : string; /** * @deprecated Please use the 'numberFormat' property instead. * Gets and sets the format of numeric value. * @param value - The value to set. */ setNumberFormat(value: string) : void; /** * @deprecated Please use the 'dateFormat' property instead. * Gets and sets the format of date value. */ get_DateFormat() : string; /** * Gets and sets the format of date value. */ dateFormat : string; /** * @deprecated Please use the 'dateFormat' property instead. * Gets and sets the format of date value. * @param value - The value to set. */ setDateFormat(value: string) : void; /** * @deprecated Please use the 'ignoreRootAttributes' property instead. * Indicates whether ignore attributes of the root element. */ getIgnoreRootAttributes() : boolean; /** * Indicates whether ignore attributes of the root element. */ ignoreRootAttributes : boolean; /** * @deprecated Please use the 'ignoreRootAttributes' property instead. * Indicates whether ignore attributes of the root element. * @param value - The value to set. */ setIgnoreRootAttributes(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the scope type of defined names. */ export enum NameScopeType { /** * All defined names. */ All = 0, /** * The defined names in the workbook. */ Workbook = 1, /** * The defined names in a worksheet or all worksheets. */ Worksheet = 2, } /** * Represents the operation type when pasting a range. */ export enum PasteOperationType { /** * No operation. */ None = 0, /** * Add */ Add = 1, /** * Subtract */ Subtract = 2, /** * Multiply */ Multiply = 3, /** * Divide */ Divide = 4, } /** * Represents the options of saving the workbook as a JSON file. */ export class JsonSaveOptions extends SaveOptions { /** * Creates options for saving json file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'exportStylePool' property instead. * Indicates whether to export styles collectively or individually to each cell. */ getExportStylePool() : boolean; /** * Indicates whether to export styles collectively or individually to each cell. */ exportStylePool : boolean; /** * @deprecated Please use the 'exportStylePool' property instead. * Indicates whether to export styles collectively or individually to each cell. * @param value - The value to set. */ setExportStylePool(value: boolean) : void; /** * @deprecated Please use the 'exportHyperlinkType' property instead. * Represents the type of exporting hyperlink to json. * * @remarks * The default value is ; */ getExportHyperlinkType() : JsonExportHyperlinkType; /** * Represents the type of exporting hyperlink to json. * * @remarks * The default value is ; */ exportHyperlinkType : JsonExportHyperlinkType; /** * @deprecated Please use the 'exportHyperlinkType' property instead. * Represents the type of exporting hyperlink to json. * @param value - The value to set. * * @remarks * The default value is ; */ setExportHyperlinkType(value: JsonExportHyperlinkType) : void; /** * @deprecated Please use the 'skipEmptyRows' property instead. * Indicates whether skipping emtpy rows. */ getSkipEmptyRows() : boolean; /** * Indicates whether skipping emtpy rows. */ skipEmptyRows : boolean; /** * @deprecated Please use the 'skipEmptyRows' property instead. * Indicates whether skipping emtpy rows. * @param value - The value to set. */ setSkipEmptyRows(value: boolean) : void; /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. */ getSheetIndexes() : number[]; /** * Represents the indexes of exported sheets. */ sheetIndexes : number[]; /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. * @param value - The value to set. */ setSheetIndexes(value: number[]) : void; /** * @deprecated Please use the 'schemas' property instead. * The original json schema of each worksheet. */ getSchemas() : string[]; /** * The original json schema of each worksheet. */ schemas : string[]; /** * @deprecated Please use the 'schemas' property instead. * The original json schema of each worksheet. * @param value - The value to set. */ setSchemas(value: string[]) : void; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. */ getExportArea() : CellArea; /** * Gets or sets the exporting range. */ exportArea : CellArea; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. * @param value - The value to set. */ setExportArea(value: CellArea) : void; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. */ getHasHeaderRow() : boolean; /** * Indicates whether the range contains header row. */ hasHeaderRow : boolean; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. * @param value - The value to set. */ setHasHeaderRow(value: boolean) : void; /** * @deprecated Please use the 'exportAsString' property instead. * Exports the string value of the cells to json. */ getExportAsString() : boolean; /** * Exports the string value of the cells to json. */ exportAsString : boolean; /** * @deprecated Please use the 'exportAsString' property instead. * Exports the string value of the cells to json. * @param value - The value to set. */ setExportAsString(value: boolean) : void; /** * @deprecated Please use the 'indent' property instead. * Indicates the indent. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ getIndent() : string; /** * Indicates the indent. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ indent : string; /** * @deprecated Please use the 'indent' property instead. * Indicates the indent. * @param value - The value to set. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ setIndent(value: string) : void; /** * @deprecated Please use the 'exportNestedStructure' property instead. * Exported as parent-child hierarchy Json structure. * * @remarks */ getExportNestedStructure() : boolean; /** * Exported as parent-child hierarchy Json structure. * * @remarks */ exportNestedStructure : boolean; /** * @deprecated Please use the 'exportNestedStructure' property instead. * Exported as parent-child hierarchy Json structure. * @param value - The value to set. * * @remarks */ setExportNestedStructure(value: boolean) : void; /** * @deprecated Please use the 'exportEmptyCells' property instead. * Indicates whether exporting empty cells as null. */ getExportEmptyCells() : boolean; /** * Indicates whether exporting empty cells as null. */ exportEmptyCells : boolean; /** * @deprecated Please use the 'exportEmptyCells' property instead. * Indicates whether exporting empty cells as null. * @param value - The value to set. */ setExportEmptyCells(value: boolean) : void; /** * @deprecated Please use the 'alwaysExportAsJsonObject' property instead. * Indicates whether always exporting excel to json as object, even there is only a worksheet in the file. */ getAlwaysExportAsJsonObject() : boolean; /** * Indicates whether always exporting excel to json as object, even there is only a worksheet in the file. */ alwaysExportAsJsonObject : boolean; /** * @deprecated Please use the 'alwaysExportAsJsonObject' property instead. * Indicates whether always exporting excel to json as object, even there is only a worksheet in the file. * @param value - The value to set. */ setAlwaysExportAsJsonObject(value: boolean) : void; /** * @deprecated Please use the 'toExcelStruct' property instead. * Indicates whether converting to json struct of the Excel file. * * @remarks * Only for converting range to JSON. */ getToExcelStruct() : boolean; /** * Indicates whether converting to json struct of the Excel file. * * @remarks * Only for converting range to JSON. */ toExcelStruct : boolean; /** * @deprecated Please use the 'toExcelStruct' property instead. * Indicates whether converting to json struct of the Excel file. * @param value - The value to set. * * @remarks * Only for converting range to JSON. */ setToExcelStruct(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents column type map. */ export class SqlScriptColumnTypeMap { /** * Default Constructor. */ constructor(); /** * Gets string type in the database. */ getStringType() : string; /** * Gets numeric type in the database. */ getNumbericType() : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of operating data. */ export enum SqlScriptOperatorType { /** * Insert data. */ Insert = 0, /** * Update data. */ Update = 1, /** * Delete data. */ Delete = 2, } /** * Represents the options of saving sql. */ export class SqlScriptSaveOptions extends SaveOptions { /** * Creates options for saving sql file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'checkIfTableExists' property instead. * Check if the table name exists before creating */ getCheckIfTableExists() : boolean; /** * Check if the table name exists before creating */ checkIfTableExists : boolean; /** * @deprecated Please use the 'checkIfTableExists' property instead. * Check if the table name exists before creating * @param value - The value to set. */ setCheckIfTableExists(value: boolean) : void; /** * @deprecated Please use the 'columnTypeMap' property instead. * Gets and sets the map of column type for different database. */ getColumnTypeMap() : SqlScriptColumnTypeMap; /** * Gets and sets the map of column type for different database. */ columnTypeMap : SqlScriptColumnTypeMap; /** * @deprecated Please use the 'columnTypeMap' property instead. * Gets and sets the map of column type for different database. * @param value - The value to set. */ setColumnTypeMap(value: SqlScriptColumnTypeMap) : void; /** * @deprecated Please use the 'checkAllDataForColumnType' property instead. * Check all data to find columns' data type. * * @remarks * The default value is false, we only check the first row for performance. * If this property is true and the columns contains mixed value type, the columns' type will be text. */ getCheckAllDataForColumnType() : boolean; /** * Check all data to find columns' data type. * * @remarks * The default value is false, we only check the first row for performance. * If this property is true and the columns contains mixed value type, the columns' type will be text. */ checkAllDataForColumnType : boolean; /** * @deprecated Please use the 'checkAllDataForColumnType' property instead. * Check all data to find columns' data type. * @param value - The value to set. * * @remarks * The default value is false, we only check the first row for performance. * If this property is true and the columns contains mixed value type, the columns' type will be text. */ setCheckAllDataForColumnType(value: boolean) : void; /** * @deprecated Please use the 'addBlankLineBetweenRows' property instead. * Insert blank line between each data. * * @remarks * If is '\n' , it's better to set this property as true to increase readability. */ getAddBlankLineBetweenRows() : boolean; /** * Insert blank line between each data. * * @remarks * If is '\n' , it's better to set this property as true to increase readability. */ addBlankLineBetweenRows : boolean; /** * @deprecated Please use the 'addBlankLineBetweenRows' property instead. * Insert blank line between each data. * @param value - The value to set. * * @remarks * If is '\n' , it's better to set this property as true to increase readability. */ setAddBlankLineBetweenRows(value: boolean) : void; /** * @deprecated Please use the 'separator' property instead. * Gets and sets character separator of sql script. * * @remarks * Only can be ' ' or '\n'. * If the */ getSeparator() : string; /** * Gets and sets character separator of sql script. * * @remarks * Only can be ' ' or '\n'. * If the */ separator : string; /** * @deprecated Please use the 'separator' property instead. * Gets and sets character separator of sql script. * @param value - The value to set. * * @remarks * Only can be ' ' or '\n'. * If the */ setSeparator(value: string) : void; /** * @deprecated Please use the 'operatorType' property instead. * Gets and sets the operator type of sql. */ getOperatorType() : SqlScriptOperatorType; /** * Gets and sets the operator type of sql. */ operatorType : SqlScriptOperatorType; /** * @deprecated Please use the 'operatorType' property instead. * Gets and sets the operator type of sql. * @param value - The value to set. */ setOperatorType(value: SqlScriptOperatorType) : void; /** * @deprecated Please use the 'primaryKey' property instead. * Represents which column is primary key of the data table. */ getPrimaryKey() : number; /** * Represents which column is primary key of the data table. */ primaryKey : number; /** * @deprecated Please use the 'primaryKey' property instead. * Represents which column is primary key of the data table. * @param value - The value to set. */ setPrimaryKey(value: number) : void; /** * @deprecated Please use the 'createTable' property instead. * Indicates whether exporting sql of creating table. */ getCreateTable() : boolean; /** * Indicates whether exporting sql of creating table. */ createTable : boolean; /** * @deprecated Please use the 'createTable' property instead. * Indicates whether exporting sql of creating table. * @param value - The value to set. */ setCreateTable(value: boolean) : void; /** * @deprecated Please use the 'idName' property instead. * Gets and sets the name of id column. * * @remarks * If this property is set , a column will be inserted with automatical increment int value. */ getIdName() : string; /** * Gets and sets the name of id column. * * @remarks * If this property is set , a column will be inserted with automatical increment int value. */ idName : string; /** * @deprecated Please use the 'idName' property instead. * Gets and sets the name of id column. * @param value - The value to set. * * @remarks * If this property is set , a column will be inserted with automatical increment int value. */ setIdName(value: string) : void; /** * @deprecated Please use the 'startId' property instead. * Gets and sets the start id. * * @remarks * Only works when is set. */ getStartId() : number; /** * Gets and sets the start id. * * @remarks * Only works when is set. */ startId : number; /** * @deprecated Please use the 'startId' property instead. * Gets and sets the start id. * @param value - The value to set. * * @remarks * Only works when is set. */ setStartId(value: number) : void; /** * @deprecated Please use the 'tableName' property instead. * Gets and sets the table name. */ getTableName() : string; /** * Gets and sets the table name. */ tableName : string; /** * @deprecated Please use the 'tableName' property instead. * Gets and sets the table name. * @param value - The value to set. */ setTableName(value: string) : void; /** * @deprecated Please use the 'exportAsString' property instead. * Indicates whether exporting all data as string value. */ getExportAsString() : boolean; /** * Indicates whether exporting all data as string value. */ exportAsString : boolean; /** * @deprecated Please use the 'exportAsString' property instead. * Indicates whether exporting all data as string value. * @param value - The value to set. */ setExportAsString(value: boolean) : void; /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. */ getSheetIndexes() : number[]; /** * Represents the indexes of exported sheets. */ sheetIndexes : number[]; /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. * @param value - The value to set. */ setSheetIndexes(value: number[]) : void; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. */ getExportArea() : CellArea; /** * Gets or sets the exporting range. */ exportArea : CellArea; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. * @param value - The value to set. */ setExportArea(value: CellArea) : void; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. */ getHasHeaderRow() : boolean; /** * Indicates whether the range contains header row. */ hasHeaderRow : boolean; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. * @param value - The value to set. */ setHasHeaderRow(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of saving the workbook as an xml file. */ export class XmlSaveOptions extends SaveOptions { /** * Creates options for saving xml file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. */ getSheetIndexes() : number[]; /** * Represents the indexes of exported sheets. */ sheetIndexes : number[]; /** * @deprecated Please use the 'sheetIndexes' property instead. * Represents the indexes of exported sheets. * @param value - The value to set. */ setSheetIndexes(value: number[]) : void; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. */ getExportArea() : CellArea; /** * Gets or sets the exporting range. */ exportArea : CellArea; /** * @deprecated Please use the 'exportArea' property instead. * Gets or sets the exporting range. * @param value - The value to set. */ setExportArea(value: CellArea) : void; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. */ getHasHeaderRow() : boolean; /** * Indicates whether the range contains header row. */ hasHeaderRow : boolean; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. * @param value - The value to set. */ setHasHeaderRow(value: boolean) : void; /** * @deprecated Please use the 'xmlMapName' property instead. * Indicates whether exporting xml map in the file. */ getXmlMapName() : string; /** * Indicates whether exporting xml map in the file. */ xmlMapName : string; /** * @deprecated Please use the 'xmlMapName' property instead. * Indicates whether exporting xml map in the file. * @param value - The value to set. */ setXmlMapName(value: string) : void; /** * @deprecated Please use the 'sheetNameAsElementName' property instead. * Indicates whether exporting sheet's name as the name of the element. */ getSheetNameAsElementName() : boolean; /** * Indicates whether exporting sheet's name as the name of the element. */ sheetNameAsElementName : boolean; /** * @deprecated Please use the 'sheetNameAsElementName' property instead. * Indicates whether exporting sheet's name as the name of the element. * @param value - The value to set. */ setSheetNameAsElementName(value: boolean) : void; /** * @deprecated Please use the 'dataAsAttribute' property instead. * Indicates whether exporting data as attributes of element. */ getDataAsAttribute() : boolean; /** * Indicates whether exporting data as attributes of element. */ dataAsAttribute : boolean; /** * @deprecated Please use the 'dataAsAttribute' property instead. * Indicates whether exporting data as attributes of element. * @param value - The value to set. */ setDataAsAttribute(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the globalization settings for pivot tables. */ export class PivotGlobalizationSettings { /** * Default Constructor. */ constructor(); /** * Gets the text of "Total" label in the PivotTable. * You need to override this method when the PivotTable contains two or more PivotFields in the data area. * @returns * The text of "Total" label */ getTextOfTotal() : string; /** * Gets the text of "Grand Total" label in the PivotTable. * @returns * The text of "Grand Total" label */ getTextOfGrandTotal() : string; /** * Gets the text of "(Multiple Items)" label in the PivotTable. * @returns * The text of "(Multiple Items)" label */ getTextOfMultipleItems() : string; /** * Gets the text of "(All)" label in the PivotTable. * @returns * The text of "(All)" label */ getTextOfAll() : string; /** * Gets the text for specified protected name. * @param protectedName - The protected name in PivotTable. * @returns * The local prorected names of PivotTable. * * @remarks * In Ms Excel, some names are not allowed to be used as the name of PivotFields in PivotTable. * They are different in different region, user may specify them explicitly according to the used region. */ getTextOfProtectedName(protectedName: string) : string; /** * Gets the text of "Column Labels" label in the PivotTable. * @returns * The text of column labels */ getTextOfColumnLabels() : string; /** * Gets the text of "Row Labels" label in the PivotTable. * @returns * The text of row labels */ getTextOfRowLabels() : string; /** * Gets the text of "(blank)" label in the PivotTable. * @returns * The text of empty data */ getTextOfEmptyData() : string; /** * Gets the the text of the value area field header in the PivotTable. * @returns * The text of data field header name */ getTextOfDataFieldHeader() : string; /** * Gets all short formatted string of 12 months. */ getShortTextOf12Months() : string[]; /** * Gets the local text of 4 Quaters. */ getTextOf4Quaters() : string[]; /** * Gets the local text of "Years". */ getTextOfYears() : string; /** * Get the local text of "Quarters". */ getTextOfQuarters() : string; /** * Gets the local text of "Months". */ getTextOfMonths() : string; /** * Gets the local text of "Days". */ getTextOfDays() : string; /** * Gets the local text of "Hours". */ getTextOfHours() : string; /** * Gets the local text of "Minutes". */ getTextOfMinutes() : string; /** * Gets the local text of "Seconds" */ getTextOfSeconds() : string; /** * Gets the local text of "Range" */ getTextOfRange() : string; /** * Gets the localized text of "All Periods". */ getTextOfAllPeriods() : string; /** * Gets the display name of data pivot field. * The default format is "Sum Of Field". * @param consolidationFunction - The function is used to summarize values of pivot field. * @param name - The original name of the pivot field. */ getNameOfDataField(consolidationFunction: ConsolidationFunction, name: string) : string; /** * Gets the text of type in the PivotTable. * @param subTotalType - The * @returns * The text of given type */ getTextOfSubTotal(subTotalType: PivotFieldSubtotalType) : string; } /** * Implementation of PivotGlobalizationSettings that supports user to set/change pre-defined texts. */ export class SettableChartGlobalizationSettings { /** * Default Constructor. */ constructor(); /** * Gets the name of Series in the Chart. */ getSeriesName() : string; /** * Sets the name of Series in the Chart. * @param name - local dependent name */ setSeriesName(name: string) : void; /** * Gets the name of Chart Title. */ getChartTitleName() : string; /** * Sets the name of Chart Title. * @param name - local dependent name */ setChartTitleName(name: string) : void; /** * Gets the name of increase for Legend. */ getLegendIncreaseName() : string; /** * Sets the name of increase for Legend. * @param name - local dependent name */ setLegendIncreaseName(name: string) : void; /** * Gets the name of Decrease for Legend. */ getLegendDecreaseName() : string; /** * Sets the name of Decrease for Legend. * @param name - local dependent name */ setLegendDecreaseName(name: string) : void; /** * Gets the name of Total for Legend. */ getLegendTotalName() : string; /** * Sets the name of Total for Legend. * @param name - local dependent name */ setLegendTotalName(name: string) : void; /** * Gets the name of Title for Axis. */ getAxisTitleName() : string; /** * Sets the name of Title for Axis. * @param name - local dependent name */ setAxisTitleName(name: string) : void; /** * Gets the name of "Other" labels for Chart. */ getOtherName() : string; /** * Sets the name of "Other" labels for Chart. * @param name - local dependent name */ setOtherName(name: string) : void; /** * Gets the Name of Axis Unit. */ getAxisUnitName(type: DisplayUnitType) : string; /** * Sets the Name of Axis Unit. * @param type - The unit type for displaying axis labels. * @param name - local dependent name */ setAxisUnitName(type: DisplayUnitType, name: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation of GlobalizationSettings that supports user to set/change pre-defined texts. */ export class SettableGlobalizationSettings { /** * Default Constructor. */ constructor(); /** * Gets the separator for list, parameters of function, ...etc. */ getListSeparator() : string; /** * Gets the separator for rows in array data in formula. */ getRowSeparatorOfFormulaArray() : string; /** * Gets the separator for the items in array's row data in formula. */ getColumnSeparatorOfFormulaArray() : string; /** * Gets the total name of specific function. * @param functionType - The function type. * @returns * The total name of the function. */ getTotalName(functionType: ConsolidationFunction) : string; /** * Sets the total name of specific function. * @param functionType - The function type. * @param name - The total name of the function. */ setTotalName(functionType: ConsolidationFunction, name: string) : void; /** * Gets the grand total name of the function. * @param functionType - The function type. * @returns * The grand total name of the function. */ getGrandTotalName(functionType: ConsolidationFunction) : string; /** * Sets the grand total name of specific function. * @param functionType - The function type. * @param name - The grand total name of the function. */ setGrandTotalName(functionType: ConsolidationFunction, name: string) : void; /** * Gets the type name of table rows that consists of the table header. * Default is "Headers", so in formula "#Headers" represents the table header. * @returns * the type name of table rows */ getTableRowTypeOfHeaders() : string; /** * Sets the type name of table rows that consists of the table header. * @param name - the type name of table rows */ setTableRowTypeOfHeaders(name: string) : void; /** * Gets the type name of table rows that consists of data region of referenced table. * Default is "Data", so in formula "#Data" represents the data region of the table. * @returns * the type name of table rows */ getTableRowTypeOfData() : string; /** * Sets the type name of table rows that consists of data region of referenced table. * @param name - the type name of table rows */ setTableRowTypeOfData(name: string) : void; /** * Gets the type name of table rows that consists of all rows in referenced table. * @returns * the type name of table rows */ getTableRowTypeOfAll() : string; /** * Sets the type name of table rows that consists of all rows in referenced table. * @param name - the type name of table rows */ setTableRowTypeOfAll(name: string) : void; /** * Gets the type name of table rows that consists of the total row of referenced table. * @returns * the type name of table rows */ getTableRowTypeOfTotals() : string; /** * Sets the type name of table rows that consists of the total row of referenced table. * @param name - the type name of table rows */ setTableRowTypeOfTotals(name: string) : void; /** * Gets the type name of table rows that consists of the current row in referenced table. * @returns * the type name of table rows */ getTableRowTypeOfCurrent() : string; /** * Sets the type name of table rows that consists of the current row in referenced table. * @param name - the type name of table rows */ setTableRowTypeOfCurrent(name: string) : void; /** * Gets the display string value for cell's error value * @param err - error values such as #VALUE!,#NAME? * @returns * By default returns the error value itself */ getErrorValueString(err: string) : string; /** * Gets the display string value for cell's boolean value * @param bv - boolean value * @returns * By default returns "TRUE" for true value and "FALSE" for false value. */ getBooleanValueString(bv: boolean) : string; /** * Sets the display string value for cell's boolean value * @param bv - boolean value * @param name - string value of the boolean value */ setBooleanValueString(bv: boolean, name: string) : void; /** * Gets the locale dependent function name according to given standard function name. * @param standardName - Standard(en-US locale) function name. * @returns * Locale dependent function name. The locale was specified by the Workbook for which this settings is used. */ getLocalFunctionName(standardName: string) : string; /** * Sets the locale dependent function name corresponding to given standard function name. * @param standardName - Standard(en-US locale) function name. * @param localName - Locale dependent function name * @param bidirectional - Whether map the local function name to standard function name automatically. /// If true, the local name will be mapped to standard name automatically /// so user does not need to call again /// for the same standard and local names pair */ setLocalFunctionName(standardName: string, localName: string, bidirectional: boolean) : void; /** * Gets the standard function name according to given locale dependent function name. * @param localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used. * @returns * Standard(en-US locale) function name. */ getStandardFunctionName(localName: string) : string; /** * Sets the locale dependent function name according to given standard function name. * @param localName - Locale dependent function name * @param standardName - Standard(en-US locale) function name. * @param bidirectional - Whether map the standard function name to local function name automatically. /// If true, the standar name will be mapped to local name automatically /// so user does not need to call again /// for the same standard and local names pair */ setStandardFunctionName(localName: string, standardName: string, bidirectional: boolean) : void; /** * Gets the locale dependent text for built-in Name according to given standard text. * @param standardName - Standard(en-US locale) text of built-in Name. * @returns * Locale dependent text. The locale was specified by the Workbook for which this settings is used. */ getLocalBuiltInName(standardName: string) : string; /** * Sets the locale dependent text for the built-in name with given standard name text. * @param standardName - Standard(en-US locale) name text of built-in name. * @param localName - Locale dependent name text * @param bidirectional - Whether map the local name text to standard name text automatically. /// If true, the local name text will be mapped to standard name text automatically /// so user does not need to call again /// for the same standard and local names pair */ setLocalBuiltInName(standardName: string, localName: string, bidirectional: boolean) : void; /** * Gets the standard text of built-in Name according to given locale dependent text. * @param localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used. * @returns * Standard(en-US locale) text. */ getStandardBuiltInName(localName: string) : string; /** * Sets the locale dependent function name according to given standard function name. * @param localName - Locale dependent function name * @param standardName - Standard(en-US locale) function name. * @param bidirectional - Whether map the standard name text to local name text automatically. /// If true, the standar name text will be mapped to local name text automatically /// so user does not need to call again /// for the same standard and local names pair */ setStandardBuiltInName(localName: string, standardName: string, bidirectional: boolean) : void; /** * Sets the separator for list, parameters of function, ...etc. * @param c - the specified separator */ setListSeparator(c: string) : void; /** * Sets the separator for rows in array data in formula. * @param c - the specified separator */ setRowSeparatorOfFormulaArray(c: string) : void; /** * Sets the separator for the items in array's row data in formula. * @param c - the specified separator */ setColumnSeparatorOfFormulaArray(c: string) : void; /** * Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name. * @param localfontStyleName - Locale font style name for Header/Footer. * @returns * Standard English font style name(Regular, Bold, Italic) */ getStandardHeaderFooterFontStyleName(localfontStyleName: string) : string; /** * Sets the locale dependent function name according to given standard function name. * @param localfontStyleName - Locale font style name for Header/Footer. * @param standardName - Standard(en-US locale) function name. */ setStandardHeaderFooterFontStyleName(localfontStyleName: string, standardName: string) : void; /** * Gets the locale dependent comment title name according to comment title type. * @param type - type of comment title * @returns * locale dependent comment title name */ getCommentTitleName(type: CommentTitleType) : string; /** * Gets the locale dependent comment title name according to comment title type. * @param type - type of comment title * @param name - locale dependent comment title name */ setCommentTitleName(type: CommentTitleType, name: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Implementation of PivotGlobalizationSettings that supports user to set/change pre-defined texts. */ export class SettablePivotGlobalizationSettings { /** * Default Constructor. */ constructor(); /** * Gets the text of "Total" label in the PivotTable. * You need to override this method when the PivotTable contains two or more PivotFields in the data area. * @returns * The text of "Total" label */ getTextOfTotal() : string; /** * Sets the text of "Total" label in the PivotTable. * @param text - custom text */ setTextOfTotal(text: string) : void; /** * Gets the text of "Grand Total" label in the PivotTable. * @returns * The text of "Grand Total" label */ getTextOfGrandTotal() : string; /** * Sets the text of "Grand Total" label in the PivotTable. * @param text - custom text */ setTextOfGrandTotal(text: string) : void; /** * Gets the text of "(Multiple Items)" label in the PivotTable. * @returns * The text of "(Multiple Items)" label */ getTextOfMultipleItems() : string; /** * Sets the text of "(Multiple Items)" label in the PivotTable. * @param text - custom text */ setTextOfMultipleItems(text: string) : void; /** * Gets the text of "(All)" label in the PivotTable. * @returns * The text of "(All)" label */ getTextOfAll() : string; /** * Sets the text of "(All)" label in the PivotTable. * @param text - custom text */ setTextOfAll(text: string) : void; /** * Gets the text for specified protected name. * @param protectedName - The protected name in PivotTable. * @returns * The local prorected names of PivotTable. * * @remarks * In Ms Excel, some names are not allowed to be used as the name of PivotFields in PivotTable. * They are different in different region, user may specify them explicitly according to the used region. */ getTextOfProtectedName(protectedName: string) : string; /** * Sets the text for specific protected name. * @param protectedName - The protected name in PivotTable. * @param text - The local prorected names of PivotTable. */ setTextOfProtectedName(protectedName: string, text: string) : void; /** * Gets the text of "Column Labels" label in the PivotTable. * @returns * The text of column labels */ getTextOfColumnLabels() : string; /** * Gets the text of "Column Labels" label in the PivotTable. * @param text - The text of column labels */ setTextOfColumnLabels(text: string) : void; /** * Gets the text of "Row Labels" label in the PivotTable. * @returns * The text of row labels */ getTextOfRowLabels() : string; /** * Sets the text of "Row Labels" label in the PivotTable. * @param text - The text of row labels */ setTextOfRowLabels(text: string) : void; /** * Gets the text of "(blank)" label in the PivotTable. * @returns * The text of empty data */ getTextOfEmptyData() : string; /** * Sets the text of "(blank)" label in the PivotTable. * @param text - The text of empty data */ setTextOfEmptyData(text: string) : void; /** * Gets the the text of the value area field header in the PivotTable. * @returns * The text of data field header name */ getTextOfDataFieldHeader() : string; /** * Sets the the text of the value area field header in the PivotTable. * @param text - The text of data field header name */ setTextOfDataFieldHeader(text: string) : void; /** * Gets the text of type in the PivotTable. * @param subTotalType - The * @returns * The text of given type */ getTextOfSubTotal(subTotalType: PivotFieldSubtotalType) : string; /** * Sets the text of type in the PivotTable. * @param subTotalType - The * @param text - The text of given type */ setTextOfSubTotal(subTotalType: PivotFieldSubtotalType, text: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of significant digits for outputting numeric values. */ export enum SignificantDigitsType { /** * 15-digits */ Digits15 = 0, /** * 17-digits by formatting the value with "G17". * * @remarks * For some double values, "G17" may given different value than the * original/literal one input by user. * For example, double value 0.15 will be output as 0.14999999999999999; * double value 1.0E-16 will be output as 9.9999999999999998E-17. * Ms excel's handles those values inconsistently, it saves 0.15 as 0.15 * in the xlsx file, but for 1.0E-16 the saved value in the xlsx file is * 9.9999999999999998E-17. */ G17 = 1, /** * 17-digits by rounding the value. * * @remarks * This type generally outputs the value as the original/literal one input by user. * For 0.15 it produces "0.15" and for 1.0E-16 it produces "1.0E-16". * But there are also some special cases which may give different values than the literal. * For example, when rounding 208435494.96478021 to 17-digits("0.#################"), * the output is 208435494.96478. */ Rounding17 = 2, } /** * Represent the type how to show items with no data for slicer. */ export enum ItemsWithNoDataShowMode { /** * Hide items with no data. */ None = 0, /** * Show items with no data last. */ Last = 1, /** * Show items with no data with natural order. */ Natural = 2, } /** * Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells. * * @remarks * User should not modify any part of the Workbook directly in this implementation(except * the calculated result of the custom function, which can be set by CalculationData.CalculatedValue property). * Otherwise unexpected result or Exception may be caused. * If user needs to change other data than calculated result in the implementation for some custom functions, * for example, change cell's formula, style, ...etc., user should gather those data in this implementation * and change them out of the scope of formula calculation. */ export abstract class AbstractCalculationEngine { /** * Indicates whether this engine needs the literal text of the parameter while doing a calculation. * Default value is false. * * @remarks * If this custom calculation engine needs the parameter's literal text, * more stacks will be required to cache the literal text for parameters * and Calculate() method may be called recursively to calculate the parameter's value. * Generally the literal text is not needed for calculating formulas * and this property should be kept as false for most implementations to get better performance. */ isParamLiteralRequired() : boolean; /** * Indicates whether this engine needs the parameter to be calculated in array mode. Default value is false. * If is required when calculating custom * functions and user has not updated the definition for them * (by ), * this property needs to be set as true. * * @remarks * If this custom calculation engine needs the parameter to be calculated in array mode, * more stacks will be required to cache the tree for parameters * and Calculate() method may be called recursively to calculate the parameter's value. * For performance consideration, please keep this property as the default value(false) * if there is no special requirement. */ isParamArrayModeRequired() : boolean; /** * Whether built-in functions that have been supported by the built-in engine * should be checked and processed by this implementation. * Default is false. * * @remarks * If user needs to change the calculation logic of some built-in functions, this property should be set as true. * Otherwise please leave this property as false for performance consideration. */ getProcessBuiltInFunctions() : boolean; /** * Calculates one function with given data. * @param data - the required data to calculate function such as function name, parameters, ...etc. * * @remarks * User should set the calculated value for given data for all functions(including excel native functions) * that he wants to calculate by himself in this implementation. */ abstract calculate(data: CalculationData) : void; /** * Whether to force the given function to be recalculated always when calculating shared formulas. * @param functionName - name of the function. Generally it is custom function's name. /// If is true, then built-in functions will also be checked here. * @returns * true if the specified function needs to be recalculated always. * * @remarks * For shared formulas, multiple cells share the same function. * If the function's parameters keep same for those cells too, then generally this function needs to be calculated only once. * So for performance consideration we only calculate such kind of function once too( * is called only once, instead of being called repeatedly for every cell). * However, for user's custom implementation, maybe the function, especially the custom function, * needs to be calculated differently for different cells. * If so, user needs to override this method to make it return true for the function. * And for , the given * may have been initialized with the cached value of previous calculation. */ forceRecalculate(functionName: string) : boolean; /** * Skips the calculation for the entire formula that references the function currently under evaluation. * * @remarks * This method can be invoked in the implementation of * to skip the calculation for the entire formula and the original value of the formula will be kept without change. */ skipCalculation() : void; } /** * Represents the required data when calculating one function, such as function name, parameters, ...etc. * * @remarks * All objects provided by this class are for "read" purpose only. * User should not change any data in the Workbook during the formula calculation process, * Otherwise unexpected result or Exception may be caused. */ export class CalculationData { /** * @deprecated Please use the 'calculatedValue' property instead. * Gets or sets the calculated value for this function. * * @remarks * User should set this property in his custom calculation engine for those functions the engine supports, * and the set value will be returned when getting this property later. * The set value may be of possible types of , * or array of such kind of values, or a Range, Name, ReferredArea. * Getting this property before setting value to it will make the function be calculated * by the default calculation engine of Aspose.Cells and then the calculated value will * be returned(generally it should be #NAME? for user-defined functions). */ getCalculatedValue() : Object; /** * Gets or sets the calculated value for this function. * * @remarks * User should set this property in his custom calculation engine for those functions the engine supports, * and the set value will be returned when getting this property later. * The set value may be of possible types of , * or array of such kind of values, or a Range, Name, ReferredArea. * Getting this property before setting value to it will make the function be calculated * by the default calculation engine of Aspose.Cells and then the calculated value will * be returned(generally it should be #NAME? for user-defined functions). */ calculatedValue : Object; /** * @deprecated Please use the 'calculatedValue' property instead. * Gets or sets the calculated value for this function. * @param value - The value to set. * * @remarks * User should set this property in his custom calculation engine for those functions the engine supports, * and the set value will be returned when getting this property later. * The set value may be of possible types of , * or array of such kind of values, or a Range, Name, ReferredArea. * Getting this property before setting value to it will make the function be calculated * by the default calculation engine of Aspose.Cells and then the calculated value will * be returned(generally it should be #NAME? for user-defined functions). */ setCalculatedValue(value: Object) : void; /** * @deprecated Please use the 'workbook' property instead. * Gets the Workbook object where the function is. */ getWorkbook() : Workbook; /** * Gets the Workbook object where the function is. */ readonly workbook : Workbook; /** * @deprecated Please use the 'worksheet' property instead. * Gets the Worksheet object where the function is. */ getWorksheet() : Worksheet; /** * Gets the Worksheet object where the function is. */ readonly worksheet : Worksheet; /** * @deprecated Please use the 'cellRow' property instead. * Gets the row index of the cell where the function is. */ getCellRow() : number; /** * Gets the row index of the cell where the function is. */ readonly cellRow : number; /** * @deprecated Please use the 'cellColumn' property instead. * Gets the column index of the cell where the function is. */ getCellColumn() : number; /** * Gets the column index of the cell where the function is. */ readonly cellColumn : number; /** * @deprecated Please use the 'cell' property instead. * Gets the Cell object where the function is. * * @remarks * When calculating a formula without setting it to a cell, * such as by , * the formula will be calculated just like it has been set to cell A1, * so both and are 0. * However, cell A1 in the worksheet may has not been instantiated. * So for such kind of situation this property will be null. */ getCell() : Cell; /** * Gets the Cell object where the function is. * * @remarks * When calculating a formula without setting it to a cell, * such as by , * the formula will be calculated just like it has been set to cell A1, * so both and are 0. * However, cell A1 in the worksheet may has not been instantiated. * So for such kind of situation this property will be null. */ readonly cell : Cell; /** * @deprecated Please use the 'functionName' property instead. * Gets the function name to be calculated. */ getFunctionName() : string; /** * Gets the function name to be calculated. */ readonly functionName : string; /** * @deprecated Please use the 'paramCount' property instead. * Gets the count of parameters */ getParamCount() : number; /** * Gets the count of parameters */ readonly paramCount : number; /** * Gets the represented value object of the parameter at a given index. * @param index - The index of the parameter(0 based) * @returns * The calculated value of the parameter. * * @remarks * For one parameter: *

If it is plain value, then returns the plain value itself;

*

If it is reference, then returns ReferredArea object;

*

If it references to dataset(s) with multiple values, then returns array of objects;

*

* If it is some kind of expression that needs to be calculated, then it will be calculated in value mode * and generally a single value will be returned according to current cell base. For example, * if one parameter of D2's formula is A:A+B:B, then A2+B2 will be calculated and returned. * However, if this parameter has been specified as array mode * (by * or ), * then an array(object[][]) will be returned whose items are A1+B1,A2+B2,.... *

*/ getParamValue(index: number) : Object; /** * Gets the value(s) of the parameter at a given index. * If the parameter is some kind of expression that needs to be calculated, then it will be calculated in array mode. * @param index - The index of the parameter(0 based) * @param maxRowCount - The row count limit for the returned array. /// If it is non-positive or greater than the actual row count, then actual row count will be used. * @param maxColumnCount - The column count limit for the returned array. /// If it is non-positive or greater than the actual row count, then actual column count will be used. * @returns * An array which contains all items represented by the specified parameter. * * @remarks * For an expression that needs to be calculated, taking A:A+B:B as an example: * In value mode it will be calculated to a single value according to current cell base. * But in array mode, all values of A1+B1,A2+B2,A3+B3,... will be calculated and used to construct the returned array. * And for such kind of situation, it is better to specify the limit for the row/column count * (such as according to and ), * otherwise the returned large array may increase memory cost with large amount of useless data. */ getParamValueInArrayMode(index: number, maxRowCount: number, maxColumnCount: number) : Object[][]; /** * Gets the literal text of the parameter at the given index. * @param index - index of the parameter(0 based) * @returns * literal text of the parameter */ getParamText(index: number) : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the globalization settings. */ export class GlobalizationSettings { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'chartSettings' property instead. * Gets or sets the globalization settings for Chart. */ getChartSettings() : ChartGlobalizationSettings; /** * Gets or sets the globalization settings for Chart. */ chartSettings : ChartGlobalizationSettings; /** * @deprecated Please use the 'chartSettings' property instead. * Gets or sets the globalization settings for Chart. * @param value - The value to set. */ setChartSettings(value: ChartGlobalizationSettings) : void; /** * @deprecated Please use the 'pivotSettings' property instead. * Gets or sets the globalization settings for the pivot table. */ getPivotSettings() : PivotGlobalizationSettings; /** * Gets or sets the globalization settings for the pivot table. */ pivotSettings : PivotGlobalizationSettings; /** * @deprecated Please use the 'pivotSettings' property instead. * Gets or sets the globalization settings for the pivot table. * @param value - The value to set. */ setPivotSettings(value: PivotGlobalizationSettings) : void; /** * Gets the separator for list, parameters of function, ...etc. */ getListSeparator() : string; /** * Gets the separator for rows in array data in formula. */ getRowSeparatorOfFormulaArray() : string; /** * Gets the separator for the items in array's row data in formula. */ getColumnSeparatorOfFormulaArray() : string; /** * Gets the total name of the function. * @param functionType - The function type. * @returns * The total name of the function. */ getTotalName(functionType: ConsolidationFunction) : string; /** * Gets the grand total name of the function. * @param functionType - The function type. * @returns * The grand total name of the function. */ getGrandTotalName(functionType: ConsolidationFunction) : string; /** * Gets the default sheet name for adding worksheet automatically. * Default is "Sheet". * @returns * the default sheet name for adding worksheet automatically * * @remarks * The automatically added(such as by ) * sheet's name will be the specified name plus sequence number. * For example, for Germany user maybe wants the sheet name to be "Tabellenblatt2" instead of "Sheet2". * Then user may implement this method to return "Tabellenblatt". */ getDefaultSheetName() : string; /** * Gets the type name of table rows that consists of the table header. * Default is "Headers", so in formula "#Headers" represents the table header. * @returns * the type name of table rows */ getTableRowTypeOfHeaders() : string; /** * Gets the type name of table rows that consists of data region of referenced table. * Default is "Data", so in formula "#Data" represents the data region of the table. * @returns * the type name of table rows */ getTableRowTypeOfData() : string; /** * Gets the type name of table rows that consists of all rows in referenced table. * Default is "All", so in formula "#All" represents all rows in referenced table. * @returns * the type name of table rows */ getTableRowTypeOfAll() : string; /** * Gets the type name of table rows that consists of the total row of referenced table. * Default is "Totals", so in formula "#Totals" represents the total row of referenced table. * @returns * the type name of table rows */ getTableRowTypeOfTotals() : string; /** * Gets the type name of table rows that consists of the current row in referenced table. * Default is "This Row", so in formula "#This Row" represents the current row in referenced table. * @returns * the type name of table rows */ getTableRowTypeOfCurrent() : string; /** * Gets the display string value for cell's error value * @param err - error values such as #VALUE!,#NAME? * @returns * By default returns the error value itself */ getErrorValueString(err: string) : string; /** * Gets the display string value for cell's boolean value * @param bv - boolean value * @returns * By default returns "TRUE" for true value and "FALSE" for false value. */ getBooleanValueString(bv: boolean) : string; /** * Gets the locale dependent function name according to given standard function name. * @param standardName - Standard(en-US locale) function name. * @returns * Locale dependent function name. The locale was specified by the Workbook for which this settings is used. */ getLocalFunctionName(standardName: string) : string; /** * Gets the standard function name according to given locale dependent function name. * @param localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used. * @returns * Standard(en-US locale) function name. */ getStandardFunctionName(localName: string) : string; /** * Gets the locale dependent text for built-in Name according to given standard text. * @param standardName - Standard(en-US locale) text of built-in Name. * @returns * Locale dependent text. The locale was specified by the Workbook for which this settings is used. */ getLocalBuiltInName(standardName: string) : string; /** * Gets the standard text of built-in Name according to given locale dependent text. * @param localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used. * @returns * Standard(en-US locale) text. */ getStandardBuiltInName(localName: string) : string; /** * Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name. * @param localfontStyleName - Locale font style name for Header/Footer. * @returns * Standard English font style name(Regular, Bold, Italic) */ getStandardHeaderFooterFontStyleName(localfontStyleName: string) : string; /** * Gets the locale dependent comment title name according to comment title type. * @param type - */ getCommentTitleName(type: CommentTitleType) : string; /** * Compares two string values according to certain collation rules. * @param v1 - the first string * @param v2 - the second string * @param ignoreCase - whether ignore case when comparing values * @returns * Integer that indicates the lexical relationship between the two comparands */ compare(v1: string, v2: string, ignoreCase: boolean) : number; } /** * Encapsulates the object that represents a single Workbook cell. */ export class Cell { /** * @deprecated Please use the 'worksheet' property instead. * Gets the parent worksheet. */ getWorksheet() : Worksheet; /** * Gets the parent worksheet. */ readonly worksheet : Worksheet; /** * @deprecated Please use the 'dateTimeValue' property instead. * Gets the DateTime value contained in the cell. */ getDateTimeValue() : Date; /** * Gets the DateTime value contained in the cell. */ readonly dateTimeValue : Date; /** * @deprecated Please use the 'row' property instead. * Gets row number (zero based) of the cell. */ getRow() : number; /** * Gets row number (zero based) of the cell. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets column number (zero based) of the cell. */ getColumn() : number; /** * Gets column number (zero based) of the cell. */ readonly column : number; /** * Represents if the specified cell contains formula. */ readonly isFormula : boolean; /** * @deprecated Please use the 'hasCustomFunction' property instead. * Checks whether there is custom function(unsupported function) in this cell's formula. */ getHasCustomFunction() : boolean; /** * Checks whether there is custom function(unsupported function) in this cell's formula. */ readonly hasCustomFunction : boolean; /** * @deprecated Please use the 'type' property instead. * Represents cell value type. */ getType() : CellValueType; /** * Represents cell value type. */ readonly type : CellValueType; /** * @deprecated Please use the 'name' property instead. * Gets the name of the cell. * * @remarks * A cell name includes its column letter and row number. For example, the name of a cell in row 0 and column 0 is A1. */ getName() : string; /** * Gets the name of the cell. * * @remarks * A cell name includes its column letter and row number. For example, the name of a cell in row 0 and column 0 is A1. */ readonly name : string; /** * Checks if the value of this cell is an error. * * @remarks * Also applies to formula cell to check whether the calculated result is an error. */ readonly isErrorValue : boolean; /** * Indicates whether the value of this cell is numeric(int, double and datetime) * * @remarks * Also applies to formula cell to check the calculated result */ readonly isNumericValue : boolean; /** * @deprecated Please use the 'stringValue' property instead. * Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. * For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. * The formatted cell value is same with what you can get from excel when copying a cell as text(such as * copying cell to text editor or exporting to csv). */ getStringValue() : string; /** * Gets the string value contained in the cell. If the type of this cell is string, then return the string value itself. * For other cell types, the formatted string value (formatted with the specified style of this cell) will be returned. * The formatted cell value is same with what you can get from excel when copying a cell as text(such as * copying cell to text editor or exporting to csv). */ readonly stringValue : string; /** * @deprecated Please use the 'numberCategoryType' property instead. * Represents the category type of this cell's number formatting. * * @remarks * When cell's formatting pattern is combined with conditional formatting patterns, * then the returned type is corresponding to the part which is used for current value of this cell. * For example, if the formatting pattern for this cell is "#,##0;(#,##0);"-";@", * then when cell's value is numeric and not 0, the returned type is ; * When cell's value is 0 or not numeric value, the returned type is . */ getNumberCategoryType() : NumberCategoryType; /** * Represents the category type of this cell's number formatting. * * @remarks * When cell's formatting pattern is combined with conditional formatting patterns, * then the returned type is corresponding to the part which is used for current value of this cell. * For example, if the formatting pattern for this cell is "#,##0;(#,##0);"-";@", * then when cell's value is numeric and not 0, the returned type is ; * When cell's value is 0 or not numeric value, the returned type is . */ readonly numberCategoryType : NumberCategoryType; /** * @deprecated Please use the 'displayStringValue' property instead. * Gets the formatted string value of this cell by cell's display style. */ getDisplayStringValue() : string; /** * Gets the formatted string value of this cell by cell's display style. */ readonly displayStringValue : string; /** * @deprecated Please use the 'intValue' property instead. * Gets the integer value contained in the cell. */ getIntValue() : number; /** * Gets the integer value contained in the cell. */ readonly intValue : number; /** * @deprecated Please use the 'doubleValue' property instead. * Gets the double value contained in the cell. */ getDoubleValue() : number; /** * Gets the double value contained in the cell. */ readonly doubleValue : number; /** * @deprecated Please use the 'floatValue' property instead. * Gets the float value contained in the cell. */ getFloatValue() : number; /** * Gets the float value contained in the cell. */ readonly floatValue : number; /** * @deprecated Please use the 'boolValue' property instead. * Gets the boolean value contained in the cell. */ getBoolValue() : boolean; /** * Gets the boolean value contained in the cell. */ readonly boolValue : boolean; /** * @deprecated Please use the 'hasCustomStyle' property instead. * Indicates whether this cell has custom style settings(different from the default one inherited * from corresponding row, column, or workbook). */ getHasCustomStyle() : boolean; /** * Indicates whether this cell has custom style settings(different from the default one inherited * from corresponding row, column, or workbook). */ readonly hasCustomStyle : boolean; /** * @deprecated Please use the 'sharedStyleIndex' property instead. * Gets cell's shared style index in the style pool. */ getSharedStyleIndex() : number; /** * Gets cell's shared style index in the style pool. */ readonly sharedStyleIndex : number; /** * @deprecated Please use the 'formula' property instead. * Gets or sets a formula of the . * * @remarks * A formula string always begins with an equal sign (=). * And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)". */ getFormula() : string; /** * Gets or sets a formula of the . * * @remarks * A formula string always begins with an equal sign (=). * And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)". */ formula : string; /** * @deprecated Please use the 'formula' property instead. * Gets or sets a formula of the . * @param value - The value to set. * * @remarks * A formula string always begins with an equal sign (=). * And please always use comma(,) as parameters delimiter, such as "=SUM(A1, E1, H2)". */ setFormula(value: string) : void; /** * @deprecated Please use the 'formulaLocal' property instead. * Get the locale formatted formula of the cell. */ getFormulaLocal() : string; /** * Get the locale formatted formula of the cell. */ formulaLocal : string; /** * @deprecated Please use the 'formulaLocal' property instead. * Get the locale formatted formula of the cell. * @param value - The value to set. */ setFormulaLocal(value: string) : void; /** * @deprecated Please use the 'r1C1Formula' property instead. * Gets or sets a R1C1 formula of the . */ getR1C1Formula() : string; /** * Gets or sets a R1C1 formula of the . */ r1C1Formula : string; /** * @deprecated Please use the 'r1C1Formula' property instead. * Gets or sets a R1C1 formula of the . * @param value - The value to set. */ setR1C1Formula(value: string) : void; /** * @deprecated Please use the 'containsExternalLink' property instead. * Indicates whether this cell contains an external link. * Only applies when the cell is a formula cell. */ getContainsExternalLink() : boolean; /** * Indicates whether this cell contains an external link. * Only applies when the cell is a formula cell. */ readonly containsExternalLink : boolean; /** * Indicates the cell's formula is an array formula * and it is the first cell of the array. */ readonly isArrayHeader : boolean; /** * Indicates whether the cell's formula is dynamic array formula(true) or legacy array formula(false). */ readonly isDynamicArrayFormula : boolean; /** * Indicates whether the cell formula is an array formula. */ readonly isArrayFormula : boolean; /** * Indicates whether the cell formula is part of shared formula. */ readonly isSharedFormula : boolean; /** * Indicates whether this cell is part of table formula. */ readonly isTableFormula : boolean; /** * @deprecated Please use the 'value' property instead. * Gets/sets the value contained in this cell. * * @remarks * Possible type: *

null,

*

Boolean,

*

DateTime,

*

Double,

*

Integer

*

String.

* For int value, it may be returned as an Integer object or a Double object. * And there is no guarantee that the returned value will be kept as the same type of object always. */ getValue() : Object; /** * Gets/sets the value contained in this cell. * * @remarks * Possible type: *

null,

*

Boolean,

*

DateTime,

*

Double,

*

Integer

*

String.

* For int value, it may be returned as an Integer object or a Double object. * And there is no guarantee that the returned value will be kept as the same type of object always. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Gets/sets the value contained in this cell. * @param value - The value to set. * * @remarks * Possible type: *

null,

*

Boolean,

*

DateTime,

*

Double,

*

Integer

*

String.

* For int value, it may be returned as an Integer object or a Double object. * And there is no guarantee that the returned value will be kept as the same type of object always. */ setValue(value: Object) : void; /** * Indicates if the cell's style is set. If return false, it means this cell has a default cell format. */ readonly isStyleSet : boolean; /** * Checks if a cell is part of a merged range or not. */ readonly isMerged : boolean; /** * @deprecated Please use the 'comment' property instead. * Gets the comment of this cell. * * @remarks * If there is no comment applies to the cell, returns null. */ getComment() : Comment; /** * Gets the comment of this cell. * * @remarks * If there is no comment applies to the cell, returns null. */ readonly comment : Comment; /** * @deprecated Please use the 'htmlString' property instead. * Gets and sets the html string which contains data and some formats in this cell. */ getHtmlString() : string; /** * Gets and sets the html string which contains data and some formats in this cell. */ htmlString : string; /** * @deprecated Please use the 'htmlString' property instead. * Gets and sets the html string which contains data and some formats in this cell. * @param value - The value to set. */ setHtmlString(value: string) : void; /** * Indicates whether setting this cell as a check box. */ isCheckBoxStyle : boolean; /** * @deprecated Please use the 'isCheckBoxStyle' property instead. * Indicates whether setting this cell as a check box. * @param value - The value to set. */ setIsCheckBoxStyle(value: boolean) : void; /** * @deprecated Please use the 'embeddedImage' property instead. * Gets and sets the embeddedn image in the cell. */ getEmbeddedImage() : Uint8Array; /** * Gets and sets the embeddedn image in the cell. */ embeddedImage : Uint8Array; /** * @deprecated Please use the 'embeddedImage' property instead. * Gets and sets the embeddedn image in the cell. * @param value - The value to set. */ setEmbeddedImage(value: Uint8Array) : void; /** * Calculates the formula of the cell. * @param options - Options for calculation */ calculate(options: CalculationOptions) : void; /** * Puts a boolean value into the cell. * @param boolValue - */ putValue(boolValue: boolean) : void; /** * Puts an integer value into the cell. * @param intValue - Input value */ putValue(intValue: number) : void; /** * Puts a double value into the cell. * @param doubleValue - Input value */ putValue(doubleValue: number) : void; /** * Puts a value into the cell, if appropriate the value will be converted to other data type and cell's number format will be reset. * @param stringValue - Input value * @param isConverted - True: converted to other data type if appropriate. * @param setStyle - True: set the number format to cell's style when converting to other data type */ putValue(stringValue: string, isConverted: boolean, setStyle: boolean) : void; /** * Puts a string value into the cell and converts the value to other data type if appropriate. * @param stringValue - Input value * @param isConverted - True: converted to other data type if appropriate. */ putValue(stringValue: string, isConverted: boolean) : void; /** * Puts a string value into the cell. * @param stringValue - Input value */ putValue(stringValue: string) : void; /** * Puts a DateTime value into the cell. * @param dateTime - Input value * * @remarks * Setting a DateTime value for a cell dose not means the cell will be formatted as date time automatically. * DateTime value was maintained as numeric value in the data model of both ms excel and Aspose.Cells. * Whether the numeric value will be taken as the numeric value itself or date time * depends on the number format applied on this cell. If this cell has not been formatted as date time, * it will be displayed as a numeric value even though what you input is DateTime. */ putValue(dateTime: Date) : void; /** * Puts an object value into the cell. * @param objectValue - input value */ putValue(objectValue: Object) : void; /** * Gets the string value by specific formatted strategy. * @param formatStrategy - The formatted strategy. */ getStringValue(formatStrategy: CellValueFormatStrategy) : string; /** * Gets the width of the value in unit of pixels. */ getWidthOfValue() : number; /** * Gets the height of the value in unit of pixels. */ getHeightOfValue() : number; /** * Gets the display style of this cell. * @returns * display style of this cell * * @remarks * Same with using * for . * That is, this method will check and adjust top/bottom/left/right borders of this cell * according to the style() of its adjacent cells, * but do not check the merged cells, and do not check the display style of adjacent cells. */ getDisplayStyle() : Style; /** * Gets the display style of this cell. * @param includeMergedBorders - Indicates whether checking borders of merged cells. * @returns * display style of this cell * * @remarks * If the specified flag is false, then it is same with . * Otherwise it is same with using * | * for . */ getDisplayStyle(includeMergedBorders: boolean) : Style; /** * Gets the display style of this cell. * @param adjacentBorders - Indicates which borders need to be checked and adjusted /// according to the borders of adjacent cells. * @returns * display style of this cell * * @remarks * If this cell is also affected by other settings such as conditional formatting, list objects, etc., * then the display style may be different from . *

For flags of adjusting borders according to adjacent cells, * / * / * denote whether check and combine the bottom/top/right/left borders of * the left/right/top/bottom cells adjacent to this one. *

For performance and compatibility consideration, * some enums are used to denote some special operations: *

/ * denote whether check and combine the bottom/right border of merged cells to this one. *

(that is, both and * have been set) denotes check and combine borders * from the display style of adjacent cells. *

Please note, checking borders/styles of adjacent cells, especially the display styles, * is time-consumed process. If there is no need to get the borders for the returned style, * using to disable the process of adjacent cells * will give better performance. * When getting borders of adjacent cells from styles defined on those cells only(without setting * ), the performance also may be better because checking * the display style of one cell is time-consumed too. */ getDisplayStyle(adjacentBorders: BorderType) : Style; /** * Gets format conditions which applies to this cell. * @returns * Returns object */ getFormatConditions() : FormatConditionCollection[]; /** * Gets the cell style. * @returns * Style object. * * @remarks * To change the style of the cell, please call Cell.SetStyle() method after modifying the returned style object. * This method is same with with true value for the parameter. */ getStyle() : Style; /** * If checkBorders is true, check whether other cells' borders will effect the style of this cell. * @param checkBorders - Check other cells' borders * @returns * Style object. * * @remarks */ getStyle(checkBorders: boolean) : Style; /** * Sets the cell style. * @param style - The cell style. * * @remarks * If the border settings are changed, the border of adjust cells will be updated too. */ setStyle(style: Style) : void; /** * Apply the changed property of style to the cell. * @param style - The cell style. * @param explicitFlag - True, only overwriting formatting which is explicitly set. */ setStyle(style: Style, explicitFlag: boolean) : void; /** * Apply the cell style based on flags. * @param style - The cell style. * @param flag - The style flag. */ setStyle(style: Style, flag: StyleFlag) : void; /** * Set the formula and the value(calculated result) of the formula. * @param formula - The formula. * @param value - The value(calculated result) of the formula. */ setFormula(formula: string, value: Object) : void; /** * Set the formula and the value(calculated result) of the formula. * @param formula - The formula. * @param options - Options for parsing the formula. */ setFormula(formula: string, options: FormulaParseOptions) : void; /** * Set the formula and the value(calculated result) of the formula. * @param formula - The formula. * @param options - Options for parsing the formula. * @param value - The value(calculated result) of the formula. */ setFormula(formula: string, options: FormulaParseOptions, value: Object) : void; /** * Get the formula of this cell. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @returns * the formula of this cell. */ getFormula(isR1C1: boolean, isLocal: boolean) : string; /** * Sets an array formula(legacy array formula entered via CTRL+SHIFT+ENTER in ms excel) to a range of cells. * @param arrayFormula - Array formula. * @param rowNumber - Number of rows to populate result of the array formula. * @param columnNumber - Number of columns to populate result of the array formula. */ setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number) : void; /** * Sets an array formula to a range of cells. * @param arrayFormula - Array formula. * @param rowNumber - Number of rows to populate result of the array formula. * @param columnNumber - Number of columns to populate result of the array formula. * @param options - Options for parsing the formula. */ setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions) : void; /** * Sets an array formula to a range of cells. * @param arrayFormula - Array formula. * @param rowNumber - Number of rows to populate result of the array formula. * @param columnNumber - Number of columns to populate result of the array formula. * @param options - Options for parsing the formula. * @param values - values for those cells with given array formula */ setArrayFormula(arrayFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions, values: Object[][]) : void; /** * Sets shared formulas to a range of cells. * @param sharedFormula - Shared formula. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * * @remarks */ setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number) : void; /** * Sets shared formulas to a range of cells. * @param sharedFormula - Shared formula. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param options - Options for parsing the formula. */ setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions) : void; /** * Sets shared formulas to a range of cells. * @param sharedFormula - Shared formula. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param options - Options for parsing the formula. * @param values - values for those cells with given shared formula */ setSharedFormula(sharedFormula: string, rowNumber: number, columnNumber: number, options: FormulaParseOptions, values: Object[][]) : void; /** * Gets all references appearing in this cell's formula. * @returns * Collection of all references appearing in this cell's formula. * * @remarks *
    *
  • Returns null if this is not a formula cell.
  • *
  • All references appearing in this cell's formula will be returned no matter they are referenced or not while calculating. * For example, although cell A2 in formula "=IF(TRUE,A1,A2)" is not used while calculating, * it is still taken as the formula's precedents.
  • *
  • To get those references which influence the calculation only, please use .
  • *
*/ getPrecedents() : ReferredAreaCollection; /** * Get all cells whose formula references to this cell directly. * @param isAll - Indicates whether check formulas in other worksheets * * @remarks *
    *
  • If one reference containing this cell appears in one cell's formula, that cell will be taken as * the dependent of this cell, no matter the reference or this cell is used or not while calculating. * For example, although cell A2 in formula "=IF(TRUE,A1,A2)" is not used while calculating, * this formula is still be taken as A2's dependent. *
  • *
  • To get those formulas whose calculated results depend on this cell, please use .
  • *
  • When tracing dependents for one cell, all formulas in the workbook or worksheet will be analized and checked. * So it is a time consumed process. If user need to trace dependents for lots of cells, using this method will * cause poor performance. For performance consideration, user should use instead. * Or, user may gather precedents map of all cells by firstly, * and then build the dependents map according to the precedents map.
  • *
*/ getDependents(isAll: boolean) : Cell[]; /** * Gets all precedents(reference to cells in current workbook) used by this cell's formula while calculating it. * @returns * Enumerator to enumerate all references(ReferredArea) * * @remarks * This method can only work with the situation that * is true for the workbook and the workbook has been fully calculated. * If this cell is not a formula or it does not reference to any other cells, null will be returned. */ getPrecedentsInCalculation() : ReferredAreaEnumerator; /** * Gets all cells whose calculated result depends on this cell. * @param recursive - Whether returns those dependents which do not reference to this cell directly /// but reference to other leafs of this cell * @returns * Enumerator to enumerate all dependents(Cell objects) * * @remarks * To use this method, please make sure the workbook has been set with true value for * and has been fully calculated with this setting. * If there is no formula reference to this cell, null will be returned. */ getDependentsInCalculation(recursive: boolean) : CellEnumerator; /** * Gets the array range if the cell's formula is an array formula. * @returns * The array range. * * @remarks * Only applies when the cell's formula is an array formula */ getArrayRange() : CellArea; /** * Sets dynamic array formula and make the formula spill into neighboring cells if possible. * @param arrayFormula - the formula expression * @param options - options to parse formula. /// "Parse" option will be ignored and the formula will always be parsed immediately * @param calculateValue - whether calculate this dynamic array formula for those cells in the spilled range. * @returns * the range that the formula should spill into. * * @remarks * the returned range may be not same with the actual one that this dynamic array formula spills into. * If there are non-empty cells in the range, the formula will be set for current cell only and marked as "#SPILL!". * But for such kind of situation we still return the whole range that this formula should spill into. */ setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, calculateValue: boolean) : CellArea; /** * Sets dynamic array formula and make the formula spill into neighboring cells if possible. * @param arrayFormula - the formula expression * @param options - options to parse formula. /// "Parse" option will be ignored and the formula will always be parsed immediately * @param values - values(calculated results) for those cells with given dynamic array formula * @param calculateRange - Whether calculate the spilled range for this dynamic array formula. /// If the "values" parameter is not null and this flag is false, /// then the spilled range's height will be values.Length and width will be values[0].Length. * @param calculateValue - whether calculate this dynamic array formula for those cells in the spilled range when "values" is null /// or corresponding item in "values" for one cell is null. * @returns * the range that the formula should spill into. * * @remarks * the returned range may be not same with the actual one that this dynamic array formula spills into. * If there are non-empty cells in the range, the formula will be set for current cell only and marked as "#SPILL!". * But for such kind of situation we still return the whole range that this formula should spill into. */ setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, values: Object[][], calculateRange: boolean, calculateValue: boolean) : CellArea; /** * Sets dynamic array formula and make the formula spill into neighboring cells if possible. * @param arrayFormula - the formula expression * @param options - options to parse formula. /// "Parse" option will be ignored and the formula will always be parsed immediately * @param values - values(calculated results) for those cells with given dynamic array formula * @param calculateRange - Whether calculate the spilled range for this dynamic array formula. /// If the "values" parameter is not null and this flag is false, /// then the spilled range's height will be values.Length and width will be values[0].Length. * @param calculateValue - whether calculate this dynamic array formula for those cells in the spilled range when "values" is null /// or corresponding item in "values" for one cell is null. * @param copts - The options for calculating formula. /// Commonly, for performance consideration, the property should be false. * @returns * the range that the formula should spill into. * * @remarks * the returned range may be not same with the actual one that this dynamic array formula spills into. * If there are non-empty cells in the range, the formula will be set for current cell only and marked as "#SPILL!". * But for such kind of situation we still return the whole range that this formula should spill into. */ setDynamicArrayFormula(arrayFormula: string, options: FormulaParseOptions, values: Object[][], calculateRange: boolean, calculateValue: boolean, copts: CalculationOptions) : CellArea; /** * Create two-variable data table for given range starting from this cell. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param rowInputCell - the row input cell * @param columnInputCell - the column input cell * @param values - values for cells in table formula range */ setTableFormula(rowNumber: number, columnNumber: number, rowInputCell: string, columnInputCell: string, values: Object[][]) : void; /** * Create one-variable data table for given range starting from this cell. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param inputCell - the input cell * @param isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false). * @param values - values for cells in table formula range */ setTableFormula(rowNumber: number, columnNumber: number, inputCell: string, isRowInput: boolean, values: Object[][]) : void; /** * Create two-variable data table for given range starting from this cell. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param rowIndexOfRowInputCell - row index of the row input cell * @param columnIndexOfRowInputCell - column index of the row input cell * @param rowIndexOfColumnInputCell - row index of the column input cell * @param columnIndexOfColumnInputCell - column index of the column input cell * @param values - values for cells in table formula range */ setTableFormula(rowNumber: number, columnNumber: number, rowIndexOfRowInputCell: number, columnIndexOfRowInputCell: number, rowIndexOfColumnInputCell: number, columnIndexOfColumnInputCell: number, values: Object[][]) : void; /** * Create one-variable data table for given range starting from this cell. * @param rowNumber - Number of rows to populate the formula. * @param columnNumber - Number of columns to populate the formula. * @param rowIndexOfInputCell - row index of the input cell * @param columnIndexOfInputCell - column index of the input cell * @param isRowInput - Indicates whether the input cell is a row input cell(true) or a column input cell(false). * @param values - values for cells in table formula range */ setTableFormula(rowNumber: number, columnNumber: number, rowIndexOfInputCell: number, columnIndexOfInputCell: number, isRowInput: boolean, values: Object[][]) : void; /** * Remove array formula. * @param leaveNormalFormula - True represents converting the array formula to normal formula. */ removeArrayFormula(leaveNormalFormula: boolean) : void; /** * Copies data from a source cell. * @param cell - Source object. */ copy(cell: Cell) : void; /** * Returns a Characters object that represents a range of characters within the cell text. * @param startIndex - The index of the start of the character. * @param length - The number of characters. * @returns * Characters object. * * @remarks * This method only works on cell with string value. */ characters(startIndex: number, length: number) : FontSetting; /** * Replace text of the cell with options. * @param placeHolder - Cell placeholder * @param newValue - String value to replace * @param options - The replace options */ replace(placeHolder: string, newValue: string, options: ReplaceOptions) : void; /** * Insert some characters to the cell. * If the cell is rich formatted, this method could keep the original formatting. * @param index - The index. * @param text - Inserted text. */ insertText(index: number, text: string) : void; /** * Indicates whether the string value of this cell is a rich formatted text. */ isRichText() : boolean; /** * Returns all Characters objects * that represents a range of characters within the cell text. * @returns * All Characters objects */ getCharacters() : FontSetting[]; /** * Returns all Characters objects * that represents a range of characters within the cell text. * @param flag - Indicates whether applying table style to the cell if the cell is in the table. * @returns * All Characters objects */ getCharacters(flag: boolean) : FontSetting[]; /** * Sets rich text format of the cell. * @param characters - All Characters objects. */ setCharacters(characters: FontSetting[]) : void; /** * Returns a object which represents a merged range. * @returns * object. Null if this cell is not merged. */ getMergedRange() : Range; /** * Gets the html string which contains data and some formats in this cell. * @param html5 - Indicates whether the value is compatible for html5 */ getHtmlString(html5: boolean) : string; /** * Returns a string represents the current Cell object. */ toString() : string; /** * Convert to JSON struct data. */ toJson() : string; /** * Checks whether this object refers to the same cell with another. * @param obj - another object * @returns * true if two objects refers to the same cell. */ equals(obj: Object) : boolean; /** * Checks whether this object refers to the same cell with another cell object. * @param cell - another cell object * @returns * true if two cell objects refers to the same cell. */ equals(cell: Cell) : boolean; /** * Serves as a hash function for a particular type. * @returns * A hash code for current Cell object. */ getHashCode() : number; /** * Get the result of the conditional formatting. * * @remarks * Returns null if no conditional formatting is applied to this cell, */ getConditionalFormattingResult() : ConditionalFormattingResult; /** * Gets the validation applied to this cell. */ getValidation() : Validation; /** * Gets the value of validation which applied to this cell. */ getValidationValue() : boolean; /** * Gets the table which contains this cell. */ getTable() : ListObject; /** * Gets rich value of the cell. */ getRichValue() : CellRichValue; /** */ dispose() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a collection of cell relevant objects, such as , , ...etc. * * @remarks */ export class Cells implements Iterable { /** * Gets the element at the specified cell row index and column index. * @param row - Row index. * @param column - Column index. * @returns * The object. */ get(row: number, column: number) : Cell; /** * Gets the element at the specified cell name. * @param cellName - Cell name,including its column letter and row number, for example A5. * @returns * A object */ get(cellName: string) : Cell; /** * @deprecated Please use the 'odsCellFields' property instead. * Gets the list of fields of ods. */ getOdsCellFields() : OdsCellFieldCollection; /** * Gets the list of fields of ods. */ readonly odsCellFields : OdsCellFieldCollection; /** * @deprecated Please use the 'count' property instead. * Gets the total count of instantiated Cell objects. */ getCount() : number; /** * Gets the total count of instantiated Cell objects. */ readonly count : number; /** * @deprecated Please use the 'countLarge' property instead. * Gets the total count of instantiated Cell objects. */ getCountLarge() : number; /** * Gets the total count of instantiated Cell objects. */ readonly countLarge : number; /** * @deprecated Please use the 'rows' property instead. * Gets the collection of objects that represents the individual rows in this worksheet. */ getRows() : RowCollection; /** * Gets the collection of objects that represents the individual rows in this worksheet. */ readonly rows : RowCollection; /** * @deprecated Please use the 'multiThreadReading' property instead. * Gets or sets whether the cells data model should support Multi-Thread reading. * Default value of this property is false. * * @remarks * If there are multiple threads to read Row/Cell objects in this collection concurrently, * this property should be set as true, otherwise unexpected result may be produced. * Supporting Multi-Thread reading may degrade the performance for accessing Row/Cell objects from this collection. * Please note, some features cannot support Multi-Thread reading, * such as formatting values(by , , .etc.). * So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading. */ getMultiThreadReading() : boolean; /** * Gets or sets whether the cells data model should support Multi-Thread reading. * Default value of this property is false. * * @remarks * If there are multiple threads to read Row/Cell objects in this collection concurrently, * this property should be set as true, otherwise unexpected result may be produced. * Supporting Multi-Thread reading may degrade the performance for accessing Row/Cell objects from this collection. * Please note, some features cannot support Multi-Thread reading, * such as formatting values(by , , .etc.). * So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading. */ multiThreadReading : boolean; /** * @deprecated Please use the 'multiThreadReading' property instead. * Gets or sets whether the cells data model should support Multi-Thread reading. * Default value of this property is false. * @param value - The value to set. * * @remarks * If there are multiple threads to read Row/Cell objects in this collection concurrently, * this property should be set as true, otherwise unexpected result may be produced. * Supporting Multi-Thread reading may degrade the performance for accessing Row/Cell objects from this collection. * Please note, some features cannot support Multi-Thread reading, * such as formatting values(by , , .etc.). * So, even with this property being set as true, those APIs still may give unexpected result for Multi-Thread reading. */ setMultiThreadReading(value: boolean) : void; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory usage option for this cells. * * @remarks * Notable limits and recommended operations for some modes: * * * Mode * Remarks * Supported * * * * Cells data will be maintained in compact format * to decrease the memory cost. On other hand, the compact data also may * cause higher time cost, especially when updating the cells data, * or accessing cells/rows randomly * v8.0.0 * * * * * When this mode is used for any worksheet in one workbook, * should be called at the end of work to release all resources such as the temporary files. *

* Randomly accessing cells will give poor performance because data needs * to be read/updated randomly and repeatedly(so the pointer in the file will be * changed accordingly and IO operations will be required repeatedly). * If possible, please always access the data sequentially(row by row). *

* When the data of one row/cell be changed, data of other cells/rows * may also be influenced(such as the data be shifted/moved to other places * to allocated enough spaces for the changed data). * So every change of every data requires synchronization of other existing objects( * such as Row or Cell object). * So, to get better performance, please do not maintain multiple Rows/Cells * at the same time. Processing them one by one will reduce the data synchronization * for them so the performance can be improved a bit. *
* v25.7 *
*
*/ getMemorySetting() : MemorySetting; /** * Gets or sets the memory usage option for this cells. * * @remarks * Notable limits and recommended operations for some modes: * * * Mode * Remarks * Supported * * * * Cells data will be maintained in compact format * to decrease the memory cost. On other hand, the compact data also may * cause higher time cost, especially when updating the cells data, * or accessing cells/rows randomly * v8.0.0 * * * * * When this mode is used for any worksheet in one workbook, * should be called at the end of work to release all resources such as the temporary files. *

* Randomly accessing cells will give poor performance because data needs * to be read/updated randomly and repeatedly(so the pointer in the file will be * changed accordingly and IO operations will be required repeatedly). * If possible, please always access the data sequentially(row by row). *

* When the data of one row/cell be changed, data of other cells/rows * may also be influenced(such as the data be shifted/moved to other places * to allocated enough spaces for the changed data). * So every change of every data requires synchronization of other existing objects( * such as Row or Cell object). * So, to get better performance, please do not maintain multiple Rows/Cells * at the same time. Processing them one by one will reduce the data synchronization * for them so the performance can be improved a bit. *
* v25.7 *
*
*/ memorySetting : MemorySetting; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory usage option for this cells. * @param value - The value to set. * * @remarks * Notable limits and recommended operations for some modes: * * * Mode * Remarks * Supported * * * * Cells data will be maintained in compact format * to decrease the memory cost. On other hand, the compact data also may * cause higher time cost, especially when updating the cells data, * or accessing cells/rows randomly * v8.0.0 * * * * * When this mode is used for any worksheet in one workbook, * should be called at the end of work to release all resources such as the temporary files. *

* Randomly accessing cells will give poor performance because data needs * to be read/updated randomly and repeatedly(so the pointer in the file will be * changed accordingly and IO operations will be required repeatedly). * If possible, please always access the data sequentially(row by row). *

* When the data of one row/cell be changed, data of other cells/rows * may also be influenced(such as the data be shifted/moved to other places * to allocated enough spaces for the changed data). * So every change of every data requires synchronization of other existing objects( * such as Row or Cell object). * So, to get better performance, please do not maintain multiple Rows/Cells * at the same time. Processing them one by one will reduce the data synchronization * for them so the performance can be improved a bit. *
* v25.7 *
*
*/ setMemorySetting(value: MemorySetting) : void; /** * @deprecated Please use the 'style' property instead. * Gets and sets the default style of the worksheet. */ getStyle() : Style; /** * Gets and sets the default style of the worksheet. */ style : Style; /** * @deprecated Please use the 'style' property instead. * Gets and sets the default style of the worksheet. * @param value - The value to set. */ setStyle(value: Style) : void; /** */ isDefaultColumnHidden : boolean; /** * @deprecated Please use the 'isDefaultColumnHidden' property instead. * @param value - The value to set. */ setIsDefaultColumnHidden(value: boolean) : void; /** * @deprecated Please use the 'standardWidthInch' property instead. * Gets or sets the default column width in the worksheet, in unit of inches. */ getStandardWidthInch() : number; /** * Gets or sets the default column width in the worksheet, in unit of inches. */ standardWidthInch : number; /** * @deprecated Please use the 'standardWidthInch' property instead. * Gets or sets the default column width in the worksheet, in unit of inches. * @param value - The value to set. */ setStandardWidthInch(value: number) : void; /** * @deprecated Please use the 'standardWidthPixels' property instead. * Gets or sets the default column width in the worksheet, in unit of pixels. */ getStandardWidthPixels() : number; /** * Gets or sets the default column width in the worksheet, in unit of pixels. */ standardWidthPixels : number; /** * @deprecated Please use the 'standardWidthPixels' property instead. * Gets or sets the default column width in the worksheet, in unit of pixels. * @param value - The value to set. */ setStandardWidthPixels(value: number) : void; /** * @deprecated Please use the 'standardWidth' property instead. * Gets or sets the default column width in the worksheet, in unit of characters. */ getStandardWidth() : number; /** * Gets or sets the default column width in the worksheet, in unit of characters. */ standardWidth : number; /** * @deprecated Please use the 'standardWidth' property instead. * Gets or sets the default column width in the worksheet, in unit of characters. * @param value - The value to set. */ setStandardWidth(value: number) : void; /** * @deprecated Please use the 'standardHeight' property instead. * Gets or sets the default row height in this worksheet, in unit of points. */ getStandardHeight() : number; /** * Gets or sets the default row height in this worksheet, in unit of points. */ standardHeight : number; /** * @deprecated Please use the 'standardHeight' property instead. * Gets or sets the default row height in this worksheet, in unit of points. * @param value - The value to set. */ setStandardHeight(value: number) : void; /** * @deprecated Please use the 'standardHeightPixels' property instead. * Gets or sets the default row height in this worksheet, in unit of pixels. */ getStandardHeightPixels() : number; /** * Gets or sets the default row height in this worksheet, in unit of pixels. */ standardHeightPixels : number; /** * @deprecated Please use the 'standardHeightPixels' property instead. * Gets or sets the default row height in this worksheet, in unit of pixels. * @param value - The value to set. */ setStandardHeightPixels(value: number) : void; /** * @deprecated Please use the 'standardHeightInch' property instead. * Gets or sets the default row height in this worksheet, in unit of inches. */ getStandardHeightInch() : number; /** * Gets or sets the default row height in this worksheet, in unit of inches. */ standardHeightInch : number; /** * @deprecated Please use the 'standardHeightInch' property instead. * Gets or sets the default row height in this worksheet, in unit of inches. * @param value - The value to set. */ setStandardHeightInch(value: number) : void; /** * @deprecated Please use the 'preserveString' property instead. * Gets or sets a value indicating whether all worksheet values are preserved as strings. * Default is false. */ getPreserveString() : boolean; /** * Gets or sets a value indicating whether all worksheet values are preserved as strings. * Default is false. */ preserveString : boolean; /** * @deprecated Please use the 'preserveString' property instead. * Gets or sets a value indicating whether all worksheet values are preserved as strings. * Default is false. * @param value - The value to set. */ setPreserveString(value: boolean) : void; /** * @deprecated Please use the 'minRow' property instead. * Minimum row index of cell which contains data or style. * * @remarks * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMinRow() : number; /** * Minimum row index of cell which contains data or style. * * @remarks * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly minRow : number; /** * @deprecated Please use the 'maxRow' property instead. * Maximum row index of cell which contains data or style. * * @remarks * Return -1 if there is no cell which contains data or style in the worksheet. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMaxRow() : number; /** * Maximum row index of cell which contains data or style. * * @remarks * Return -1 if there is no cell which contains data or style in the worksheet. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly maxRow : number; /** * @deprecated Please use the 'minColumn' property instead. * Minimum column index of those cells that have been instantiated in the collection(does not include the column * where style is defined for the whole column but no cell has been instantiated in it). * * @remarks * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMinColumn() : number; /** * Minimum column index of those cells that have been instantiated in the collection(does not include the column * where style is defined for the whole column but no cell has been instantiated in it). * * @remarks * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly minColumn : number; /** * @deprecated Please use the 'maxColumn' property instead. * Maximum column index of those cells that have been instantiated in the collection(does not include the column * where style is defined for the whole column but no cell has been instantiated in it). * * @remarks * Return -1 if there is no cell has been instantiated. */ getMaxColumn() : number; /** * Maximum column index of those cells that have been instantiated in the collection(does not include the column * where style is defined for the whole column but no cell has been instantiated in it). * * @remarks * Return -1 if there is no cell has been instantiated. */ readonly maxColumn : number; /** * @deprecated Please use the 'minDataRow' property instead. * Minimum row index of cell which contains data. * * @remarks * Return -1 if there is no cell which contains data. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMinDataRow() : number; /** * Minimum row index of cell which contains data. * * @remarks * Return -1 if there is no cell which contains data. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly minDataRow : number; /** * @deprecated Please use the 'maxDataRow' property instead. * Maximum row index of cell which contains data. * * @remarks * Return -1 if there is no cell which contains data. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMaxDataRow() : number; /** * Maximum row index of cell which contains data. * * @remarks * Return -1 if there is no cell which contains data. * This property needs to iterate and check cells and rows dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly maxDataRow : number; /** * @deprecated Please use the 'minDataColumn' property instead. * Minimum column index of cell which contains data. * * @remarks * -1 will be returned if there is no cell which contains data. * This property needs to iterate and check all cells in a worksheet dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMinDataColumn() : number; /** * Minimum column index of cell which contains data. * * @remarks * -1 will be returned if there is no cell which contains data. * This property needs to iterate and check all cells in a worksheet dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly minDataColumn : number; /** * @deprecated Please use the 'maxDataColumn' property instead. * Maximum column index of cell which contains data. * * @remarks * -1 will be returned if there is no cell which contains data. * This property needs to iterate and check all cells in a worksheet dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ getMaxDataColumn() : number; /** * Maximum column index of cell which contains data. * * @remarks * -1 will be returned if there is no cell which contains data. * This property needs to iterate and check all cells in a worksheet dynamically, * so it is a time-consumed progress and should not be invoked repeatedly, * such as using it directly as condition in a loop. */ readonly maxDataColumn : number; /** * Indicates that row height and default font height matches */ isDefaultRowHeightMatched : boolean; /** * @deprecated Please use the 'isDefaultRowHeightMatched' property instead. * Indicates that row height and default font height matches * @param value - The value to set. */ setIsDefaultRowHeightMatched(value: boolean) : void; /** * Indicates whether the row is default hidden. */ isDefaultRowHidden : boolean; /** * @deprecated Please use the 'isDefaultRowHidden' property instead. * Indicates whether the row is default hidden. * @param value - The value to set. */ setIsDefaultRowHidden(value: boolean) : void; /** * @deprecated Please use the 'columns' property instead. * Gets the collection of objects that represents the individual columns in this worksheet. */ getColumns() : ColumnCollection; /** * Gets the collection of objects that represents the individual columns in this worksheet. */ readonly columns : ColumnCollection; /** * @deprecated Please use the 'ranges' property instead. * Gets the collection of objects created at run time. */ getRanges() : RangeCollection; /** * Gets the collection of objects created at run time. */ readonly ranges : RangeCollection; /** * @deprecated Please use the 'lastCell' property instead. * Gets the last cell in this worksheet. * * @remarks * Returns null if there is no data in the worksheet. */ getLastCell() : Cell; /** * Gets the last cell in this worksheet. * * @remarks * Returns null if there is no data in the worksheet. */ readonly lastCell : Cell; /** * @deprecated Please use the 'maxDisplayRange' property instead. * Gets the max range which includes data, merged cells and shapes. * * @remarks * Reutrns null if the worksheet is empty since Aspose.Cells 21.5.2. */ getMaxDisplayRange() : Range; /** * Gets the max range which includes data, merged cells and shapes. * * @remarks * Reutrns null if the worksheet is empty since Aspose.Cells 21.5.2. */ readonly maxDisplayRange : Range; /** * @deprecated Please use the 'firstCell' property instead. * Gets the first cell in this worksheet. * * @remarks * Returns null if there is no data in the worksheet. */ getFirstCell() : Cell; /** * Gets the first cell in this worksheet. * * @remarks * Returns null if there is no data in the worksheet. */ readonly firstCell : Cell; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Gets the cells enumerator. * @returns * The cells enumerator * * @remarks * When traversing elements by the returned Enumerator, the cells collection * should not be modified(such as operations that will cause new Cell/Row be instantiated or existing Cell/Row be deleted). * Otherwise the enumerator may not be able to traverse all cells correctly(some elements may be traversed repeatedly or skipped). */ getEnumerator() : CellEnumerator; /** * Gets all merged cells. */ getMergedAreas() : CellArea[]; /** * Gets the element or null at the specified cell row index and column index. * @param row - Row index * @param column - Column index * @returns * Return Cell object if a Cell object exists. * Return null if the cell does not exist. * * @remarks * NOTE: This member is now obsolete. Instead, * please use CheckCell(int row, int column) method. * This method will be removed 12 months later since February 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.CheckCell(int row, int column) instead. */ getCell(row: number, column: number) : Cell; /** * Gets the element at the specified cell row index. * @param row - Row index * @returns * If the row object does exist return Row object, otherwise return null. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Cells.CheckRow(int row) method. * This method will be removed 12 months later since February 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.CheckRow(int row) instead. */ getRow(row: number) : Row; /** * Gets the element or null at the specified cell row index and column index. * @param row - Row index * @param column - Column index * @returns * Return Cell object if a Cell object exists. * Return null if the cell does not exist. */ checkCell(row: number, column: number) : Cell; /** * Gets the element or null at the specified cell row index. * @param row - Row index * @returns * Returns object If the row object does exist, otherwise returns null. */ checkRow(row: number) : Row; /** * Gets the element or null at the specified column index. * @param columnIndex - The column index. * @returns * The Column object. */ checkColumn(columnIndex: number) : Column; /** * Checks whether a row at given index is hidden. * @param rowIndex - row index * @returns * true if the row is hidden */ isRowHidden(rowIndex: number) : boolean; /** * Checks whether a column at given index is hidden. * @param columnIndex - column index * @returns * true if the column is hidden. */ isColumnHidden(columnIndex: number) : boolean; /** * Adds a range object reference to cells * @param rangeObject - The range object will be contained in the cells */ addRange(rangeObject: Range) : void; /** * Creates a object from a range of cells. * @param upperLeftCell - Upper left cell name. * @param lowerRightCell - Lower right cell name. * @returns * A object */ createRange(upperLeftCell: string, lowerRightCell: string) : Range; /** * Creates a object from a range of cells. * @param firstRow - First row of this range * @param firstColumn - First column of this range * @param totalRows - Number of rows * @param totalColumns - Number of columns * @returns * A object */ createRange(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number) : Range; /** * Creates a object from an address of the range. * @param address - The address of the range. * @returns * A object */ createRange(address: string) : Range; /** * Creates a object from rows of cells or columns of cells. * @param firstIndex - First row index or first column index, zero based. * @param number - Total number of rows or columns, one based. * @param isVertical - True - Range created from columns of cells. False - Range created from rows of cells. * @returns * A object. */ createRange(firstIndex: number, number: number, isVertical: boolean) : Range; /** * Clears all data of the worksheet. */ clear() : void; /** * Imports an array of formula into a worksheet. * @param stringArray - Formula array. * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. * @param isVertical - Specifies to import data vertically or horizontally. */ importFormulaArray(stringArray: string[], firstRow: number, firstColumn: number, isVertical: boolean) : void; /** * Splits content in specified column into multiple columns.. * @param row - The row index. * @param column - The column index. * @param totalRows - The number of rows. * @param options - The split options. * @returns * Total column count of the split values. */ textToColumns(row: number, column: number, totalRows: number, options: TxtLoadOptions) : number; /** * Import a CSV file to the cells. * @param fileName - The CSV file name. * @param splitter - The splitter * @param convertNumericData - Whether the string in text file is converted to numeric data. * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSV(fileName: string, splitter: string, convertNumericData: boolean, firstRow: number, firstColumn: number) : void; /** * Import a CSV file to the cells. * @param stream - The CSV file stream. * @param splitter - The splitter * @param convertNumericData - Whether the string in text file is converted to numeric data. * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSV(stream: Uint8Array, splitter: string, convertNumericData: boolean, firstRow: number, firstColumn: number) : void; /** * Import a CSV file to the cells. * @param fileName - The CSV file name. * @param options - The load options for reading text file * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSV(fileName: string, options: TxtLoadOptions, firstRow: number, firstColumn: number) : void; /** * Import a CSV file to the cells. * @param stream - The CSV file stream. * @param options - The load options for reading text file * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSV(stream: Uint8Array, options: TxtLoadOptions, firstRow: number, firstColumn: number) : void; /** * Import a CSV file to the cells. * @param fileName - The CSV file name. * @param splitter - The splitter * @param convertNumericData - Whether the string in text file is converted to numeric data. * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSVAsync(fileName: string, splitter: string, convertNumericData: boolean, firstRow: number, firstColumn: number) : Promise; /** * Import a CSV file to the cells. * @param stream - The CSV file stream. * @param splitter - The splitter * @param convertNumericData - Whether the string in text file is converted to numeric data. * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSVAsync(stream: Uint8Array, splitter: string, convertNumericData: boolean, firstRow: number, firstColumn: number) : Promise; /** * Import a CSV file to the cells. * @param fileName - The CSV file name. * @param options - The load options for reading text file * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSVAsync(fileName: string, options: TxtLoadOptions, firstRow: number, firstColumn: number) : Promise; /** * Import a CSV file to the cells. * @param stream - The CSV file stream. * @param options - The load options for reading text file * @param firstRow - The row number of the first cell to import in. * @param firstColumn - The column number of the first cell to import in. */ importCSVAsync(stream: Uint8Array, options: TxtLoadOptions, firstRow: number, firstColumn: number) : Promise; /** * Merges a specified range of cells into a single cell. * @param firstRow - First row of this range(zero based) * @param firstColumn - First column of this range(zero based) * @param totalRows - Number of rows(one based) * @param totalColumns - Number of columns(one based) * * @remarks * Reference the merged cell via the address of the upper-left cell in the range. */ merge(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number) : void; /** * Merges a specified range of cells into a single cell. * @param firstRow - First row of this range(zero based) * @param firstColumn - First column of this range(zero based) * @param totalRows - Number of rows(one based) * @param totalColumns - Number of columns(one based) * @param mergeConflict - Merge conflict merged ranges. * * @remarks * Reference the merged cell via the address of the upper-left cell in the range. * If mergeConflict is true and the merged range conflicts with other merged cells, * other merged cells will be automatically removed. */ merge(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number, mergeConflict: boolean) : void; /** * Merges a specified range of cells into a single cell. * @param firstRow - First row of this range(zero based) * @param firstColumn - First column of this range(zero based) * @param totalRows - Number of rows(one based) * @param totalColumns - Number of columns(one based) * @param checkConflict - Indicates whether check the merged cells intersects other merged cells * @param mergeConflict - Merge conflict merged ranges. * * @remarks * Reference the merged cell via the address of the upper-left cell in the range. * If mergeConflict is true and the merged range conflicts with other merged cells, * other merged cells will be automatically removed. */ merge(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number, checkConflict: boolean, mergeConflict: boolean) : void; /** * Unmerges a specified range of merged cells. * @param firstRow - First row of this range(zero based) * @param firstColumn - First column of this range(zero based) * @param totalRows - Number of rows(one based) * @param totalColumns - Number of columns(one based) */ unMerge(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number) : void; /** * Clears all merged ranges. */ clearMergedCells() : void; /** * Hides a row. * @param row - Row index. */ hideRow(row: number) : void; /** * Unhides a row. * @param row - Row index. * @param height - Row height. The row's height will be changed only when the row is hidden and given height value is positive. */ unhideRow(row: number, height: number) : void; /** * Hides multiple rows. * @param row - The row index. * @param totalRows - The row number. */ hideRows(row: number, totalRows: number) : void; /** * Unhides the hidden rows. * @param row - The row index. * @param totalRows - The row number. * @param height - Row height. The row's height will be changed only when the row is hidden and given height value is positive. */ unhideRows(row: number, totalRows: number, height: number) : void; /** * Sets row height in unit of pixels. * @param row - Row index. * @param pixels - Number of pixels. */ setRowHeightPixel(row: number, pixels: number) : void; /** * Sets row height in unit of inches. * @param row - Row index. * @param inches - Number of inches. It should be between 0 and 409.5/72. */ setRowHeightInch(row: number, inches: number) : void; /** * Sets the height of the specified row. * @param row - Row index. * @param height - Height of row.In unit of point It should be between 0 and 409.5. */ setRowHeight(row: number, height: number) : void; /** * Gets row's height. * @param row - The row index. * @param isOriginal - Whether returns the original row height or 0 for hidden row. * @param unitType - Unit type of the returned height value * @returns * Row's height */ getRowHeight(row: number, isOriginal: boolean, unitType: CellsUnitType) : number; /** * Gets the height of a specified row, in unit of points. * @param row - Row index * @returns * Height of row */ getRowHeight(row: number) : number; /** * Gets original row's height in unit of point if the row is hidden * @param row - The row index. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Cells.GetRowHeight(int,bool,CellsUnitType) method. * This method will be removed 12 months later since April 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.GetRowHeight(int,bool,CellsUnitType) method, instead. */ getRowOriginalHeightPoint(row: number) : number; /** * Gets the column width. * @param column - The column index. * @param isOriginal - Indicates whether getting original width. * @param unitType - */ getColumnWidth(column: number, isOriginal: boolean, unitType: CellsUnitType) : number; /** * Gets the width(in unit of characters) of the specified column in normal view * @param column - Column index * @returns * Width of column. For spreadsheet, column width is measured as the number of characters * of the maximum digit width of the numbers 0~9 as rendered in the normal style's font. */ getColumnWidth(column: number) : number; /** * Gets original column's height in unit of point if the column is hidden * @param column - The row index. * * @remarks * NOTE: This method is now obsolete. Instead, * please use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method. * This method will be removed 12 months later since April 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method, instead. */ getColumnOriginalWidthPoint(column: number) : number; /** * Hides a column. * @param column - Column index. */ hideColumn(column: number) : void; /** * Unhides a column * @param column - Column index. * @param width - Column width. */ unhideColumn(column: number, width: number) : void; /** * Hide multiple columns. * @param column - Column index. * @param totalColumns - Column number. */ hideColumns(column: number, totalColumns: number) : void; /** * Unhide multiple columns. * @param column - Column index. * @param totalColumns - Column number * @param width - Column width. * * @remarks * Only applies the column width to the hidden columns. */ unhideColumns(column: number, totalColumns: number, width: number) : void; /** * Gets the height of a specified row. * @param row - Row index. * @returns * Height of row. */ getViewRowHeight(row: number) : number; /** * Gets the height of a specified row in unit of inches. * @param row - Row index * @returns * Height of row */ getRowHeightInch(row: number) : number; /** * Gets the height of a specified row in unit of inches. * @param row - Row index * @returns * Height of row */ getViewRowHeightInch(row: number) : number; /** * Gets the height of a specified row in unit of pixel. * @param row - Row index * @returns * Height of row */ getRowHeightPixel(row: number) : number; /** * Sets column width in unit of pixels in normal view. * @param column - Column index. * @param pixels - Number of pixels. */ setColumnWidthPixel(column: number, pixels: number) : void; /** * Sets column width in unit of inches in normal view. * @param column - Column index. * @param inches - Number of inches. */ setColumnWidthInch(column: number, inches: number) : void; /** * Sets the width of the specified column in normal view. * @param column - Column index. * @param width - Width of column in unit of characters.Column width must be between 0 and 255. * * @remarks * For spreadsheet, column width is measured as the number of characters * of the maximum digit width of the numbers 0~9 as rendered in the normal style's font. */ setColumnWidth(column: number, width: number) : void; /** * Gets the width of the specified column in normal view, in units of pixel. * @param column - Column index * @returns * Width of column in normal view. */ getColumnWidthPixel(column: number) : number; /** * Gets the width of the specified column in normal view, in units of pixel. * @param column - Column index * @param original - Indicates whether returning original width even when the column is hidden * @returns * Width of column in normal view. * * @remarks * NOTE: This method is now obsolete. Instead, * please use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method. * This method will be removed 12 months later since April 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method, instead. */ getColumnWidthPixel(column: number, original: boolean) : number; /** * Gets the width of the specified column in normal view, in units of inches. * @param column - Column index * @returns * Width of column * * @remarks * NOTE: This method is now obsolete. Instead, * please use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method. * This method will be removed 12 months later since April 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Cells.GetColumnWidth(int ,bool , CellsUnitType ) method, instead. */ getColumnWidthInch(column: number) : number; /** * Get the width in different view type. * @param column - The column index. * @returns * the column width in unit of pixels */ getViewColumnWidthPixel(column: number) : number; /** * Sets the width of the column in different view. * @param column - The column index. * @param pixels - The width in unit of pixels. * * @remarks * If the current view type is , the column's width is same as printed width. */ setViewColumnWidthPixel(column: number, pixels: number) : void; /** * Gets the last row index of cell which contains data in the specified column. * @param column - Column index. * @returns * last row index. */ getLastDataRow(column: number) : number; /** * Gets the first row index of cell which contains data in the specified column. * @param column - Column index. * @returns * first row index. */ getFirstDataRow(column: number) : number; /** * Applies formats for a whole column. * @param column - The column index. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. */ applyColumnStyle(column: number, style: Style, flag: StyleFlag) : void; /** * Applies formats for a whole row. * @param row - The row index. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. */ applyRowStyle(row: number, style: Style, flag: StyleFlag) : void; /** * Applies formats for a whole worksheet. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. */ applyStyle(style: Style, flag: StyleFlag) : void; /** * Copies data and formats of a whole column. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceColumnIndex - Source column index. * @param destinationColumnIndex - Destination column index. * @param columnNumber - The copied column number. * @param pasteOptions - the options of pasting. */ copyColumns(sourceCells: Cells, sourceColumnIndex: number, destinationColumnIndex: number, columnNumber: number, pasteOptions: PasteOptions) : void; /** * Copies data and formats of whole columns. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceColumnIndex - Source column index. * @param destinationColumnIndex - Destination column index. * @param columnNumber - The copied column number. */ copyColumns(sourceCells: Cells, sourceColumnIndex: number, destinationColumnIndex: number, columnNumber: number) : void; /** * Copies data and formats of the whole columns. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceColumnIndex - Source column index. * @param sourceTotalColumns - The number of the source columns. * @param destinationColumnIndex - Destination column index. * @param destinationTotalColumns - The number of the destination columns. */ copyColumns(sourceCells: Cells, sourceColumnIndex: number, sourceTotalColumns: number, destinationColumnIndex: number, destinationTotalColumns: number) : void; /** * Copies data and formats of a whole column. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceColumnIndex - Source column index. * @param destinationColumnIndex - Destination column index. */ copyColumn(sourceCells: Cells, sourceColumnIndex: number, destinationColumnIndex: number) : void; /** * Copies data and formats of a whole row. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceRowIndex - Source row index. * @param destinationRowIndex - Destination row index. */ copyRow(sourceCells: Cells, sourceRowIndex: number, destinationRowIndex: number) : void; /** * Copies data and formats of some whole rows. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceRowIndex - Source row index. * @param destinationRowIndex - Destination row index. * @param rowNumber - The copied row number. */ copyRows(sourceCells: Cells, sourceRowIndex: number, destinationRowIndex: number, rowNumber: number) : void; /** * Copies data and formats of some whole rows. * @param sourceCells - Source Cells object contains data and formats to copy. * @param sourceRowIndex - Source row index. * @param destinationRowIndex - Destination row index. * @param rowNumber - The copied row number. * @param copyOptions - The copy options. */ copyRows(sourceCells: Cells, sourceRowIndex: number, destinationRowIndex: number, rowNumber: number, copyOptions: CopyOptions) : void; /** * Copies data and formats of some whole rows. * @param sourceCells0 - Source Cells object contains data and formats to copy. * @param sourceRowIndex - Source row index. * @param destinationRowIndex - Destination row index. * @param rowNumber - The copied row number. * @param copyOptions - The copy options. * @param pasteOptions - the options of pasting. */ copyRows(sourceCells0: Cells, sourceRowIndex: number, destinationRowIndex: number, rowNumber: number, copyOptions: CopyOptions, pasteOptions: PasteOptions) : void; /** * Gets the outline level (zero-based) of the row. * @param rowIndex - The row index. * @returns * The outline level (zero-based) of the row. * * @remarks * If the row is not grouped, returns zero. */ getGroupedRowOutlineLevel(rowIndex: number) : number; /** * Gets the outline level (zero-based) of the column. * @param columnIndex - The column index * @returns * The outline level of the column * * @remarks * If the column is not grouped, returns zero. */ getGroupedColumnOutlineLevel(columnIndex: number) : number; /** * Gets the max grouped column outline level (zero-based). * @returns * The max grouped column outline level (zero-based) */ getMaxGroupedColumnOutlineLevel() : number; /** * Gets the max grouped row outline level (zero-based). * @returns * The max grouped row outline level (zero-based) */ getMaxGroupedRowOutlineLevel() : number; /** * Expands the grouped rows/columns. * @param isVertical - True, expands the grouped rows. * @param index - The row/column index */ showGroupDetail(isVertical: boolean, index: number) : void; /** * Collapses the grouped rows/columns. * @param isVertical - True, collapse the grouped rows. * @param index - The row/column index */ hideGroupDetail(isVertical: boolean, index: number) : void; /** * Ungroups columns. * @param firstIndex - The first column index to be ungrouped. * @param lastIndex - The last column index to be ungrouped. */ ungroupColumns(firstIndex: number, lastIndex: number) : void; /** * Groups columns. * @param firstIndex - The first column index to be grouped. * @param lastIndex - The last column index to be grouped. */ groupColumns(firstIndex: number, lastIndex: number) : void; /** * Groups columns. * @param firstIndex - The first column index to be grouped. * @param lastIndex - The last column index to be grouped. * @param isHidden - Specifies if the grouped columns are hidden. */ groupColumns(firstIndex: number, lastIndex: number, isHidden: boolean) : void; /** * Ungroups rows. * @param firstIndex - The first row index to be ungrouped. * @param lastIndex - The last row index to be ungrouped. * @param isAll - True, removes all grouped info.Otherwise, remove the outer group info. */ ungroupRows(firstIndex: number, lastIndex: number, isAll: boolean) : void; /** * Ungroups rows. * @param firstIndex - The first row index to be ungrouped. * @param lastIndex - The last row index to be ungrouped. * * @remarks * Only removes outer group info. */ ungroupRows(firstIndex: number, lastIndex: number) : void; /** * Groups rows. * @param firstIndex - The first row index to be grouped. * @param lastIndex - The last row index to be grouped. * @param isHidden - Specifies if the grouped rows are hidden. */ groupRows(firstIndex: number, lastIndex: number, isHidden: boolean) : void; /** * Groups rows. * @param firstIndex - The first row index to be grouped. * @param lastIndex - The last row index to be grouped. */ groupRows(firstIndex: number, lastIndex: number) : void; /** * Deletes a column. * @param columnIndex - Index of the column to be deleted. * @param updateReference - Indicates whether update references in other worksheets. */ deleteColumn(columnIndex: number, updateReference: boolean) : void; /** * Deletes a column. * @param columnIndex - Index of the column to be deleted. */ deleteColumn(columnIndex: number) : void; /** * Deletes several columns. * @param columnIndex - Index of the first column to be deleted. * @param totalColumns - Count of columns to be deleted. * @param updateReference - Indicates whether update references in other worksheets. */ deleteColumns(columnIndex: number, totalColumns: number, updateReference: boolean) : void; /** * Deletes several columns. * @param columnIndex - Index of the first column to be deleted. * @param totalColumns - Count of columns to be deleted. * @param options - Options for the deleting operation */ deleteColumns(columnIndex: number, totalColumns: number, options: DeleteOptions) : void; /** * Check whether the range could be deleted. * @param startRow - The start row index of the range. * @param startColumn - The start column index of the range. * @param totalRows - The number of the rows in the range. * @param totalColumns - The number of the columns in the range. */ isDeletingRangeEnabled(startRow: number, startColumn: number, totalRows: number, totalColumns: number) : boolean; /** * Deletes a row. * @param rowIndex - Index of the row to be deleted. */ deleteRow(rowIndex: number) : void; /** * Deletes a row. * @param rowIndex - Index of the row to be deleted. * @param updateReference - Indicates whether update references in other worksheets. */ deleteRow(rowIndex: number, updateReference: boolean) : void; /** * Deletes multiple rows. * @param rowIndex - The first row index to be deleted. * @param totalRows - Count of rows to be deleted. * * @remarks * If the deleted range contains the top part(not whole) of the table(ListObject), * the ranged could not be deleted and nothing will be done. * It works in the same way with MS Excel. */ deleteRows(rowIndex: number, totalRows: number) : boolean; /** * Deletes multiple rows in the worksheet. * @param rowIndex - Index of the first row to be deleted. * @param totalRows - Count of rows to be deleted. * @param updateReference - Indicates whether update references in other worksheets. */ deleteRows(rowIndex: number, totalRows: number, updateReference: boolean) : boolean; /** * Deletes multiple rows in the worksheet. * @param rowIndex - Index of the first row to be deleted. * @param totalRows - Count of rows to be deleted. * @param options - Options for the deleting operation */ deleteRows(rowIndex: number, totalRows: number, options: DeleteOptions) : boolean; /** * Delete all blank columns which do not contain any data. */ deleteBlankColumns() : void; /** * Delete all blank columns which do not contain any data. * @param options - The options of deleting range. */ deleteBlankColumns(options: DeleteOptions) : void; /** * Checks whether given column is blank(does not contain any data). * @param columnIndex - the column index * @returns * true if given column does not contain any data */ isBlankColumn(columnIndex: number) : boolean; /** * Delete all blank rows which do not contain any data or other object. */ deleteBlankRows() : void; /** * Delete all blank rows which do not contain any data or some special objects such as visible comment, pivot table. * @param options - The options of deleting range. * * @remarks * For blank rows that will be deleted, it is not only required that should be true, * but also there should be no visible comment defined for any cell in those rows, * and no pivot table whose range intersects with them. */ deleteBlankRows(options: DeleteOptions) : void; /** * Inserts some columns into the worksheet. * @param columnIndex - Column index. * @param totalColumns - The number of columns. */ insertColumns(columnIndex: number, totalColumns: number) : void; /** * Inserts some columns into the worksheet. * @param columnIndex - Column index. * @param totalColumns - The number of columns. * @param updateReference - Indicates if references in other worksheets will be updated. */ insertColumns(columnIndex: number, totalColumns: number, updateReference: boolean) : void; /** * Inserts some columns into the worksheet. * @param columnIndex - Column index. * @param totalColumns - The number of columns. * @param options - The options for inserting operation. */ insertColumns(columnIndex: number, totalColumns: number, options: InsertOptions) : void; /** * Inserts a new column into the worksheet. * @param columnIndex - Column index. * @param updateReference - Indicates if references in other worksheets will be updated. */ insertColumn(columnIndex: number, updateReference: boolean) : void; /** * Inserts a new column into the worksheet. * @param columnIndex - Column index. */ insertColumn(columnIndex: number) : void; /** * Inserts multiple rows into the worksheet. * @param rowIndex - Row index. * @param totalRows - Number of rows to be inserted. * @param updateReference - Indicates if references in other worksheets will be updated. */ insertRows(rowIndex: number, totalRows: number, updateReference: boolean) : void; /** * Inserts multiple rows into the worksheet. * @param rowIndex - Row index. * @param totalRows - Number of rows to be inserted. * @param options - Options for inserting operation. */ insertRows(rowIndex: number, totalRows: number, options: InsertOptions) : void; /** * Inserts multiple rows into the worksheet. * @param rowIndex - Row index. * @param totalRows - Number of rows to be inserted. */ insertRows(rowIndex: number, totalRows: number) : void; /** * Inserts a new row into the worksheet. * @param rowIndex - Row index. */ insertRow(rowIndex: number) : void; /** * Clears contents and formatting of a range. * @param range - Range to be cleared. */ clearRange(range: CellArea) : void; /** * Clears contents and formatting of a range. * @param startRow - Start row index. * @param startColumn - Start column index. * @param endRow - End row index. * @param endColumn - End column index. */ clearRange(startRow: number, startColumn: number, endRow: number, endColumn: number) : void; /** * Clears contents of a range. * @param range - Range to be cleared. */ clearContents(range: CellArea) : void; /** * Clears contents of a range. * @param startRow - Start row index. * @param startColumn - Start column index. * @param endRow - End row index. * @param endColumn - End column index. */ clearContents(startRow: number, startColumn: number, endRow: number, endColumn: number) : void; /** * Clears formatting of a range. * @param range - Range to be cleared. */ clearFormats(range: CellArea) : void; /** * Clears formatting of a range. * @param startRow - Start row index. * @param startColumn - Start column index. * @param endRow - End row index. * @param endColumn - End column index. */ clearFormats(startRow: number, startColumn: number, endRow: number, endColumn: number) : void; /** * Link to a xml map. * @param mapName - name of xml map * @param row - row of the destination cell * @param column - column of the destination cell * @param path - path of xml element in xml map */ linkToXmlMap(mapName: string, row: number, column: number, path: string) : void; /** * Finds the cell containing with the input object. * @param what - The object to search for. /// The type should be int,double,DateTime,string,bool. * @param previousCell - Previous cell with the same object. /// This parameter can be set to null if searching from the start. * @returns * Cell object. * * @remarks * Returns null (Nothing) if no cell is found. */ find(what: Object, previousCell: Cell) : Cell; /** * Finds the cell containing with the input object. * @param what - The object to search for. /// The type should be int,double,DateTime,string,bool. * @param previousCell - Previous cell with the same object. /// This parameter can be set to null if searching from the start. * @param findOptions - Find options * @returns * Cell object. * * @remarks * Returns null (Nothing) if no cell is found. */ find(what: Object, previousCell: Cell, findOptions: FindOptions) : Cell; /** * Gets the last cell in this row. * @param rowIndex - Row index. * @returns * Cell object. */ endCellInRow(rowIndex: number) : Cell; /** * Gets the last cell with maximum row index in this range. * @param startRow - Start row index. * @param endRow - End row index. * @param startColumn - Start column index. * @param endColumn - End column index. * @returns * Cell object. */ endCellInRow(startRow: number, endRow: number, startColumn: number, endColumn: number) : Cell; /** * Gets the last cell in this column. * @param columnIndex - Column index. * @returns * Cell object. */ endCellInColumn(columnIndex: number) : Cell; /** * Gets the last cell with maximum column index in this range. * @param startRow - Start row index. * @param endRow - End row index. * @param startColumn - Start column index. * @param endColumn - End column index. * @returns * Cell object. */ endCellInColumn(startRow: number, endRow: number, startColumn: number, endColumn: number) : Cell; /** * Moves the range. * @param sourceArea - The range which should be moved. * @param destRow - The dest row. * @param destColumn - The dest column. */ moveRange(sourceArea: CellArea, destRow: number, destColumn: number) : void; /** * Insert cut range. * @param cutRange - The cut range. * @param row - The row. * @param column - The column. * @param shiftType - Indicates how to shift other objects of the target range when inserting cut range. */ insertCutCells(cutRange: Range, row: number, column: number, shiftType: ShiftType) : void; /** * Inserts a range of cells and shift cells according to the shift option. * @param area - Shift area. * @param shiftNumber - Number of rows or columns to be inserted. * @param shiftType - Shift cells option. * @param updateReference - Indicates whether update references in other worksheets. */ insertRange(area: CellArea, shiftNumber: number, shiftType: ShiftType, updateReference: boolean) : void; /** * Inserts a range of cells and shift cells according to the shift option. * @param area - Shift area. * @param shiftType - Shift cells option. */ insertRange(area: CellArea, shiftType: ShiftType) : void; /** * Inserts a range of cells and shift cells according to the shift option. * @param area - Shift area. * @param shiftNumber - Number of rows or columns to be inserted. * @param shiftType - Shift cells option. */ insertRange(area: CellArea, shiftNumber: number, shiftType: ShiftType) : void; /** * Deletes a range of cells and shift cells according to the shift option. * @param startRow - Start row index. * @param startColumn - Start column index. * @param endRow - End row index. * @param endColumn - End column index. * @param shiftType - Shift cells option. */ deleteRange(startRow: number, startColumn: number, endRow: number, endColumn: number, shiftType: ShiftType) : void; /** * Exports data in the collection to a two-dimension array object. * @param firstRow - The row number of the first cell to export out. * @param firstColumn - The column number of the first cell to export out. * @param totalRows - Number of rows to be exported * @param totalColumns - Number of columns to be exported * @returns * Exported cell value array object. */ exportArray(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number) : Object[][]; /** * Retrieves subtotals setting of the range. * @param ca - The range */ retrieveSubtotalSetting(ca: CellArea) : SubtotalSetting; /** * Creates subtotals for the range. * @param ca - The range * @param groupBy - The field to group by, as a zero-based integer offset * @param consolidationFunction - The subtotal function. * @param totalList - An array of zero-based field offsets, indicating the fields to which the subtotals are added. */ subtotal(ca: CellArea, groupBy: number, consolidationFunction: ConsolidationFunction, totalList: number[]) : void; /** * Creates subtotals for the range. * @param ca - The range * @param groupBy - The field to group by, as a zero-based integer offset * @param consolidationFunction - The subtotal function. * @param totalList - An array of zero-based field offsets, indicating the fields to which the subtotals are added. * @param replace - Indicates whether replace the current subtotals * @param pageBreaks - Indicates whether add page break between groups * @param summaryBelowData - Indicates whether add summary below data. */ subtotal(ca: CellArea, groupBy: number, consolidationFunction: ConsolidationFunction, totalList: number[], replace: boolean, pageBreaks: boolean, summaryBelowData: boolean) : void; /** * Removes all formula and replaces with the value of the formula. */ removeFormulas() : void; /** * Removes duplicate rows in the sheet. */ removeDuplicates() : void; /** * Removes duplicate values in the range. * @param startRow - The start row. * @param startColumn - The start column * @param endRow - The end row index. * @param endColumn - The end column index. */ removeDuplicates(startRow: number, startColumn: number, endRow: number, endColumn: number) : void; /** * Removes duplicate data of the range. * @param startRow - The start row. * @param startColumn - The start column * @param endRow - The end row index. * @param endColumn - The end column index. * @param hasHeaders - Indicates whether the range contains headers. * @param columnOffsets - The column offsets. */ removeDuplicates(startRow: number, startColumn: number, endRow: number, endColumn: number, hasHeaders: boolean, columnOffsets: number[]) : void; /** * Converts all string data in the worksheet to numeric value if possible. */ convertStringToNumericValue() : void; /** * Get all cells which refer to the specific cell. * @param isAll - Indicates whether check other worksheets * @param row - The row index. * @param column - The column index. */ getDependents(isAll: boolean, row: number, column: number) : Cell[]; /** * Gets all cells whose calculated result depends on specific cell. * @param row - Row index of the specific cell * @param column - Column index of the specific cell. * @param recursive - Whether returns those dependents which do not reference to the specific cell directly /// but reference to other leafs of that cell. * @returns * Enumerator to enumerate all dependents(Cell objects) * * @remarks * To use this method, please make sure the workbook has been set with true value for * and has been fully calculated with this setting. * If there is no formula reference to this cell, null will be returned. * For more details and example, please see */ getDependentsInCalculation(row: number, column: number, recursive: boolean) : CellEnumerator; /** * Gets all cells that contain embedded picture. * @returns * Enumerator to enumerate all Cell objects that contain embedded picture * * @remarks * If there is no picture which is set as "Place in Cell" in this worksheet, null will be returned. */ getCellsWithPlaceInCellPicture() : CellEnumerator; /** * Get the style of given cell. * @param row - row index * @param column - column * @returns * the style of given cell. * * @remarks * The returned style is only the one set for the cell or inherited from the row/column of the cell, * does not include the applied properties by other settings such as conditional formattings. */ getCellStyle(row: number, column: number) : Style; /** * Get the display style of given cell. * @param row - row index of given cell * @param column - column of given cell * @returns * the display style of given cell. * * @remarks * Same with , * and same with using * for . */ getCellDisplayStyle(row: number, column: number) : Style; /** * Get the display style of given cell. * @param row - row index of given cell * @param column - column of given cell * @param adjacentBorders - Indicates which borders need to be checked and adjusted according to the borders of adjacent cells. /// Please see the description for the same parameter of /// . * @returns * the display style of given cell. * * @remarks * If the cell is also affected by other settings such as conditional formatting, list objects, etc., * then the display style may be different from . * And because those settings also may be applied to empty(non-existing) cells, * using this method can avoid the instantiation of those empty cells * so the performance will be better than getting the Cell instance from Cells * and then calling . */ getCellDisplayStyle(row: number, column: number, adjacentBorders: BorderType) : Style; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Collection of the objects that represent the individual column(setting)s in a worksheet. * The Column object only represents the settings such as column width, styles, .etc. for the whole column, * has nothing to do with the fact that there are non-empty cells(data) or not in corresponding column. * And the "Count" of this collection only represents the count Column objects that have been instantiated in this collection, * has nothing to do with the fact that there are non-empty cells(data) or not in the worksheet. */ export class ColumnCollection implements Iterable { /** * Gets a object by column index. * The Column object of given column index will be instantiated if it does not exist before. */ get(columnIndex: number) : Column; /** * Gets the object by the position in the list. * @param index - The position in the list. * @returns * Returns the column object. */ getColumnByIndex(index: number) : Column; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a single column in a worksheet. */ export class Column { /** * @deprecated Please use the 'index' property instead. * Gets the index of this column. */ getIndex() : number; /** * Gets the index of this column. */ readonly index : number; /** * @deprecated Please use the 'width' property instead. * Gets and sets the column width in unit of characters. * * @remarks * For spreadsheet, column width is measured as the number of characters * of the maximum digit width of the numbers 0~9 as rendered in the normal style's font. */ getWidth() : number; /** * Gets and sets the column width in unit of characters. * * @remarks * For spreadsheet, column width is measured as the number of characters * of the maximum digit width of the numbers 0~9 as rendered in the normal style's font. */ width : number; /** * @deprecated Please use the 'width' property instead. * Gets and sets the column width in unit of characters. * @param value - The value to set. * * @remarks * For spreadsheet, column width is measured as the number of characters * of the maximum digit width of the numbers 0~9 as rendered in the normal style's font. */ setWidth(value: number) : void; /** * @deprecated Please use the 'groupLevel' property instead. * Gets the group level of the column. */ getGroupLevel() : number; /** * Gets the group level of the column. */ groupLevel : number; /** * @deprecated Please use the 'groupLevel' property instead. * Gets the group level of the column. * @param value - The value to set. */ setGroupLevel(value: number) : void; /** * Indicates whether the column is hidden. */ isHidden : boolean; /** * @deprecated Please use the 'isHidden' property instead. * Indicates whether the column is hidden. * @param value - The value to set. */ setIsHidden(value: boolean) : void; /** * @deprecated Please use the 'hasCustomStyle' property instead. * Indicates whether this column has custom style settings(different from the default one inherited from workbook). */ getHasCustomStyle() : boolean; /** * Indicates whether this column has custom style settings(different from the default one inherited from workbook). */ readonly hasCustomStyle : boolean; /** * whether the column is collapsed */ isCollapsed : boolean; /** * @deprecated Please use the 'isCollapsed' property instead. * whether the column is collapsed * @param value - The value to set. */ setIsCollapsed(value: boolean) : void; /** * Applies formats for a whole column. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. */ applyStyle(style: Style, flag: StyleFlag) : void; /** * Gets the style of this column. * * @remarks * Modifying the returned style object directly takes no effect for this column or any cells in this column. * You have to call or method * to apply the change to this column.

* Column's style is the style which will be inherited by cells in this column(those cells that have no custom style settings, * such as existing cells that have not been set style explicitly, or those that have not been instantiated) */ getStyle() : Style; /** * Sets the style of this column. * @param style - the style to be used as the default style for cells in this column. * * @remarks * This method only sets the given style as the default style for this column, * without changing the style settings for existing cells in this column. * To update style settings of existing cells to the specified style at the same time, * please use */ setStyle(style: Style) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the setting of the subtotal . */ export class SubtotalSetting { /** * @deprecated Please use the 'groupBy' property instead. * The field to group by, as a zero-based integer offset */ getGroupBy() : number; /** * The field to group by, as a zero-based integer offset */ readonly groupBy : number; /** * @deprecated Please use the 'subtotalFunction' property instead. * The subtotal function. */ getSubtotalFunction() : ConsolidationFunction; /** * The subtotal function. */ readonly subtotalFunction : ConsolidationFunction; /** * @deprecated Please use the 'totalList' property instead. * An array of zero-based field offsets, indicating the fields to which the subtotals are added. */ getTotalList() : number[]; /** * An array of zero-based field offsets, indicating the fields to which the subtotals are added. */ readonly totalList : number[]; /** * @deprecated Please use the 'summaryBelowData' property instead. * Indicates whether add summary below data. */ getSummaryBelowData() : boolean; /** * Indicates whether add summary below data. */ readonly summaryBelowData : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Common options for loading text values */ export class AbstractTextLoadOptions extends LoadOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the default encoding. Only applies for csv file. */ getEncoding() : EncodingType; /** * Gets and sets the default encoding. Only applies for csv file. */ encoding : EncodingType; /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the default encoding. Only applies for csv file. * @param value - The value to set. */ setEncoding(value: EncodingType) : void; /** * @deprecated Please use the 'loadStyleStrategy' property instead. * Indicates the strategy to apply style for parsed values when converting string value to number or datetime. */ getLoadStyleStrategy() : TxtLoadStyleStrategy; /** * Indicates the strategy to apply style for parsed values when converting string value to number or datetime. */ loadStyleStrategy : TxtLoadStyleStrategy; /** * @deprecated Please use the 'loadStyleStrategy' property instead. * Indicates the strategy to apply style for parsed values when converting string value to number or datetime. * @param value - The value to set. */ setLoadStyleStrategy(value: TxtLoadStyleStrategy) : void; /** * @deprecated Please use the 'convertNumericData' property instead. * Gets or sets a value that indicates whether the string in text file is converted to numeric data. * Default value is true. */ getConvertNumericData() : boolean; /** * Gets or sets a value that indicates whether the string in text file is converted to numeric data. * Default value is true. */ convertNumericData : boolean; /** * @deprecated Please use the 'convertNumericData' property instead. * Gets or sets a value that indicates whether the string in text file is converted to numeric data. * Default value is true. * @param value - The value to set. */ setConvertNumericData(value: boolean) : void; /** * @deprecated Please use the 'convertDateTimeData' property instead. * Gets or sets a value that indicates whether the string in text file is converted to date data. * Default value is true. */ getConvertDateTimeData() : boolean; /** * Gets or sets a value that indicates whether the string in text file is converted to date data. * Default value is true. */ convertDateTimeData : boolean; /** * @deprecated Please use the 'convertDateTimeData' property instead. * Gets or sets a value that indicates whether the string in text file is converted to date data. * Default value is true. * @param value - The value to set. */ setConvertDateTimeData(value: boolean) : void; /** * @deprecated Please use the 'keepPrecision' property instead. * Indicates whether not parsing a string value if the length is 15. */ getKeepPrecision() : boolean; /** * Indicates whether not parsing a string value if the length is 15. */ keepPrecision : boolean; /** * @deprecated Please use the 'keepPrecision' property instead. * Indicates whether not parsing a string value if the length is 15. * @param value - The value to set. */ setKeepPrecision(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for loading markdown document. */ export class MarkdownLoadOptions extends AbstractTextLoadOptions { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: AbstractTextLoadOptions); /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". */ getHasFormula() : boolean; /** * Indicates whether the text is formula if it starts with "=". */ hasFormula : boolean; /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". * @param value - The value to set. */ setHasFormula(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of loading ods file. */ export class OdsLoadOptions extends LoadOptions { /** * Represents the options of loading ods file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: LoadOptions); /** * Represents the options of loading ods file. * @param type - The load format type. */ constructor(type: LoadFormat); /** * @deprecated Please use the 'applyExcelDefaultStyleToHyperlink' property instead. * Indicates whether applying the default style of the Excel to hyperlink. */ getApplyExcelDefaultStyleToHyperlink() : boolean; /** * Indicates whether applying the default style of the Excel to hyperlink. */ applyExcelDefaultStyleToHyperlink : boolean; /** * @deprecated Please use the 'applyExcelDefaultStyleToHyperlink' property instead. * Indicates whether applying the default style of the Excel to hyperlink. * @param value - The value to set. */ setApplyExcelDefaultStyleToHyperlink(value: boolean) : void; /** * @deprecated Please use the 'refreshPivotTables' property instead. * Indicates whether refresh pivot tables when loading file. */ getRefreshPivotTables() : boolean; /** * Indicates whether refresh pivot tables when loading file. */ refreshPivotTables : boolean; /** * @deprecated Please use the 'refreshPivotTables' property instead. * Indicates whether refresh pivot tables when loading file. * @param value - The value to set. */ setRefreshPivotTables(value: boolean) : void; /** * Indicates whether the pivot table is classic. */ isClassicPivotTable : boolean; /** * @deprecated Please use the 'isClassicPivotTable' property instead. * Indicates whether the pivot table is classic. * @param value - The value to set. */ setIsClassicPivotTable(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the cell field of ods. */ export class OdsCellField { /** * @deprecated Please use the 'customFormat' property instead. * Represents the custom format of the field's value. */ getCustomFormat() : string; /** * Represents the custom format of the field's value. */ customFormat : string; /** * @deprecated Please use the 'customFormat' property instead. * Represents the custom format of the field's value. * @param value - The value to set. */ setCustomFormat(value: string) : void; /** * @deprecated Please use the 'fieldType' property instead. * Gets and sets the type of the field. */ getFieldType() : OdsCellFieldType; /** * Gets and sets the type of the field. */ fieldType : OdsCellFieldType; /** * @deprecated Please use the 'fieldType' property instead. * Gets and sets the type of the field. * @param value - The value to set. */ setFieldType(value: OdsCellFieldType) : void; /** * @deprecated Please use the 'row' property instead. * Get and sets the row index of the cell. */ getRow() : number; /** * Get and sets the row index of the cell. */ row : number; /** * @deprecated Please use the 'row' property instead. * Get and sets the row index of the cell. * @param value - The value to set. */ setRow(value: number) : void; /** * @deprecated Please use the 'column' property instead. * Get and sets the column index of the cell. */ getColumn() : number; /** * Get and sets the column index of the cell. */ column : number; /** * @deprecated Please use the 'column' property instead. * Get and sets the column index of the cell. * @param value - The value to set. */ setColumn(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the fields of ODS. */ export class OdsCellFieldCollection implements Iterable { /** * Gets the field by the index. * @param index - The index. */ get(index: number) : OdsCellField; /** * Gets the field by row and column index. * @param row - The row index. * @param column - The column index. */ get(row: number, column: number) : OdsCellField; /** * Adds a field. * @param row - The row index. * @param column - The column index. * @param fieldType - The type of the field. * @param format - The number format of the field. */ add(row: number, column: number, fieldType: OdsCellFieldType, format: string) : number; /** * Update fields value to the cells. */ updateFieldsValue() : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the cell field type of ods. */ export enum OdsCellFieldType { /** * Current date. */ Date = 0, /** * The name of the sheet. */ SheetName = 1, /** * The name of the file. */ Title = 2, } /** * Represents the type of ODS generator. */ export enum OdsGeneratorType { /** * Libre Office */ LibreOffice = 0, /** * Open Office */ OpenOffice = 1, } /** * Represents the page background of ods. */ export class OdsPageBackground { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'type' property instead. * Gets and sets the page background type. */ getType() : OdsPageBackgroundType; /** * Gets and sets the page background type. */ type : OdsPageBackgroundType; /** * @deprecated Please use the 'type' property instead. * Gets and sets the page background type. * @param value - The value to set. */ setType(value: OdsPageBackgroundType) : void; /** * @deprecated Please use the 'color' property instead. * Gets and sets the color of background. */ getColor() : Color; /** * Gets and sets the color of background. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets and sets the color of background. * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'graphicType' property instead. * Gets and sets the page background graphic type. */ getGraphicType() : OdsPageBackgroundGraphicType; /** * Gets and sets the page background graphic type. */ graphicType : OdsPageBackgroundGraphicType; /** * @deprecated Please use the 'graphicType' property instead. * Gets and sets the page background graphic type. * @param value - The value to set. */ setGraphicType(value: OdsPageBackgroundGraphicType) : void; /** * @deprecated Please use the 'graphicPositionType' property instead. * Gets and set the background graphic position. */ getGraphicPositionType() : OdsPageBackgroundGraphicPositionType; /** * Gets and set the background graphic position. */ graphicPositionType : OdsPageBackgroundGraphicPositionType; /** * @deprecated Please use the 'graphicPositionType' property instead. * Gets and set the background graphic position. * @param value - The value to set. */ setGraphicPositionType(value: OdsPageBackgroundGraphicPositionType) : void; /** * Indicates whether it's a linked graphic. */ readonly isLink : boolean; /** * @deprecated Please use the 'linkedGraphic' property instead. * Gets and sets the linked graphic path. */ getLinkedGraphic() : string; /** * Gets and sets the linked graphic path. */ linkedGraphic : string; /** * @deprecated Please use the 'linkedGraphic' property instead. * Gets and sets the linked graphic path. * @param value - The value to set. */ setLinkedGraphic(value: string) : void; /** * @deprecated Please use the 'graphicData' property instead. * Gets and sets the graphic data. */ getGraphicData() : Uint8Array; /** * Gets and sets the graphic data. */ graphicData : Uint8Array; /** * @deprecated Please use the 'graphicData' property instead. * Gets and sets the graphic data. * @param value - The value to set. */ setGraphicData(value: Uint8Array) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the position. */ export enum OdsPageBackgroundGraphicPositionType { /** * Top left. */ TopLeft = 0, /** * Top center. */ TopCenter = 1, /** * Top right. */ TopRight = 2, /** * Center left. */ CenterLeft = 3, /** * Center. */ CenterCenter = 4, /** * Center right. */ CenterRight = 5, /** * Bottom left. */ BottomLeft = 6, /** * Bottom center. */ BottomCenter = 7, /** * Bottom right. */ BottomRight = 8, } /** * Represents the type of formatting page background with image. */ export enum OdsPageBackgroundGraphicType { /** * Set the image at specific position. */ Position = 0, /** * Stretch the image. */ Area = 1, /** * Repeat and repeat the image. */ Tile = 2, } /** * Represents the page background type of ods. */ export enum OdsPageBackgroundType { /** * No background. */ None = 0, /** * Formats the background with color. */ Color = 1, /** * Formats the background with image. */ Graphic = 2, } /** * Enumerates page layout alignment types. */ export enum PageLayoutAlignmentType { /** * Represents bottom page layout alignment. */ Bottom = 0, /** * Represents center page layout alignment. */ Center = 1, /** * Represents left page layout alignment. */ Left = 2, /** * Represents right page layout alignment. */ Right = 3, /** * Represents top page layout alignment. */ Top = 4, } /** * Represents two color gradient. */ export class TwoColorGradient { /** * @param color1 - * @param color2 - * @param gradientStyleType - * @param variant - */ constructor(color1: Color, color2: Color, gradientStyleType: GradientStyleType, variant: number); /** * @deprecated Please use the 'color1' property instead. * Gets and sets the first gradient color. */ getColor1() : Color; /** * Gets and sets the first gradient color. */ color1 : Color; /** * @deprecated Please use the 'color1' property instead. * Gets and sets the first gradient color. * @param value - The value to set. */ setColor1(value: Color) : void; /** * @deprecated Please use the 'color2' property instead. * Gets and sets the second gradient color. */ getColor2() : Color; /** * Gets and sets the second gradient color. */ color2 : Color; /** * @deprecated Please use the 'color2' property instead. * Gets and sets the second gradient color. * @param value - The value to set. */ setColor2(value: Color) : void; /** * @deprecated Please use the 'gradientStyleType' property instead. * Gets and sets gradient shading style. */ getGradientStyleType() : GradientStyleType; /** * Gets and sets gradient shading style. */ gradientStyleType : GradientStyleType; /** * @deprecated Please use the 'gradientStyleType' property instead. * Gets and sets gradient shading style. * @param value - The value to set. */ setGradientStyleType(value: GradientStyleType) : void; /** * @deprecated Please use the 'variant' property instead. * Gets and sets the gradient variant. */ getVariant() : number; /** * Gets and sets the gradient variant. */ variant : number; /** * @deprecated Please use the 'variant' property instead. * Gets and sets the gradient variant. * @param value - The value to set. */ setVariant(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Simple implementation of by checking and comparing current system time with user specified limit. * * @remarks * This implementation is just a simple solution for simple scenarios. * It needs to frequently retrieve and check the system time so itself may have a negative impact on performance to some extent. */ export class SystemTimeInterruptMonitor { /** * Constructs one interruption monitor. * @param terminateWithoutException - */ constructor(terminateWithoutException: boolean); /** * This implementation just checks whether the time cost(from the time when starting this monitor to now) is greater than user specified limit. */ isInterruptionRequested() : boolean; /** * See . * This property is specified by user when constructing this monitor instance. */ getTerminateWithoutException() : boolean; /** * Starts the monitor with the specified time limit. The start time to calculate time cost is just when this method is called, * so the procedure which needs to be monitored should be started just after this call. * @param msLimit - time limit(ms) to require the interruption. */ startMonitor(msLimit: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Summary description of Timeline View * Due to MS Excel, Excel 2003 does not support Timeline */ export class Timeline { /** * @deprecated Please use the 'showHeader' property instead. * Indicates whether to display the header of this timeline. */ getShowHeader() : boolean; /** * Indicates whether to display the header of this timeline. */ showHeader : boolean; /** * @deprecated Please use the 'showHeader' property instead. * Indicates whether to display the header of this timeline. * @param value - The value to set. */ setShowHeader(value: boolean) : void; /** * @deprecated Please use the 'showSelectionLabel' property instead. * Indicates whether to display the selction label. */ getShowSelectionLabel() : boolean; /** * Indicates whether to display the selction label. */ showSelectionLabel : boolean; /** * @deprecated Please use the 'showSelectionLabel' property instead. * Indicates whether to display the selction label. * @param value - The value to set. */ setShowSelectionLabel(value: boolean) : void; /** * @deprecated Please use the 'showTimeLevel' property instead. * Indicates whether to display the drop-down selection box of the time level. */ getShowTimeLevel() : boolean; /** * Indicates whether to display the drop-down selection box of the time level. */ showTimeLevel : boolean; /** * @deprecated Please use the 'showTimeLevel' property instead. * Indicates whether to display the drop-down selection box of the time level. * @param value - The value to set. */ setShowTimeLevel(value: boolean) : void; /** * @deprecated Please use the 'showHorizontalScrollbar' property instead. * Indicates whether to display the horizontal scroll bar. */ getShowHorizontalScrollbar() : boolean; /** * Indicates whether to display the horizontal scroll bar. */ showHorizontalScrollbar : boolean; /** * @deprecated Please use the 'showHorizontalScrollbar' property instead. * Indicates whether to display the horizontal scroll bar. * @param value - The value to set. */ setShowHorizontalScrollbar(value: boolean) : void; /** * @deprecated Please use the 'startDate' property instead. * Gets and sets the start date of the timespan scrolling position of this . */ getStartDate() : Date; /** * Gets and sets the start date of the timespan scrolling position of this . */ startDate : Date; /** * @deprecated Please use the 'startDate' property instead. * Gets and sets the start date of the timespan scrolling position of this . * @param value - The value to set. */ setStartDate(value: Date) : void; /** * @deprecated Please use the 'currentLevel' property instead. * The current time level of the Timeline. */ getCurrentLevel() : TimelineLevelType; /** * The current time level of the Timeline. */ currentLevel : TimelineLevelType; /** * @deprecated Please use the 'currentLevel' property instead. * The current time level of the Timeline. * @param value - The value to set. */ setCurrentLevel(value: TimelineLevelType) : void; /** * @deprecated Please use the 'selectionLevel' property instead. * Gets and sets the time level at which the current selection was made for the Timeline. */ getSelectionLevel() : TimelineLevelType; /** * Gets and sets the time level at which the current selection was made for the Timeline. */ selectionLevel : TimelineLevelType; /** * @deprecated Please use the 'selectionLevel' property instead. * Gets and sets the time level at which the current selection was made for the Timeline. * @param value - The value to set. */ setSelectionLevel(value: TimelineLevelType) : void; /** * @deprecated Please use the 'caption' property instead. * Gets or sets the caption of this Timeline. */ getCaption() : string; /** * Gets or sets the caption of this Timeline. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Gets or sets the caption of this Timeline. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'shape' property instead. * Returns the object associated with this Timeline. */ getShape() : TimelineShape; /** * Returns the object associated with this Timeline. */ readonly shape : TimelineShape; /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the specified Timeline */ getName() : string; /** * Returns or sets the name of the specified Timeline */ name : string; /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the specified Timeline * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'leftPixel' property instead. * Returns or sets the horizontal offset of timeline shape from its left column, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ getLeftPixel() : number; /** * Returns or sets the horizontal offset of timeline shape from its left column, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ leftPixel : number; /** * @deprecated Please use the 'leftPixel' property instead. * Returns or sets the horizontal offset of timeline shape from its left column, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ setLeftPixel(value: number) : void; /** * @deprecated Please use the 'topPixel' property instead. * Returns or sets the vertical offset of timeline shape from its top row, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ getTopPixel() : number; /** * Returns or sets the vertical offset of timeline shape from its top row, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ topPixel : number; /** * @deprecated Please use the 'topPixel' property instead. * Returns or sets the vertical offset of timeline shape from its top row, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ setTopPixel(value: number) : void; /** * @deprecated Please use the 'widthPixel' property instead. * Returns or sets the width of the specified timeline, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ getWidthPixel() : number; /** * Returns or sets the width of the specified timeline, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ widthPixel : number; /** * @deprecated Please use the 'widthPixel' property instead. * Returns or sets the width of the specified timeline, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ setWidthPixel(value: number) : void; /** * @deprecated Please use the 'heightPixel' property instead. * Returns or sets the height of the specified timeline, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ getHeightPixel() : number; /** * Returns or sets the height of the specified timeline, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ heightPixel : number; /** * @deprecated Please use the 'heightPixel' property instead. * Returns or sets the height of the specified timeline, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ setHeightPixel(value: number) : void; /** * Gets the selected range of date time. */ getSelectedDateTimeRange() : Date[]; /** * Select item between the date time. * @param start - The start date time * @param end - The end date time * @param calculate - Indicates whether to calculate relative pivot tables * * @remarks * must be set before calling this method. * If this method is called, will be . */ select(start: Date, end: Date, calculate: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the collection of all the objects on the worksheet. * It was supported since Excel 2013. */ export class TimelineCollection implements Iterable { /** * Gets the Timeline by index. */ get(index: number) : Timeline; /** * Gets the Timeline by Timeline's name. */ get(name: string) : Timeline; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Timeline range. * @param column - Column index of the cell in the upper-left corner of the Timeline range. * @param baseFieldName - The name of PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, row: number, column: number, baseFieldName: string) : number; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell name in the upper-left corner of the Timeline range. * @param baseFieldName - The name of PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, destCellName: string, baseFieldName: string) : number; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Timeline range. * @param column - Column index of the cell in the upper-left corner of the Timeline range. * @param baseFieldIndex - The index of PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, row: number, column: number, baseFieldIndex: number) : number; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell name in the upper-left corner of the Timeline range. * @param baseFieldIndex - The index of PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, destCellName: string, baseFieldIndex: number) : number; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Timeline range. * @param column - Column index of the cell in the upper-left corner of the Timeline range. * @param baseField - The PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, row: number, column: number, baseField: PivotField) : number; /** * Add a new Timeline using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell name in the upper-left corner of the Timeline range. * @param baseField - The PivotField in PivotTable.BaseFields * @returns * The new add Timeline index */ add(pivot: PivotTable, destCellName: string, baseField: PivotField) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the level type of */ export enum TimelineLevelType { /** * Year */ Year = 0, /** * Quarter */ Quarter = 1, /** * Month */ Month = 2, /** * Day */ Day = 3, } /** * Represents utility to convert files to other formats. */ export class ConversionUtility { /** * Converts Excel files to other formats. * @param source - The source file name. * @param saveAs - The file name of expected file. */ static convert(source: string, saveAs: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents type how to export hyperlinks to json. */ export enum JsonExportHyperlinkType { /** * Export display string */ DisplayString = 0, /** * Export url */ Address = 1, /** * Export as html string. */ HtmlString = 2, } /** * Represents state of the sheet's pane. */ export enum PaneStateType { /** * Panes are frozen, but were not before being frozen. */ Frozen = 0, /** * Panes are frozen and were split before being frozen. */ FrozenSplit = 1, /** * Panes are split, but not frozen. */ Split = 2, /** * Panes are not frozen and not split. */ Normal = 3, } /** * Represents mashup data. */ export class DataMashup { /** * @deprecated Please use the 'powerQueryFormulas' property instead. * Gets all power query formulas. */ getPowerQueryFormulas() : PowerQueryFormulaCollection; /** * Gets all power query formulas. */ readonly powerQueryFormulas : PowerQueryFormulaCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the definition of power query formula. */ export class PowerQueryFormula { /** * Gets the type of this power query formula. */ getType() : PowerQueryFormulaType; /** * @deprecated Please use the 'groupName' property instead. * Gets the name of group which contains this power query formula. */ getGroupName() : string; /** * Gets the name of group which contains this power query formula. */ readonly groupName : string; /** * Gets the definition of the power query formula. */ getFormulaDefinition() : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the power query formula. */ getName() : string; /** * Gets and sets the name of the power query formula. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the power query formula. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'description' property instead. * Gets and sets the description of the power query formula. */ getDescription() : string; /** * Gets and sets the description of the power query formula. */ description : string; /** * @deprecated Please use the 'description' property instead. * Gets and sets the description of the power query formula. * @param value - The value to set. */ setDescription(value: string) : void; /** * @deprecated Please use the 'powerQueryFormulaItems' property instead. * Gets all items of power query formula. */ getPowerQueryFormulaItems() : PowerQueryFormulaItemCollection; /** * Gets all items of power query formula. */ readonly powerQueryFormulaItems : PowerQueryFormulaItemCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all power query formulas in the mashup data. */ export class PowerQueryFormulaCollection implements Iterable { /** * Gets by the index in the list. * @param index - The index. */ get(index: number) : PowerQueryFormula; /** * Gets by the name of the power query formula. * @param name - The name of the item. */ get(name: string) : PowerQueryFormula; /** * Remove power query formula by name. * @param name - The name of power query formula. */ removeBy(name: string) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the function of power query. */ export class PowerQueryFormulaFunction extends PowerQueryFormula { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PowerQueryFormula); /** * Gets the type of power query formula. */ getType() : PowerQueryFormulaType; /** * @deprecated Please use the 'f' property instead. * Gets and sets the definition of function. */ getF() : string; /** * Gets and sets the definition of function. */ f : string; /** * @deprecated Please use the 'f' property instead. * Gets and sets the definition of function. * @param value - The value to set. */ setF(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the item of the power query formula. */ export class PowerQueryFormulaItem { /** * @deprecated Please use the 'name' property instead. * Gets the name of the item. */ getName() : string; /** * Gets the name of the item. */ readonly name : string; /** * @deprecated Please use the 'value' property instead. * Gets the value of the item. */ getValue() : string; /** * Gets the value of the item. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets the value of the item. * @param value - The value to set. */ setValue(value: string) : void; /** * @deprecated Please use the 'textValue' property instead. * Gets the text value of the item. */ getTextValue() : string; /** * Gets the text value of the item. */ readonly textValue : string; /** * @deprecated Please use the 'itemType' property instead. * Gets the type of this item (Function, Parameter, List, Literal, or Unknown). */ getItemType() : PowerQueryFormulaItemType; /** * Gets the type of this item (Function, Parameter, List, Literal, or Unknown). */ readonly itemType : PowerQueryFormulaItemType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all item of the power query formula. */ export class PowerQueryFormulaItemCollection implements Iterable { /** * Gets by the index in the list. * @param index - The index. */ get(index: number) : PowerQueryFormulaItem; /** * Gets by the name of the item. * @param name - The name of the item. */ get(name: string) : PowerQueryFormulaItem; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the parameter of power query formula. */ export class PowerQueryFormulaParameter extends PowerQueryFormula { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PowerQueryFormula); /** * Gets the type of power query formula. */ getType() : PowerQueryFormulaType; /** * @deprecated Please use the 'value' property instead. * Gets the value of parameter. */ getValue() : string; /** * Gets the value of parameter. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets the value of parameter. * @param value - The value to set. */ setValue(value: string) : void; /** * Gets the definition of the parameter. */ getFormulaDefinition() : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the parameters of power query formula. * * @remarks * NOTE: This class is now obsolete. Instead, * please use PowerQueryFormulaCollection class. * This property will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PowerQueryFormulaCollection class, instead. */ export class PowerQueryFormulaParameterCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets by the index in the list. * @param index - The index. */ get(index: number) : PowerQueryFormulaParameter; /** * Gets by the name of the item. * @param name - The name of the item. */ get(name: string) : PowerQueryFormulaParameter; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Encapsulates the object that represents a range of cells within a spreadsheet. * * @remarks * The Range class denotes a region of Excel spreadsheet. * With this, you can format and set value of the range. * And you can simply copy range of Excel too. */ export class Range implements Iterable { /** * Gets object in this range. * @param rowOffset - Row offset in this range, zero based. * @param columnOffset - Column offset in this range, zero based. * @returns * object. */ get(rowOffset: number, columnOffset: number) : Cell; /** * @deprecated Please use the 'currentRegion' property instead. * Returns a Range object that represents the current region. * The current region is a range bounded by any combination of blank rows and blank columns. */ getCurrentRegion() : Range; /** * Returns a Range object that represents the current region. * The current region is a range bounded by any combination of blank rows and blank columns. */ readonly currentRegion : Range; /** * @deprecated Please use the 'hyperlinks' property instead. * Gets all hyperlink in the range. */ getHyperlinks() : Hyperlink[]; /** * Gets all hyperlink in the range. */ readonly hyperlinks : Hyperlink[]; /** * @deprecated Please use the 'rowCount' property instead. * Gets the count of rows in the range. */ getRowCount() : number; /** * Gets the count of rows in the range. */ readonly rowCount : number; /** * @deprecated Please use the 'columnCount' property instead. * Gets the count of columns in the range. */ getColumnCount() : number; /** * Gets the count of columns in the range. */ readonly columnCount : number; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the range. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ getName() : string; /** * Gets or sets the name of the range. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ name : string; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the range. * @param value - The value to set. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ setName(value: string) : void; /** * @deprecated Please use the 'refersTo' property instead. * Gets the range's refers to. */ getRefersTo() : string; /** * Gets the range's refers to. */ readonly refersTo : string; /** * @deprecated Please use the 'address' property instead. * Gets address of the range. */ getAddress() : string; /** * Gets address of the range. */ readonly address : string; /** * @deprecated Please use the 'left' property instead. * Gets the distance, in points, from the left edge of column A to the left edge of the range. */ getLeft() : number; /** * Gets the distance, in points, from the left edge of column A to the left edge of the range. */ readonly left : number; /** * @deprecated Please use the 'top' property instead. * Gets the distance, in points, from the top edge of row 1 to the top edge of the range. */ getTop() : number; /** * Gets the distance, in points, from the top edge of row 1 to the top edge of the range. */ readonly top : number; /** * @deprecated Please use the 'width' property instead. * Gets the width of a range in points. */ getWidth() : number; /** * Gets the width of a range in points. */ readonly width : number; /** * @deprecated Please use the 'height' property instead. * Gets the width of a range in points. */ getHeight() : number; /** * Gets the width of a range in points. */ readonly height : number; /** * @deprecated Please use the 'firstRow' property instead. * Gets the index of the first row of the range. */ getFirstRow() : number; /** * Gets the index of the first row of the range. */ readonly firstRow : number; /** * @deprecated Please use the 'firstColumn' property instead. * Gets the index of the first column of the range. */ getFirstColumn() : number; /** * Gets the index of the first column of the range. */ readonly firstColumn : number; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the range. * * @remarks * If the range contains multiple cells, the returned/applied object should be a two-dimension object. */ getValue() : Object; /** * Gets and sets the value of the range. * * @remarks * If the range contains multiple cells, the returned/applied object should be a two-dimension object. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the range. * @param value - The value to set. * * @remarks * If the range contains multiple cells, the returned/applied object should be a two-dimension object. */ setValue(value: Object) : void; /** * @deprecated Please use the 'columnWidth' property instead. * Sets or gets the column width of this range */ getColumnWidth() : number; /** * Sets or gets the column width of this range */ columnWidth : number; /** * @deprecated Please use the 'columnWidth' property instead. * Sets or gets the column width of this range * @param value - The value to set. */ setColumnWidth(value: number) : void; /** * @deprecated Please use the 'rowHeight' property instead. * Sets or gets the height of rows in this range */ getRowHeight() : number; /** * Sets or gets the height of rows in this range */ rowHeight : number; /** * @deprecated Please use the 'rowHeight' property instead. * Sets or gets the height of rows in this range * @param value - The value to set. */ setRowHeight(value: number) : void; /** * @deprecated Please use the 'entireColumn' property instead. * Gets a Range object that represents the entire column (or columns) that contains the specified range. */ getEntireColumn() : Range; /** * Gets a Range object that represents the entire column (or columns) that contains the specified range. */ readonly entireColumn : Range; /** * @deprecated Please use the 'entireRow' property instead. * Gets a Range object that represents the entire row (or rows) that contains the specified range. */ getEntireRow() : Range; /** * Gets a Range object that represents the entire row (or rows) that contains the specified range. */ readonly entireRow : Range; /** * @deprecated Please use the 'worksheet' property instead. * Gets the object which contains this range. */ getWorksheet() : Worksheet; /** * Gets the object which contains this range. */ readonly worksheet : Worksheet; /** * Automaticall fill the target range. * @param target - the target range. */ autoFill(target: Range) : void; /** * Automaticall fill the target range. * @param target - The targed range. * @param autoFillType - The auto fill type. */ autoFill(target: Range, autoFillType: AutoFillType) : void; /** * Adds a hyperlink to a specified cell or a range of cells. * @param address - Address of the hyperlink. * @param textToDisplay - The text to be displayed for the specified hyperlink. * @param screenTip - The screenTip text for the specified hyperlink. * @returns * object. */ addHyperlink(address: string, textToDisplay: string, screenTip: string) : Hyperlink; /** * Gets the enumerator for cells in this Range. * @returns * The cells enumerator * * @remarks * When traversing elements by the returned Enumerator, the cells collection * should not be modified(such as operations that will cause new Cell/Row be instantiated or existing Cell/Row be deleted). * Otherwise the enumerator may not be able to traverse all cells correctly(some elements may be traversed repeatedly or skipped). */ getEnumerator() : CellEnumerator; /** * Indicates whether the range is intersect. * @param range - The range. * @returns * Whether the range is intersect. * * @remarks * If the two ranges area not in the same worksheet ,return false. */ isIntersect(range: Range) : boolean; /** * Returns a object that represents the rectangular intersection of two ranges. * @param range - The intersecting range. * @returns * Returns a object * * @remarks * If the two ranges are not intersected, returns null. */ intersect(range: Range) : Range; /** * Returns the union result of two ranges. * @param range - The range * @returns * The union of two ranges. * * @remarks * NOTE: This method is now obsolete. Instead, * please use Range.UnionRanges() method. * This method will be removed 12 months later since May 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Range.UnionRanges() instead. */ unionRang(range: Range) : Range[]; /** * Returns the union result of two ranges. * @param ranges - The range * @returns * The union of two ranges. */ unionRanges(ranges: Range[]) : UnionRange; /** * Indicates whether the range contains values. */ isBlank() : boolean; /** * Combines a range of cells into a single cell. * * @remarks * Reference the merged cell via the address of the upper-left cell in the range. */ merge() : void; /** * Unmerges merged cells of this range. */ unMerge() : void; /** * Puts a value into the range, if appropriate the value will be converted to other data type and cell's number format will be reset. * @param stringValue - Input value * @param isConverted - True: converted to other data type if appropriate. * @param setStyle - True: set the number format to cell's style when converting to other data type */ putValue(stringValue: string, isConverted: boolean, setStyle: boolean) : void; /** * Apply the cell style. * @param style - The cell style. * @param explicitFlag - True, only overwriting formatting which is explicitly set. */ setStyle(style: Style, explicitFlag: boolean) : void; /** * Sets the style of the range. * @param style - The Style object. */ setStyle(style: Style) : void; /** * Applies formats for a whole range. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. * * @remarks * Each cell in this range will contains a object. * So this is a memory-consuming method. Please use it carefully. */ applyStyle(style: Style, flag: StyleFlag) : void; /** * Sets the outline borders around a range of cells with same border style and color. * @param borderStyle - Border style. * @param borderColor - Border color. */ setOutlineBorders(borderStyle: CellBorderType, borderColor: CellsColor) : void; /** * Sets the outline borders around a range of cells with same border style and color. * @param borderStyle - Border style. * @param borderColor - Border color. */ setOutlineBorders(borderStyle: CellBorderType, borderColor: Color) : void; /** * Sets out line borders around a range of cells. * @param borderStyles - Border styles. * @param borderColors - Border colors. * * @remarks * Both the length of borderStyles and borderStyles must be 4. * The order of borderStyles and borderStyles must be top,bottom,left,right */ setOutlineBorders(borderStyles: CellBorderType[], borderColors: Color[]) : void; /** * Sets outline border around a range of cells. * @param borderEdge - Border edge. * @param borderStyle - Border style. * @param borderColor - Border color. */ setOutlineBorder(borderEdge: BorderType, borderStyle: CellBorderType, borderColor: CellsColor) : void; /** * Sets outline border around a range of cells. * @param borderEdge - Border edge. * @param borderStyle - Border style. * @param borderColor - Border color. */ setOutlineBorder(borderEdge: BorderType, borderStyle: CellBorderType, borderColor: Color) : void; /** * Set inside borders of the range. * @param borderEdge - Inside borde type, only can be and . * @param lineStyle - The border style. * @param borderColor - The color of the border. */ setInsideBorders(borderEdge: BorderType, lineStyle: CellBorderType, borderColor: CellsColor) : void; /** * Move the current range to the dest range. * @param destRow - The start row of the dest range. * @param destColumn - The start column of the dest range. */ moveTo(destRow: number, destColumn: number) : void; /** * Copies cell data (including formulas) from a source range. * @param range - Source object. */ copyData(range: Range) : void; /** * Copies cell value from a source range. * @param range - Source object. */ copyValue(range: Range) : void; /** * Copies style settings from a source range. * @param range - Source object. */ copyStyle(range: Range) : void; /** * Copying the range with paste special options. * @param range - The source range. * @param options - The paste special options. */ copy(range: Range, options: PasteOptions) : void; /** * Copies data (including formulas), formatting, drawing objects etc. from a source range. * @param range - Source object. */ copy(range: Range) : void; /** * Transpose (rotate) data from rows to columns or vice versa. */ transpose() : void; /** * Gets object or null in this range. * @param rowOffset - Row offset in this range, zero based. * @param columnOffset - Column offset in this range, zero based. * @returns * object. */ getCellOrNull(rowOffset: number, columnOffset: number) : Cell; /** * Gets range by offset. * @param rowOffset - Row offset in this range, zero based. * @param columnOffset - Column offset in this range, zero based. */ getOffset(rowOffset: number, columnOffset: number) : Range; /** * Returns a string represents the current Range object. */ toString() : string; /** * Converts the range to image. * @param options - The options for converting this range to image */ toImage(options: ImageOrPrintOptions) : Uint8Array; /** * Convert the range to JSON value. * @param options - The options of converting */ toJson(options: JsonSaveOptions) : string; /** * Convert the range to html . * @param saveOptions - Options for coverting range to html. */ toHtml(saveOptions: HtmlSaveOptions) : Uint8Array; /** * Clears this range. */ clear() : void; /** * Clears the contents of this range. */ clearContents() : void; /** * Clears the formats of this range. */ clearFormats() : void; /** * Clears the comments of this range. */ clearComments() : void; /** * Only removes hyperlinks. * @param clearFormat - Indicates whether to clear the format of hyperlinks. */ clearHyperlinks(clearFormat: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents how to loading the linked resource. */ export enum ResourceLoadingType { /** * Loads this resource as usual. */ Default = 0, /** * Skips loading of this resource. */ Skip = 1, /** * Use stream provided by user */ UserProvided = 2, } /** * Collects the objects that represent the individual rows in a worksheet. */ export class RowCollection implements Iterable { /** * Gets a object by given row index. The Row object of given row index will be instantiated if it does not exist before. */ get(rowIndex: number) : Row; /** * @deprecated Please use the 'count' property instead. * Gets the number of rows in this collection. */ getCount() : number; /** * Gets the number of rows in this collection. */ readonly count : number; /** * Gets an enumerator that iterates rows through this collection * @returns * The row enumerator which will traverse all existing rows in this collection. */ getEnumerator() : RowEnumerator; /** * Gets an enumerator that iterates rows through this collection * @param reversed - whether enumerate rows in reversed order * @param sync - whether the returned enumerator should check the modification of row collection /// and keep synchronized with it. * @returns * The row enumerator which will traverse all existing rows in this collection. * * @remarks * If the row collection will be modified(by operations that may cause new Row be instantiated or * existing Row be removed) during the traversal with the enumerator, * synchronized enumerator should be used instead of normal enumerator so that the traversal can continue * from the position just after the one has been traversed by the last MoveNext(). * However, together with the advantage that no element be skipped or traversed repeatedly, * the disadvantage for synchronized enumerator is that the performance will be degraded a bit * when comparing with normal enumerator. */ getEnumerator(reversed: boolean, sync: boolean) : RowEnumerator; /** * Gets the row object by the position in the list. * @param index - The position. * @returns * The Row object at given position. */ getRowByIndex(index: number) : Row; /** * Clear all rows and cells. */ clear() : void; /** * Remove the row item at the specified index(position) in this collection. * @param index - zero-based index(position, not ) of the existing row item in this collection. */ removeAt(index: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a single row in a worksheet. */ export class Row implements Iterable { /** * Gets the cell. * @param column - The column index */ get(column: number) : Cell; /** * Indicates whether the row contains any data */ readonly isBlank : boolean; /** * whether the row is collapsed */ isCollapsed : boolean; /** * @deprecated Please use the 'isCollapsed' property instead. * whether the row is collapsed * @param value - The value to set. */ setIsCollapsed(value: boolean) : void; /** * @deprecated Please use the 'height' property instead. * Gets and sets the row height in unit of Points. */ getHeight() : number; /** * Gets and sets the row height in unit of Points. */ height : number; /** * @deprecated Please use the 'height' property instead. * Gets and sets the row height in unit of Points. * @param value - The value to set. */ setHeight(value: number) : void; /** * Indicates whether the row is hidden. */ isHidden : boolean; /** * @deprecated Please use the 'isHidden' property instead. * Indicates whether the row is hidden. * @param value - The value to set. */ setIsHidden(value: boolean) : void; /** * @deprecated Please use the 'index' property instead. * Gets the index of this row. */ getIndex() : number; /** * Gets the index of this row. */ readonly index : number; /** * @deprecated Please use the 'groupLevel' property instead. * Gets the group level of the row. */ getGroupLevel() : number; /** * Gets the group level of the row. */ groupLevel : number; /** * @deprecated Please use the 'groupLevel' property instead. * Gets the group level of the row. * @param value - The value to set. */ setGroupLevel(value: number) : void; /** * Indicates whether the row height matches current default font setting of the workbook. * True of this property also denotes the row height is "automatic" without custom height value set by user. * * @remarks * When this property is true, if the content in this row changes, * generally the row height needs to be re-calculated(such as by ) * to get the same result with what is shown in ms excel when you opening the workbook in it. */ isHeightMatched : boolean; /** * @deprecated Please use the 'isHeightMatched' property instead. * Indicates whether the row height matches current default font setting of the workbook. * True of this property also denotes the row height is "automatic" without custom height value set by user. * @param value - The value to set. * * @remarks * When this property is true, if the content in this row changes, * generally the row height needs to be re-calculated(such as by ) * to get the same result with what is shown in ms excel when you opening the workbook in it. */ setIsHeightMatched(value: boolean) : void; /** * @deprecated Please use the 'hasCustomStyle' property instead. * Indicates whether this row has custom style settings(different from the default one inherited from workbook). */ getHasCustomStyle() : boolean; /** * Indicates whether this row has custom style settings(different from the default one inherited from workbook). */ readonly hasCustomStyle : boolean; /** * @deprecated Please use the 'firstCell' property instead. * Gets the first cell object in the row. */ getFirstCell() : Cell; /** * Gets the first cell object in the row. */ readonly firstCell : Cell; /** * @deprecated Please use the 'firstDataCell' property instead. * Gets the first non-blank cell in the row. */ getFirstDataCell() : Cell; /** * Gets the first non-blank cell in the row. */ readonly firstDataCell : Cell; /** * @deprecated Please use the 'lastCell' property instead. * Gets the last cell object in the row. */ getLastCell() : Cell; /** * Gets the last cell object in the row. */ readonly lastCell : Cell; /** * @deprecated Please use the 'lastDataCell' property instead. * Gets the last non-blank cell in the row. */ getLastDataCell() : Cell; /** * Gets the last non-blank cell in the row. */ readonly lastDataCell : Cell; /** * Get the cell by specific index in the cells collection of this row. * @param index - The index(position) of the cell in the cells collection of this row. * @returns * The Cell object at given position. * * @remarks * To traverse all cells in sequence without modification, * using will give better performance than using this method to get cell one by one. */ getCellByIndex(index: number) : Cell; /** * Gets the cells enumerator * @returns * The cells enumerator which will traverse all existing cells in this row. */ getEnumerator() : CellEnumerator; /** * Gets an enumerator that iterates cells through this row. * @param reversed - whether enumerate cells in reversed order * @param sync - whether the returned enumerator should check the modification of cells in this row /// and keep synchronized with it. * @returns * The cells enumerator which will traverse all existing cells in this row. * * @remarks * If the row will be modified(by operations that may cause new Cell be instantiated or * existing Cell be removed) during the traversal with the enumerator, * synchronized enumerator should be used instead of normal enumerator so that the traversal can continue * from the position just after the one has been traversed by the last MoveNext(). * However, together with the advantage that no element be skipped or traversed repeatedly, * the disadvantage for synchronized enumerator is that the performance will be degraded a bit * when comparing with normal enumerator. */ getEnumerator(reversed: boolean, sync: boolean) : CellEnumerator; /** * Gets the cell or null in the specific index. * @param column - The column index * @returns * Returns the cell object if the cell exists. * Or returns null if the cell object does not exist. */ getCellOrNull(column: number) : Cell; /** * Gets the style of this row. * * @remarks * Modifying the returned style object directly takes no effect for this row or any cells in this row. * You have to call or method * to apply the change to this row.

* Row's style is the style which will be inherited by cells in this row(those cells that have no custom style settings, * such as existing cells that have not been set style explicitly, or those that have not been instantiated) */ getStyle() : Style; /** * Sets the style of this row. * @param style - the style to be used as the default style for cells in this row. * * @remarks * This method only sets the given style as the default style for this row, * without changing the style settings for existing cells in this row. * To update style settings of existing cells to the specified style at the same time, * please use */ setStyle(style: Style) : void; /** * Copy settings of row, such as style, height, visibility, ...etc. * @param source - the source row whose settings will be copied to this one * @param checkStyle - whether check and gather style. /// Only takes effect and be needed when two row objects belong to different workbook and the styles of two workbooks are different. */ copySettings(source: Row, checkStyle: boolean) : void; /** * Applies formats for a whole row. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. */ applyStyle(style: Style, flag: StyleFlag) : void; /** * Checks whether this object refers to the same row with another. * @param obj - another object * @returns * true if two objects refers to the same row. */ equals(obj: Object) : boolean; /** * Checks whether this object refers to the same row with another row object. * @param row - another row object * @returns * true if two row objects refers to the same row. */ equals(row: Row) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents options of saving .docx file. */ export class DocxSaveOptions extends PaginatedSaveOptions { /** * Represents options of saving .docx file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PaginatedSaveOptions); /** * Represents options of saving .docx file. * @param saveAsImage - If True, the workbook will be converted into some pictures of .docx file. ///If False, the workbook will be converted into some tables of .docx file. */ constructor(saveAsImage: boolean); /** * @deprecated Please use the 'saveAsEditableShaps' property instead. * Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.SaveAsEditableShapes instead. */ getSaveAsEditableShaps() : boolean; /** * Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.SaveAsEditableShapes instead. */ saveAsEditableShaps : boolean; /** * @deprecated Please use the 'saveAsEditableShaps' property instead. * Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.SaveAsEditableShapes instead. */ setSaveAsEditableShaps(value: boolean) : void; /** * @deprecated Please use the 'saveAsEditableShapes' property instead. * Save all drawing objects as editable shapes in the word file, so you can edit them in Word. * * @remarks * Only for charts. */ getSaveAsEditableShapes() : boolean; /** * Save all drawing objects as editable shapes in the word file, so you can edit them in Word. * * @remarks * Only for charts. */ saveAsEditableShapes : boolean; /** * @deprecated Please use the 'saveAsEditableShapes' property instead. * Save all drawing objects as editable shapes in the word file, so you can edit them in Word. * @param value - The value to set. * * @remarks * Only for charts. */ setSaveAsEditableShapes(value: boolean) : void; /** * @deprecated Please use the 'embedXlsxAsChartDataSource' property instead. * Indicates whether embedding an xlsx file as data source of the chart. * * @remarks * The default value is true. */ getEmbedXlsxAsChartDataSource() : boolean; /** * Indicates whether embedding an xlsx file as data source of the chart. * * @remarks * The default value is true. */ embedXlsxAsChartDataSource : boolean; /** * @deprecated Please use the 'embedXlsxAsChartDataSource' property instead. * Indicates whether embedding an xlsx file as data source of the chart. * @param value - The value to set. * * @remarks * The default value is true. */ setEmbedXlsxAsChartDataSource(value: boolean) : void; /** * @deprecated Please use the 'asFlatOpc' property instead. * Indicates whether saving as a flat opc file which can be generated by Open XML SDK */ getAsFlatOpc() : boolean; /** * Indicates whether saving as a flat opc file which can be generated by Open XML SDK */ asFlatOpc : boolean; /** * @deprecated Please use the 'asFlatOpc' property instead. * Indicates whether saving as a flat opc file which can be generated by Open XML SDK * @param value - The value to set. */ setAsFlatOpc(value: boolean) : void; /** * @deprecated Please use the 'saveElementType' property instead. * Indicates which elements should be saved. */ getSaveElementType() : SaveElementType; /** * Indicates which elements should be saved. */ saveElementType : SaveElementType; /** * @deprecated Please use the 'saveElementType' property instead. * Indicates which elements should be saved. * @param value - The value to set. */ setSaveElementType(value: SaveElementType) : void; /** * @deprecated Please use the 'asNormalView' property instead. * Exporting Excel file to docx fiel as normal view. * If this property is true , one Area will be output, and no scale will take effect. * The default value is false. */ getAsNormalView() : boolean; /** * Exporting Excel file to docx fiel as normal view. * If this property is true , one Area will be output, and no scale will take effect. * The default value is false. */ asNormalView : boolean; /** * @deprecated Please use the 'asNormalView' property instead. * Exporting Excel file to docx fiel as normal view. * If this property is true , one Area will be output, and no scale will take effect. * The default value is false. * @param value - The value to set. */ setAsNormalView(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the save options for markdown. */ export class MarkdownSaveOptions extends SaveOptions { /** * Creates options for saving markdown document */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the default encoding. */ getEncoding() : EncodingType; /** * Gets and sets the default encoding. */ encoding : EncodingType; /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the default encoding. * @param value - The value to set. */ setEncoding(value: EncodingType) : void; /** * @deprecated Please use the 'formatStrategy' property instead. * Gets and sets the format strategy when exporting the cell value as string. */ getFormatStrategy() : CellValueFormatStrategy; /** * Gets and sets the format strategy when exporting the cell value as string. */ formatStrategy : CellValueFormatStrategy; /** * @deprecated Please use the 'formatStrategy' property instead. * Gets and sets the format strategy when exporting the cell value as string. * @param value - The value to set. */ setFormatStrategy(value: CellValueFormatStrategy) : void; /** * @deprecated Please use the 'lightCellsDataProvider' property instead. * The Data provider to provide cells data for saving workbook in light mode. */ getLightCellsDataProvider() : LightCellsDataProvider; /** * The Data provider to provide cells data for saving workbook in light mode. */ lightCellsDataProvider : LightCellsDataProvider; /** * @deprecated Please use the 'lightCellsDataProvider' property instead. * The Data provider to provide cells data for saving workbook in light mode. * @param value - The value to set. */ setLightCellsDataProvider(value: LightCellsDataProvider) : void; /** * @deprecated Please use the 'lineSeparator' property instead. * Gets and sets the line separator. */ getLineSeparator() : string; /** * Gets and sets the line separator. */ lineSeparator : string; /** * @deprecated Please use the 'lineSeparator' property instead. * Gets and sets the line separator. * @param value - The value to set. */ setLineSeparator(value: string) : void; /** * @deprecated Please use the 'tableHeaderType' property instead. * Gets and sets how set the header of the table. */ getTableHeaderType() : MarkdownTableHeaderType; /** * Gets and sets how set the header of the table. */ tableHeaderType : MarkdownTableHeaderType; /** * @deprecated Please use the 'tableHeaderType' property instead. * Gets and sets how set the header of the table. * @param value - The value to set. */ setTableHeaderType(value: MarkdownTableHeaderType) : void; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * * @remarks * The set is ignored when it is used in */ getSheetSet() : SheetSet; /** * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * * @remarks * The set is ignored when it is used in */ sheetSet : SheetSet; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * @param value - The value to set. * * @remarks * The set is ignored when it is used in */ setSheetSet(value: SheetSet) : void; /** * @deprecated Please use the 'imageOptions' property instead. * Get the ImageOrPrintOptions object before exporting */ getImageOptions() : ImageOrPrintOptions; /** * Get the ImageOrPrintOptions object before exporting */ readonly imageOptions : ImageOrPrintOptions; /** * @deprecated Please use the 'exportImagesAsBase64' property instead. * Specifies whether images are saved in Base64 format to Markdown. * The default value is true. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ getExportImagesAsBase64() : boolean; /** * Specifies whether images are saved in Base64 format to Markdown. * The default value is true. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ exportImagesAsBase64 : boolean; /** * @deprecated Please use the 'exportImagesAsBase64' property instead. * Specifies whether images are saved in Base64 format to Markdown. * The default value is true. * @param value - The value to set. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ setExportImagesAsBase64(value: boolean) : void; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving markdown file. * * @remarks * The default value is false. */ getCalculateFormula() : boolean; /** * Indicates whether to calculate formulas before saving markdown file. * * @remarks * The default value is false. */ calculateFormula : boolean; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving markdown file. * @param value - The value to set. * * @remarks * The default value is false. */ setCalculateFormula(value: boolean) : void; /** * @deprecated Please use the 'exportHyperlinkAsReference' property instead. * Indicates whether to export hyperlink using reference definitions instead of inline format. * The default value is false. */ getExportHyperlinkAsReference() : boolean; /** * Indicates whether to export hyperlink using reference definitions instead of inline format. * The default value is false. */ exportHyperlinkAsReference : boolean; /** * @deprecated Please use the 'exportHyperlinkAsReference' property instead. * Indicates whether to export hyperlink using reference definitions instead of inline format. * The default value is false. * @param value - The value to set. */ setExportHyperlinkAsReference(value: boolean) : void; /** * @deprecated Please use the 'alignColumnPadding' property instead. * Indicates whether column alignment is enabled for generated Markdown tables. * When enabled, columns are aligned by padding cell content with the specified character(typically ' ' for spaces). * Set to '\0' to disable column alignment (default). */ getAlignColumnPadding() : string; /** * Indicates whether column alignment is enabled for generated Markdown tables. * When enabled, columns are aligned by padding cell content with the specified character(typically ' ' for spaces). * Set to '\0' to disable column alignment (default). */ alignColumnPadding : string; /** * @deprecated Please use the 'alignColumnPadding' property instead. * Indicates whether column alignment is enabled for generated Markdown tables. * When enabled, columns are aligned by padding cell content with the specified character(typically ' ' for spaces). * Set to '\0' to disable column alignment (default). * @param value - The value to set. */ setAlignColumnPadding(value: string) : void; /** * @deprecated Please use the 'splitTablesByBlankRow' property instead. * Indicates whether blank rows in the worksheet should be treated as table separators when exporting to Markdown. * The default value is false. */ getSplitTablesByBlankRow() : boolean; /** * Indicates whether blank rows in the worksheet should be treated as table separators when exporting to Markdown. * The default value is false. */ splitTablesByBlankRow : boolean; /** * @deprecated Please use the 'splitTablesByBlankRow' property instead. * Indicates whether blank rows in the worksheet should be treated as table separators when exporting to Markdown. * The default value is false. * @param value - The value to set. */ setSplitTablesByBlankRow(value: boolean) : void; /** * @deprecated Please use the 'officeMathOutputType' property instead. * Indicates how OfficeMath objects are exported to Markdown, Default value is Image. */ getOfficeMathOutputType() : HtmlOfficeMathOutputType; /** * Indicates how OfficeMath objects are exported to Markdown, Default value is Image. */ officeMathOutputType : HtmlOfficeMathOutputType; /** * @deprecated Please use the 'officeMathOutputType' property instead. * Indicates how OfficeMath objects are exported to Markdown, Default value is Image. * @param value - The value to set. */ setOfficeMathOutputType(value: HtmlOfficeMathOutputType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Allows to specify which OOXML specification will be used when saving in the Xlsx format. */ export enum OoxmlCompliance { /** * ECMA-376 1st Edition, 2006. */ Ecma376_2006 = 0, /** * ISO/IEC 29500:2008 Strict compliance level. */ Iso29500_2008_Strict = 1, } /** * The Ooxml compression type */ export enum OoxmlCompressionType { /** * The fastest but least effective compression. */ Level1 = 1, /** * A little slower, but better, than level 1. */ Level2 = 2, /** * A little slower, but better, than level 2. */ Level3 = 3, /** * A little slower, but better, than level 3. */ Level4 = 4, /** * A little slower than level 4, but with better compression. */ Level5 = 5, /** * A good balance of speed and compression efficiency. */ Level6 = 6, /** * Pretty good compression! */ Level7 = 7, /** * Better compression than Level7! */ Level8 = 8, /** * The "best" compression, where best means greatest reduction in size of the input data stream. * This is also the slowest compression. */ Level9 = 9, } /** * Represents the pptx save options. */ export class PptxSaveOptions extends PaginatedSaveOptions { /** * Represents the pptx save options. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PaginatedSaveOptions); /** * Represents options of saving .pptx file. * @param saveAsImage - If True, the workbook will be converted into some pictures of .pptx file. /// If False, the workbook will be converted into some tables of .pptx file. */ constructor(saveAsImage: boolean); /** * @deprecated Please use the 'ignoreHiddenRows' property instead. * Inidicates whether ignoring hidden rows when converting Excel to PowerPoint. */ getIgnoreHiddenRows() : boolean; /** * Inidicates whether ignoring hidden rows when converting Excel to PowerPoint. */ ignoreHiddenRows : boolean; /** * @deprecated Please use the 'ignoreHiddenRows' property instead. * Inidicates whether ignoring hidden rows when converting Excel to PowerPoint. * @param value - The value to set. */ setIgnoreHiddenRows(value: boolean) : void; /** * @deprecated Please use the 'saveAsEditableShapes' property instead. * Save all drawing objects as editable shapes in the pptx file, so you can edit them in PowerPoint. * * @remarks * Only for charts. */ getSaveAsEditableShapes() : boolean; /** * Save all drawing objects as editable shapes in the pptx file, so you can edit them in PowerPoint. * * @remarks * Only for charts. */ saveAsEditableShapes : boolean; /** * @deprecated Please use the 'saveAsEditableShapes' property instead. * Save all drawing objects as editable shapes in the pptx file, so you can edit them in PowerPoint. * @param value - The value to set. * * @remarks * Only for charts. */ setSaveAsEditableShapes(value: boolean) : void; /** * @deprecated Please use the 'embedXlsxAsChartDataSource' property instead. * Indicates whether embedding an xlsx file as data source of the chart. * * @remarks * The default value is true. */ getEmbedXlsxAsChartDataSource() : boolean; /** * Indicates whether embedding an xlsx file as data source of the chart. * * @remarks * The default value is true. */ embedXlsxAsChartDataSource : boolean; /** * @deprecated Please use the 'embedXlsxAsChartDataSource' property instead. * Indicates whether embedding an xlsx file as data source of the chart. * @param value - The value to set. * * @remarks * The default value is true. */ setEmbedXlsxAsChartDataSource(value: boolean) : void; /** * @deprecated Please use the 'adjustFontSizeForRowType' property instead. * Represents what type of line needs to be adjusted size of font if height of row is small. */ getAdjustFontSizeForRowType() : AdjustFontSizeForRowType; /** * Represents what type of line needs to be adjusted size of font if height of row is small. */ adjustFontSizeForRowType : AdjustFontSizeForRowType; /** * @deprecated Please use the 'adjustFontSizeForRowType' property instead. * Represents what type of line needs to be adjusted size of font if height of row is small. * @param value - The value to set. */ setAdjustFontSizeForRowType(value: AdjustFontSizeForRowType) : void; /** * @deprecated Please use the 'exportViewType' property instead. * Gets and sets the display type when exporting to PowerPoint. * The default exporting type is working as printing. */ getExportViewType() : SlideViewType; /** * Gets and sets the display type when exporting to PowerPoint. * The default exporting type is working as printing. */ exportViewType : SlideViewType; /** * @deprecated Please use the 'exportViewType' property instead. * Gets and sets the display type when exporting to PowerPoint. * The default exporting type is working as printing. * @param value - The value to set. */ setExportViewType(value: SlideViewType) : void; /** * @deprecated Please use the 'asFlatOpc' property instead. * Indicates whether saving as a flat opc file which can be generated by Open XML SDK */ getAsFlatOpc() : boolean; /** * Indicates whether saving as a flat opc file which can be generated by Open XML SDK */ asFlatOpc : boolean; /** * @deprecated Please use the 'asFlatOpc' property instead. * Indicates whether saving as a flat opc file which can be generated by Open XML SDK * @param value - The value to set. */ setAsFlatOpc(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the key list of data sorter. */ export class DataSorterKeyCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets and sets by index. * @param index - The index. */ get(index: number) : DataSorterKey; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the options when converting table to range. */ export class TableToRangeOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'lastRow' property instead. * Gets and sets the last row index of the table. */ getLastRow() : number; /** * Gets and sets the last row index of the table. */ lastRow : number; /** * @deprecated Please use the 'lastRow' property instead. * Gets and sets the last row index of the table. * @param value - The value to set. */ setLastRow(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of target mode. */ export enum TargetModeType { /** * External link */ External = 0, /** * Local and full paths to files or folders. */ FilePath = 1, /** * Email. */ Email = 2, /** * Link on cell or named range. */ CellReference = 3, } /** * Represents union range. */ export class UnionRange implements Iterable { /** * @deprecated Please use the 'firstRow' property instead. * Gets the index of the first row of the range. * * @remarks * Only effects when it only contains one range. */ getFirstRow() : number; /** * Gets the index of the first row of the range. * * @remarks * Only effects when it only contains one range. */ readonly firstRow : number; /** * @deprecated Please use the 'firstColumn' property instead. * Gets the index of the first column of the range. * * @remarks * Only effects when it only contains one range. */ getFirstColumn() : number; /** * Gets the index of the first column of the range. * * @remarks * Only effects when it only contains one range. */ readonly firstColumn : number; /** * @deprecated Please use the 'rowCount' property instead. * Gets the count of rows in the range. * * @remarks * Only effects when it only contains one range. */ getRowCount() : number; /** * Gets the count of rows in the range. * * @remarks * Only effects when it only contains one range. */ readonly rowCount : number; /** * @deprecated Please use the 'columnCount' property instead. * Gets the count of rows in the range. * * @remarks * Only effects when it only contains one range. */ getColumnCount() : number; /** * Gets the count of rows in the range. * * @remarks * Only effects when it only contains one range. */ readonly columnCount : number; /** * @deprecated Please use the 'value' property instead. * Gets and sets the values of the range. */ getValue() : Object; /** * Gets and sets the values of the range. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Gets and sets the values of the range. * @param value - The value to set. */ setValue(value: Object) : void; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the range. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ getName() : string; /** * Gets or sets the name of the range. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ name : string; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the range. * @param value - The value to set. * * @remarks * Named range is supported. For example, *

range.Name = "Sheet1!MyRange";

*/ setName(value: string) : void; /** * @deprecated Please use the 'refersTo' property instead. * Gets the range's refers to. */ getRefersTo() : string; /** * Gets the range's refers to. */ readonly refersTo : string; /** * @deprecated Please use the 'hasRange' property instead. * Indicates whether this has range. */ getHasRange() : boolean; /** * Indicates whether this has range. */ readonly hasRange : boolean; /** * @deprecated Please use the 'hyperlinks' property instead. * Gets all hyperlink in the range. */ getHyperlinks() : Hyperlink[]; /** * Gets all hyperlink in the range. */ readonly hyperlinks : Hyperlink[]; /** * @deprecated Please use the 'cellCount' property instead. * Gets all cell count in the range. */ getCellCount() : number; /** * Gets all cell count in the range. */ readonly cellCount : number; /** * @deprecated Please use the 'rangeCount' property instead. * Gets the count of the ranges. */ getRangeCount() : number; /** * Gets the count of the ranges. */ readonly rangeCount : number; /** * @deprecated Please use the 'ranges' property instead. * Gets all union ranges. */ getRanges() : Range[]; /** * Gets all union ranges. */ readonly ranges : Range[]; /** * Combines a range of cells into a single cell. * * @remarks * Reference the merged cell via the address of the upper-left cell in the range. */ merge() : void; /** * Unmerges merged cells of this range. */ unMerge() : void; /** * Puts a value into the range, if appropriate the value will be converted to other data type and cell's number format will be reset. * @param stringValue - Input value * @param isConverted - True: converted to other data type if appropriate. * @param setStyle - True: set the number format to cell's style when converting to other data type */ putValue(stringValue: string, isConverted: boolean, setStyle: boolean) : void; /** * Sets the style of the range. * @param style - The Style object. */ setStyle(style: Style) : void; /** * Applies formats for a whole range. * @param style - The style object which will be applied. * @param flag - Flags which indicates applied formatting properties. * * @remarks * Each cell in this range will contains a object. * So this is a memory-consuming method. Please use it carefully. */ applyStyle(style: Style, flag: StyleFlag) : void; /** * Copying the range with paste special options. * @param range - The source range. * @param options - The paste special options. */ copy(range: UnionRange, options: PasteOptions) : void; /** * Gets the enumerator for cells in this Range. * @returns * The cells enumerator * * @remarks * When traversing elements by the returned Enumerator, the cells collection * should not be modified(such as operations that will cause new Cell/Row be instantiated or existing Cell/Row be deleted). * Otherwise the enumerator may not be able to traverse all cells correctly(some elements may be traversed repeatedly or skipped). */ getEnumerator() : CellEnumerator; /** * Sets out line borders around a range of cells. * @param borderStyles - Border styles. * @param borderColors - Border colors. * * @remarks * Both the length of borderStyles and borderStyles must be 4. * The order of borderStyles and borderStyles must be top,bottom,left,right */ setOutlineBorders(borderStyles: CellBorderType[], borderColors: Color[]) : void; /** * Sets the outline borders around a range of cells with same border style and color. * @param borderStyle - Border style. * @param borderColor - Border color. */ setOutlineBorders(borderStyle: CellBorderType, borderColor: Color) : void; /** * Intersects another range. * @param range - The range. * * @remarks * If the two union ranges are not intersected, returns null. */ intersect(range: string) : UnionRange; /** * Intersects another range. * @param unionRange - The range. * * @remarks * If the two union ranges are not intersected, returns null. */ intersect(unionRange: UnionRange) : UnionRange; /** * Intersects another range. * @param ranges - The range. * * @remarks * If the two union ranges are not intersected, returns null. */ intersect(ranges: Range[]) : UnionRange; /** * Union another range. * @param range - The range. */ union(range: string) : UnionRange; /** * Union another range. * @param unionRange - The range. */ union(unionRange: UnionRange) : UnionRange; /** * Union the ranges. * @param ranges - The ranges. */ union(ranges: Range[]) : UnionRange; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Indicates the options that exporting range to json. */ export class ExportRangeToJsonOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. */ getHasHeaderRow() : boolean; /** * Indicates whether the range contains header row. */ hasHeaderRow : boolean; /** * @deprecated Please use the 'hasHeaderRow' property instead. * Indicates whether the range contains header row. * @param value - The value to set. */ setHasHeaderRow(value: boolean) : void; /** * @deprecated Please use the 'exportAsString' property instead. * Exports the string value of the cells to json. */ getExportAsString() : boolean; /** * Exports the string value of the cells to json. */ exportAsString : boolean; /** * @deprecated Please use the 'exportAsString' property instead. * Exports the string value of the cells to json. * @param value - The value to set. */ setExportAsString(value: boolean) : void; /** * @deprecated Please use the 'exportEmptyCells' property instead. * Indicates whether exporting empty cells as null. */ getExportEmptyCells() : boolean; /** * Indicates whether exporting empty cells as null. */ exportEmptyCells : boolean; /** * @deprecated Please use the 'exportEmptyCells' property instead. * Indicates whether exporting empty cells as null. * @param value - The value to set. */ setExportEmptyCells(value: boolean) : void; /** * @deprecated Please use the 'indent' property instead. * Indicates the indent. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ getIndent() : string; /** * Indicates the indent. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ indent : string; /** * @deprecated Please use the 'indent' property instead. * Indicates the indent. * @param value - The value to set. * * @remarks * If the indent is null or empty, the exported json is not formatted. */ setIndent(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of json layout type. */ export class JsonLayoutOptions { /** * Constructor of loading JSON layout options. */ constructor(); /** * @deprecated Please use the 'arrayAsTable' property instead. * Processes Array as table. */ getArrayAsTable() : boolean; /** * Processes Array as table. */ arrayAsTable : boolean; /** * @deprecated Please use the 'arrayAsTable' property instead. * Processes Array as table. * @param value - The value to set. */ setArrayAsTable(value: boolean) : void; /** * @deprecated Please use the 'ignoreNull' property instead. * Indicates whether ignoring null value. */ getIgnoreNull() : boolean; /** * Indicates whether ignoring null value. */ ignoreNull : boolean; /** * @deprecated Please use the 'ignoreNull' property instead. * Indicates whether ignoring null value. * @param value - The value to set. */ setIgnoreNull(value: boolean) : void; /** * @deprecated Please use the 'ignoreTitle' property instead. * Ingores titles of attributes */ getIgnoreTitle() : boolean; /** * Ingores titles of attributes */ ignoreTitle : boolean; /** * @deprecated Please use the 'ignoreTitle' property instead. * Ingores titles of attributes * @param value - The value to set. */ setIgnoreTitle(value: boolean) : void; /** * @deprecated Please use the 'convertNumericOrDate' property instead. * Indicates whether converting the string in json to numeric or date value. */ getConvertNumericOrDate() : boolean; /** * Indicates whether converting the string in json to numeric or date value. */ convertNumericOrDate : boolean; /** * @deprecated Please use the 'convertNumericOrDate' property instead. * Indicates whether converting the string in json to numeric or date value. * @param value - The value to set. */ setConvertNumericOrDate(value: boolean) : void; /** * @deprecated Please use the 'numberFormat' property instead. * Gets and sets the format of numeric value. */ get_NumberFormat() : string; /** * Gets and sets the format of numeric value. */ numberFormat : string; /** * @deprecated Please use the 'numberFormat' property instead. * Gets and sets the format of numeric value. * @param value - The value to set. */ setNumberFormat(value: string) : void; /** * @deprecated Please use the 'dateFormat' property instead. * Gets and sets the format of date value. */ get_DateFormat() : string; /** * Gets and sets the format of date value. */ dateFormat : string; /** * @deprecated Please use the 'dateFormat' property instead. * Gets and sets the format of date value. * @param value - The value to set. */ setDateFormat(value: string) : void; /** * @deprecated Please use the 'titleStyle' property instead. * Gets and sets the style of the title. */ getTitleStyle() : Style; /** * Gets and sets the style of the title. */ titleStyle : Style; /** * @deprecated Please use the 'titleStyle' property instead. * Gets and sets the style of the title. * @param value - The value to set. */ setTitleStyle(value: Style) : void; /** * @deprecated Please use the 'keptSchema' property instead. * Indicates whether keeping schema of this json. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ getKeptSchema() : boolean; /** * Indicates whether keeping schema of this json. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ keptSchema : boolean; /** * @deprecated Please use the 'keptSchema' property instead. * Indicates whether keeping schema of this json. * @param value - The value to set. * * @remarks * Sometimes we will save the file to JSON after loading JSON file. */ setKeptSchema(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the utility class of processing json. */ export class JsonUtility { /** * Default Constructor. */ constructor(); /** * Import the json string. * @param json - The json string. * @param cells - The Cells. * @param row - The row index. * @param column - The column index. * @param option - The options of import json string. */ static importData(json: string, cells: Cells, row: number, column: number, option: JsonLayoutOptions) : number[]; /** * Exporting the range to json file. * @param range - The range. * @param options - The options of exporting. * @returns * The json string value. */ static exportRangeToJson(range: Range, options: JsonSaveOptions) : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a persisted taskpane object. */ export class WebExtensionTaskPane { /** * @deprecated Please use the 'webExtension' property instead. * Gets and sets the web extension part associated with the taskpane instance */ getWebExtension() : WebExtension; /** * Gets and sets the web extension part associated with the taskpane instance */ webExtension : WebExtension; /** * @deprecated Please use the 'webExtension' property instead. * Gets and sets the web extension part associated with the taskpane instance * @param value - The value to set. */ setWebExtension(value: WebExtension) : void; /** * @deprecated Please use the 'dockState' property instead. * Gets and sets the last-docked location of this taskpane object. */ getDockState() : string; /** * Gets and sets the last-docked location of this taskpane object. */ dockState : string; /** * @deprecated Please use the 'dockState' property instead. * Gets and sets the last-docked location of this taskpane object. * @param value - The value to set. */ setDockState(value: string) : void; /** * Indicates whether the Task Pane shows as visible by default when the document opens. */ isVisible : boolean; /** * @deprecated Please use the 'isVisible' property instead. * Indicates whether the Task Pane shows as visible by default when the document opens. * @param value - The value to set. */ setIsVisible(value: boolean) : void; /** * Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user. */ isLocked : boolean; /** * @deprecated Please use the 'isLocked' property instead. * Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user. * @param value - The value to set. */ setIsLocked(value: boolean) : void; /** * @deprecated Please use the 'width' property instead. * Gets and sets the default width value for this taskpane instance. */ getWidth() : number; /** * Gets and sets the default width value for this taskpane instance. */ width : number; /** * @deprecated Please use the 'width' property instead. * Gets and sets the default width value for this taskpane instance. * @param value - The value to set. */ setWidth(value: number) : void; /** * @deprecated Please use the 'row' property instead. * Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location. */ getRow() : number; /** * Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location. */ row : number; /** * @deprecated Please use the 'row' property instead. * Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location. * @param value - The value to set. */ setRow(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of task pane. */ export class WebExtensionTaskPaneCollection implements Iterable { /** * Gets task pane by the specific index. * @param index - The index. * @returns * The task pane. */ get(index: number) : WebExtensionTaskPane; /** * Adds task pane. * @returns * The index. */ add() : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents an Office Add-in instance. */ export class WebExtension { /** * @deprecated Please use the 'id' property instead. * Gets and sets the uniquely identifies the Office Add-in instance in the current document. */ getId() : string; /** * Gets and sets the uniquely identifies the Office Add-in instance in the current document. */ id : string; /** * @deprecated Please use the 'id' property instead. * Gets and sets the uniquely identifies the Office Add-in instance in the current document. * @param value - The value to set. */ setId(value: string) : void; /** * Indicates whether the user can interact with the Office Add-in or not. */ isFrozen : boolean; /** * @deprecated Please use the 'isFrozen' property instead. * Indicates whether the user can interact with the Office Add-in or not. * @param value - The value to set. */ setIsFrozen(value: boolean) : void; /** * @deprecated Please use the 'reference' property instead. * Get the primary reference to an Office Add-in. */ getReference() : WebExtensionReference; /** * Get the primary reference to an Office Add-in. */ readonly reference : WebExtensionReference; /** * @deprecated Please use the 'alterReferences' property instead. * Gets a list of alter references. */ getAlterReferences() : WebExtensionReferenceCollection; /** * Gets a list of alter references. */ readonly alterReferences : WebExtensionReferenceCollection; /** * @deprecated Please use the 'properties' property instead. * Gets all properties of web extension. */ getProperties() : WebExtensionPropertyCollection; /** * Gets all properties of web extension. */ readonly properties : WebExtensionPropertyCollection; /** * @deprecated Please use the 'bindings' property instead. * Gets all bindings relationship between an Office Add-in and the data in the document. */ getBindings() : WebExtensionBindingCollection; /** * Gets all bindings relationship between an Office Add-in and the data in the document. */ readonly bindings : WebExtensionBindingCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a binding relationship between an Office Add-in and the data in the document. */ export class WebExtensionBinding { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'id' property instead. * Gets and sets the binding identifier. */ getId() : string; /** * Gets and sets the binding identifier. */ id : string; /** * @deprecated Please use the 'id' property instead. * Gets and sets the binding identifier. * @param value - The value to set. */ setId(value: string) : void; /** * @deprecated Please use the 'type' property instead. * Gets and sets the binding type. */ getType() : string; /** * Gets and sets the binding type. */ type : string; /** * @deprecated Please use the 'type' property instead. * Gets and sets the binding type. * @param value - The value to set. */ setType(value: string) : void; /** * @deprecated Please use the 'appref' property instead. * Gets and sets the binding key used to map the binding entry in this list with the bound data in the document. */ getAppref() : string; /** * Gets and sets the binding key used to map the binding entry in this list with the bound data in the document. */ appref : string; /** * @deprecated Please use the 'appref' property instead. * Gets and sets the binding key used to map the binding entry in this list with the bound data in the document. * @param value - The value to set. */ setAppref(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of binding relationships between an Office Add-in and the data in the document. */ export class WebExtensionBindingCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets web extension binding relationship by the specific index. * @param index - The index. * @returns * The web extension binding relationship */ get(index: number) : WebExtensionBinding; /** * Adds an a binding relationship between an Office Add-in and the data in the document. */ add() : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the list of web extension. */ export class WebExtensionCollection implements Iterable { /** * Gets web extension by the specific index. * @param index - The index. * @returns * The web extension. */ get(index: number) : WebExtension; /** * Adds a web extension. * @returns * The index. */ add() : number; /** * Add a web video player into exel. * @param url - * @param autoPlay - Indicates whether auto playing the video. * @param startTime - The start time in unit of seconds. * @param endTime - The end time in unit of seconds. */ addWebVideoPlayer(url: string, autoPlay: boolean, startTime: number, endTime: number) : number; /** * Remove web extension by the index. * @param index - The index. */ removeAt(index: number) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents an Office Add-in custom property. */ export class WebExtensionProperty { /** * @deprecated Please use the 'name' property instead. * Gets and set a custom property name. */ getName() : string; /** * Gets and set a custom property name. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and set a custom property name. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Gets and sets a custom property value. */ getValue() : string; /** * Gets and sets a custom property value. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets a custom property value. * @param value - The value to set. */ setValue(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of web extension properties. */ export class WebExtensionPropertyCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets the property of web extension by the index. * @param index - The index. * @returns * The property of web extension. */ get(index: number) : WebExtensionProperty; /** * Gets the property of web extension. * @param name - The name of property. * @returns * The property of web extension. */ get(name: string) : WebExtensionProperty; /** * Adds web extension property. * @param name - The name of property. * @param value - The value of property. * @returns * The index of added property. */ add(name: string, value: string) : number; /** * Remove the property by the name. * @param name - The name of the property. */ removeAt(name: string) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents identify the provider location and version of the extension. */ export class WebExtensionReference { /** * @deprecated Please use the 'id' property instead. * Gets and sets the identifier associated with the Office Add-in within a catalog provider. * The identifier MUST be unique within a catalog provider. */ getId() : string; /** * Gets and sets the identifier associated with the Office Add-in within a catalog provider. * The identifier MUST be unique within a catalog provider. */ id : string; /** * @deprecated Please use the 'id' property instead. * Gets and sets the identifier associated with the Office Add-in within a catalog provider. * The identifier MUST be unique within a catalog provider. * @param value - The value to set. */ setId(value: string) : void; /** * @deprecated Please use the 'version' property instead. * Gets and sets the version. */ getVersion() : string; /** * Gets and sets the version. */ version : string; /** * @deprecated Please use the 'version' property instead. * Gets and sets the version. * @param value - The value to set. */ setVersion(value: string) : void; /** * @deprecated Please use the 'storeName' property instead. * Gets and sets the instance of the marketplace where the Office Add-in is stored. . */ getStoreName() : string; /** * Gets and sets the instance of the marketplace where the Office Add-in is stored. . */ storeName : string; /** * @deprecated Please use the 'storeName' property instead. * Gets and sets the instance of the marketplace where the Office Add-in is stored. . * @param value - The value to set. */ setStoreName(value: string) : void; /** * @deprecated Please use the 'storeType' property instead. * Gets and sets the type of marketplace that the store attribute identifies. */ getStoreType() : WebExtensionStoreType; /** * Gets and sets the type of marketplace that the store attribute identifies. */ storeType : WebExtensionStoreType; /** * @deprecated Please use the 'storeType' property instead. * Gets and sets the type of marketplace that the store attribute identifies. * @param value - The value to set. */ setStoreType(value: WebExtensionStoreType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of web extension reference. */ export class WebExtensionReferenceCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets web extension by the specific index. * @param index - The index. * @returns * The web extension */ get(index: number) : WebExtensionReference; /** * Adds an empty reference of web extension. */ add() : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the store type of web extension. */ export enum WebExtensionStoreType { /** * Specifies that the store type is Office.com. */ OMEX = 0, /** * Specifies that the store type is SharePoint corporate catalog. */ SPCatalog = 1, /** * Specifies that the store type is a SharePoint web application. */ SPApp = 2, /** * Specifies that the store type is an Exchange server. */ Exchange = 3, /** * Specifies that the store type is a file system share. */ FileSystem = 4, /** * Specifies that the store type is the system registry. */ Registry = 5, /** * Specifies that the store type is Centralized Deployment via Exchange. */ ExCatalog = 6, } /** * Represents a root object to create an Excel spreadsheet. * * @remarks * The Workbook class denotes an Excel spreadsheet. Each spreadsheet can contain multiple worksheets. * The basic feature of the class is to open and save native excel files. * The class has some advanced features like copying data from other Workbooks, combining two Workbooks, converting Excel to PDF, rendering Excel to image and protecting the Excel spreadsheet. */ export class Workbook { /** * Initializes a new instance of the class. * * @remarks * The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType). */ constructor(); /** * Initializes a new instance of the class. * @param fileFormatType - The new file format. * * @remarks * The default file format type is Excel97To2003. */ constructor(fileFormatType: FileFormatType); /** * Initializes a new empty instance of the class with options * @param loadOptions - The options. */ constructor(loadOptions: LoadOptions); constructor(file: string); /** * Initializes a new instance of the class and open a stream. * @param stream - The stream. */ constructor(stream: Uint8Array); /** * Initializes a new instance of the class and open a file. * @param file - The file name. * @param loadOptions - The load options */ constructor(file: string, loadOptions: LoadOptions); /** * Initializes a new instance of the class and open stream. * @param stream - The stream. * @param loadOptions - The load options */ constructor(stream: Uint8Array, loadOptions: LoadOptions); /** * Initializes a new instance of the class. * * @remarks * The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType). */ static openAsync() : Promise; /** * Initializes a new instance of the class. * @param fileFormatType - The new file format. * * @remarks * The default file format type is Excel97To2003. */ static openAsync(fileFormatType: FileFormatType) : Promise; /** * Initializes a new empty instance of the class with options * @param loadOptions - The options. */ static openAsync(loadOptions: LoadOptions) : Promise; static openAsync(file: string) : Promise; /** * Initializes a new instance of the class and open a stream. * @param stream - The stream. */ static openAsync(stream: Uint8Array) : Promise; /** * Initializes a new instance of the class and open a file. * @param file - The file name. * @param loadOptions - The load options */ static openAsync(file: string, loadOptions: LoadOptions) : Promise; /** * Initializes a new instance of the class and open stream. * @param stream - The stream. * @param loadOptions - The load options */ static openAsync(stream: Uint8Array, loadOptions: LoadOptions) : Promise; /** * @deprecated Please use the 'settings' property instead. * Represents the workbook settings. */ getSettings() : WorkbookSettings; /** * Represents the workbook settings. */ readonly settings : WorkbookSettings; /** * @deprecated Please use the 'worksheets' property instead. * Gets the collection in the spreadsheet. * @returns * collection */ getWorksheets() : WorksheetCollection; /** * Gets the collection in the spreadsheet. * @returns * collection */ readonly worksheets : WorksheetCollection; /** * Indicates whether license is set. */ readonly isLicensed : boolean; /** * @deprecated Please use the 'colors' property instead. * Returns colors in the palette for the spreadsheet. * * @remarks * The palette has 56 entries, each represented by an RGB value. */ getColors() : Color[]; /** * Returns colors in the palette for the spreadsheet. * * @remarks * The palette has 56 entries, each represented by an RGB value. */ readonly colors : Color[]; /** * @deprecated Please use the 'countOfStylesInPool' property instead. * Gets number of the styles in the style pool. */ getCountOfStylesInPool() : number; /** * Gets number of the styles in the style pool. */ readonly countOfStylesInPool : number; /** * @deprecated Please use the 'defaultStyle' property instead. * Gets or sets the default object of the workbook. * * @remarks * The DefaultStyle property is useful to implement a Style for the whole Workbook. */ getDefaultStyle() : Style; /** * Gets or sets the default object of the workbook. * * @remarks * The DefaultStyle property is useful to implement a Style for the whole Workbook. */ defaultStyle : Style; /** * @deprecated Please use the 'defaultStyle' property instead. * Gets or sets the default object of the workbook. * @param value - The value to set. * * @remarks * The DefaultStyle property is useful to implement a Style for the whole Workbook. */ setDefaultStyle(value: Style) : void; /** * Indicates if this spreadsheet is digitally signed. */ readonly isDigitallySigned : boolean; /** * Indicates whether structure or window is protected with password. */ readonly isWorkbookProtectedWithPassword : boolean; /** * @deprecated Please use the 'vbaProject' property instead. * Gets the in a spreadsheet. */ getVbaProject() : VbaProject; /** * Gets the in a spreadsheet. */ readonly vbaProject : VbaProject; /** * @deprecated Please use the 'hasMacro' property instead. * Indicates if this spreadsheet contains macro/VBA. */ getHasMacro() : boolean; /** * Indicates if this spreadsheet contains macro/VBA. */ readonly hasMacro : boolean; /** * @deprecated Please use the 'hasRevisions' property instead. * Gets if the workbook has any tracked changes */ getHasRevisions() : boolean; /** * Gets if the workbook has any tracked changes */ readonly hasRevisions : boolean; /** * @deprecated Please use the 'fileName' property instead. * Gets and sets the current file name. * * @remarks * If the file is opened by stream and there are some external formula references, * please set the file name. */ getFileName() : string; /** * Gets and sets the current file name. * * @remarks * If the file is opened by stream and there are some external formula references, * please set the file name. */ fileName : string; /** * @deprecated Please use the 'fileName' property instead. * Gets and sets the current file name. * @param value - The value to set. * * @remarks * If the file is opened by stream and there are some external formula references, * please set the file name. */ setFileName(value: string) : void; /** * @deprecated Please use the 'dataSorter' property instead. * Gets a DataSorter object to sort data. */ getDataSorter() : DataSorter; /** * Gets a DataSorter object to sort data. */ readonly dataSorter : DataSorter; /** * @deprecated Please use the 'theme' property instead. * Gets the theme name. */ getTheme() : string; /** * Gets the theme name. */ readonly theme : string; /** * @deprecated Please use the 'builtInDocumentProperties' property instead. * Returns a collection that represents all the built-in document properties of the spreadsheet. * * @remarks * A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. * The following is the built-in properties name list: *

Title

*

Subject

*

Author

*

Keywords

*

Comments

*

Template

*

Last Author

*

Revision Number

*

Application Name

*

Last Print Date

*

Creation Date

*

Last Save Time

*

Total Editing Time

*

Number of Pages

*

Number of Words

*

Number of Characters

*

Security

*

Category

*

Format

*

Manager

*

Company

*

Number of Bytes

*

Number of Lines

*

Number of Paragraphs

*

Number of Slides

*

Number of Notes

*

Number of Hidden Slides

*

Number of Multimedia Clips

*/ getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection; /** * Returns a collection that represents all the built-in document properties of the spreadsheet. * * @remarks * A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. * The following is the built-in properties name list: *

Title

*

Subject

*

Author

*

Keywords

*

Comments

*

Template

*

Last Author

*

Revision Number

*

Application Name

*

Last Print Date

*

Creation Date

*

Last Save Time

*

Total Editing Time

*

Number of Pages

*

Number of Words

*

Number of Characters

*

Security

*

Category

*

Format

*

Manager

*

Company

*

Number of Bytes

*

Number of Lines

*

Number of Paragraphs

*

Number of Slides

*

Number of Notes

*

Number of Hidden Slides

*

Number of Multimedia Clips

*/ readonly builtInDocumentProperties : BuiltInDocumentPropertyCollection; /** * @deprecated Please use the 'customDocumentProperties' property instead. * Returns a collection that represents all the custom document properties of the spreadsheet. */ getCustomDocumentProperties() : CustomDocumentPropertyCollection; /** * Returns a collection that represents all the custom document properties of the spreadsheet. */ readonly customDocumentProperties : CustomDocumentPropertyCollection; /** * @deprecated Please use the 'fileFormat' property instead. * Gets and sets the file format. */ getFileFormat() : FileFormatType; /** * Gets and sets the file format. */ fileFormat : FileFormatType; /** * @deprecated Please use the 'fileFormat' property instead. * Gets and sets the file format. * @param value - The value to set. */ setFileFormat(value: FileFormatType) : void; /** * @deprecated Please use the 'hasCustomFunction' property instead. * Detects whether there is custom function used in this workbook, * such as in cell's formula, in defined names... */ getHasCustomFunction() : boolean; /** * Detects whether there is custom function used in this workbook, * such as in cell's formula, in defined names... */ readonly hasCustomFunction : boolean; /** * @deprecated Please use the 'interruptMonitor' property instead. * Gets and sets the interrupt monitor. */ getInterruptMonitor() : AbstractInterruptMonitor; /** * Gets and sets the interrupt monitor. */ interruptMonitor : AbstractInterruptMonitor; /** * @deprecated Please use the 'interruptMonitor' property instead. * Gets and sets the interrupt monitor. * @param value - The value to set. */ setInterruptMonitor(value: AbstractInterruptMonitor) : void; /** * @deprecated Please use the 'contentTypeProperties' property instead. * Gets the list of objects in the workbook. */ getContentTypeProperties() : ContentTypePropertyCollection; /** * Gets the list of objects in the workbook. */ readonly contentTypeProperties : ContentTypePropertyCollection; /** * @deprecated Please use the 'customXmlParts' property instead. * Represents a Custom XML Data Storage Part (custom XML data within a package). */ getCustomXmlParts() : CustomXmlPartCollection; /** * Represents a Custom XML Data Storage Part (custom XML data within a package). */ readonly customXmlParts : CustomXmlPartCollection; /** * @deprecated Please use the 'dataMashup' property instead. * Gets mashup data. */ getDataMashup() : DataMashup; /** * Gets mashup data. */ readonly dataMashup : DataMashup; /** * @deprecated Please use the 'ribbonXml' property instead. * Gets and sets the XML file that defines the Ribbon UI. */ getRibbonXml() : string; /** * Gets and sets the XML file that defines the Ribbon UI. */ ribbonXml : string; /** * @deprecated Please use the 'ribbonXml' property instead. * Gets and sets the XML file that defines the Ribbon UI. * @param value - The value to set. */ setRibbonXml(value: string) : void; /** * @deprecated Please use the 'absolutePath' property instead. * Gets and sets the absolute path of the file. * * @remarks * Only used for external links. */ getAbsolutePath() : string; /** * Gets and sets the absolute path of the file. * * @remarks * Only used for external links. */ absolutePath : string; /** * @deprecated Please use the 'absolutePath' property instead. * Gets and sets the absolute path of the file. * @param value - The value to set. * * @remarks * Only used for external links. */ setAbsolutePath(value: string) : void; /** * @deprecated Please use the 'dataConnections' property instead. * Gets the collection. */ getDataConnections() : ExternalConnectionCollection; /** * Gets the collection. */ readonly dataConnections : ExternalConnectionCollection; /** * @deprecated Please use the 'dataModel' property instead. * Gets data model in the workbook. */ getDataModel() : DataModel; /** * Gets data model in the workbook. */ readonly dataModel : DataModel; /** * Parses all formulas which have not been parsed when they were loaded from template file or set to a cell. * @param ignoreError - Whether ignore error for invalid formula. /// For one invalid formula, if ignore error then this formula will be ignored /// and the process will continue to parse other formulas, otherwise exception will be thrown. */ parseFormulas(ignoreError: boolean) : void; /** * Starts the session that uses caches to access data. * @param opts - options of data access * * @remarks * If the cache of specified data access requires some data models in worksheet to be "read-only", * then corresponding data models in every worksheet in this workbook will be taken as "read-only" * and user should not change any of them. *

* After finishing the access to the data, should * be invoked with same options to clear all caches and recover normal access mode. *

*/ startAccessCache(opts: AccessCacheOptions) : void; /** * Closes the session that uses caches to access data. * @param opts - options of data access */ closeAccessCache(opts: AccessCacheOptions) : void; /** * Saves the workbook to the disk. * @param fileName - The file name. * @param saveFormat - The save format type. */ save(fileName: string, saveFormat: SaveFormat) : void; /** * Save the workbook to the disk. * @param fileName - */ save(fileName: string) : void; /** * Saves the workbook to the disk. * @param fileName - The file name. * @param saveOptions - The save options. */ save(fileName: string, saveOptions: SaveOptions) : void; /** * Saves the workbook to the stream. * @param saveFormat - The save file format type. * @returns * The result stream. */ save(saveFormat: SaveFormat) : Uint8Array; /** * Saves the workbook to the stream. * @param saveOptions - The save options. * @returns * The result stream. */ save(saveOptions: SaveOptions) : Uint8Array; /** * Saves the workbook to the disk. * @param fileName - The file name. * @param saveFormat - The save format type. */ saveAsync(fileName: string, saveFormat: SaveFormat) : Promise; /** * Save the workbook to the disk. * @param fileName - */ saveAsync(fileName: string) : Promise; /** * Saves the workbook to the disk. * @param fileName - The file name. * @param saveOptions - The save options. */ saveAsync(fileName: string, saveOptions: SaveOptions) : Promise; /** * Saves the workbook to the stream. * @param saveFormat - The save file format type. * @returns * The result stream. */ saveAsync(saveFormat: SaveFormat) : Promise; /** * Saves the workbook to the stream. * @param saveOptions - The save options. * @returns * The result stream. */ saveAsync(saveOptions: SaveOptions) : Promise; /** * Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it. * @returns * MemoryStream object which contains an xls Excel file. * * @remarks * This method provides same function as Save method and only save the workbook as Excel97-2003 xls file. * It's mainly for calling from COM clients. */ saveToStream() : Uint8Array; /** * Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it. * @returns * MemoryStream object which contains an xls Excel file. * * @remarks * This method provides same function as Save method and only save the workbook as Excel97-2003 xls file. * It's mainly for calling from COM clients. */ saveToStreamAsync() : Promise; /** * Remove all unused styles. */ removeUnusedStyles() : void; /** * Creates a new style. * @returns * Returns a style object. */ createStyle() : Style; /** * Creates a new style. * @param cloneDefaultStyle - Incidates whether clones the default style * @returns * Returns a style object. */ createStyle(cloneDefaultStyle: boolean) : Style; /** * Creates built-in style by given type. * @param type - The builtin style stype. * @returns * object */ createBuiltinStyle(type: BuiltinStyleType) : Style; /** * Creates a object. * @returns * Returns a object. */ createCellsColor() : CellsColor; /** * Replaces a cell's value with a new string. * @param placeHolder - Cell placeholder * @param newValue - String value to replace */ replace(placeHolder: string, newValue: string) : number; /** * Replaces a cell's value with a new integer. * @param placeHolder - Cell placeholder * @param newValue - Integer value to replace */ replace(placeHolder: string, newValue: number) : number; /** * Replaces a cell's value with a new double. * @param placeHolder - Cell placeholder * @param newValue - Double value to replace */ replace(placeHolder: string, newValue: number) : number; /** * Replaces a cell's value with a new string array. * @param placeHolder - Cell placeholder * @param newValues - String array to replace * @param isVertical - True - Vertical, False - Horizontal */ replace(placeHolder: string, newValues: string[], isVertical: boolean) : number; /** * Replaces cells' values with an integer array. * @param placeHolder - Cell placeholder * @param newValues - Integer array to replace * @param isVertical - True - Vertical, False - Horizontal */ replace(placeHolder: string, newValues: number[], isVertical: boolean) : number; /** * Replaces cells' values with a double array. * @param placeHolder - Cell placeholder * @param newValues - Double array to replace * @param isVertical - True - Vertical, False - Horizontal */ replace(placeHolder: string, newValues: number[], isVertical: boolean) : number; /** * Replaces cells' values with new data. * @param boolValue - The boolean value to be replaced. * @param newValue - New value. Can be string, integer, double or DateTime value. */ replace(boolValue: boolean, newValue: Object) : number; /** * Replaces cells' values with new data. * @param intValue - The integer value to be replaced. * @param newValue - New value. Can be string, integer, double or DateTime value. */ replace(intValue: number, newValue: Object) : number; /** * Replaces a cell's value with a new string. * @param placeHolder - Cell placeholder * @param newValue - String value to replace * @param options - The replace options */ replace(placeHolder: string, newValue: string, options: ReplaceOptions) : number; /** * Copies another Workbook object. * @param source - Source Workbook object. * @param copyOptions - The options of copying other workbook. * * @remarks * It's very simple to clone an Excel file. */ copy(source: Workbook, copyOptions: CopyOptions) : void; /** * Copies data from a source Workbook object. * @param source - Source Workbook object. */ copy(source: Workbook) : void; /** * Combines another Workbook object. * @param secondWorkbook - Another Workbook object. * * @remarks * Merge Excel, ODS , CSV and other files to one file. */ combine(secondWorkbook: Workbook) : void; /** * Gets the style in the style pool. * All styles in the workbook will be gathered into a pool. * There is only a simple reference index in the cells. * @param index - The index. * @returns * The style in the pool corresponds to given index, may be null. * * @remarks * If the returned style is changed, the style of all cells(which refers to this style) will be changed. */ getStyleInPool(index: number) : Style; /** * Gets all fonts in the style pool. */ getFonts() : Font[]; /** * Gets the named style in the style pool. * @param name - name of the style * @returns * named style, maybe null. */ getNamedStyle(name: string) : Style; /** * Merges named styles from the other Excel file. * @param source - The other file */ mergeNamedStyles(source: Workbook) : void; /** * Changes the palette for the spreadsheet in the specified index. * @param color - Color structure. * @param index - Palette index, 0 - 55. * * @remarks *

The palette has 56 entries, each represented by an RGB value.

*

If you set a color which is not in the palette, it will not take effect.

*

So if you want to set a custom color, please change the palette at first.

*

The following is the standard color palette.

* * * Color * Red * Green * Blue * * * Black * 0 * 0 * 0 * * * White * 255 * 255 * 255 * * * Red * 255 * 0 * 0 * * * Lime * 0 * 255 * 0 * * * Blue * 0 * 0 * 255 * * * Yellow * 255 * 255 * 0 * * * Magenta * 255 * 0 * 255 * * * Cyan * 0 * 255 * 255 * * * Maroon * 128 * 0 * 0 * * * Green * 0 * 128 * 0 * * * Navy * 0 * 0 * 128 * * * Olive * 128 * 128 * 0 * * * Purple * 128 * 0 * 128 * * * Teal * 0 * 128 * 128 * * * Silver * 192 * 192 * 192 * * * Gray * 128 * 128 * 128 * * * Color17 * 153 * 153 * 255 * * * Color18 * 153 * 51 * 102 * * * Color19 * 255 * 255 * 204 * * * Color20 * 204 * 255 * 255 * * * Color21 * 102 * 0 * 102 * * * Color22 * 255 * 128 * 128 * * * Color23 * 0 * 102 * 204 * * * Color24 * 204 * 204 * 255 * * * Color25 * 0 * 0 * 128 * * * Color26 * 255 * 0 * 255 * * * Color27 * 255 * 255 * 0 * * * Color28 * 0 * 255 * 255 * * * Color29 * 128 * 0 * 128 * * * Color30 * 128 * 0 * 0 * * * Color31 * 0 * 128 * 128 * * * Color32 * 0 * 0 * 255 * * * Color33 * 0 * 204 * 255 * * * Color34 * 204 * 255 * 255 * * * Color35 * 204 * 255 * 204 * * * Color36 * 255 * 255 * 153 * * * Color37 * 153 * 204 * 255 * * * Color38 * 255 * 153 * 204 * * * Color39 * 204 * 153 * 255 * * * Color40 * 255 * 204 * 153 * * * Color41 * 51 * 102 * 255 * * * Color42 * 51 * 204 * 204 * * * Color43 * 153 * 204 * 0 * * * Color44 * 255 * 204 * 0 * * * Color45 * 255 * 153 * 0 * * * Color46 * 255 * 102 * 0 * * * Color47 * 102 * 102 * 153 * * * Color48 * 150 * 150 * 150 * * * Color49 * 0 * 51 * 102 * * * Color50 * 51 * 153 * 102 * * * Color51 * 0 * 51 * 0 * * * Color52 * 51 * 51 * 0 * * * Color53 * 153 * 51 * 0 * * * Color54 * 153 * 51 * 102 * * * Color55 * 51 * 51 * 153 * * * Color56 * 51 * 51 * 51 * * */ changePalette(color: Color, index: number) : void; /** * Checks if a color is in the palette for the spreadsheet. * @param color - Color structure. * @returns * Returns true if this color is in the palette. Otherwise, returns false */ isColorInPalette(color: Color) : boolean; /** * Calculates the result of formulas. * * @remarks * For all supported formulas, please see the list at https://docs.aspose.com/display/cellsnet/Supported+Formula+Functions */ calculateFormula() : void; /** * Calculates the result of formulas. * @param ignoreError - Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc. */ calculateFormula(ignoreError: boolean) : void; /** * Calculating formulas in this workbook. * @param options - Options for calculation */ calculateFormula(options: CalculationOptions) : void; /** * Calculates the result of formulas. * * @remarks * For all supported formulas, please see the list at https://docs.aspose.com/display/cellsnet/Supported+Formula+Functions */ calculateFormulaAsync() : Promise; /** * Calculates the result of formulas. * @param ignoreError - Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc. */ calculateFormulaAsync(ignoreError: boolean) : Promise; /** * Calculating formulas in this workbook. * @param options - Options for calculation */ calculateFormulaAsync(options: CalculationOptions) : Promise; /** * Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) * Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas. * @param calculate - Whether calculates and updates cell values for those dynamic array formulas */ refreshDynamicArrayFormulas(calculate: boolean) : void; /** * Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) * @param calculate - Whether calculates and updates cell values for those dynamic array formulas * @param copts - The options for calculating formulas * * @remarks * For performance consideration, we do not refresh all dynamic array formulas automatically * when the formula itself or the data it references to changed. * So user need to call this method manually after those operations which may influence dynamic array formulas, * such as importing/setting cell values, inserting/deleting rows/columns/ranges, ...etc.

* For most formulas with functions, calculating the spill range also needs to calculating the formula, * so in general true value for "calculate" flag is preferred. * If the formula is simple, such as a range reference or array(for example "=C1:E5", "={1,2;3,4}", ...), * simple function on a range or array(for example "=ABS(C1:E5)", "=1+{1,2;3,4}", ...), * and all formulas will be calculated later(such as by ), * then using false vlaue for "calculate" flag may avoid the duplicated calculation for the benefit of performance. */ refreshDynamicArrayFormulas(calculate: boolean, copts: CalculationOptions) : void; /** * Find best matching Color in current palette. * @param rawColor - Raw color. * @returns * Best matching color. * * @remarks * There are only 56 colors in the color palette in Excel 97-2003. * If the color is not in the palette, the similar color will be set. */ getMatchingColor(rawColor: Color) : Color; /** * Set Encryption Options. * @param encryptionType - The encryption type. * @param keyLength - The key length. */ setEncryptionOptions(encryptionType: EncryptionType, keyLength: number) : void; /** * Protects a workbook. * @param protectionType - Protection type. * @param password - Password to protect the workbook. */ protect(protectionType: ProtectionType, password: string) : void; /** * Protects a shared workbook. * @param password - Password to protect the workbook. */ protectSharedWorkbook(password: string) : void; /** * Unprotects a workbook. * @param password - Password to unprotect the workbook. */ unprotect(password: string) : void; /** * Unprotects a shared workbook. * @param password - Password to unprotect the workbook. */ unprotectSharedWorkbook(password: string) : void; /** * Removes VBA/macro from this spreadsheet. */ removeMacro() : void; /** * Removes digital signature from this spreadsheet. */ removeDigitalSignature() : void; /** * Accepts all tracked changes in the workbook. */ acceptAllRevisions() : void; /** * Gets theme color. * @param type - The theme color type. * @returns * The theme color. */ getThemeColor(type: ThemeColorType) : Color; /** * Sets the theme color * @param type - The theme color type. * @param color - the theme color */ setThemeColor(type: ThemeColorType, color: Color) : void; /** * Customs the theme. * @param themeName - The theme name * @param colors - The theme colors * * @remarks * The length of colors should be 12. * * * Array index * Theme type * * * 0 * Backgournd1 * * * 1 * Text1 * * * 2 * Backgournd2 * * * 3 * Text2 * * * 4 * Accent1 * * * 5 * Accent2 * * * 6 * Accent3 * * * 7 * Accent4 * * * 8 * Accent5 * * * 9 * Accent6 * * * 10 * Hyperlink * * * 11 * Followed Hyperlink * * */ customTheme(themeName: string, colors: Color[]) : void; /** * Copies the theme from another workbook. * @param source - Source workbook. */ copyTheme(source: Workbook) : void; /** * Updates definition of custom functions. * @param definition - Special definition of custom functions for user's special requirement. * * @remarks * This method can be used for some special scenarios. For example, if user needs some parameters * of some custom functions be calculated in array mode, then user may provide their own definition with implemented * for those functions. * After the data of formulas being updated, those specified parameters will be calculated in array mode automatically * when calculating corresponding custom functions. */ updateCustomFunctionDefinition(definition: CustomFunctionDefinition) : void; /** * If this workbook contains external links to other data source, * Aspose.Cells will attempt to retrieve the latest data from give sources. * @param externalWorkbooks - Workbooks that will be used to update data of external links referenced by this workbook. /// The match of those workbooks with external links is determined by /// and . So please make sure has /// been specified with the proper value for every workbook so they can be linked to corresponding external link. * * @remarks * If corresponding external link cannot be found for one workbook, then this workbook will be ignored. * So when you set a formula later with one new external link which you intend to make the ignored workbook * be linked to it, the link cannot be performed until you call this this method again with those workbooks. */ updateLinkedDataSource(externalWorkbooks: Workbook[]) : void; /** * Sets the interrupt monitor. * @param interruptMonitor - An InterruptMonitor object. */ setInterruptMonitor(interruptMonitor: InterruptMonitor) : void; /** * Imports/Updates an XML data file into the workbook. * @param url - the url/path of the xml file. * @param sheetName - the destination sheet name. * @param row - the destination row * @param col - the destination column */ importXml(url: string, sheetName: string, row: number, col: number) : void; /** * Imports/Updates an XML data file into the workbook. * @param stream - the xml file stream. * @param sheetName - the destination sheet name. * @param row - the destination row. * @param col - the destination column. */ importXml(stream: Uint8Array, sheetName: string, row: number, col: number) : void; /** * Export XML data linked by the specified XML map. * @param mapName - name of the XML map that need to be exported * @param path - the export path */ exportXml(mapName: string, path: string) : void; /** * Export XML data. * @param mapName - name of the XML map that need to be exported * @returns * The result stream. */ exportXml(mapName: string) : Uint8Array; /** * Sets digital signature to an spreadsheet file (Excel2007 and later). * @param digitalSignatureCollection - * * @remarks * Only support adding Xmldsig Digital Signature */ setDigitalSignature(digitalSignatureCollection: DigitalSignatureCollection) : void; /** * Adds digital signature to an OOXML spreadsheet file (Excel2007 and later). * @param digitalSignatureCollection - * * @remarks * Only support adding Xmldsig Digital Signature to an OOXML spreadsheet file */ addDigitalSignature(digitalSignatureCollection: DigitalSignatureCollection) : void; /** * Gets digital signature from file. */ getDigitalSignature() : DigitalSignatureCollection; /** * Removes personal information. */ removePersonalInformation() : void; /** * Refresh linked shapes, all pivot tables and charts with pivot source. */ refreshAll() : void; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all settings of the workbook. */ export class WorkbookSettings { /** * @deprecated Please use the 'author' property instead. * Gets and sets the author of the file. * * @remarks * It''s not set, check first, then check the user of Environment. */ getAuthor() : string; /** * Gets and sets the author of the file. * * @remarks * It''s not set, check first, then check the user of Environment. */ author : string; /** * @deprecated Please use the 'author' property instead. * Gets and sets the author of the file. * @param value - The value to set. * * @remarks * It''s not set, check first, then check the user of Environment. */ setAuthor(value: string) : void; /** * @deprecated Please use the 'checkCustomNumberFormat' property instead. * Indicates whether checking custom number format when setting Style.Custom. */ getCheckCustomNumberFormat() : boolean; /** * Indicates whether checking custom number format when setting Style.Custom. */ checkCustomNumberFormat : boolean; /** * @deprecated Please use the 'checkCustomNumberFormat' property instead. * Indicates whether checking custom number format when setting Style.Custom. * @param value - The value to set. */ setCheckCustomNumberFormat(value: boolean) : void; /** * @deprecated Please use the 'enableMacros' property instead. * Enable macros; * * @remarks * Now it only works when copying a worksheet to other worksheet in a workbook. */ getEnableMacros() : boolean; /** * Enable macros; * * @remarks * Now it only works when copying a worksheet to other worksheet in a workbook. */ enableMacros : boolean; /** * @deprecated Please use the 'enableMacros' property instead. * Enable macros; * @param value - The value to set. * * @remarks * Now it only works when copying a worksheet to other worksheet in a workbook. */ setEnableMacros(value: boolean) : void; /** * @deprecated Please use the 'date1904' property instead. * Gets or sets a value which represents if the workbook uses the 1904 date system. */ getDate1904() : boolean; /** * Gets or sets a value which represents if the workbook uses the 1904 date system. */ date1904 : boolean; /** * @deprecated Please use the 'date1904' property instead. * Gets or sets a value which represents if the workbook uses the 1904 date system. * @param value - The value to set. */ setDate1904(value: boolean) : void; /** * @deprecated Please use the 'protectionType' property instead. * Gets the protection type of the workbook. */ getProtectionType() : ProtectionType; /** * Gets the protection type of the workbook. */ readonly protectionType : ProtectionType; /** * @deprecated Please use the 'displayDrawingObjects' property instead. * Indicates whether and how to show objects in the workbook. */ getDisplayDrawingObjects() : DisplayDrawingObjects; /** * Indicates whether and how to show objects in the workbook. */ displayDrawingObjects : DisplayDrawingObjects; /** * @deprecated Please use the 'displayDrawingObjects' property instead. * Indicates whether and how to show objects in the workbook. * @param value - The value to set. */ setDisplayDrawingObjects(value: DisplayDrawingObjects) : void; /** * @deprecated Please use the 'sheetTabBarWidth' property instead. * Width of worksheet tab bar (in 1/1000 of window width). */ getSheetTabBarWidth() : number; /** * Width of worksheet tab bar (in 1/1000 of window width). */ sheetTabBarWidth : number; /** * @deprecated Please use the 'sheetTabBarWidth' property instead. * Width of worksheet tab bar (in 1/1000 of window width). * @param value - The value to set. */ setSheetTabBarWidth(value: number) : void; /** * @deprecated Please use the 'showTabs' property instead. * Get or sets a value whether the Workbook tabs are displayed. * * @remarks * The default value is true. */ getShowTabs() : boolean; /** * Get or sets a value whether the Workbook tabs are displayed. * * @remarks * The default value is true. */ showTabs : boolean; /** * @deprecated Please use the 'showTabs' property instead. * Get or sets a value whether the Workbook tabs are displayed. * @param value - The value to set. * * @remarks * The default value is true. */ setShowTabs(value: boolean) : void; /** * @deprecated Please use the 'firstVisibleTab' property instead. * Gets or sets the first visible worksheet tab. */ getFirstVisibleTab() : number; /** * Gets or sets the first visible worksheet tab. */ firstVisibleTab : number; /** * @deprecated Please use the 'firstVisibleTab' property instead. * Gets or sets the first visible worksheet tab. * @param value - The value to set. */ setFirstVisibleTab(value: number) : void; /** * Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar. * * @remarks * The default value is true. */ isHScrollBarVisible : boolean; /** * @deprecated Please use the 'isHScrollBarVisible' property instead. * Gets or sets a value indicating whether the generated spreadsheet will contain a horizontal scroll bar. * @param value - The value to set. * * @remarks * The default value is true. */ setIsHScrollBarVisible(value: boolean) : void; /** * Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar. * * @remarks * The default value is true. */ isVScrollBarVisible : boolean; /** * @deprecated Please use the 'isVScrollBarVisible' property instead. * Gets or sets a value indicating whether the generated spreadsheet will contain a vertical scroll bar. * @param value - The value to set. * * @remarks * The default value is true. */ setIsVScrollBarVisible(value: boolean) : void; /** * @deprecated Please use the 'shared' property instead. * Gets or sets a value that indicates whether the Workbook is shared. * * @remarks * The default value is false. */ getShared() : boolean; /** * Gets or sets a value that indicates whether the Workbook is shared. * * @remarks * The default value is false. */ shared : boolean; /** * @deprecated Please use the 'shared' property instead. * Gets or sets a value that indicates whether the Workbook is shared. * @param value - The value to set. * * @remarks * The default value is false. */ setShared(value: boolean) : void; /** * @deprecated Please use the 'languageCode' property instead. * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. */ getLanguageCode() : CountryCode; /** * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. */ languageCode : CountryCode; /** * @deprecated Please use the 'languageCode' property instead. * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. * @param value - The value to set. */ setLanguageCode(value: CountryCode) : void; /** * @deprecated Please use the 'region' property instead. * Gets or sets the regional settings for workbook. * * @remarks * 1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: * i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. * So, we use the saved region in the template file for the workbook. * If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. * And, we save the user specified value (by this method) into the file too when saving an XLS file. * ii). For other file formats, such as, XLSX, XLSB...etc., there is no field defined for regional settings in the file format specification. * So, we use the regional settings of application's environment for the workbook. * And, the user specified value (by this method) cannot be kept for the generated files with those file formats. * 2. For the view effect in MS Excel: * The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. * Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, * the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, * not the one saved in the file. It is MS Excel's behavior and cannot be changed by code. */ getRegion() : CountryCode; /** * Gets or sets the regional settings for workbook. * * @remarks * 1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: * i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. * So, we use the saved region in the template file for the workbook. * If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. * And, we save the user specified value (by this method) into the file too when saving an XLS file. * ii). For other file formats, such as, XLSX, XLSB...etc., there is no field defined for regional settings in the file format specification. * So, we use the regional settings of application's environment for the workbook. * And, the user specified value (by this method) cannot be kept for the generated files with those file formats. * 2. For the view effect in MS Excel: * The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. * Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, * the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, * not the one saved in the file. It is MS Excel's behavior and cannot be changed by code. */ region : CountryCode; /** * @deprecated Please use the 'region' property instead. * Gets or sets the regional settings for workbook. * @param value - The value to set. * * @remarks * 1. Regional settings used by Aspose.Cells component for a workbook loaded from template file: * i). For an XLS file, there are fields defined for regional settings and MS Excel does save regional settings data into the file when saving the XLS file. * So, we use the saved region in the template file for the workbook. * If you do not want to use the region saved in the XLS file, please reset it to the expected one (such as, CountryCode.Default) after loading the template file. * And, we save the user specified value (by this method) into the file too when saving an XLS file. * ii). For other file formats, such as, XLSX, XLSB...etc., there is no field defined for regional settings in the file format specification. * So, we use the regional settings of application's environment for the workbook. * And, the user specified value (by this method) cannot be kept for the generated files with those file formats. * 2. For the view effect in MS Excel: * The applied regional settings here can take effect only at runtime with Aspose.Cells component and not when viewing the generated file with MS Excel. * Even for the generated XLS file in which the specified regional settings data has been saved, when viewing/editing it with MS Excel, * the used region to perform formatting by MS Excel is always the default regional settings of the environment where MS Excel is running, * not the one saved in the file. It is MS Excel's behavior and cannot be changed by code. */ setRegion(value: CountryCode) : void; /** * @deprecated Please use the 'globalizationSettings' property instead. * Gets and sets the globalization settings. */ getGlobalizationSettings() : GlobalizationSettings; /** * Gets and sets the globalization settings. */ globalizationSettings : GlobalizationSettings; /** * @deprecated Please use the 'globalizationSettings' property instead. * Gets and sets the globalization settings. * @param value - The value to set. */ setGlobalizationSettings(value: GlobalizationSettings) : void; /** * @deprecated Please use the 'numberDecimalSeparator' property instead. * Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region. */ getNumberDecimalSeparator() : string; /** * Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region. */ numberDecimalSeparator : string; /** * @deprecated Please use the 'numberDecimalSeparator' property instead. * Gets or sets the decimal separator for formatting/parsing numeric values. Default is the decimal separator of current Region. * @param value - The value to set. */ setNumberDecimalSeparator(value: string) : void; /** * @deprecated Please use the 'numberGroupSeparator' property instead. * Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region. */ getNumberGroupSeparator() : string; /** * Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region. */ numberGroupSeparator : string; /** * @deprecated Please use the 'numberGroupSeparator' property instead. * Gets or sets the character that separates groups of digits to the left of the decimal in numeric values. Default is the group separator of current Region. * @param value - The value to set. */ setNumberGroupSeparator(value: string) : void; /** * @deprecated Please use the 'password' property instead. * Represents Workbook file encryption password. */ getPassword() : string; /** * Represents Workbook file encryption password. */ password : string; /** * @deprecated Please use the 'password' property instead. * Represents Workbook file encryption password. * @param value - The value to set. */ setPassword(value: string) : void; /** * @deprecated Please use the 'writeProtection' property instead. * Provides access to the workbook write protection options. */ getWriteProtection() : WriteProtection; /** * Provides access to the workbook write protection options. */ readonly writeProtection : WriteProtection; /** * Gets a value that indicates whether a password is required to open this workbook. */ readonly isEncrypted : boolean; /** * Gets a value that indicates whether the structure or window of the Workbook is protected. */ readonly isProtected : boolean; /** * Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked. * * @remarks * The default value is false now. It's same as MS Excel 2013. */ isDefaultEncrypted : boolean; /** * @deprecated Please use the 'isDefaultEncrypted' property instead. * Indicates whether encrypting the workbook with default password if Structure and Windows of the workbook are locked. * @param value - The value to set. * * @remarks * The default value is false now. It's same as MS Excel 2013. */ setIsDefaultEncrypted(value: boolean) : void; /** * Represents whether the generated spreadsheet will be opened Minimized. */ isMinimized : boolean; /** * @deprecated Please use the 'isMinimized' property instead. * Represents whether the generated spreadsheet will be opened Minimized. * @param value - The value to set. */ setIsMinimized(value: boolean) : void; /** * Indicates whether this workbook is hidden. */ isHidden : boolean; /** * @deprecated Please use the 'isHidden' property instead. * Indicates whether this workbook is hidden. * @param value - The value to set. */ setIsHidden(value: boolean) : void; /** * @deprecated Please use the 'autoCompressPictures' property instead. * Specifies a boolean value that indicates the application automatically compressed pictures in the workbook. */ getAutoCompressPictures() : boolean; /** * Specifies a boolean value that indicates the application automatically compressed pictures in the workbook. */ autoCompressPictures : boolean; /** * @deprecated Please use the 'autoCompressPictures' property instead. * Specifies a boolean value that indicates the application automatically compressed pictures in the workbook. * @param value - The value to set. */ setAutoCompressPictures(value: boolean) : void; /** * @deprecated Please use the 'removePersonalInformation' property instead. * True if personal information can be removed from the specified workbook. * * @remarks */ getRemovePersonalInformation() : boolean; /** * True if personal information can be removed from the specified workbook. * * @remarks */ removePersonalInformation : boolean; /** * @deprecated Please use the 'removePersonalInformation' property instead. * True if personal information can be removed from the specified workbook. * @param value - The value to set. * * @remarks */ setRemovePersonalInformation(value: boolean) : void; /** * @deprecated Please use the 'shapeDisplayType' property instead. * Gets and sets how the application displays shapes in this workbook */ getShapeDisplayType() : ShapeDisplayType; /** * Gets and sets how the application displays shapes in this workbook */ shapeDisplayType : ShapeDisplayType; /** * @deprecated Please use the 'shapeDisplayType' property instead. * Gets and sets how the application displays shapes in this workbook * @param value - The value to set. */ setShapeDisplayType(value: ShapeDisplayType) : void; /** * @deprecated Please use the 'hidePivotFieldList' property instead. * Gets and sets whether hide the field list for the PivotTable. */ getHidePivotFieldList() : boolean; /** * Gets and sets whether hide the field list for the PivotTable. */ hidePivotFieldList : boolean; /** * @deprecated Please use the 'hidePivotFieldList' property instead. * Gets and sets whether hide the field list for the PivotTable. * @param value - The value to set. */ setHidePivotFieldList(value: boolean) : void; /** * @deprecated Please use the 'maxUniqueItemsPerField' property instead. * Gets and set the limitation of unique items per field * * @remarks */ getMaxUniqueItemsPerField() : number; /** * Gets and set the limitation of unique items per field * * @remarks */ maxUniqueItemsPerField : number; /** * @deprecated Please use the 'maxUniqueItemsPerField' property instead. * Gets and set the limitation of unique items per field * @param value - The value to set. * * @remarks */ setMaxUniqueItemsPerField(value: number) : void; /** * @deprecated Please use the 'updateLinksType' property instead. * Gets and sets how updates external links when the workbook is opened. */ getUpdateLinksType() : UpdateLinksType; /** * Gets and sets how updates external links when the workbook is opened. */ updateLinksType : UpdateLinksType; /** * @deprecated Please use the 'updateLinksType' property instead. * Gets and sets how updates external links when the workbook is opened. * @param value - The value to set. */ setUpdateLinksType(value: UpdateLinksType) : void; /** * @deprecated Please use the 'maxRow' property instead. * Gets the max row index, zero-based. * * @remarks * Returns 65535 if the file format is Excel97-2003; */ getMaxRow() : number; /** * Gets the max row index, zero-based. * * @remarks * Returns 65535 if the file format is Excel97-2003; */ readonly maxRow : number; /** * @deprecated Please use the 'maxColumn' property instead. * Gets the max column index, zero-based. * * @remarks * Returns 255 if the file format is Excel97-2003; */ getMaxColumn() : number; /** * Gets the max column index, zero-based. * * @remarks * Returns 255 if the file format is Excel97-2003; */ readonly maxColumn : number; /** * @deprecated Please use the 'smartTagOptions' property instead. * Gets the options of the smart tag. */ getSmartTagOptions() : SmartTagOptions; /** * Gets the options of the smart tag. */ readonly smartTagOptions : SmartTagOptions; /** * @deprecated Please use the 'defaultStyleSettings' property instead. * Gets the settings for default values of style-related properties for this workbook. */ getDefaultStyleSettings() : DefaultStyleSettings; /** * Gets the settings for default values of style-related properties for this workbook. */ readonly defaultStyleSettings : DefaultStyleSettings; /** * @deprecated Please use the 'windowLeft' property instead. * The distance from the left edge of the client area to the left edge of the window, in unit of point. */ getWindowLeft() : number; /** * The distance from the left edge of the client area to the left edge of the window, in unit of point. */ windowLeft : number; /** * @deprecated Please use the 'windowLeft' property instead. * The distance from the left edge of the client area to the left edge of the window, in unit of point. * @param value - The value to set. */ setWindowLeft(value: number) : void; /** * @deprecated Please use the 'windowLeftInch' property instead. * The distance from the left edge of the client area to the left edge of the window. * In unit of inch. */ getWindowLeftInch() : number; /** * The distance from the left edge of the client area to the left edge of the window. * In unit of inch. */ windowLeftInch : number; /** * @deprecated Please use the 'windowLeftInch' property instead. * The distance from the left edge of the client area to the left edge of the window. * In unit of inch. * @param value - The value to set. */ setWindowLeftInch(value: number) : void; /** * @deprecated Please use the 'windowLeftCM' property instead. * The distance from the left edge of the client area to the left edge of the window. * In unit of centimeter. */ getWindowLeftCM() : number; /** * The distance from the left edge of the client area to the left edge of the window. * In unit of centimeter. */ windowLeftCM : number; /** * @deprecated Please use the 'windowLeftCM' property instead. * The distance from the left edge of the client area to the left edge of the window. * In unit of centimeter. * @param value - The value to set. */ setWindowLeftCM(value: number) : void; /** * @deprecated Please use the 'windowTop' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of point. */ getWindowTop() : number; /** * The distance from the top edge of the client area to the top edge of the window, in unit of point. */ windowTop : number; /** * @deprecated Please use the 'windowTop' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of point. * @param value - The value to set. */ setWindowTop(value: number) : void; /** * @deprecated Please use the 'windowTopInch' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of inch. */ getWindowTopInch() : number; /** * The distance from the top edge of the client area to the top edge of the window, in unit of inch. */ windowTopInch : number; /** * @deprecated Please use the 'windowTopInch' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of inch. * @param value - The value to set. */ setWindowTopInch(value: number) : void; /** * @deprecated Please use the 'windowTopCM' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of centimeter. */ getWindowTopCM() : number; /** * The distance from the top edge of the client area to the top edge of the window, in unit of centimeter. */ windowTopCM : number; /** * @deprecated Please use the 'windowTopCM' property instead. * The distance from the top edge of the client area to the top edge of the window, in unit of centimeter. * @param value - The value to set. */ setWindowTopCM(value: number) : void; /** * @deprecated Please use the 'windowWidth' property instead. * The width of the window, in unit of point. */ getWindowWidth() : number; /** * The width of the window, in unit of point. */ windowWidth : number; /** * @deprecated Please use the 'windowWidth' property instead. * The width of the window, in unit of point. * @param value - The value to set. */ setWindowWidth(value: number) : void; /** * @deprecated Please use the 'windowWidthInch' property instead. * The width of the window, in unit of inch. */ getWindowWidthInch() : number; /** * The width of the window, in unit of inch. */ windowWidthInch : number; /** * @deprecated Please use the 'windowWidthInch' property instead. * The width of the window, in unit of inch. * @param value - The value to set. */ setWindowWidthInch(value: number) : void; /** * @deprecated Please use the 'windowWidthCM' property instead. * The width of the window, in unit of centimeter. */ getWindowWidthCM() : number; /** * The width of the window, in unit of centimeter. */ windowWidthCM : number; /** * @deprecated Please use the 'windowWidthCM' property instead. * The width of the window, in unit of centimeter. * @param value - The value to set. */ setWindowWidthCM(value: number) : void; /** * @deprecated Please use the 'windowHeight' property instead. * The height of the window, in unit of point. */ getWindowHeight() : number; /** * The height of the window, in unit of point. */ windowHeight : number; /** * @deprecated Please use the 'windowHeight' property instead. * The height of the window, in unit of point. * @param value - The value to set. */ setWindowHeight(value: number) : void; /** * @deprecated Please use the 'windowHeightInch' property instead. * The height of the window, in unit of inch. */ getWindowHeightInch() : number; /** * The height of the window, in unit of inch. */ windowHeightInch : number; /** * @deprecated Please use the 'windowHeightInch' property instead. * The height of the window, in unit of inch. * @param value - The value to set. */ setWindowHeightInch(value: number) : void; /** * @deprecated Please use the 'windowHeightCM' property instead. * The height of the window, in unit of centimeter. */ getWindowHeightCM() : number; /** * The height of the window, in unit of centimeter. */ windowHeightCM : number; /** * @deprecated Please use the 'windowHeightCM' property instead. * The height of the window, in unit of centimeter. * @param value - The value to set. */ setWindowHeightCM(value: number) : void; /** * @deprecated Please use the 'updateAdjacentCellsBorder' property instead. * Indicates whether update adjacent cells' border. * * @remarks * The default value is false. * For example: the bottom border of the cell A1 is update, * the top border of the cell A2 should be changed too. */ getUpdateAdjacentCellsBorder() : boolean; /** * Indicates whether update adjacent cells' border. * * @remarks * The default value is false. * For example: the bottom border of the cell A1 is update, * the top border of the cell A2 should be changed too. */ updateAdjacentCellsBorder : boolean; /** * @deprecated Please use the 'updateAdjacentCellsBorder' property instead. * Indicates whether update adjacent cells' border. * @param value - The value to set. * * @remarks * The default value is false. * For example: the bottom border of the cell A1 is update, * the top border of the cell A2 should be changed too. */ setUpdateAdjacentCellsBorder(value: boolean) : void; /** * @deprecated Please use the 'significantDigitsType' property instead. * Gets and sets the type of significant digits for outputing numeric * values in this workbook. Default value is . */ getSignificantDigitsType() : SignificantDigitsType; /** * Gets and sets the type of significant digits for outputing numeric * values in this workbook. Default value is . */ significantDigitsType : SignificantDigitsType; /** * @deprecated Please use the 'significantDigitsType' property instead. * Gets and sets the type of significant digits for outputing numeric * values in this workbook. Default value is . * @param value - The value to set. */ setSignificantDigitsType(value: SignificantDigitsType) : void; /** * @deprecated Please use the 'checkCompatibility' property instead. * Indicates whether check compatibility with earlier versions when saving workbook. * * @remarks * The default value is true. * Only for Excel97-2003 xls or xlt files. */ getCheckCompatibility() : boolean; /** * Indicates whether check compatibility with earlier versions when saving workbook. * * @remarks * The default value is true. * Only for Excel97-2003 xls or xlt files. */ checkCompatibility : boolean; /** * @deprecated Please use the 'checkCompatibility' property instead. * Indicates whether check compatibility with earlier versions when saving workbook. * @param value - The value to set. * * @remarks * The default value is true. * Only for Excel97-2003 xls or xlt files. */ setCheckCompatibility(value: boolean) : void; /** * @deprecated Please use the 'checkExcelRestriction' property instead. * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. */ getCheckExcelRestriction() : boolean; /** * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. */ checkExcelRestriction : boolean; /** * @deprecated Please use the 'checkExcelRestriction' property instead. * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. * @param value - The value to set. */ setCheckExcelRestriction(value: boolean) : void; /** * @deprecated Please use the 'autoRecover' property instead. * Indicates whether the file is marked for auto-recovery. */ getAutoRecover() : boolean; /** * Indicates whether the file is marked for auto-recovery. */ autoRecover : boolean; /** * @deprecated Please use the 'autoRecover' property instead. * Indicates whether the file is marked for auto-recovery. * @param value - The value to set. */ setAutoRecover(value: boolean) : void; /** * @deprecated Please use the 'crashSave' property instead. * indicates whether the application last saved the workbook file after a crash. */ getCrashSave() : boolean; /** * indicates whether the application last saved the workbook file after a crash. */ crashSave : boolean; /** * @deprecated Please use the 'crashSave' property instead. * indicates whether the application last saved the workbook file after a crash. * @param value - The value to set. */ setCrashSave(value: boolean) : void; /** * @deprecated Please use the 'dataExtractLoad' property instead. * indicates whether the application last opened the workbook for data recovery. */ getDataExtractLoad() : boolean; /** * indicates whether the application last opened the workbook for data recovery. */ dataExtractLoad : boolean; /** * @deprecated Please use the 'dataExtractLoad' property instead. * indicates whether the application last opened the workbook for data recovery. * @param value - The value to set. */ setDataExtractLoad(value: boolean) : void; /** * @deprecated Please use the 'repairLoad' property instead. * Indicates whether the application last opened the workbook in safe or repair mode. */ getRepairLoad() : boolean; /** * Indicates whether the application last opened the workbook in safe or repair mode. */ repairLoad : boolean; /** * @deprecated Please use the 'repairLoad' property instead. * Indicates whether the application last opened the workbook in safe or repair mode. * @param value - The value to set. */ setRepairLoad(value: boolean) : void; /** * @deprecated Please use the 'buildVersion' property instead. * Specifies the incremental public release of the application. */ getBuildVersion() : string; /** * Specifies the incremental public release of the application. */ buildVersion : string; /** * @deprecated Please use the 'buildVersion' property instead. * Specifies the incremental public release of the application. * @param value - The value to set. */ setBuildVersion(value: string) : void; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets. * * @remarks * For more details about memory mode, please see . */ getMemorySetting() : MemorySetting; /** * Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets. * * @remarks * For more details about memory mode, please see . */ memorySetting : MemorySetting; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory usage options. The new option will be taken as the default option for newly created worksheets but does not take effect for existing worksheets. * @param value - The value to set. * * @remarks * For more details about memory mode, please see . */ setMemorySetting(value: MemorySetting) : void; /** * @deprecated Please use the 'paperSize' property instead. * Gets and sets the default print paper size. * * @remarks * If there is no setting about paper size,MS Excel will use default printer's setting. */ getPaperSize() : PaperSizeType; /** * Gets and sets the default print paper size. * * @remarks * If there is no setting about paper size,MS Excel will use default printer's setting. */ paperSize : PaperSizeType; /** * @deprecated Please use the 'paperSize' property instead. * Gets and sets the default print paper size. * @param value - The value to set. * * @remarks * If there is no setting about paper size,MS Excel will use default printer's setting. */ setPaperSize(value: PaperSizeType) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. * @param value - The value to set. */ setWarningCallback(value: IWarningCallback) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. */ getWarningCallback() : IWarningCallback; /** * Gets or sets warning callback. */ warningCallback : IWarningCallback; /** * @deprecated Please use the 'maxRowsOfSharedFormula' property instead. * Gets and sets the max row number of shared formula. * * @remarks * If the number is too large, the autofilter works very slow in MS Excel 2013. */ getMaxRowsOfSharedFormula() : number; /** * Gets and sets the max row number of shared formula. * * @remarks * If the number is too large, the autofilter works very slow in MS Excel 2013. */ maxRowsOfSharedFormula : number; /** * @deprecated Please use the 'maxRowsOfSharedFormula' property instead. * Gets and sets the max row number of shared formula. * @param value - The value to set. * * @remarks * If the number is too large, the autofilter works very slow in MS Excel 2013. */ setMaxRowsOfSharedFormula(value: number) : void; /** * @deprecated Please use the 'compliance' property instead. * Specifies the OOXML version for the output document. The default value is Ecma376_2006. * * @remarks * Only for .xlsx files. */ getCompliance() : OoxmlCompliance; /** * Specifies the OOXML version for the output document. The default value is Ecma376_2006. * * @remarks * Only for .xlsx files. */ compliance : OoxmlCompliance; /** * @deprecated Please use the 'compliance' property instead. * Specifies the OOXML version for the output document. The default value is Ecma376_2006. * @param value - The value to set. * * @remarks * Only for .xlsx files. */ setCompliance(value: OoxmlCompliance) : void; /** * @deprecated Please use the 'quotePrefixToStyle' property instead. * Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell */ getQuotePrefixToStyle() : boolean; /** * Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell */ quotePrefixToStyle : boolean; /** * @deprecated Please use the 'quotePrefixToStyle' property instead. * Indicates whether setting property when entering the string value(which starts with single quote mark ) to the cell * @param value - The value to set. */ setQuotePrefixToStyle(value: boolean) : void; /** * @deprecated Please use the 'formulaSettings' property instead. * Gets the settings for formula-related features. */ getFormulaSettings() : FormulaSettings; /** * Gets the settings for formula-related features. */ readonly formulaSettings : FormulaSettings; /** * @deprecated Please use the 'propertiesFollowChartPoint' property instead. * Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference. */ getPropertiesFollowChartPoint() : boolean; /** * Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference. */ propertiesFollowChartPoint : boolean; /** * @deprecated Please use the 'propertiesFollowChartPoint' property instead. * Indicates whether datapoint properties and datalabels in all charts in this workbook follow their reference. * @param value - The value to set. */ setPropertiesFollowChartPoint(value: boolean) : void; /** * @deprecated Please use the 'discardImageEditData' property instead. * Indicates whether discarding editting image data. */ getDiscardImageEditData() : boolean; /** * Indicates whether discarding editting image data. */ discardImageEditData : boolean; /** * @deprecated Please use the 'discardImageEditData' property instead. * Indicates whether discarding editting image data. * @param value - The value to set. */ setDiscardImageEditData(value: boolean) : void; /** * @deprecated Please use the 'defaultImageResolution' property instead. * Gets and sets default resolution of image. */ getDefaultImageResolution() : number; /** * Gets and sets default resolution of image. */ defaultImageResolution : number; /** * @deprecated Please use the 'defaultImageResolution' property instead. * Gets and sets default resolution of image. * @param value - The value to set. */ setDefaultImageResolution(value: number) : void; /** * @deprecated Please use the 'wpsCompatibility' property instead. * Indicates whether to be compatible with WPS. */ getWpsCompatibility() : boolean; /** * Indicates whether to be compatible with WPS. */ wpsCompatibility : boolean; /** * @deprecated Please use the 'wpsCompatibility' property instead. * Indicates whether to be compatible with WPS. * @param value - The value to set. */ setWpsCompatibility(value: boolean) : void; /** * Releases resources. */ dispose() : void; /** * Gets the default theme font name. * @param type - The scheme type of the font. */ getThemeFont(type: FontSchemeType) : string; /** * Set the type of print orientation for the whole workbook. * @param pageOrientationType - The page orientation type */ setPageOrientationType(pageOrientationType: PageOrientationType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a collection of objects. */ export class WorksheetCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : Worksheet; /** * Gets the element with the specified name. * @param sheetName - Worksheet name * @returns * The element with the specified name. */ get(sheetName: string) : Worksheet; /** * @deprecated Please use the 'webExtensionTaskPanes' property instead. * Gets the list of task panes. */ getWebExtensionTaskPanes() : WebExtensionTaskPaneCollection; /** * Gets the list of task panes. */ readonly webExtensionTaskPanes : WebExtensionTaskPaneCollection; /** * @deprecated Please use the 'webExtensions' property instead. * Gets the list of task panes. */ getWebExtensions() : WebExtensionCollection; /** * Gets the list of task panes. */ readonly webExtensions : WebExtensionCollection; /** * @deprecated Please use the 'threadedCommentAuthors' property instead. * Gets the list of threaded comment authors. */ getThreadedCommentAuthors() : ThreadedCommentAuthorCollection; /** * Gets the list of threaded comment authors. */ readonly threadedCommentAuthors : ThreadedCommentAuthorCollection; /** * Indicates whether refresh all connections on opening file in MS Excel. */ isRefreshAllConnections : boolean; /** * @deprecated Please use the 'isRefreshAllConnections' property instead. * Indicates whether refresh all connections on opening file in MS Excel. * @param value - The value to set. */ setIsRefreshAllConnections(value: boolean) : void; /** * @deprecated Please use the 'names' property instead. * Gets the collection of all the Name objects in the spreadsheet. */ getNames() : NameCollection; /** * Gets the collection of all the Name objects in the spreadsheet. */ readonly names : NameCollection; /** * @deprecated Please use the 'activeSheetName' property instead. * Represents the name of active worksheet when the spreadsheet is opened. */ getActiveSheetName() : string; /** * Represents the name of active worksheet when the spreadsheet is opened. */ activeSheetName : string; /** * @deprecated Please use the 'activeSheetName' property instead. * Represents the name of active worksheet when the spreadsheet is opened. * @param value - The value to set. */ setActiveSheetName(value: string) : void; /** * @deprecated Please use the 'activeSheetIndex' property instead. * Represents the index of active worksheet when the spreadsheet is opened. * * @remarks * Sheet index is zero based. */ getActiveSheetIndex() : number; /** * Represents the index of active worksheet when the spreadsheet is opened. * * @remarks * Sheet index is zero based. */ activeSheetIndex : number; /** * @deprecated Please use the 'activeSheetIndex' property instead. * Represents the index of active worksheet when the spreadsheet is opened. * @param value - The value to set. * * @remarks * Sheet index is zero based. */ setActiveSheetIndex(value: number) : void; /** * @deprecated Please use the 'dxfs' property instead. * Gets the master differential formatting records. */ getDxfs() : DxfCollection; /** * Gets the master differential formatting records. */ readonly dxfs : DxfCollection; /** * @deprecated Please use the 'xmlMaps' property instead. * Gets and sets the XML maps in the workbook. */ getXmlMaps() : XmlMapCollection; /** * Gets and sets the XML maps in the workbook. */ xmlMaps : XmlMapCollection; /** * @deprecated Please use the 'xmlMaps' property instead. * Gets and sets the XML maps in the workbook. * @param value - The value to set. */ setXmlMaps(value: XmlMapCollection) : void; /** * @deprecated Please use the 'builtInDocumentProperties' property instead. * Returns a collection that represents all the built-in document properties of the spreadsheet. * * @remarks * A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. * The following is the built-in properties name list: *

Title

*

Subject

*

Author

*

Keywords

*

Comments

*

Template

*

Last Author

*

Revision Number

*

Application Name

*

Last Print Date

*

Creation Date

*

Last Save Time

*

Total Editing Time

*

Number of Pages

*

Number of Words

*

Number of Characters

*

Security

*

Category

*

Format

*

Manager

*

Company

*

Number of Bytes

*

Number of Lines

*

Number of Paragraphs

*

Number of Slides

*

Number of Notes

*

Number of Hidden Slides

*

Number of Multimedia Clips

*/ getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection; /** * Returns a collection that represents all the built-in document properties of the spreadsheet. * * @remarks * A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. * The following is the built-in properties name list: *

Title

*

Subject

*

Author

*

Keywords

*

Comments

*

Template

*

Last Author

*

Revision Number

*

Application Name

*

Last Print Date

*

Creation Date

*

Last Save Time

*

Total Editing Time

*

Number of Pages

*

Number of Words

*

Number of Characters

*

Security

*

Category

*

Format

*

Manager

*

Company

*

Number of Bytes

*

Number of Lines

*

Number of Paragraphs

*

Number of Slides

*

Number of Notes

*

Number of Hidden Slides

*

Number of Multimedia Clips

*/ readonly builtInDocumentProperties : BuiltInDocumentPropertyCollection; /** * @deprecated Please use the 'customDocumentProperties' property instead. * Returns a collection that represents all the custom document properties of the spreadsheet. */ getCustomDocumentProperties() : CustomDocumentPropertyCollection; /** * Returns a collection that represents all the custom document properties of the spreadsheet. */ readonly customDocumentProperties : CustomDocumentPropertyCollection; /** * @deprecated Please use the 'oleSize' property instead. * Gets and Sets displayed size when Workbook file is used as an Ole object. * * @remarks * Null means no ole size setting. */ getOleSize() : Object; /** * Gets and Sets displayed size when Workbook file is used as an Ole object. * * @remarks * Null means no ole size setting. */ oleSize : Object; /** * @deprecated Please use the 'oleSize' property instead. * Gets and Sets displayed size when Workbook file is used as an Ole object. * @param value - The value to set. * * @remarks * Null means no ole size setting. */ setOleSize(value: Object) : void; /** * @deprecated Please use the 'externalLinks' property instead. * Represents external links in a workbook. */ getExternalLinks() : ExternalLinkCollection; /** * Represents external links in a workbook. */ readonly externalLinks : ExternalLinkCollection; /** * @deprecated Please use the 'pivotCaches' property instead. * Gets all . */ getPivotCaches() : PivotCacheCollection; /** * Gets all . */ readonly pivotCaches : PivotCacheCollection; /** * @deprecated Please use the 'tableStyles' property instead. * Gets object. */ getTableStyles() : TableStyleCollection; /** * Gets object. */ readonly tableStyles : TableStyleCollection; /** * @deprecated Please use the 'revisionLogs' property instead. * Represents revision logs. */ getRevisionLogs() : RevisionLogCollection; /** * Represents revision logs. */ readonly revisionLogs : RevisionLogCollection; /** * @deprecated Please use the 'sensitivityLabels' property instead. * Represents all sensitivity labels. */ getSensitivityLabels() : SensitivityLabelCollection; /** * Represents all sensitivity labels. */ readonly sensitivityLabels : SensitivityLabelCollection; /** * Creates a object from an address of the range. * @param address - The address of the range. * @param sheetIndex - The sheet index. * @returns * A object */ createRange(address: string, sheetIndex: number) : Range; /** * Creates a object from an address of the range. * @param address - The address of the range. * @param sheetIndex - The sheet index. * @returns * A object */ createUnionRange(address: string, sheetIndex: number) : UnionRange; /** * Gets the worksheet by the code name. * @param codeName - Worksheet code name. * @returns * The element with the specified code name. */ getSheetByCodeName(codeName: string) : Worksheet; /** * Sorts the defined names. * * @remarks * If you create a large amount of named ranges in the Excel file, * please call this method after all named ranges are created and before saving */ sortNames() : void; /** * Insert a worksheet. * @param index - The sheet index * @param sheetType - The sheet type. * @returns * Returns an inserted worksheet. */ insert(index: number, sheetType: SheetType) : Worksheet; /** * Insert a worksheet. * @param index - The sheet index * @param sheetType - The sheet type. * @param sheetName - The sheet name. * @returns * Returns an inserted worksheet. */ insert(index: number, sheetType: SheetType, sheetName: string) : Worksheet; /** * Adds a worksheet to the collection. * @param type - Worksheet type. * @returns * object index. */ add(type: SheetType) : number; /** * Adds a worksheet to the collection. * @returns * object index. */ add() : number; /** * Adds a worksheet to the collection. * @param sheetName - Worksheet name * @returns * object. */ add(sheetName: string) : Worksheet; /** * Swaps the two sheets. * @param sheetIndex1 - The first worksheet. * @param sheetIndex2 - The second worksheet. */ swapSheet(sheetIndex1: number, sheetIndex2: number) : void; /** * Adds addin function into the workbook * @param addInFile - the file contains the addin functions * @param functionName - the addin function name * @param lib - whether the given addin file is in the directory or sub-directory of Workbook Add-In library. /// This flag takes effect and makes difference when given addInFile is of relative path: /// true denotes the path is relative to Add-In library and false denotes the path is relative to this Workbook. * @returns * ID of the data which contains given addin function */ registerAddInFunction(addInFile: string, functionName: string, lib: boolean) : number; /** * Adds addin function into the workbook * @param id - ID of the data which contains addin functions, /// can be got by the first call of for the same addin file. * @param functionName - the addin function name * @returns * URL of the addin file which contains addin functions */ registerAddInFunction(id: number, functionName: string) : string; /** * Removes the element at a specified name. * @param name - The name of the element to remove. */ removeAt(name: string) : void; /** * Removes the element at a specified index. * @param index - The index value of the element to remove. */ removeAt(index: number) : void; /** * Clear all worksheets. * * @remarks * A workbook must contains a worksheet. */ clear() : void; /** * Adds a worksheet to the collection and copies data from an existed worksheet. * @param sheetName - Name of source worksheet. * @returns * object index. */ addCopy(sheetName: string) : number; /** * Adds a worksheet to the collection and copies data from an existed worksheet. * @param sheetIndex - Index of source worksheet. * @returns * object index. */ addCopy(sheetIndex: number) : number; /** * Copy a group of worksheets. * @param source - The source worksheets. * @param destSheetNames - The names of the copied sheets. */ addCopy(source: Worksheet[], destSheetNames: string[]) : void; /** * Gets Range object by pre-defined name. * @param rangeName - Name of range. * @returns * Range object.

Returns null if the named range does not exist. */ getRangeByName(rangeName: string) : Range; /** * Gets by pre-defined name or table's name * @param rangeName - Name of range or table's name. * @param currentSheetIndex - The sheet index. -1 represents global . * @param includeTable - Indicates whether checking all tables. */ getRangeByName(rangeName: string, currentSheetIndex: number, includeTable: boolean) : Range; /** * Gets all pre-defined named ranges in the spreadsheet. * @returns * An array of Range objects. * If the defined Name's reference is external or has multiple ranges, no Range object will be returned for this Name. *

Returns null if the named range does not exist. */ getNamedRanges() : Range[]; /** * Gets all pre-defined named ranges in the spreadsheet. * @returns * An array of Range objects.

Returns null if the named range does not exist. */ getNamedRangesAndTables() : Range[]; /** * Sets displayed size when Workbook file is used as an Ole object. * @param startRow - Start row index. * @param endRow - End row index. * @param startColumn - Start column index. * @param endColumn - End column index. * * @remarks * This method is generally used to adjust display size in ppt file or doc file. */ setOleSize(startRow: number, endRow: number, startColumn: number, endColumn: number) : void; /** * Clears pivot tables from the spreadsheet. */ clearPivottables() : void; /** * Refresh all pivot tables and charts with pivot source. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Workbook.RefreshAll() method. * This method will be removed 12 months later since April 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Workbook.RefreshAll() method instead. */ refreshAll() : void; /** * Refresh all pivot tables and charts with pivot source. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Workbook.RefreshAll() method. * This method will be removed 12 months later since April 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Workbook.RefreshAll() method instead. */ refreshAllAsync() : Promise; /** * Refreshes all the PivotTables in the Excel file. */ refreshPivotTables() : void; /** * Refreshes all the PivotTables in the Excel file. * @param option - The option for refreshing data source of the pivot tables. */ refreshPivotTables(option: PivotTableRefreshOption) : boolean; /** * Refreshes all the PivotTables in the Excel file. */ refreshPivotTablesAsync() : Promise; /** * Refreshes all the PivotTables in the Excel file. * @param option - The option for refreshing data source of the pivot tables. */ refreshPivotTablesAsync(option: PivotTableRefreshOption) : Promise; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Encapsulates the object that represents a single worksheet. */ export class Worksheet { /** * @deprecated Please use the 'protection' property instead. * Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version. * * @remarks * This property can protect worksheet in all versions of Excel file and support advanced protection options in ExcelXP and above version. */ getProtection() : Protection; /** * Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version. * * @remarks * This property can protect worksheet in all versions of Excel file and support advanced protection options in ExcelXP and above version. */ readonly protection : Protection; /** * @deprecated Please use the 'uniqueId' property instead. * Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. */ getUniqueId() : string; /** * Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. */ uniqueId : string; /** * @deprecated Please use the 'uniqueId' property instead. * Gets and sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. * @param value - The value to set. */ setUniqueId(value: string) : void; /** * @deprecated Please use the 'workbook' property instead. * Gets the workbook object which contains this sheet. */ getWorkbook() : Workbook; /** * Gets the workbook object which contains this sheet. */ readonly workbook : Workbook; /** * @deprecated Please use the 'cells' property instead. * Gets the collection. */ getCells() : Cells; /** * Gets the collection. */ readonly cells : Cells; /** * @deprecated Please use the 'queryTables' property instead. * Gets in the worksheet. */ getQueryTables() : QueryTableCollection; /** * Gets in the worksheet. */ readonly queryTables : QueryTableCollection; /** * @deprecated Please use the 'type' property instead. * Represents worksheet type. */ getType() : SheetType; /** * Represents worksheet type. */ type : SheetType; /** * @deprecated Please use the 'type' property instead. * Represents worksheet type. * @param value - The value to set. */ setType(value: SheetType) : void; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the worksheet. * * @remarks * The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. * For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet. */ getName() : string; /** * Gets or sets the name of the worksheet. * * @remarks * The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. * For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets or sets the name of the worksheet. * @param value - The value to set. * * @remarks * The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. * For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet. */ setName(value: string) : void; /** * @deprecated Please use the 'showFormulas' property instead. * Indicates whether to show formulas or their results. */ getShowFormulas() : boolean; /** * Indicates whether to show formulas or their results. */ showFormulas : boolean; /** * @deprecated Please use the 'showFormulas' property instead. * Indicates whether to show formulas or their results. * @param value - The value to set. */ setShowFormulas(value: boolean) : void; /** * @deprecated Please use the 'showDataTypeIcons' property instead. * Indicates whether to show data type icons. */ getShowDataTypeIcons() : boolean; /** * Indicates whether to show data type icons. */ showDataTypeIcons : boolean; /** * @deprecated Please use the 'showDataTypeIcons' property instead. * Indicates whether to show data type icons. * @param value - The value to set. */ setShowDataTypeIcons(value: boolean) : void; /** * Gets or sets a value indicating whether the gridlines are visible.Default is true. */ isGridlinesVisible : boolean; /** * @deprecated Please use the 'isGridlinesVisible' property instead. * Gets or sets a value indicating whether the gridlines are visible.Default is true. * @param value - The value to set. */ setIsGridlinesVisible(value: boolean) : void; /** * Gets or sets a value indicating whether the worksheet will display row and column headers. * Default is true. */ isRowColumnHeadersVisible : boolean; /** * @deprecated Please use the 'isRowColumnHeadersVisible' property instead. * Gets or sets a value indicating whether the worksheet will display row and column headers. * Default is true. * @param value - The value to set. */ setIsRowColumnHeadersVisible(value: boolean) : void; /** * @deprecated Please use the 'paneState' property instead. * Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. */ getPaneState() : PaneStateType; /** * Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. */ readonly paneState : PaneStateType; /** * @deprecated Please use the 'displayZeros' property instead. * True if zero values are displayed. */ getDisplayZeros() : boolean; /** * True if zero values are displayed. */ displayZeros : boolean; /** * @deprecated Please use the 'displayZeros' property instead. * True if zero values are displayed. * @param value - The value to set. */ setDisplayZeros(value: boolean) : void; /** * @deprecated Please use the 'displayRightToLeft' property instead. * Indicates if the specified worksheet is displayed from right to left instead of from left to right. * Default is false. */ getDisplayRightToLeft() : boolean; /** * Indicates if the specified worksheet is displayed from right to left instead of from left to right. * Default is false. */ displayRightToLeft : boolean; /** * @deprecated Please use the 'displayRightToLeft' property instead. * Indicates if the specified worksheet is displayed from right to left instead of from left to right. * Default is false. * @param value - The value to set. */ setDisplayRightToLeft(value: boolean) : void; /** * Indicates whether to show outline. */ isOutlineShown : boolean; /** * @deprecated Please use the 'isOutlineShown' property instead. * Indicates whether to show outline. * @param value - The value to set. */ setIsOutlineShown(value: boolean) : void; /** * Indicates whether this worksheet is selected when the workbook is opened. */ isSelected : boolean; /** * @deprecated Please use the 'isSelected' property instead. * Indicates whether this worksheet is selected when the workbook is opened. * @param value - The value to set. */ setIsSelected(value: boolean) : void; /** * @deprecated Please use the 'pivotTables' property instead. * Gets all pivot tables in this worksheet. */ getPivotTables() : PivotTableCollection; /** * Gets all pivot tables in this worksheet. */ readonly pivotTables : PivotTableCollection; /** * @deprecated Please use the 'listObjects' property instead. * Gets all ListObjects in this worksheet. */ getListObjects() : ListObjectCollection; /** * Gets all ListObjects in this worksheet. */ readonly listObjects : ListObjectCollection; /** * @deprecated Please use the 'tabId' property instead. * Specifies the internal identifier for the sheet. */ getTabId() : number; /** * Specifies the internal identifier for the sheet. */ tabId : number; /** * @deprecated Please use the 'tabId' property instead. * Specifies the internal identifier for the sheet. * @param value - The value to set. */ setTabId(value: number) : void; /** * @deprecated Please use the 'horizontalPageBreaks' property instead. * Gets the collection. */ getHorizontalPageBreaks() : HorizontalPageBreakCollection; /** * Gets the collection. */ readonly horizontalPageBreaks : HorizontalPageBreakCollection; /** * @deprecated Please use the 'verticalPageBreaks' property instead. * Gets the collection. */ getVerticalPageBreaks() : VerticalPageBreakCollection; /** * Gets the collection. */ readonly verticalPageBreaks : VerticalPageBreakCollection; /** * @deprecated Please use the 'hyperlinks' property instead. * Gets the collection. */ getHyperlinks() : HyperlinkCollection; /** * Gets the collection. */ readonly hyperlinks : HyperlinkCollection; /** * @deprecated Please use the 'pageSetup' property instead. * Represents the page setup description in this sheet. */ getPageSetup() : PageSetup; /** * Represents the page setup description in this sheet. */ readonly pageSetup : PageSetup; /** * @deprecated Please use the 'autoFilter' property instead. * Represents auto filter for the specified worksheet. */ getAutoFilter() : AutoFilter; /** * Represents auto filter for the specified worksheet. */ readonly autoFilter : AutoFilter; /** * @deprecated Please use the 'hasAutofilter' property instead. * Indicates whether this worksheet has auto filter. */ getHasAutofilter() : boolean; /** * Indicates whether this worksheet has auto filter. */ readonly hasAutofilter : boolean; /** * @deprecated Please use the 'transitionEvaluation' property instead. * Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. */ getTransitionEvaluation() : boolean; /** * Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. */ transitionEvaluation : boolean; /** * @deprecated Please use the 'transitionEvaluation' property instead. * Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. * @param value - The value to set. */ setTransitionEvaluation(value: boolean) : void; /** * @deprecated Please use the 'transitionEntry' property instead. * Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. */ getTransitionEntry() : boolean; /** * Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. */ transitionEntry : boolean; /** * @deprecated Please use the 'transitionEntry' property instead. * Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. * @param value - The value to set. */ setTransitionEntry(value: boolean) : void; /** * @deprecated Please use the 'visibilityType' property instead. * Indicates the visible state for this sheet. */ getVisibilityType() : VisibilityType; /** * Indicates the visible state for this sheet. */ visibilityType : VisibilityType; /** * @deprecated Please use the 'visibilityType' property instead. * Indicates the visible state for this sheet. * @param value - The value to set. */ setVisibilityType(value: VisibilityType) : void; /** * Represents if the worksheet is visible. */ isVisible : boolean; /** * @deprecated Please use the 'isVisible' property instead. * Represents if the worksheet is visible. * @param value - The value to set. */ setIsVisible(value: boolean) : void; /** * @deprecated Please use the 'sparklineGroups' property instead. * Gets the sparkline groups in the worksheet. */ getSparklineGroups() : SparklineGroupCollection; /** * Gets the sparkline groups in the worksheet. */ readonly sparklineGroups : SparklineGroupCollection; /** * @deprecated Please use the 'charts' property instead. * Gets a collection */ getCharts() : ChartCollection; /** * Gets a collection */ readonly charts : ChartCollection; /** * @deprecated Please use the 'comments' property instead. * Gets the collection. */ getComments() : CommentCollection; /** * Gets the collection. */ readonly comments : CommentCollection; /** * @deprecated Please use the 'pictures' property instead. * Gets a collection. */ getPictures() : PictureCollection; /** * Gets a collection. */ readonly pictures : PictureCollection; /** * @deprecated Please use the 'textBoxes' property instead. * Gets a collection. */ getTextBoxes() : TextBoxCollection; /** * Gets a collection. */ readonly textBoxes : TextBoxCollection; /** * @deprecated Please use the 'checkBoxes' property instead. * Gets a collection. */ getCheckBoxes() : CheckBoxCollection; /** * Gets a collection. */ readonly checkBoxes : CheckBoxCollection; /** * @deprecated Please use the 'oleObjects' property instead. * Represents a collection of in a worksheet. */ getOleObjects() : OleObjectCollection; /** * Represents a collection of in a worksheet. */ readonly oleObjects : OleObjectCollection; /** * @deprecated Please use the 'shapes' property instead. * Returns all drawing shapes in this worksheet. */ getShapes() : ShapeCollection; /** * Returns all drawing shapes in this worksheet. */ readonly shapes : ShapeCollection; /** * @deprecated Please use the 'slicers' property instead. * Get the Slicer collection in the worksheet */ getSlicers() : SlicerCollection; /** * Get the Slicer collection in the worksheet */ readonly slicers : SlicerCollection; /** * @deprecated Please use the 'timelines' property instead. * Get the Timeline collection in the worksheet */ getTimelines() : TimelineCollection; /** * Get the Timeline collection in the worksheet */ readonly timelines : TimelineCollection; /** * @deprecated Please use the 'index' property instead. * Gets the index of sheet in the worksheet collection. */ getIndex() : number; /** * Gets the index of sheet in the worksheet collection. */ readonly index : number; /** * Indicates if the worksheet is protected. */ readonly isProtected : boolean; /** * @deprecated Please use the 'validations' property instead. * Gets the data validation setting collection in the worksheet. */ getValidations() : ValidationCollection; /** * Gets the data validation setting collection in the worksheet. */ readonly validations : ValidationCollection; /** * @deprecated Please use the 'allowEditRanges' property instead. * Gets the allow edit range collection in the worksheet. */ getAllowEditRanges() : ProtectedRangeCollection; /** * Gets the allow edit range collection in the worksheet. */ readonly allowEditRanges : ProtectedRangeCollection; /** * @deprecated Please use the 'errorCheckOptions' property instead. * Gets error check setting applied on certain ranges. */ getErrorCheckOptions() : ErrorCheckOptionCollection; /** * Gets error check setting applied on certain ranges. */ readonly errorCheckOptions : ErrorCheckOptionCollection; /** * @deprecated Please use the 'outline' property instead. * Gets the outline on this worksheet. */ getOutline() : Outline; /** * Gets the outline on this worksheet. */ readonly outline : Outline; /** * @deprecated Please use the 'firstVisibleRow' property instead. * Represents first visible row index. */ getFirstVisibleRow() : number; /** * Represents first visible row index. */ firstVisibleRow : number; /** * @deprecated Please use the 'firstVisibleRow' property instead. * Represents first visible row index. * @param value - The value to set. */ setFirstVisibleRow(value: number) : void; /** * @deprecated Please use the 'firstVisibleColumn' property instead. * Represents first visible column index. */ getFirstVisibleColumn() : number; /** * Represents first visible column index. */ firstVisibleColumn : number; /** * @deprecated Please use the 'firstVisibleColumn' property instead. * Represents first visible column index. * @param value - The value to set. */ setFirstVisibleColumn(value: number) : void; /** * @deprecated Please use the 'zoom' property instead. * Represents the scaling factor in percentage. It should be between 10 and 400. * * @remarks * Please set the view type first. */ getZoom() : number; /** * Represents the scaling factor in percentage. It should be between 10 and 400. * * @remarks * Please set the view type first. */ zoom : number; /** * @deprecated Please use the 'zoom' property instead. * Represents the scaling factor in percentage. It should be between 10 and 400. * @param value - The value to set. * * @remarks * Please set the view type first. */ setZoom(value: number) : void; /** * @deprecated Please use the 'viewType' property instead. * Gets and sets the view type. */ getViewType() : ViewType; /** * Gets and sets the view type. */ viewType : ViewType; /** * @deprecated Please use the 'viewType' property instead. * Gets and sets the view type. * @param value - The value to set. */ setViewType(value: ViewType) : void; /** * Indicates whether the specified worksheet is shown in normal view or page break preview. */ isPageBreakPreview : boolean; /** * @deprecated Please use the 'isPageBreakPreview' property instead. * Indicates whether the specified worksheet is shown in normal view or page break preview. * @param value - The value to set. */ setIsPageBreakPreview(value: boolean) : void; /** * Indicates whether the ruler is visible. This property is only applied for page break preview. */ isRulerVisible : boolean; /** * @deprecated Please use the 'isRulerVisible' property instead. * Indicates whether the ruler is visible. This property is only applied for page break preview. * @param value - The value to set. */ setIsRulerVisible(value: boolean) : void; /** * @deprecated Please use the 'tabColor' property instead. * Represents worksheet tab color. * * @remarks * This feature is only supported in ExcelXP(Excel2002) and later versions. * If you save file as Excel97 or Excel2000 format, it will be omitted. */ getTabColor() : Color; /** * Represents worksheet tab color. * * @remarks * This feature is only supported in ExcelXP(Excel2002) and later versions. * If you save file as Excel97 or Excel2000 format, it will be omitted. */ tabColor : Color; /** * @deprecated Please use the 'tabColor' property instead. * Represents worksheet tab color. * @param value - The value to set. * * @remarks * This feature is only supported in ExcelXP(Excel2002) and later versions. * If you save file as Excel97 or Excel2000 format, it will be omitted. */ setTabColor(value: Color) : void; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets and sets the color of gridline */ getGridlineColor() : Color; /** * Gets and sets the color of gridline */ gridlineColor : Color; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets and sets the color of gridline * @param value - The value to set. */ setGridlineColor(value: Color) : void; /** * @deprecated Please use the 'codeName' property instead. * Gets worksheet code name. */ getCodeName() : string; /** * Gets worksheet code name. */ codeName : string; /** * @deprecated Please use the 'codeName' property instead. * Gets worksheet code name. * @param value - The value to set. */ setCodeName(value: string) : void; /** * @deprecated Please use the 'backgroundImage' property instead. * Gets and sets worksheet background image. */ getBackgroundImage() : Uint8Array; /** * Gets and sets worksheet background image. */ backgroundImage : Uint8Array; /** * @deprecated Please use the 'backgroundImage' property instead. * Gets and sets worksheet background image. * @param value - The value to set. */ setBackgroundImage(value: Uint8Array) : void; /** * @deprecated Please use the 'conditionalFormattings' property instead. * Gets the ConditionalFormattings in the worksheet. */ getConditionalFormattings() : ConditionalFormattingCollection; /** * Gets the ConditionalFormattings in the worksheet. */ readonly conditionalFormattings : ConditionalFormattingCollection; /** * @deprecated Please use the 'activeCell' property instead. * Gets or sets the active cell in the worksheet. */ getActiveCell() : string; /** * Gets or sets the active cell in the worksheet. */ activeCell : string; /** * @deprecated Please use the 'activeCell' property instead. * Gets or sets the active cell in the worksheet. * @param value - The value to set. */ setActiveCell(value: string) : void; /** * @deprecated Please use the 'customProperties' property instead. * Gets an object representing * the identifier information associated with a worksheet. * * @remarks * Worksheet.CustomProperties provide a preferred mechanism for storing arbitrary data. * It supports legacy third-party document components, as well as those situations that have a stringent need for binary parts. */ getCustomProperties() : CustomPropertyCollection; /** * Gets an object representing * the identifier information associated with a worksheet. * * @remarks * Worksheet.CustomProperties provide a preferred mechanism for storing arbitrary data. * It supports legacy third-party document components, as well as those situations that have a stringent need for binary parts. */ readonly customProperties : CustomPropertyCollection; /** * @deprecated Please use the 'smartTagSetting' property instead. * Gets all objects of the worksheet. */ getSmartTagSetting() : SmartTagSetting; /** * Gets all objects of the worksheet. */ readonly smartTagSetting : SmartTagSetting; /** * @deprecated Please use the 'scenarios' property instead. * Gets the collection of . */ getScenarios() : ScenarioCollection; /** * Gets the collection of . */ readonly scenarios : ScenarioCollection; /** * @deprecated Please use the 'cellWatches' property instead. * Gets collection of cells on this worksheet being watched in the 'watch window'. */ getCellWatches() : CellWatchCollection; /** * Gets collection of cells on this worksheet being watched in the 'watch window'. */ readonly cellWatches : CellWatchCollection; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Gets the window panes. * * @remarks * If the window is not split or frozen. */ getPanes() : PaneCollection; /** * Freezes panes at the specified cell in the worksheet. * @param row - Row index. * @param column - Column index. * @param freezedRows - Number of visible rows in top pane, no more than row index. * @param freezedColumns - Number of visible columns in left pane, no more than column index. * * @remarks *

Row index and column index cannot all be zero. Number of rows and number of columns * also cannot all be zero.

*

The first two parameters specify the froze position and the last two parameters specify the area frozen on the left top pane.

*/ freezePanes(row: number, column: number, freezedRows: number, freezedColumns: number) : void; /** * Freezes panes at the specified cell in the worksheet. * @param cellName - Cell name. * @param freezedRows - Number of visible rows in top pane, no more than row index. * @param freezedColumns - Number of visible columns in left pane, no more than column index. * * @remarks * Row index and column index cannot all be zero. Number of rows and number of columns * also cannot all be zero. */ freezePanes(cellName: string, freezedRows: number, freezedColumns: number) : void; /** * Gets the freeze panes. * @returns * Return null means the worksheet is not frozen * 0:Row index;1:column;2:freezedRows;3:freezedRows */ getFreezedPanes() : number[]; /** * Splits window. */ split() : void; /** * Unfreezes panes in the worksheet. */ unFreezePanes() : void; /** * Removes split window. */ removeSplit() : void; /** * Adds page break. * @param cellName - */ addPageBreaks(cellName: string) : void; /** * Copies contents and formats from another worksheet. * @param sourceSheet - Source worksheet. */ copy(sourceSheet: Worksheet) : void; /** * Copies contents and formats from another worksheet. * @param sourceSheet - Source worksheet. * @param copyOptions - * * @remarks * You can copy data from another worksheet in the same file or another file. However, this method does not support to copy drawing objects, such as comments, images and charts. */ copy(sourceSheet: Worksheet, copyOptions: CopyOptions) : void; /** * Autofits the column width. * @param columnIndex - Column index. * @param firstRow - First row index. * @param lastRow - Last row index. * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitColumn(columnIndex: number, firstRow: number, lastRow: number) : void; /** * Autofits the column width. * @param columnIndex - Column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumn(columnIndex: number) : void; /** * Autofits the column width. * @param columnIndex - Column index. * @param firstRow - First row index. * @param lastRow - Last row index. * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitColumnAsync(columnIndex: number, firstRow: number, lastRow: number) : Promise; /** * Autofits the column width. * @param columnIndex - Column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumnAsync(columnIndex: number) : Promise; /** * Autofits all columns in this worksheet. */ autoFitColumns() : void; /** * Autofits all columns in this worksheet. * @param options - The auto fitting options */ autoFitColumns(options: AutoFitterOptions) : void; /** * Autofits the columns width. * @param firstColumn - First column index. * @param lastColumn - Last column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumns(firstColumn: number, lastColumn: number) : void; /** * Autofits the columns width. * @param firstColumn - First column index. * @param lastColumn - Last column index. * @param options - The auto fitting options * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumns(firstColumn: number, lastColumn: number, options: AutoFitterOptions) : void; /** * Autofits the columns width. * @param firstRow - First row index. * @param firstColumn - First column index. * @param lastRow - Last row index. * @param lastColumn - Last column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumns(firstRow: number, firstColumn: number, lastRow: number, lastColumn: number) : void; /** * Autofits the columns width. * @param firstRow - First row index. * @param firstColumn - First column index. * @param lastRow - Last row index. * @param lastColumn - Last column index. * @param options - The auto fitting options * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumns(firstRow: number, firstColumn: number, lastRow: number, lastColumn: number, options: AutoFitterOptions) : void; /** * Autofits all columns in this worksheet. */ autoFitColumnsAsync() : Promise; /** * Autofits all columns in this worksheet. * @param options - The auto fitting options */ autoFitColumnsAsync(options: AutoFitterOptions) : Promise; /** * Autofits the columns width. * @param firstColumn - First column index. * @param lastColumn - Last column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumnsAsync(firstColumn: number, lastColumn: number) : Promise; /** * Autofits the columns width. * @param firstColumn - First column index. * @param lastColumn - Last column index. * @param options - The auto fitting options * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumnsAsync(firstColumn: number, lastColumn: number, options: AutoFitterOptions) : Promise; /** * Autofits the columns width. * @param firstRow - First row index. * @param firstColumn - First column index. * @param lastRow - Last row index. * @param lastColumn - Last column index. * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumnsAsync(firstRow: number, firstColumn: number, lastRow: number, lastColumn: number) : Promise; /** * Autofits the columns width. * @param firstRow - First row index. * @param firstColumn - First column index. * @param lastRow - Last row index. * @param lastColumn - Last column index. * @param options - The auto fitting options * * @remarks * AutoFitColumn is an imprecise function. */ autoFitColumnsAsync(firstRow: number, firstColumn: number, lastRow: number, lastColumn: number, options: AutoFitterOptions) : Promise; /** * Autofits the row height. * @param rowIndex - Row index. * @param firstColumn - First column index. * @param lastColumn - Last column index. * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitRow(rowIndex: number, firstColumn: number, lastColumn: number) : void; /** * Autofits the row height. * @param rowIndex - Row index. * @param firstColumn - First column index. * @param lastColumn - Last column index. * @param options - The auto fitter options * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitRow(rowIndex: number, firstColumn: number, lastColumn: number, options: AutoFitterOptions) : void; /** * Autofits row height in a rectangle range. * @param startRow - Start row index. * @param endRow - End row index. * @param startColumn - Start column index. * @param endColumn - End column index. */ autoFitRow(startRow: number, endRow: number, startColumn: number, endColumn: number) : void; /** * Autofits the row height. * @param rowIndex - Row index. * * @remarks * AutoFitRow is an imprecise function. */ autoFitRow(rowIndex: number) : void; /** * Autofits the row height. * @param rowIndex - Row index. * @param firstColumn - First column index. * @param lastColumn - Last column index. * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitRowAsync(rowIndex: number, firstColumn: number, lastColumn: number) : Promise; /** * Autofits the row height. * @param rowIndex - Row index. * @param firstColumn - First column index. * @param lastColumn - Last column index. * @param options - The auto fitter options * * @remarks * This method autofits a row based on content in a range of cells within the row. */ autoFitRowAsync(rowIndex: number, firstColumn: number, lastColumn: number, options: AutoFitterOptions) : Promise; /** * Autofits row height in a rectangle range. * @param startRow - Start row index. * @param endRow - End row index. * @param startColumn - Start column index. * @param endColumn - End column index. */ autoFitRowAsync(startRow: number, endRow: number, startColumn: number, endColumn: number) : Promise; /** * Autofits the row height. * @param rowIndex - Row index. * * @remarks * AutoFitRow is an imprecise function. */ autoFitRowAsync(rowIndex: number) : Promise; /** * Autofits all rows in this worksheet. */ autoFitRows() : void; /** * Autofits all rows in this worksheet. * @param onlyAuto - True,only autofits the row height when row height is not customed. */ autoFitRows(onlyAuto: boolean) : void; /** * Autofits all rows in this worksheet. * @param options - The auto fitter options */ autoFitRows(options: AutoFitterOptions) : void; /** * Autofits row height in a range. * @param startRow - Start row index. * @param endRow - End row index. */ autoFitRows(startRow: number, endRow: number) : void; /** * Autofits row height in a range. * @param startRow - Start row index. * @param endRow - End row index. * @param options - The options of auto fitter. */ autoFitRows(startRow: number, endRow: number, options: AutoFitterOptions) : void; /** * Autofits all rows in this worksheet. */ autoFitRowsAsync() : Promise; /** * Autofits all rows in this worksheet. * @param onlyAuto - True,only autofits the row height when row height is not customed. */ autoFitRowsAsync(onlyAuto: boolean) : Promise; /** * Autofits all rows in this worksheet. * @param options - The auto fitter options */ autoFitRowsAsync(options: AutoFitterOptions) : Promise; /** * Autofits row height in a range. * @param startRow - Start row index. * @param endRow - End row index. */ autoFitRowsAsync(startRow: number, endRow: number) : Promise; /** * Autofits row height in a range. * @param startRow - Start row index. * @param endRow - End row index. * @param options - The options of auto fitter. */ autoFitRowsAsync(startRow: number, endRow: number, options: AutoFitterOptions) : Promise; /** * Filters the range. * @param ca - The range */ filter(ca: CellArea) : void; /** * Gets the settings of advanced filter. */ getAdvancedFilter() : AdvancedFilter; /** * Filters data using complex criteria. * @param isFilter - Indicates whether filtering the list in place. * @param listRange - The list range. * @param criteriaRange - The criteria range. * @param copyTo - The range where copying data to. * @param uniqueRecordOnly - Only displaying or copying unique rows. */ advanced_Filter(isFilter: boolean, listRange: string, criteriaRange: string, copyTo: string, uniqueRecordOnly: boolean) : void; /** * Removes the auto filter of the worksheet. */ removeAutoFilter() : void; /** * Sets the visible options. * @param isVisible - Whether the worksheet is visible * @param ignoreError - Whether to ignore error if this option is not valid. */ setVisible(isVisible: boolean, ignoreError: boolean) : void; /** * Selects a range. * @param startRow - The start row. * @param startColumn - The start column * @param totalRows - The number of rows. * @param totalColumns - The number of columns * @param removeOthers - True means removing other selected range and only select this range. */ selectRange(startRow: number, startColumn: number, totalRows: number, totalColumns: number, removeOthers: boolean) : void; /** * Removes all drawing objects in this worksheet. */ removeAllDrawingObjects() : void; /** * Clears all comments in designer spreadsheet. */ clearComments() : void; /** * Gets all pictures includes images are embedded in the cell and over the cells. */ getAllPictures() : Picture[]; /** * Protects worksheet. * @param type - Protection type. * * @remarks * This method protects worksheet without password. It can protect worksheet in all versions of Excel file. */ protect(type: ProtectionType) : void; /** * Protects worksheet. * @param type - Protection type. * @param password - Password. * @param oldPassword - If the worksheet is already protected by a password, please supply the old password. /// Otherwise, you can set a null value or blank string to this parameter. * * @remarks * This method can protect worksheet in all versions of Excel file. */ protect(type: ProtectionType, password: string, oldPassword: string) : void; /** * Unprotects worksheet. * * @remarks * This method unprotects worksheet which is protected without password. */ unprotect() : void; /** * Unprotects worksheet. * @param password - Password * * @remarks * If the worksheet is protected without a password, you can set a null value or blank string to password parameter. */ unprotect(password: string) : void; /** * Moves the sheet to another location in the spreadsheet. * @param index - Destination sheet index. */ moveTo(index: number) : void; /** * Replaces all cells' text with a new string. * @param oldString - Old string value. * @param newString - New string value. */ replace(oldString: string, newString: string) : number; /** * Gets selected ranges of cells in the designer spreadsheet. * @returns * Returns all selected ranges. */ getSelectedAreas() : Range[]; /** * Gets automatic page breaks. * @param options - The print options * @returns * The automatic page breaks areas. * * @remarks * Each cell area represents a paper. */ getPrintingPageBreaks(options: ImageOrPrintOptions) : CellArea[]; /** * Returns a string represents the current Worksheet object. */ toString() : string; /** * Starts the session that uses caches to access the data in this worksheet. * @param opts - options of data access * * @remarks * After finishing the access to the data, should * be invoked with same options to clear all caches and recover normal access mode. */ startAccessCache(opts: AccessCacheOptions) : void; /** * Closes the session that uses caches to access the data in this worksheet. * @param opts - options of data access */ closeAccessCache(opts: AccessCacheOptions) : void; /** * Converts the formula reference style. * @param formula - The formula to be converted. * @param toR1C1 - Which reference style to convert the formula to. /// If the original formula is of A1 reference style, /// then this value should be true so the formula will be converted from A1 to R1C1 reference style; /// If the original formula is of R1C1 reference style, /// then this value should be false so the formula will be converted from R1C1 to A1 reference style; * @param baseCellRow - The row index of the base cell. * @param baseCellColumn - The column index of the base cell. * @returns * The converted formula. */ convertFormulaReferenceStyle(formula: string, toR1C1: boolean, baseCellRow: number, baseCellColumn: number) : string; /** * Calculates a formula. * @param formula - Formula to be calculated. * @returns * Calculated formula result. */ calculateFormula(formula: string) : Object; /** * Calculates a formula expression directly. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula * @returns * Calculated result of given formula. * The returned object may be of possible types of , or ReferredArea. * * @remarks * The formula will be calculated just like it has been set to cell A1. * And the formula will be taken as normal formula. * If you need the formula be calculated as an array formula and to get an array for the calculated result, * please use instead. */ calculateFormula(formula: string, opts: CalculationOptions) : Object; /** * Calculates a formula expression directly. * @param formula - Formula to be calculated. * @param pOpts - Options for parsing formula. * @param cOpts - Options for calculating formula. * @param baseCellRow - The row index of the base cell. * @param baseCellColumn - The column index of the base cell. * @param calculationData - The calculation data. It is used for the situation /// that user needs to calculate some static formulas when implementing custom calculation engine. /// For such kind of situation, user needs to specify it with the calculation data provided /// for . * @returns * Calculated result of given formula. * The returned object may be of possible types of , or ReferredArea. * * @remarks * The formula will be calculated just like it has been set to the specified base cell. * And the formula will be taken as normal formula. If you need the formula be calculated as an array formula * and to get an array for the calculated result, please use * instead. */ calculateFormula(formula: string, pOpts: FormulaParseOptions, cOpts: CalculationOptions, baseCellRow: number, baseCellColumn: number, calculationData: CalculationData) : Object; /** * Calculates all formulas in this worksheet. * @param options - Options for calculation * @param recursive - True means if the worksheet' cells depend on the cells of other worksheets, /// the dependent cells in other worksheets will be calculated too. /// False means all the formulas in the worksheet have been calculated and the values are right. */ calculateFormula(options: CalculationOptions, recursive: boolean) : void; /** * Calculates a formula. * @param formula - Formula to be calculated. * @returns * Calculated formula result. */ calculateFormulaAsync(formula: string) : Promise; /** * Calculates a formula expression directly. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula * @returns * Calculated result of given formula. * The returned object may be of possible types of , or ReferredArea. * * @remarks * The formula will be calculated just like it has been set to cell A1. * And the formula will be taken as normal formula. * If you need the formula be calculated as an array formula and to get an array for the calculated result, * please use instead. */ calculateFormulaAsync(formula: string, opts: CalculationOptions) : Promise; /** * Calculates a formula expression directly. * @param formula - Formula to be calculated. * @param pOpts - Options for parsing formula. * @param cOpts - Options for calculating formula. * @param baseCellRow - The row index of the base cell. * @param baseCellColumn - The column index of the base cell. * @param calculationData - The calculation data. It is used for the situation /// that user needs to calculate some static formulas when implementing custom calculation engine. /// For such kind of situation, user needs to specify it with the calculation data provided /// for . * @returns * Calculated result of given formula. * The returned object may be of possible types of , or ReferredArea. * * @remarks * The formula will be calculated just like it has been set to the specified base cell. * And the formula will be taken as normal formula. If you need the formula be calculated as an array formula * and to get an array for the calculated result, please use * instead. */ calculateFormulaAsync(formula: string, pOpts: FormulaParseOptions, cOpts: CalculationOptions, baseCellRow: number, baseCellColumn: number, calculationData: CalculationData) : Promise; /** * Calculates all formulas in this worksheet. * @param options - Options for calculation * @param recursive - True means if the worksheet' cells depend on the cells of other worksheets, /// the dependent cells in other worksheets will be calculated too. /// False means all the formulas in the worksheet have been calculated and the values are right. */ calculateFormulaAsync(options: CalculationOptions, recursive: boolean) : Promise; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula */ calculateArrayFormula(formula: string, opts: CalculationOptions) : Object[][]; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula * @param maxRowCount - the maximum row count of resultant data. /// If it is non-positive or greater than the actual row count, then actual row count will be used. * @param maxColumnCount - the maximum column count of resultant data. /// If it is non-positive or greater than the actual row count, then actual column count will be used. * @returns * Calculated formula result. * * @remarks * The formula will be taken as dynamic array formula to calculate the dimension and result. * User specified maximum dimension is used for cases that the calculated result is large data set * (for example, the calculated result may correspond to a whole row or column data) * but user does not need so large an array according to business requirement or for performance consideration. */ calculateArrayFormula(formula: string, opts: CalculationOptions, maxRowCount: number, maxColumnCount: number) : Object[][]; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param pOpts - Options for parsing formula * @param cOpts - Options for calculating formula * @param baseCellRow - The row index of the base cell. * @param baseCellColumn - The column index of the base cell. * @param maxRowCount - The maximum row count of resultant data. /// If it is non-positive or greater than the actual row count, then actual row count will be used. * @param maxColumnCount - The maximum column count of resultant data. /// If it is non-positive or greater than the actual row count, then actual column count will be used. * @param calculationData - The calculation data. It is used for the situation /// that user needs to calculate some static formulas when implementing custom calculation engine. /// For such kind of situation, user needs to specify it with the calculation data provided /// for . * @returns * Calculated formula result. * * @remarks * The formula will be taken as dynamic array formula to calculate the dimension and result. * User specified maximum dimension is used for cases that the calculated result is large data set * (for example, the calculated result may correspond to a whole row or column data) * but user does not need so large an array according to business requirement or for performance consideration. */ calculateArrayFormula(formula: string, pOpts: FormulaParseOptions, cOpts: CalculationOptions, baseCellRow: number, baseCellColumn: number, maxRowCount: number, maxColumnCount: number, calculationData: CalculationData) : Object[][]; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula */ calculateArrayFormulaAsync(formula: string, opts: CalculationOptions) : Promise; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param opts - Options for calculating formula * @param maxRowCount - the maximum row count of resultant data. /// If it is non-positive or greater than the actual row count, then actual row count will be used. * @param maxColumnCount - the maximum column count of resultant data. /// If it is non-positive or greater than the actual row count, then actual column count will be used. * @returns * Calculated formula result. * * @remarks * The formula will be taken as dynamic array formula to calculate the dimension and result. * User specified maximum dimension is used for cases that the calculated result is large data set * (for example, the calculated result may correspond to a whole row or column data) * but user does not need so large an array according to business requirement or for performance consideration. */ calculateArrayFormulaAsync(formula: string, opts: CalculationOptions, maxRowCount: number, maxColumnCount: number) : Promise; /** * Calculates a formula as array formula. * @param formula - Formula to be calculated. * @param pOpts - Options for parsing formula * @param cOpts - Options for calculating formula * @param baseCellRow - The row index of the base cell. * @param baseCellColumn - The column index of the base cell. * @param maxRowCount - The maximum row count of resultant data. /// If it is non-positive or greater than the actual row count, then actual row count will be used. * @param maxColumnCount - The maximum column count of resultant data. /// If it is non-positive or greater than the actual row count, then actual column count will be used. * @param calculationData - The calculation data. It is used for the situation /// that user needs to calculate some static formulas when implementing custom calculation engine. /// For such kind of situation, user needs to specify it with the calculation data provided /// for . * @returns * Calculated formula result. * * @remarks * The formula will be taken as dynamic array formula to calculate the dimension and result. * User specified maximum dimension is used for cases that the calculated result is large data set * (for example, the calculated result may correspond to a whole row or column data) * but user does not need so large an array according to business requirement or for performance consideration. */ calculateArrayFormulaAsync(formula: string, pOpts: FormulaParseOptions, cOpts: CalculationOptions, baseCellRow: number, baseCellColumn: number, maxRowCount: number, maxColumnCount: number, calculationData: CalculationData) : Promise; /** * Refreshes all the PivotTables in this Worksheet. */ refreshPivotTables() : void; /** * Refreshes all the PivotTables in this Worksheet. * @param option - The option for refreshing data source of pivot table. */ refreshPivotTables(option: PivotTableRefreshOption) : boolean; /** * Refreshes all the PivotTables in this Worksheet. */ refreshPivotTablesAsync() : Promise; /** * Refreshes all the PivotTables in this Worksheet. * @param option - The option for refreshing data source of pivot table. */ refreshPivotTablesAsync(option: PivotTableRefreshOption) : Promise; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the filter that provides options for loading data when loading workbook from template. * * @remarks * User may specify the filter options or implement their own LoadFilter to specify how to load data. */ export class LoadFilter { /** * Default Constructor. */ constructor(); /** * Constructs one LoadFilter with given filter options. * @param opts - The default filter options. */ constructor(opts: LoadDataFilterOptions); /** * @deprecated Please use the 'loadDataFilterOptions' property instead. * The filter options to denote what data should be loaded. */ getLoadDataFilterOptions() : LoadDataFilterOptions; /** * The filter options to denote what data should be loaded. */ loadDataFilterOptions : LoadDataFilterOptions; /** * @deprecated Please use the 'loadDataFilterOptions' property instead. * The filter options to denote what data should be loaded. * @param value - The value to set. */ setLoadDataFilterOptions(value: LoadDataFilterOptions) : void; /** * Specifies the sheets(indices) and order to be loaded. * Default is null, that denotes to load all sheets in the default order in template file. * If not null and some sheet's index is not in the returned array, then the sheet will not be loaded. */ getSheetsInLoadingOrder() : number[]; /** * Prepares filter options before loading given worksheet. * User's implementation of LoadFilter can change the LoadDataFilterOptions here * to denote how to load data for this worksheet. * @param sheet - The worksheet to be loaded. /// There are only few properties can be used for the given worksheet object here /// because most data and properties have not been loaded. The available properties are: /// Name, Index, VisibilityType */ startSheet(sheet: Worksheet) : void; } /** * Encapsulates the object that represents the page setup description. * The PageSetup object contains all page setup options. */ export class PageSetup { /** * @deprecated Please use the 'oDSPageBackground' property instead. * Gets the background of ODS. */ getODSPageBackground() : OdsPageBackground; /** * Gets the background of ODS. */ readonly oDSPageBackground : OdsPageBackground; /** * @deprecated Please use the 'printArea' property instead. * Represents the range to be printed. */ getPrintArea() : string; /** * Represents the range to be printed. */ printArea : string; /** * @deprecated Please use the 'printArea' property instead. * Represents the range to be printed. * @param value - The value to set. */ setPrintArea(value: string) : void; /** * @deprecated Please use the 'printTitleColumns' property instead. * Represents the columns that contain the cells to be repeated on the left side of each page. */ getPrintTitleColumns() : string; /** * Represents the columns that contain the cells to be repeated on the left side of each page. */ printTitleColumns : string; /** * @deprecated Please use the 'printTitleColumns' property instead. * Represents the columns that contain the cells to be repeated on the left side of each page. * @param value - The value to set. */ setPrintTitleColumns(value: string) : void; /** * @deprecated Please use the 'printTitleRows' property instead. * Represents the rows that contain the cells to be repeated at the top of each page. */ getPrintTitleRows() : string; /** * Represents the rows that contain the cells to be repeated at the top of each page. */ printTitleRows : string; /** * @deprecated Please use the 'printTitleRows' property instead. * Represents the rows that contain the cells to be repeated at the top of each page. * @param value - The value to set. */ setPrintTitleRows(value: string) : void; /** * @deprecated Please use the 'blackAndWhite' property instead. * Represents if elements of the document will be printed in black and white. */ getBlackAndWhite() : boolean; /** * Represents if elements of the document will be printed in black and white. */ blackAndWhite : boolean; /** * @deprecated Please use the 'blackAndWhite' property instead. * Represents if elements of the document will be printed in black and white. * @param value - The value to set. */ setBlackAndWhite(value: boolean) : void; /** * @deprecated Please use the 'centerHorizontally' property instead. * Represent if the sheet is printed centered horizontally. */ getCenterHorizontally() : boolean; /** * Represent if the sheet is printed centered horizontally. */ centerHorizontally : boolean; /** * @deprecated Please use the 'centerHorizontally' property instead. * Represent if the sheet is printed centered horizontally. * @param value - The value to set. */ setCenterHorizontally(value: boolean) : void; /** * @deprecated Please use the 'centerVertically' property instead. * Represent if the sheet is printed centered vertically. */ getCenterVertically() : boolean; /** * Represent if the sheet is printed centered vertically. */ centerVertically : boolean; /** * @deprecated Please use the 'centerVertically' property instead. * Represent if the sheet is printed centered vertically. * @param value - The value to set. */ setCenterVertically(value: boolean) : void; /** * @deprecated Please use the 'printDraft' property instead. * Represents if the sheet will be printed without graphics. */ getPrintDraft() : boolean; /** * Represents if the sheet will be printed without graphics. */ printDraft : boolean; /** * @deprecated Please use the 'printDraft' property instead. * Represents if the sheet will be printed without graphics. * @param value - The value to set. */ setPrintDraft(value: boolean) : void; /** * @deprecated Please use the 'footerMargin' property instead. * Represents the distance from the bottom of the page to the footer, in unit of centimeters. */ getFooterMargin() : number; /** * Represents the distance from the bottom of the page to the footer, in unit of centimeters. */ footerMargin : number; /** * @deprecated Please use the 'footerMargin' property instead. * Represents the distance from the bottom of the page to the footer, in unit of centimeters. * @param value - The value to set. */ setFooterMargin(value: number) : void; /** * @deprecated Please use the 'footerMarginInch' property instead. * Represents the distance from the bottom of the page to the footer, in unit of inches. */ getFooterMarginInch() : number; /** * Represents the distance from the bottom of the page to the footer, in unit of inches. */ footerMarginInch : number; /** * @deprecated Please use the 'footerMarginInch' property instead. * Represents the distance from the bottom of the page to the footer, in unit of inches. * @param value - The value to set. */ setFooterMarginInch(value: number) : void; /** * @deprecated Please use the 'headerMargin' property instead. * Represents the distance from the top of the page to the header, in unit of centimeters. */ getHeaderMargin() : number; /** * Represents the distance from the top of the page to the header, in unit of centimeters. */ headerMargin : number; /** * @deprecated Please use the 'headerMargin' property instead. * Represents the distance from the top of the page to the header, in unit of centimeters. * @param value - The value to set. */ setHeaderMargin(value: number) : void; /** * @deprecated Please use the 'headerMarginInch' property instead. * Represents the distance from the top of the page to the header, in unit of inches. */ getHeaderMarginInch() : number; /** * Represents the distance from the top of the page to the header, in unit of inches. */ headerMarginInch : number; /** * @deprecated Please use the 'headerMarginInch' property instead. * Represents the distance from the top of the page to the header, in unit of inches. * @param value - The value to set. */ setHeaderMarginInch(value: number) : void; /** * @deprecated Please use the 'printerSettings' property instead. * Gets and sets the settings of the default printer. */ getPrinterSettings() : Uint8Array; /** * Gets and sets the settings of the default printer. */ printerSettings : Uint8Array; /** * @deprecated Please use the 'printerSettings' property instead. * Gets and sets the settings of the default printer. * @param value - The value to set. */ setPrinterSettings(value: Uint8Array) : void; /** * @deprecated Please use the 'leftMargin' property instead. * Represents the size of the left margin, in unit of centimeters. */ getLeftMargin() : number; /** * Represents the size of the left margin, in unit of centimeters. */ leftMargin : number; /** * @deprecated Please use the 'leftMargin' property instead. * Represents the size of the left margin, in unit of centimeters. * @param value - The value to set. */ setLeftMargin(value: number) : void; /** * @deprecated Please use the 'leftMarginInch' property instead. * Represents the size of the left margin, in unit of inches. */ getLeftMarginInch() : number; /** * Represents the size of the left margin, in unit of inches. */ leftMarginInch : number; /** * @deprecated Please use the 'leftMarginInch' property instead. * Represents the size of the left margin, in unit of inches. * @param value - The value to set. */ setLeftMarginInch(value: number) : void; /** * @deprecated Please use the 'rightMargin' property instead. * Represents the size of the right margin, in unit of centimeters. */ getRightMargin() : number; /** * Represents the size of the right margin, in unit of centimeters. */ rightMargin : number; /** * @deprecated Please use the 'rightMargin' property instead. * Represents the size of the right margin, in unit of centimeters. * @param value - The value to set. */ setRightMargin(value: number) : void; /** * @deprecated Please use the 'rightMarginInch' property instead. * Represents the size of the right margin, in unit of inches. */ getRightMarginInch() : number; /** * Represents the size of the right margin, in unit of inches. */ rightMarginInch : number; /** * @deprecated Please use the 'rightMarginInch' property instead. * Represents the size of the right margin, in unit of inches. * @param value - The value to set. */ setRightMarginInch(value: number) : void; /** * @deprecated Please use the 'topMargin' property instead. * Represents the size of the top margin, in unit of centimeters. */ getTopMargin() : number; /** * Represents the size of the top margin, in unit of centimeters. */ topMargin : number; /** * @deprecated Please use the 'topMargin' property instead. * Represents the size of the top margin, in unit of centimeters. * @param value - The value to set. */ setTopMargin(value: number) : void; /** * @deprecated Please use the 'topMarginInch' property instead. * Represents the size of the top margin, in unit of inches. */ getTopMarginInch() : number; /** * Represents the size of the top margin, in unit of inches. */ topMarginInch : number; /** * @deprecated Please use the 'topMarginInch' property instead. * Represents the size of the top margin, in unit of inches. * @param value - The value to set. */ setTopMarginInch(value: number) : void; /** * @deprecated Please use the 'bottomMargin' property instead. * Represents the size of the bottom margin, in unit of centimeters. */ getBottomMargin() : number; /** * Represents the size of the bottom margin, in unit of centimeters. */ bottomMargin : number; /** * @deprecated Please use the 'bottomMargin' property instead. * Represents the size of the bottom margin, in unit of centimeters. * @param value - The value to set. */ setBottomMargin(value: number) : void; /** * @deprecated Please use the 'bottomMarginInch' property instead. * Represents the size of the bottom margin, in unit of inches. */ getBottomMarginInch() : number; /** * Represents the size of the bottom margin, in unit of inches. */ bottomMarginInch : number; /** * @deprecated Please use the 'bottomMarginInch' property instead. * Represents the size of the bottom margin, in unit of inches. * @param value - The value to set. */ setBottomMarginInch(value: number) : void; /** * @deprecated Please use the 'firstPageNumber' property instead. * Represents the first page number that will be used when this sheet is printed. */ getFirstPageNumber() : number; /** * Represents the first page number that will be used when this sheet is printed. */ firstPageNumber : number; /** * @deprecated Please use the 'firstPageNumber' property instead. * Represents the first page number that will be used when this sheet is printed. * @param value - The value to set. */ setFirstPageNumber(value: number) : void; /** * @deprecated Please use the 'fitToPagesTall' property instead. * Represents the number of pages tall the worksheet will be scaled to when it's printed. * The default value is 1. * * @remarks * You have to set FitToPagesWide as zero if you want to fit all rows on one page. */ getFitToPagesTall() : number; /** * Represents the number of pages tall the worksheet will be scaled to when it's printed. * The default value is 1. * * @remarks * You have to set FitToPagesWide as zero if you want to fit all rows on one page. */ fitToPagesTall : number; /** * @deprecated Please use the 'fitToPagesTall' property instead. * Represents the number of pages tall the worksheet will be scaled to when it's printed. * The default value is 1. * @param value - The value to set. * * @remarks * You have to set FitToPagesWide as zero if you want to fit all rows on one page. */ setFitToPagesTall(value: number) : void; /** * @deprecated Please use the 'fitToPagesWide' property instead. * Represents the number of pages wide the worksheet will be scaled to when it's printed. * The default value is 1. * * @remarks * You have to set FitToPagesTall as zero if you want to fit all columns on one page. */ getFitToPagesWide() : number; /** * Represents the number of pages wide the worksheet will be scaled to when it's printed. * The default value is 1. * * @remarks * You have to set FitToPagesTall as zero if you want to fit all columns on one page. */ fitToPagesWide : number; /** * @deprecated Please use the 'fitToPagesWide' property instead. * Represents the number of pages wide the worksheet will be scaled to when it's printed. * The default value is 1. * @param value - The value to set. * * @remarks * You have to set FitToPagesTall as zero if you want to fit all columns on one page. */ setFitToPagesWide(value: number) : void; /** * If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled. */ isPercentScale : boolean; /** * @deprecated Please use the 'isPercentScale' property instead. * If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled. * @param value - The value to set. */ setIsPercentScale(value: boolean) : void; /** * @deprecated Please use the 'order' property instead. * Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. */ getOrder() : PrintOrderType; /** * Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. */ order : PrintOrderType; /** * @deprecated Please use the 'order' property instead. * Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. * @param value - The value to set. */ setOrder(value: PrintOrderType) : void; /** * Indicates whether the paper size is automatic. */ readonly isAutomaticPaperSize : boolean; /** * @deprecated Please use the 'paperSize' property instead. * Represents the size of the paper. */ getPaperSize() : PaperSizeType; /** * Represents the size of the paper. */ paperSize : PaperSizeType; /** * @deprecated Please use the 'paperSize' property instead. * Represents the size of the paper. * @param value - The value to set. */ setPaperSize(value: PaperSizeType) : void; /** * @deprecated Please use the 'paperWidth' property instead. * Gets the width of the paper in unit of inches, considered page orientation. */ getPaperWidth() : number; /** * Gets the width of the paper in unit of inches, considered page orientation. */ readonly paperWidth : number; /** * @deprecated Please use the 'paperHeight' property instead. * Gets the height of the paper in unit of inches , considered page orientation. */ getPaperHeight() : number; /** * Gets the height of the paper in unit of inches , considered page orientation. */ readonly paperHeight : number; /** * @deprecated Please use the 'orientation' property instead. * Represents page print orientation. */ getOrientation() : PageOrientationType; /** * Represents page print orientation. */ orientation : PageOrientationType; /** * @deprecated Please use the 'orientation' property instead. * Represents page print orientation. * @param value - The value to set. */ setOrientation(value: PageOrientationType) : void; /** * @deprecated Please use the 'printComments' property instead. * Represents the way comments are printed with the sheet. */ getPrintComments() : PrintCommentsType; /** * Represents the way comments are printed with the sheet. */ printComments : PrintCommentsType; /** * @deprecated Please use the 'printComments' property instead. * Represents the way comments are printed with the sheet. * @param value - The value to set. */ setPrintComments(value: PrintCommentsType) : void; /** * @deprecated Please use the 'printErrors' property instead. * Specifies the type of print error displayed. */ getPrintErrors() : PrintErrorsType; /** * Specifies the type of print error displayed. */ printErrors : PrintErrorsType; /** * @deprecated Please use the 'printErrors' property instead. * Specifies the type of print error displayed. * @param value - The value to set. */ setPrintErrors(value: PrintErrorsType) : void; /** * @deprecated Please use the 'printHeadings' property instead. * Represents if row and column headings are printed with this page. */ getPrintHeadings() : boolean; /** * Represents if row and column headings are printed with this page. */ printHeadings : boolean; /** * @deprecated Please use the 'printHeadings' property instead. * Represents if row and column headings are printed with this page. * @param value - The value to set. */ setPrintHeadings(value: boolean) : void; /** * @deprecated Please use the 'printGridlines' property instead. * Represents if cell gridlines are printed on the page. */ getPrintGridlines() : boolean; /** * Represents if cell gridlines are printed on the page. */ printGridlines : boolean; /** * @deprecated Please use the 'printGridlines' property instead. * Represents if cell gridlines are printed on the page. * @param value - The value to set. */ setPrintGridlines(value: boolean) : void; /** * @deprecated Please use the 'zoom' property instead. * Represents the scaling factor in percent. It should be between 10 and 400. */ getZoom() : number; /** * Represents the scaling factor in percent. It should be between 10 and 400. */ zoom : number; /** * @deprecated Please use the 'zoom' property instead. * Represents the scaling factor in percent. It should be between 10 and 400. * @param value - The value to set. */ setZoom(value: number) : void; /** * Indicates whether the first the page number is automatically assigned. */ isAutoFirstPageNumber : boolean; /** * @deprecated Please use the 'isAutoFirstPageNumber' property instead. * Indicates whether the first the page number is automatically assigned. * @param value - The value to set. */ setIsAutoFirstPageNumber(value: boolean) : void; /** * @deprecated Please use the 'printQuality' property instead. * Represents the print quality. */ getPrintQuality() : number; /** * Represents the print quality. */ printQuality : number; /** * @deprecated Please use the 'printQuality' property instead. * Represents the print quality. * @param value - The value to set. */ setPrintQuality(value: number) : void; /** * @deprecated Please use the 'printCopies' property instead. * Get and sets number of copies to print. */ getPrintCopies() : number; /** * Get and sets number of copies to print. */ printCopies : number; /** * @deprecated Please use the 'printCopies' property instead. * Get and sets number of copies to print. * @param value - The value to set. */ setPrintCopies(value: number) : void; /** * True means that the header/footer of the odd pages is different with odd pages. */ isHFDiffOddEven : boolean; /** * @deprecated Please use the 'isHFDiffOddEven' property instead. * True means that the header/footer of the odd pages is different with odd pages. * @param value - The value to set. */ setIsHFDiffOddEven(value: boolean) : void; /** * True means that the header/footer of the first page is different with other pages. */ isHFDiffFirst : boolean; /** * @deprecated Please use the 'isHFDiffFirst' property instead. * True means that the header/footer of the first page is different with other pages. * @param value - The value to set. */ setIsHFDiffFirst(value: boolean) : void; /** * Indicates whether header and footer are scaled with document scaling. * Only applies for Excel 2007. */ isHFScaleWithDoc : boolean; /** * @deprecated Please use the 'isHFScaleWithDoc' property instead. * Indicates whether header and footer are scaled with document scaling. * Only applies for Excel 2007. * @param value - The value to set. */ setIsHFScaleWithDoc(value: boolean) : void; /** * Indicates whether header and footer margins are aligned with the page margins. * If this property is true, the left header and footer will be aligned with the left margin, * and the right header and footer will be aligned with the right margin. * This option is enabled by default. */ isHFAlignMargins : boolean; /** * @deprecated Please use the 'isHFAlignMargins' property instead. * Indicates whether header and footer margins are aligned with the page margins. * If this property is true, the left header and footer will be aligned with the left margin, * and the right header and footer will be aligned with the right margin. * This option is enabled by default. * @param value - The value to set. */ setIsHFAlignMargins(value: boolean) : void; /** * Copies the setting of the page setup. * @param source - The source. * @param copyOptions - The copy options. */ copy(source: PageSetup, copyOptions: CopyOptions) : void; /** * Sets the number of pages the worksheet will be scaled to when it's printed. * @param wide - Pages wide. * @param tall - Pages tall. */ setFitToPages(wide: number, tall: number) : void; /** * Sets the custom paper size, in unit of inches. * @param width - The width of the paper. * @param height - The height of the paper. */ customPaperSize(width: number, height: number) : void; /** * Clears header and footer setting. */ clearHeaderFooter() : void; /** * Gets a script formatting the header of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getHeader(section: number) : string; /** * Gets all commands of header or footer. * @param headerFooterScript - The header/footer script * @returns * Returns all commands of header or footer. */ getCommands(headerFooterScript: string) : HeaderFooterCommand[]; /** * Gets a script formatting the footer of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getFooter(section: number) : string; /** * Sets a script formatting the header of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param headerScript - Header format script. * * @remarks *

Script commands:

* * * Command * Description * * * &P * Current page number  * * * &N * Page count  * * * &D * Current date  * * * &T * Current time * * * &A * Sheet name * * * &F * File name without path * * * &"<FontName>" * Font name, for example: &"Arial" * * * &"<FontName>, <FontStyle>" * Font name and font style, for example: &"Arial,Bold" * * * &<FontSize> * Font size. If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character. * * * &K<RRGGBB> * Font color, for example(RED): &KFF0000 * * * &G * Image script * * * For example: "&Arial,Bold&8Header Note" */ setHeader(section: number, headerScript: string) : void; /** * Sets a script formatting the footer of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param footerScript - Footer format script. * * @remarks *

Script commands:

* * * Command * Description * * * &P * Current page number  * * * &N * Page count  * * * &D * Current date  * * * &T * Current time * * * &A * Sheet name * * * &F * File name without path * * * &"<FontName>" * Font name, for example: &"Arial" * * * &"<FontName>, <FontStyle>" * Font name and font style, for example: &"Arial,Bold" * * * &<FontSize> * Font size. If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character. * * * &K<RRGGBB> * Font color, for example(RED): &KFF0000 * * * &G * Image script * * * For example: "&Arial,Bold&8Footer Note" */ setFooter(section: number, footerScript: string) : void; /** * Sets a script formatting the even page header of an Excel file. * Only effect in Excel 2007 when IsHFDiffOddEven is true. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param headerScript - Header format script. */ setEvenHeader(section: number, headerScript: string) : void; /** * Gets a script formatting the even header of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getEvenHeader(section: number) : string; /** * Sets a script formatting the even page footer of an Excel file. * Only effect in Excel 2007 when IsHFDiffOddEven is true. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param footerScript - Footer format script. */ setEvenFooter(section: number, footerScript: string) : void; /** * Gets a script formatting the even footer of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getEvenFooter(section: number) : string; /** * Sets a script formatting the first page header of an Excel file. * Only effect in Excel 2007 when IsHFDiffFirst is true. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param headerScript - Header format script. */ setFirstPageHeader(section: number, headerScript: string) : void; /** * Gets a script formatting the first page header of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getFirstPageHeader(section: number) : string; /** * Sets a script formatting the first page footer of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param footerScript - Footer format script. */ setFirstPageFooter(section: number, footerScript: string) : void; /** * Gets a script formatting the first page footer of an Excel file. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. */ getFirstPageFooter(section: number) : string; /** * Sets an image in the header of a worksheet. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param headerPicture - Image data. * @returns * Returns object. */ setHeaderPicture(section: number, headerPicture: Uint8Array) : Picture; /** * Sets an image in the footer of a worksheet. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param footerPicture - Image data. * @returns * Returns object. */ setFooterPicture(section: number, footerPicture: Uint8Array) : Picture; /** * Sets an image in the header/footer of a worksheet. * @param isFirst - Indicates whether setting the picture of first page header/footer. * @param isEven - Indicates whether setting the picture of even page header/footer. * @param isHeader - Indicates whether setting the picture of header/footer. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @param imageData - Image data. * @returns * Returns object. */ setPicture(isFirst: boolean, isEven: boolean, isHeader: boolean, section: number, imageData: Uint8Array) : Picture; /** * Gets the object of the header / footer. * @param isHeader - Indicates whether it is in the header or footer. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @returns * Returns object. * Returns null if there is no picture. */ getPicture(isHeader: boolean, section: number) : Picture; /** * Gets the object of the header / footer. * @param isFirst - Indicates whether getting the picture of first page header/footer. * @param isEven - Indicates whether getting the picture of even page header/footer. * @param isHeader - Indicates whether getting the picture of header/footer. * @param section - 0: Left Section, 1: Center Section, 2: Right Section. * @returns * Returns object. */ getPicture(isFirst: boolean, isEven: boolean, isHeader: boolean, section: number) : Picture; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the text options. */ export class TextOptions extends Font { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Font); /** * Gets and sets the name of the shape. */ getName() : string; /** * Gets and sets the name of the shape. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'languageCode' property instead. * Gets and sets the user interface language. */ getLanguageCode() : CountryCode; /** * Gets and sets the user interface language. */ languageCode : CountryCode; /** * @deprecated Please use the 'languageCode' property instead. * Gets and sets the user interface language. * @param value - The value to set. */ setLanguageCode(value: CountryCode) : void; /** * @deprecated Please use the 'latinName' property instead. * Gets and sets the latin name. */ getLatinName() : string; /** * Gets and sets the latin name. */ latinName : string; /** * @deprecated Please use the 'latinName' property instead. * Gets and sets the latin name. * @param value - The value to set. */ setLatinName(value: string) : void; /** * @deprecated Please use the 'farEastName' property instead. * Gets and sets the FarEast name. */ getFarEastName() : string; /** * Gets and sets the FarEast name. */ farEastName : string; /** * @deprecated Please use the 'farEastName' property instead. * Gets and sets the FarEast name. * @param value - The value to set. */ setFarEastName(value: string) : void; /** * @deprecated Please use the 'fill' property instead. * Represents the fill format of the text. */ getFill() : FillFormat; /** * Represents the fill format of the text. */ readonly fill : FillFormat; /** * @deprecated Please use the 'outline' property instead. * Represents the outline format of the text. */ getOutline() : LineFormat; /** * Represents the outline format of the text. */ readonly outline : LineFormat; /** * @deprecated Please use the 'shadow' property instead. * Represents a object that specifies shadow effect for the chart element or shape. */ getShadow() : ShadowEffect; /** * Represents a object that specifies shadow effect for the chart element or shape. */ readonly shadow : ShadowEffect; /** * @deprecated Please use the 'underlineColor' property instead. * Gets or sets the color of underline. */ getUnderlineColor() : CellsColor; /** * Gets or sets the color of underline. */ underlineColor : CellsColor; /** * @deprecated Please use the 'underlineColor' property instead. * Gets or sets the color of underline. * @param value - The value to set. */ setUnderlineColor(value: CellsColor) : void; /** * @deprecated Please use the 'kerning' property instead. * Specifies the minimum font size at which character kerning will occur for this text run. */ getKerning() : number; /** * Specifies the minimum font size at which character kerning will occur for this text run. */ kerning : number; /** * @deprecated Please use the 'kerning' property instead. * Specifies the minimum font size at which character kerning will occur for this text run. * @param value - The value to set. */ setKerning(value: number) : void; /** * @deprecated Please use the 'spacing' property instead. * Specifies the spacing between characters within a text run. */ getSpacing() : number; /** * Specifies the spacing between characters within a text run. */ spacing : number; /** * @deprecated Please use the 'spacing' property instead. * Specifies the spacing between characters within a text run. * @param value - The value to set. */ setSpacing(value: number) : void; /** * Indicates whether the normalization of height that is to be applied to the text run. * * @remarks * Only for the fonts of Shapes or Charts. */ isNormalizeHeights : boolean; /** * @deprecated Please use the 'isNormalizeHeights' property instead. * Indicates whether the normalization of height that is to be applied to the text run. * @param value - The value to set. * * @remarks * Only for the fonts of Shapes or Charts. */ setIsNormalizeHeights(value: boolean) : void; /** * @deprecated Please use the 'capsType' property instead. * Gets and sets the caps type for texts of the shape. */ getCapsType() : TextCapsType; /** * Gets and sets the caps type for texts of the shape. */ capsType : TextCapsType; /** * @deprecated Please use the 'capsType' property instead. * Gets and sets the caps type for texts of the shape. * @param value - The value to set. */ setCapsType(value: TextCapsType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a field in a PivotTable report. */ export class PivotField { /** * @deprecated Please use the 'pivotItems' property instead. * Gets the pivot items of the pivot field */ getPivotItems() : PivotItemCollection; /** * Gets the pivot items of the pivot field */ readonly pivotItems : PivotItemCollection; /** * @deprecated Please use the 'groupSettings' property instead. * Gets the group settings of the pivot field. * * @remarks * If this field is not grouped, Null will be returned. */ getGroupSettings() : PivotFieldGroupSettings; /** * Gets the group settings of the pivot field. * * @remarks * If this field is not grouped, Null will be returned. */ readonly groupSettings : PivotFieldGroupSettings; /** * Indicates whether the this pivot field is calculated field. */ readonly isCalculatedField : boolean; /** * Indicates whether this field represents values field. * * @remarks * Only works when there are two or more data fields in the pivot table view. */ readonly isValuesField : boolean; /** * @deprecated Please use the 'baseIndex' property instead. * Represents the index in the source pivot fields. */ getBaseIndex() : number; /** * Represents the index in the source pivot fields. */ baseIndex : number; /** * @deprecated Please use the 'baseIndex' property instead. * Represents the index in the source pivot fields. * @param value - The value to set. */ setBaseIndex(value: number) : void; /** * @deprecated Please use the 'position' property instead. * Represents the index of in the region. */ getPosition() : number; /** * Represents the index of in the region. */ readonly position : number; /** * @deprecated Please use the 'regionType' property instead. * Specifies the region of the PivotTable that this field is displayed. */ getRegionType() : PivotFieldType; /** * Specifies the region of the PivotTable that this field is displayed. */ readonly regionType : PivotFieldType; /** * @deprecated Please use the 'name' property instead. * Represents the name of PivotField. */ getName() : string; /** * Represents the name of PivotField. */ name : string; /** * @deprecated Please use the 'name' property instead. * Represents the name of PivotField. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'displayName' property instead. * Represents the display name of pivot field in the pivot table view. */ getDisplayName() : string; /** * Represents the display name of pivot field in the pivot table view. */ displayName : string; /** * @deprecated Please use the 'displayName' property instead. * Represents the display name of pivot field in the pivot table view. * @param value - The value to set. */ setDisplayName(value: string) : void; /** * Indicates whether the specified field shows automatic subtotals. Default is true. */ isAutoSubtotals : boolean; /** * @deprecated Please use the 'isAutoSubtotals' property instead. * Indicates whether the specified field shows automatic subtotals. Default is true. * @param value - The value to set. */ setIsAutoSubtotals(value: boolean) : void; /** * @deprecated Please use the 'dragToColumn' property instead. * Indicates whether the specified field can be dragged to the column position. * The default value is true. */ getDragToColumn() : boolean; /** * Indicates whether the specified field can be dragged to the column position. * The default value is true. */ dragToColumn : boolean; /** * @deprecated Please use the 'dragToColumn' property instead. * Indicates whether the specified field can be dragged to the column position. * The default value is true. * @param value - The value to set. */ setDragToColumn(value: boolean) : void; /** * @deprecated Please use the 'dragToHide' property instead. * Indicates whether the specified field can be dragged to the hide region. * The default value is true. */ getDragToHide() : boolean; /** * Indicates whether the specified field can be dragged to the hide region. * The default value is true. */ dragToHide : boolean; /** * @deprecated Please use the 'dragToHide' property instead. * Indicates whether the specified field can be dragged to the hide region. * The default value is true. * @param value - The value to set. */ setDragToHide(value: boolean) : void; /** * @deprecated Please use the 'dragToRow' property instead. * Indicates whether the specified field can be dragged to the row region. * The default value is true. */ getDragToRow() : boolean; /** * Indicates whether the specified field can be dragged to the row region. * The default value is true. */ dragToRow : boolean; /** * @deprecated Please use the 'dragToRow' property instead. * Indicates whether the specified field can be dragged to the row region. * The default value is true. * @param value - The value to set. */ setDragToRow(value: boolean) : void; /** * @deprecated Please use the 'dragToPage' property instead. * Indicates whether the specified field can be dragged to the page position. * The default value is true. */ getDragToPage() : boolean; /** * Indicates whether the specified field can be dragged to the page position. * The default value is true. */ dragToPage : boolean; /** * @deprecated Please use the 'dragToPage' property instead. * Indicates whether the specified field can be dragged to the page position. * The default value is true. * @param value - The value to set. */ setDragToPage(value: boolean) : void; /** * @deprecated Please use the 'dragToData' property instead. * Indicates whether the specified field can be dragged to the values region. * The default value is true. */ getDragToData() : boolean; /** * Indicates whether the specified field can be dragged to the values region. * The default value is true. */ dragToData : boolean; /** * @deprecated Please use the 'dragToData' property instead. * Indicates whether the specified field can be dragged to the values region. * The default value is true. * @param value - The value to set. */ setDragToData(value: boolean) : void; /** * Indicates whether multiple items could be selected in the page field. * The default value is false. */ isMultipleItemSelectionAllowed : boolean; /** * @deprecated Please use the 'isMultipleItemSelectionAllowed' property instead. * Indicates whether multiple items could be selected in the page field. * The default value is false. * @param value - The value to set. */ setIsMultipleItemSelectionAllowed(value: boolean) : void; /** * Indicates whether to repeat labels of the field in the region. * The default value is false. */ isRepeatItemLabels : boolean; /** * @deprecated Please use the 'isRepeatItemLabels' property instead. * Indicates whether to repeat labels of the field in the region. * The default value is false. * @param value - The value to set. */ setIsRepeatItemLabels(value: boolean) : void; /** * Indicates whether to include new items to the field in manual filter. * The default value is false. */ isIncludeNewItemsInFilter : boolean; /** * @deprecated Please use the 'isIncludeNewItemsInFilter' property instead. * Indicates whether to include new items to the field in manual filter. * The default value is false. * @param value - The value to set. */ setIsIncludeNewItemsInFilter(value: boolean) : void; /** * Indicates whether to insert page breaks after each item. * The default value is false. */ isInsertPageBreaksBetweenItems : boolean; /** * @deprecated Please use the 'isInsertPageBreaksBetweenItems' property instead. * Indicates whether to insert page breaks after each item. * The default value is false. * @param value - The value to set. */ setIsInsertPageBreaksBetweenItems(value: boolean) : void; /** * @deprecated Please use the 'showAllItems' property instead. * Indicates whether to display all items in the PivotTable view, * even if they don't contain summary data. * The default value is false. */ getShowAllItems() : boolean; /** * Indicates whether to display all items in the PivotTable view, * even if they don't contain summary data. * The default value is false. */ showAllItems : boolean; /** * @deprecated Please use the 'showAllItems' property instead. * Indicates whether to display all items in the PivotTable view, * even if they don't contain summary data. * The default value is false. * @param value - The value to set. */ setShowAllItems(value: boolean) : void; /** * @deprecated Please use the 'nonAutoSortDefault' property instead. * Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. */ getNonAutoSortDefault() : boolean; /** * Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. */ nonAutoSortDefault : boolean; /** * @deprecated Please use the 'nonAutoSortDefault' property instead. * Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. * @param value - The value to set. */ setNonAutoSortDefault(value: boolean) : void; /** * Indicates whether the items of this PivotTable field are automatically sorted. */ isAutoSort : boolean; /** * @deprecated Please use the 'isAutoSort' property instead. * Indicates whether the items of this PivotTable field are automatically sorted. * @param value - The value to set. */ setIsAutoSort(value: boolean) : void; /** * Indicates whether the items of this pivot field is autosorted ascending. */ isAscendSort : boolean; /** * @deprecated Please use the 'isAscendSort' property instead. * Indicates whether the items of this pivot field is autosorted ascending. * @param value - The value to set. */ setIsAscendSort(value: boolean) : void; /** * @deprecated Please use the 'sortSetting' property instead. * Gets all settings of auto sorting */ getSortSetting() : PivotFieldSortSetting; /** * Gets all settings of auto sorting */ readonly sortSetting : PivotFieldSortSetting; /** * @deprecated Please use the 'autoSortField' property instead. * Represents the index of field which is auto sorted. * -1 means PivotField itself,others means the position of the data fields. */ getAutoSortField() : number; /** * Represents the index of field which is auto sorted. * -1 means PivotField itself,others means the position of the data fields. */ autoSortField : number; /** * @deprecated Please use the 'autoSortField' property instead. * Represents the index of field which is auto sorted. * -1 means PivotField itself,others means the position of the data fields. * @param value - The value to set. */ setAutoSortField(value: number) : void; /** * Indicates whether the specified PivotTable field is automatically shown. * * @remarks * Only valid for excel 2003. */ isAutoShow : boolean; /** * @deprecated Please use the 'isAutoShow' property instead. * Indicates whether the specified PivotTable field is automatically shown. * @param value - The value to set. * * @remarks * Only valid for excel 2003. */ setIsAutoShow(value: boolean) : void; /** * Indicates whether the specified PivotTable field is autoshown ascending. */ isAscendShow : boolean; /** * @deprecated Please use the 'isAscendShow' property instead. * Indicates whether the specified PivotTable field is autoshown ascending. * @param value - The value to set. */ setIsAscendShow(value: boolean) : void; /** * @deprecated Please use the 'autoShowCount' property instead. * Represent the number of top or bottom items * that are automatically shown in the specified PivotTable field. */ getAutoShowCount() : number; /** * Represent the number of top or bottom items * that are automatically shown in the specified PivotTable field. */ autoShowCount : number; /** * @deprecated Please use the 'autoShowCount' property instead. * Represent the number of top or bottom items * that are automatically shown in the specified PivotTable field. * @param value - The value to set. */ setAutoShowCount(value: number) : void; /** * @deprecated Please use the 'autoShowField' property instead. * Represents auto show field index. -1 means PivotField itself. * It should be the index of the data fields. */ getAutoShowField() : number; /** * Represents auto show field index. -1 means PivotField itself. * It should be the index of the data fields. */ autoShowField : number; /** * @deprecated Please use the 'autoShowField' property instead. * Represents auto show field index. -1 means PivotField itself. * It should be the index of the data fields. * @param value - The value to set. */ setAutoShowField(value: number) : void; /** * @deprecated Please use the 'function' property instead. * Represents the function used to summarize this PivotTable data field. */ getFunction() : ConsolidationFunction; /** * Represents the function used to summarize this PivotTable data field. */ function : ConsolidationFunction; /** * @deprecated Please use the 'function' property instead. * Represents the function used to summarize this PivotTable data field. * @param value - The value to set. */ setFunction(value: ConsolidationFunction) : void; /** * @deprecated Please use the 'showValuesSetting' property instead. * Gets the settings of showing values as when the ShowDataAs calculation is in use. */ getShowValuesSetting() : PivotShowValuesSetting; /** * Gets the settings of showing values as when the ShowDataAs calculation is in use. */ readonly showValuesSetting : PivotShowValuesSetting; /** * @deprecated Please use the 'currentPageItem' property instead. * Represents the current selected page item of the page field to filter data. * Only valid for page fields. */ getCurrentPageItem() : number; /** * Represents the current selected page item of the page field to filter data. * Only valid for page fields. */ currentPageItem : number; /** * @deprecated Please use the 'currentPageItem' property instead. * Represents the current selected page item of the page field to filter data. * Only valid for page fields. * @param value - The value to set. */ setCurrentPageItem(value: number) : void; /** * @deprecated Please use the 'insertBlankRow' property instead. * Indicates whether to insert a blank line after each item. */ getInsertBlankRow() : boolean; /** * Indicates whether to insert a blank line after each item. */ insertBlankRow : boolean; /** * @deprecated Please use the 'insertBlankRow' property instead. * Indicates whether to insert a blank line after each item. * @param value - The value to set. */ setInsertBlankRow(value: boolean) : void; /** * @deprecated Please use the 'showSubtotalAtTop' property instead. * Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then * * @remarks * Only works when ShowInOutlineForm is true. */ getShowSubtotalAtTop() : boolean; /** * Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then * * @remarks * Only works when ShowInOutlineForm is true. */ showSubtotalAtTop : boolean; /** * @deprecated Please use the 'showSubtotalAtTop' property instead. * Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then * @param value - The value to set. * * @remarks * Only works when ShowInOutlineForm is true. */ setShowSubtotalAtTop(value: boolean) : void; /** * @deprecated Please use the 'showInOutlineForm' property instead. * Indicates whether to layout this field in outline form on the Pivot Table view. */ getShowInOutlineForm() : boolean; /** * Indicates whether to layout this field in outline form on the Pivot Table view. */ showInOutlineForm : boolean; /** * @deprecated Please use the 'showInOutlineForm' property instead. * Indicates whether to layout this field in outline form on the Pivot Table view. * @param value - The value to set. */ setShowInOutlineForm(value: boolean) : void; /** * @deprecated Please use the 'number' property instead. * Represents the built-in display format of numbers and dates. */ getNumber() : number; /** * Represents the built-in display format of numbers and dates. */ number : number; /** * @deprecated Please use the 'number' property instead. * Represents the built-in display format of numbers and dates. * @param value - The value to set. */ setNumber(value: number) : void; /** * @deprecated Please use the 'numberFormat' property instead. * Represents the custom display format of numbers and dates. */ get_NumberFormat() : string; /** * Represents the custom display format of numbers and dates. */ numberFormat : string; /** * @deprecated Please use the 'numberFormat' property instead. * Represents the custom display format of numbers and dates. * @param value - The value to set. */ setNumberFormat(value: string) : void; /** * @deprecated Please use the 'items' property instead. * Get all labels of pivot items in this field. */ getItems() : string[]; /** * Get all labels of pivot items in this field. */ readonly items : string[]; /** * @deprecated Please use the 'originalItems' property instead. * Get the original base items; */ getOriginalItems() : string[]; /** * Get the original base items; */ readonly originalItems : string[]; /** * @deprecated Please use the 'itemCount' property instead. * Gets the count of the base items in this pivot field. */ getItemCount() : number; /** * Gets the count of the base items in this pivot field. */ readonly itemCount : number; /** * @deprecated Please use the 'showCompact' property instead. * Indicates whether to display labels of the next field in the same column on the Pivot Table view */ getShowCompact() : boolean; /** * Indicates whether to display labels of the next field in the same column on the Pivot Table view */ showCompact : boolean; /** * @deprecated Please use the 'showCompact' property instead. * Indicates whether to display labels of the next field in the same column on the Pivot Table view * @param value - The value to set. */ setShowCompact(value: boolean) : void; /** * Gets the max value of this field. * * @remarks * Only works for row or column fields which value must be date time, number or blank. */ getMaxValue() : CellValue; /** * Gets the max value of this field. * * @remarks * Only works for row or column fields which value must be date time, number or blank. */ getMinValue() : CellValue; /** * Init the pivot items of the pivot field */ initPivotItems() : void; /** * Automatically group the field with internal * @param interval - The internal of group. /// Automatic value will be assigned if it's zero, * @param newField - Indicates whether adding a new field to the pivottable. */ groupBy(interval: number, newField: boolean) : void; /** * Automatically group the field with internal * @param groups - Group types * @param interval - The internal of group. /// Automatic value will be assigned if it's zero, * @param newField - Indicates whether adding a new field to the pivottable. */ groupBy(groups: PivotGroupByType[], interval: number, newField: boolean) : void; /** * Group the file by the date group types. * @param start - The start datetime * @param end - The end of datetime * @param groups - Group types * @param interval - The interval * @param firstAsNewField - Indicates whether adding a new field to the pivottable. /// Only for the first group item. * @returns * False means this field could not be grouped by date time. */ groupBy(start: Date, end: Date, groups: PivotGroupByType[], interval: number, firstAsNewField: boolean) : boolean; /** * Group the file by the date group types. * @param isAutoStart - Indicates whether to auto detect the start date time value. * @param start - The start datetime * @param isAutoEnd - Indicates whether to auto detect the end date time value. * @param end - The end of datetime * @param groups - Group types * @param interval - The interval * @param firstAsNewField - Indicates whether adding a new field to the pivottable. /// Only for the first group item. * @returns * False means this field could not be grouped by date time. */ groupBy(isAutoStart: boolean, start: Date, isAutoEnd: boolean, end: Date, groups: PivotGroupByType[], interval: number, firstAsNewField: boolean) : boolean; /** * Group the file by number. * @param start - The start value * @param end - The end of value * @param interval - The interval * @param newField - Indicates whether adding a new field to the pivottable * @returns * False means this field could not be grouped by date time. * * @remarks */ groupBy(start: number, end: number, interval: number, newField: boolean) : boolean; /** * Group the file by number. * @param isAutoStart - Indicates whether to auto detect the start value. * @param start - The start value * @param isAutoEnd - Indicates whether to auto detect the end value. * @param end - The end of value * @param interval - The interval * @param newField - Indicates whether adding a new field to the pivottable * @returns * False means this field could not be grouped by date time. */ groupBy(isAutoStart: boolean, start: number, isAutoEnd: boolean, end: number, interval: number, newField: boolean) : boolean; /** * Custom group the field. * @param customGroupItems - The custom group items. * @param newField - Indicates whether adding a new field to the pivottable * @returns * False means this field could not be grouped by date time. */ groupBy(customGroupItems: CustomPiovtFieldGroupItem[], newField: boolean) : boolean; /** * Ungroup the pivot field. */ ungroup() : void; /** * Gets the pivot filter of the pivot field by type */ getPivotFilterByType(type: PivotFilterType) : PivotFilter; /** * Gets all pivot filters applied for this pivot field. */ getFilters() : PivotFilter[]; /** * Clears filter setting on this pivot field. */ clearFilter() : void; /** * Filters by values of data pivot field. * @param valueFieldIndex - The index of data field in the data region. * @param type - The type of filtering data. Only can be Count,Sum and Percent. * @param isTop - Indicates whether filter from top or bottom * @param itemCount - The item count */ filterTop10(valueFieldIndex: number, type: PivotFilterType, isTop: boolean, itemCount: number) : PivotFilter; /** * Filters by values of data pivot field. * @param valueFieldIndex - The index of value field in the value region. * @param type - The type of filtering data. * @param value1 - The value of filter condition * @param value2 - The upper-bound value of between filter condition */ filterByValue(valueFieldIndex: number, type: PivotFilterType, value1: number, value2: number) : PivotFilter; /** * Filters by captions of row or column pivot field. * @param type - The type of filtering data. * @param label1 - The label of filter condition * @param label2 - The upper-bound label of between filter condition */ filterByLabel(type: PivotFilterType, label1: string, label2: string) : PivotFilter; /** * Filters by date values of row or column pivot field. * @param type - The type of filtering data. * @param dateTime1 - The date label of filter condition * @param dateTime2 - The upper-bound date label of between filter condition */ filterByDate(type: PivotFilterType, dateTime1: Date, dateTime2: Date) : PivotFilter; /** * Gets the formula of the calculated field . * Only works for calculated field. */ getFormula() : string; /** * Sets how to subtotal the specified field. * @param subtotalType - * @param shown - Whether the specified field shows that subtotals. */ setSubtotals(subtotalType: PivotFieldSubtotalType, shown: boolean) : void; /** * Indicates whether to show specified subtotal for this pivot field. * @param subtotalType - Subtotal type. * @returns * Returns whether showing specified subtotal. */ getSubtotals(subtotalType: PivotFieldSubtotalType) : boolean; /** * Sorts this pivot field. * @param sortType - The type of sorting this field. * @param fieldSortedBy - The index of pivot field sorted by. /// -1 means sorting by data labels of this field, others mean the index of data field sorted by. */ sortBy(sortType: SortOrder, fieldSortedBy: number) : void; /** * Sorts this pivot field. * @param sortType - The type of sorting this field. * @param fieldSortedBy - The index of pivot field sorted by. /// -1 means sorting by data labels of this field, others mean the index of data field sorted by. * @param dataType - The type of data sorted by. * @param cellName - Sort by values in the row or column */ sortBy(sortType: SortOrder, fieldSortedBy: number, dataType: PivotLineType, cellName: string) : void; /** * Shows values of data field as different display format when the ShowDataAs calculation is in use. * @param displayFormat - The data display format type. * @param baseField - The index to the field which ShowDataAs calculation bases on. * @param baseItemPositionType - The position type of base iteam. * @param baseItem - The index to the base item which ShowDataAs calculation bases on. /// Only works when baseItemPositionType is custom. * * @remarks * Only for data field. */ showValuesAs(displayFormat: PivotFieldDataDisplayFormat, baseField: number, baseItemPositionType: PivotItemPositionType, baseItem: number) : void; /** * Gets whether the specific PivotItem is hidden. * @param index - The index of the pivotItem in the pivotField. * @returns * whether the specific PivotItem is hidden */ isHiddenItem(index: number) : boolean; /** * Sets whether the specific PivotItem in a data field is hidden. * @param index - the index of the pivotItem in the pivotField. * @param isHidden - whether the specific PivotItem is hidden */ hideItem(index: number, isHidden: boolean) : void; /** * Sets whether the specific PivotItem in a data field is hidden. * @param itemValue - The name of the pivotItem in the pivotField. * @param isHidden - Whether the specific PivotItem is hidden */ hideItem(itemValue: string, isHidden: boolean) : void; /** * Gets whether to hide the detail of the specific PivotItem.. * @param index - The index of the pivotItem in the pivotField. * @returns * whether the specific PivotItem is hidden detail */ isHiddenItemDetail(index: number) : boolean; /** * Sets whether the specific PivotItem in a pivot field is hidden detail. * @param index - the index of the pivotItem in the pivotField. * @param isHiddenDetail - whether the specific PivotItem is hidden */ hideItemDetail(index: number, isHiddenDetail: boolean) : void; /** * Sets whether the detail of all PivotItems in a pivot field are hidden. * That is collapse/expand this field. * @param isHiddenDetail - Whether hide the detail of the pivot field. */ hideDetail(isHiddenDetail: boolean) : void; /** * Add a calculated formula item to the pivot field. * @param name - The item's name. * @param formula - The formula of pivot item. * * @remarks * Only supports to add calculated item to Row/Column field. */ addCalculatedItem(name: string, formula: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Summary description for PivotTable. */ export class PivotTable { /** * @deprecated Please use the 'pivotCache' property instead. * Gets the data source. */ getPivotCache() : PivotCache; /** * Gets the data source. */ readonly pivotCache : PivotCache; /** * Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, * if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, * it will be truncated. if false, a string will not have the aforementioned restriction. * The default value is true. */ isExcel2003Compatible : boolean; /** * @deprecated Please use the 'isExcel2003Compatible' property instead. * Specifies whether the PivotTable is compatible for Excel2003 when refreshing PivotTable, * if true, a string must be less than or equal to 255 characters, so if the string is greater than 255 characters, * it will be truncated. if false, a string will not have the aforementioned restriction. * The default value is true. * @param value - The value to set. */ setIsExcel2003Compatible(value: boolean) : void; /** * @deprecated Please use the 'refreshedByWho' property instead. * Gets the name of the last user who refreshed this PivotTable */ getRefreshedByWho() : string; /** * Gets the name of the last user who refreshed this PivotTable */ readonly refreshedByWho : string; /** * @deprecated Please use the 'refreshDate' property instead. * Gets the last date time when the PivotTable was refreshed. */ getRefreshDate() : Date; /** * Gets the last date time when the PivotTable was refreshed. */ readonly refreshDate : Date; /** * @deprecated Please use the 'pivotTableStyle' property instead. * Gets settings of this pivot table. */ getPivotTableStyle() : TableStyle; /** * Gets settings of this pivot table. */ pivotTableStyle : TableStyle; /** * @deprecated Please use the 'pivotTableStyle' property instead. * Gets settings of this pivot table. * @param value - The value to set. */ setPivotTableStyle(value: TableStyle) : void; /** * @deprecated Please use the 'pivotTableStyleName' property instead. * Gets and sets the pivottable style name. */ getPivotTableStyleName() : string; /** * Gets and sets the pivottable style name. */ pivotTableStyleName : string; /** * @deprecated Please use the 'pivotTableStyleName' property instead. * Gets and sets the pivottable style name. * @param value - The value to set. */ setPivotTableStyleName(value: string) : void; /** * @deprecated Please use the 'pivotTableStyleType' property instead. * Gets and sets the built-in pivot table style. */ getPivotTableStyleType() : PivotTableStyleType; /** * Gets and sets the built-in pivot table style. */ pivotTableStyleType : PivotTableStyleType; /** * @deprecated Please use the 'pivotTableStyleType' property instead. * Gets and sets the built-in pivot table style. * @param value - The value to set. */ setPivotTableStyleType(value: PivotTableStyleType) : void; /** * @deprecated Please use the 'columnFields' property instead. * Returns a PivotFields object that are currently shown as column fields. */ getColumnFields() : PivotFieldCollection; /** * Returns a PivotFields object that are currently shown as column fields. */ readonly columnFields : PivotFieldCollection; /** * @deprecated Please use the 'rowFields' property instead. * Returns a PivotFields object that are currently shown as row fields. */ getRowFields() : PivotFieldCollection; /** * Returns a PivotFields object that are currently shown as row fields. */ readonly rowFields : PivotFieldCollection; /** * @deprecated Please use the 'pageFields' property instead. * Returns a PivotFields object that are currently shown as page fields. */ getPageFields() : PivotFieldCollection; /** * Returns a PivotFields object that are currently shown as page fields. */ readonly pageFields : PivotFieldCollection; /** * @deprecated Please use the 'dataFields' property instead. * Gets a PivotField object that represents all the data fields in a PivotTable. * Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. * It only use to add DataPivotField to the PivotTable row/column area . Default is in row area. */ getDataFields() : PivotFieldCollection; /** * Gets a PivotField object that represents all the data fields in a PivotTable. * Read-only.It would be init only when there are two or more data fields in the DataPiovtFiels. * It only use to add DataPivotField to the PivotTable row/column area . Default is in row area. */ readonly dataFields : PivotFieldCollection; /** * @deprecated Please use the 'dataField' property instead. * Gets a object that represents all the data fields in a PivotTable. * Read-only. * It would only be created when there are two or more data fields in the Data region. * Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotTable.ValuesField property. * This method will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ValuesField property instead. */ getDataField() : PivotField; /** * Gets a object that represents all the data fields in a PivotTable. * Read-only. * It would only be created when there are two or more data fields in the Data region. * Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotTable.ValuesField property. * This method will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ValuesField property instead. */ readonly dataField : PivotField; /** * @deprecated Please use the 'valuesField' property instead. * Gets a object that represents all the data fields in a PivotTable. * Read-only. * It would only be created when there are two or more data fields in the Data region. * Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . */ getValuesField() : PivotField; /** * Gets a object that represents all the data fields in a PivotTable. * Read-only. * It would only be created when there are two or more data fields in the Data region. * Defaultly it is in row region. You can drag it to the row/column region with PivotTable.AddFieldToArea() method . */ readonly valuesField : PivotField; /** * @deprecated Please use the 'baseFields' property instead. * Returns all base pivot fields in the PivotTable. */ getBaseFields() : PivotFieldCollection; /** * Returns all base pivot fields in the PivotTable. */ readonly baseFields : PivotFieldCollection; /** * @deprecated Please use the 'pivotFilters' property instead. * Returns all filters of pivot fields in the pivot table. */ getPivotFilters() : PivotFilterCollection; /** * Returns all filters of pivot fields in the pivot table. */ readonly pivotFilters : PivotFilterCollection; /** * @deprecated Please use the 'topRightArea' property instead. * Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets). */ getTopRightArea() : CellArea; /** * Represents the blank area at the top-right of the PivotTable (top-left for RTL sheets). */ readonly topRightArea : CellArea; /** * @deprecated Please use the 'filterArea' property instead. * Gets the area of filter region. * * @remarks * Only valid if filter pivot fields exists. * An empty area will be returned if this pivot table does not contains filter pivot fields */ getFilterArea() : CellArea; /** * Gets the area of filter region. * * @remarks * Only valid if filter pivot fields exists. * An empty area will be returned if this pivot table does not contains filter pivot fields */ readonly filterArea : CellArea; /** * @deprecated Please use the 'columnRange' property instead. * Returns a CellArea object that represents the range * that contains the column area in the PivotTable report. Read-only. */ getColumnRange() : CellArea; /** * Returns a CellArea object that represents the range * that contains the column area in the PivotTable report. Read-only. */ readonly columnRange : CellArea; /** * @deprecated Please use the 'rowRange' property instead. * Returns a CellArea object that represents the range * that contains the row area in the PivotTable report. Read-only. */ getRowRange() : CellArea; /** * Returns a CellArea object that represents the range * that contains the row area in the PivotTable report. Read-only. */ readonly rowRange : CellArea; /** * @deprecated Please use the 'dataBodyRange' property instead. * Returns a object that represents the range that contains the data area * in the list between the header row and the insert row. Read-only. */ getDataBodyRange() : CellArea; /** * Returns a object that represents the range that contains the data area * in the list between the header row and the insert row. Read-only. */ readonly dataBodyRange : CellArea; /** * @deprecated Please use the 'tableRange1' property instead. * Returns a CellArea object that represents the range containing the entire PivotTable report, * but doesn't include page fields. Read-only. */ getTableRange1() : CellArea; /** * Returns a CellArea object that represents the range containing the entire PivotTable report, * but doesn't include page fields. Read-only. */ readonly tableRange1 : CellArea; /** * @deprecated Please use the 'tableRange2' property instead. * Returns a CellArea object that represents the range containing the entire PivotTable report, * includes page fields. Read-only. */ getTableRange2() : CellArea; /** * Returns a CellArea object that represents the range containing the entire PivotTable report, * includes page fields. Read-only. */ readonly tableRange2 : CellArea; /** * Indicates whether the PivotTable report displays classic pivottable layout. * (enables dragging fields in the grid) */ isGridDropZones : boolean; /** * @deprecated Please use the 'isGridDropZones' property instead. * Indicates whether the PivotTable report displays classic pivottable layout. * (enables dragging fields in the grid) * @param value - The value to set. */ setIsGridDropZones(value: boolean) : void; /** * @deprecated Please use the 'showColumnGrandTotals' property instead. * Indicates whether to show grand totals for columns of this pivot table. */ getShowColumnGrandTotals() : boolean; /** * Indicates whether to show grand totals for columns of this pivot table. */ showColumnGrandTotals : boolean; /** * @deprecated Please use the 'showColumnGrandTotals' property instead. * Indicates whether to show grand totals for columns of this pivot table. * @param value - The value to set. */ setShowColumnGrandTotals(value: boolean) : void; /** * @deprecated Please use the 'showRowGrandTotals' property instead. * Indicates whether to show grand totals for rows of the pivot table. * * @remarks */ getShowRowGrandTotals() : boolean; /** * Indicates whether to show grand totals for rows of the pivot table. * * @remarks */ showRowGrandTotals : boolean; /** * @deprecated Please use the 'showRowGrandTotals' property instead. * Indicates whether to show grand totals for rows of the pivot table. * @param value - The value to set. * * @remarks */ setShowRowGrandTotals(value: boolean) : void; /** * @deprecated Please use the 'columnGrand' property instead. * Indicates whether the PivotTable report shows grand totals for columns. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowColumnGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowColumnGrandTotals property instead. */ getColumnGrand() : boolean; /** * Indicates whether the PivotTable report shows grand totals for columns. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowColumnGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowColumnGrandTotals property instead. */ columnGrand : boolean; /** * @deprecated Please use the 'columnGrand' property instead. * Indicates whether the PivotTable report shows grand totals for columns. * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowColumnGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowColumnGrandTotals property instead. */ setColumnGrand(value: boolean) : void; /** * @deprecated Please use the 'rowGrand' property instead. * Indicates whether to show grand totals for rows of this pivot table. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowRowGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowRowGrandTotals property instead. */ getRowGrand() : boolean; /** * Indicates whether to show grand totals for rows of this pivot table. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowRowGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowRowGrandTotals property instead. */ rowGrand : boolean; /** * @deprecated Please use the 'rowGrand' property instead. * Indicates whether to show grand totals for rows of this pivot table. * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ShowRowGrandTotals method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ShowRowGrandTotals property instead. */ setRowGrand(value: boolean) : void; /** * @deprecated Please use the 'displayNullString' property instead. * Indicates whether the PivotTable report displays a custom string if the value is null. */ getDisplayNullString() : boolean; /** * Indicates whether the PivotTable report displays a custom string if the value is null. */ displayNullString : boolean; /** * @deprecated Please use the 'displayNullString' property instead. * Indicates whether the PivotTable report displays a custom string if the value is null. * @param value - The value to set. */ setDisplayNullString(value: boolean) : void; /** * @deprecated Please use the 'nullString' property instead. * Gets the string displayed in cells that contain null values * when the DisplayNullString property is true.The default value is an empty string. */ getNullString() : string; /** * Gets the string displayed in cells that contain null values * when the DisplayNullString property is true.The default value is an empty string. */ nullString : string; /** * @deprecated Please use the 'nullString' property instead. * Gets the string displayed in cells that contain null values * when the DisplayNullString property is true.The default value is an empty string. * @param value - The value to set. */ setNullString(value: string) : void; /** * @deprecated Please use the 'displayErrorString' property instead. * Indicates whether the PivotTable report displays a custom string in cells that contain errors. */ getDisplayErrorString() : boolean; /** * Indicates whether the PivotTable report displays a custom string in cells that contain errors. */ displayErrorString : boolean; /** * @deprecated Please use the 'displayErrorString' property instead. * Indicates whether the PivotTable report displays a custom string in cells that contain errors. * @param value - The value to set. */ setDisplayErrorString(value: boolean) : void; /** * @deprecated Please use the 'dataFieldHeaderName' property instead. * Gets and sets the name of the value area field header in the PivotTable. */ getDataFieldHeaderName() : string; /** * Gets and sets the name of the value area field header in the PivotTable. */ dataFieldHeaderName : string; /** * @deprecated Please use the 'dataFieldHeaderName' property instead. * Gets and sets the name of the value area field header in the PivotTable. * @param value - The value to set. */ setDataFieldHeaderName(value: string) : void; /** * @deprecated Please use the 'errorString' property instead. * Gets the string displayed in cells that contain errors * when the DisplayErrorString property is true.The default value is an empty string. */ getErrorString() : string; /** * Gets the string displayed in cells that contain errors * when the DisplayErrorString property is true.The default value is an empty string. */ errorString : string; /** * @deprecated Please use the 'errorString' property instead. * Gets the string displayed in cells that contain errors * when the DisplayErrorString property is true.The default value is an empty string. * @param value - The value to set. */ setErrorString(value: string) : void; /** * Indicates whether the PivotTable report is automatically formatted. * Checkbox "autoformat table " which is in pivottable option for Excel 2003 */ isAutoFormat : boolean; /** * @deprecated Please use the 'isAutoFormat' property instead. * Indicates whether the PivotTable report is automatically formatted. * Checkbox "autoformat table " which is in pivottable option for Excel 2003 * @param value - The value to set. */ setIsAutoFormat(value: boolean) : void; /** * @deprecated Please use the 'autofitColumnWidthOnUpdate' property instead. * Indicates whether autofitting column width on update */ getAutofitColumnWidthOnUpdate() : boolean; /** * Indicates whether autofitting column width on update */ autofitColumnWidthOnUpdate : boolean; /** * @deprecated Please use the 'autofitColumnWidthOnUpdate' property instead. * Indicates whether autofitting column width on update * @param value - The value to set. */ setAutofitColumnWidthOnUpdate(value: boolean) : void; /** * @deprecated Please use the 'autoFormatType' property instead. * Gets and sets the auto format type of PivotTable. */ getAutoFormatType() : PivotTableAutoFormatType; /** * Gets and sets the auto format type of PivotTable. */ autoFormatType : PivotTableAutoFormatType; /** * @deprecated Please use the 'autoFormatType' property instead. * Gets and sets the auto format type of PivotTable. * @param value - The value to set. */ setAutoFormatType(value: PivotTableAutoFormatType) : void; /** * @deprecated Please use the 'mergeLabels' property instead. * Indicates whether row or column titles that span multiple cells should be merged into a single cell. */ getMergeLabels() : boolean; /** * Indicates whether row or column titles that span multiple cells should be merged into a single cell. */ mergeLabels : boolean; /** * @deprecated Please use the 'mergeLabels' property instead. * Indicates whether row or column titles that span multiple cells should be merged into a single cell. * @param value - The value to set. */ setMergeLabels(value: boolean) : void; /** * @deprecated Please use the 'preserveFormatting' property instead. * Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated. */ getPreserveFormatting() : boolean; /** * Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated. */ preserveFormatting : boolean; /** * @deprecated Please use the 'preserveFormatting' property instead. * Indicates whether formatting is preserved when the PivotTable is refreshed or recalculated. * @param value - The value to set. */ setPreserveFormatting(value: boolean) : void; /** * @deprecated Please use the 'showDrill' property instead. * Gets and sets whether showing expand/collapse buttons. */ getShowDrill() : boolean; /** * Gets and sets whether showing expand/collapse buttons. */ showDrill : boolean; /** * @deprecated Please use the 'showDrill' property instead. * Gets and sets whether showing expand/collapse buttons. * @param value - The value to set. */ setShowDrill(value: boolean) : void; /** * @deprecated Please use the 'enableDrilldown' property instead. * Gets whether drilldown is enabled. */ getEnableDrilldown() : boolean; /** * Gets whether drilldown is enabled. */ enableDrilldown : boolean; /** * @deprecated Please use the 'enableDrilldown' property instead. * Gets whether drilldown is enabled. * @param value - The value to set. */ setEnableDrilldown(value: boolean) : void; /** * @deprecated Please use the 'enableFieldDialog' property instead. * Indicates whether the PivotTable Field dialog box is available * when the user double-clicks the PivotTable field. */ getEnableFieldDialog() : boolean; /** * Indicates whether the PivotTable Field dialog box is available * when the user double-clicks the PivotTable field. */ enableFieldDialog : boolean; /** * @deprecated Please use the 'enableFieldDialog' property instead. * Indicates whether the PivotTable Field dialog box is available * when the user double-clicks the PivotTable field. * @param value - The value to set. */ setEnableFieldDialog(value: boolean) : void; /** * @deprecated Please use the 'enableFieldList' property instead. * Indicates whether the field list for the PivotTable is available on the view of Excel. */ getEnableFieldList() : boolean; /** * Indicates whether the field list for the PivotTable is available on the view of Excel. */ enableFieldList : boolean; /** * @deprecated Please use the 'enableFieldList' property instead. * Indicates whether the field list for the PivotTable is available on the view of Excel. * @param value - The value to set. */ setEnableFieldList(value: boolean) : void; /** * @deprecated Please use the 'enableWizard' property instead. * Indicates whether the PivotTable Wizard is available. */ getEnableWizard() : boolean; /** * Indicates whether the PivotTable Wizard is available. */ enableWizard : boolean; /** * @deprecated Please use the 'enableWizard' property instead. * Indicates whether the PivotTable Wizard is available. * @param value - The value to set. */ setEnableWizard(value: boolean) : void; /** * @deprecated Please use the 'subtotalHiddenPageItems' property instead. * Indicates whether hidden page field items in the PivotTable report * are included in row and column subtotals, block totals, and grand totals. * The default value is False. */ getSubtotalHiddenPageItems() : boolean; /** * Indicates whether hidden page field items in the PivotTable report * are included in row and column subtotals, block totals, and grand totals. * The default value is False. */ subtotalHiddenPageItems : boolean; /** * @deprecated Please use the 'subtotalHiddenPageItems' property instead. * Indicates whether hidden page field items in the PivotTable report * are included in row and column subtotals, block totals, and grand totals. * The default value is False. * @param value - The value to set. */ setSubtotalHiddenPageItems(value: boolean) : void; /** * @deprecated Please use the 'grandTotalName' property instead. * Returns the label that is displayed in the grand total column or row heading. * The default value is the string "Grand Total". */ getGrandTotalName() : string; /** * Returns the label that is displayed in the grand total column or row heading. * The default value is the string "Grand Total". */ grandTotalName : string; /** * @deprecated Please use the 'grandTotalName' property instead. * Returns the label that is displayed in the grand total column or row heading. * The default value is the string "Grand Total". * @param value - The value to set. */ setGrandTotalName(value: string) : void; /** * @deprecated Please use the 'manualUpdate' property instead. * Indicates whether the PivotTable report is recalculated only at the user's request. */ getManualUpdate() : boolean; /** * Indicates whether the PivotTable report is recalculated only at the user's request. */ manualUpdate : boolean; /** * @deprecated Please use the 'manualUpdate' property instead. * Indicates whether the PivotTable report is recalculated only at the user's request. * @param value - The value to set. */ setManualUpdate(value: boolean) : void; /** * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.AllowMultipleFiltersPerField property. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.AllowMultipleFiltersPerField property instead. */ isMultipleFieldFilters : boolean; /** * @deprecated Please use the 'isMultipleFieldFilters' property instead. * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.AllowMultipleFiltersPerField property. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.AllowMultipleFiltersPerField property instead. */ setIsMultipleFieldFilters(value: boolean) : void; /** * @deprecated Please use the 'allowMultipleFiltersPerField' property instead. * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. */ getAllowMultipleFiltersPerField() : boolean; /** * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. */ allowMultipleFiltersPerField : boolean; /** * @deprecated Please use the 'allowMultipleFiltersPerField' property instead. * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. * @param value - The value to set. */ setAllowMultipleFiltersPerField(value: boolean) : void; /** * @deprecated Please use the 'missingItemsLimit' property instead. * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. */ getMissingItemsLimit() : PivotMissingItemLimitType; /** * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. */ missingItemsLimit : PivotMissingItemLimitType; /** * @deprecated Please use the 'missingItemsLimit' property instead. * Specifies a boolean value that indicates whether the fields of a PivotTable can have multiple filters set on them. * @param value - The value to set. */ setMissingItemsLimit(value: PivotMissingItemLimitType) : void; /** * @deprecated Please use the 'enableDataValueEditing' property instead. * Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. * Enable cell editing in the values area */ getEnableDataValueEditing() : boolean; /** * Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. * Enable cell editing in the values area */ enableDataValueEditing : boolean; /** * @deprecated Please use the 'enableDataValueEditing' property instead. * Specifies a boolean value that indicates whether the user is allowed to edit the cells in the data area of the pivottable. * Enable cell editing in the values area * @param value - The value to set. */ setEnableDataValueEditing(value: boolean) : void; /** * @deprecated Please use the 'showDataTips' property instead. * Indicates whether tooltips should be displayed for PivotTable data cells. */ getShowDataTips() : boolean; /** * Indicates whether tooltips should be displayed for PivotTable data cells. */ showDataTips : boolean; /** * @deprecated Please use the 'showDataTips' property instead. * Indicates whether tooltips should be displayed for PivotTable data cells. * @param value - The value to set. */ setShowDataTips(value: boolean) : void; /** * @deprecated Please use the 'showMemberPropertyTips' property instead. * Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. */ getShowMemberPropertyTips() : boolean; /** * Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. */ showMemberPropertyTips : boolean; /** * @deprecated Please use the 'showMemberPropertyTips' property instead. * Specifies a boolean value that indicates whether member property information should be omitted from PivotTable tooltips. * @param value - The value to set. */ setShowMemberPropertyTips(value: boolean) : void; /** * @deprecated Please use the 'showValuesRow' property instead. * Indicates whether showing values row. */ getShowValuesRow() : boolean; /** * Indicates whether showing values row. */ showValuesRow : boolean; /** * @deprecated Please use the 'showValuesRow' property instead. * Indicates whether showing values row. * @param value - The value to set. */ setShowValuesRow(value: boolean) : void; /** * @deprecated Please use the 'showEmptyCol' property instead. * Indicates whether to include empty columns in the table */ getShowEmptyCol() : boolean; /** * Indicates whether to include empty columns in the table */ showEmptyCol : boolean; /** * @deprecated Please use the 'showEmptyCol' property instead. * Indicates whether to include empty columns in the table * @param value - The value to set. */ setShowEmptyCol(value: boolean) : void; /** * @deprecated Please use the 'showEmptyRow' property instead. * Indicates whether to include empty rows in the table. */ getShowEmptyRow() : boolean; /** * Indicates whether to include empty rows in the table. */ showEmptyRow : boolean; /** * @deprecated Please use the 'showEmptyRow' property instead. * Indicates whether to include empty rows in the table. * @param value - The value to set. */ setShowEmptyRow(value: boolean) : void; /** * @deprecated Please use the 'fieldListSortAscending' property instead. * Indicates whether fields in the PivotTable are sorted in non-default order in the field list. */ getFieldListSortAscending() : boolean; /** * Indicates whether fields in the PivotTable are sorted in non-default order in the field list. */ fieldListSortAscending : boolean; /** * @deprecated Please use the 'fieldListSortAscending' property instead. * Indicates whether fields in the PivotTable are sorted in non-default order in the field list. * @param value - The value to set. */ setFieldListSortAscending(value: boolean) : void; /** * @deprecated Please use the 'printDrill' property instead. * Specifies a boolean value that indicates whether drill indicators should be printed. * Print expand/collapse buttons when displayed on pivottable. */ getPrintDrill() : boolean; /** * Specifies a boolean value that indicates whether drill indicators should be printed. * Print expand/collapse buttons when displayed on pivottable. */ printDrill : boolean; /** * @deprecated Please use the 'printDrill' property instead. * Specifies a boolean value that indicates whether drill indicators should be printed. * Print expand/collapse buttons when displayed on pivottable. * @param value - The value to set. */ setPrintDrill(value: boolean) : void; /** * @deprecated Please use the 'altTextTitle' property instead. * Gets and sets the title of the alter text. */ getAltTextTitle() : string; /** * Gets and sets the title of the alter text. */ altTextTitle : string; /** * @deprecated Please use the 'altTextTitle' property instead. * Gets and sets the title of the alter text. * @param value - The value to set. */ setAltTextTitle(value: string) : void; /** * @deprecated Please use the 'altTextDescription' property instead. * Gets the description of the alt text. */ getAltTextDescription() : string; /** * Gets the description of the alt text. */ altTextDescription : string; /** * @deprecated Please use the 'altTextDescription' property instead. * Gets the description of the alt text. * @param value - The value to set. */ setAltTextDescription(value: string) : void; /** * @deprecated Please use the 'name' property instead. * Gets the name of the PivotTable */ getName() : string; /** * Gets the name of the PivotTable */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets the name of the PivotTable * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'columnHeaderCaption' property instead. * Gets and sets the custom Caption of the Column Header of the PivotTable. */ getColumnHeaderCaption() : string; /** * Gets and sets the custom Caption of the Column Header of the PivotTable. */ columnHeaderCaption : string; /** * @deprecated Please use the 'columnHeaderCaption' property instead. * Gets and sets the custom Caption of the Column Header of the PivotTable. * @param value - The value to set. */ setColumnHeaderCaption(value: string) : void; /** * @deprecated Please use the 'indent' property instead. * Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. */ getIndent() : number; /** * Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. */ indent : number; /** * @deprecated Please use the 'indent' property instead. * Specifies the indentation increment for compact axis and can be used to set the Report Layout to Compact Form. * @param value - The value to set. */ setIndent(value: number) : void; /** * @deprecated Please use the 'rowHeaderCaption' property instead. * Gets and sets custom caption of the Row Header in this PivotTable. */ getRowHeaderCaption() : string; /** * Gets and sets custom caption of the Row Header in this PivotTable. */ rowHeaderCaption : string; /** * @deprecated Please use the 'rowHeaderCaption' property instead. * Gets and sets custom caption of the Row Header in this PivotTable. * @param value - The value to set. */ setRowHeaderCaption(value: string) : void; /** * @deprecated Please use the 'showRowHeaderCaption' property instead. * Indicates whether row header caption is shown in the PivotTable report * Indicates whether Display field captions and filter drop downs * @deprecated * Use PivotTable.ShowHeaders property instead. */ getShowRowHeaderCaption() : boolean; /** * Indicates whether row header caption is shown in the PivotTable report * Indicates whether Display field captions and filter drop downs * @deprecated * Use PivotTable.ShowHeaders property instead. */ showRowHeaderCaption : boolean; /** * @deprecated Please use the 'showRowHeaderCaption' property instead. * Indicates whether row header caption is shown in the PivotTable report * Indicates whether Display field captions and filter drop downs * @param value - The value to set. * @deprecated * Use PivotTable.ShowHeaders property instead. */ setShowRowHeaderCaption(value: boolean) : void; /** * @deprecated Please use the 'customListSort' property instead. * Indicates whether consider built-in custom list when sort data */ getCustomListSort() : boolean; /** * Indicates whether consider built-in custom list when sort data */ customListSort : boolean; /** * @deprecated Please use the 'customListSort' property instead. * Indicates whether consider built-in custom list when sort data * @param value - The value to set. */ setCustomListSort(value: boolean) : void; /** * @deprecated Please use the 'pivotFormatConditions' property instead. * Gets the Format Conditions of the pivot table. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ConditionalFormats property. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ConditionalFormats property instead. */ getPivotFormatConditions() : PivotFormatConditionCollection; /** * Gets the Format Conditions of the pivot table. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.ConditionalFormats property. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.ConditionalFormats property instead. */ readonly pivotFormatConditions : PivotFormatConditionCollection; /** * @deprecated Please use the 'conditionalFormats' property instead. * Gets the conditional formats of the pivot table. */ getConditionalFormats() : PivotConditionalFormatCollection; /** * Gets the conditional formats of the pivot table. */ readonly conditionalFormats : PivotConditionalFormatCollection; /** * @deprecated Please use the 'pageFieldOrder' property instead. * Gets and sets the order in which page fields are added to the PivotTable report's layout. */ getPageFieldOrder() : PrintOrderType; /** * Gets and sets the order in which page fields are added to the PivotTable report's layout. */ pageFieldOrder : PrintOrderType; /** * @deprecated Please use the 'pageFieldOrder' property instead. * Gets and sets the order in which page fields are added to the PivotTable report's layout. * @param value - The value to set. */ setPageFieldOrder(value: PrintOrderType) : void; /** * @deprecated Please use the 'pageFieldWrapCount' property instead. * Gets the number of page fields in each column or row in the PivotTable report. */ getPageFieldWrapCount() : number; /** * Gets the number of page fields in each column or row in the PivotTable report. */ pageFieldWrapCount : number; /** * @deprecated Please use the 'pageFieldWrapCount' property instead. * Gets the number of page fields in each column or row in the PivotTable report. * @param value - The value to set. */ setPageFieldWrapCount(value: number) : void; /** * @deprecated Please use the 'tag' property instead. * Gets and sets a user-defined string that is associated with this PivotTable view. */ getTag() : string; /** * Gets and sets a user-defined string that is associated with this PivotTable view. */ tag : string; /** * @deprecated Please use the 'tag' property instead. * Gets and sets a user-defined string that is associated with this PivotTable view. * @param value - The value to set. */ setTag(value: string) : void; /** * @deprecated Please use the 'saveData' property instead. * Indicates whether data for the PivotTable report is saved with the workbook. */ getSaveData() : boolean; /** * Indicates whether data for the PivotTable report is saved with the workbook. */ saveData : boolean; /** * @deprecated Please use the 'saveData' property instead. * Indicates whether data for the PivotTable report is saved with the workbook. * @param value - The value to set. */ setSaveData(value: boolean) : void; /** * @deprecated Please use the 'refreshDataOnOpeningFile' property instead. * Indicates whether Refresh Data when Opening File. */ getRefreshDataOnOpeningFile() : boolean; /** * Indicates whether Refresh Data when Opening File. */ refreshDataOnOpeningFile : boolean; /** * @deprecated Please use the 'refreshDataOnOpeningFile' property instead. * Indicates whether Refresh Data when Opening File. * @param value - The value to set. */ setRefreshDataOnOpeningFile(value: boolean) : void; /** * @deprecated Please use the 'refreshDataFlag' property instead. * Indicates whether Refreshing Data or not. * * @remarks * NOTE: This method is now obsolete. Instead, * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Simply remove this calling. */ getRefreshDataFlag() : boolean; /** * Indicates whether Refreshing Data or not. * * @remarks * NOTE: This method is now obsolete. Instead, * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Simply remove this calling. */ refreshDataFlag : boolean; /** * @deprecated Please use the 'refreshDataFlag' property instead. * Indicates whether Refreshing Data or not. * @param value - The value to set. * * @remarks * NOTE: This method is now obsolete. Instead, * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Simply remove this calling. */ setRefreshDataFlag(value: boolean) : void; /** * @deprecated Please use the 'sourceType' property instead. * Gets the data source type of the pivot table. */ getSourceType() : PivotTableSourceType; /** * Gets the data source type of the pivot table. */ readonly sourceType : PivotTableSourceType; /** * @deprecated Please use the 'externalConnectionDataSource' property instead. * Gets the external connection data source. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.GetSourceDataConnections() method. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.GetSourceDataConnections() method instead. */ getExternalConnectionDataSource() : ExternalConnection; /** * Gets the external connection data source. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.GetSourceDataConnections() method. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.GetSourceDataConnections() method instead. */ readonly externalConnectionDataSource : ExternalConnection; /** * @deprecated Please use the 'dataSource' property instead. * Gets and sets the data source of the pivot table. */ getDataSource() : string[]; /** * Gets and sets the data source of the pivot table. */ dataSource : string[]; /** * @deprecated Please use the 'dataSource' property instead. * Gets and sets the data source of the pivot table. * @param value - The value to set. */ setDataSource(value: string[]) : void; /** * @deprecated Please use the 'pivotFormats' property instead. * Gets all formats applied to PivotTable. */ getPivotFormats() : PivotTableFormatCollection; /** * Gets all formats applied to PivotTable. */ readonly pivotFormats : PivotTableFormatCollection; /** * @deprecated Please use the 'itemPrintTitles' property instead. * Indicates whether PivotItem names should be repeated at the top of each printed page. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.RepeatItemsOnEachPrintedPage property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.RepeatItemsOnEachPrintedPage property instead. */ getItemPrintTitles() : boolean; /** * Indicates whether PivotItem names should be repeated at the top of each printed page. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.RepeatItemsOnEachPrintedPage property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.RepeatItemsOnEachPrintedPage property instead. */ itemPrintTitles : boolean; /** * @deprecated Please use the 'itemPrintTitles' property instead. * Indicates whether PivotItem names should be repeated at the top of each printed page. * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.RepeatItemsOnEachPrintedPage property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.RepeatItemsOnEachPrintedPage property instead. */ setItemPrintTitles(value: boolean) : void; /** * @deprecated Please use the 'repeatItemsOnEachPrintedPage' property instead. * Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. */ getRepeatItemsOnEachPrintedPage() : boolean; /** * Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. */ repeatItemsOnEachPrintedPage : boolean; /** * @deprecated Please use the 'repeatItemsOnEachPrintedPage' property instead. * Indicates whether captions of pivot item on the row area are repeated on each printed page for pivot fields in tabular form. * @param value - The value to set. */ setRepeatItemsOnEachPrintedPage(value: boolean) : void; /** * @deprecated Please use the 'printTitles' property instead. * Indicates whether the print titles for the worksheet are set based * on the PivotTable report. The default value is false. */ getPrintTitles() : boolean; /** * Indicates whether the print titles for the worksheet are set based * on the PivotTable report. The default value is false. */ printTitles : boolean; /** * @deprecated Please use the 'printTitles' property instead. * Indicates whether the print titles for the worksheet are set based * on the PivotTable report. The default value is false. * @param value - The value to set. */ setPrintTitles(value: boolean) : void; /** * @deprecated Please use the 'displayImmediateItems' property instead. * Indicates whether items in the row and column areas are visible * when the data area of the PivotTable is empty. The default value is true. */ getDisplayImmediateItems() : boolean; /** * Indicates whether items in the row and column areas are visible * when the data area of the PivotTable is empty. The default value is true. */ displayImmediateItems : boolean; /** * @deprecated Please use the 'displayImmediateItems' property instead. * Indicates whether items in the row and column areas are visible * when the data area of the PivotTable is empty. The default value is true. * @param value - The value to set. */ setDisplayImmediateItems(value: boolean) : void; /** * Indicates whether this PivotTable is selected. */ isSelected : boolean; /** * @deprecated Please use the 'isSelected' property instead. * Indicates whether this PivotTable is selected. * @param value - The value to set. */ setIsSelected(value: boolean) : void; /** * @deprecated Please use the 'showPivotStyleRowHeader' property instead. * Indicates whether the row header in the pivot table should have the style applied. */ getShowPivotStyleRowHeader() : boolean; /** * Indicates whether the row header in the pivot table should have the style applied. */ showPivotStyleRowHeader : boolean; /** * @deprecated Please use the 'showPivotStyleRowHeader' property instead. * Indicates whether the row header in the pivot table should have the style applied. * @param value - The value to set. */ setShowPivotStyleRowHeader(value: boolean) : void; /** * @deprecated Please use the 'showPivotStyleColumnHeader' property instead. * Indicates whether the column header in the pivot table should have the style applied. */ getShowPivotStyleColumnHeader() : boolean; /** * Indicates whether the column header in the pivot table should have the style applied. */ showPivotStyleColumnHeader : boolean; /** * @deprecated Please use the 'showPivotStyleColumnHeader' property instead. * Indicates whether the column header in the pivot table should have the style applied. * @param value - The value to set. */ setShowPivotStyleColumnHeader(value: boolean) : void; /** * @deprecated Please use the 'showPivotStyleRowStripes' property instead. * Indicates whether row stripe formatting is applied. */ getShowPivotStyleRowStripes() : boolean; /** * Indicates whether row stripe formatting is applied. */ showPivotStyleRowStripes : boolean; /** * @deprecated Please use the 'showPivotStyleRowStripes' property instead. * Indicates whether row stripe formatting is applied. * @param value - The value to set. */ setShowPivotStyleRowStripes(value: boolean) : void; /** * @deprecated Please use the 'showPivotStyleColumnStripes' property instead. * Indicates whether stripe formatting is applied for column. */ getShowPivotStyleColumnStripes() : boolean; /** * Indicates whether stripe formatting is applied for column. */ showPivotStyleColumnStripes : boolean; /** * @deprecated Please use the 'showPivotStyleColumnStripes' property instead. * Indicates whether stripe formatting is applied for column. * @param value - The value to set. */ setShowPivotStyleColumnStripes(value: boolean) : void; /** * @deprecated Please use the 'showPivotStyleLastColumn' property instead. * Indicates whether the column formatting is applied. */ getShowPivotStyleLastColumn() : boolean; /** * Indicates whether the column formatting is applied. */ showPivotStyleLastColumn : boolean; /** * @deprecated Please use the 'showPivotStyleLastColumn' property instead. * Indicates whether the column formatting is applied. * @param value - The value to set. */ setShowPivotStyleLastColumn(value: boolean) : void; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Copies named style from another pivot table. * @param pivotTable - Source pivot table. */ copyStyle(pivotTable: PivotTable) : void; /** * Show all the report filter pages according to PivotField, the PivotField must be located in the PageFields. * @param pageField - The PivotField object */ showReportFilterPage(pageField: PivotField) : void; /** * Show all the report filter pages according to PivotField's name, the PivotField must be located in the PageFields. * @param fieldName - The name of PivotField */ showReportFilterPageByName(fieldName: string) : void; /** * Show all the report filter pages according to the position index in the PageFields * @param posIndex - The position index in the PageFields */ showReportFilterPageByIndex(posIndex: number) : void; /** * Removes a field from specific field area * @param fieldType - The fields area type. * @param fieldName - The name in the base fields. */ removeField(fieldType: PivotFieldType, fieldName: string) : void; /** * Removes a field from specific field area * @param fieldType - The fields area type. * @param baseFieldIndex - The field index in the base fields. */ removeField(fieldType: PivotFieldType, baseFieldIndex: number) : void; /** * Remove field from specific field area * @param fieldType - the fields area type. * @param pivotField - the field in the base fields. */ removeField(fieldType: PivotFieldType, pivotField: PivotField) : void; /** * Adds the field to the specific area. * @param fieldType - The fields area type. * @param fieldName - The name in the base fields. * @returns * The field position in the specific fields.If there is no field named as it, return -1. */ addFieldToArea(fieldType: PivotFieldType, fieldName: string) : number; /** * Adds the field to the specific area. * @param fieldType - The fields area type. * @param baseFieldIndex - The field index in the base fields. * @returns * The field position in the specific fields. */ addFieldToArea(fieldType: PivotFieldType, baseFieldIndex: number) : number; /** * Adds the field to the specific area. * @param fieldType - the fields area type. * @param pivotField - the field in the base fields. * @returns * the field position in the specific fields. */ addFieldToArea(fieldType: PivotFieldType, pivotField: PivotField) : number; /** * Adds a calculated field to pivot field. * @param name - The name of the calculated field * @param formula - The formula of the calculated field. * @param dragToDataArea - True,drag this field to data area immediately */ addCalculatedField(name: string, formula: string, dragToDataArea: boolean) : void; /** * Adds a calculated field to pivot field and drag it to data area. * @param name - The name of the calculated field * @param formula - The formula of the calculated field. */ addCalculatedField(name: string, formula: string) : void; /** * Gets the specific pivot field list by the region. * @param fieldType - the region type. * @returns * the specific pivot field collection */ getFields(fieldType: PivotFieldType) : PivotFieldCollection; /** * Gets the area contains field button. * @param axisType - The region type. */ getButtonArea(axisType: PivotFieldType) : CellArea; /** * Moves the PivotTable to a different location in the worksheet. * @param row - row index. * @param column - column index. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.MoveTo() method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.MoveTo() method instead. */ move(row: number, column: number) : void; /** * Moves the PivotTable to a different location in the worksheet. * @param destCellName - the dest cell name. * * @remarks * NOTE: This property is now obsolete. Instead, * please use PivotTable.MoveTo() method. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.MoveTo() method instead. */ move(destCellName: string) : void; /** * Moves the PivotTable to a different location in the worksheet. * @param row - row index. * @param column - column index. */ moveTo(row: number, column: number) : void; /** * Moves the PivotTable to a different location in the worksheet. * @param destCellName - the dest cell name. */ moveTo(destCellName: string) : void; /** * Gets the external connection data sources. */ getSourceDataConnections() : ExternalConnection[]; /** * Gets the names of external source data connections. */ getNamesOfSourceDataConnections() : string[]; /** * Change data source of the pivottable. */ changeDataSource(source: string[]) : void; /** * Get the data source of this pivottable. */ getSource() : string[]; /** * Get the data source of this pivottable. * @param isOriginal - Indicates whether to return original or display data source. */ getSource(isOriginal: boolean) : string[]; /** * Refreshes data from it's data source to pivot cache. * * @remarks * We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. * And it's better that you can simply call to refresh and calculate all pivot tables in the file, not to refresh one by one. * NOTE: This method is now obsolete. Instead, * please use method and remove followed * because this pivot table will be caclualted when refreshing . * This method will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotCache.RefreshData() method instead. */ refreshData() : PivotRefreshState; /** * Refreshes pivottable's data and setting from it's data source with options. * @param option - The options for refreshing data source of pivot table. * * @remarks * We will gather data from data source to a pivot cache ,then calculate the data in the cache to the cells. * And it's better that you can simply call to refresh and calculate all pivot tables in the file, not to refresh one by one. * NOTE: This method is now obsolete. Instead, * please use method and remove followed * because this pivot table will be caclualted when refreshing * This method will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotCache.RefreshData() method instead. */ refreshData(option: PivotTableRefreshOption) : PivotRefreshState; /** * Calculates data of pivottable to cells. * * @remarks * This method only calculate data with the cached data in the . * So if you want to calcualte with latest data source, please use method to calculate. * If only the setting of pivot table is changed, is enough. */ calculateData() : void; /** * Calculates pivot table with options. * @param option - The options for calculating the pivot table * @returns * Returns all pivot tables which have been calculated. * If is true,all pivot tables based on same pivot cache will be calculated together. * * @remarks * If is true, * this method will refresh pivot cache from data source,then calculate all pivot tables based same pivot cache. * Otherwise, only calculating with the cached data in the pivot cache. */ calculateData(option: PivotTableCalculateOption) : PivotTable[]; /** * Gets all pivot tables with same pivot cache. */ getPivotTablesWithSamePivotCache() : PivotTable[]; /** * Clear data and formatting of PivotTable view. * * @remarks * If this method is not called before you add or delete PivotField, Maybe the PivotTable data is not corrected */ clearData() : void; /** * Clears all filters of this pivot table. */ clearFilters() : void; /** * Remove all fields from regions. */ clearAll() : void; /** * Calculates pivottable's range. * * @remarks * If this method is not been called,maybe the pivottable range is not corrected. */ calculateRange() : void; /** * Format all the cell in the pivottable area * @param style - Style which is to format */ formatAll(style: Style) : void; /** * Format the row data in the pivottable area * @param row - Row Index of the Row object * @param style - Style which is to format */ formatRow(row: number, style: Style) : void; /** * Formats selected area of the PivotTable. * @param pivotArea - The selected pivot view area. * @param style - The formatted setting. */ format(pivotArea: PivotArea, style: Style) : void; /** * Formats selected area of the PivotTable. * @param ca - The range of the cells. * @param style - The style */ format(ca: CellArea, style: Style) : void; /** * Formats the cell in the pivottable area * @param row - Row Index of the cell * @param column - Column index of the cell * @param style - Style which is to format the cell */ format(row: number, column: number, style: Style) : void; /** * Select an area of pivot table view. * @param ca - The cell area. */ selectArea(ca: CellArea) : PivotAreaCollection; /** * Show the detail of one item in the data region to a new Table. * @param rowOffset - Offset to the first data row in the data region. * @param columnOffset - Offset to the first data column in the data region. * @param newSheet - Show the detail to a new worksheet. * @param destRow - The target row. * @param destColumn - The target column. */ showDetail(rowOffset: number, columnOffset: number, newSheet: boolean, destRow: number, destColumn: number) : void; /** * Gets horizontal page breaks of this pivot table. */ getHorizontalPageBreaks() : number[]; /** * Layouts the PivotTable view in compact form. */ showInCompactForm() : void; /** * Layouts the PivotTable in outline form. */ showInOutlineForm() : void; /** * Layouts the PivotTable in tabular form. */ showInTabularForm() : void; /** * Gets the object by the display name of PivotField. * @param displayName - the DisplayName of PivotField * @returns * the Cell object */ getCellByDisplayName(displayName: string) : Cell; /** * Gets all s that use this PivotTable as their data source. * * @remarks * Because pivot tables may depend on each other's data, * they must be refreshed in the correct order to ensure data consistency. */ getDependentPivotTables() : PivotTable[]; /** * Gets the Children Pivot Tables which use this PivotTable data as data source. * @returns * the PivotTable array object * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotTable.GetDependentPivotTables() method. * This method will be removed 12 months later since April 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotTable.GetDependentPivotTables() method instead. */ getChildren() : PivotTable[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Strategy option for duplicate names of columns. * * @remarks * When processing data with headers, some scenarios require the headers to be no duplication for all columns. * For example, when exporting data to a datatable and the header is required to be taken as datatable's column name, * duplicated values of the header are invalid. * For such kind of situations, user may determine how to handle them by specifying this strategy. */ export enum RenameStrategy { /** * Throws exception. */ Exception = 0, /** * Named with digit. Duplicated names will become ...1, ...2, etc. */ Digit = 1, /** * Named with letter.. Duplicated names will become ...A, ...B, etc. */ Letter = 2, } /** * Specifies how to handle formatting from the HTML source */ export enum HtmlFormatHandlingType { /** * Transfer all HTML formatting into the worksheet along with data. */ All = 0, /** * Bring data in as unformatted text (setting data types still occurs). */ None = 1, /** * Translate HTML formatting to rich text formatting on the data brought into the worksheet. */ Rtf = 2, } /** * Specifies a type of optimization. */ export enum PdfOptimizationType { /** * High print quality */ Standard = 0, /** * File size is more important than print quality * * @remarks * Font Arial and Times New Roman with characters 32-127 will not be embedded in pdf. * Border lines are optimized for smaller file size. */ MinimumSize = 1, } /** * Specifies the unit of measurement. */ export enum CellsUnitType { /** * Measurement is in pixels. */ Pixel = 1, /** * Measurement is in points. A point represents 1/72 of an inch. */ Point = 2, /** * Measurement is in inches. */ Inch = 4, /** * Measurement is in centimeters. */ Cm = 6, /** * In unit of characters. * * @remarks * Only for width. */ Character = 7, } /** * Represents the options of loading metadata of the file. */ export class MetadataOptions { /** * Creates an options of loading the metadata. * @param metadataType - The type of metadata. */ constructor(metadataType: MetadataType); /** * @deprecated Please use the 'metadataType' property instead. * Gets and sets the type of the metadata which is loading. */ getMetadataType() : MetadataType; /** * Gets and sets the type of the metadata which is loading. */ readonly metadataType : MetadataType; /** * @deprecated Please use the 'password' property instead. * Represents Workbook file encryption password. */ getPassword() : string; /** * Represents Workbook file encryption password. */ password : string; /** * @deprecated Please use the 'password' property instead. * Represents Workbook file encryption password. * @param value - The value to set. */ setPassword(value: string) : void; /** * @deprecated Please use the 'keyLength' property instead. * The key length. */ getKeyLength() : number; /** * The key length. */ keyLength : number; /** * @deprecated Please use the 'keyLength' property instead. * The key length. * @param value - The value to set. */ setKeyLength(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of metadata. */ export enum MetadataType { /** * Encrypts the file. */ Encryption = 1, /** * Decrypts the file. */ Decryption = 2, /** * Load the properties of the file. */ Document_Properties = 4, } /** * Represents the meta data. */ export class WorkbookMetadata { /** * Create the meta data object. * @param fileName - * @param options - */ constructor(fileName: string, options: MetadataOptions); /** * Create the meta data object. * @param stream - * @param options - */ constructor(stream: Uint8Array, options: MetadataOptions); /** * @deprecated Please use the 'options' property instead. * Gets the options of the metadata. */ getOptions() : MetadataOptions; /** * Gets the options of the metadata. */ readonly options : MetadataOptions; /** * @deprecated Please use the 'builtInDocumentProperties' property instead. * Returns a collection that represents all the built-in document properties of the spreadsheet. */ getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection; /** * Returns a collection that represents all the built-in document properties of the spreadsheet. */ readonly builtInDocumentProperties : BuiltInDocumentPropertyCollection; /** * @deprecated Please use the 'customDocumentProperties' property instead. * Returns a collection that represents all the custom document properties of the spreadsheet. */ getCustomDocumentProperties() : CustomDocumentPropertyCollection; /** * Returns a collection that represents all the custom document properties of the spreadsheet. */ readonly customDocumentProperties : CustomDocumentPropertyCollection; /** * Save the modified metadata to the file. * @param fileName - The file name. */ save(fileName: string) : void; /** * Save the modified metadata to the stream. * @param stream - The stream. */ save(stream: Uint8Array) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies how to apply style for the value of the cell. */ export enum CellValueFormatStrategy { /** * Not formatted. */ None = 0, /** * Only formatted with the cell's original style. */ CellStyle = 1, /** * Formatted with the cell's displayed style. */ DisplayStyle = 2, /** * Gets the displayed string shown in ms excel. * The main difference from is this option also considers the effect of column width. * If the column width is too small to show the formatted string completely, * "#" may be shown, just like what ms excel does. */ DisplayString = 3, } /** * Represents a complex type that specifies the pivot controls that appear on the chart */ export class PivotOptions { /** * @deprecated Please use the 'showExpandCollapseFieldButtons' property instead. * Gets or sets a value indicating whether to show expand or collapse field buttons */ getShowExpandCollapseFieldButtons() : boolean; /** * Gets or sets a value indicating whether to show expand or collapse field buttons */ showExpandCollapseFieldButtons : boolean; /** * @deprecated Please use the 'showExpandCollapseFieldButtons' property instead. * Gets or sets a value indicating whether to show expand or collapse field buttons * @param value - The value to set. */ setShowExpandCollapseFieldButtons(value: boolean) : void; /** * @deprecated Please use the 'dropZoneFilter' property instead. * Specifies whether a control for each PivotTable field on the PivotTable page axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ getDropZoneFilter() : boolean; /** * Specifies whether a control for each PivotTable field on the PivotTable page axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ dropZoneFilter : boolean; /** * @deprecated Please use the 'dropZoneFilter' property instead. * Specifies whether a control for each PivotTable field on the PivotTable page axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. * @param value - The value to set. */ setDropZoneFilter(value: boolean) : void; /** * @deprecated Please use the 'dropZoneCategories' property instead. * Specifies whether a control for each PivotTable field on the PivotTable row axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ getDropZoneCategories() : boolean; /** * Specifies whether a control for each PivotTable field on the PivotTable row axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ dropZoneCategories : boolean; /** * @deprecated Please use the 'dropZoneCategories' property instead. * Specifies whether a control for each PivotTable field on the PivotTable row axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. * @param value - The value to set. */ setDropZoneCategories(value: boolean) : void; /** * @deprecated Please use the 'dropZoneData' property instead. * Specifies whether a control for each PivotTable field on the PivotTable data axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ getDropZoneData() : boolean; /** * Specifies whether a control for each PivotTable field on the PivotTable data axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ dropZoneData : boolean; /** * @deprecated Please use the 'dropZoneData' property instead. * Specifies whether a control for each PivotTable field on the PivotTable data axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. * @param value - The value to set. */ setDropZoneData(value: boolean) : void; /** * @deprecated Please use the 'dropZoneSeries' property instead. * Specifies whether a control for each PivotTable field on the PivotTable column axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ getDropZoneSeries() : boolean; /** * Specifies whether a control for each PivotTable field on the PivotTable column axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. */ dropZoneSeries : boolean; /** * @deprecated Please use the 'dropZoneSeries' property instead. * Specifies whether a control for each PivotTable field on the PivotTable column axis * of the source PivotTable appears on the chart when dropZonesVisible is set to true. * @param value - The value to set. */ setDropZoneSeries(value: boolean) : void; /** * @deprecated Please use the 'dropZonesVisible' property instead. * Specifies whether any pivot controls can appear on the pivot chart. */ getDropZonesVisible() : boolean; /** * Specifies whether any pivot controls can appear on the pivot chart. */ dropZonesVisible : boolean; /** * @deprecated Please use the 'dropZonesVisible' property instead. * Specifies whether any pivot controls can appear on the pivot chart. * @param value - The value to set. */ setDropZonesVisible(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the persistence method to persist an ActiveX control. */ export enum ActiveXPersistenceType { /** * The data is stored as xml data. */ PropertyBag = 0, /** * The data is stored as a storage binary data. */ Storage = 1, /** * The data is stored as a stream binary data. */ Stream = 2, /** * The data is stored as a streaminit binary data. */ StreamInit = 3, } /** * Represents the symbol displayed on the drop button. */ export enum DropButtonStyle { /** * Displays a button with no symbol. */ Plain = 0, /** * Displays a button with a down arrow. */ Arrow = 1, /** * Displays a button with an ellipsis (...). */ Ellipsis = 2, /** * Displays a button with a horizontal line like an underscore character. */ Reduce = 3, } /** * Specifies when to show the drop button */ export enum ShowDropButtonType { /** * Never show the drop button. */ Never = 0, /** * Show the drop button when the control has the focus. */ Focus = 1, /** * Always show the drop button. */ Always = 2, } /** * Represents the ActiveX control. */ export class ActiveXControl extends ActiveXControlBase { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControlBase); /** * Indicates whether the control can receive the focus and respond to user-generated events. */ isEnabled : boolean; /** * @deprecated Please use the 'isEnabled' property instead. * Indicates whether the control can receive the focus and respond to user-generated events. * @param value - The value to set. */ setIsEnabled(value: boolean) : void; /** * Indicates whether data in the control is locked for editing. */ isLocked : boolean; /** * @deprecated Please use the 'isLocked' property instead. * Indicates whether data in the control is locked for editing. * @param value - The value to set. */ setIsLocked(value: boolean) : void; /** * Indicates whether the control is transparent. */ isTransparent : boolean; /** * @deprecated Please use the 'isTransparent' property instead. * Indicates whether the control is transparent. * @param value - The value to set. */ setIsTransparent(value: boolean) : void; /** * Indicates whether the control will automatically resize to display its entire contents. */ isAutoSize() : boolean; /** * Indicates whether the control will automatically resize to display its entire contents. * @param value - The value to set. */ setIsAutoSize(value: boolean) : void; /** * @deprecated Please use the 'iMEMode' property instead. * Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. */ getIMEMode() : InputMethodEditorMode; /** * Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. */ iMEMode : InputMethodEditorMode; /** * @deprecated Please use the 'iMEMode' property instead. * Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. * @param value - The value to set. */ setIMEMode(value: InputMethodEditorMode) : void; /** * @deprecated Please use the 'font' property instead. * Represents the font of the control. */ getFont() : Font; /** * Represents the font of the control. */ readonly font : Font; /** * @deprecated Please use the 'textAlign' property instead. * Represents how to align the text used by the control. */ getTextAlign() : TextAlignmentType; /** * Represents how to align the text used by the control. */ textAlign : TextAlignmentType; /** * @deprecated Please use the 'textAlign' property instead. * Represents how to align the text used by the control. * @param value - The value to set. */ setTextAlign(value: TextAlignmentType) : void; /** * Gets and sets the binary data of the control. */ getData() : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the ActiveX control. */ export class ActiveXControlBase { /** * @deprecated Please use the 'workbook' property instead. * Gets the object. */ getWorkbook() : Workbook; /** * Gets the object. */ readonly workbook : Workbook; /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * Gets and sets the width of the control in unit of points. */ getWidth() : number; /** * Gets and sets the width of the control in unit of points. * @param value - The value to set. */ setWidth(value: number) : void; /** * Gets and sets the height of the control in unit of points. */ getHeight() : number; /** * Gets and sets the height of the control in unit of points. * @param value - The value to set. */ setHeight(value: number) : void; /** * @deprecated Please use the 'mouseIcon' property instead. * Gets and sets a custom icon to display as the mouse pointer for the control. */ getMouseIcon() : Uint8Array; /** * Gets and sets a custom icon to display as the mouse pointer for the control. */ mouseIcon : Uint8Array; /** * @deprecated Please use the 'mouseIcon' property instead. * Gets and sets a custom icon to display as the mouse pointer for the control. * @param value - The value to set. */ setMouseIcon(value: Uint8Array) : void; /** * @deprecated Please use the 'mousePointer' property instead. * Gets and sets the type of icon displayed as the mouse pointer for the control. */ getMousePointer() : ControlMousePointerType; /** * Gets and sets the type of icon displayed as the mouse pointer for the control. */ mousePointer : ControlMousePointerType; /** * @deprecated Please use the 'mousePointer' property instead. * Gets and sets the type of icon displayed as the mouse pointer for the control. * @param value - The value to set. */ setMousePointer(value: ControlMousePointerType) : void; /** * Gets and sets the ole color of the foreground. * * @remarks * Not applies to Image control. */ getForeOleColor() : number; /** * Gets and sets the ole color of the foreground. * @param value - The value to set. * * @remarks * Not applies to Image control. */ setForeOleColor(value: number) : void; /** * Gets and sets the ole color of the background. */ getBackOleColor() : number; /** * Gets and sets the ole color of the background. * @param value - The value to set. */ setBackOleColor(value: number) : void; /** * Indicates whether this control is visible. */ isVisible() : boolean; /** * Indicates whether this control is visible. * @param value - The value to set. */ setIsVisible(value: boolean) : void; /** * Indicates whether to show a shadow. */ getShadow() : boolean; /** * Indicates whether to show a shadow. * @param value - The value to set. */ setShadow(value: boolean) : void; /** * @deprecated Please use the 'linkedCell' property instead. * Gets and sets the linked cell. */ getLinkedCell() : string; /** * Gets and sets the linked cell. */ linkedCell : string; /** * @deprecated Please use the 'linkedCell' property instead. * Gets and sets the linked cell. * @param value - The value to set. */ setLinkedCell(value: string) : void; /** * @deprecated Please use the 'listFillRange' property instead. * Gets and sets the list fill range. */ getListFillRange() : string; /** * Gets and sets the list fill range. */ listFillRange : string; /** * @deprecated Please use the 'listFillRange' property instead. * Gets and sets the list fill range. * @param value - The value to set. */ setListFillRange(value: string) : void; /** * Gets and sets the binary data of the control. */ getData() : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the border type of the ActiveX control. */ export enum ControlBorderType { /** * No border. */ None = 0, /** * The single line. */ Single = 1, } /** * Represents the default run-time mode of the Input Method Editor. */ export enum InputMethodEditorMode { /** * Does not control IME. */ NoControl = 0, /** * IME on. */ On = 1, /** * IME off. English mode. */ Off = 2, /** * IME off.User can't turn on IME by keyboard. */ Disable = 3, /** * IME on with Full-width hiragana mode. */ Hiragana = 4, /** * IME on with Full-width katakana mode. */ Katakana = 5, /** * IME on with Half-width katakana mode. */ KatakanaHalf = 6, /** * IME on with Full-width Alphanumeric mode. */ AlphaFull = 7, /** * IME on with Half-width Alphanumeric mode. */ Alpha = 8, /** * IME on with Full-width hangul mode. */ HangulFull = 9, /** * IME on with Half-width hangul mode. */ Hangul = 10, /** * IME on with Full-width hanzi mode. */ HanziFull = 11, /** * IME on with Half-width hanzi mode. */ Hanzi = 12, } /** * Represents the position of the Caption relative to the control. */ export enum ControlCaptionAlignmentType { /** * The left of the control. */ Left = 0, /** * The right of the control. */ Right = 1, } /** * Represents a CheckBox ActiveX control. */ export class CheckBoxActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'groupName' property instead. * Gets and sets the group's name. */ getGroupName() : string; /** * Gets and sets the group's name. */ groupName : string; /** * @deprecated Please use the 'groupName' property instead. * Gets and sets the group's name. * @param value - The value to set. */ setGroupName(value: string) : void; /** * @deprecated Please use the 'alignment' property instead. * Gets and set the position of the Caption relative to the control. */ getAlignment() : ControlCaptionAlignmentType; /** * Gets and set the position of the Caption relative to the control. */ alignment : ControlCaptionAlignmentType; /** * @deprecated Please use the 'alignment' property instead. * Gets and set the position of the Caption relative to the control. * @param value - The value to set. */ setAlignment(value: ControlCaptionAlignmentType) : void; /** * Indicates whether the contents of the control automatically wrap at the end of a line. */ isWordWrapped : boolean; /** * @deprecated Please use the 'isWordWrapped' property instead. * Indicates whether the contents of the control automatically wrap at the end of a line. * @param value - The value to set. */ setIsWordWrapped(value: boolean) : void; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. */ getCaption() : string; /** * Gets and set the descriptive text that appears on a control. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. */ getPicturePosition() : ControlPicturePositionType; /** * Gets and set the location of the control's picture relative to its caption. */ picturePosition : ControlPicturePositionType; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. * @param value - The value to set. */ setPicturePosition(value: ControlPicturePositionType) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. */ getPicture() : Uint8Array; /** * Gets and sets the data of the picture. */ picture : Uint8Array; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. * @param value - The value to set. */ setPicture(value: Uint8Array) : void; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. */ getAccelerator() : string; /** * Gets and sets the accelerator key for the control. */ accelerator : string; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. * @param value - The value to set. */ setAccelerator(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Indicates if the control is checked or not. */ getValue() : CheckValueType; /** * Indicates if the control is checked or not. */ value : CheckValueType; /** * @deprecated Please use the 'value' property instead. * Indicates if the control is checked or not. * @param value - The value to set. */ setValue(value: CheckValueType) : void; /** * Indicates how the specified control will display Null values. * * @remarks * * * Setting * Description * * * True * The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. * * * False * (Default) The control will cycle through states for Yes and No values. Null values display as if they were No values. * * */ isTripleState : boolean; /** * @deprecated Please use the 'isTripleState' property instead. * Indicates how the specified control will display Null values. * @param value - The value to set. * * @remarks * * * Setting * Description * * * True * The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. * * * False * (Default) The control will cycle through states for Yes and No values. Null values display as if they were No values. * * */ setIsTripleState(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a ComboBox ActiveX control. */ export class ComboBoxActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'maxLength' property instead. * Gets and sets the maximum number of characters */ getMaxLength() : number; /** * Gets and sets the maximum number of characters */ maxLength : number; /** * @deprecated Please use the 'maxLength' property instead. * Gets and sets the maximum number of characters * @param value - The value to set. */ setMaxLength(value: number) : void; /** * @deprecated Please use the 'listWidth' property instead. * Gets and set the width in unit of points. */ getListWidth() : number; /** * Gets and set the width in unit of points. */ listWidth : number; /** * @deprecated Please use the 'listWidth' property instead. * Gets and set the width in unit of points. * @param value - The value to set. */ setListWidth(value: number) : void; /** * @deprecated Please use the 'boundColumn' property instead. * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). */ getBoundColumn() : number; /** * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). */ boundColumn : number; /** * @deprecated Please use the 'boundColumn' property instead. * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). * @param value - The value to set. */ setBoundColumn(value: number) : void; /** * @deprecated Please use the 'textColumn' property instead. * Represents the column in a ComboBox or ListBox to display to the user. */ getTextColumn() : number; /** * Represents the column in a ComboBox or ListBox to display to the user. */ textColumn : number; /** * @deprecated Please use the 'textColumn' property instead. * Represents the column in a ComboBox or ListBox to display to the user. * @param value - The value to set. */ setTextColumn(value: number) : void; /** * @deprecated Please use the 'columnCount' property instead. * Represents the number of columns to display in a ComboBox or ListBox. */ getColumnCount() : number; /** * Represents the number of columns to display in a ComboBox or ListBox. */ columnCount : number; /** * @deprecated Please use the 'columnCount' property instead. * Represents the number of columns to display in a ComboBox or ListBox. * @param value - The value to set. */ setColumnCount(value: number) : void; /** * @deprecated Please use the 'listRows' property instead. * Represents the maximum number of rows to display in the list. */ getListRows() : number; /** * Represents the maximum number of rows to display in the list. */ listRows : number; /** * @deprecated Please use the 'listRows' property instead. * Represents the maximum number of rows to display in the list. * @param value - The value to set. */ setListRows(value: number) : void; /** * @deprecated Please use the 'matchEntry' property instead. * Indicates how a ListBox or ComboBox searches its list as the user types. */ getMatchEntry() : ControlMatchEntryType; /** * Indicates how a ListBox or ComboBox searches its list as the user types. */ matchEntry : ControlMatchEntryType; /** * @deprecated Please use the 'matchEntry' property instead. * Indicates how a ListBox or ComboBox searches its list as the user types. * @param value - The value to set. */ setMatchEntry(value: ControlMatchEntryType) : void; /** * @deprecated Please use the 'dropButtonStyle' property instead. * Specifies the symbol displayed on the drop button */ getDropButtonStyle() : DropButtonStyle; /** * Specifies the symbol displayed on the drop button */ dropButtonStyle : DropButtonStyle; /** * @deprecated Please use the 'dropButtonStyle' property instead. * Specifies the symbol displayed on the drop button * @param value - The value to set. */ setDropButtonStyle(value: DropButtonStyle) : void; /** * @deprecated Please use the 'showDropButtonTypeWhen' property instead. * Specifies the symbol displayed on the drop button */ getShowDropButtonTypeWhen() : ShowDropButtonType; /** * Specifies the symbol displayed on the drop button */ showDropButtonTypeWhen : ShowDropButtonType; /** * @deprecated Please use the 'showDropButtonTypeWhen' property instead. * Specifies the symbol displayed on the drop button * @param value - The value to set. */ setShowDropButtonTypeWhen(value: ShowDropButtonType) : void; /** * @deprecated Please use the 'listStyle' property instead. * Gets and sets the visual appearance. */ getListStyle() : ControlListStyle; /** * Gets and sets the visual appearance. */ listStyle : ControlListStyle; /** * @deprecated Please use the 'listStyle' property instead. * Gets and sets the visual appearance. * @param value - The value to set. */ setListStyle(value: ControlListStyle) : void; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. */ getBorderStyle() : ControlBorderType; /** * Gets and set the type of border used by the control. */ borderStyle : ControlBorderType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. * @param value - The value to set. */ setBorderStyle(value: ControlBorderType) : void; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. */ getBorderOleColor() : number; /** * Gets and sets the ole color of the background. */ borderOleColor : number; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. * @param value - The value to set. */ setBorderOleColor(value: number) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * Indicates whether the user can type into the control. */ isEditable : boolean; /** * @deprecated Please use the 'isEditable' property instead. * Indicates whether the user can type into the control. * @param value - The value to set. */ setIsEditable(value: boolean) : void; /** * @deprecated Please use the 'showColumnHeads' property instead. * Indicates whether column headings are displayed. */ getShowColumnHeads() : boolean; /** * Indicates whether column headings are displayed. */ showColumnHeads : boolean; /** * @deprecated Please use the 'showColumnHeads' property instead. * Indicates whether column headings are displayed. * @param value - The value to set. */ setShowColumnHeads(value: boolean) : void; /** * Indicates whether dragging and dropping is enabled for the control. */ isDragBehaviorEnabled : boolean; /** * @deprecated Please use the 'isDragBehaviorEnabled' property instead. * Indicates whether dragging and dropping is enabled for the control. * @param value - The value to set. */ setIsDragBehaviorEnabled(value: boolean) : void; /** * @deprecated Please use the 'enterFieldBehavior' property instead. * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. */ getEnterFieldBehavior() : boolean; /** * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. */ enterFieldBehavior : boolean; /** * @deprecated Please use the 'enterFieldBehavior' property instead. * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. * @param value - The value to set. */ setEnterFieldBehavior(value: boolean) : void; /** * Specifies the basic unit used to extend a selection. * True specifies that the basic unit is a single character. * false specifies that the basic unit is a whole word. */ isAutoWordSelected() : boolean; /** * Specifies the basic unit used to extend a selection. * True specifies that the basic unit is a single character. * false specifies that the basic unit is a whole word. * @param value - The value to set. */ setIsAutoWordSelected(value: boolean) : void; /** * @deprecated Please use the 'selectionMargin' property instead. * Indicates whether the user can select a line of text by clicking in the region to the left of the text. */ getSelectionMargin() : boolean; /** * Indicates whether the user can select a line of text by clicking in the region to the left of the text. */ selectionMargin : boolean; /** * @deprecated Please use the 'selectionMargin' property instead. * Indicates whether the user can select a line of text by clicking in the region to the left of the text. * @param value - The value to set. */ setSelectionMargin(value: boolean) : void; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the control. */ getValue() : string; /** * Gets and sets the value of the control. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the control. * @param value - The value to set. */ setValue(value: string) : void; /** * @deprecated Please use the 'hideSelection' property instead. * Indicates whether selected text in the control appears highlighted when the control does not have focus. */ getHideSelection() : boolean; /** * Indicates whether selected text in the control appears highlighted when the control does not have focus. */ hideSelection : boolean; /** * @deprecated Please use the 'hideSelection' property instead. * Indicates whether selected text in the control appears highlighted when the control does not have focus. * @param value - The value to set. */ setHideSelection(value: boolean) : void; /** * @deprecated Please use the 'columnWidths' property instead. * Gets and sets the width of the column. */ getColumnWidths() : number; /** * Gets and sets the width of the column. */ columnWidths : number; /** * @deprecated Please use the 'columnWidths' property instead. * Gets and sets the width of the column. * @param value - The value to set. */ setColumnWidths(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all type of ActiveX control. */ export enum ControlType { /** * Button */ CommandButton = 0, /** * ComboBox */ ComboBox = 1, /** * CheckBox */ CheckBox = 2, /** * ListBox */ ListBox = 3, /** * TextBox */ TextBox = 4, /** * Spinner */ SpinButton = 5, /** * RadioButton */ RadioButton = 6, /** * Label */ Label = 7, /** * Image */ Image = 8, /** * ToggleButton */ ToggleButton = 9, /** * ScrollBar */ ScrollBar = 10, /** * ScrollBar * * @remarks * Unsupported. */ BarCode = 11, /** * Unknown */ Unknown = 12, } /** * Represents a command button. */ export class CommandButtonActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. */ getCaption() : string; /** * Gets and set the descriptive text that appears on a control. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. */ getPicturePosition() : ControlPicturePositionType; /** * Gets and set the location of the control's picture relative to its caption. */ picturePosition : ControlPicturePositionType; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. * @param value - The value to set. */ setPicturePosition(value: ControlPicturePositionType) : void; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. */ getPicture() : Uint8Array; /** * Gets and sets the data of the picture. */ picture : Uint8Array; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. * @param value - The value to set. */ setPicture(value: Uint8Array) : void; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. */ getAccelerator() : string; /** * Gets and sets the accelerator key for the control. */ accelerator : string; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. * @param value - The value to set. */ setAccelerator(value: string) : void; /** * @deprecated Please use the 'takeFocusOnClick' property instead. * Indicates whether the control takes the focus when clicked. */ getTakeFocusOnClick() : boolean; /** * Indicates whether the control takes the focus when clicked. */ takeFocusOnClick : boolean; /** * @deprecated Please use the 'takeFocusOnClick' property instead. * Indicates whether the control takes the focus when clicked. * @param value - The value to set. */ setTakeFocusOnClick(value: boolean) : void; /** * Indicates whether the contents of the control automatically wrap at the end of a line. */ isWordWrapped : boolean; /** * @deprecated Please use the 'isWordWrapped' property instead. * Indicates whether the contents of the control automatically wrap at the end of a line. * @param value - The value to set. */ setIsWordWrapped(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the image control. */ export class ImageActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * Indicates whether the control will automatically resize to display its entire contents. */ isAutoSize() : boolean; /** * Indicates whether the control will automatically resize to display its entire contents. * @param value - The value to set. */ setIsAutoSize(value: boolean) : void; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. */ getBorderOleColor() : number; /** * Gets and sets the ole color of the background. */ borderOleColor : number; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. * @param value - The value to set. */ setBorderOleColor(value: number) : void; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. */ getBorderStyle() : ControlBorderType; /** * Gets and set the type of border used by the control. */ borderStyle : ControlBorderType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. * @param value - The value to set. */ setBorderStyle(value: ControlBorderType) : void; /** * @deprecated Please use the 'pictureSizeMode' property instead. * Gets and sets how to display the picture. */ getPictureSizeMode() : ControlPictureSizeMode; /** * Gets and sets how to display the picture. */ pictureSizeMode : ControlPictureSizeMode; /** * @deprecated Please use the 'pictureSizeMode' property instead. * Gets and sets how to display the picture. * @param value - The value to set. */ setPictureSizeMode(value: ControlPictureSizeMode) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. */ getPicture() : Uint8Array; /** * Gets and sets the data of the picture. */ picture : Uint8Array; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. * @param value - The value to set. */ setPicture(value: Uint8Array) : void; /** * @deprecated Please use the 'pictureAlignment' property instead. * Gets and sets the alignment of the picture inside the Form or Image. */ getPictureAlignment() : ControlPictureAlignmentType; /** * Gets and sets the alignment of the picture inside the Form or Image. */ pictureAlignment : ControlPictureAlignmentType; /** * @deprecated Please use the 'pictureAlignment' property instead. * Gets and sets the alignment of the picture inside the Form or Image. * @param value - The value to set. */ setPictureAlignment(value: ControlPictureAlignmentType) : void; /** * Indicates whether the picture is tiled across the background. */ isTiled : boolean; /** * @deprecated Please use the 'isTiled' property instead. * Indicates whether the picture is tiled across the background. * @param value - The value to set. */ setIsTiled(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the label ActiveX control. */ export class LabelActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. */ getCaption() : string; /** * Gets and set the descriptive text that appears on a control. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. */ getPicturePosition() : ControlPicturePositionType; /** * Gets and set the location of the control's picture relative to its caption. */ picturePosition : ControlPicturePositionType; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. * @param value - The value to set. */ setPicturePosition(value: ControlPicturePositionType) : void; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. */ getBorderOleColor() : number; /** * Gets and sets the ole color of the background. */ borderOleColor : number; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. * @param value - The value to set. */ setBorderOleColor(value: number) : void; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. */ getBorderStyle() : ControlBorderType; /** * Gets and set the type of border used by the control. */ borderStyle : ControlBorderType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. * @param value - The value to set. */ setBorderStyle(value: ControlBorderType) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. */ getPicture() : Uint8Array; /** * Gets and sets the data of the picture. */ picture : Uint8Array; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. * @param value - The value to set. */ setPicture(value: Uint8Array) : void; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. */ getAccelerator() : string; /** * Gets and sets the accelerator key for the control. */ accelerator : string; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. * @param value - The value to set. */ setAccelerator(value: string) : void; /** * Indicates whether the contents of the control automatically wrap at the end of a line. */ isWordWrapped : boolean; /** * @deprecated Please use the 'isWordWrapped' property instead. * Indicates whether the contents of the control automatically wrap at the end of a line. * @param value - The value to set. */ setIsWordWrapped(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a ListBox ActiveX control. */ export class ListBoxActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'scrollBars' property instead. * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. */ getScrollBars() : ControlScrollBarType; /** * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. */ scrollBars : ControlScrollBarType; /** * @deprecated Please use the 'scrollBars' property instead. * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. * @param value - The value to set. */ setScrollBars(value: ControlScrollBarType) : void; /** * @deprecated Please use the 'listWidth' property instead. * Gets and set the width in unit of points. */ getListWidth() : number; /** * Gets and set the width in unit of points. */ listWidth : number; /** * @deprecated Please use the 'listWidth' property instead. * Gets and set the width in unit of points. * @param value - The value to set. */ setListWidth(value: number) : void; /** * @deprecated Please use the 'boundColumn' property instead. * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). */ getBoundColumn() : number; /** * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). */ boundColumn : number; /** * @deprecated Please use the 'boundColumn' property instead. * Represents how the Value property is determined for a ComboBox or ListBox * when the MultiSelect properties value (fmMultiSelectSingle). * @param value - The value to set. */ setBoundColumn(value: number) : void; /** * @deprecated Please use the 'textColumn' property instead. * Represents the column in a ComboBox or ListBox to display to the user. */ getTextColumn() : number; /** * Represents the column in a ComboBox or ListBox to display to the user. */ textColumn : number; /** * @deprecated Please use the 'textColumn' property instead. * Represents the column in a ComboBox or ListBox to display to the user. * @param value - The value to set. */ setTextColumn(value: number) : void; /** * @deprecated Please use the 'columnCount' property instead. * Represents the number of columns to display in a ComboBox or ListBox. */ getColumnCount() : number; /** * Represents the number of columns to display in a ComboBox or ListBox. */ columnCount : number; /** * @deprecated Please use the 'columnCount' property instead. * Represents the number of columns to display in a ComboBox or ListBox. * @param value - The value to set. */ setColumnCount(value: number) : void; /** * @deprecated Please use the 'matchEntry' property instead. * Indicates how a ListBox or ComboBox searches its list as the user types. */ getMatchEntry() : ControlMatchEntryType; /** * Indicates how a ListBox or ComboBox searches its list as the user types. */ matchEntry : ControlMatchEntryType; /** * @deprecated Please use the 'matchEntry' property instead. * Indicates how a ListBox or ComboBox searches its list as the user types. * @param value - The value to set. */ setMatchEntry(value: ControlMatchEntryType) : void; /** * @deprecated Please use the 'listStyle' property instead. * Gets and sets the visual appearance. */ getListStyle() : ControlListStyle; /** * Gets and sets the visual appearance. */ listStyle : ControlListStyle; /** * @deprecated Please use the 'listStyle' property instead. * Gets and sets the visual appearance. * @param value - The value to set. */ setListStyle(value: ControlListStyle) : void; /** * @deprecated Please use the 'selectionType' property instead. * Indicates whether the control permits multiple selections. */ getSelectionType() : SelectionType; /** * Indicates whether the control permits multiple selections. */ selectionType : SelectionType; /** * @deprecated Please use the 'selectionType' property instead. * Indicates whether the control permits multiple selections. * @param value - The value to set. */ setSelectionType(value: SelectionType) : void; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the control. * * @remarks * Only effects when is SelectionType.Single; */ getValue() : string; /** * Gets and sets the value of the control. * * @remarks * Only effects when is SelectionType.Single; */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the control. * @param value - The value to set. * * @remarks * Only effects when is SelectionType.Single; */ setValue(value: string) : void; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. */ getBorderStyle() : ControlBorderType; /** * Gets and set the type of border used by the control. */ borderStyle : ControlBorderType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. * @param value - The value to set. */ setBorderStyle(value: ControlBorderType) : void; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. */ getBorderOleColor() : number; /** * Gets and sets the ole color of the background. */ borderOleColor : number; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. * @param value - The value to set. */ setBorderOleColor(value: number) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'showColumnHeads' property instead. * Indicates whether column headings are displayed. */ getShowColumnHeads() : boolean; /** * Indicates whether column headings are displayed. */ showColumnHeads : boolean; /** * @deprecated Please use the 'showColumnHeads' property instead. * Indicates whether column headings are displayed. * @param value - The value to set. */ setShowColumnHeads(value: boolean) : void; /** * @deprecated Please use the 'integralHeight' property instead. * Indicates whether the control will only show complete lines of text without showing any partial lines. */ getIntegralHeight() : boolean; /** * Indicates whether the control will only show complete lines of text without showing any partial lines. */ integralHeight : boolean; /** * @deprecated Please use the 'integralHeight' property instead. * Indicates whether the control will only show complete lines of text without showing any partial lines. * @param value - The value to set. */ setIntegralHeight(value: boolean) : void; /** * @deprecated Please use the 'columnWidths' property instead. * Gets and sets the width of the column. */ getColumnWidths() : number; /** * Gets and sets the width of the column. */ columnWidths : number; /** * @deprecated Please use the 'columnWidths' property instead. * Gets and sets the width of the column. * @param value - The value to set. */ setColumnWidths(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the visual appearance of the list in a ListBox or ComboBox. */ export enum ControlListStyle { /** * Displays a list in which the background of an item is highlighted when it is selected. */ Plain = 0, /** * Displays a list in which an option button or a checkbox next to each entry displays the selection state of that item. */ Option = 1, } /** * Represents how a ListBox or ComboBox searches its list as the user types. */ export enum ControlMatchEntryType { /** * The control searches for the next entry that starts with the character entered. * Repeatedly typing the same letter cycles through all entries beginning with that letter. */ FirstLetter = 0, /** * As each character is typed, the control searches for an entry matching all characters entered. */ Complete = 1, /** * The list will not be searched when characters are typed. */ None = 2, } /** * Represents the type of icon displayed as the mouse pointer for the control. */ export enum ControlMousePointerType { /** * Standard pointer. */ Default = 0, /** * Arrow. */ Arrow = 1, /** * Cross-hair pointer. */ Cross = 2, /** * I-beam. */ IBeam = 3, /** * Double arrow pointing northeast and southwest. */ SizeNESW = 6, /** * Double arrow pointing north and south. */ SizeNS = 7, /** * Double arrow pointing northwest and southeast. */ SizeNWSE = 8, /** * Double arrow pointing west and east. */ SizeWE = 9, /** * Up arrow. */ UpArrow = 10, /** * Hourglass. */ HourGlass = 11, /** * "Not" symbol (circle with a diagonal line) on top of the object being dragged. */ NoDrop = 12, /** * Arrow with an hourglass. */ AppStarting = 13, /** * Arrow with a question mark. */ Help = 14, /** * "Size-all" cursor (arrows pointing north, south, east, and west). */ SizeAll = 15, /** * Uses the icon specified by the MouseIcon property. */ Custom = 99, } /** * Represents the alignment of the picture inside the Form or Image. */ export enum ControlPictureAlignmentType { /** * The top left corner. */ TopLeft = 0, /** * The top right corner. */ TopRight = 1, /** * The center. */ Center = 2, /** * The bottom left corner. */ BottomLeft = 3, /** * The bottom right corner. */ BottomRight = 4, } /** * Represents the location of the control's picture relative to its caption. */ export enum ControlPicturePositionType { /** * The picture appears to the left of the caption. * The caption is aligned with the top of the picture. */ LeftTop = 131072, /** * The picture appears to the left of the caption. * The caption is centered relative to the picture. */ LeftCenter = 327683, /** * The picture appears to the left of the caption. * The caption is aligned with the bottom of the picture. */ LeftBottom = 524294, /** * The picture appears to the right of the caption. * The caption is aligned with the top of the picture. */ RightTop = 2, /** * The picture appears to the right of the caption. * The caption is centered relative to the picture. */ RightCenter = 196613, /** * The picture appears to the right of the caption. * The caption is aligned with the bottom of the picture. */ RightBottom = 393224, /** * The picture appears above the caption. * The caption is aligned with the left edge of the picture. */ AboveLeft = 393216, /** * The picture appears above the caption. * The caption is centered below the picture. */ AboveCenter = 458753, /** * The picture appears above the caption. * The caption is aligned with the right edge of the picture. */ AboveRight = 524290, /** * The picture appears below the caption. * The caption is aligned with the left edge of the picture. */ BelowLeft = 6, /** * The picture appears below the caption. * The caption is centered above the picture. */ BelowCenter = 65543, /** * The picture appears below the caption. * The caption is aligned with the right edge of the picture. */ BelowRight = 131080, /** * The picture appears in the center of the control. * The caption is centered horizontally and vertically on top of the picture. */ Center = 262148, } /** * Represents how to display the picture. */ export enum ControlPictureSizeMode { /** * Crops any part of the picture that is larger than the control's boundaries. */ Clip = 0, /** * Stretches the picture to fill the control's area. * This setting distorts the picture in either the horizontal or vertical direction. */ Stretch = 1, /** * Enlarges the picture, but does not distort the picture in either the horizontal or vertical direction. */ Zoom = 3, } /** * Represents a RadioButton ActiveX control. */ export class RadioButtonActiveXControl extends ToggleButtonActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ToggleButtonActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'groupName' property instead. * Gets and sets the group's name. */ getGroupName() : string; /** * Gets and sets the group's name. */ groupName : string; /** * @deprecated Please use the 'groupName' property instead. * Gets and sets the group's name. * @param value - The value to set. */ setGroupName(value: string) : void; /** * @deprecated Please use the 'alignment' property instead. * Gets and set the position of the Caption relative to the control. */ getAlignment() : ControlCaptionAlignmentType; /** * Gets and set the position of the Caption relative to the control. */ alignment : ControlCaptionAlignmentType; /** * @deprecated Please use the 'alignment' property instead. * Gets and set the position of the Caption relative to the control. * @param value - The value to set. */ setAlignment(value: ControlCaptionAlignmentType) : void; /** * Indicates whether the contents of the control automatically wrap at the end of a line. */ isWordWrapped : boolean; /** * @deprecated Please use the 'isWordWrapped' property instead. * Indicates whether the contents of the control automatically wrap at the end of a line. * @param value - The value to set. */ setIsWordWrapped(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the ScrollBar control. */ export class ScrollBarActiveXControl extends SpinButtonActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SpinButtonActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'largeChange' property instead. * Gets and sets the amount by which the Position property changes */ getLargeChange() : number; /** * Gets and sets the amount by which the Position property changes */ largeChange : number; /** * @deprecated Please use the 'largeChange' property instead. * Gets and sets the amount by which the Position property changes * @param value - The value to set. */ setLargeChange(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of scroll bar. */ export enum ControlScrollBarType { /** * Displays no scroll bars. */ None = 0, /** * Displays a horizontal scroll bar. */ Horizontal = 1, /** * Displays a vertical scroll bar. */ BarsVertical = 2, /** * Displays both a horizontal and a vertical scroll bar. */ BarsBoth = 3, } /** * Represents type of scroll orientation */ export enum ControlScrollOrientation { /** * Control is rendered horizontally when the control's width is greater than its height. * Control is rendered vertically otherwise. */ Auto = 3, /** * Control is rendered vertically. */ Vertical = 0, /** * Control is rendered horizontally. */ Horizontal = 1, } /** * Represents the type of special effect. */ export enum ControlSpecialEffectType { /** * Flat */ Flat = 0, /** * Raised */ Raised = 1, /** * Sunken */ Sunken = 2, /** * Etched */ Etched = 3, /** * Bump */ Bump = 6, } /** * Represents the SpinButton control. */ export class SpinButtonActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'min' property instead. * Gets and sets the minimum acceptable value. */ getMin() : number; /** * Gets and sets the minimum acceptable value. */ min : number; /** * @deprecated Please use the 'min' property instead. * Gets and sets the minimum acceptable value. * @param value - The value to set. */ setMin(value: number) : void; /** * @deprecated Please use the 'max' property instead. * Gets and sets the maximum acceptable value. */ getMax() : number; /** * Gets and sets the maximum acceptable value. */ max : number; /** * @deprecated Please use the 'max' property instead. * Gets and sets the maximum acceptable value. * @param value - The value to set. */ setMax(value: number) : void; /** * @deprecated Please use the 'position' property instead. * Gets and sets the value. */ getPosition() : number; /** * Gets and sets the value. */ position : number; /** * @deprecated Please use the 'position' property instead. * Gets and sets the value. * @param value - The value to set. */ setPosition(value: number) : void; /** * @deprecated Please use the 'smallChange' property instead. * Gets and sets the amount by which the Position property changes */ getSmallChange() : number; /** * Gets and sets the amount by which the Position property changes */ smallChange : number; /** * @deprecated Please use the 'smallChange' property instead. * Gets and sets the amount by which the Position property changes * @param value - The value to set. */ setSmallChange(value: number) : void; /** * @deprecated Please use the 'orientation' property instead. * Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally. */ getOrientation() : ControlScrollOrientation; /** * Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally. */ orientation : ControlScrollOrientation; /** * @deprecated Please use the 'orientation' property instead. * Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally. * @param value - The value to set. */ setOrientation(value: ControlScrollOrientation) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a text box ActiveX control. */ export class TextBoxActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. */ getBorderStyle() : ControlBorderType; /** * Gets and set the type of border used by the control. */ borderStyle : ControlBorderType; /** * @deprecated Please use the 'borderStyle' property instead. * Gets and set the type of border used by the control. * @param value - The value to set. */ setBorderStyle(value: ControlBorderType) : void; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. */ getBorderOleColor() : number; /** * Gets and sets the ole color of the background. */ borderOleColor : number; /** * @deprecated Please use the 'borderOleColor' property instead. * Gets and sets the ole color of the background. * @param value - The value to set. */ setBorderOleColor(value: number) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'maxLength' property instead. * Gets and sets the maximum number of characters */ getMaxLength() : number; /** * Gets and sets the maximum number of characters */ maxLength : number; /** * @deprecated Please use the 'maxLength' property instead. * Gets and sets the maximum number of characters * @param value - The value to set. */ setMaxLength(value: number) : void; /** * @deprecated Please use the 'scrollBars' property instead. * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. */ getScrollBars() : ControlScrollBarType; /** * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. */ scrollBars : ControlScrollBarType; /** * @deprecated Please use the 'scrollBars' property instead. * Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. * @param value - The value to set. */ setScrollBars(value: ControlScrollBarType) : void; /** * @deprecated Please use the 'passwordChar' property instead. * Gets and sets a character to be displayed in place of the characters entered. */ getPasswordChar() : string; /** * Gets and sets a character to be displayed in place of the characters entered. */ passwordChar : string; /** * @deprecated Please use the 'passwordChar' property instead. * Gets and sets a character to be displayed in place of the characters entered. * @param value - The value to set. */ setPasswordChar(value: string) : void; /** * Indicates whether the user can type into the control. */ isEditable : boolean; /** * @deprecated Please use the 'isEditable' property instead. * Indicates whether the user can type into the control. * @param value - The value to set. */ setIsEditable(value: boolean) : void; /** * @deprecated Please use the 'integralHeight' property instead. * Indicates whether the control will only show complete lines of text without showing any partial lines. */ getIntegralHeight() : boolean; /** * Indicates whether the control will only show complete lines of text without showing any partial lines. */ integralHeight : boolean; /** * @deprecated Please use the 'integralHeight' property instead. * Indicates whether the control will only show complete lines of text without showing any partial lines. * @param value - The value to set. */ setIntegralHeight(value: boolean) : void; /** * Indicates whether dragging and dropping is enabled for the control. */ isDragBehaviorEnabled : boolean; /** * @deprecated Please use the 'isDragBehaviorEnabled' property instead. * Indicates whether dragging and dropping is enabled for the control. * @param value - The value to set. */ setIsDragBehaviorEnabled(value: boolean) : void; /** * @deprecated Please use the 'enterKeyBehavior' property instead. * Specifies the behavior of the ENTER key. * True specifies that pressing ENTER will create a new line. * False specifies that pressing ENTER will move the focus to the next object in the tab order. */ getEnterKeyBehavior() : boolean; /** * Specifies the behavior of the ENTER key. * True specifies that pressing ENTER will create a new line. * False specifies that pressing ENTER will move the focus to the next object in the tab order. */ enterKeyBehavior : boolean; /** * @deprecated Please use the 'enterKeyBehavior' property instead. * Specifies the behavior of the ENTER key. * True specifies that pressing ENTER will create a new line. * False specifies that pressing ENTER will move the focus to the next object in the tab order. * @param value - The value to set. */ setEnterKeyBehavior(value: boolean) : void; /** * @deprecated Please use the 'enterFieldBehavior' property instead. * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. */ getEnterFieldBehavior() : boolean; /** * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. */ enterFieldBehavior : boolean; /** * @deprecated Please use the 'enterFieldBehavior' property instead. * Specifies selection behavior when entering the control. * True specifies that the selection remains unchanged from last time the control was active. * False specifies that all the text in the control will be selected when entering the control. * @param value - The value to set. */ setEnterFieldBehavior(value: boolean) : void; /** * @deprecated Please use the 'tabKeyBehavior' property instead. * Indicates whether tab characters are allowed in the text of the control. */ getTabKeyBehavior() : boolean; /** * Indicates whether tab characters are allowed in the text of the control. */ tabKeyBehavior : boolean; /** * @deprecated Please use the 'tabKeyBehavior' property instead. * Indicates whether tab characters are allowed in the text of the control. * @param value - The value to set. */ setTabKeyBehavior(value: boolean) : void; /** * @deprecated Please use the 'hideSelection' property instead. * Indicates whether selected text in the control appears highlighted when the control does not have focus. */ getHideSelection() : boolean; /** * Indicates whether selected text in the control appears highlighted when the control does not have focus. */ hideSelection : boolean; /** * @deprecated Please use the 'hideSelection' property instead. * Indicates whether selected text in the control appears highlighted when the control does not have focus. * @param value - The value to set. */ setHideSelection(value: boolean) : void; /** * Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters. */ isAutoTab : boolean; /** * @deprecated Please use the 'isAutoTab' property instead. * Indicates whether the focus will automatically move to the next control when the user enters the maximum number of characters. * @param value - The value to set. */ setIsAutoTab(value: boolean) : void; /** * Indicates whether the control can display more than one line of text. */ isMultiLine : boolean; /** * @deprecated Please use the 'isMultiLine' property instead. * Indicates whether the control can display more than one line of text. * @param value - The value to set. */ setIsMultiLine(value: boolean) : void; /** * Specifies the basic unit used to extend a selection. * True specifies that the basic unit is a single character. * false specifies that the basic unit is a whole word. */ isAutoWordSelected() : boolean; /** * Specifies the basic unit used to extend a selection. * True specifies that the basic unit is a single character. * false specifies that the basic unit is a whole word. * @param value - The value to set. */ setIsAutoWordSelected(value: boolean) : void; /** * Indicates whether the contents of the control automatically wrap at the end of a line. */ isWordWrapped : boolean; /** * @deprecated Please use the 'isWordWrapped' property instead. * Indicates whether the contents of the control automatically wrap at the end of a line. * @param value - The value to set. */ setIsWordWrapped(value: boolean) : void; /** * @deprecated Please use the 'text' property instead. * Gets and set text of the control. */ getText() : string; /** * Gets and set text of the control. */ text : string; /** * @deprecated Please use the 'text' property instead. * Gets and set text of the control. * @param value - The value to set. */ setText(value: string) : void; /** * @deprecated Please use the 'dropButtonStyle' property instead. * Specifies the symbol displayed on the drop button */ getDropButtonStyle() : DropButtonStyle; /** * Specifies the symbol displayed on the drop button */ dropButtonStyle : DropButtonStyle; /** * @deprecated Please use the 'dropButtonStyle' property instead. * Specifies the symbol displayed on the drop button * @param value - The value to set. */ setDropButtonStyle(value: DropButtonStyle) : void; /** * @deprecated Please use the 'showDropButtonTypeWhen' property instead. * Specifies the symbol displayed on the drop button */ getShowDropButtonTypeWhen() : ShowDropButtonType; /** * Specifies the symbol displayed on the drop button */ showDropButtonTypeWhen : ShowDropButtonType; /** * @deprecated Please use the 'showDropButtonTypeWhen' property instead. * Specifies the symbol displayed on the drop button * @param value - The value to set. */ setShowDropButtonTypeWhen(value: ShowDropButtonType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a ToggleButton ActiveX control. */ export class ToggleButtonActiveXControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. */ getCaption() : string; /** * Gets and set the descriptive text that appears on a control. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Gets and set the descriptive text that appears on a control. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. */ getPicturePosition() : ControlPicturePositionType; /** * Gets and set the location of the control's picture relative to its caption. */ picturePosition : ControlPicturePositionType; /** * @deprecated Please use the 'picturePosition' property instead. * Gets and set the location of the control's picture relative to its caption. * @param value - The value to set. */ setPicturePosition(value: ControlPicturePositionType) : void; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. */ getSpecialEffect() : ControlSpecialEffectType; /** * Gets and sets the special effect of the control. */ specialEffect : ControlSpecialEffectType; /** * @deprecated Please use the 'specialEffect' property instead. * Gets and sets the special effect of the control. * @param value - The value to set. */ setSpecialEffect(value: ControlSpecialEffectType) : void; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. */ getPicture() : Uint8Array; /** * Gets and sets the data of the picture. */ picture : Uint8Array; /** * @deprecated Please use the 'picture' property instead. * Gets and sets the data of the picture. * @param value - The value to set. */ setPicture(value: Uint8Array) : void; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. */ getAccelerator() : string; /** * Gets and sets the accelerator key for the control. */ accelerator : string; /** * @deprecated Please use the 'accelerator' property instead. * Gets and sets the accelerator key for the control. * @param value - The value to set. */ setAccelerator(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Indicates if the control is checked or not. */ getValue() : CheckValueType; /** * Indicates if the control is checked or not. */ value : CheckValueType; /** * @deprecated Please use the 'value' property instead. * Indicates if the control is checked or not. * @param value - The value to set. */ setValue(value: CheckValueType) : void; /** * Indicates how the specified control will display Null values. * * @remarks * * * Setting * Description * * * True * The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. * * * False * (Default) The control will cycle through states for Yes and No values. Null values display as if they were No values. * * */ isTripleState : boolean; /** * @deprecated Please use the 'isTripleState' property instead. * Indicates how the specified control will display Null values. * @param value - The value to set. * * @remarks * * * Setting * Description * * * True * The control will cycle through states for Yes, No, and Null values. The control appears dimmed (grayed) when its Value property is set to Null. * * * False * (Default) The control will cycle through states for Yes and No values. Null values display as if they were No values. * * */ setIsTripleState(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Unknow control. */ export class UnknownControl extends ActiveXControl { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ActiveXControl); /** * Gets and sets the binary data of the control. */ getData() : Uint8Array; /** * Gets the type of the ActiveX control. */ getType() : ControlType; /** * Gets the related data. * @param relId - The relationship id. * @returns * Returns the related data. */ getRelationshipData(relId: string) : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Provides helper functions about color. */ export class ColorHelper { /** * Convert OLE_COLOR. * @param oleColor - The value of OLE_COLOR. * @returns * The object. */ static fromOleColor(oleColor: number) : Color; /** * Convert color to OLE_COLOR * @param color - The object. * @param workbook - * @returns * The value of OLE_COLOR */ static toOleColor(color: Color, workbook: Workbook) : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Enumerates strategies for handling calculation precision. * Because of the precision issue of IEEE 754 Floating-Point Arithmetic, some "seemingly simple" formulas may not be calculated as the expected result. * Such as formula "=-0.45+0.43+0.02", when calculating operands by '+' operator directly, the result is not zero. For such kind of precision issue, * some special strategies may give the expected result. */ export enum CalculationPrecisionStrategy { /** * No strategy applied on calculation. * When calculating just use the original double value as operand and return the result directly. * Most efficient for performance and applicable for most cases. */ None = 0, /** * Rounds the calculation result according with significant digits. */ Round = 1, /** * Uses decimal as operands when possible. * Most inefficient for performance. */ Decimal = 2, } /** * Represents options for calculation. */ export class CalculationOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'ignoreError' property instead. * Indicates whether errors encountered while calculating formulas should be ignored. * The error may be unsupported function, external links, etc. * The default value is true. */ getIgnoreError() : boolean; /** * Indicates whether errors encountered while calculating formulas should be ignored. * The error may be unsupported function, external links, etc. * The default value is true. */ ignoreError : boolean; /** * @deprecated Please use the 'ignoreError' property instead. * Indicates whether errors encountered while calculating formulas should be ignored. * The error may be unsupported function, external links, etc. * The default value is true. * @param value - The value to set. */ setIgnoreError(value: boolean) : void; /** * @deprecated Please use the 'recursive' property instead. * Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. * The default value is true. */ getRecursive() : boolean; /** * Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. * The default value is true. */ recursive : boolean; /** * @deprecated Please use the 'recursive' property instead. * Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. * The default value is true. * @param value - The value to set. */ setRecursive(value: boolean) : void; /** * @deprecated Please use the 'userSpecifiedRefreshDynamicArrayFormula' property instead. * Indicates whether user has explicitly specified the behavior of * refreshing dynamic array formulas before calculating specified formulas. */ getUserSpecifiedRefreshDynamicArrayFormula() : boolean; /** * Indicates whether user has explicitly specified the behavior of * refreshing dynamic array formulas before calculating specified formulas. */ readonly userSpecifiedRefreshDynamicArrayFormula : boolean; /** * @deprecated Please use the 'refreshDynamicArrayFormula' property instead. * Indicates whether dynamic array formulas should be refreshed * before calculating formulas. * * @remarks * If this property has been specified explicitly, then the specified value * will be used to determine whether refresh dynamic array formulas. * Otherwise( is flase), * the default value of it depends on what kind of formulas need to be calculated: * For calculating formulas for the workbook, * such as , * this property will be taken as true. * For other cases, such as * or , * this property will be taken as false. */ getRefreshDynamicArrayFormula() : boolean; /** * Indicates whether dynamic array formulas should be refreshed * before calculating formulas. * * @remarks * If this property has been specified explicitly, then the specified value * will be used to determine whether refresh dynamic array formulas. * Otherwise( is flase), * the default value of it depends on what kind of formulas need to be calculated: * For calculating formulas for the workbook, * such as , * this property will be taken as true. * For other cases, such as * or , * this property will be taken as false. */ refreshDynamicArrayFormula : boolean; /** * @deprecated Please use the 'refreshDynamicArrayFormula' property instead. * Indicates whether dynamic array formulas should be refreshed * before calculating formulas. * @param value - The value to set. * * @remarks * If this property has been specified explicitly, then the specified value * will be used to determine whether refresh dynamic array formulas. * Otherwise( is flase), * the default value of it depends on what kind of formulas need to be calculated: * For calculating formulas for the workbook, * such as , * this property will be taken as true. * For other cases, such as * or , * this property will be taken as false. */ setRefreshDynamicArrayFormula(value: boolean) : void; /** * @deprecated Please use the 'customEngine' property instead. * The custom formula calculation engine to extend the default calculation engine of Aspose.Cells. */ getCustomEngine() : AbstractCalculationEngine; /** * The custom formula calculation engine to extend the default calculation engine of Aspose.Cells. */ customEngine : AbstractCalculationEngine; /** * @deprecated Please use the 'customEngine' property instead. * The custom formula calculation engine to extend the default calculation engine of Aspose.Cells. * @param value - The value to set. */ setCustomEngine(value: AbstractCalculationEngine) : void; /** * @deprecated Please use the 'calcStackSize' property instead. * The stack size for calculating cells recursively. Default value is 200. * * @remarks * When there are large amount of cells need to be calculated recursively in the dependency tree, * StackOverflowException may be caused in the calculation process. * If so, user should specify smaller value for this property. * For such situation, user should determine the proper value for this property according to the actual formulas and data. * However, too small value may cause performance degradation for the formula calculation and value less than 2 * will make it impossible to calculate formula which depends on another one. So if the specified value is less than 2, * it will be reset to 2. */ getCalcStackSize() : number; /** * The stack size for calculating cells recursively. Default value is 200. * * @remarks * When there are large amount of cells need to be calculated recursively in the dependency tree, * StackOverflowException may be caused in the calculation process. * If so, user should specify smaller value for this property. * For such situation, user should determine the proper value for this property according to the actual formulas and data. * However, too small value may cause performance degradation for the formula calculation and value less than 2 * will make it impossible to calculate formula which depends on another one. So if the specified value is less than 2, * it will be reset to 2. */ calcStackSize : number; /** * @deprecated Please use the 'calcStackSize' property instead. * The stack size for calculating cells recursively. Default value is 200. * @param value - The value to set. * * @remarks * When there are large amount of cells need to be calculated recursively in the dependency tree, * StackOverflowException may be caused in the calculation process. * If so, user should specify smaller value for this property. * For such situation, user should determine the proper value for this property according to the actual formulas and data. * However, too small value may cause performance degradation for the formula calculation and value less than 2 * will make it impossible to calculate formula which depends on another one. So if the specified value is less than 2, * it will be reset to 2. */ setCalcStackSize(value: number) : void; /** * @deprecated Please use the 'precisionStrategy' property instead. * Specifies the strategy for processing precision of calculation. */ getPrecisionStrategy() : CalculationPrecisionStrategy; /** * Specifies the strategy for processing precision of calculation. */ precisionStrategy : CalculationPrecisionStrategy; /** * @deprecated Please use the 'precisionStrategy' property instead. * Specifies the strategy for processing precision of calculation. * @param value - The value to set. */ setPrecisionStrategy(value: CalculationPrecisionStrategy) : void; /** * @deprecated Please use the 'linkedDataSources' property instead. * Specifies the data sources for external links used in formulas. * * @remarks * Like , here you may specify * data sources for external links used in formulas to be calculated, especially those * used in INDIRECT function. For those external links used in INDIRECT function, * they are not taken as part of the external links of the workbook and cannot be updated * by . * The match of those workbooks with external links is determined by * and . So please make sure has * been specified with the proper value(generally it should be same with corresponding * ) for every workbook so they can be linked as expected. */ getLinkedDataSources() : Workbook[]; /** * Specifies the data sources for external links used in formulas. * * @remarks * Like , here you may specify * data sources for external links used in formulas to be calculated, especially those * used in INDIRECT function. For those external links used in INDIRECT function, * they are not taken as part of the external links of the workbook and cannot be updated * by . * The match of those workbooks with external links is determined by * and . So please make sure has * been specified with the proper value(generally it should be same with corresponding * ) for every workbook so they can be linked as expected. */ linkedDataSources : Workbook[]; /** * @deprecated Please use the 'linkedDataSources' property instead. * Specifies the data sources for external links used in formulas. * @param value - The value to set. * * @remarks * Like , here you may specify * data sources for external links used in formulas to be calculated, especially those * used in INDIRECT function. For those external links used in INDIRECT function, * they are not taken as part of the external links of the workbook and cannot be updated * by . * The match of those workbooks with external links is determined by * and . So please make sure has * been specified with the proper value(generally it should be same with corresponding * ) for every workbook so they can be linked as expected. */ setLinkedDataSources(value: Workbook[]) : void; /** * @deprecated Please use the 'characterEncoding' property instead. * Specifies the encoding used for encoding/decoding characters when calculating formulas. * For functions such as CHAR, CODE, the calculated result depends on the region settings and default charset of the environment. * With this property user can specify the proper encoding used for those function to get the expected result. */ getCharacterEncoding() : EncodingType; /** * Specifies the encoding used for encoding/decoding characters when calculating formulas. * For functions such as CHAR, CODE, the calculated result depends on the region settings and default charset of the environment. * With this property user can specify the proper encoding used for those function to get the expected result. */ characterEncoding : EncodingType; /** * @deprecated Please use the 'characterEncoding' property instead. * Specifies the encoding used for encoding/decoding characters when calculating formulas. * For functions such as CHAR, CODE, the calculated result depends on the region settings and default charset of the environment. * With this property user can specify the proper encoding used for those function to get the expected result. * @param value - The value to set. */ setCharacterEncoding(value: EncodingType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a Custom XML Data Storage Part (custom XML data within a package). */ export class CustomXmlPart { /** * @deprecated Please use the 'data' property instead. * Gets or sets the XML content of this Custom XML Data Storage Part. */ getData() : Uint8Array; /** * Gets or sets the XML content of this Custom XML Data Storage Part. */ data : Uint8Array; /** * @deprecated Please use the 'data' property instead. * Gets or sets the XML content of this Custom XML Data Storage Part. * @param value - The value to set. */ setData(value: Uint8Array) : void; /** * @deprecated Please use the 'schemaData' property instead. * Gets or sets the XML content of this Custom XML Schema Data Storage Part. */ getSchemaData() : Uint8Array; /** * Gets or sets the XML content of this Custom XML Schema Data Storage Part. */ schemaData : Uint8Array; /** * @deprecated Please use the 'schemaData' property instead. * Gets or sets the XML content of this Custom XML Schema Data Storage Part. * @param value - The value to set. */ setSchemaData(value: Uint8Array) : void; /** * @deprecated Please use the 'iD' property instead. * Gets and sets the id of the custom xml part. */ getID() : string; /** * Gets and sets the id of the custom xml part. */ iD : string; /** * @deprecated Please use the 'iD' property instead. * Gets and sets the id of the custom xml part. * @param value - The value to set. */ setID(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a Custom XML Data Storage Part (custom XML data within a package). */ export class CustomXmlPartCollection implements Iterable { /** * Gets an item at the specified index. * @param index - The index. */ get(index: number) : CustomXmlPart; /** * Adds an item to the collection. * @param data - The XML content of this Custom XML Data Storage Part. * @param shemaData - The set of XML schemas that are associated with this custom XML part. */ add(data: Uint8Array, shemaData: Uint8Array) : number; /** * Gets an item by id. * @param id - Contains the GUID for the custom XML part. */ selectByID(id: string) : CustomXmlPart; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * represents automatic fill. */ export class AutomaticFill { /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents this fill format should inherit the fill properties of the group. */ export class GroupFill { /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents no fill. */ export class NoneFill { /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represent the signature line. */ export class SignatureLine { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'signer' property instead. * Gets or sets the signer. */ getSigner() : string; /** * Gets or sets the signer. */ signer : string; /** * @deprecated Please use the 'signer' property instead. * Gets or sets the signer. * @param value - The value to set. */ setSigner(value: string) : void; /** * @deprecated Please use the 'title' property instead. * Gets or sets the title of singer. */ getTitle() : string; /** * Gets or sets the title of singer. */ title : string; /** * @deprecated Please use the 'title' property instead. * Gets or sets the title of singer. * @param value - The value to set. */ setTitle(value: string) : void; /** * @deprecated Please use the 'email' property instead. * Gets or sets the email of singer. */ getEmail() : string; /** * Gets or sets the email of singer. */ email : string; /** * @deprecated Please use the 'email' property instead. * Gets or sets the email of singer. * @param value - The value to set. */ setEmail(value: string) : void; /** * Indicates whether it is a signature line. */ isLine : boolean; /** * @deprecated Please use the 'isLine' property instead. * Indicates whether it is a signature line. * @param value - The value to set. */ setIsLine(value: boolean) : void; /** * @deprecated Please use the 'allowComments' property instead. * Indicates whether comments could be attached. */ getAllowComments() : boolean; /** * Indicates whether comments could be attached. */ allowComments : boolean; /** * @deprecated Please use the 'allowComments' property instead. * Indicates whether comments could be attached. * @param value - The value to set. */ setAllowComments(value: boolean) : void; /** * @deprecated Please use the 'showSignedDate' property instead. * Indicates whether show signed date. */ getShowSignedDate() : boolean; /** * Indicates whether show signed date. */ showSignedDate : boolean; /** * @deprecated Please use the 'showSignedDate' property instead. * Indicates whether show signed date. * @param value - The value to set. */ setShowSignedDate(value: boolean) : void; /** * @deprecated Please use the 'instructions' property instead. * Gets or sets the text shown to user at signing time. */ getInstructions() : string; /** * Gets or sets the text shown to user at signing time. */ instructions : string; /** * @deprecated Please use the 'instructions' property instead. * Gets or sets the text shown to user at signing time. * @param value - The value to set. */ setInstructions(value: string) : void; /** * @deprecated Please use the 'signatureLineType' property instead. * Gets or sets the signature type. * Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. * Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. * Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. */ getSignatureLineType() : SignatureType; /** * Gets or sets the signature type. * Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. * Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. * Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. */ signatureLineType : SignatureType; /** * @deprecated Please use the 'signatureLineType' property instead. * Gets or sets the signature type. * Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. * Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. * Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. * @param value - The value to set. */ setSignatureLineType(value: SignatureType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the slicer shape. */ export class SlicerShape extends Shape { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Shape); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents automatic numbered bullet. */ export class AutoNumberedBulletValue extends BulletValue { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BulletValue); /** * Default Constructor. */ constructor(); /** * Gets the type of the bullet. */ getType() : BulletType; /** * @deprecated Please use the 'startAt' property instead. * Gets and sets the starting number of the bullet. */ getStartAt() : number; /** * Gets and sets the starting number of the bullet. */ startAt : number; /** * @deprecated Please use the 'startAt' property instead. * Gets and sets the starting number of the bullet. * @param value - The value to set. */ setStartAt(value: number) : void; /** * @deprecated Please use the 'autonumberScheme' property instead. * Represents the scheme of automatic number. */ getAutonumberScheme() : TextAutonumberScheme; /** * Represents the scheme of automatic number. */ autonumberScheme : TextAutonumberScheme; /** * @deprecated Please use the 'autonumberScheme' property instead. * Represents the scheme of automatic number. * @param value - The value to set. */ setAutonumberScheme(value: TextAutonumberScheme) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the bullet points should be applied to a paragraph. */ export class Bullet { /** * @deprecated Please use the 'bulletValue' property instead. * Gets the value of bullet. */ getBulletValue() : BulletValue; /** * Gets the value of bullet. */ readonly bulletValue : BulletValue; /** * @deprecated Please use the 'type' property instead. * Gets and sets the type of bullet. */ getType() : BulletType; /** * Gets and sets the type of bullet. */ type : BulletType; /** * @deprecated Please use the 'type' property instead. * Gets and sets the type of bullet. * @param value - The value to set. */ setType(value: BulletType) : void; /** * @deprecated Please use the 'fontName' property instead. * Get and sets the name of the font. */ getFontName() : string; /** * Get and sets the name of the font. */ fontName : string; /** * @deprecated Please use the 'fontName' property instead. * Get and sets the name of the font. * @param value - The value to set. */ setFontName(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the type of the bullet. */ export enum BulletType { /** * No bullet. */ None = 0, /** * Character bullet. */ Character = 1, /** * Image bullet. */ Picture = 2, /** * Automatic numbered bullet. */ AutoNumbered = 3, } /** * Represents the value of the bullet. */ export class BulletValue { /** * Gets the type of the bullet's value. */ getType() : BulletType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the character bullet. */ export class CharacterBulletValue extends BulletValue { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BulletValue); /** * Default Constructor. */ constructor(); /** * Gets the type of the bullet. */ getType() : BulletType; /** * @deprecated Please use the 'character' property instead. * Gets and sets character of the bullet. */ getCharacter() : string; /** * Gets and sets character of the bullet. */ character : string; /** * @deprecated Please use the 'character' property instead. * Gets and sets character of the bullet. * @param value - The value to set. */ setCharacter(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This specifies the shape of delimiters in the delimiter object. */ export enum EquationDelimiterShapeType { /** * The divider is centered around the entire height of its content. */ Centered = 0, /** * The divider is altered to exactly match their contents' height. */ Match = 1, } /** * Equation node type. * Notice: * (1)[1-99] Currently there is only one node in the scope, and its enumeration value is 1. The node it specifies is used to store mathematical text. * (2)[100-199] Indicates that the node is a component of some special function nodes. * (3)[200-] Indicates that the node has some special functions. */ export enum EquationNodeType { /** * UnKnow */ UnKnow = 0, /** * specifies a node that stores math text */ Text = 1, /** * Specifies a Base component */ Base = 100, /** * Specifies a Denominator component */ Denominator = 101, /** * Specifies a Numerator component */ Numerator = 102, /** * Specifies a FunctionName component */ FunctionName = 103, /** * Specifies a Subscript component */ Subscript = 104, /** * Specifies a Superscript component */ Superscript = 105, /** * Specifies a Degree component */ Degree = 106, /** * Specifies a MatrixRow component.A single row of the matrix */ MatrixRow = 107, /** * Represents a sub-object of Lower-Limit function or Upper-Limit function */ Limit = 108, /** * Specifies a mathematical paragraph(oMathPara). */ EquationParagraph = 200, /** * Specifies an equation or mathematical expression(OMath). * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Mathematical. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Mathematical instead. */ MathematicalEquation = 201, /** * Specifies fractional equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Fraction. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Fraction instead. */ FractionEquation = 202, /** * Specifies function equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Function. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Function instead. */ FunctionEquation = 203, /** * Specifies delimiter equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Delimiter. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Delimiter instead. */ DelimiterEquation = 204, /** * Specifies n-ary operator equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Nary. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Nary instead. */ NaryEquation = 205, /** * Specifies the radical equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Radical. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Radical instead. */ RadicalEquation = 206, /** * Specifies superscript equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Sup. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Sup instead. */ SuperscriptEquation = 207, /** * Specifies subscript equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Sub. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Sub instead. */ SubscriptEquation = 208, /** * Specifies an equation with superscripts and subscripts to the right of the operands. * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.SubSup. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.SubSup instead. */ SubSupEquation = 209, /** * Specifies an equation with superscripts and subscripts to the left of the operands. * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.PreSubSup. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.PreSubSup instead. */ PreSubSupEquation = 210, /** * Specifies accent equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Accent. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Accent instead. */ AccentEquation = 211, /** * Specifies bar equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Bar. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Bar instead. */ BarEquation = 212, /** * Specifies border box equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.BorderBox. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.BorderBox instead. */ BorderBoxEquation = 213, /** * Specifies box equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Box. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Box instead. */ BoxEquation = 214, /** * Specifies Group-Character equation * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.GroupChr. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.GroupChr instead. */ GroupCharacterEquation = 215, /** * Specifies the Matrix equation, * * @remarks * NOTE: This member is now obsolete. Instead, please use EquationNodeType.Matrix. * This property will be removed 12 months later since September 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use EquationNodeType.Matrix instead. */ MatrixEquation = 216, /** * Specifies the Lower-Limit function */ LowerLimit = 217, /** * Specifies the Upper-Limit function */ UpperLimit = 218, /** * Specifies an equation or mathematical expression(OMath). */ Mathematical = 201, /** * Specifies fractional equation */ Fraction = 202, /** * Specifies function equation */ Function = 203, /** * Specifies delimiter equation */ Delimiter = 204, /** * Specifies n-ary operator equation */ Nary = 205, /** * Specifies the radical equation */ Radical = 206, /** * Specifies superscript equation */ Sup = 207, /** * Specifies subscript equation */ Sub = 208, /** * Specifies an equation with superscripts and subscripts to the right of the operands. */ SubSup = 209, /** * Specifies an equation with superscripts and subscripts to the left of the operands. */ PreSubSup = 210, /** * Specifies accent equation */ Accent = 211, /** * Specifies bar equation */ Bar = 212, /** * Specifies border box equation */ BorderBox = 213, /** * Specifies box equation */ Box = 214, /** * Specifies Group-Character equation */ GroupChr = 215, /** * Specifies the Matrix equation, */ Matrix = 216, /** * Specifies the Equation-Array function. The function consists of one or more equations. */ ArrayEquation = 317, } /** * This specifies the display style of the fraction bar. */ export enum EquationFractionType { /** * This specifies that the numerator is above and the denominator below is separated by a bar in the middle. */ Bar = 0, /** * This specifies that the numerator is above and the denominator below is not separated by a bar in the middle. */ NoBar = 1, /** * This specifies that the numerator is on the left and the denominator is on the right, separated by a '/' in between. */ Linear = 2, /** * This specifies that the numerator is on the upper left and the denominator is on the lower right, separated by a "/". */ Skewed = 3, } /** * This specifies the default horizontal justification of equations in the document. */ export enum EquationHorizontalJustificationType { /** * Centered */ Center = 0, /** * Centered as Group */ CenterGroup = 1, /** * Left Justified */ Left = 2, /** * Right Justified */ Right = 3, } /** * Specifies the limit location on an operator. */ export enum EquationLimitLocationType { /** * Specifies that the limit is centered above or below the operator. */ UndOvr = 0, /** * Specifies that the limit is on the right side of the operator. */ SubSup = 1, } /** * This class specifies an accent equation, consisting of a base component and a combining diacritic. */ export class AccentEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'accentCharacter' property instead. * This attribute specifies the type of combining diacritical mark attached to the base of the accent function. The default accent character is U+0302. * It is strongly recommended to use attribute AccentType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getAccentCharacter() : string; /** * This attribute specifies the type of combining diacritical mark attached to the base of the accent function. The default accent character is U+0302. * It is strongly recommended to use attribute AccentType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ accentCharacter : string; /** * @deprecated Please use the 'accentCharacter' property instead. * This attribute specifies the type of combining diacritical mark attached to the base of the accent function. The default accent character is U+0302. * It is strongly recommended to use attribute AccentType to set accent character. * Use this property setting if you cannot find the character you need in a known type. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setAccentCharacter(value: string) : void; /** * @deprecated Please use the 'accentCharacterType' property instead. * Specify combining characters by type value. */ getAccentCharacterType() : EquationCombiningCharacterType; /** * Specify combining characters by type value. */ accentCharacterType : EquationCombiningCharacterType; /** * @deprecated Please use the 'accentCharacterType' property instead. * Specify combining characters by type value. * @param value - The value to set. */ setAccentCharacterType(value: EquationCombiningCharacterType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the bar equation, consisting of a base argument and an overbar or underbar. */ export class BarEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'barPosition' property instead. * This attribute specifies the position of the bar in the bar object */ getBarPosition() : EquationCharacterPositionType; /** * This attribute specifies the position of the bar in the bar object */ barPosition : EquationCharacterPositionType; /** * @deprecated Please use the 'barPosition' property instead. * This attribute specifies the position of the bar in the bar object * @param value - The value to set. */ setBarPosition(value: EquationCharacterPositionType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the Border Box function, consisting of a border drawn around an equation. */ export class BorderBoxEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the box function, which is used to group components of an equation. */ export class BoxEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the delimiter equation, consisting of opening and closing delimiters (such as parentheses, braces, brackets, and vertical bars), and a component contained inside. * The delimiter may have more than one component, with a designated separator character between each component. */ export class DelimiterEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'beginChar' property instead. * Delimiter beginning character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getBeginChar() : string; /** * Delimiter beginning character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ beginChar : string; /** * @deprecated Please use the 'beginChar' property instead. * Delimiter beginning character. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setBeginChar(value: string) : void; /** * @deprecated Please use the 'endChar' property instead. * Delimiter ending character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getEndChar() : string; /** * Delimiter ending character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ endChar : string; /** * @deprecated Please use the 'endChar' property instead. * Delimiter ending character. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setEndChar(value: string) : void; /** * @deprecated Please use the 'naryGrow' property instead. * Specifies whether the delimiter should automatically expand and contract with the height of the formula. * * @remarks * This property specifies the growth property of the delimiter at the document level. * When off, the delimiter will not grow to match the size of its component height. * When enabled, the delimiter grows vertically to match its component height. */ getNaryGrow() : boolean; /** * Specifies whether the delimiter should automatically expand and contract with the height of the formula. * * @remarks * This property specifies the growth property of the delimiter at the document level. * When off, the delimiter will not grow to match the size of its component height. * When enabled, the delimiter grows vertically to match its component height. */ naryGrow : boolean; /** * @deprecated Please use the 'naryGrow' property instead. * Specifies whether the delimiter should automatically expand and contract with the height of the formula. * @param value - The value to set. * * @remarks * This property specifies the growth property of the delimiter at the document level. * When off, the delimiter will not grow to match the size of its component height. * When enabled, the delimiter grows vertically to match its component height. */ setNaryGrow(value: boolean) : void; /** * @deprecated Please use the 'separatorChar' property instead. * Delimiter separator character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getSeparatorChar() : string; /** * Delimiter separator character. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ separatorChar : string; /** * @deprecated Please use the 'separatorChar' property instead. * Delimiter separator character. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setSeparatorChar(value: string) : void; /** * @deprecated Please use the 'delimiterShape' property instead. * Specifies the shape of delimiters in the delimiter object. */ getDelimiterShape() : EquationDelimiterShapeType; /** * Specifies the shape of delimiters in the delimiter object. */ delimiterShape : EquationDelimiterShapeType; /** * @deprecated Please use the 'delimiterShape' property instead. * Specifies the shape of delimiters in the delimiter object. * @param value - The value to set. */ setDelimiterShape(value: EquationDelimiterShapeType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Abstract class for deriving other equation nodes. */ export class EquationNode extends FontSetting { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FontSetting); /** * @deprecated Please use the 'parentNode' property instead. * Specifies the parent node of the current node */ getParentNode() : EquationNode; /** * Specifies the parent node of the current node */ parentNode : EquationNode; /** * @deprecated Please use the 'parentNode' property instead. * Specifies the parent node of the current node * @param value - The value to set. */ setParentNode(value: EquationNode) : void; /** * Represents the type of the node. */ getType() : TextNodeType; /** * @deprecated Please use the 'equationType' property instead. * Get the equation type of the current node */ getEquationType() : EquationNodeType; /** * Get the equation type of the current node */ readonly equationType : EquationNodeType; /** * Convert this equtation to LaTeX expression. */ toLaTeX() : string; /** * Convert this equtation to MathML expression. */ toMathML() : string; /** * Insert a node of the specified type at the end of the child node list of the current node. * @param equationType - Types of Equation Nodes * @returns * If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned. */ addChild(equationType: EquationNodeType) : EquationNode; /** * Inserts the specified node at the end of the current node's list of child nodes. * @param node - The specified node */ addChild(node: EquationNode) : void; /** * Inserts a node of the specified type at the specified index position in the current node's child node list. * @param index - index value * @param equationType - Types of Equation Nodes * @returns * If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned. */ insertChild(index: number, equationType: EquationNodeType) : EquationNode; /** * Inserts the specified node after the current node. * @param equationType - Types of Equation Nodes * @returns * If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned. */ insertAfter(equationType: EquationNodeType) : EquationNode; /** * Inserts the specified node before the current node. * @param equationType - Types of Equation Nodes * @returns * If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned. */ insertBefore(equationType: EquationNodeType) : EquationNode; /** * Returns the node at the specified index among the children of the current node. * @param index - Index of the node * @returns * Returns the corresponding node if the specified node exists, otherwise returns null. */ getChild(index: number) : EquationNode; /** * Removes itself from the parent. */ remove() : void; /** * Removes the specified node from the current node's children. * @param node - Node to be deleted. */ removeChild(node: EquationNode) : void; /** * Removes the node at the specified index from the current node's children. * @param index - Index of the node */ removeChild(index: number) : void; /** * Removes all the child nodes of the current node. */ removeAllChildren() : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Create a node of the specified type. * @param equationType - Types of Equation Nodes * @param workbook - The workbook object associated with the equation * @param parent - The parent node where this node is located * @returns * If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned. */ static createNode(equationType: EquationNodeType, workbook: Workbook, parent: EquationNode) : EquationNode; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies a mathematical paragraph containing one or more MathEquationNode(OMath) elements. */ export class EquationNodeParagraph extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'justification' property instead. * This specifies justification of the math paragraph (a series of adjacent equations within the same paragraph). A math paragraph can be Left Justified, Right Justified, Centered, or Centered as Group. By default, the math paragraph is Centered as Group. This means that the equations can be aligned with respect to each other, but the entire group of equations is centered as a whole. */ getJustification() : EquationHorizontalJustificationType; /** * This specifies justification of the math paragraph (a series of adjacent equations within the same paragraph). A math paragraph can be Left Justified, Right Justified, Centered, or Centered as Group. By default, the math paragraph is Centered as Group. This means that the equations can be aligned with respect to each other, but the entire group of equations is centered as a whole. */ justification : EquationHorizontalJustificationType; /** * @deprecated Please use the 'justification' property instead. * This specifies justification of the math paragraph (a series of adjacent equations within the same paragraph). A math paragraph can be Left Justified, Right Justified, Centered, or Centered as Group. By default, the math paragraph is Centered as Group. This means that the equations can be aligned with respect to each other, but the entire group of equations is centered as a whole. * @param value - The value to set. */ setJustification(value: EquationHorizontalJustificationType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the fraction equation, consisting of a numerator and denominator separated by a fraction bar. The fraction bar can be horizontal or diagonal, depending on the fraction properties. The fraction equation is also used to represent the stack function, which places one element above another, with no fraction bar. */ export class FractionEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * @deprecated Please use the 'fractionType' property instead. * This specifies the type of fraction ; the default is 'Bar'. */ getFractionType() : EquationFractionType; /** * This specifies the type of fraction ; the default is 'Bar'. */ fractionType : EquationFractionType; /** * @deprecated Please use the 'fractionType' property instead. * This specifies the type of fraction ; the default is 'Bar'. * @param value - The value to set. */ setFractionType(value: EquationFractionType) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies an n-ary operator equation consisting of an n-ary operator, a base (or operand), and optional upper and lower bounds. */ export class NaryEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Whether to display the lower bound */ isHideSubscript : boolean; /** * @deprecated Please use the 'isHideSubscript' property instead. * Whether to display the lower bound * @param value - The value to set. */ setIsHideSubscript(value: boolean) : void; /** * Whether to display the upper bound */ isHideSuperscript : boolean; /** * @deprecated Please use the 'isHideSuperscript' property instead. * Whether to display the upper bound * @param value - The value to set. */ setIsHideSuperscript(value: boolean) : void; /** * @deprecated Please use the 'limitLocation' property instead. * This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator. */ getLimitLocation() : EquationLimitLocationType; /** * This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator. */ limitLocation : EquationLimitLocationType; /** * @deprecated Please use the 'limitLocation' property instead. * This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator. * @param value - The value to set. */ setLimitLocation(value: EquationLimitLocationType) : void; /** * @deprecated Please use the 'naryOperator' property instead. * an n-ary operator.e.g "∑". * It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ getNaryOperator() : string; /** * an n-ary operator.e.g "∑". * It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. * Use this property setting if you cannot find the character you need in a known type. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ naryOperator : string; /** * @deprecated Please use the 'naryOperator' property instead. * an n-ary operator.e.g "∑". * It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. * Use this property setting if you cannot find the character you need in a known type. * @param value - The value to set. * * @remarks * It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted. */ setNaryOperator(value: string) : void; /** * @deprecated Please use the 'naryOperatorType' property instead. * an n-ary operator.e.g "∑" */ getNaryOperatorType() : EquationMathematicalOperatorType; /** * an n-ary operator.e.g "∑" */ naryOperatorType : EquationMathematicalOperatorType; /** * @deprecated Please use the 'naryOperatorType' property instead. * an n-ary operator.e.g "∑" * @param value - The value to set. */ setNaryOperatorType(value: EquationMathematicalOperatorType) : void; /** * @deprecated Please use the 'naryGrow' property instead. * This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height. */ getNaryGrow() : boolean; /** * This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height. */ naryGrow : boolean; /** * @deprecated Please use the 'naryGrow' property instead. * This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height. * @param value - The value to set. */ setNaryGrow(value: boolean) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the radical equation, consisting of an optional degree deg(EquationNodeType.Degree) and a base. */ export class RadicalEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Whether to hide the degree of radicals. */ isDegHide : boolean; /** * @deprecated Please use the 'isDegHide' property instead. * Whether to hide the degree of radicals. * @param value - The value to set. */ setIsDegHide(value: boolean) : void; /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the components of an equation or mathematical expression. * Different types of components combined into different equations. * For example, a fraction consists of two parts, a numerator component and a denominator component. * For more component types, please refer to 'EquationNodeType'. */ export class EquationComponentNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies an equation that can optionally be superscript or subscript. * There are four main forms of this equation, superscript,subscript,superscript and subscript placed to the left of the base, superscript and subscript placed to the right of the base. */ export class SubSupEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Equation node class of unknown type */ export class UnknowEquationNode extends EquationNode { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: EquationNode); /** * Determine whether the current equation node is equal to the specified node * @param obj - The specified node */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the unit type of line space size. */ export enum LineSpaceSizeType { /** * Represents in unit of a percentage of the text size. */ Percentage = 0, /** * Represents in unit of points. */ Points = 1, } /** * Represents no bullet. */ export class NoneBulletValue extends BulletValue { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BulletValue); /** * Default Constructor. */ constructor(); /** * Gets the type of the bullet's value. */ getType() : BulletType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the value of the image bullet. */ export class PictureBulletValue extends BulletValue { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BulletValue); /** * Default Constructor. */ constructor(); /** * Gets the type of the bullet's value. */ getType() : BulletType; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets image data of the bullet. */ getImageData() : Uint8Array; /** * Gets and sets image data of the bullet. */ imageData : Uint8Array; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets image data of the bullet. * @param value - The value to set. */ setImageData(value: Uint8Array) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all automatic number scheme. */ export enum TextAutonumberScheme { /** */ None = 0, /** * (a), (b), (c), … */ AlphaLcParenBoth = 1, /** * a), b), c), … */ AlphaLcParenR = 2, /** * a., b., c., … */ AlphaLcPeriod = 3, /** * (A), (B), (C), … */ AlphaUcParenBoth = 4, /** * A), B), C), … */ AlphaUcParenR = 5, /** * A., B., C., … */ AlphaUcPeriod = 6, /** * Bidi Arabic 1 (AraAlpha) with ANSI minus symbol */ Arabic1Minus = 7, /** * Bidi Arabic 2 (AraAbjad) with ANSI minus symbol */ Arabic2Minus = 8, /** * Dbl-byte Arabic numbers w/ double-byte period */ ArabicDbPeriod = 9, /** * Dbl-byte Arabic numbers */ ArabicDbPlain = 10, /** * (1), (2), (3), … */ ArabicParenBoth = 11, /** * 1), 2), 3), … */ ArabicParenR = 12, /** * 1., 2., 3., … */ ArabicPeriod = 13, /** * 1, 2, 3, … */ ArabicPlain = 14, /** * Dbl-byte circle numbers (1-10 circle[0x2460-], 11-arabic numbers) */ CircleNumDbPlain = 15, /** * Wingdings black circle numbers */ CircleNumWdBlackPlain = 16, /** * Wingdings white circle numbers (0-10 circle[0x0080-],11- arabic numbers) */ CircleNumWdWhitePlain = 17, /** * EA: Simplified Chinese w/ single-byte period */ Ea1ChsPeriod = 18, /** * EA: Simplified Chinese (TypeA 1-99, TypeC 100-) */ Ea1ChsPlain = 19, /** * EA: Traditional Chinese w/ single-byte period */ Ea1ChtPeriod = 20, /** * EA: Traditional Chinese (TypeA 1-19, TypeC 20-) */ Ea1ChtPlain = 21, /** * EA: Japanese w/ double-byte period */ Ea1JpnChsDbPeriod = 22, /** * EA: Japanese/Korean w/ single-byte period */ Ea1JpnKorPeriod = 23, /** * EA: Japanese/Korean (TypeC 1-) */ Ea1JpnKorPlain = 24, /** * Bidi Hebrew 2 with ANSI minus symbol */ Hebrew2Minus = 25, /** * Hindi alphabet period - consonants */ HindiAlpha1Period = 26, /** * Hindi alphabet period - vowels */ HindiAlphaPeriod = 27, /** * Hindi numerical parentheses - right */ HindiNumParenR = 28, /** * Hindi numerical period */ HindiNumPeriod = 29, /** * (i), (ii), (iii), … */ RomanLcParenBoth = 30, /** * i), ii), iii), … */ RomanLcParenR = 31, /** * i., ii., iii., … */ RomanLcPeriod = 32, /** * (I), (II), (III), … */ RomanUcParenBoth = 33, /** * I), II), III), … */ RomanUcParenR = 34, /** * I., II., III., … */ RomanUcPeriod = 35, /** * Thai alphabet parentheses - both */ ThaiAlphaParenBoth = 36, /** * Thai alphabet parentheses - right */ ThaiAlphaParenR = 37, /** * Thai alphabet period */ ThaiAlphaPeriod = 38, /** * Thai numerical parentheses - both */ ThaiNumParenBoth = 39, /** * Thai numerical parentheses - right */ ThaiNumParenR = 40, /** * Thai numerical period */ ThaiNumPeriod = 41, } /** * Represents a geometric shape. */ export class Geometry { /** * @deprecated Please use the 'shapeAdjustValues' property instead. * Gets a collection of shape adjust value */ getShapeAdjustValues() : ShapeGuideCollection; /** * Gets a collection of shape adjust value */ readonly shapeAdjustValues : ShapeGuideCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the different types of font alignment. */ export enum TextFontAlignType { /** * When the text flow is horizontal or simple vertical same as fontBaseline * but for other vertical modes same as fontCenter. */ Automatic = 0, /** * The letters are anchored to the very bottom of a single line. */ Bottom = 1, /** * The letters are anchored to the bottom baseline of a single line. */ Baseline = 2, /** * The letters are anchored between the two baselines of a single line. */ Center = 3, /** * The letters are anchored to the top baseline of a single line. */ Top = 4, } /** * Represents the setting of shape's text alignment; */ export class ShapeTextAlignment { /** * Gets or sets the text wrapped type of the shape which contains text. */ isTextWrapped : boolean; /** * @deprecated Please use the 'isTextWrapped' property instead. * Gets or sets the text wrapped type of the shape which contains text. * @param value - The value to set. */ setIsTextWrapped(value: boolean) : void; /** * @deprecated Please use the 'rotateTextWithShape' property instead. * Indicates whether rotating text with shape. */ getRotateTextWithShape() : boolean; /** * Indicates whether rotating text with shape. */ rotateTextWithShape : boolean; /** * @deprecated Please use the 'rotateTextWithShape' property instead. * Indicates whether rotating text with shape. * @param value - The value to set. */ setRotateTextWithShape(value: boolean) : void; /** * @deprecated Please use the 'textVerticalOverflow' property instead. * Gets and sets the text vertical overflow type of the text box. */ getTextVerticalOverflow() : TextOverflowType; /** * Gets and sets the text vertical overflow type of the text box. */ textVerticalOverflow : TextOverflowType; /** * @deprecated Please use the 'textVerticalOverflow' property instead. * Gets and sets the text vertical overflow type of the text box. * @param value - The value to set. */ setTextVerticalOverflow(value: TextOverflowType) : void; /** * @deprecated Please use the 'textHorizontalOverflow' property instead. * Gets and sets the text horizontal overflow type of the text box. */ getTextHorizontalOverflow() : TextOverflowType; /** * Gets and sets the text horizontal overflow type of the text box. */ textHorizontalOverflow : TextOverflowType; /** * @deprecated Please use the 'textHorizontalOverflow' property instead. * Gets and sets the text horizontal overflow type of the text box. * @param value - The value to set. */ setTextHorizontalOverflow(value: TextOverflowType) : void; /** * @deprecated Please use the 'rotationAngle' property instead. * Gets and sets the rotation of the shape. */ getRotationAngle() : number; /** * Gets and sets the rotation of the shape. */ rotationAngle : number; /** * @deprecated Please use the 'rotationAngle' property instead. * Gets and sets the rotation of the shape. * @param value - The value to set. */ setRotationAngle(value: number) : void; /** * @deprecated Please use the 'textVerticalType' property instead. * Gets and sets the text direction. */ getTextVerticalType() : TextVerticalType; /** * Gets and sets the text direction. */ textVerticalType : TextVerticalType; /** * @deprecated Please use the 'textVerticalType' property instead. * Gets and sets the text direction. * @param value - The value to set. */ setTextVerticalType(value: TextVerticalType) : void; /** * Indicates whether the shape is locked when worksheet is protected. * * @remarks * Only works when worksheet is protected. */ isLockedText : boolean; /** * @deprecated Please use the 'isLockedText' property instead. * Indicates whether the shape is locked when worksheet is protected. * @param value - The value to set. * * @remarks * Only works when worksheet is protected. */ setIsLockedText(value: boolean) : void; /** * @deprecated Please use the 'autoSize' property instead. * Indicates if size of shape is adjusted automatically according to its content. */ getAutoSize() : boolean; /** * Indicates if size of shape is adjusted automatically according to its content. */ autoSize : boolean; /** * @deprecated Please use the 'autoSize' property instead. * Indicates if size of shape is adjusted automatically according to its content. * @param value - The value to set. */ setAutoSize(value: boolean) : void; /** * @deprecated Please use the 'textShapeType' property instead. * Gets and set the transform type of text. */ getTextShapeType() : AutoShapeType; /** * Gets and set the transform type of text. */ textShapeType : AutoShapeType; /** * @deprecated Please use the 'textShapeType' property instead. * Gets and set the transform type of text. * @param value - The value to set. */ setTextShapeType(value: AutoShapeType) : void; /** * @deprecated Please use the 'topMarginPt' property instead. * Returns the top margin in unit of Points */ getTopMarginPt() : number; /** * Returns the top margin in unit of Points */ topMarginPt : number; /** * @deprecated Please use the 'topMarginPt' property instead. * Returns the top margin in unit of Points * @param value - The value to set. */ setTopMarginPt(value: number) : void; /** * @deprecated Please use the 'bottomMarginPt' property instead. * Returns the bottom margin in unit of Points */ getBottomMarginPt() : number; /** * Returns the bottom margin in unit of Points */ bottomMarginPt : number; /** * @deprecated Please use the 'bottomMarginPt' property instead. * Returns the bottom margin in unit of Points * @param value - The value to set. */ setBottomMarginPt(value: number) : void; /** * @deprecated Please use the 'leftMarginPt' property instead. * Returns the left margin in unit of Points */ getLeftMarginPt() : number; /** * Returns the left margin in unit of Points */ leftMarginPt : number; /** * @deprecated Please use the 'leftMarginPt' property instead. * Returns the left margin in unit of Points * @param value - The value to set. */ setLeftMarginPt(value: number) : void; /** * @deprecated Please use the 'rightMarginPt' property instead. * Returns the right margin in unit of Points */ getRightMarginPt() : number; /** * Returns the right margin in unit of Points */ rightMarginPt : number; /** * @deprecated Please use the 'rightMarginPt' property instead. * Returns the right margin in unit of Points * @param value - The value to set. */ setRightMarginPt(value: number) : void; /** * Indicates whether the margin of the text frame is automatic. */ isAutoMargin : boolean; /** * @deprecated Please use the 'isAutoMargin' property instead. * Indicates whether the margin of the text frame is automatic. * @param value - The value to set. */ setIsAutoMargin(value: boolean) : void; /** * @deprecated Please use the 'numberOfColumns' property instead. * Gets and sets the number of columns of text in the bounding rectangle. */ getNumberOfColumns() : number; /** * Gets and sets the number of columns of text in the bounding rectangle. */ numberOfColumns : number; /** * @deprecated Please use the 'numberOfColumns' property instead. * Gets and sets the number of columns of text in the bounding rectangle. * @param value - The value to set. */ setNumberOfColumns(value: number) : void; /** * Determines whether this instance has the same value as another specified object. * @param obj - The object to compare with this instance. * @returns * true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false. */ equals(obj: Object) : boolean; /** */ getHashCode() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the node type. */ export enum TextNodeType { /** * Represents the text node. */ TextRun = 0, /** * Represents the text paragraph. */ TextParagraph = 1, /** * Represents the equation text. */ Equation = 2, } /** * Represents the text paragraph setting. */ export class TextParagraph extends FontSetting { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: FontSetting); /** * @deprecated Please use the 'bullet' property instead. * Gets the bullet. */ getBullet() : Bullet; /** * Gets the bullet. */ readonly bullet : Bullet; /** * Gets the type of text node. */ getType() : TextNodeType; /** * @deprecated Please use the 'lineSpaceSizeType' property instead. * Gets and sets the amount of vertical white space that will be used within a paragraph. */ getLineSpaceSizeType() : LineSpaceSizeType; /** * Gets and sets the amount of vertical white space that will be used within a paragraph. */ lineSpaceSizeType : LineSpaceSizeType; /** * @deprecated Please use the 'lineSpaceSizeType' property instead. * Gets and sets the amount of vertical white space that will be used within a paragraph. * @param value - The value to set. */ setLineSpaceSizeType(value: LineSpaceSizeType) : void; /** * @deprecated Please use the 'lineSpace' property instead. * Gets and sets the amount of vertical white space that will be used within a paragraph. */ getLineSpace() : number; /** * Gets and sets the amount of vertical white space that will be used within a paragraph. */ lineSpace : number; /** * @deprecated Please use the 'lineSpace' property instead. * Gets and sets the amount of vertical white space that will be used within a paragraph. * @param value - The value to set. */ setLineSpace(value: number) : void; /** * @deprecated Please use the 'spaceAfterSizeType' property instead. * Gets and sets the amount of vertical white space that will be present after a paragraph. */ getSpaceAfterSizeType() : LineSpaceSizeType; /** * Gets and sets the amount of vertical white space that will be present after a paragraph. */ spaceAfterSizeType : LineSpaceSizeType; /** * @deprecated Please use the 'spaceAfterSizeType' property instead. * Gets and sets the amount of vertical white space that will be present after a paragraph. * @param value - The value to set. */ setSpaceAfterSizeType(value: LineSpaceSizeType) : void; /** * @deprecated Please use the 'spaceAfter' property instead. * Gets and sets the amount of vertical white space that will be present after a paragraph. */ getSpaceAfter() : number; /** * Gets and sets the amount of vertical white space that will be present after a paragraph. */ spaceAfter : number; /** * @deprecated Please use the 'spaceAfter' property instead. * Gets and sets the amount of vertical white space that will be present after a paragraph. * @param value - The value to set. */ setSpaceAfter(value: number) : void; /** * @deprecated Please use the 'spaceBeforeSizeType' property instead. * Gets and sets the amount of vertical white space that will be present before a paragraph. */ getSpaceBeforeSizeType() : LineSpaceSizeType; /** * Gets and sets the amount of vertical white space that will be present before a paragraph. */ spaceBeforeSizeType : LineSpaceSizeType; /** * @deprecated Please use the 'spaceBeforeSizeType' property instead. * Gets and sets the amount of vertical white space that will be present before a paragraph. * @param value - The value to set. */ setSpaceBeforeSizeType(value: LineSpaceSizeType) : void; /** * @deprecated Please use the 'spaceBefore' property instead. * Gets and sets the amount of vertical white space that will be present before a paragraph. */ getSpaceBefore() : number; /** * Gets and sets the amount of vertical white space that will be present before a paragraph. */ spaceBefore : number; /** * @deprecated Please use the 'spaceBefore' property instead. * Gets and sets the amount of vertical white space that will be present before a paragraph. * @param value - The value to set. */ setSpaceBefore(value: number) : void; /** * @deprecated Please use the 'stops' property instead. * Gets tab stop list. */ getStops() : TextTabStopCollection; /** * Gets tab stop list. */ readonly stops : TextTabStopCollection; /** * Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added. */ isLatinLineBreak : boolean; /** * @deprecated Please use the 'isLatinLineBreak' property instead. * Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added. * @param value - The value to set. */ setIsLatinLineBreak(value: boolean) : void; /** * Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added. */ isEastAsianLineBreak : boolean; /** * @deprecated Please use the 'isEastAsianLineBreak' property instead. * Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added. * @param value - The value to set. */ setIsEastAsianLineBreak(value: boolean) : void; /** * Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text. */ isHangingPunctuation : boolean; /** * @deprecated Please use the 'isHangingPunctuation' property instead. * Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text. * @param value - The value to set. */ setIsHangingPunctuation(value: boolean) : void; /** * @deprecated Please use the 'rightMargin' property instead. * Specifies the right margin of the paragraph. */ getRightMargin() : number; /** * Specifies the right margin of the paragraph. */ rightMargin : number; /** * @deprecated Please use the 'rightMargin' property instead. * Specifies the right margin of the paragraph. * @param value - The value to set. */ setRightMargin(value: number) : void; /** * @deprecated Please use the 'leftMargin' property instead. * Specifies the left margin of the paragraph. */ getLeftMargin() : number; /** * Specifies the left margin of the paragraph. */ leftMargin : number; /** * @deprecated Please use the 'leftMargin' property instead. * Specifies the left margin of the paragraph. * @param value - The value to set. */ setLeftMargin(value: number) : void; /** * @deprecated Please use the 'firstLineIndent' property instead. * Specifies the indent size that will be applied to the first line of text in the paragraph. */ getFirstLineIndent() : number; /** * Specifies the indent size that will be applied to the first line of text in the paragraph. */ firstLineIndent : number; /** * @deprecated Please use the 'firstLineIndent' property instead. * Specifies the indent size that will be applied to the first line of text in the paragraph. * @param value - The value to set. */ setFirstLineIndent(value: number) : void; /** * @deprecated Please use the 'fontAlignType' property instead. * Determines where vertically on a line of text the actual words are positioned. This deals * with vertical placement of the characters with respect to the baselines. */ getFontAlignType() : TextFontAlignType; /** * Determines where vertically on a line of text the actual words are positioned. This deals * with vertical placement of the characters with respect to the baselines. */ fontAlignType : TextFontAlignType; /** * @deprecated Please use the 'fontAlignType' property instead. * Determines where vertically on a line of text the actual words are positioned. This deals * with vertical placement of the characters with respect to the baselines. * @param value - The value to set. */ setFontAlignType(value: TextFontAlignType) : void; /** * @deprecated Please use the 'alignmentType' property instead. * Gets and sets the text horizontal alignment type of the paragraph. */ getAlignmentType() : TextAlignmentType; /** * Gets and sets the text horizontal alignment type of the paragraph. */ alignmentType : TextAlignmentType; /** * @deprecated Please use the 'alignmentType' property instead. * Gets and sets the text horizontal alignment type of the paragraph. * @param value - The value to set. */ setAlignmentType(value: TextAlignmentType) : void; /** * @deprecated Please use the 'defaultTabSize' property instead. * Gets and sets the default size for a tab character within this paragraph. */ getDefaultTabSize() : number; /** * Gets and sets the default size for a tab character within this paragraph. */ defaultTabSize : number; /** * @deprecated Please use the 'defaultTabSize' property instead. * Gets and sets the default size for a tab character within this paragraph. * @param value - The value to set. */ setDefaultTabSize(value: number) : void; /** * @deprecated Please use the 'children' property instead. * Gets all text runs in this paragraph. * If this paragraph is empty, return paragraph itself. */ getChildren() : FontSetting[]; /** * Gets all text runs in this paragraph. * If this paragraph is empty, return paragraph itself. */ readonly children : FontSetting[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the text tab alignment types. */ export enum TextTabAlignmentType { /** * The text at this tab stop is center aligned. */ Center = 0, /** * At this tab stop, the decimals are lined up. */ Decimal = 1, /** * The text at this tab stop is left aligned. */ Left = 2, /** * The text at this tab stop is right aligned. */ Right = 3, } /** * Represents tab stop. */ export class TextTabStop { /** * @deprecated Please use the 'tabAlignment' property instead. * Specifies the alignment that is to be applied to text using this tab stop. */ getTabAlignment() : TextTabAlignmentType; /** * Specifies the alignment that is to be applied to text using this tab stop. */ tabAlignment : TextTabAlignmentType; /** * @deprecated Please use the 'tabAlignment' property instead. * Specifies the alignment that is to be applied to text using this tab stop. * @param value - The value to set. */ setTabAlignment(value: TextTabAlignmentType) : void; /** * @deprecated Please use the 'tabPosition' property instead. * Specifies the position of the tab stop relative to the left margin. */ getTabPosition() : number; /** * Specifies the position of the tab stop relative to the left margin. */ tabPosition : number; /** * @deprecated Please use the 'tabPosition' property instead. * Specifies the position of the tab stop relative to the left margin. * @param value - The value to set. */ setTabPosition(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of all tab stops. */ export class TextTabStopCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets by the index. * @param index - The index. */ get(index: number) : TextTabStop; /** * Adds a tab stop. * @param tabAlignment - * @param tabPosition - */ add(tabAlignment: TextTabAlignmentType, tabPosition: number) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the text direct type. */ export enum TextVerticalType { /** * East Asian Vertical display. */ Vertical = 0, /** * Horizontal text. */ Horizontal = 1, /** * Displayed vertical and the text flows top down then LEFT to RIGHT */ VerticalLeftToRight = 2, /** * Each line is 90 degrees rotated clockwise */ Vertical90 = 3, /** * Each line is 270 degrees rotated clockwise */ Vertical270 = 4, /** * Determines if all of the text is vertical */ Stacked = 5, /** * Specifies that vertical WordArt should be shown from right to left rather than left to right. */ StackedRightToLeft = 6, } /** * Specifies how to apply style for parsed values when converting string value to number or datetime. */ export enum TxtLoadStyleStrategy { /** * Does not set style for the parsed value. */ None = 0, /** * Set the style as built-in number/datetime when the parsed value are plain numeric/datetime values. * * @remarks * When ms excel parsing datetime or numeric values according to user's input(such as CSV file), * the formatting of those values may be changed, such as * leading/tailing zeros of number, year/month/day order of datetime, ...etc. * This type is for simulating ms excel's behavior. */ BuiltIn = 1, /** * Set the exact custom format for the parsed value to make the formatted value be same with the original input one. */ ExactFormat = 2, } /** * Represents a custom geometric shape. */ export class CustomGeometry extends Geometry { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Geometry); /** * @deprecated Please use the 'paths' property instead. * Gets path collection information when shape is a NotPrimitive autoshape */ getPaths() : ShapePathCollection; /** * Gets path collection information when shape is a NotPrimitive autoshape */ readonly paths : ShapePathCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a shape guide specifies the presence of a shape guide that will be used to * govern the geometry of the specified shape */ export class ShapeGuide extends BaseShapeGuide { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: BaseShapeGuide); /** * @deprecated Please use the 'value' property instead. * Gets or sets value of this guide */ getValue() : number; /** * Gets or sets value of this guide */ value : number; /** * @deprecated Please use the 'value' property instead. * Gets or sets value of this guide * @param value - The value to set. */ setValue(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a collection of shape guide */ export class ShapeGuideCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets a shape guide by index * @param index - */ get(index: number) : ShapeGuide; /** * Adds a shape guide.(Important: This feature is currently only available for Excel07 and above) * @param name - the name of adjust. It's as "adj(Used when there is only one adjustment value)", "adj1", "adj2", "adj3" and so on. * @param val - the value of adjust */ add(name: string, val: number) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents type of the property to be locked. */ export enum ShapeLockType { /** * Group */ Group = 0, /** * AdjustHandles */ AdjustHandles = 1, /** * Text */ Text = 2, /** * Points */ Points = 3, /** * Crop */ Crop = 4, /** * Selection */ Selection = 5, /** * Move */ Move = 6, /** * AspectRatio */ AspectRatio = 7, /** * Rotation */ Rotation = 8, /** * Ungroup */ Ungroup = 9, /** * Resize */ Resize = 10, /** * ShapeType */ ShapeType = 11, /** * Arrowhead */ Arrowhead = 12, } /** * Represents a creation path consisting of a series of moves, lines and curves that when combined will form a geometric shape. */ export class ShapeSegmentPathCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets object. * @param index - The index. * @returns * Returns a object. */ get(index: number) : ShapeSegmentPath; /** * Add a segment path in creation path. * @param type - The path type. * @returns * Returns the position of object in the list. */ add(type: ShapePathType) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specify position coordinates or angle markers. * Position coordinates represent the coordinates of a path in a coordinate space (e.g. X/Y). * Angle markers indicate angular changes in a path (e.g. the start and swing angles of an arc). */ export class ShapePathPoint { /** * @deprecated Please use the 'x' property instead. * Gets and sets x coordinate for this position coordinate. Unit EMUs. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties instead. */ getX() : number; /** * Gets and sets x coordinate for this position coordinate. Unit EMUs. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties instead. */ x : number; /** * @deprecated Please use the 'x' property instead. * Gets and sets x coordinate for this position coordinate. Unit EMUs. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.XPixel and ShapePathPoint.XAngle properties instead. */ setX(value: number) : void; /** * @deprecated Please use the 'y' property instead. * Gets y coordinate for this position coordinate. Unit EMUs. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties instead. */ getY() : number; /** * Gets y coordinate for this position coordinate. Unit EMUs. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties instead. */ y : number; /** * @deprecated Please use the 'y' property instead. * Gets y coordinate for this position coordinate. Unit EMUs. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties. * This property will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ShapePathPoint.YPixel and ShapePathPoint.YAngle properties instead. */ setY(value: number) : void; /** * @deprecated Please use the 'xPixel' property instead. * When the object is a position coordinate, get or set the x coordinate in pixels. */ getXPixel() : number; /** * When the object is a position coordinate, get or set the x coordinate in pixels. */ xPixel : number; /** * @deprecated Please use the 'xPixel' property instead. * When the object is a position coordinate, get or set the x coordinate in pixels. * @param value - The value to set. */ setXPixel(value: number) : void; /** * @deprecated Please use the 'yPixel' property instead. * When the object is a position coordinate, get or set the y coordinate in pixels. */ getYPixel() : number; /** * When the object is a position coordinate, get or set the y coordinate in pixels. */ yPixel : number; /** * @deprecated Please use the 'yPixel' property instead. * When the object is a position coordinate, get or set the y coordinate in pixels. * @param value - The value to set. */ setYPixel(value: number) : void; /** * @deprecated Please use the 'xAngle' property instead. * When the object is an angle marker, get or set the first angle in degrees. * * @remarks * If this angle is the starting angle of an arc. This angle will specify what angle along the supposed circle path will be used as the start position for drawing the arc. This start angle will be locked to the last known pen position in the shape path. Thus guaranteeing a continuos shape path. */ getXAngle() : number; /** * When the object is an angle marker, get or set the first angle in degrees. * * @remarks * If this angle is the starting angle of an arc. This angle will specify what angle along the supposed circle path will be used as the start position for drawing the arc. This start angle will be locked to the last known pen position in the shape path. Thus guaranteeing a continuos shape path. */ xAngle : number; /** * @deprecated Please use the 'xAngle' property instead. * When the object is an angle marker, get or set the first angle in degrees. * @param value - The value to set. * * @remarks * If this angle is the starting angle of an arc. This angle will specify what angle along the supposed circle path will be used as the start position for drawing the arc. This start angle will be locked to the last known pen position in the shape path. Thus guaranteeing a continuos shape path. */ setXAngle(value: number) : void; /** * @deprecated Please use the 'yAngle' property instead. * When the object is an angle marker, get or set the second angle in degrees. * * @remarks * If this angle is the swing angle of an arc. This angle will specify how far angle-wise along the supposed cicle path the arc will be extended. The extension from the start angle will always be in the clockwise direction around the supposed circle. */ getYAngle() : number; /** * When the object is an angle marker, get or set the second angle in degrees. * * @remarks * If this angle is the swing angle of an arc. This angle will specify how far angle-wise along the supposed cicle path the arc will be extended. The extension from the start angle will always be in the clockwise direction around the supposed circle. */ yAngle : number; /** * @deprecated Please use the 'yAngle' property instead. * When the object is an angle marker, get or set the second angle in degrees. * @param value - The value to set. * * @remarks * If this angle is the swing angle of an arc. This angle will specify how far angle-wise along the supposed cicle path the arc will be extended. The extension from the start angle will always be in the clockwise direction around the supposed circle. */ setYAngle(value: number) : void; /** * @deprecated Please use the 'type' property instead. * Specifies the value type of the current object. */ getType() : ShapePathPointValueType; /** * Specifies the value type of the current object. */ readonly type : ShapePathPointValueType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all shape path points. */ export class ShapePathPointCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets shape path point by index. * @param index - The index * @returns * Returns object */ get(index: number) : ShapePathPoint; /** * Adds a path point in unit of EMUs. * @param x - The x coordinate. * @param y - The y coordinate. * * @remarks * NOTE: This member is now obsolete. Instead, * please use the MoveTo,LineTo,CubicBezierTo and ArcTo methods in ShapePath. * This method will be removed 12 months later since August 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use the MoveTo,LineTo,CubicBezierTo and ArcTo methods in ShapePath instead. */ add(x: number, y: number) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specifies an external data connection */ export class ExternalConnection { /** * @deprecated Please use the 'id' property instead. * Gets the id of the connection. */ getId() : number; /** * Gets the id of the connection. */ readonly id : number; /** * @deprecated Please use the 'connectionId' property instead. * Specifies The unique identifier of this connection. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.Id property. * This property will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.Id property instead. */ getConnectionId() : number; /** * Specifies The unique identifier of this connection. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.Id property. * This property will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.Id property instead. */ readonly connectionId : number; /** * Gets the type of this object. */ getClassType() : ExternalConnectionClassType; /** * Gets the definition of power query formula. */ getPowerQueryFormula() : PowerQueryFormula; /** * @deprecated Please use the 'sourceType' property instead. * Gets or Sets the external connection DataSource type. */ getSourceType() : ConnectionDataSourceType; /** * Gets or Sets the external connection DataSource type. */ sourceType : ConnectionDataSourceType; /** * @deprecated Please use the 'sourceType' property instead. * Gets or Sets the external connection DataSource type. * @param value - The value to set. */ setSourceType(value: ConnectionDataSourceType) : void; /** * @deprecated Please use the 'sSOId' property instead. * Identifier for Single Sign On (SSO) used for authentication between an intermediate * spreadsheetML server and the external data source. */ getSSOId() : string; /** * Identifier for Single Sign On (SSO) used for authentication between an intermediate * spreadsheetML server and the external data source. */ sSOId : string; /** * @deprecated Please use the 'sSOId' property instead. * Identifier for Single Sign On (SSO) used for authentication between an intermediate * spreadsheetML server and the external data source. * @param value - The value to set. */ setSSOId(value: string) : void; /** * @deprecated Please use the 'savePassword' property instead. * True if the password is to be saved as part of the connection string; otherwise, False. */ getSavePassword() : boolean; /** * True if the password is to be saved as part of the connection string; otherwise, False. */ savePassword : boolean; /** * @deprecated Please use the 'savePassword' property instead. * True if the password is to be saved as part of the connection string; otherwise, False. * @param value - The value to set. */ setSavePassword(value: boolean) : void; /** * @deprecated Please use the 'saveData' property instead. * True if the external data fetched over the connection to populate a table is to be saved * with the workbook; otherwise, false. */ getSaveData() : boolean; /** * True if the external data fetched over the connection to populate a table is to be saved * with the workbook; otherwise, false. */ saveData : boolean; /** * @deprecated Please use the 'saveData' property instead. * True if the external data fetched over the connection to populate a table is to be saved * with the workbook; otherwise, false. * @param value - The value to set. */ setSaveData(value: boolean) : void; /** * @deprecated Please use the 'refreshOnLoad' property instead. * True if this connection should be refreshed when opening the file; otherwise, false. */ getRefreshOnLoad() : boolean; /** * True if this connection should be refreshed when opening the file; otherwise, false. */ refreshOnLoad : boolean; /** * @deprecated Please use the 'refreshOnLoad' property instead. * True if this connection should be refreshed when opening the file; otherwise, false. * @param value - The value to set. */ setRefreshOnLoad(value: boolean) : void; /** * @deprecated Please use the 'reconnectionMethodType' property instead. * Specifies what the spreadsheet application should do when a connection fails. * The default value is ReConnectionMethodType.Required. */ getReconnectionMethodType() : ReConnectionMethodType; /** * Specifies what the spreadsheet application should do when a connection fails. * The default value is ReConnectionMethodType.Required. */ reconnectionMethodType : ReConnectionMethodType; /** * @deprecated Please use the 'reconnectionMethodType' property instead. * Specifies what the spreadsheet application should do when a connection fails. * The default value is ReConnectionMethodType.Required. * @param value - The value to set. */ setReconnectionMethodType(value: ReConnectionMethodType) : void; /** * @deprecated Please use the 'onlyUseConnectionFile' property instead. * Indicates whether the spreadsheet application should always and only use the * connection information in the external connection file indicated by the odcFile attribute * when the connection is refreshed. If false, then the spreadsheet application * should follow the procedure indicated by the reconnectionMethod attribute */ getOnlyUseConnectionFile() : boolean; /** * Indicates whether the spreadsheet application should always and only use the * connection information in the external connection file indicated by the odcFile attribute * when the connection is refreshed. If false, then the spreadsheet application * should follow the procedure indicated by the reconnectionMethod attribute */ onlyUseConnectionFile : boolean; /** * @deprecated Please use the 'onlyUseConnectionFile' property instead. * Indicates whether the spreadsheet application should always and only use the * connection information in the external connection file indicated by the odcFile attribute * when the connection is refreshed. If false, then the spreadsheet application * should follow the procedure indicated by the reconnectionMethod attribute * @param value - The value to set. */ setOnlyUseConnectionFile(value: boolean) : void; /** * @deprecated Please use the 'odcFile' property instead. * Specifies the full path to external connection file from which this connection was * created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, * then the spreadsheet application will try again using information from the external connection file * instead of the connection object embedded within the workbook. */ getOdcFile() : string; /** * Specifies the full path to external connection file from which this connection was * created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, * then the spreadsheet application will try again using information from the external connection file * instead of the connection object embedded within the workbook. */ odcFile : string; /** * @deprecated Please use the 'odcFile' property instead. * Specifies the full path to external connection file from which this connection was * created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, * then the spreadsheet application will try again using information from the external connection file * instead of the connection object embedded within the workbook. * @param value - The value to set. */ setOdcFile(value: string) : void; /** * @deprecated Please use the 'sourceFile' property instead. * Used when the external data source is file-based. * When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be * expressed in URI or system-specific file path notation. */ getSourceFile() : string; /** * Used when the external data source is file-based. * When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be * expressed in URI or system-specific file path notation. */ sourceFile : string; /** * @deprecated Please use the 'sourceFile' property instead. * Used when the external data source is file-based. * When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be * expressed in URI or system-specific file path notation. * @param value - The value to set. */ setSourceFile(value: string) : void; /** * Gets the connection file. */ getConnectionFile() : string; /** * True if the connection has not been refreshed for the first time; otherwise, false. * This state can happen when the user saves the file before a query has finished returning. */ isNew : boolean; /** * @deprecated Please use the 'isNew' property instead. * True if the connection has not been refreshed for the first time; otherwise, false. * This state can happen when the user saves the file before a query has finished returning. * @param value - The value to set. */ setIsNew(value: boolean) : void; /** * @deprecated Please use the 'name' property instead. * Specifies the name of the connection. Each connection must have a unique name. */ getName() : string; /** * Specifies the name of the connection. Each connection must have a unique name. */ name : string; /** * @deprecated Please use the 'name' property instead. * Specifies the name of the connection. Each connection must have a unique name. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'keepAlive' property instead. * True when the spreadsheet application should make efforts to keep the connection * open. When false, the application should close the connection after retrieving the * information. */ getKeepAlive() : boolean; /** * True when the spreadsheet application should make efforts to keep the connection * open. When false, the application should close the connection after retrieving the * information. */ keepAlive : boolean; /** * @deprecated Please use the 'keepAlive' property instead. * True when the spreadsheet application should make efforts to keep the connection * open. When false, the application should close the connection after retrieving the * information. * @param value - The value to set. */ setKeepAlive(value: boolean) : void; /** * @deprecated Please use the 'refreshInternal' property instead. * Specifies the number of minutes between automatic refreshes of the connection. */ getRefreshInternal() : number; /** * Specifies the number of minutes between automatic refreshes of the connection. */ refreshInternal : number; /** * @deprecated Please use the 'refreshInternal' property instead. * Specifies the number of minutes between automatic refreshes of the connection. * @param value - The value to set. */ setRefreshInternal(value: number) : void; /** * @deprecated Please use the 'connectionDescription' property instead. * Specifies the user description for this connection */ getConnectionDescription() : string; /** * Specifies the user description for this connection */ connectionDescription : string; /** * @deprecated Please use the 'connectionDescription' property instead. * Specifies the user description for this connection * @param value - The value to set. */ setConnectionDescription(value: string) : void; /** * Indicates whether the associated workbook connection has been deleted. true if the * connection has been deleted; otherwise, false. */ isDeleted : boolean; /** * @deprecated Please use the 'isDeleted' property instead. * Indicates whether the associated workbook connection has been deleted. true if the * connection has been deleted; otherwise, false. * @param value - The value to set. */ setIsDeleted(value: boolean) : void; /** * @deprecated Please use the 'credentialsMethodType' property instead. * Specifies the authentication method to be used when establishing (or re-establishing) the connection. */ getCredentialsMethodType() : CredentialsMethodType; /** * Specifies the authentication method to be used when establishing (or re-establishing) the connection. */ credentialsMethodType : CredentialsMethodType; /** * @deprecated Please use the 'credentialsMethodType' property instead. * Specifies the authentication method to be used when establishing (or re-establishing) the connection. * @param value - The value to set. */ setCredentialsMethodType(value: CredentialsMethodType) : void; /** * @deprecated Please use the 'backgroundRefresh' property instead. * Indicates whether the connection can be refreshed in the background (asynchronously). * true if preferred usage of the connection is to refresh asynchronously in the background; * false if preferred usage of the connection is to refresh synchronously in the foreground. */ getBackgroundRefresh() : boolean; /** * Indicates whether the connection can be refreshed in the background (asynchronously). * true if preferred usage of the connection is to refresh asynchronously in the background; * false if preferred usage of the connection is to refresh synchronously in the foreground. */ backgroundRefresh : boolean; /** * @deprecated Please use the 'backgroundRefresh' property instead. * Indicates whether the connection can be refreshed in the background (asynchronously). * true if preferred usage of the connection is to refresh asynchronously in the background; * false if preferred usage of the connection is to refresh synchronously in the foreground. * @param value - The value to set. */ setBackgroundRefresh(value: boolean) : void; /** * @deprecated Please use the 'parameters' property instead. * Gets for an ODBC or web query. */ getParameters() : ConnectionParameterCollection; /** * Gets for an ODBC or web query. */ readonly parameters : ConnectionParameterCollection; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data */ getCommand() : string; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data * @param value - The value to set. */ setCommand(value: string) : void; /** * Specifies the OLE DB command type. * 1. Query specifies a cube name * 2. Query specifies a SQL statement * 3. Query specifies a table name * 4. Query specifies that default information has been given, and it is up to the provider how to interpret. * 5. Query is against a web based List Data Provider. */ getCommandType() : OLEDBCommandType; /** * Specifies the OLE DB command type. * 1. Query specifies a cube name * 2. Query specifies a SQL statement * 3. Query specifies a table name * 4. Query specifies that default information has been given, and it is up to the provider how to interpret. * 5. Query is against a web based List Data Provider. * @param value - The value to set. */ setCommandType(value: OLEDBCommandType) : void; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. */ getConnectionString() : string; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. * @param value - The value to set. */ setConnectionString(value: string) : void; /** * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed */ getSecondCommand() : string; /** * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed * @param value - The value to set. */ setSecondCommand(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the collection */ export class ExternalConnectionCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : ExternalConnection; /** * Gets the element with the specified name. * @param connectionName - the name of data connection * @returns * The element with the specified name. */ get(connectionName: string) : ExternalConnection; /** * Gets the element with the specified id. * @param connId - external connection id * @returns * The element with the specified id. */ getExternalConnectionById(connId: number) : ExternalConnection; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specifies all properties associated with an ODBC or OLE DB external data connection. */ export class DBConnection extends ExternalConnection { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ExternalConnection); /** * Gets the type of this object. */ getClassType() : ExternalConnectionClassType; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. */ getConnectionString() : string; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. * @param value - The value to set. */ setConnectionString(value: string) : void; /** * @deprecated Please use the 'connectionInfo' property instead. * The connection information string is used to make contact with an OLE DB or ODBC data source. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.ConnectionString property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.ConnectionString property instead. */ getConnectionInfo() : string; /** * The connection information string is used to make contact with an OLE DB or ODBC data source. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.ConnectionString property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.ConnectionString property instead. */ connectionInfo : string; /** * @deprecated Please use the 'connectionInfo' property instead. * The connection information string is used to make contact with an OLE DB or ODBC data source. * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.ConnectionString property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.ConnectionString property instead. */ setConnectionInfo(value: string) : void; /** * Gets the definition of power query formula. */ getPowerQueryFormula() : PowerQueryFormula; /** * Specifies the OLE DB command type. * 1. Query specifies a cube name * 2. Query specifies a SQL statement * 3. Query specifies a table name * 4. Query specifies that default information has been given, and it is up to the provider how to interpret. * 5. Query is against a web based List Data Provider. */ getCommandType() : OLEDBCommandType; /** * Specifies the OLE DB command type. * 1. Query specifies a cube name * 2. Query specifies a SQL statement * 3. Query specifies a table name * 4. Query specifies that default information has been given, and it is up to the provider how to interpret. * 5. Query is against a web based List Data Provider. * @param value - The value to set. */ setCommandType(value: OLEDBCommandType) : void; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data */ getCommand() : string; /** * The string containing the database command to pass to the data provider API that will * interact with the external source in order to retrieve data * @param value - The value to set. */ setCommand(value: string) : void; /** * @deprecated Please use the 'severCommand' property instead. * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.SecondCommand property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.SecondCommand property instead. */ getSeverCommand() : string; /** * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.SecondCommand property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.SecondCommand property instead. */ severCommand : string; /** * @deprecated Please use the 'severCommand' property instead. * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed * @param value - The value to set. * * @remarks * NOTE: This property is now obsolete. Instead, * please use ExternalConnection.SecondCommand property. * This method will be removed 12 months later since October 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExternalConnection.SecondCommand property instead. */ setSeverCommand(value: string) : void; /** * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed */ getSecondCommand() : string; /** * Specifies a second command text string that is persisted when PivotTable server-based * page fields are in use. * For ODBC connections, serverCommand is usually a broader query than command (no * WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), * parameter UI can be populated and parameterized queries can be constructed * @param value - The value to set. */ setSecondCommand(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the properties for a web query source. A web query will retrieve data from HTML tables, * and can also supply HTTP "Get" parameters to be processed by the web server in generating the HTML by * including the parameters and parameter elements. */ export class WebQueryConnection extends ExternalConnection { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ExternalConnection); /** * Gets the type of this object. */ getClassType() : ExternalConnectionClassType; /** * true if the web query source is XML (versus HTML), otherwise false. */ isXml : boolean; /** * @deprecated Please use the 'isXml' property instead. * true if the web query source is XML (versus HTML), otherwise false. * @param value - The value to set. */ setIsXml(value: boolean) : void; /** * This flag exists for backward compatibility with older existing spreadsheet files, and is set * to true if this web query was created in Microsoft Excel 97. * This is an optional attribute that can be ignored. */ isXl97 : boolean; /** * @deprecated Please use the 'isXl97' property instead. * This flag exists for backward compatibility with older existing spreadsheet files, and is set * to true if this web query was created in Microsoft Excel 97. * This is an optional attribute that can be ignored. * @param value - The value to set. */ setIsXl97(value: boolean) : void; /** * This flag exists for backward compatibility with older existing spreadsheet files, and is set * to true if this web query was refreshed in a spreadsheet application newer than or equal * to Microsoft Excel 2000. * This is an optional attribute that can be ignored. */ isXl2000 : boolean; /** * @deprecated Please use the 'isXl2000' property instead. * This flag exists for backward compatibility with older existing spreadsheet files, and is set * to true if this web query was refreshed in a spreadsheet application newer than or equal * to Microsoft Excel 2000. * This is an optional attribute that can be ignored. * @param value - The value to set. */ setIsXl2000(value: boolean) : void; /** * @deprecated Please use the 'url' property instead. * URL to use to refresh external data. */ getUrl() : string; /** * URL to use to refresh external data. */ url : string; /** * @deprecated Please use the 'url' property instead. * URL to use to refresh external data. * @param value - The value to set. */ setUrl(value: string) : void; /** * Gets the connection file. */ getConnectionFile() : string; /** * Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates. */ isTextDates : boolean; /** * @deprecated Please use the 'isTextDates' property instead. * Flag indicating whether dates should be imported into cells in the worksheet as text rather than dates. * @param value - The value to set. */ setIsTextDates(value: boolean) : void; /** * Flag indicating that XML source data should be imported instead of the HTML table itself. */ isXmlSourceData : boolean; /** * @deprecated Please use the 'isXmlSourceData' property instead. * Flag indicating that XML source data should be imported instead of the HTML table itself. * @param value - The value to set. */ setIsXmlSourceData(value: boolean) : void; /** * @deprecated Please use the 'post' property instead. * Returns or sets the string used with the post method of inputting data into a web server * to return data from a web query. */ getPost() : string; /** * Returns or sets the string used with the post method of inputting data into a web server * to return data from a web query. */ post : string; /** * @deprecated Please use the 'post' property instead. * Returns or sets the string used with the post method of inputting data into a web server * to return data from a web query. * @param value - The value to set. */ setPost(value: string) : void; /** * Flag indicating whether data contained within HTML PRE tags in the web page is * parsed into columns when you import the page into a query table. */ isParsePre : boolean; /** * @deprecated Please use the 'isParsePre' property instead. * Flag indicating whether data contained within HTML PRE tags in the web page is * parsed into columns when you import the page into a query table. * @param value - The value to set. */ setIsParsePre(value: boolean) : void; /** * Flag indicating whether web queries should only work on HTML tables. */ isHtmlTables : boolean; /** * @deprecated Please use the 'isHtmlTables' property instead. * Flag indicating whether web queries should only work on HTML tables. * @param value - The value to set. */ setIsHtmlTables(value: boolean) : void; /** * @deprecated Please use the 'htmlFormat' property instead. * How to handle formatting from the HTML source when bringing web query data into the * worksheet. Relevant when sourceData is True. */ getHtmlFormat() : HtmlFormatHandlingType; /** * How to handle formatting from the HTML source when bringing web query data into the * worksheet. Relevant when sourceData is True. */ htmlFormat : HtmlFormatHandlingType; /** * @deprecated Please use the 'htmlFormat' property instead. * How to handle formatting from the HTML source when bringing web query data into the * worksheet. Relevant when sourceData is True. * @param value - The value to set. */ setHtmlFormat(value: HtmlFormatHandlingType) : void; /** * Flag indicating whether to parse all tables inside a PRE block with the same width settings * as the first row. */ isSameSettings : boolean; /** * @deprecated Please use the 'isSameSettings' property instead. * Flag indicating whether to parse all tables inside a PRE block with the same width settings * as the first row. * @param value - The value to set. */ setIsSameSettings(value: boolean) : void; /** * @deprecated Please use the 'editWebPage' property instead. * The URL of the user-facing web page showing the web query data. This URL is persisted * in the case that sourceData="true" and url has been redirected to reference an XML file. * Then the user-facing page can be shown in the UI, and the XML data can be retrieved * behind the scenes. */ getEditWebPage() : string; /** * The URL of the user-facing web page showing the web query data. This URL is persisted * in the case that sourceData="true" and url has been redirected to reference an XML file. * Then the user-facing page can be shown in the UI, and the XML data can be retrieved * behind the scenes. */ editWebPage : string; /** * @deprecated Please use the 'editWebPage' property instead. * The URL of the user-facing web page showing the web query data. This URL is persisted * in the case that sourceData="true" and url has been redirected to reference an XML file. * Then the user-facing page can be shown in the UI, and the XML data can be retrieved * behind the scenes. * @param value - The value to set. */ setEditWebPage(value: string) : void; /** * Flag indicating whether consecutive delimiters should be treated as just one delimiter. */ isConsecutive : boolean; /** * @deprecated Please use the 'isConsecutive' property instead. * Flag indicating whether consecutive delimiters should be treated as just one delimiter. * @param value - The value to set. */ setIsConsecutive(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies external database source type */ export enum ConnectionDataSourceType { /** * ODBC-based source */ ODBCBasedSource = 1, /** * DAO-based source */ DAOBasedSource = 2, /** * File based database source */ FileBasedDataBaseSource = 3, /** * Web query */ WebQuery = 4, /** * OLE DB-based source */ OLEDBBasedSource = 5, /** * Text-based source */ TextBasedSource = 6, /** * ADO record set */ ADORecordSet = 7, /** * DSP */ DSP = 8, /** * OLE DB data source created by the Spreadsheet Data Model. */ OLEDBDataModel = 100, /** * Data feed data source created by the Spreadsheet Data Model. */ DataFeedDataModel = 101, /** * Worksheet data source created by the Spreadsheet Data Model. */ WorksheetDataModel = 102, /** * Worksheet data source created by the Spreadsheet Data Model. * * @remarks * NOTE: This member is now obsolete. Instead, * please use WorksheetDataModel enum. * This property will be removed 12 months later since September 2017. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use WorksheetDataModel enum instead. */ Table = 102, /** * Text data source created by the Spreadsheet Data Model. */ TextDataModel = 103, /** * Text data source created by the Spreadsheet Data Model. */ Unknown = 255, } /** * Specifies properties about any parameters used with external data connections * Parameters are valid for ODBC and web queries. */ export class ConnectionParameter { /** * @deprecated Please use the 'sqlType' property instead. * SQL data type of the parameter. Only valid for ODBC sources. */ getSqlType() : SqlDataType; /** * SQL data type of the parameter. Only valid for ODBC sources. */ sqlType : SqlDataType; /** * @deprecated Please use the 'sqlType' property instead. * SQL data type of the parameter. Only valid for ODBC sources. * @param value - The value to set. */ setSqlType(value: SqlDataType) : void; /** * @deprecated Please use the 'refreshOnChange' property instead. * Flag indicating whether the query should automatically refresh when the contents of a * cell that provides the parameter value changes. If true, then external data is refreshed * using the new parameter value every time there's a change. If false, then external data * is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened). */ getRefreshOnChange() : boolean; /** * Flag indicating whether the query should automatically refresh when the contents of a * cell that provides the parameter value changes. If true, then external data is refreshed * using the new parameter value every time there's a change. If false, then external data * is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened). */ refreshOnChange : boolean; /** * @deprecated Please use the 'refreshOnChange' property instead. * Flag indicating whether the query should automatically refresh when the contents of a * cell that provides the parameter value changes. If true, then external data is refreshed * using the new parameter value every time there's a change. If false, then external data * is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened). * @param value - The value to set. */ setRefreshOnChange(value: boolean) : void; /** * @deprecated Please use the 'prompt' property instead. * Prompt string for the parameter. Presented to the spreadsheet user along with input UI * to collect the parameter value before refreshing the external data. Used only when * parameterType = prompt. */ getPrompt() : string; /** * Prompt string for the parameter. Presented to the spreadsheet user along with input UI * to collect the parameter value before refreshing the external data. Used only when * parameterType = prompt. */ prompt : string; /** * @deprecated Please use the 'prompt' property instead. * Prompt string for the parameter. Presented to the spreadsheet user along with input UI * to collect the parameter value before refreshing the external data. Used only when * parameterType = prompt. * @param value - The value to set. */ setPrompt(value: string) : void; /** * @deprecated Please use the 'type' property instead. * Type of parameter used. * If the parameterType=value, then the value from boolean, double, integer, * or string will be used. In this case, it is expected that only one of * {boolean, double, integer, or string} will be specified. */ getType() : ConnectionParameterType; /** * Type of parameter used. * If the parameterType=value, then the value from boolean, double, integer, * or string will be used. In this case, it is expected that only one of * {boolean, double, integer, or string} will be specified. */ type : ConnectionParameterType; /** * @deprecated Please use the 'type' property instead. * Type of parameter used. * If the parameterType=value, then the value from boolean, double, integer, * or string will be used. In this case, it is expected that only one of * {boolean, double, integer, or string} will be specified. * @param value - The value to set. */ setType(value: ConnectionParameterType) : void; /** * @deprecated Please use the 'name' property instead. * The name of the parameter. */ getName() : string; /** * The name of the parameter. */ name : string; /** * @deprecated Please use the 'name' property instead. * The name of the parameter. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'cellReference' property instead. * Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell. */ getCellReference() : string; /** * Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell. */ cellReference : string; /** * @deprecated Please use the 'cellReference' property instead. * Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell. * @param value - The value to set. */ setCellReference(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Non-integer numeric value,Integer value,String value or Boolean value * to use as the query parameter. Used only when parameterType is value. */ getValue() : Object; /** * Non-integer numeric value,Integer value,String value or Boolean value * to use as the query parameter. Used only when parameterType is value. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Non-integer numeric value,Integer value,String value or Boolean value * to use as the query parameter. Used only when parameterType is value. * @param value - The value to set. */ setValue(value: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the collection */ export class ConnectionParameterCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : ConnectionParameter; /** * Gets the element with the specified name. * @param connParamName - connection parameter name * @returns * The element with the specified name. */ get(connParamName: string) : ConnectionParameter; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specifies the parameter type of external connection */ export enum ConnectionParameterType { /** * Get the parameter value from a cell on each refresh. */ Cell = 0, /** * Prompt the user on each refresh for a parameter value. */ Prompt = 1, /** * Use a constant value on each refresh for the parameter value. */ Value = 2, } /** * Specifies Credentials method used for server access. */ export enum CredentialsMethodType { /** * Integrated Authentication */ Integrated = 0, /** * No Credentials */ None = 1, /** * Prompt Credentials */ Prompt = 2, /** * Stored Credentials */ Stored = 3, } /** * Specifies the OLE DB command type. */ export enum OLEDBCommandType { /** * The command type is not specified. */ None = 0, /** * Specifies a cube name * * @remarks * unsupported */ CubeName = 1, /** * Specifies a SQL statement */ SqlStatement = 2, /** * Specifies a table name */ TableName = 3, /** * Specifies that default information has been given, and it is up to the provider how to interpret. * * @remarks * unsupported */ DefaultInformation = 4, /** * Specifies a query which is against a web based List Data Provider. * * @remarks * unsupported */ WebBasedList = 5, /** * Specifies the table list. * * @remarks * Only for reading. */ TableCollection = 6, } /** * Specifies what the spreadsheet application should do when a connection fails. */ export enum ReConnectionMethodType { /** * On refresh use the existing connection information and if it ends up being invalid * then get updated connection information, if available from the external connection file. */ Required = 1, /** * On every refresh get updated connection information from the external connection file, * if available, and use that instead of the existing connection information. * In this case the data refresh will fail if the external connection file is unavailable. */ Always = 2, /** * Never get updated connection information from the external connection file * even if it is available and even if the existing connection information is invalid */ Never = 3, } /** * Specifies SQL data type of the parameter. Only valid for ODBC sources. */ export enum SqlDataType { /** * sql unsigned offset */ SqlUnsignedOffset = -22, /** * sql signed offset */ SqlSignedOffset = -20, /** * sql guid */ SqlGUID = -11, /** * sql wide long variable char */ SqlWLongVarchar = -10, /** * sql wide variable char */ SqlWVarchar = -9, /** * sql wide char */ SqlWChar = -8, /** * sql bit */ SqlBit = -7, /** * sql tiny int */ SqlTinyInt = -6, /** * sql big int */ SqlBigInt = -5, /** * sql long variable binary */ SqlLongVarBinary = -4, /** * sql variable binary */ SqlVarBinary = -3, /** * sql binary */ SqlBinary = -2, /** * sql long variable char */ SqlLongVarChar = -1, /** * sql unknown type */ SqlUnknownType = 0, /** * sql char */ SqlChar = 1, /** * sql numeric */ SqlNumeric = 2, /** * sql decimal */ SqlDecimal = 3, /** * sql integer */ SqlInteger = 4, /** * sql small int */ SqlSmallInt = 5, /** * sql float */ SqlFloat = 6, /** * sql real */ SqlReal = 7, /** * sql double */ SqlDouble = 8, /** * sql date type */ SqlTypeDate = 9, /** * sql time type */ SqlTypeTime = 10, /** * sql timestamp type */ SqlTypeTimestamp = 11, /** * sql variable char */ SqlVarChar = 12, /** * sql interval year */ SqlIntervalYear = 101, /** * sql interval month */ SqlIntervalMonth = 102, /** * sql interval day */ SqlIntervalDay = 103, /** * sql interval hour */ SqlIntervalHour = 104, /** * sql interval minute */ SqlIntervalMinute = 105, /** * sql interval second */ SqlIntervalSecond = 106, /** * sql interval year to month */ SqlIntervalYearToMonth = 107, /** * sql interval day to hour */ SqlIntervalDayToHour = 108, /** * sql interval day to minute */ SqlIntervalDayToMinute = 109, /** * sql interval day to second */ SqlIntervalDayToSecond = 110, /** * sql interval hour to minute */ SqlIntervalHourToMinute = 111, /** * sql interval hour to second */ SqlIntervalHourToSecond = 112, /** * sql interval minute to second */ SqlIntervalMinuteToSecond = 113, } /** * Contains data returned by file format detection methods. */ export class FileFormatInfo { /** * Default Constructor. */ constructor(); /** * Gets whether the file is protected by Microsoft Rights Management Server. */ readonly isProtectedByRMS : boolean; /** * Returns true if the document is encrypted and requires a password to open. */ readonly isEncrypted : boolean; /** * @deprecated Please use the 'fileFormatType' property instead. * Gets the detected file format. */ getFileFormatType() : FileFormatType; /** * Gets the detected file format. */ readonly fileFormatType : FileFormatType; /** * @deprecated Please use the 'loadFormat' property instead. * Gets the detected load format. */ getLoadFormat() : LoadFormat; /** * Gets the detected load format. */ readonly loadFormat : LoadFormat; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents cells data handler for reading large spreadsheet files in light weight mode. * * @remarks * When reading a workbook by this mode, will be checked when reading every worksheet in the workbook. * For one sheet, if gives true, then all data and properties of rows/cells of this sheet will be checked * and processed by the implementation of this interface. For every row, will be called to check whether it need to be processed. * If a row needs to be processed, properties of this row will be read firstly and user can access its properties by . * if row's cells need to be processed too, then should returns true and then will be * called for every existing cell in this row to check whether one cell need to be processed. If one cell needs to be processed, * then will be called to process the cell by the implementation of this interface. *

* Please note, user should only operate on the values and properties of current Row/Cell object provided by corresponding method. * Because the cells data is read from the template file in streaming manner, most of other objects may be reset/update later * after cells data has been loaded. So when user operating other objects in this implementation, * those operations may be not able to affect the objects existing in the workbook. Or even worse, those operations may * cause inconsistent data in the workbook and then cause unpected issue or exception later. * So, for all other objects such as shapes, column width and styles, conditional formattings, ...etc., * please do not operate them in any methods of this implementation. * Instead, please manage them after the workbook has been constructed. */ export interface LightCellsDataHandler { /** * Starts to process a worksheet. * @param sheet - the worksheet to read cells data. * @returns * whether this sheet's cells data needs to be processed. false to ignore this sheet. * * @remarks * It will be called before reading cells data of a worksheet. */ startSheet(sheet: Worksheet) : boolean; /** * Prepares to process a row. * @param rowIndex - the index of next row to be processed * @returns * whether this row(properties or cells data) needs to be processed. false to ignore this row and its cells and check the next row. */ startRow(rowIndex: number) : boolean; /** * Starts to process one row. * @param row - Row object which is being processed currently. * @returns * whether this row's cells need to be processed. false to ignore all cells in this row. * * @remarks * It will be called after row's properties such as height, style, ...etc. have been read. However, cells in this row has not been read yet. */ processRow(row: Row) : boolean; /** * Prepares to process a cell. * @param columnIndex - column index of the cell to be processed * @returns * whether this cell needs to be processed. false to ignore the cell and check the next one until reach the end of cells data of current row * * @remarks * It will be called when reaching an existing cell in current row. Current row is the row of last call of . */ startCell(columnIndex: number) : boolean; /** * Starts to process one cell. * @param cell - Cell object which is being processed currently * @returns * whether this cell needs to be kept in cells model of current sheet. * Commonly it should be false so that all cells will not be kept in memory after being processed and then memory be saved. * For some special purpose such as user needs to access some cells later after the whole workbook having been processed, * user can make this method return true to keep those special cells in Cells model and access them later by APIs such as Cells[row, column]. * However, keeping cells data in Cells model will requires more memory and if all cells are kept then reading template file * in LightCells mode will become same with reading it in normal way. * * @remarks * It will be called after one cell's data has been read. */ processCell(cell: Cell) : boolean; } /** * Represents the options to filter data when loading workbook from template. */ export enum LoadDataFilterOptions { /** * Load nothing for sheet data * * @remarks * NOTE: This member is now obsolete and please use Structure instead. * This property will be removed 12 months later since December 2017. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Structure instead. */ None = 0, /** * Load all */ All = 2147483647, /** * Load cells whose value is blank */ CellBlank = 1, /** * Load cells whose value is string */ CellString = 2, /** * Load cells whose value is numeric(including datetime) */ CellNumeric = 4, /** * Load cells whose value is error */ CellError = 8, /** * Load cells whose value is bool */ CellBool = 16, /** * Load cells value(all value types) only */ CellValue = 31, /** * Load cell formulas. * * @remarks * Generally defined Name objects(DefinedNames) also need to be loaded when loading formulas because they may be referenced by formulas. * So Formula or CellData option should work with DefinedNames option together(Formula|DefinedNames or CellData|DefinedNames) for most scenarios. */ Formula = 32, /** * Load cells data including values, formulas and formatting */ CellData = 67108927, /** * Load charts */ Chart = 256, /** * Load shapes * * @remarks * NOTE: This member is now obsolete and please use Drawing instead. * This property will be removed 12 months later since November 2019. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Drawing instead. */ Shape = 402653696, /** * Drawing objects(including Chart, Picture, OleObject and all other drawing objects) */ Drawing = 402653952, /** * Load merged cells */ MergedArea = 1024, /** * Load conditional formatting */ ConditionalFormatting = 2048, /** * Load data validations */ DataValidation = 4096, /** * Load pivot tables */ PivotTable = 8192, /** * Load tables */ Table = 16384, /** * Load hyperlinks */ Hyperlinks = 32768, /** * Load settings for worksheet */ SheetSettings = 65536, /** * Load all data of worksheet, such as cells data, settings, objects, ...etc. */ SheetData = 403701759, /** * Load settings for workbook */ BookSettings = 1048576, /** * Load settings for workbook and worksheet */ Settings = 1114112, /** * Load XmlMap */ XmlMap = 2097152, /** * Load structure of the workbook */ Structure = 4194304, /** * Load document properties */ Document_Properties = 8388608, /** * Load defined Name objects */ DefinedNames = 16777216, /** * Load VBA projects */ VBA = 33554432, /** * Load styles for cell formatting */ Style = 67108864, /** * Load pictures */ Picture = 134217728, /** * Load OleObjects */ OleObject = 268435456, /** * Load revision logs */ Revision = 536870912, } /** * Fill format type. */ export enum FillType { /** * Represents automatic formatting type. */ Automatic = 0, /** * Represents none formatting type. */ None = 1, /** * Solid fill format. */ Solid = 2, /** * Gradient fill format. */ Gradient = 3, /** * Texture fill format(includes picture fill). */ Texture = 4, /** * Pattern fill format. */ Pattern = 5, /** * Inherit the fill properties of the group. */ Group = 6, } /** * Encapsulates the object that represents solid fill format */ export class SolidFill { /** * @deprecated Please use the 'color' property instead. * Gets or sets the . */ getColor() : Color; /** * Gets or sets the . */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets or sets the . * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'cellsColor' property instead. * Gets and sets the object. */ getCellsColor() : CellsColor; /** * Gets and sets the object. */ cellsColor : CellsColor; /** * @deprecated Please use the 'cellsColor' property instead. * Gets and sets the object. * @param value - The value to set. */ setCellsColor(value: CellsColor) : void; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). */ getTransparency() : number; /** * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * Gets the hash code. */ getHashCode() : number; /** * @param obj - */ equals(obj: Object) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the custom icon of conditional formatting rule. */ export class ConditionalFormattingIcon { /** * @deprecated Please use the 'imageData' property instead. * Gets the icon set data. */ getImageData() : Uint8Array; /** * Gets the icon set data. */ readonly imageData : Uint8Array; /** * @deprecated Please use the 'type' property instead. * Gets and sets the icon set type. */ getType() : IconSetType; /** * Gets and sets the icon set type. */ type : IconSetType; /** * @deprecated Please use the 'type' property instead. * Gets and sets the icon set type. * @param value - The value to set. */ setType(value: IconSetType) : void; /** * @deprecated Please use the 'index' property instead. * Gets and sets the icon's index in the icon set. */ getIndex() : number; /** * Gets and sets the icon's index in the icon set. */ index : number; /** * @deprecated Please use the 'index' property instead. * Gets and sets the icon's index in the icon set. * @param value - The value to set. */ setIndex(value: number) : void; /** * Get the icon set data * @param type - icon's type * @param index - icon's index */ static getIconImageData(type: IconSetType, index: number) : Uint8Array; /** * Gets the image data with the setting of cell. * @param cell - The setting of cell. * @returns * Returns the image data of icon. */ getImageData(cell: Cell) : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a collection of objects. */ export class ConditionalFormattingIconCollection implements Iterable { /** * Gets the ConditionalFormattingIcon element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : ConditionalFormattingIcon; /** * Adds object. * @param type - The value type. * @param index - The Index. * @returns * Returns the index of new object in the list. */ add(type: IconSetType, index: number) : number; /** * Adds object. * @param cficon - Returns the index of new object in the list. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Add(IconSetType, int) method. * This method will be removed 6 months later since December 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ConditionalFormattingIconCollection.Add(IconSetType, int) method instead. */ add(cficon: ConditionalFormattingIcon) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specifies the axis position for a range of cells with conditional formatting as data bars. */ export enum DataBarAxisPosition { /** * Display the axis at a variable position based on the ratio of the minimum negative value to the maximum positive value in the range. * Positive values are displayed in a left-to-right direction. * Negative values are displayed in a right-to-left direction. * When all values are positive or all values are negative, no axis is displayed. */ Automatic = 0, /** * Display the axis at the midpoint of the cell regardless of the set of values in the range. * Positive values are displayed in a left-to-right direction. * Negative values are displayed in a right-to-left direction. */ Midpoint = 1, /** * No axis is displayed, and both positive and negative values are displayed in the left-to-right direction. */ None = 2, } /** * Represents the border of the data bars specified by a conditional formatting rule. */ export class DataBarBorder { /** * @deprecated Please use the 'color' property instead. * Gets or sets the border's color of data bars specified by a conditional formatting rule. */ getColor() : Color; /** * Gets or sets the border's color of data bars specified by a conditional formatting rule. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets or sets the border's color of data bars specified by a conditional formatting rule. * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'type' property instead. * Gets or sets the border's type of data bars specified by a conditional formatting rule. */ getType() : DataBarBorderType; /** * Gets or sets the border's type of data bars specified by a conditional formatting rule. */ type : DataBarBorderType; /** * @deprecated Please use the 'type' property instead. * Gets or sets the border's type of data bars specified by a conditional formatting rule. * @param value - The value to set. */ setType(value: DataBarBorderType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the border type of a data bar. */ export enum DataBarBorderType { /** * The data bar has no border. */ None = 0, /** * The data bar has a solid border. */ Solid = 1, } /** * Specifies how a data bar is filled with color. */ export enum DataBarFillType { /** * The data bar is filled with solid color. */ Solid = 0, /** * The data bar is filled with a color gradient. */ Gradient = 1, } /** * Specifies whether to use the same border and fill color as positive data bars. */ export enum DataBarNegativeColorType { /** * Use the color specified in the Negative Value and Axis Setting dialog box * or by using the ColorType and BorderColorType properties of the NegativeBarFormat object. */ Color = 0, /** * Use the same color as positive data bars. */ SameAsPositive = 1, } /** * Represents the color settings of the data bars for negative values that are defined by a data bar conditional formatting rule. */ export class NegativeBarFormat { /** * @deprecated Please use the 'borderColor' property instead. * Gets or sets a FormatColor object that you can use to specify the border color for negative data bars. */ getBorderColor() : Color; /** * Gets or sets a FormatColor object that you can use to specify the border color for negative data bars. */ borderColor : Color; /** * @deprecated Please use the 'borderColor' property instead. * Gets or sets a FormatColor object that you can use to specify the border color for negative data bars. * @param value - The value to set. */ setBorderColor(value: Color) : void; /** * @deprecated Please use the 'borderColorType' property instead. * Gets whether to use the same border color as positive data bars. */ getBorderColorType() : DataBarNegativeColorType; /** * Gets whether to use the same border color as positive data bars. */ borderColorType : DataBarNegativeColorType; /** * @deprecated Please use the 'borderColorType' property instead. * Gets whether to use the same border color as positive data bars. * @param value - The value to set. */ setBorderColorType(value: DataBarNegativeColorType) : void; /** * @deprecated Please use the 'color' property instead. * Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars. */ getColor() : Color; /** * Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets or sets a FormatColor object that you can use to specify the fill color for negative data bars. * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'colorType' property instead. * Gets or sets whether to use the same fill color as positive data bars. */ getColorType() : DataBarNegativeColorType; /** * Gets or sets whether to use the same fill color as positive data bars. */ colorType : DataBarNegativeColorType; /** * @deprecated Please use the 'colorType' property instead. * Gets or sets whether to use the same fill color as positive data bars. * @param value - The value to set. */ setColorType(value: DataBarNegativeColorType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents identifier information. */ export class ContentTypeProperty { /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the object. */ getName() : string; /** * Returns or sets the name of the object. */ name : string; /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the object. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Returns or sets the value of the content type property. */ getValue() : string; /** * Returns or sets the value of the content type property. */ value : string; /** * @deprecated Please use the 'value' property instead. * Returns or sets the value of the content type property. * @param value - The value to set. */ setValue(value: string) : void; /** * @deprecated Please use the 'type' property instead. * Gets and sets the type of the property. */ getType() : string; /** * Gets and sets the type of the property. */ type : string; /** * @deprecated Please use the 'type' property instead. * Gets and sets the type of the property. * @param value - The value to set. */ setType(value: string) : void; /** * Indicates whether the value could be empty. */ isNillable : boolean; /** * @deprecated Please use the 'isNillable' property instead. * Indicates whether the value could be empty. * @param value - The value to set. */ setIsNillable(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * A collection of objects that represent additional information. */ export class ContentTypePropertyCollection implements Iterable { /** * Gets the content type property by the specific index. * @param index - The index. * @returns * The content type property */ get(index: number) : ContentTypeProperty; /** * Gets the content type property by the property name. * @param name - The property name. * @returns * The content type property */ get(name: string) : ContentTypeProperty; /** * Adds content type property information. * @param name - The name of the content type property. * @param value - The value of the content type property. */ add(name: string, value: string) : number; /** * Adds content type property information. * @param name - The name of the content type property. * @param value - The value of the content type property. * @param type - The type of the content type property. */ add(name: string, value: string, type: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the setting of deleting rows/columns. */ export class DeleteOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'updateReference' property instead. * Indicates if update references in other worksheets. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ getUpdateReference() : boolean; /** * Indicates if update references in other worksheets. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ updateReference : boolean; /** * @deprecated Please use the 'updateReference' property instead. * Indicates if update references in other worksheets. * @param value - The value to set. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ setUpdateReference(value: boolean) : void; /** * @deprecated Please use the 'formulaChangeMonitor' property instead. * Gets/sets the monitor for tracking changes caused by the deletion. */ getFormulaChangeMonitor() : AbstractFormulaChangeMonitor; /** * Gets/sets the monitor for tracking changes caused by the deletion. */ formulaChangeMonitor : AbstractFormulaChangeMonitor; /** * @deprecated Please use the 'formulaChangeMonitor' property instead. * Gets/sets the monitor for tracking changes caused by the deletion. * @param value - The value to set. */ setFormulaChangeMonitor(value: AbstractFormulaChangeMonitor) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the result of conditional formatting which applies to a cell. */ export class ConditionalFormattingResult { /** * @deprecated Please use the 'conditionalStyle' property instead. * Gets the conditional result style. */ getConditionalStyle() : Style; /** * Gets the conditional result style. */ readonly conditionalStyle : Style; /** * @deprecated Please use the 'conditionalFormattingIcon' property instead. * Gets the image of icon set. */ getConditionalFormattingIcon() : ConditionalFormattingIcon; /** * Gets the image of icon set. */ readonly conditionalFormattingIcon : ConditionalFormattingIcon; /** * @deprecated Please use the 'conditionalFormattingDataBar' property instead. * Gets the DataBar object. */ getConditionalFormattingDataBar() : DataBar; /** * Gets the DataBar object. */ readonly conditionalFormattingDataBar : DataBar; /** * @deprecated Please use the 'conditionalFormattingColorScale' property instead. * Gets the ColorScale object. */ getConditionalFormattingColorScale() : ColorScale; /** * Gets the ColorScale object. */ readonly conditionalFormattingColorScale : ColorScale; /** * @deprecated Please use the 'colorScaleResult' property instead. * Gets the display color of color scale. */ getColorScaleResult() : Color; /** * Gets the display color of color scale. */ readonly colorScaleResult : Color; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents how the application displays shapes in this workbook. Shapes might include charts, * images, and other object data that the application supports. */ export enum ShapeDisplayType { /** * Indicates that all shapes be shown in the workbook. */ All = 0, /** * Indicates that the application show placeholders for shapes in the workbook. */ Placeholders = 1, /** * Indicates that all shapes be hidden in the workbook. */ None = 2, } /** * Represents PivotTable condition formatting rule type. */ export enum PivotConditionFormatRuleType { /** * Indicates that Top N conditional formatting is not evaluated */ None = 0, /** * Indicates that Top N conditional formatting is * evaluated across the entire scope range. */ All = 1, /** * Indicates that Top N conditional formatting is evaluated for each row. */ Row = 2, /** * Indicates that Top N conditional formatting is * evaluated for each column. */ Column = 3, } /** * Represents the collection of formats applied to PivotTable. */ export class PivotTableFormatCollection implements Iterable { /** * Gets the format by the index. * @param index - The index. */ get(index: number) : PivotTableFormat; /** * Add a . * @returns * The index of new format. */ add() : number; /** * Formats selected area. * @param axisType - The region of the PivotTable to which this rule applies. * @param fieldPosition - Position of the field within the axis to which this rule applies. * @param subtotalType - The subtotal filter type of the pivot field * @param selectionType - Indicates how to select data. * @param isGrandRow - Indicates whether selecting grand total rows. * @param isGrandColumn - Indicates whether selecting grand total columns. * @param style - The style which appies to the area of the pivot table. */ formatArea(axisType: PivotFieldType, fieldPosition: number, subtotalType: PivotFieldSubtotalType, selectionType: PivotTableSelectionType, isGrandRow: boolean, isGrandColumn: boolean, style: Style) : PivotTableFormat; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the revision. */ export class Revision { /** * Represents the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'worksheet' property instead. * Gets the worksheet. */ getWorksheet() : Worksheet; /** * Gets the worksheet. */ readonly worksheet : Worksheet; /** * @deprecated Please use the 'id' property instead. * Gets the number of this revision. * * @remarks * Zero means this revision does not contains id. */ getId() : number; /** * Gets the number of this revision. * * @remarks * Zero means this revision does not contains id. */ readonly id : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * represents a revision record of information about a formatting change. */ export class RevisionAutoFormat extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of the revision. */ getType() : RevisionType; /** * @deprecated Please use the 'cellArea' property instead. * Gets the location where the formatting was applied. */ getCellArea() : CellArea; /** * Gets the location where the formatting was applied. */ readonly cellArea : CellArea; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record of a cell comment change. */ export class RevisionCellComment extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'row' property instead. * Gets the row index of the which contains a comment. */ getRow() : number; /** * Gets the row index of the which contains a comment. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets the column index of the which contains a comment. */ getColumn() : number; /** * Gets the column index of the which contains a comment. */ readonly column : number; /** * @deprecated Please use the 'cellName' property instead. * Gets the name of the cell. */ getCellName() : string; /** * Gets the name of the cell. */ cellName : string; /** * @deprecated Please use the 'cellName' property instead. * Gets the name of the cell. * @param value - The value to set. */ setCellName(value: string) : void; /** * @deprecated Please use the 'actionType' property instead. * Gets the action type of the revision. */ getActionType() : RevisionActionType; /** * Gets the action type of the revision. */ readonly actionType : RevisionActionType; /** * Indicates whether it's an old comment. */ readonly isOldComment : boolean; /** * @deprecated Please use the 'oldLength' property instead. * Gets Length of the comment text added in this revision. */ getOldLength() : number; /** * Gets Length of the comment text added in this revision. */ readonly oldLength : number; /** * @deprecated Please use the 'newLength' property instead. * Gets Length of the comment before this revision was made. */ getNewLength() : number; /** * Gets Length of the comment before this revision was made. */ readonly newLength : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record on a cell(s) that moved. */ export class RevisionCellMove extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'sourceArea' property instead. * Gets the source area. */ getSourceArea() : CellArea; /** * Gets the source area. */ readonly sourceArea : CellArea; /** * @deprecated Please use the 'destinationArea' property instead. * Gets the destination area. */ getDestinationArea() : CellArea; /** * Gets the destination area. */ readonly destinationArea : CellArea; /** * @deprecated Please use the 'sourceWorksheet' property instead. * Gets the source worksheet. */ getSourceWorksheet() : Worksheet; /** * Gets the source worksheet. */ readonly sourceWorksheet : Worksheet; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record of information about a formatting change. */ export class RevisionFormat extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'areas' property instead. * The range to which this formatting was applied. */ getAreas() : CellArea[]; /** * The range to which this formatting was applied. */ readonly areas : CellArea[]; /** * @deprecated Please use the 'style' property instead. * Gets the applied style. */ getStyle() : Style; /** * Gets the applied style. */ readonly style : Style; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record of a row/column insert/delete action. */ export class RevisionInsertDelete extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'cellArea' property instead. * Gets the inserting/deleting range. */ getCellArea() : CellArea; /** * Gets the inserting/deleting range. */ readonly cellArea : CellArea; /** * @deprecated Please use the 'actionType' property instead. * Gets the action type of this revision. */ getActionType() : RevisionActionType; /** * Gets the action type of this revision. */ readonly actionType : RevisionActionType; /** * @deprecated Please use the 'revisions' property instead. * Gets revision list by this operation. */ getRevisions() : RevisionCollection; /** * Gets revision list by this operation. */ readonly revisions : RevisionCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record of a sheet that was inserted. */ export class RevisionInsertSheet extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'actionType' property instead. * Gets the action type of the revision. */ getActionType() : RevisionActionType; /** * Gets the action type of the revision. */ readonly actionType : RevisionActionType; /** * @deprecated Please use the 'name' property instead. * Gets the name of the worksheet. */ getName() : string; /** * Gets the name of the worksheet. */ readonly name : string; /** * @deprecated Please use the 'sheetPosition' property instead. * Gets the zero based position of the new sheet in the sheet tab bar. */ getSheetPosition() : number; /** * Gets the zero based position of the new sheet in the sheet tab bar. */ readonly sheetPosition : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision record which indicates that there was a merge conflict. */ export class RevisionMergeConflict extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of revision. */ getType() : RevisionType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a revision of a query table field change. */ export class RevisionQueryTable extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of the revision. */ getType() : RevisionType; /** * @deprecated Please use the 'cellArea' property instead. * Gets the location of the affected query table. */ getCellArea() : CellArea; /** * Gets the location of the affected query table. */ readonly cellArea : CellArea; /** * @deprecated Please use the 'fieldId' property instead. * Gets ID of the specific query table field that was removed. */ getFieldId() : number; /** * Gets ID of the specific query table field that was removed. */ readonly fieldId : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the revision that changing cells. */ export class RevisionCellChange extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'cellName' property instead. * Gets the name of the cell. */ getCellName() : string; /** * Gets the name of the cell. */ readonly cellName : string; /** * @deprecated Please use the 'row' property instead. * Gets the row index of the cell. */ getRow() : number; /** * Gets the row index of the cell. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets the column index of the cell. */ getColumn() : number; /** * Gets the column index of the cell. */ readonly column : number; /** * Indicates whether this cell is new formatted. */ readonly isNewFormatted : boolean; /** * Indicates whether this cell is old formatted. */ readonly isOldFormatted : boolean; /** * @deprecated Please use the 'oldFormula' property instead. * Gets the old formula. */ getOldFormula() : string; /** * Gets the old formula. */ readonly oldFormula : string; /** * @deprecated Please use the 'oldValue' property instead. * Gets old value of the cell. */ getOldValue() : Object; /** * Gets old value of the cell. */ readonly oldValue : Object; /** * @deprecated Please use the 'newValue' property instead. * Gets new value of the cell. */ getNewValue() : Object; /** * Gets new value of the cell. */ readonly newValue : Object; /** * @deprecated Please use the 'newFormula' property instead. * Gets the old formula. */ getNewFormula() : string; /** * Gets the old formula. */ readonly newFormula : string; /** * @deprecated Please use the 'newStyle' property instead. * Gets the new style of the cell. */ getNewStyle() : Style; /** * Gets the new style of the cell. */ readonly newStyle : Style; /** * @deprecated Please use the 'oldStyle' property instead. * Gets the old style of the cell. */ getOldStyle() : Style; /** * Gets the old style of the cell. */ readonly oldStyle : Style; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all revision logs. */ export class RevisionCollection implements Iterable { /** * Gets by the index. * @param index - */ get(index: number) : Revision; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a revision record of a defined name change. */ export class RevisionDefinedName extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'text' property instead. * Gets the text of the defined name. */ getText() : string; /** * Gets the text of the defined name. */ readonly text : string; /** * @deprecated Please use the 'oldFormula' property instead. * Gets the old formula. */ getOldFormula() : string; /** * Gets the old formula. */ readonly oldFormula : string; /** * @deprecated Please use the 'newFormula' property instead. * Gets the formula. */ getNewFormula() : string; /** * Gets the formula. */ readonly newFormula : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all revision logs. */ export class RevisionLogCollection implements Iterable { /** * Gets by index. * @param index - The index. * @returns * Returns object. */ get(index: number) : RevisionLog; /** * @deprecated Please use the 'daysPreservingHistory' property instead. * Gets and sets the number of days the spreadsheet application will keep the change history for this workbook. */ getDaysPreservingHistory() : number; /** * Gets and sets the number of days the spreadsheet application will keep the change history for this workbook. */ daysPreservingHistory : number; /** * @deprecated Please use the 'daysPreservingHistory' property instead. * Gets and sets the number of days the spreadsheet application will keep the change history for this workbook. * @param value - The value to set. */ setDaysPreservingHistory(value: number) : void; /** * Highlights changes of shared workbook. * @param options - Set the options for filtering which changes should be tracked. */ highlightChanges(options: HighlightChangesOptions) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the type of revision action. */ export enum RevisionActionType { /** * Add revision. */ Add = 0, /** * Delete revision. */ Delete = 1, /** * Column delete revision. */ DeleteColumn = 2, /** * Row delete revision. */ DeleteRow = 3, /** * Column insert revision. */ InsertColumn = 4, /** * Row insert revision. */ InsertRow = 5, } /** * Represents a revision record of adding or removing a custom view to the workbook */ export class RevisionCustomView extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Gets the type of revision. */ getType() : RevisionType; /** * @deprecated Please use the 'actionType' property instead. * Gets the type of action. */ getActionType() : RevisionActionType; /** * Gets the type of action. */ readonly actionType : RevisionActionType; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a list of specific changes that have taken place for this workbook. */ export class RevisionHeader { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'savedTime' property instead. * Gets and sets rhe date and time when this set of revisions was saved. */ getSavedTime() : Date; /** * Gets and sets rhe date and time when this set of revisions was saved. */ savedTime : Date; /** * @deprecated Please use the 'savedTime' property instead. * Gets and sets rhe date and time when this set of revisions was saved. * @param value - The value to set. */ setSavedTime(value: Date) : void; /** * @deprecated Please use the 'userName' property instead. * Gets and sets the name of the user making the revision. */ get_UserName() : string; /** * Gets and sets the name of the user making the revision. */ userName : string; /** * @deprecated Please use the 'userName' property instead. * Gets and sets the name of the user making the revision. * @param value - The value to set. */ setUserName(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the revision log. */ export class RevisionLog { /** * @deprecated Please use the 'metadataTable' property instead. * Gets table that contains metadata about a list of specific changes that have taken place * for this workbook. */ getMetadataTable() : RevisionHeader; /** * Gets table that contains metadata about a list of specific changes that have taken place * for this workbook. */ readonly metadataTable : RevisionHeader; /** * @deprecated Please use the 'revisions' property instead. * Gets all revisions in this log. */ getRevisions() : RevisionCollection; /** * Gets all revisions in this log. */ readonly revisions : RevisionCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the revision type. */ export enum RevisionType { /** * Custom view. */ CustomView = 0, /** * Defined name. */ DefinedName = 1, /** * Cells change. */ ChangeCells = 2, /** * Auto format. */ AutoFormat = 3, /** * Merge conflict. */ MergeConflict = 4, /** * Comment. */ Comment = 5, /** * Format. */ Format = 6, /** * Insert worksheet. */ InsertSheet = 7, /** * Move cells. */ MoveCells = 8, /** * Undo. */ Undo = 9, /** * Query table. */ QueryTable = 10, /** * Inserting or deleting. */ InsertDelete = 11, /** * Rename worksheet. */ RenameSheet = 12, /** * Unknown. */ Unknown = 13, } /** * Represents a revision of renaming sheet. */ export class RevisionRenameSheet extends Revision { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: Revision); /** * Represents the type of the revision. */ getType() : RevisionType; /** * @deprecated Please use the 'oldName' property instead. * Gets the old name of the worksheet. */ getOldName() : string; /** * Gets the old name of the worksheet. */ readonly oldName : string; /** * @deprecated Please use the 'newName' property instead. * Gets the new name of the worksheet. */ getNewName() : string; /** * Gets the new name of the worksheet. */ readonly newName : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Callback interface of warning. */ export interface IWarningCallback { /** * Our callback only needs to implement the "Warning" method. * @param warningInfo - warning info */ warning(warningInfo: WarningInfo) : void; } /** * Represents the options for exporting html data. */ export enum HtmlExportDataOptions { /** * Export file to html which only contains table part. */ Table = 1, /** * Export all the data to html. */ All = 255, } /** * Represents the type of target attribute in HTML tag. */ export enum HtmlLinkTargetType { /** * Opens the linked document in a new window or tab */ Blank = 0, /** * Opens the linked document in the parent frame */ Parent = 1, /** * Opens the linked document in the same frame as it was clicked (this is default) */ Self = 2, /** * Opens the linked document in the full body of the window */ Top = 3, } /** * Specifies the type of using quotation marks for values in text format files. */ export enum TxtValueQuoteType { /** * All values that contain special characters such as quotation mark, separator character will be quoted. * Same with the behavior of ms excel for exporting text file. */ Normal = 0, /** * All values will be quoted always. */ Always = 1, /** * Only quote values when needed. Such as, if one value contains quotation mark but the quotation mark is not at the begin of this value, this value will not be quoted. */ Minimum = 2, /** * All values will not be quoted. The exported text file with this type may not be read back correctly because the needed quotation marks being absent. */ Never = 3, } /** * Represents two types of showing the hidden rows in html. */ export enum HtmlHiddenRowDisplayType { /** * Hidden the hidden rows in html page. */ Hidden = 0, /** * Remove the hidden rows in html page. */ Remove = 1, } /** * Represents two types of showing the hidden columns in html. */ export enum HtmlHiddenColDisplayType { /** * Hidden the hidden columns in html page. */ Hidden = 0, /** * Remove the hidden columns in html page. */ Remove = 1, } /** * Represents QueryTable information. */ export class QueryTable { /** * @deprecated Please use the 'connectionId' property instead. * Gets the connection id of the query table. */ getConnectionId() : number; /** * Gets the connection id of the query table. */ readonly connectionId : number; /** * @deprecated Please use the 'externalConnection' property instead. * Gets the relate external connection. */ getExternalConnection() : ExternalConnection; /** * Gets the relate external connection. */ readonly externalConnection : ExternalConnection; /** * @deprecated Please use the 'name' property instead. * Gets the name of querytable. */ getName() : string; /** * Gets the name of querytable. */ readonly name : string; /** * @deprecated Please use the 'resultRange' property instead. * Gets the range of the result. */ getResultRange() : Range; /** * Gets the range of the result. */ readonly resultRange : Range; /** * @deprecated Please use the 'preserveFormatting' property instead. * Returns or sets the PreserveFormatting of the object. */ getPreserveFormatting() : boolean; /** * Returns or sets the PreserveFormatting of the object. */ preserveFormatting : boolean; /** * @deprecated Please use the 'preserveFormatting' property instead. * Returns or sets the PreserveFormatting of the object. * @param value - The value to set. */ setPreserveFormatting(value: boolean) : void; /** * @deprecated Please use the 'adjustColumnWidth' property instead. * Returns or sets the AdjustColumnWidth of the object. */ getAdjustColumnWidth() : boolean; /** * Returns or sets the AdjustColumnWidth of the object. */ adjustColumnWidth : boolean; /** * @deprecated Please use the 'adjustColumnWidth' property instead. * Returns or sets the AdjustColumnWidth of the object. * @param value - The value to set. */ setAdjustColumnWidth(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * A collection of objects that represent QueryTable collection information. */ export class QueryTableCollection implements Iterable { /** * Gets the querytable by the specific index. * @param index - The index. * @returns * The querytable */ get(index: number) : QueryTable; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents an individual scenario. */ export class Scenario { /** * @deprecated Please use the 'comment' property instead. * Gets and sets the comment of scenario. */ getComment() : string; /** * Gets and sets the comment of scenario. */ comment : string; /** * @deprecated Please use the 'comment' property instead. * Gets and sets the comment of scenario. * @param value - The value to set. */ setComment(value: string) : void; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of scenario. */ getName() : string; /** * Gets and sets the name of scenario. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of scenario. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'user' property instead. * Gets name of user who last changed the scenario. */ getUser() : string; /** * Gets name of user who last changed the scenario. */ readonly user : string; /** * Indicates whether scenario is hidden. */ isHidden : boolean; /** * @deprecated Please use the 'isHidden' property instead. * Indicates whether scenario is hidden. * @param value - The value to set. */ setIsHidden(value: boolean) : void; /** * Indicates whether scenario is locked for editing when the sheet is protected. */ isLocked : boolean; /** * @deprecated Please use the 'isLocked' property instead. * Indicates whether scenario is locked for editing when the sheet is protected. * @param value - The value to set. */ setIsLocked(value: boolean) : void; /** * @deprecated Please use the 'inputCells' property instead. * Gets the input cells of scenario. */ getInputCells() : ScenarioInputCellCollection; /** * Gets the input cells of scenario. */ readonly inputCells : ScenarioInputCellCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of scenarios. */ export class ScenarioCollection implements Iterable { /** * Gets the object by the index. * @param index - The specific index in the list. */ get(index: number) : Scenario; /** * @deprecated Please use the 'activeIndex' property instead. * Gets and sets which scenario is selected. */ getActiveIndex() : number; /** * Gets and sets which scenario is selected. */ activeIndex : number; /** * @deprecated Please use the 'activeIndex' property instead. * Gets and sets which scenario is selected. * @param value - The value to set. */ setActiveIndex(value: number) : void; /** * @deprecated Please use the 'lastSelected' property instead. * Indicates which scenario was last selected by the user to be run/shown. */ getLastSelected() : number; /** * Indicates which scenario was last selected by the user to be run/shown. */ lastSelected : number; /** * @deprecated Please use the 'lastSelected' property instead. * Indicates which scenario was last selected by the user to be run/shown. * @param value - The value to set. */ setLastSelected(value: number) : void; /** * Adds a scenario. * @param name - The name of scenario. * @returns * The index in the list of scenarios. */ add(name: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents input cell for the scenario. */ export class ScenarioInputCell { /** * @deprecated Please use the 'row' property instead. * Gets and sets the row index of the input cell. */ getRow() : number; /** * Gets and sets the row index of the input cell. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets and sets the column index of the input cell. */ getColumn() : number; /** * Gets and sets the column index of the input cell. */ readonly column : number; /** * @deprecated Please use the 'name' property instead. * Gets and sets the input cell address. */ getName() : string; /** * Gets and sets the input cell address. */ readonly name : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets value of the input cell. */ getValue() : string; /** * Gets and sets value of the input cell. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets value of the input cell. * @param value - The value to set. */ setValue(value: string) : void; /** * Indicates whether input cell is deleted. */ isDeleted : boolean; /** * @deprecated Please use the 'isDeleted' property instead. * Indicates whether input cell is deleted. * @param value - The value to set. */ setIsDeleted(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of the scenario's input cells. */ export class ScenarioInputCellCollection implements Iterable { /** * Gets by index in the list. * @param index - The specific index in the list * @returns * The object */ get(index: number) : ScenarioInputCell; /** * Adds an input cell. * @param row - The row index of input cell. * @param column - The column index of input cell. * @param value - The value of input cell. */ add(row: number, column: number, value: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represent summary description of slicer cache */ export class SlicerCache { /** * @deprecated Please use the 'crossFilterType' property instead. * Indicates how to show items with no data of slicer. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowTypeOfItemsWithNoData property instead. */ getCrossFilterType() : SlicerCacheCrossFilterType; /** * Indicates how to show items with no data of slicer. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowTypeOfItemsWithNoData property instead. */ crossFilterType : SlicerCacheCrossFilterType; /** * @deprecated Please use the 'crossFilterType' property instead. * Indicates how to show items with no data of slicer. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowTypeOfItemsWithNoData property instead. */ setCrossFilterType(value: SlicerCacheCrossFilterType) : void; /** * @deprecated Please use the 'list' property instead. * Indicates whether the slicer associated with the specified slicer cache is based on an Non-OLAP data source. */ getList() : boolean; /** * Indicates whether the slicer associated with the specified slicer cache is based on an Non-OLAP data source. */ readonly list : boolean; /** * @deprecated Please use the 'slicerCacheItems' property instead. * Returns a SlicerCacheItem collection that contains the collection of all items in the slicer cache. Read-only */ getSlicerCacheItems() : SlicerCacheItemCollection; /** * Returns a SlicerCacheItem collection that contains the collection of all items in the slicer cache. Read-only */ readonly slicerCacheItems : SlicerCacheItemCollection; /** * @deprecated Please use the 'name' property instead. * Returns the name of the slicer cache. */ getName() : string; /** * Returns the name of the slicer cache. */ readonly name : string; /** * @deprecated Please use the 'sourceName' property instead. * Returns the name of this slicer cache. */ getSourceName() : string; /** * Returns the name of this slicer cache. */ readonly sourceName : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represent the type how to show items with no data for slicer. * * @remarks * NOTE: This enum is now obsolete. Instead, * please use enum. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ItemsWithNoDataShowMode enum instead. */ export enum SlicerCacheCrossFilterType { /** * Hide items with no data. */ None = 0, /** * Show items with data at top. */ ShowItemsWithDataAtTop = 1, /** * Show items with no data with natural order. */ ShowItemsWithNoData = 2, } /** * Represent slicer data source item */ export class SlicerCacheItem { /** * @deprecated Please use the 'selected' property instead. * Specifies whether the is selected or not. * * @remarks * Please use method instead if you want to select item. * Because this refresh operation causes poor performance due to full data reload every time selection changes. */ getSelected() : boolean; /** * Specifies whether the is selected or not. * * @remarks * Please use method instead if you want to select item. * Because this refresh operation causes poor performance due to full data reload every time selection changes. */ selected : boolean; /** * @deprecated Please use the 'selected' property instead. * Specifies whether the is selected or not. * @param value - The value to set. * * @remarks * Please use method instead if you want to select item. * Because this refresh operation causes poor performance due to full data reload every time selection changes. */ setSelected(value: boolean) : void; /** * @deprecated Please use the 'value' property instead. * Returns the label text for the slicer item. */ getValue() : string; /** * Returns the label text for the slicer item. */ readonly value : string; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represent the collection of SlicerCacheItem */ export class SlicerCacheItemCollection implements Iterable { /** * Gets the SlicerCacheItem object by index. */ get(index: number) : SlicerCacheItem; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Specify the style of slicer view */ export enum SlicerStyleType { /** * built-in light style one */ SlicerStyleLight1 = 0, /** * built-in light style two */ SlicerStyleLight2 = 1, /** * built-in light style three */ SlicerStyleLight3 = 2, /** * built-in light style four */ SlicerStyleLight4 = 3, /** * built-in light style five */ SlicerStyleLight5 = 4, /** * built-in light style six */ SlicerStyleLight6 = 5, /** * built-in style other one */ SlicerStyleOther1 = 6, /** * built-in style other two */ SlicerStyleOther2 = 7, /** * built-in dark style one */ SlicerStyleDark1 = 8, /** * built-in dark style tow */ SlicerStyleDark2 = 9, /** * built-in dark style three */ SlicerStyleDark3 = 10, /** * built-in dark style four */ SlicerStyleDark4 = 11, /** * built-in dark style five */ SlicerStyleDark5 = 12, /** * built-in dark style six */ SlicerStyleDark6 = 13, /** * user-defined style, unsupported for now * * @remarks * unsupported */ Custom = 14, } /** * summary description of Slicer View */ export class Slicer { /** * @deprecated Please use the 'sortOrderType' property instead. * Indicates the type of sorting items. */ getSortOrderType() : SortOrder; /** * Indicates the type of sorting items. */ sortOrderType : SortOrder; /** * @deprecated Please use the 'sortOrderType' property instead. * Indicates the type of sorting items. * @param value - The value to set. */ setSortOrderType(value: SortOrder) : void; /** * @deprecated Please use the 'showMissing' property instead. * Indicates whether to show items deteleted from the data source. * * @remarks * Only works when is true. */ getShowMissing() : boolean; /** * Indicates whether to show items deteleted from the data source. * * @remarks * Only works when is true. */ showMissing : boolean; /** * @deprecated Please use the 'showMissing' property instead. * Indicates whether to show items deteleted from the data source. * @param value - The value to set. * * @remarks * Only works when is true. */ setShowMissing(value: boolean) : void; /** * @deprecated Please use the 'showTypeOfItemsWithNoData' property instead. * Indicates whether to show items deteleted from the data source. * * @remarks * Only works when is true. */ getShowTypeOfItemsWithNoData() : ItemsWithNoDataShowMode; /** * Indicates whether to show items deteleted from the data source. * * @remarks * Only works when is true. */ showTypeOfItemsWithNoData : ItemsWithNoDataShowMode; /** * @deprecated Please use the 'showTypeOfItemsWithNoData' property instead. * Indicates whether to show items deteleted from the data source. * @param value - The value to set. * * @remarks * Only works when is true. */ setShowTypeOfItemsWithNoData(value: ItemsWithNoDataShowMode) : void; /** * @deprecated Please use the 'showAllItems' property instead. * Indicates whether to show all items even if there are no data or they are deleted. * Default value is true; */ getShowAllItems() : boolean; /** * Indicates whether to show all items even if there are no data or they are deleted. * Default value is true; */ showAllItems : boolean; /** * @deprecated Please use the 'showAllItems' property instead. * Indicates whether to show all items even if there are no data or they are deleted. * Default value is true; * @param value - The value to set. */ setShowAllItems(value: boolean) : void; /** * @deprecated Please use the 'title' property instead. * Specifies the title of the current Slicer object. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Title property instead. */ getTitle() : string; /** * Specifies the title of the current Slicer object. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Title property instead. */ title : string; /** * @deprecated Please use the 'title' property instead. * Specifies the title of the current Slicer object. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Title property instead. */ setTitle(value: string) : void; /** * @deprecated Please use the 'alternativeText' property instead. * Returns or sets the descriptive (alternative) text string of the Slicer object. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.AlternativeText property instead. */ getAlternativeText() : string; /** * Returns or sets the descriptive (alternative) text string of the Slicer object. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.AlternativeText property instead. */ alternativeText : string; /** * @deprecated Please use the 'alternativeText' property instead. * Returns or sets the descriptive (alternative) text string of the Slicer object. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.AlternativeText property instead. */ setAlternativeText(value: string) : void; /** * Indicates whether the slicer object is printable. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsPrintable property instead. */ isPrintable : boolean; /** * @deprecated Please use the 'isPrintable' property instead. * Indicates whether the slicer object is printable. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsPrintable property instead. */ setIsPrintable(value: boolean) : void; /** * Indicates whether the slicer shape is locked. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsLocked property instead. */ isLocked : boolean; /** * @deprecated Please use the 'isLocked' property instead. * Indicates whether the slicer shape is locked. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsLocked property instead. */ setIsLocked(value: boolean) : void; /** * @deprecated Please use the 'placement' property instead. * Represents the way the drawing object is attached to the cells below it. * The property controls the placement of an object on a worksheet. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Placement property instead. */ getPlacement() : PlacementType; /** * Represents the way the drawing object is attached to the cells below it. * The property controls the placement of an object on a worksheet. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Placement property instead. */ placement : PlacementType; /** * @deprecated Please use the 'placement' property instead. * Represents the way the drawing object is attached to the cells below it. * The property controls the placement of an object on a worksheet. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Placement property instead. */ setPlacement(value: PlacementType) : void; /** * @deprecated Please use the 'lockedAspectRatio' property instead. * Indicates whether locking aspect ratio. * * @remarks * NOTE: This member is now obsolete. Instead, * please use method. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsLockAspectRatio property instead. */ getLockedAspectRatio() : boolean; /** * Indicates whether locking aspect ratio. * * @remarks * NOTE: This member is now obsolete. Instead, * please use method. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsLockAspectRatio property instead. */ lockedAspectRatio : boolean; /** * @deprecated Please use the 'lockedAspectRatio' property instead. * Indicates whether locking aspect ratio. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use method. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.IsLockAspectRatio property instead. */ setLockedAspectRatio(value: boolean) : void; /** * @deprecated Please use the 'lockedPosition' property instead. * Indicates whether the specified slicer can be moved or resized by using the user interface. */ getLockedPosition() : boolean; /** * Indicates whether the specified slicer can be moved or resized by using the user interface. */ lockedPosition : boolean; /** * @deprecated Please use the 'lockedPosition' property instead. * Indicates whether the specified slicer can be moved or resized by using the user interface. * @param value - The value to set. */ setLockedPosition(value: boolean) : void; /** * @deprecated Please use the 'shape' property instead. * Returns the Shape object associated with the specified slicer. Read-only. */ getShape() : SlicerShape; /** * Returns the Shape object associated with the specified slicer. Read-only. */ readonly shape : SlicerShape; /** * @deprecated Please use the 'slicerCache' property instead. * Returns the SlicerCache object associated with the slicer. Read-only. */ getSlicerCache() : SlicerCache; /** * Returns the SlicerCache object associated with the slicer. Read-only. */ readonly slicerCache : SlicerCache; /** * @deprecated Please use the 'parent' property instead. * Returns the object which contains this slicer. Read-only. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.Worksheet property instead. */ getParent() : Worksheet; /** * Returns the object which contains this slicer. Read-only. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.Worksheet property instead. */ readonly parent : Worksheet; /** * @deprecated Please use the 'worksheet' property instead. * Returns the object which contains this slicer. Read-only. */ getWorksheet() : Worksheet; /** * Returns the object which contains this slicer. Read-only. */ readonly worksheet : Worksheet; /** * @deprecated Please use the 'styleType' property instead. * Specify the type of Built-in slicer style. * The default type is SlicerStyleLight1. */ getStyleType() : SlicerStyleType; /** * Specify the type of Built-in slicer style. * The default type is SlicerStyleLight1. */ styleType : SlicerStyleType; /** * @deprecated Please use the 'styleType' property instead. * Specify the type of Built-in slicer style. * The default type is SlicerStyleLight1. * @param value - The value to set. */ setStyleType(value: SlicerStyleType) : void; /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the specified slicer */ getName() : string; /** * Returns or sets the name of the specified slicer */ name : string; /** * @deprecated Please use the 'name' property instead. * Returns or sets the name of the specified slicer * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'caption' property instead. * Returns or sets the caption of the specified slicer. */ getCaption() : string; /** * Returns or sets the caption of the specified slicer. */ caption : string; /** * @deprecated Please use the 'caption' property instead. * Returns or sets the caption of the specified slicer. * @param value - The value to set. */ setCaption(value: string) : void; /** * @deprecated Please use the 'firstItemIndex' property instead. * Specifies the zero-based index of the first slicer item. */ getFirstItemIndex() : number; /** * Specifies the zero-based index of the first slicer item. */ firstItemIndex : number; /** * @deprecated Please use the 'firstItemIndex' property instead. * Specifies the zero-based index of the first slicer item. * @param value - The value to set. */ setFirstItemIndex(value: number) : void; /** * @deprecated Please use the 'captionVisible' property instead. * Returns or sets whether the header that displays the slicer Caption is visible. * The default value is true * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowCaption property instead. */ getCaptionVisible() : boolean; /** * Returns or sets whether the header that displays the slicer Caption is visible. * The default value is true * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowCaption property instead. */ captionVisible : boolean; /** * @deprecated Please use the 'captionVisible' property instead. * Returns or sets whether the header that displays the slicer Caption is visible. * The default value is true * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 12 months later since January 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Slicer.ShowCaption property instead. */ setCaptionVisible(value: boolean) : void; /** * @deprecated Please use the 'showCaption' property instead. * Indicates whether the header of the slicer is visible. * The default value is true */ getShowCaption() : boolean; /** * Indicates whether the header of the slicer is visible. * The default value is true */ showCaption : boolean; /** * @deprecated Please use the 'showCaption' property instead. * Indicates whether the header of the slicer is visible. * The default value is true * @param value - The value to set. */ setShowCaption(value: boolean) : void; /** * @deprecated Please use the 'numberOfColumns' property instead. * Returns or sets the number of columns in the slicer. * The default value is 1. */ getNumberOfColumns() : number; /** * Returns or sets the number of columns in the slicer. * The default value is 1. */ numberOfColumns : number; /** * @deprecated Please use the 'numberOfColumns' property instead. * Returns or sets the number of columns in the slicer. * The default value is 1. * @param value - The value to set. */ setNumberOfColumns(value: number) : void; /** * @deprecated Please use the 'leftPixel' property instead. * Returns or sets the horizontal offset of slicer shape from its left column, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ getLeftPixel() : number; /** * Returns or sets the horizontal offset of slicer shape from its left column, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ leftPixel : number; /** * @deprecated Please use the 'leftPixel' property instead. * Returns or sets the horizontal offset of slicer shape from its left column, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Left property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Left property instead. */ setLeftPixel(value: number) : void; /** * @deprecated Please use the 'topPixel' property instead. * Returns or sets the vertical offset of slicer shape from its top row, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ getTopPixel() : number; /** * Returns or sets the vertical offset of slicer shape from its top row, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ topPixel : number; /** * @deprecated Please use the 'topPixel' property instead. * Returns or sets the vertical offset of slicer shape from its top row, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Top property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Top property instead. */ setTopPixel(value: number) : void; /** * @deprecated Please use the 'width' property instead. * Returns or sets the width of the specified slicer, in points. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.WidthPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.WidthPt property instead. */ getWidth() : number; /** * Returns or sets the width of the specified slicer, in points. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.WidthPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.WidthPt property instead. */ width : number; /** * @deprecated Please use the 'width' property instead. * Returns or sets the width of the specified slicer, in points. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.WidthPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.WidthPt property instead. */ setWidth(value: number) : void; /** * @deprecated Please use the 'widthPixel' property instead. * Returns or sets the width of the specified slicer, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ getWidthPixel() : number; /** * Returns or sets the width of the specified slicer, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ widthPixel : number; /** * @deprecated Please use the 'widthPixel' property instead. * Returns or sets the width of the specified slicer, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Width property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Width property instead. */ setWidthPixel(value: number) : void; /** * @deprecated Please use the 'height' property instead. * Returns or sets the height of the specified slicer, in points. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.HeightPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.HeightPt property instead. */ getHeight() : number; /** * Returns or sets the height of the specified slicer, in points. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.HeightPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.HeightPt property instead. */ height : number; /** * @deprecated Please use the 'height' property instead. * Returns or sets the height of the specified slicer, in points. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.HeightPt property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.HeightPt property instead. */ setHeight(value: number) : void; /** * @deprecated Please use the 'heightPixel' property instead. * Returns or sets the height of the specified slicer, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ getHeightPixel() : number; /** * Returns or sets the height of the specified slicer, in pixels. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ heightPixel : number; /** * @deprecated Please use the 'heightPixel' property instead. * Returns or sets the height of the specified slicer, in pixels. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use Shape.Height property. * This property will be removed 12 months later since May 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use Shape.Height property instead. */ setHeightPixel(value: number) : void; /** * @deprecated Please use the 'columnWidthPixel' property instead. * Gets or sets the width of each column in the slicer, in unit of pixels.  */ getColumnWidthPixel() : number; /** * Gets or sets the width of each column in the slicer, in unit of pixels.  */ columnWidthPixel : number; /** * @deprecated Please use the 'columnWidthPixel' property instead. * Gets or sets the width of each column in the slicer, in unit of pixels.  * @param value - The value to set. */ setColumnWidthPixel(value: number) : void; /** * @deprecated Please use the 'columnWidth' property instead. * Returns or sets the width of each column in the slicer in unit of points. */ getColumnWidth() : number; /** * Returns or sets the width of each column in the slicer in unit of points. */ columnWidth : number; /** * @deprecated Please use the 'columnWidth' property instead. * Returns or sets the width of each column in the slicer in unit of points. * @param value - The value to set. */ setColumnWidth(value: number) : void; /** * @deprecated Please use the 'rowHeightPixel' property instead. * Returns or sets the height of each row in the specified slicer, in unit of pixels. */ getRowHeightPixel() : number; /** * Returns or sets the height of each row in the specified slicer, in unit of pixels. */ rowHeightPixel : number; /** * @deprecated Please use the 'rowHeightPixel' property instead. * Returns or sets the height of each row in the specified slicer, in unit of pixels. * @param value - The value to set. */ setRowHeightPixel(value: number) : void; /** * @deprecated Please use the 'rowHeight' property instead. * Returns or sets the height of each row in the specified slicer in unit of points. */ getRowHeight() : number; /** * Returns or sets the height of each row in the specified slicer in unit of points. */ rowHeight : number; /** * @deprecated Please use the 'rowHeight' property instead. * Returns or sets the height of each row in the specified slicer in unit of points. * @param value - The value to set. */ setRowHeight(value: number) : void; /** * Adds PivotTable connection. * @param pivot - The PivotTable object */ addPivotConnection(pivot: PivotTable) : void; /** * Removes PivotTable connection. * @param pivot - The PivotTable object */ removePivotConnection(pivot: PivotTable) : void; /** * Refreshing the items of the slicer from the associated pivot tables. */ refresh() : void; /** * @param labels - Selected labels. * @param append - False means only selecting these labels and unselecting others. /// True means keeping old selected items and selecting these labels. * * @remarks * If you want to select all items, please use method. */ selectItems(labels: string[], append: boolean) : void; /** * @param labels - */ unselectItems(labels: string[]) : void; /** * Remove filters */ clearFilter() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Specifies the collection of all the Slicer objects on the specified worksheet. */ export class SlicerCollection implements Iterable { /** * Gets the Slicer by index. */ get(index: number) : Slicer; /** * Gets the Slicer by slicer's name. */ get(name: string) : Slicer; /** * Remove the specified Slicer * @param slicer - The Slicer object */ remove(slicer: Slicer) : void; /** * Deletes the Slicer at the specified index * @param index - The position index in Slicer collection */ removeAt(index: number) : void; /** * Clear all Slicers. */ clear() : void; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell in the upper-left corner of the Slicer range. * @param baseFieldName - The name of PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, destCellName: string, baseFieldName: string) : number; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Slicer range. * @param column - Column index of the cell in the upper-left corner of the Slicer range. * @param baseFieldName - The name of PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, row: number, column: number, baseFieldName: string) : number; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Slicer range. * @param column - Column index of the cell in the upper-left corner of the Slicer range. * @param baseFieldIndex - The index of PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, row: number, column: number, baseFieldIndex: number) : number; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell in the upper-left corner of the Slicer range. * @param baseFieldIndex - The index of PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, destCellName: string, baseFieldIndex: number) : number; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param row - Row index of the cell in the upper-left corner of the Slicer range. * @param column - Column index of the cell in the upper-left corner of the Slicer range. * @param baseField - The PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, row: number, column: number, baseField: PivotField) : number; /** * Add a new Slicer using PivotTable as data source * @param pivot - PivotTable object * @param destCellName - The cell in the upper-left corner of the Slicer range. * @param baseField - The PivotField in PivotTable.BaseFields * @returns * The new add Slicer index */ add(pivot: PivotTable, destCellName: string, baseField: PivotField) : number; /** * Add a new Slicer using ListObjet as data source * @param table - ListObject object * @param index - The index of ListColumn in ListObject.ListColumns * @param destCellName - The cell in the upper-left corner of the Slicer range. * @returns * The new add Slicer index */ add(table: ListObject, index: number, destCellName: string) : number; /** * Add a new Slicer using ListObjet as data source * @param table - ListObject object * @param listColumn - The ListColumn in ListObject.ListColumns * @param destCellName - The cell in the upper-left corner of the Slicer range. * @returns * The new add Slicer index */ add(table: ListObject, listColumn: ListColumn, destCellName: string) : number; /** * Add a new Slicer using ListObjet as data source * @param table - ListObject object * @param listColumn - The ListColumn in ListObject.ListColumns * @param row - Row index of the cell in the upper-left corner of the Slicer range. * @param column - Column index of the cell in the upper-left corner of the Slicer range. * @returns * The new add Slicer index */ add(table: ListObject, listColumn: ListColumn, row: number, column: number) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents category type of cell's number formatting. */ export enum NumberCategoryType { /** * General */ General = 0, /** * Text */ Text = 1, /** * Number */ Number = 2, /** * Date or Date and Time */ Date = 3, /** * Time */ Time = 4, /** * Fraction */ Fraction = 5, /** * Scientific */ Scientific = 6, } /** * This type specifies the cap types of the text. * * @remarks * Only can be applied to chart and shape. */ export enum TextCapsType { /** * None caps */ None = 0, /** * Apply all caps on the text. */ All = 1, /** * Apply small caps to the text. */ Small = 2, } /** * This type specifies the strike type. */ export enum TextStrikeType { /** * A single strikethrough applied on the text. */ Single = 0, /** * A double strikethrough applied on the text. * Only works for the text of the shapes or charts. */ Double = 1, /** * No strike is applied to the text. */ None = 2, } /** * Represents a table in a worksheet. */ export class ListObject { /** * @deprecated Please use the 'startRow' property instead. * Gets the start row of the range. */ getStartRow() : number; /** * Gets the start row of the range. */ readonly startRow : number; /** * @deprecated Please use the 'startColumn' property instead. * Gets the start column of the range. */ getStartColumn() : number; /** * Gets the start column of the range. */ readonly startColumn : number; /** * @deprecated Please use the 'endRow' property instead. * Gets the end row of the range. */ getEndRow() : number; /** * Gets the end row of the range. */ readonly endRow : number; /** * @deprecated Please use the 'endColumn' property instead. * Gets the end column of the range. */ getEndColumn() : number; /** * Gets the end column of the range. */ readonly endColumn : number; /** * @deprecated Please use the 'listColumns' property instead. * Gets the list of this table. */ getListColumns() : ListColumnCollection; /** * Gets the list of this table. */ readonly listColumns : ListColumnCollection; /** * @deprecated Please use the 'showHeaderRow' property instead. * Gets and sets whether this Table shows header row. */ getShowHeaderRow() : boolean; /** * Gets and sets whether this Table shows header row. */ showHeaderRow : boolean; /** * @deprecated Please use the 'showHeaderRow' property instead. * Gets and sets whether this Table shows header row. * @param value - The value to set. */ setShowHeaderRow(value: boolean) : void; /** * @deprecated Please use the 'showTotals' property instead. * Gets and sets whether this TAble shows total row. */ getShowTotals() : boolean; /** * Gets and sets whether this TAble shows total row. */ showTotals : boolean; /** * @deprecated Please use the 'showTotals' property instead. * Gets and sets whether this TAble shows total row. * @param value - The value to set. */ setShowTotals(value: boolean) : void; /** * @deprecated Please use the 'dataRange' property instead. * Gets the data range of the Table. */ getDataRange() : Range; /** * Gets the data range of the Table. */ readonly dataRange : Range; /** * @deprecated Please use the 'queryTable' property instead. * Gets the linked QueryTable. */ getQueryTable() : QueryTable; /** * Gets the linked QueryTable. */ readonly queryTable : QueryTable; /** * @deprecated Please use the 'dataSourceType' property instead. * Gets the data source type of the table. */ getDataSourceType() : TableDataSourceType; /** * Gets the data source type of the table. */ readonly dataSourceType : TableDataSourceType; /** * @deprecated Please use the 'hasAutoFilter' property instead. * Indicates whether auto filter is applied to this table. */ getHasAutoFilter() : boolean; /** * Indicates whether auto filter is applied to this table. */ hasAutoFilter : boolean; /** * @deprecated Please use the 'hasAutoFilter' property instead. * Indicates whether auto filter is applied to this table. * @param value - The value to set. */ setHasAutoFilter(value: boolean) : void; /** * @deprecated Please use the 'autoFilter' property instead. * Gets auto filter of this table. * * @remarks * It works only when is false. */ getAutoFilter() : AutoFilter; /** * Gets auto filter of this table. * * @remarks * It works only when is false. */ readonly autoFilter : AutoFilter; /** * @deprecated Please use the 'displayName' property instead. * Gets and sets the display name of the table. */ getDisplayName() : string; /** * Gets and sets the display name of the table. */ displayName : string; /** * @deprecated Please use the 'displayName' property instead. * Gets and sets the display name of the table. * @param value - The value to set. */ setDisplayName(value: string) : void; /** * @deprecated Please use the 'comment' property instead. * Gets and sets the comment of the table. */ getComment() : string; /** * Gets and sets the comment of the table. */ comment : string; /** * @deprecated Please use the 'comment' property instead. * Gets and sets the comment of the table. * @param value - The value to set. */ setComment(value: string) : void; /** * @deprecated Please use the 'showTableStyleFirstColumn' property instead. * Indicates whether the first column in the table is the style applied to. */ getShowTableStyleFirstColumn() : boolean; /** * Indicates whether the first column in the table is the style applied to. */ showTableStyleFirstColumn : boolean; /** * @deprecated Please use the 'showTableStyleFirstColumn' property instead. * Indicates whether the first column in the table is the style applied to. * @param value - The value to set. */ setShowTableStyleFirstColumn(value: boolean) : void; /** * @deprecated Please use the 'showTableStyleLastColumn' property instead. * Indicates whether the last column in the table is the style applied to. */ getShowTableStyleLastColumn() : boolean; /** * Indicates whether the last column in the table is the style applied to. */ showTableStyleLastColumn : boolean; /** * @deprecated Please use the 'showTableStyleLastColumn' property instead. * Indicates whether the last column in the table is the style applied to. * @param value - The value to set. */ setShowTableStyleLastColumn(value: boolean) : void; /** * @deprecated Please use the 'showTableStyleRowStripes' property instead. * Indicates whether row stripe formatting is applied to. */ getShowTableStyleRowStripes() : boolean; /** * Indicates whether row stripe formatting is applied to. */ showTableStyleRowStripes : boolean; /** * @deprecated Please use the 'showTableStyleRowStripes' property instead. * Indicates whether row stripe formatting is applied to. * @param value - The value to set. */ setShowTableStyleRowStripes(value: boolean) : void; /** * @deprecated Please use the 'showTableStyleColumnStripes' property instead. * Indicates whether column stripe formatting is applied to. */ getShowTableStyleColumnStripes() : boolean; /** * Indicates whether column stripe formatting is applied to. */ showTableStyleColumnStripes : boolean; /** * @deprecated Please use the 'showTableStyleColumnStripes' property instead. * Indicates whether column stripe formatting is applied to. * @param value - The value to set. */ setShowTableStyleColumnStripes(value: boolean) : void; /** * @deprecated Please use the 'tableStyleType' property instead. * Gets and the built-in table style. */ getTableStyleType() : TableStyleType; /** * Gets and the built-in table style. */ tableStyleType : TableStyleType; /** * @deprecated Please use the 'tableStyleType' property instead. * Gets and the built-in table style. * @param value - The value to set. */ setTableStyleType(value: TableStyleType) : void; /** * @deprecated Please use the 'tableStyleName' property instead. * Gets and sets the table style name. */ getTableStyleName() : string; /** * Gets and sets the table style name. */ tableStyleName : string; /** * @deprecated Please use the 'tableStyleName' property instead. * Gets and sets the table style name. * @param value - The value to set. */ setTableStyleName(value: string) : void; /** * @deprecated Please use the 'xmlMap' property instead. * Gets an used for this list. */ getXmlMap() : XmlMap; /** * Gets an used for this list. */ readonly xmlMap : XmlMap; /** * @deprecated Please use the 'alternativeText' property instead. * Gets and sets the alternative text. */ getAlternativeText() : string; /** * Gets and sets the alternative text. */ alternativeText : string; /** * @deprecated Please use the 'alternativeText' property instead. * Gets and sets the alternative text. * @param value - The value to set. */ setAlternativeText(value: string) : void; /** * @deprecated Please use the 'alternativeDescription' property instead. * Gets and sets the alternative description. */ getAlternativeDescription() : string; /** * Gets and sets the alternative description. */ alternativeDescription : string; /** * @deprecated Please use the 'alternativeDescription' property instead. * Gets and sets the alternative description. * @param value - The value to set. */ setAlternativeDescription(value: string) : void; /** * Resize the range of the list object. * @param startRow - The start row index of the new range. * @param startColumn - The start column index of the new range. * @param endRow - The end row index of the new range. * @param endColumn - The end column index of the new range. * @param hasHeaders - Whether this table has headers. */ resize(startRow: number, startColumn: number, endRow: number, endColumn: number, hasHeaders: boolean) : void; /** * Put the value to the cell. * @param rowOffset - The row offset in the table. * @param columnOffset - The column offset in the table. * @param value - The cell value. */ putCellValue(rowOffset: number, columnOffset: number, value: Object) : void; /** * Put the value to the cell. * @param rowOffset - The row offset in the table. * @param columnOffset - The column offset in the table. * @param value - The cell value. * @param isTotalsRowLabel - Indicates whether it is a label for total row,only works for total row. /// If False and this row is total row, a new row will be inserted. */ putCellValue(rowOffset: number, columnOffset: number, value: Object, isTotalsRowLabel: boolean) : void; /** * Put the formula to the cell in the table. * @param rowOffset - The row offset in the table. * @param columnOffset - The column offset in the table. * @param formula - The formula of the cell. */ putCellFormula(rowOffset: number, columnOffset: number, formula: string) : void; /** * Put the formula to the cell in the table. * @param rowOffset - The row offset in the table. * @param columnOffset - The column offset in the table. * @param formula - The formula of the cell. * @param isTotalsRowFormula - */ putCellFormula(rowOffset: number, columnOffset: number, formula: string, isTotalsRowFormula: boolean) : void; /** * Updates all list columns' name to cells in the table. * * @remarks * The value of the cells in the header row of the table must be same as the name of the ListColumn; * Cell.PutValue do not auto modify the name of the ListColumn for performance. */ updateColumnName() : void; /** * Removes auto filter which is applied to this table. */ removeAutoFilter() : void; /** * Filter the table. * * @remarks * NOTE: This member is now obsolete. * Instead,please set ListObject.HasAutoFilter property. * This property will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use set ListObject.HasAutoFilter property */ filter() : AutoFilter; /** * Apply the table style to the range. */ applyStyleToRange() : void; /** * Convert the table to range. */ convertToRange() : void; /** * Convert the table to range. * @param options - the options when converting table to range. */ convertToRange(options: TableToRangeOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents how to update links to other workbooks when the workbook is opened. */ export enum UpdateLinksType { /** * Prompt user to update. */ UserSet = 0, /** * Do not update, and do not prompt user. */ Never = 1, /** * Always update. */ Always = 2, } /** * Represents data validation.settings. */ export class Validation { /** * @deprecated Please use the 'operator' property instead. * Represents the operator for the data validation. */ getOperator() : OperatorType; /** * Represents the operator for the data validation. */ operator : OperatorType; /** * @deprecated Please use the 'operator' property instead. * Represents the operator for the data validation. * @param value - The value to set. */ setOperator(value: OperatorType) : void; /** * @deprecated Please use the 'alertStyle' property instead. * Represents the validation alert style. */ getAlertStyle() : ValidationAlertType; /** * Represents the validation alert style. */ alertStyle : ValidationAlertType; /** * @deprecated Please use the 'alertStyle' property instead. * Represents the validation alert style. * @param value - The value to set. */ setAlertStyle(value: ValidationAlertType) : void; /** * @deprecated Please use the 'type' property instead. * Represents the data validation type. */ getType() : ValidationType; /** * Represents the data validation type. */ type : ValidationType; /** * @deprecated Please use the 'type' property instead. * Represents the data validation type. * @param value - The value to set. */ setType(value: ValidationType) : void; /** * @deprecated Please use the 'inputMessage' property instead. * Represents the data validation input message. */ getInputMessage() : string; /** * Represents the data validation input message. */ inputMessage : string; /** * @deprecated Please use the 'inputMessage' property instead. * Represents the data validation input message. * @param value - The value to set. */ setInputMessage(value: string) : void; /** * @deprecated Please use the 'inputTitle' property instead. * Represents the title of the data-validation input dialog box. */ getInputTitle() : string; /** * Represents the title of the data-validation input dialog box. */ inputTitle : string; /** * @deprecated Please use the 'inputTitle' property instead. * Represents the title of the data-validation input dialog box. * @param value - The value to set. */ setInputTitle(value: string) : void; /** * @deprecated Please use the 'errorMessage' property instead. * Represents the data validation error message. */ getErrorMessage() : string; /** * Represents the data validation error message. */ errorMessage : string; /** * @deprecated Please use the 'errorMessage' property instead. * Represents the data validation error message. * @param value - The value to set. */ setErrorMessage(value: string) : void; /** * @deprecated Please use the 'errorTitle' property instead. * Represents the title of the data-validation error dialog box. */ getErrorTitle() : string; /** * Represents the title of the data-validation error dialog box. */ errorTitle : string; /** * @deprecated Please use the 'errorTitle' property instead. * Represents the title of the data-validation error dialog box. * @param value - The value to set. */ setErrorTitle(value: string) : void; /** * @deprecated Please use the 'showInput' property instead. * Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range. */ getShowInput() : boolean; /** * Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range. */ showInput : boolean; /** * @deprecated Please use the 'showInput' property instead. * Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range. * @param value - The value to set. */ setShowInput(value: boolean) : void; /** * @deprecated Please use the 'showError' property instead. * Indicates whether the data validation error message will be displayed whenever the user enters invalid data. */ getShowError() : boolean; /** * Indicates whether the data validation error message will be displayed whenever the user enters invalid data. */ showError : boolean; /** * @deprecated Please use the 'showError' property instead. * Indicates whether the data validation error message will be displayed whenever the user enters invalid data. * @param value - The value to set. */ setShowError(value: boolean) : void; /** * @deprecated Please use the 'ignoreBlank' property instead. * Indicates whether blank values are permitted by the range data validation. */ getIgnoreBlank() : boolean; /** * Indicates whether blank values are permitted by the range data validation. */ ignoreBlank : boolean; /** * @deprecated Please use the 'ignoreBlank' property instead. * Indicates whether blank values are permitted by the range data validation. * @param value - The value to set. */ setIgnoreBlank(value: boolean) : void; /** * @deprecated Please use the 'formula1' property instead. * Represents the value or expression associated with the data validation. */ getFormula1() : string; /** * Represents the value or expression associated with the data validation. */ formula1 : string; /** * @deprecated Please use the 'formula1' property instead. * Represents the value or expression associated with the data validation. * @param value - The value to set. */ setFormula1(value: string) : void; /** * @deprecated Please use the 'formula2' property instead. * Represents the value or expression associated with the data validation. */ getFormula2() : string; /** * Represents the value or expression associated with the data validation. */ formula2 : string; /** * @deprecated Please use the 'formula2' property instead. * Represents the value or expression associated with the data validation. * @param value - The value to set. */ setFormula2(value: string) : void; /** * @deprecated Please use the 'value1' property instead. * Represents the first value associated with the data validation. */ getValue1() : Object; /** * Represents the first value associated with the data validation. */ value1 : Object; /** * @deprecated Please use the 'value1' property instead. * Represents the first value associated with the data validation. * @param value - The value to set. */ setValue1(value: Object) : void; /** * @deprecated Please use the 'value2' property instead. * Represents the second value associated with the data validation. */ getValue2() : Object; /** * Represents the second value associated with the data validation. */ value2 : Object; /** * @deprecated Please use the 'value2' property instead. * Represents the second value associated with the data validation. * @param value - The value to set. */ setValue2(value: Object) : void; /** * @deprecated Please use the 'inCellDropDown' property instead. * Indicates whether data validation displays a drop-down list that contains acceptable values. */ getInCellDropDown() : boolean; /** * Indicates whether data validation displays a drop-down list that contains acceptable values. */ inCellDropDown : boolean; /** * @deprecated Please use the 'inCellDropDown' property instead. * Indicates whether data validation displays a drop-down list that contains acceptable values. * @param value - The value to set. */ setInCellDropDown(value: boolean) : void; /** * @deprecated Please use the 'areas' property instead. * Gets all which contain the data validation settings. */ getAreas() : CellArea[]; /** * Gets all which contain the data validation settings. */ readonly areas : CellArea[]; /** * Gets the value or expression associated with this validation. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @returns * The value or expression associated with this validation. */ getFormula1(isR1C1: boolean, isLocal: boolean) : string; /** * Gets the value or expression associated with this validation for specific cell. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @param row - The row index. * @param column - The column index. * @returns * The value or expression associated with this validation. */ getFormula1(isR1C1: boolean, isLocal: boolean, row: number, column: number) : string; /** * Gets the value or expression associated with this validation. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @returns * The value or expression associated with this validation. */ getFormula2(isR1C1: boolean, isLocal: boolean) : string; /** * Gets the value or expression associated with this validation for specific cell. * @param isR1C1 - Whether the formula needs to be formatted as R1C1. * @param isLocal - Whether the formula needs to be formatted by locale. * @param row - The row index. * @param column - The column index. * @returns * The value or expression associated with this validation. */ getFormula2(isR1C1: boolean, isLocal: boolean, row: number, column: number) : string; /** * Sets the value or expression associated with this validation. * @param formula - The value or expression associated with this format condition. * @param isR1C1 - Whether the formula is R1C1 formula. * @param isLocal - Whether the formula is locale formatted. */ setFormula1(formula: string, isR1C1: boolean, isLocal: boolean) : void; /** * Sets the value or expression associated with this validation. * @param formula - The value or expression associated with this format condition. * @param isR1C1 - Whether the formula is R1C1 formula. * @param isLocal - Whether the formula is locale formatted. */ setFormula2(formula: string, isR1C1: boolean, isLocal: boolean) : void; /** * Get the value for list of the validation for the specified cell. * @param row - The row index. * @param column - The column index. * @returns * The value to produce the list of this validation for the specified cell. * If the list references to a range, then the returned value will be a object; * Otherwise the returned value may be null, object[], or simple object. * * @remarks * Only for validation whose type is List and has been applied to given cell, * otherwise null will be returned. */ getListValue(row: number, column: number) : Object; /** * Get the value of validation on the specific cell. * @param row - The row index. * @param column - The column index. * @param isValue1 - Indicates whether getting the first value. */ getValue(row: number, column: number, isValue1: boolean) : Object; /** * Applies the validation to the area. * @param cellArea - The area. * * @remarks * It is equivalent to use * with checking intersection and edge. */ addArea(cellArea: CellArea) : void; /** * Applies the validation to the area. * @param cellArea - The area. * @param checkIntersection - Whether check the intersection of given area with existing validations' areas. /// If one validation has been applied in given area(or part of it), /// then the existing validation should be removed at first from given area. /// Otherwise corruption may be caused for the generated Validations. /// If user is sure that the added area does not intersect with any existing area, /// this parameter can be set as false for performance consideration. * @param checkEdge - Whether check the edge of this validation's applied areas. /// Validation's internal settings depend on the top-left one of its applied ranges, /// so if given area will become the new top-left one of the applied ranges, /// the internal settings should be changed and rebuilt, otherwise unexpected result may be caused. /// If user is sure that the added area is not the top-left one, /// this parameter can be set as false for performance consideration. * * @remarks * In this method, we will remove all old validations in given area. * For the top-left one of Validation's applied ranges, firstly its StartRow is smallest, * secondly its StartColumn is the smallest one of those areas who have the same smallest StartRow. */ addArea(cellArea: CellArea, checkIntersection: boolean, checkEdge: boolean) : void; /** * Applies the validation to given areas. * @param areas - The areas. * @param checkIntersection - Whether check the intersection of given area with existing validations' areas. /// If one validation has been applied in given area(or part of it), /// then the existing validation should be removed at first from given area. /// Otherwise corruption may be caused for the generated Validations. /// If user is sure that all the added areas do not intersect with any existing area, /// this parameter can be set as false for performance consideration. * @param checkEdge - Whether check the edge of this validation's applied areas. /// Validation's internal settings depend on the top-left one of its applied ranges, /// so if one of given areas will become the new top-left one of the applied ranges, /// the internal settings should be changed and rebuilt, otherwise unexpected result may be caused. /// If user is sure that no one of those added areas is the top-left, /// this parameter can be set as false for performance consideration. * * @remarks * In this method, we will remove all old validations in given area. * For the top-left one of Validation's applied ranges, firstly its StartRow is smallest, * secondly its StartColumn is the smallest one of those areas who have the same smallest StartRow. */ addAreas(areas: CellArea[], checkIntersection: boolean, checkEdge: boolean) : void; /** * Remove the validation settings in the range. * @param cellArea - the areas where this validation settings should be removed. */ removeArea(cellArea: CellArea) : void; /** * Removes this validation from given areas. * @param areas - the areas where this validation settings should be removed. */ removeAreas(areas: CellArea[]) : void; /** * Remove the validation settings in the cell. * @param row - The row index. * @param column - The column index. */ removeACell(row: number, column: number) : void; /** * Copy validation. * @param source - The source validation. * @param copyOption - The copy option. */ copy(source: Validation, copyOption: CopyOptions) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the module in VBA project. */ export class VbaModule { /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of Module. */ getName() : string; /** * Gets and sets the name of Module. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of Module. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'type' property instead. * Gets the type of module. */ getType() : VbaModuleType; /** * Gets the type of module. */ readonly type : VbaModuleType; /** * @deprecated Please use the 'binaryCodes' property instead. * Gets and sets the binary codes of module. */ getBinaryCodes() : Uint8Array; /** * Gets and sets the binary codes of module. */ readonly binaryCodes : Uint8Array; /** * @deprecated Please use the 'codes' property instead. * Gets and sets the codes of module. */ getCodes() : string; /** * Gets and sets the codes of module. */ codes : string; /** * @deprecated Please use the 'codes' property instead. * Gets and sets the codes of module. * @param value - The value to set. */ setCodes(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the list of */ export class VbaModuleCollection implements Iterable { /** * Gets in the list by the index. * @param index - The index. */ get(index: number) : VbaModule; /** * Gets in the list by the name. * @param name - The name of module. */ get(name: string) : VbaModule; /** * @param name - * @param data - */ addDesignerStorage(name: string, data: Uint8Array) : void; /** * Represents the data of Designer. * * @remarks * We do not support to parse them. Just only for copying. */ getDesignerStorage(name: string) : Uint8Array; /** * Adds module for a worksheet. * @param sheet - The worksheet */ add(sheet: Worksheet) : number; /** * Adds module. * @param type - The type of module. * @param name - The name of module. */ add(type: VbaModuleType, name: string) : number; /** * Inser user form into VBA Project. * @param name - The name of user form * @param codes - The codes for the user form * @param designerStorage - the designer setting about the user form */ addUserForm(name: string, codes: string, designerStorage: Uint8Array) : number; /** * Removes module for a worksheet. * @param sheet - The worksheet */ remove(sheet: Worksheet) : void; /** * Remove the module by the name * @param name - */ remove(name: string) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the type of VBA module. */ export enum VbaModuleType { /** * Represents a procedural module. */ Procedural = 0, /** * Represents a document module. */ Document = 1, /** * Represents a class module. */ Class = 2, /** * Represents a designer module. */ Designer = 3, } /** * Represents the VBA project. */ export class VbaProject { /** * Indicates whether the signature of VBA project is valid or not. */ readonly isValidSigned : boolean; /** * @deprecated Please use the 'certRawData' property instead. * Gets certificate raw data if this VBA project is signed. */ getCertRawData() : Uint8Array; /** * Gets certificate raw data if this VBA project is signed. */ readonly certRawData : Uint8Array; /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the encoding of VBA project. */ getEncoding() : EncodingType; /** * Gets and sets the encoding of VBA project. */ encoding : EncodingType; /** * @deprecated Please use the 'encoding' property instead. * Gets and sets the encoding of VBA project. * @param value - The value to set. */ setEncoding(value: EncodingType) : void; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the VBA project. */ getName() : string; /** * Gets and sets the name of the VBA project. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the VBA project. * @param value - The value to set. */ setName(value: string) : void; /** * Indicates whether VBAcode is signed or not. */ readonly isSigned : boolean; /** * Indicates whether this VBA project is protected. */ readonly isProtected : boolean; /** * @deprecated Please use the 'islockedForViewing' property instead. * Indicates whether this VBA project is locked for viewing. */ getIslockedForViewing() : boolean; /** * Indicates whether this VBA project is locked for viewing. */ readonly islockedForViewing : boolean; /** * @deprecated Please use the 'modules' property instead. * Gets all objects. */ getModules() : VbaModuleCollection; /** * Gets all objects. */ readonly modules : VbaModuleCollection; /** * @deprecated Please use the 'references' property instead. * Gets all references of VBA project. */ getReferences() : VbaProjectReferenceCollection; /** * Gets all references of VBA project. */ readonly references : VbaProjectReferenceCollection; /** * Sign this VBA project by a DigitalSignature * @param digitalSignature - DigitalSignature */ sign(digitalSignature: DigitalSignature) : void; /** * Protects or unprotects this VBA project. * @param islockedForViewing - indicates whether locks project for viewing. * @param password - If the value is null, unprotects this VBA project, otherwise projects the this VBA project. * * @remarks * If islockedForViewing is true, the password could not be null. */ protect(islockedForViewing: boolean, password: string) : void; /** * Copy VBA project from other file. * @param source - */ copy(source: VbaProject) : void; /** * Validates protection password. * @param password - the password * @returns * Whether password is the protection password of this VBA project */ validatePassword(password: string) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the reference of VBA project. */ export class VbaProjectReference { /** * @deprecated Please use the 'type' property instead. * Gets the type of this reference. */ getType() : VbaProjectReferenceType; /** * Gets the type of this reference. */ readonly type : VbaProjectReferenceType; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the reference. */ getName() : string; /** * Gets and sets the name of the reference. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the reference. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'libid' property instead. * Gets and sets the Libid of the reference. */ getLibid() : string; /** * Gets and sets the Libid of the reference. */ libid : string; /** * @deprecated Please use the 'libid' property instead. * Gets and sets the Libid of the reference. * @param value - The value to set. */ setLibid(value: string) : void; /** * @deprecated Please use the 'twiddledlibid' property instead. * Gets and sets the twiddled Libid of the reference. * * @remarks * Only for control reference. */ getTwiddledlibid() : string; /** * Gets and sets the twiddled Libid of the reference. * * @remarks * Only for control reference. */ twiddledlibid : string; /** * @deprecated Please use the 'twiddledlibid' property instead. * Gets and sets the twiddled Libid of the reference. * @param value - The value to set. * * @remarks * Only for control reference. */ setTwiddledlibid(value: string) : void; /** * @deprecated Please use the 'extendedLibid' property instead. * Gets and sets the extended Libid of the reference. * * @remarks * Only for control reference. */ getExtendedLibid() : string; /** * Gets and sets the extended Libid of the reference. * * @remarks * Only for control reference. */ extendedLibid : string; /** * @deprecated Please use the 'extendedLibid' property instead. * Gets and sets the extended Libid of the reference. * @param value - The value to set. * * @remarks * Only for control reference. */ setExtendedLibid(value: string) : void; /** * @deprecated Please use the 'relativeLibid' property instead. * Gets and sets the referenced VBA project's identifier with an relative path. * * @remarks * Only for project reference. */ getRelativeLibid() : string; /** * Gets and sets the referenced VBA project's identifier with an relative path. * * @remarks * Only for project reference. */ relativeLibid : string; /** * @deprecated Please use the 'relativeLibid' property instead. * Gets and sets the referenced VBA project's identifier with an relative path. * @param value - The value to set. * * @remarks * Only for project reference. */ setRelativeLibid(value: string) : void; /** * @param source - */ copy(source: VbaProjectReference) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all references of VBA project. */ export class VbaProjectReferenceCollection implements Iterable { /** * Get the reference in the list by the index. * @param i - The index. */ get(i: number) : VbaProjectReference; /** * Add a reference to an Automation type library. * @param name - The name of reference. * @param libid - The identifier of an Automation type library. */ addRegisteredReference(name: string, libid: string) : number; /** * Add a reference to a twiddled type library and its extended type library. * @param name - The name of reference. * @param libid - The identifier of an Automation type library. * @param twiddledlibid - The identifier of a twiddled type library * @param extendedLibid - The identifier of an extended type library */ addControlRefrernce(name: string, libid: string, twiddledlibid: string, extendedLibid: string) : number; /** * Adds a reference to an external VBA project. * @param name - The name of reference. * @param absoluteLibid - The referenced VBA project's identifier with an absolute path. * @param relativeLibid - The referenced VBA project's identifier with an relative path. */ addProjectRefrernce(name: string, absoluteLibid: string, relativeLibid: string) : number; /** * Copies references from other VBA project. * @param source - The source references. */ copy(source: VbaProjectReferenceCollection) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the type of VBA project reference. */ export enum VbaProjectReferenceType { /** * Specifies a reference to an Automation type library. */ Registered = 0, /** * Specifies a reference to a twiddled type library and its extended type library. */ Control = 1, /** * Specifies a reference to an external VBA project. */ Project = 2, } /** * Warning info */ export class WarningInfo { /** * @deprecated Please use the 'type' property instead. * Get warning type. */ getType() : ExceptionType; /** * Get warning type. */ readonly type : ExceptionType; /** * @deprecated Please use the 'description' property instead. * Get description of warning info. */ getDescription() : string; /** * Get description of warning info. */ readonly description : string; /** * @deprecated Please use the 'errorObject' property instead. * The error object. */ getErrorObject() : Object; /** * The error object. */ readonly errorObject : Object; /** * @deprecated Please use the 'correctedObject' property instead. * Gets and sets the corrected object. */ getCorrectedObject() : Object; /** * Gets and sets the corrected object. */ correctedObject : Object; /** * @deprecated Please use the 'correctedObject' property instead. * Gets and sets the corrected object. * @param value - The value to set. */ setCorrectedObject(value: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * WaringType * * @remarks * NOTE: This enum is now obsolete. Instead, * please use ExceptionType enum, instead. * This property will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ExceptionType enum, instead. */ export enum WarningType { /** * Font substitution warning type * when a font has not been found, this warning type can be get. */ FontSubstitution = 0, /** * Duplicate defined name is found in the file. */ DuplicateDefinedName = 1, /** * Unsupported file format. */ UnsupportedFileFormat = 2, /** * Invalid text of the defined name. */ InvalidTextOfDefinedName = 3, /** * Invalid the font name. */ InvalidFontName = 4, /** * Invalid autofilter range. */ InvalidAutoFilterRange = 5, /** * The file is corrupted. */ IO = 6, /** * Out of MS Excel limitation error. */ Limitation = 7, /** * Invalid data. */ InvalidData = 8, /** * Invalid formula. */ Formula = 9, /** * Invalid operator. */ InvalidOperator = 10, } /** * Specifies write protection settings for a workbook. */ export class WriteProtection { /** * @deprecated Please use the 'author' property instead. * Gets and sets the author. */ getAuthor() : string; /** * Gets and sets the author. */ author : string; /** * @deprecated Please use the 'author' property instead. * Gets and sets the author. * @param value - The value to set. */ setAuthor(value: string) : void; /** * @deprecated Please use the 'recommendReadOnly' property instead. * Indicates if the Read Only Recommended option is selected. */ getRecommendReadOnly() : boolean; /** * Indicates if the Read Only Recommended option is selected. */ recommendReadOnly : boolean; /** * @deprecated Please use the 'recommendReadOnly' property instead. * Indicates if the Read Only Recommended option is selected. * @param value - The value to set. */ setRecommendReadOnly(value: boolean) : void; /** * Indicates whether this workbook is write protected. */ readonly isWriteProtected : boolean; /** * @deprecated Please use the 'password' property instead. * Sets the protected password to modify the file. * * @remarks */ getPassword() : string; /** * Sets the protected password to modify the file. * * @remarks */ password : string; /** * @deprecated Please use the 'password' property instead. * Sets the protected password to modify the file. * @param value - The value to set. * * @remarks */ setPassword(value: string) : void; /** * Returns true if the specified password is the same as the write-protection password the file was protected with. * @param password - The specified password. */ validatePassword(password: string) : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents five types of html cross string. */ export enum HtmlCrossType { /** * Display like MS Excel,depends on the next cell. * If the next cell is null,the string will cross,or it will be truncated */ Default = 0, /** * Display the string like MS Excel exporting html. */ MSExport = 1, /** * Display HTML cross string, this performance for creating large html files will be more than ten times faster than setting the value to Default or FitToCell. */ Cross = 2, /** * Display HTML cross string and hide the right string when the texts overlap. */ CrossHideRight = 3, /** * Only displaying the string within the width of cell. */ FitToCell = 4, } /** * Enumerates Bit Depth Type for tiff image. */ export enum ColorDepth { /** * Default value, not set value. */ Default = 0, /** * 1 bit per pixel */ Format1bpp = 1, /** * 4 bits per pixel */ Format4bpp = 4, /** * 8 bits per pixel */ Format8bpp = 8, /** * 24 bits per pixel */ Format24bpp = 24, /** * 32 bits per pixel */ Format32bpp = 32, } /** * DrawObject will be initialized and returned when rendering. */ export class DrawObject { /** * @deprecated Please use the 'cell' property instead. * Indicates the Cell object when rendering. * All properties of cell can be accessed. */ getCell() : Cell; /** * Indicates the Cell object when rendering. * All properties of cell can be accessed. */ readonly cell : Cell; /** * @deprecated Please use the 'shape' property instead. * Indicates the Shape object when rendering. * All properties of shape can be accessed. */ getShape() : Shape; /** * Indicates the Shape object when rendering. * All properties of shape can be accessed. */ readonly shape : Shape; /** * @deprecated Please use the 'imageBytes' property instead. * Indicates image bytes of rendered Chart, Shape when rendering. */ getImageBytes() : Uint8Array; /** * Indicates image bytes of rendered Chart, Shape when rendering. */ readonly imageBytes : Uint8Array; /** * @deprecated Please use the 'type' property instead. * Indicates the type of DrawObject. */ getType() : DrawObjectEnum; /** * Indicates the type of DrawObject. */ readonly type : DrawObjectEnum; /** * @deprecated Please use the 'currentPage' property instead. * Indicates the page index of DrawObject. * Page index is based on zero. * One Sheet contains several pages when rendering. */ getCurrentPage() : number; /** * Indicates the page index of DrawObject. * Page index is based on zero. * One Sheet contains several pages when rendering. */ readonly currentPage : number; /** * @deprecated Please use the 'totalPages' property instead. * Indicates total pages in current rendering. */ getTotalPages() : number; /** * Indicates total pages in current rendering. */ readonly totalPages : number; /** * @deprecated Please use the 'sheetIndex' property instead. * Indicates current sheet index of DrawObject. */ getSheetIndex() : number; /** * Indicates current sheet index of DrawObject. */ readonly sheetIndex : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Indicate Cell or Image of DrawObject. */ export enum DrawObjectEnum { /** * Indicate DrawObject is an Image */ Image = 0, /** * indicate DrawObject is an Cell */ Cell = 1, } /** * Interface to get DrawObject and Bound when rendering. */ export abstract class DrawObjectEventHandler { /** * Implements this interface to get DrawObject and Bound when rendering. * @param drawObject - DrawObject will be initialized and returned when rendering * @param x - Left of DrawObject * @param y - Top of DrawObject * @param width - Width of DrawObject * @param height - Height of DrawObject */ draw(drawObject: DrawObject, x: number, y: number, width: number, height: number) : void; } /** * Enumerates grid line Type. */ export enum GridlineType { /** * Represents dotted line. */ Dotted = 0, /** * Represents hair line. */ Hair = 1, } /** * Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image. */ export class ImageOrPrintOptions { /** * Ctor. */ constructor(); /** * @deprecated Please use the 'printWithStatusDialog' property instead. * If PrintWithStatusDialog = true , there will be a dialog that shows current print status. * else no such dialog will show. * @param value - The value to set. */ setPrintWithStatusDialog(value: boolean) : void; /** * @deprecated Please use the 'printWithStatusDialog' property instead. * If PrintWithStatusDialog = true , there will be a dialog that shows current print status. * else no such dialog will show. */ getPrintWithStatusDialog() : boolean; /** * If PrintWithStatusDialog = true , there will be a dialog that shows current print status. * else no such dialog will show. */ printWithStatusDialog : boolean; /** * @deprecated Please use the 'horizontalResolution' property instead. * Gets or sets the horizontal resolution for generated images, in dots per inch. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ getHorizontalResolution() : number; /** * Gets or sets the horizontal resolution for generated images, in dots per inch. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ horizontalResolution : number; /** * @deprecated Please use the 'horizontalResolution' property instead. * Gets or sets the horizontal resolution for generated images, in dots per inch. * @param value - The value to set. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ setHorizontalResolution(value: number) : void; /** * @deprecated Please use the 'verticalResolution' property instead. * Gets or sets the vertical resolution for generated images, in dots per inch. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ getVerticalResolution() : number; /** * Gets or sets the vertical resolution for generated images, in dots per inch. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ verticalResolution : number; /** * @deprecated Please use the 'verticalResolution' property instead. * Gets or sets the vertical resolution for generated images, in dots per inch. * @param value - The value to set. * * @remarks * The default value is 96. * Setting and * effects the width and height of the output image in pixels. */ setVerticalResolution(value: number) : void; /** * @deprecated Please use the 'tiffCompression' property instead. * Gets or sets the type of compression to apply only when saving pages to the Tiff format. * * @remarks * Has effect only when saving to TIFF. * The default value is Lzw. */ getTiffCompression() : TiffCompression; /** * Gets or sets the type of compression to apply only when saving pages to the Tiff format. * * @remarks * Has effect only when saving to TIFF. * The default value is Lzw. */ tiffCompression : TiffCompression; /** * @deprecated Please use the 'tiffCompression' property instead. * Gets or sets the type of compression to apply only when saving pages to the Tiff format. * @param value - The value to set. * * @remarks * Has effect only when saving to TIFF. * The default value is Lzw. */ setTiffCompression(value: TiffCompression) : void; /** * @deprecated Please use the 'tiffColorDepth' property instead. * Gets or sets bit depth to apply only when saving pages to the Tiff format. * * @remarks * Has effect only when saving to TIFF. * If TiffCompression is set to CCITT3, CCITT4, this will not take effect, the bit depth of the generated tiff image will be always 1. */ getTiffColorDepth() : ColorDepth; /** * Gets or sets bit depth to apply only when saving pages to the Tiff format. * * @remarks * Has effect only when saving to TIFF. * If TiffCompression is set to CCITT3, CCITT4, this will not take effect, the bit depth of the generated tiff image will be always 1. */ tiffColorDepth : ColorDepth; /** * @deprecated Please use the 'tiffColorDepth' property instead. * Gets or sets bit depth to apply only when saving pages to the Tiff format. * @param value - The value to set. * * @remarks * Has effect only when saving to TIFF. * If TiffCompression is set to CCITT3, CCITT4, this will not take effect, the bit depth of the generated tiff image will be always 1. */ setTiffColorDepth(value: ColorDepth) : void; /** * @deprecated Please use the 'tiffBinarizationMethod' property instead. * Gets or sets method used while converting images to 1 bpp format * when is Tiff and is equal to Ccitt3 or Ccitt4. * * @remarks * The default value is FloydSteinbergDithering. */ getTiffBinarizationMethod() : ImageBinarizationMethod; /** * Gets or sets method used while converting images to 1 bpp format * when is Tiff and is equal to Ccitt3 or Ccitt4. * * @remarks * The default value is FloydSteinbergDithering. */ tiffBinarizationMethod : ImageBinarizationMethod; /** * @deprecated Please use the 'tiffBinarizationMethod' property instead. * Gets or sets method used while converting images to 1 bpp format * when is Tiff and is equal to Ccitt3 or Ccitt4. * @param value - The value to set. * * @remarks * The default value is FloydSteinbergDithering. */ setTiffBinarizationMethod(value: ImageBinarizationMethod) : void; /** * @deprecated Please use the 'printingPage' property instead. * Indicates which pages will not be printed. */ getPrintingPage() : PrintingPageType; /** * Indicates which pages will not be printed. */ printingPage : PrintingPageType; /** * @deprecated Please use the 'printingPage' property instead. * Indicates which pages will not be printed. * @param value - The value to set. */ setPrintingPage(value: PrintingPageType) : void; /** * @deprecated Please use the 'quality' property instead. * Gets or sets a value determining the quality of the generated images * to apply only when saving pages to the Jpeg format. The default value is 100 * * @remarks * Has effect only when saving to JPEG. * The value must be between 0 and 100. * The default value is 100. */ getQuality() : number; /** * Gets or sets a value determining the quality of the generated images * to apply only when saving pages to the Jpeg format. The default value is 100 * * @remarks * Has effect only when saving to JPEG. * The value must be between 0 and 100. * The default value is 100. */ quality : number; /** * @deprecated Please use the 'quality' property instead. * Gets or sets a value determining the quality of the generated images * to apply only when saving pages to the Jpeg format. The default value is 100 * @param value - The value to set. * * @remarks * Has effect only when saving to JPEG. * The value must be between 0 and 100. * The default value is 100. */ setQuality(value: number) : void; /** * Gets or sets the format of the generated images. * default value: PNG. */ getImageType() : ImageType; /** * Gets or sets the format of the generated images. * default value: PNG. * @param value - The value to set. */ setImageType(value: ImageType) : void; /** * @deprecated Please use the 'onePagePerSheet' property instead. * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ getOnePagePerSheet() : boolean; /** * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ onePagePerSheet : boolean; /** * @deprecated Please use the 'onePagePerSheet' property instead. * If OnePagePerSheet is true , all content of one sheet will output to only one page in result. * The paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. * @param value - The value to set. */ setOnePagePerSheet(value: boolean) : void; /** * @deprecated Please use the 'allColumnsInOnePagePerSheet' property instead. * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ getAllColumnsInOnePagePerSheet() : boolean; /** * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. */ allColumnsInOnePagePerSheet : boolean; /** * @deprecated Please use the 'allColumnsInOnePagePerSheet' property instead. * If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. * The width of paper size of pagesetup will be invalid, and the other settings of pagesetup * will still take effect. * @param value - The value to set. */ setAllColumnsInOnePagePerSheet(value: boolean) : void; /** * @deprecated Please use the 'drawObjectEventHandler' property instead. * Implements this interface to get DrawObject and Bound when rendering. */ getDrawObjectEventHandler() : DrawObjectEventHandler; /** * Implements this interface to get DrawObject and Bound when rendering. */ drawObjectEventHandler : DrawObjectEventHandler; /** * @deprecated Please use the 'drawObjectEventHandler' property instead. * Implements this interface to get DrawObject and Bound when rendering. * @param value - The value to set. */ setDrawObjectEventHandler(value: DrawObjectEventHandler) : void; /** * @deprecated Please use the 'embededImageNameInSvg' property instead. * Indicate the filename of embedded image in svg. * This should be full path with directory like "c:\\xpsEmbedded" * * @remarks * NOTE: This member is now obsolete. Instead, * please remove this property because images are now always embedded in Svg with base64 format. * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Images are now always embedded in Svg with base64 format, please remove this property. */ getEmbededImageNameInSvg() : string; /** * Indicate the filename of embedded image in svg. * This should be full path with directory like "c:\\xpsEmbedded" * * @remarks * NOTE: This member is now obsolete. Instead, * please remove this property because images are now always embedded in Svg with base64 format. * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Images are now always embedded in Svg with base64 format, please remove this property. */ embededImageNameInSvg : string; /** * @deprecated Please use the 'embededImageNameInSvg' property instead. * Indicate the filename of embedded image in svg. * This should be full path with directory like "c:\\xpsEmbedded" * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please remove this property because images are now always embedded in Svg with base64 format. * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Images are now always embedded in Svg with base64 format, please remove this property. */ setEmbededImageNameInSvg(value: string) : void; /** * @deprecated Please use the 'sVGFitToViewPort' property instead. * if this property is true, the generated svg will fit to view port. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.FitToViewPort property instead. */ getSVGFitToViewPort() : boolean; /** * if this property is true, the generated svg will fit to view port. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.FitToViewPort property instead. */ sVGFitToViewPort : boolean; /** * @deprecated Please use the 'sVGFitToViewPort' property instead. * if this property is true, the generated svg will fit to view port. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.FitToViewPort property instead. */ setSVGFitToViewPort(value: boolean) : void; /** * @deprecated Please use the 'svgCssPrefix' property instead. * Gets and sets the prefix of the css name in svg,the default value is empty string. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.CssPrefix property instead. */ getSvgCssPrefix() : string; /** * Gets and sets the prefix of the css name in svg,the default value is empty string. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.CssPrefix property instead. */ svgCssPrefix : string; /** * @deprecated Please use the 'svgCssPrefix' property instead. * Gets and sets the prefix of the css name in svg,the default value is empty string. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use . * This property will be removed 12 months later since April 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SvgImageOptions.CssPrefix property instead. */ setSvgCssPrefix(value: string) : void; /** * @deprecated Please use the 'onlyArea' property instead. * If this property is true , one Area will be output, and no scale will take effect. */ getOnlyArea() : boolean; /** * If this property is true , one Area will be output, and no scale will take effect. */ onlyArea : boolean; /** * @deprecated Please use the 'onlyArea' property instead. * If this property is true , one Area will be output, and no scale will take effect. * @param value - The value to set. */ setOnlyArea(value: boolean) : void; /** * @deprecated Please use the 'transparent' property instead. * Indicates if the background of generated image should be transparent. * * @remarks * The default value is false. That means the background of the generated images is white. */ getTransparent() : boolean; /** * Indicates if the background of generated image should be transparent. * * @remarks * The default value is false. That means the background of the generated images is white. */ transparent : boolean; /** * @deprecated Please use the 'transparent' property instead. * Indicates if the background of generated image should be transparent. * @param value - The value to set. * * @remarks * The default value is false. That means the background of the generated images is white. */ setTransparent(value: boolean) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. * @param value - The value to set. */ setWarningCallback(value: IWarningCallback) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. */ getWarningCallback() : IWarningCallback; /** * Gets or sets warning callback. */ warningCallback : IWarningCallback; /** * @deprecated Please use the 'pageSavingCallback' property instead. * Control/Indicate progress of page saving process. */ getPageSavingCallback() : IPageSavingCallback; /** * Control/Indicate progress of page saving process. */ pageSavingCallback : IPageSavingCallback; /** * @deprecated Please use the 'pageSavingCallback' property instead. * Control/Indicate progress of page saving process. * @param value - The value to set. */ setPageSavingCallback(value: IPageSavingCallback) : void; /** * @deprecated Please use the 'isFontSubstitutionCharGranularity' property instead. * Indicates whether to only substitute the font of character when the cell font is not compatibility for it. * @param value - The value to set. * * @remarks * Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first. */ setIsFontSubstitutionCharGranularity(value: boolean) : void; /** * Indicates whether to only substitute the font of character when the cell font is not compatibility for it. * * @remarks * Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first. */ isFontSubstitutionCharGranularity : boolean; /** * @deprecated Please use the 'pageIndex' property instead. * Gets or sets the 0-based index of the first page to save. * @param value - The value to set. * * @remarks * Default is 0. */ setPageIndex(value: number) : void; /** * @deprecated Please use the 'pageIndex' property instead. * Gets or sets the 0-based index of the first page to save. * * @remarks * Default is 0. */ getPageIndex() : number; /** * Gets or sets the 0-based index of the first page to save. * * @remarks * Default is 0. */ pageIndex : number; /** * @deprecated Please use the 'pageCount' property instead. * Gets or sets the number of pages to save. * @param value - The value to set. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered. */ setPageCount(value: number) : void; /** * @deprecated Please use the 'pageCount' property instead. * Gets or sets the number of pages to save. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered. */ getPageCount() : number; /** * Gets or sets the number of pages to save. * * @remarks * Default is System.Int32.MaxValue which means all pages will be rendered. */ pageCount : number; /** * Indicates whether to optimize the output elements. * * @remarks * Default value is false. * Currently when this property is set to true, the following optimizations will be done: * 1. optimize the border lines. * 2. optimize the file size while rendering to Svg image. */ isOptimized : boolean; /** * @deprecated Please use the 'isOptimized' property instead. * Indicates whether to optimize the output elements. * @param value - The value to set. * * @remarks * Default value is false. * Currently when this property is set to true, the following optimizations will be done: * 1. optimize the border lines. * 2. optimize the file size while rendering to Svg image. */ setIsOptimized(value: boolean) : void; /** * @deprecated Please use the 'defaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. */ getDefaultFont() : string; /** * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. */ defaultFont : string; /** * @deprecated Please use the 'defaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set the DefaultFont such as MingLiu or MS Gothic to show these characters. * If this property is not set, Aspose.Cells will use system default font to show these unicode characters. * @param value - The value to set. */ setDefaultFont(value: string) : void; /** * @deprecated Please use the 'checkWorkbookDefaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * * @remarks * Default is true. */ getCheckWorkbookDefaultFont() : boolean; /** * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * * @remarks * Default is true. */ checkWorkbookDefaultFont : boolean; /** * @deprecated Please use the 'checkWorkbookDefaultFont' property instead. * When characters in the Excel are Unicode and not be set with correct font in cell style, * They may appear as block in pdf,image. * Set this to true to try to use workbook's default font to show these characters first. * @param value - The value to set. * * @remarks * Default is true. */ setCheckWorkbookDefaultFont(value: boolean) : void; /** * @deprecated Please use the 'outputBlankPageWhenNothingToPrint' property instead. * Indicates whether to output a blank page when there is nothing to print. * * @remarks * Default is false. */ getOutputBlankPageWhenNothingToPrint() : boolean; /** * Indicates whether to output a blank page when there is nothing to print. * * @remarks * Default is false. */ outputBlankPageWhenNothingToPrint : boolean; /** * @deprecated Please use the 'outputBlankPageWhenNothingToPrint' property instead. * Indicates whether to output a blank page when there is nothing to print. * @param value - The value to set. * * @remarks * Default is false. */ setOutputBlankPageWhenNothingToPrint(value: boolean) : void; /** * @deprecated Please use the 'gridlineType' property instead. * Gets or sets gridline type. * * @remarks * Default is Dotted type. */ getGridlineType() : GridlineType; /** * Gets or sets gridline type. * * @remarks * Default is Dotted type. */ gridlineType : GridlineType; /** * @deprecated Please use the 'gridlineType' property instead. * Gets or sets gridline type. * @param value - The value to set. * * @remarks * Default is Dotted type. */ setGridlineType(value: GridlineType) : void; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets or sets gridline colr. * * @remarks * It will ignore the gridline color settings in the source file. */ getGridlineColor() : Color; /** * Gets or sets gridline colr. * * @remarks * It will ignore the gridline color settings in the source file. */ gridlineColor : Color; /** * @deprecated Please use the 'gridlineColor' property instead. * Gets or sets gridline colr. * @param value - The value to set. * * @remarks * It will ignore the gridline color settings in the source file. */ setGridlineColor(value: Color) : void; /** * @deprecated Please use the 'textCrossType' property instead. * Gets or sets displaying text type when the text width is larger than cell width. */ getTextCrossType() : TextCrossType; /** * Gets or sets displaying text type when the text width is larger than cell width. */ textCrossType : TextCrossType; /** * @deprecated Please use the 'textCrossType' property instead. * Gets or sets displaying text type when the text width is larger than cell width. * @param value - The value to set. */ setTextCrossType(value: TextCrossType) : void; /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ getDefaultEditLanguage() : DefaultEditLanguage; /** * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ defaultEditLanguage : DefaultEditLanguage; /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * @param value - The value to set. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ setDefaultEditLanguage(value: DefaultEditLanguage) : void; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * * @remarks * The set is ignored when it is used in */ getSheetSet() : SheetSet; /** * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * * @remarks * The set is ignored when it is used in */ sheetSet : SheetSet; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * @param value - The value to set. * * @remarks * The set is ignored when it is used in */ setSheetSet(value: SheetSet) : void; /** * @deprecated Please use the 'emfRenderSetting' property instead. * Setting for rendering Emf metafiles in source file. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed. * Default value is . * For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored. */ getEmfRenderSetting() : EmfRenderSetting; /** * Setting for rendering Emf metafiles in source file. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed. * Default value is . * For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored. */ emfRenderSetting : EmfRenderSetting; /** * @deprecated Please use the 'emfRenderSetting' property instead. * Setting for rendering Emf metafiles in source file. * @param value - The value to set. * * @remarks * EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. * Either type of record can be used to render the image, only EMF+ records, or only EMF records. * When is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed. * Default value is . * For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored. */ setEmfRenderSetting(value: EmfRenderSetting) : void; /** * @deprecated Please use the 'customRenderSettings' property instead. * Gets or sets custom settings during rendering. */ getCustomRenderSettings() : CustomRenderSettings; /** * Gets or sets custom settings during rendering. */ customRenderSettings : CustomRenderSettings; /** * @deprecated Please use the 'customRenderSettings' property instead. * Gets or sets custom settings during rendering. * @param value - The value to set. */ setCustomRenderSettings(value: CustomRenderSettings) : void; /** * Sets desired width and height of image. * @param desiredWidth - desired width in pixels * @param desiredHeight - desired height in pixels * @param keepAspectRatio - whether to keep aspect ratio of origin image * * @remarks * The width and height of the output image in pixels will be only based on * the set desired width and height. * The and * will not effect the width and height of the output image in this case. */ setDesiredSize(desiredWidth: number, desiredHeight: number, keepAspectRatio: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Control/Indicate progress of page saving process. */ export interface IPageSavingCallback { /** * Control/Indicate a page starts to be output. * @param args - Info for a page starts saving process. */ pageStartSaving(args: PageStartSavingArgs) : void; /** * Control/Indicate a page ends to be output. * @param args - Info for a page ends saving process. */ pageEndSaving(args: PageEndSavingArgs) : void; } /** * Info for a page ends saving process. */ export class PageEndSavingArgs extends PageSavingArgs { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PageSavingArgs); /** * @deprecated Please use the 'hasMorePages' property instead. * Gets or sets a value indicating whether having more pages to be output. * The default value is true. */ getHasMorePages() : boolean; /** * Gets or sets a value indicating whether having more pages to be output. * The default value is true. */ hasMorePages : boolean; /** * @deprecated Please use the 'hasMorePages' property instead. * Gets or sets a value indicating whether having more pages to be output. * The default value is true. * @param value - The value to set. */ setHasMorePages(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Info for a page saving process. */ export class PageSavingArgs { /** * @deprecated Please use the 'pageIndex' property instead. * Current page index, zero based. */ getPageIndex() : number; /** * Current page index, zero based. */ readonly pageIndex : number; /** * @deprecated Please use the 'pageCount' property instead. * Total page count. */ getPageCount() : number; /** * Total page count. */ readonly pageCount : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Info for a page starts saving process. */ export class PageStartSavingArgs extends PageSavingArgs { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PageSavingArgs); /** * Gets or sets a value indicating whether the page should be output. * The default value is true. */ isToOutput : boolean; /** * @deprecated Please use the 'isToOutput' property instead. * Gets or sets a value indicating whether the page should be output. * The default value is true. * @param value - The value to set. */ setIsToOutput(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Indicates which pages will not be printed. */ export enum PrintingPageType { /** * Prints all pages. */ Default = 0, /** * Don't print the pages which the cells are blank. */ IgnoreBlank = 1, /** * Don't print the pages which cells only contain styles. */ IgnoreStyle = 2, } /** * Enumerates displaying text type when the text width is larger than cell width. */ export enum TextCrossType { /** * Display text like in Microsoft Excel. */ Default = 1, /** * Display all the text by crossing other cells and keep text of crossed cells. */ CrossKeep = 2, /** * Display all the text by crossing other cells and override text of crossed cells. */ CrossOverride = 3, /** * Only display the text within the width of cell. */ StrictInCell = 4, } /** * Specifies what type of compression to apply when saving images into TIFF format file. */ export enum TiffCompression { /** * Specifies no compression. */ CompressionNone = 0, /** * Specifies the RLE compression scheme. */ CompressionRle = 1, /** * Specifies the LZW compression scheme. */ CompressionLZW = 2, /** * Specifies the CCITT3 compression scheme. */ CompressionCCITT3 = 3, /** * Specifies the CCITT4 compression scheme. */ CompressionCCITT4 = 4, } /** * Worksheet printing preview. */ export class SheetPrintingPreview { /** * The construct of SheetPrintingPreview * @param sheet - Indicate which spreadsheet to be printed. * @param options - ImageOrPrintOptions contains some property of output */ constructor(sheet: Worksheet, options: ImageOrPrintOptions); /** * @deprecated Please use the 'evaluatedPageCount' property instead. * Evaluate the total page count of this worksheet */ getEvaluatedPageCount() : number; /** * Evaluate the total page count of this worksheet */ readonly evaluatedPageCount : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a worksheet render which can render worksheet to various images such as (BMP, PNG, JPEG, TIFF..) * The constructor of this class , must be used after modification of pagesetup, cell style. */ export class SheetRender { /** * the construct of SheetRender, need worksheet and ImageOrPrintOptions as params * @param worksheet - Indicate which spreadsheet to be rendered. * @param options - ImageOrPrintOptions contains some property of output image */ constructor(worksheet: Worksheet, options: ImageOrPrintOptions); /** * @deprecated Please use the 'pageCount' property instead. * Gets the total page count of current worksheet. */ getPageCount() : number; /** * Gets the total page count of current worksheet. */ readonly pageCount : number; /** * @deprecated Please use the 'pageScale' property instead. * Gets calculated page scale of the sheet. * Returns the set scale if is set. Otherwise, returns the calculated scale according to and . */ getPageScale() : number; /** * Gets calculated page scale of the sheet. * Returns the set scale if is set. Otherwise, returns the calculated scale according to and . */ readonly pageScale : number; /** * Get page size in inch of output image. * @param pageIndex - The page index is based on zero. * @returns * Page size of image, [0] for width and [1] for height */ getPageSizeInch(pageIndex: number) : number[]; /** * Render certain page to a file. * @param pageIndex - indicate which page is to be converted * @param fileName - filename of the output image */ toImage(pageIndex: number, fileName: string) : void; /** * Render certain page to a stream. * @param pageIndex - indicate which page is to be converted * @returns * The result stream. */ toImage(pageIndex: number) : Uint8Array; /** * Render certain page to a file. * @param pageIndex - indicate which page is to be converted * @param fileName - filename of the output image */ toImageAsync(pageIndex: number, fileName: string) : Promise; /** * Render certain page to a stream. * @param pageIndex - indicate which page is to be converted * @returns * The result stream. */ toImageAsync(pageIndex: number) : Promise; /** * Render whole worksheet as Tiff Image to stream. * @returns * The result stream. */ toTiff() : Uint8Array; /** * Render whole worksheet as Tiff Image to a file. * @param filename - the filename of the output image */ toTiff(filename: string) : void; /** * Render whole worksheet as Tiff Image to stream. * @returns * The result stream. */ toTiffAsync() : Promise; /** * Render whole worksheet as Tiff Image to a file. * @param filename - the filename of the output image */ toTiffAsync(filename: string) : Promise; /** * Releases resources created and used for rendering. */ dispose() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Workbook printing preview. */ export class WorkbookPrintingPreview { /** * The construct of WorkbookPrintingPreview * @param workbook - Indicate which workbook to be printed. * @param options - ImageOrPrintOptions contains some property of output */ constructor(workbook: Workbook, options: ImageOrPrintOptions); /** * @deprecated Please use the 'evaluatedPageCount' property instead. * Evaluate the total page count of this workbook */ getEvaluatedPageCount() : number; /** * Evaluate the total page count of this workbook */ readonly evaluatedPageCount : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a Workbook render. * The constructor of this class , must be used after modification of pagesetup, cell style. * * @remarks */ export class WorkbookRender { /** * The construct of WorkbookRender * @param workbook - Indicate which workbook to be rendered. * @param options - ImageOrPrintOptions contains some property of output image */ constructor(workbook: Workbook, options: ImageOrPrintOptions); /** * @deprecated Please use the 'pageCount' property instead. * Gets the total page count of workbook. */ getPageCount() : number; /** * Gets the total page count of workbook. */ readonly pageCount : number; /** * Get page size in inch of output image. * @param pageIndex - The page index is based on zero. * @returns * Page size of image, [0] for width and [1] for height */ getPageSizeInch(pageIndex: number) : number[]; /** * Render whole workbook as Tiff Image to stream. * @returns * The result stream. */ toImage() : Uint8Array; /** * Render whole workbook as Tiff Image to a file. * @param filename - the filename of the output image */ toImage(filename: string) : void; /** * Render certain page to a file. * @param pageIndex - indicate which page is to be converted * @param fileName - filename of the output image */ toImage(pageIndex: number, fileName: string) : void; /** * Render certain page to a stream. * @param pageIndex - indicate which page is to be converted * @returns * The result stream. */ toImage(pageIndex: number) : Uint8Array; /** * Releases resources created and used for rendering. */ dispose() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options of inserting. */ export class InsertOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'copyFormatType' property instead. */ getCopyFormatType() : CopyFormatType; /** */ copyFormatType : CopyFormatType; /** * @deprecated Please use the 'copyFormatType' property instead. * @param value - The value to set. */ setCopyFormatType(value: CopyFormatType) : void; /** * @deprecated Please use the 'updateReference' property instead. * Indicates if references in other worksheets will be updated. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ getUpdateReference() : boolean; /** * Indicates if references in other worksheets will be updated. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ updateReference : boolean; /** * @deprecated Please use the 'updateReference' property instead. * Indicates if references in other worksheets will be updated. * @param value - The value to set. * * @remarks * Starting from 26.7 we set the default value of this property to true. */ setUpdateReference(value: boolean) : void; /** * @deprecated Please use the 'formulaChangeMonitor' property instead. * Gets/sets the monitor for tracking changes caused by the insertion. */ getFormulaChangeMonitor() : AbstractFormulaChangeMonitor; /** * Gets/sets the monitor for tracking changes caused by the insertion. */ formulaChangeMonitor : AbstractFormulaChangeMonitor; /** * @deprecated Please use the 'formulaChangeMonitor' property instead. * Gets/sets the monitor for tracking changes caused by the insertion. * @param value - The value to set. */ setFormulaChangeMonitor(value: AbstractFormulaChangeMonitor) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents fill formatting for a shape. */ export class MsoFillFormatHelper { /** * @deprecated Please use the 'foreColor' property instead. * Gets and sets the fill fore color. */ getForeColor() : Color; /** * Gets and sets the fill fore color. */ foreColor : Color; /** * @deprecated Please use the 'foreColor' property instead. * Gets and sets the fill fore color. * @param value - The value to set. */ setForeColor(value: Color) : void; /** * @deprecated Please use the 'foreColorTransparency' property instead. * Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). */ getForeColorTransparency() : number; /** * Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). */ foreColorTransparency : number; /** * @deprecated Please use the 'foreColorTransparency' property instead. * Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setForeColorTransparency(value: number) : void; /** * @deprecated Please use the 'backColor' property instead. * Gets and sets the file back color. */ getBackColor() : Color; /** * Gets and sets the file back color. */ backColor : Color; /** * @deprecated Please use the 'backColor' property instead. * Gets and sets the file back color. * @param value - The value to set. */ setBackColor(value: Color) : void; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets the Texture and Picture fill data. */ getImageData() : Uint8Array; /** * Gets and sets the Texture and Picture fill data. */ imageData : Uint8Array; /** * @deprecated Please use the 'imageData' property instead. * Gets and sets the Texture and Picture fill data. * @param value - The value to set. */ setImageData(value: Uint8Array) : void; /** * @deprecated Please use the 'texture' property instead. * Gets the texture fill type. */ getTexture() : TextureType; /** * Gets the texture fill type. */ readonly texture : TextureType; /** * Indicates whether there is fill. */ isVisible : boolean; /** * @deprecated Please use the 'isVisible' property instead. * Indicates whether there is fill. * @param value - The value to set. */ setIsVisible(value: boolean) : void; /** * Sets the specified fill to a one-color gradient. * @param color - One gradient color. * @param degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light). * @param style - Gradient shading style. * @param variant - The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. */ setOneColorGradient(color: Color, degree: number, style: GradientStyleType, variant: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all parameters' type or return value type of function. */ export enum ParameterType { /** */ Reference = 0, /** */ Value = 1, /** */ Array = 2, } /** * Represents the options of importing data into cells. */ export class ImportTableOptions { /** * Creates the default importing options. */ constructor(); /** * @deprecated Please use the 'convertGridStyle' property instead. * Indicates whether apply the style of the grid view to cells. */ getConvertGridStyle() : boolean; /** * Indicates whether apply the style of the grid view to cells. */ convertGridStyle : boolean; /** * @deprecated Please use the 'convertGridStyle' property instead. * Indicates whether apply the style of the grid view to cells. * @param value - The value to set. */ setConvertGridStyle(value: boolean) : void; /** * @deprecated Please use the 'convertNumericData' property instead. * Gets or sets a value that indicates whether the string value should be converted to numeric or date value. */ getConvertNumericData() : boolean; /** * Gets or sets a value that indicates whether the string value should be converted to numeric or date value. */ convertNumericData : boolean; /** * @deprecated Please use the 'convertNumericData' property instead. * Gets or sets a value that indicates whether the string value should be converted to numeric or date value. * @param value - The value to set. */ setConvertNumericData(value: boolean) : void; /** * @deprecated Please use the 'insertRows' property instead. * Indicates whether new rows should be added for importing data records. */ getInsertRows() : boolean; /** * Indicates whether new rows should be added for importing data records. */ insertRows : boolean; /** * @deprecated Please use the 'insertRows' property instead. * Indicates whether new rows should be added for importing data records. * @param value - The value to set. */ setInsertRows(value: boolean) : void; /** * @deprecated Please use the 'shiftFirstRowDown' property instead. * Indicates whether shifting the first row down when inserting rows. */ getShiftFirstRowDown() : boolean; /** * Indicates whether shifting the first row down when inserting rows. */ shiftFirstRowDown : boolean; /** * @deprecated Please use the 'shiftFirstRowDown' property instead. * Indicates whether shifting the first row down when inserting rows. * @param value - The value to set. */ setShiftFirstRowDown(value: boolean) : void; /** * Indicates whether field name should be imported. */ isFieldNameShown : boolean; /** * @deprecated Please use the 'isFieldNameShown' property instead. * Indicates whether field name should be imported. * @param value - The value to set. */ setIsFieldNameShown(value: boolean) : void; /** * @deprecated Please use the 'exportCaptionAsFieldName' property instead. * Indicates whether exporting caption as field name * * @remarks * Only works for DataTable. */ getExportCaptionAsFieldName() : boolean; /** * Indicates whether exporting caption as field name * * @remarks * Only works for DataTable. */ exportCaptionAsFieldName : boolean; /** * @deprecated Please use the 'exportCaptionAsFieldName' property instead. * Indicates whether exporting caption as field name * @param value - The value to set. * * @remarks * Only works for DataTable. */ setExportCaptionAsFieldName(value: boolean) : void; /** * @deprecated Please use the 'dateFormat' property instead. * Gets or sets date format string for cells with imported datetime values. */ getDateFormat() : string; /** * Gets or sets date format string for cells with imported datetime values. */ dateFormat : string; /** * @deprecated Please use the 'dateFormat' property instead. * Gets or sets date format string for cells with imported datetime values. * @param value - The value to set. */ setDateFormat(value: string) : void; /** * @deprecated Please use the 'numberFormats' property instead. * Gets or sets the number formats */ getNumberFormats() : string[]; /** * Gets or sets the number formats */ numberFormats : string[]; /** * @deprecated Please use the 'numberFormats' property instead. * Gets or sets the number formats * @param value - The value to set. */ setNumberFormats(value: string[]) : void; /** * @deprecated Please use the 'styles' property instead. * Gets and sets the styles for each column of the table. */ getStyles() : Style[]; /** * Gets and sets the styles for each column of the table. */ styles : Style[]; /** * @deprecated Please use the 'styles' property instead. * Gets and sets the styles for each column of the table. * @param value - The value to set. */ setStyles(value: Style[]) : void; /** * @deprecated Please use the 'isFormulas' property instead. * Indicates whether the data are formulas. */ getIsFormulas() : boolean[]; /** * Indicates whether the data are formulas. */ isFormulas : boolean[]; /** * @deprecated Please use the 'isFormulas' property instead. * Indicates whether the data are formulas. * @param value - The value to set. */ setIsFormulas(value: boolean[]) : void; /** * @deprecated Please use the 'totalRows' property instead. * Gets or sets total row count to import from data source. -1 means all rows of given data source. */ getTotalRows() : number; /** * Gets or sets total row count to import from data source. -1 means all rows of given data source. */ totalRows : number; /** * @deprecated Please use the 'totalRows' property instead. * Gets or sets total row count to import from data source. -1 means all rows of given data source. * @param value - The value to set. */ setTotalRows(value: number) : void; /** * @deprecated Please use the 'totalColumns' property instead. * Gets or sets total column count to import from data source. -1 means all rows of given data source. */ getTotalColumns() : number; /** * Gets or sets total column count to import from data source. -1 means all rows of given data source. */ totalColumns : number; /** * @deprecated Please use the 'totalColumns' property instead. * Gets or sets total column count to import from data source. -1 means all rows of given data source. * @param value - The value to set. */ setTotalColumns(value: number) : void; /** * @deprecated Please use the 'columnIndexes' property instead. * Gets or sets the columns(0-based) to import from data source. null means all columns should be imported. */ getColumnIndexes() : number[]; /** * Gets or sets the columns(0-based) to import from data source. null means all columns should be imported. */ columnIndexes : number[]; /** * @deprecated Please use the 'columnIndexes' property instead. * Gets or sets the columns(0-based) to import from data source. null means all columns should be imported. * @param value - The value to set. */ setColumnIndexes(value: number[]) : void; /** * @deprecated Please use the 'defaultValues' property instead. * Default value for the value in the table is null. */ getDefaultValues() : Object[]; /** * Default value for the value in the table is null. */ defaultValues : Object[]; /** * @deprecated Please use the 'defaultValues' property instead. * Default value for the value in the table is null. * @param value - The value to set. */ setDefaultValues(value: Object[]) : void; /** * Indicates whether the value contains html tags. */ isHtmlString : boolean; /** * @deprecated Please use the 'isHtmlString' property instead. * Indicates whether the value contains html tags. * @param value - The value to set. */ setIsHtmlString(value: boolean) : void; /** * @deprecated Please use the 'checkMergedCells' property instead. * Indicates whether checking merged cells. */ getCheckMergedCells() : boolean; /** * Indicates whether checking merged cells. */ checkMergedCells : boolean; /** * @deprecated Please use the 'checkMergedCells' property instead. * Indicates whether checking merged cells. * @param value - The value to set. */ setCheckMergedCells(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents error bar display type. */ export enum ErrorBarDisplayType { /** * Both */ Both = 0, /** * Minus */ Minus = 1, /** * None */ None = 2, /** * Plus */ Plus = 3, } /** * Fill format set type. */ export enum FormatSetType { /** * No Fill format. */ None = 0, /** * Gradient fill format. */ IsGradientSet = 1, /** * Texture fill format. */ IsTextureSet = 2, /** * Pattern fill format. */ IsPatternSet = 3, } /** * Represents the gradient stop collection. */ export class GradientStopCollection implements Iterable { /** * Gets the gradient stop by the index. * @param index - The index. * @returns * The gradient stop. */ get(index: number) : GradientStop; /** * Add a gradient stop. * @param position - The position of the stop,in unit of percentage. * @param color - The color of the stop. * @param alpha - The alpha of the color. */ add(position: number, color: CellsColor, alpha: number) : void; /** * Add a gradient stop. * @param position - The position of the stop,in unit of percentage. * @param color - The color of the stop. * @param alpha - The alpha of the color. */ add(position: number, color: Color, alpha: number) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents data label position type. */ export enum LabelPositionType { /** * Applies only to bar, 2D/3D pie charts */ Center = 0, /** * Applies only to bar, 2D/3D pie charts */ InsideBase = 1, /** * Applies only to bar charts */ InsideEnd = 2, /** * Applies only to bar, 2d/3d pie charts */ OutsideEnd = 3, /** * Applies only to line charts */ Above = 4, /** * Applies only to line charts */ Below = 5, /** * Applies only to line charts */ Left = 6, /** * Applies only to line charts */ Right = 7, /** * Applies only to 2D/3D pie charts */ BestFit = 8, /** * User moved the data labels. * This is only for reading the chart from the template file. */ Moved = 9, } /** * Represents mirror type of texture fill */ export enum MirrorType { /** * None */ None = 0, /** * Horizonal */ Horizonal = 1, /** * Vertical */ Vertical = 2, /** * Both */ Both = 3, } /** * Represents picture format option */ export class PicFormatOption { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'type' property instead. * Gets or sets the picture fill type. */ getType() : FillPictureType; /** * Gets or sets the picture fill type. */ type : FillPictureType; /** * @deprecated Please use the 'type' property instead. * Gets or sets the picture fill type. * @param value - The value to set. */ setType(value: FillPictureType) : void; /** * @deprecated Please use the 'scale' property instead. * Gets or sets how many the picture stack and scale with. */ getScale() : number; /** * Gets or sets how many the picture stack and scale with. */ scale : number; /** * @deprecated Please use the 'scale' property instead. * Gets or sets how many the picture stack and scale with. * @param value - The value to set. */ setScale(value: number) : void; /** * @deprecated Please use the 'left' property instead. * Gets or sets the left offset for stretching picture. */ getLeft() : number; /** * Gets or sets the left offset for stretching picture. */ left : number; /** * @deprecated Please use the 'left' property instead. * Gets or sets the left offset for stretching picture. * @param value - The value to set. */ setLeft(value: number) : void; /** * @deprecated Please use the 'top' property instead. * Gets or sets the top offset for stretching picture. */ getTop() : number; /** * Gets or sets the top offset for stretching picture. */ top : number; /** * @deprecated Please use the 'top' property instead. * Gets or sets the top offset for stretching picture. * @param value - The value to set. */ setTop(value: number) : void; /** * @deprecated Please use the 'bottom' property instead. * Gets or sets the bottom offset for stretching picture. */ getBottom() : number; /** * Gets or sets the bottom offset for stretching picture. */ bottom : number; /** * @deprecated Please use the 'bottom' property instead. * Gets or sets the bottom offset for stretching picture. * @param value - The value to set. */ setBottom(value: number) : void; /** * @deprecated Please use the 'right' property instead. * Gets or sets the right offset for stretching picture. */ getRight() : number; /** * Gets or sets the right offset for stretching picture. */ right : number; /** * @deprecated Please use the 'right' property instead. * Gets or sets the right offset for stretching picture. * @param value - The value to set. */ setRight(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents tile picture as texture. */ export class TilePicOption { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'offsetX' property instead. * Gets or sets the X offset for tiling picture. */ getOffsetX() : number; /** * Gets or sets the X offset for tiling picture. */ offsetX : number; /** * @deprecated Please use the 'offsetX' property instead. * Gets or sets the X offset for tiling picture. * @param value - The value to set. */ setOffsetX(value: number) : void; /** * @deprecated Please use the 'offsetY' property instead. * Gets or sets the Y offset for tiling picture. */ getOffsetY() : number; /** * Gets or sets the Y offset for tiling picture. */ offsetY : number; /** * @deprecated Please use the 'offsetY' property instead. * Gets or sets the Y offset for tiling picture. * @param value - The value to set. */ setOffsetY(value: number) : void; /** * @deprecated Please use the 'scaleX' property instead. * Gets or sets the X scale for tiling picture. */ getScaleX() : number; /** * Gets or sets the X scale for tiling picture. */ scaleX : number; /** * @deprecated Please use the 'scaleX' property instead. * Gets or sets the X scale for tiling picture. * @param value - The value to set. */ setScaleX(value: number) : void; /** * @deprecated Please use the 'scaleY' property instead. * Gets or sets the Y scale for tiling picture. */ getScaleY() : number; /** * Gets or sets the Y scale for tiling picture. */ scaleY : number; /** * @deprecated Please use the 'scaleY' property instead. * Gets or sets the Y scale for tiling picture. * @param value - The value to set. */ setScaleY(value: number) : void; /** * @deprecated Please use the 'mirrorType' property instead. * Gets or sets the mirror type for tiling. */ getMirrorType() : MirrorType; /** * Gets or sets the mirror type for tiling. */ mirrorType : MirrorType; /** * @deprecated Please use the 'mirrorType' property instead. * Gets or sets the mirror type for tiling. * @param value - The value to set. */ setMirrorType(value: MirrorType) : void; /** * @deprecated Please use the 'alignmentType' property instead. * Gets or sets the alignment for tiling. */ getAlignmentType() : RectangleAlignmentType; /** * Gets or sets the alignment for tiling. */ alignmentType : RectangleAlignmentType; /** * @deprecated Please use the 'alignmentType' property instead. * Gets or sets the alignment for tiling. * @param value - The value to set. */ setAlignmentType(value: RectangleAlignmentType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a creation path consisting of a series of moves, lines and curves that when combined will form a geometric shape. */ export class ShapePath { /** * Initializes a new instance of the class. */ constructor(); /** * @deprecated Please use the 'pathSegementList' property instead. * Gets list */ getPathSegementList() : ShapeSegmentPathCollection; /** * Gets list */ readonly pathSegementList : ShapeSegmentPathCollection; /** * @deprecated Please use the 'widthPixel' property instead. * Gets the width of this path in unit of pixels. */ getWidthPixel() : number; /** * Gets the width of this path in unit of pixels. */ widthPixel : number; /** * @deprecated Please use the 'widthPixel' property instead. * Gets the width of this path in unit of pixels. * @param value - The value to set. */ setWidthPixel(value: number) : void; /** * @deprecated Please use the 'heightPixel' property instead. * Gets the height of this path in unit of pixels. */ getHeightPixel() : number; /** * Gets the height of this path in unit of pixels. */ heightPixel : number; /** * @deprecated Please use the 'heightPixel' property instead. * Gets the height of this path in unit of pixels. * @param value - The value to set. */ setHeightPixel(value: number) : void; /** * Starts a new figure from the specified point without closing the current figure. All subsequent points added to the path are added to this new figure.Unit: Pixel. * @param x - The x-coordinate of the starting point of the figure(Unit: Pixel). * @param y - The y-coordinate of the starting point of the figure(Unit: Pixel). */ moveTo(x: number, y: number) : void; /** * Appends a line segment to the current figure. * The starting point is the end point of the current figure.Unit: Pixel. * @param x - The x-coordinate of the endpoint of the line segment(Unit: Pixel). * @param y - The y-coordinate of the endpoint of the line segment(Unit: Pixel). */ lineTo(x: number, y: number) : void; /** * Appends a cubic Bézier curve to the current figure. The starting point is the end point of the current figure.Unit: Pixel. * @param ctrX1 - The x-coordinate of the first control point for the curve(Unit: Pixel). * @param ctrY1 - The y-coordinate of the first control point for the curve(Unit: Pixel). * @param ctrX2 - The x-coordinate of the second control point for the curve(Unit: Pixel). * @param ctrY2 - The y-coordinate of the second control point for the curve(Unit: Pixel). * @param endX - The x-coordinate of the endpoint of the curve(Unit: Pixel). * @param endY - The y-coordinate of the endpoint of the curve(Unit: Pixel). */ cubicBezierTo(ctrX1: number, ctrY1: number, ctrX2: number, ctrY2: number, endX: number, endY: number) : void; /** * Appends an elliptical arc to the current figure. The starting point is the end point of the current figure. * @param wR - The half-width of the rectangular area of ​​the ellipse that draws the arc(Unit: Pixel). * @param hR - The half-height of the rectangular area of ​​the ellipse that draws the arc(Unit: Pixel). * @param stAng - The starting angle of the arc, measured in degrees clockwise from the x-axis(Unit: Degree). This angle will specify what angle along the supposed circle path will be used as the start position for drawing the arc. This start angle will be locked to the last known pen position in the shape path. Thus guaranteeing a continuos shape path. * @param swAng - The swing angle for an arc. This angle will specify how far angle-wise along the supposed cicle path the arc will be extended. The extension from the start angle will always be in the clockwise direction around the supposed circle.(Unit: Degree) */ arcTo(wR: number, hR: number, stAng: number, swAng: number) : void; /** * Closes the current figure and starts a new figure. If the current figure contains a sequence of connected lines and curves, the method closes the loop by connecting a line from the endpoint to the starting point. */ close() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents path collection information in NotPrimitive autoshape */ export class ShapePathCollection implements Iterable { /** * Gets a creation path. * @param index - The index. * @returns * Returns object. */ get(index: number) : ShapePath; /** * @deprecated Please use the 'count' property instead. * Gets the count of paths */ getCount() : number; /** * Gets the count of paths */ readonly count : number; /** * Add a creation path. * @returns * Returns object. */ add() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a segment path in a path of the freeform. */ export class ShapeSegmentPath { /** * @deprecated Please use the 'type' property instead. * Gets the path segment type */ getType() : ShapePathType; /** * Gets the path segment type */ readonly type : ShapePathType; /** * @deprecated Please use the 'points' property instead. * Gets the points in path segment */ getPoints() : ShapePathPointCollection; /** * Gets the points in path segment */ readonly points : ShapePathPointCollection; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents path segment type. */ export enum ShapePathType { /** * Straight line segment */ LineTo = 1, /** * Cubic Bezier curve */ CubicBezierCurveTo = 3, /** * Start a new path */ MoveTo = 0, /** * If the starting POINT and the end POINT are not the same, a single * straight line is drawn to connect the starting POINT and ending POINT of the path. */ Close = 128, /** * The end of the current path */ End = 4, /** * Escape */ Escape = 5, /** * An arc */ ArcTo = 6, /** * Unknown */ Unknown = 7, } /** * Represents all error check option. */ export class ErrorCheckOptionCollection implements Iterable { /** * Gets object by the given index. * @param index - The index * @returns * Return object */ get(index: number) : ErrorCheckOption; /** * Add an error check option. */ add() : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Error check setting applied on certain ranges. */ export class ErrorCheckOption { /** * Checks whether given error type will be checked. * @param errorCheckType - error type can be checked * @returns * return true if given error type will be checked(green triangle will be shown for cell if the check failed). */ isErrorCheck(errorCheckType: ErrorCheckType) : boolean; /** * Sets whether given error type will be checked. * @param errorCheckType - error type can be checked. * @param isCheck - true if given error type needs to be checked(green triangle will be shown for cell if the check failed). */ setErrorCheck(errorCheckType: ErrorCheckType, isCheck: boolean) : void; /** * Gets the count of ranges that influenced by this setting. * @returns * the count of ranges that influenced by this setting. */ getCountOfRange() : number; /** * Adds one influenced range by this setting. * @param ca - the range to be added. * @returns * the index of the added range in the range list of this setting. */ addRange(ca: CellArea) : number; /** * Gets the influenced range of this setting by given index. * @param index - the index of range * @returns * return influenced range at given index. */ getRange(index: number) : CellArea; /** * Removes one range by given index. * @param index - the index of the range to be removed. */ removeRange(index: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all error check type. */ export enum ErrorCheckType { /** * Ignore errors when cells contain formulas that result in an error. */ EvaluationError = 1, Calc = 1, /** * Ignore errors when formulas refer to empty cells. */ EmptyCellRef = 2, /** * Ignore errors when numbers are formatted as text or are preceded by an apostrophe */ NumberStoredAsText = 4, /** * Ignore errors when numbers are formatted as text or are preceded by an apostrophe * * @remarks * NOTE: This member is now obsolete. Instead, * please use ErrorCheckType.NumberStoredAsText enum. * This method will be removed 12 months later since October 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ErrorCheckType.NumberStoredAsText instead. */ TextNumber = 4, /** * Ignore errors when formulas omit certain cells in a region. */ InconsistRange = 8, /** * Ignore errors when a formula in a region of your worksheet differs from other formulas in the same region. */ InconsistFormula = 16, /** * Ignore errors when formulas contain text formatted cells with years represented as 2 digits. */ TwoDigitTextYear = 32, /** * Ignore errors when formulas contain text formatted cells with years represented as 2 digits. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ErrorCheckType.TwoDigitTextYear enum. * This method will be removed 12 months later since October 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ErrorCheckType.TwoDigitTextYear instead. */ TextDate = 32, /** * Ignore errors when unlocked cells contain formulas. */ UnlockedFormula = 64, /** * Ignore errors when unlocked cells contain formulas. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ErrorCheckType.UnproctedFormula enum. * This method will be removed 12 months later since October 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ErrorCheckType.UnproctedFormula instead. */ UnproctedFormula = 64, /** * Ignore errors when a cell's value in a Table does not comply with the Data Validation rules specified. */ TableDataValidation = 128, /** * Ignore errors when a cell's value in a Table does not comply with the Data Validation rules specified. * * @remarks * NOTE: This member is now obsolete. Instead, * please use ErrorCheckType.TableDataValidation enum. * This method will be removed 12 months later since October 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use ErrorCheckType.TableDataValidation instead. */ Validation = 128, /** * Ignore errors when cells contain a value different from a calculated column formula. */ CalculatedColumn = 129, } /** * Represents all operator about the interrupt. */ export class InterruptMonitor { /** * Default Constructor. */ constructor(); /** * Mark the monitor as requesting interruption */ isInterruptionRequested() : boolean; /** * Interrupt the current operator. */ interrupt() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents Data provider for saving large spreadsheet files in light weight mode. * * @remarks * When saving a workbook by this mode, will be checked when saving every worksheet in the workbook. * For one sheet, if gives true, then all data and properties to be saved for rows/cells of this sheet * will be provided by the implementation of this interface. * In the first place, will be called to get the next row index to be saved. * If a valid row index is returned(the row index must be in ascending order for the rows to be saved), * then a Row object representing this row will be provided by for the implementation to set its properties. * For one row, will be checked firstly. * If a valid column index be returned(the column index must be in ascending order for all cells of current row), * then a Cell object representing this cell will be provided by for implementation to set its data and properties. * After the cell will be saved directly to the resultant spreadsheet file. * Then the next cell will be checked and processed. *

* Please note, user should only update values and properties for current Row/Cell object provided by corresponding method. * Because the cells data is written to the resultant file in streaming manner, most of other objects may have been written * to the resultant file, or have been gathered and written some global data for them. So when user updating other objects * while saving cells data, those operations may be not able to affect the saved data. Or even worse, those operations may * cause inconsistent data be save to the resultant file and finally make the file corrupted. * So, for all other objects such as shapes, column width and styles, conditional formattings, ...etc., * please do not operate them in any methods of this implementation. * Instead, please manage them and adjust them to the final state before calling "Save" method of the Workbook. */ export interface LightCellsDataProvider { /** * Starts to save a worksheet. * @param sheetIndex - index of current sheet to be saved. * @returns * true if this provider will provide data for the given sheet; false if given sheet should use its normal data model(Cells). * * @remarks * It will be called at the beginning of saving a worksheet during saving a workbook. * If the provider needs to refer to sheetIndex later * in startRow(Row) or startCell(Cell) method, * that is, if the process needs to know which worksheet is being processed, * the implementation should retain the sheetIndex value here. */ startSheet(sheetIndex: number) : boolean; /** * Gets the next row to be saved. * @returns * the next row index to be saved. -1 means the end of current sheet data has been reached and no further row of current sheet to be saved. * * @remarks * It will be called at the beginning of saving a row and its cells data(before ). */ nextRow() : number; /** * Starts to save data of one row. * @param row - Row object for implementation to fill data. Its row index is the returned value of latest call of . /// If the row has been initialized in the inner cells model, the existing row object will be used. /// Otherwise a temporary Row object will be used for implementation to fill data. * * @remarks * It will be called at the beginning of saving a row and its cells data. * If current row has some custom properties such as height, style, ...etc., * implementation should set those properties to given Row object here. */ startRow(row: Row) : void; /** * Gets next cell to be saved. * @returns * column index of the next cell to be saved. -1 means the end of current row data has been reached and no further cell of current row to be saved. * * @remarks * It will be called at the beginning of saving one cell. */ nextCell() : number; /** * Starts to save data of one cell. * @param cell - Cell object for implementation to fill data. Its column index is the returned value of latest call of . /// If the cell has been initialized in the inner cells model, the existed cell object will be used. /// Otherwise a temporary Cell object will be used for implementation to fill data. * * @remarks */ startCell(cell: Cell) : void; /** * Checks whether the current string value of cell needs to be gathered into a global pool. * @returns * true if string value need to be gathered into a global pool for the resultant file. * * @remarks * Gathering string values will take advantage only when there are many duplicated string values for the cells provided by this implementation. * In this situation gathering string will save much memory and generate smaller resultant file. * If there are many string values for the cells provided by LightCellsDataProvider but few of them are same, * gathering string will cost more memory and time and has no advantage for the resultant file. */ isGatherString() : boolean; } /** * Represents the load file format. */ export enum LoadFormat { /** * Represents recognizing the format automatically. */ Auto = 0, /** * Comma-Separated Values(CSV) text file. */ Csv = 1, /** * Comma-Separated Values(CSV) text file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use LoadFormat.Csv instead. */ CSV = 1, /** * Represents Office Open XML spreadsheetML workbook or template, with or without macros. */ Xlsx = 6, /** * Tab-Separated Values(TSV) text file. */ Tsv = 11, /** * Tab-Separated Values(TSV) text file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use LoadFormat.Tsv instead. */ TSV = 11, /** * Represents a tab delimited text file, same with . */ TabDelimited = 11, /** * Represents a html file. */ Html = 12, /** * Represents a mhtml file. */ MHtml = 13, /** * Open Document Sheet(ODS) file. */ Ods = 14, /** * Open Document Sheet(ODS) file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use LoadFormat.Ods instead. */ ODS = 14, /** * Represents an Excel97-2003 xls file. */ Excel97To2003 = 5, /** * Represents an Excel 2003 xml file. */ SpreadsheetML = 15, /** * Represents an xlsb file. */ Xlsb = 16, /** * Open Document Template Sheet(OTS) file. */ Ots = 31, /** * Represents a numbers file. */ Numbers = 56, /** * Represents OpenDocument Flat XML Spreadsheet (.fods) file format. */ Fods = 59, /** * Represents OpenDocument Flat XML Spreadsheet (.fods) file format. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use LoadFormat.Fods instead. */ FODS = 59, /** * Represents StarOffice Calc Spreadsheet (.sxc) file format. */ Sxc = 60, /** * Represents StarOffice Calc Spreadsheet (.sxc) file format. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use LoadFormat.Sxc instead. */ SXC = 60, /** * Represents a simple xml file. */ Xml = 51, /** * Reprents an EPUB file. */ Epub = 52, /** * Represents an AZW3 file. */ Azw3 = 53, /** * Represents a CHM file. */ Chm = 54, /** * Represents a Markdown file. */ Markdown = 55, /** * Represents unrecognized format, cannot be loaded. */ Unknown = 255, /** * Image */ Image = 254, /** * Json */ Json = 513, /** * Data Interchange Format. */ Dif = 30, /** * Xbase Data file */ Dbf = 515, } /** * Represents the options of loading the file. */ export class LoadOptions { /** * Creates an options of loading the file. */ constructor(); /** * Creates an options of loading the file. * @param loadFormat - The loading format. */ constructor(loadFormat: LoadFormat); /** * @deprecated Please use the 'loadFormat' property instead. * Gets the load format. */ getLoadFormat() : LoadFormat; /** * Gets the load format. */ readonly loadFormat : LoadFormat; /** * @deprecated Please use the 'password' property instead. * Gets and set the password of the workbook. */ getPassword() : string; /** * Gets and set the password of the workbook. */ password : string; /** * @deprecated Please use the 'password' property instead. * Gets and set the password of the workbook. * @param value - The value to set. */ setPassword(value: string) : void; /** * @deprecated Please use the 'parsingFormulaOnOpen' property instead. * Indicates whether parsing the formula when reading the file. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file * because the formulas in the files are stored with a string formula. */ getParsingFormulaOnOpen() : boolean; /** * Indicates whether parsing the formula when reading the file. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file * because the formulas in the files are stored with a string formula. */ parsingFormulaOnOpen : boolean; /** * @deprecated Please use the 'parsingFormulaOnOpen' property instead. * Indicates whether parsing the formula when reading the file. * @param value - The value to set. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file * because the formulas in the files are stored with a string formula. */ setParsingFormulaOnOpen(value: boolean) : void; /** * @deprecated Please use the 'parsingPivotCachedRecords' property instead. * Indicates whether parsing pivot cached records when loading the file. * The default value is false. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file */ getParsingPivotCachedRecords() : boolean; /** * Indicates whether parsing pivot cached records when loading the file. * The default value is false. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file */ parsingPivotCachedRecords : boolean; /** * @deprecated Please use the 'parsingPivotCachedRecords' property instead. * Indicates whether parsing pivot cached records when loading the file. * The default value is false. * @param value - The value to set. * * @remarks * Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file */ setParsingPivotCachedRecords(value: boolean) : void; /** * @deprecated Please use the 'languageCode' property instead. * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. */ getLanguageCode() : CountryCode; /** * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. */ languageCode : CountryCode; /** * @deprecated Please use the 'languageCode' property instead. * Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. * @param value - The value to set. */ setLanguageCode(value: CountryCode) : void; /** * @deprecated Please use the 'region' property instead. * Gets or sets the regional settings used for the Workbook that will be loaded. * * @remarks * The regional settings may be used for initializing some features for the workbook * such as fonts, themes, and so on. * For text based file formats, such as CSV, HTML, ..., the regional setting * also will be used to detect number formats and parse text values to numeric * or datetime values for cells. * This setting will be kept for the instantiated workbook later, that is, * of the workbook will use the same region * with this property. */ getRegion() : CountryCode; /** * Gets or sets the regional settings used for the Workbook that will be loaded. * * @remarks * The regional settings may be used for initializing some features for the workbook * such as fonts, themes, and so on. * For text based file formats, such as CSV, HTML, ..., the regional setting * also will be used to detect number formats and parse text values to numeric * or datetime values for cells. * This setting will be kept for the instantiated workbook later, that is, * of the workbook will use the same region * with this property. */ region : CountryCode; /** * @deprecated Please use the 'region' property instead. * Gets or sets the regional settings used for the Workbook that will be loaded. * @param value - The value to set. * * @remarks * The regional settings may be used for initializing some features for the workbook * such as fonts, themes, and so on. * For text based file formats, such as CSV, HTML, ..., the regional setting * also will be used to detect number formats and parse text values to numeric * or datetime values for cells. * This setting will be kept for the instantiated workbook later, that is, * of the workbook will use the same region * with this property. */ setRegion(value: CountryCode) : void; /** * @deprecated Please use the 'defaultStyleSettings' property instead. * Gets the default style settings for initializing styles of the workbook */ getDefaultStyleSettings() : DefaultStyleSettings; /** * Gets the default style settings for initializing styles of the workbook */ readonly defaultStyleSettings : DefaultStyleSettings; /** * @deprecated Please use the 'interruptMonitor' property instead. * Gets and sets the interrupt monitor. */ getInterruptMonitor() : AbstractInterruptMonitor; /** * Gets and sets the interrupt monitor. */ interruptMonitor : AbstractInterruptMonitor; /** * @deprecated Please use the 'interruptMonitor' property instead. * Gets and sets the interrupt monitor. * @param value - The value to set. */ setInterruptMonitor(value: AbstractInterruptMonitor) : void; /** * @deprecated Please use the 'ignoreNotPrinted' property instead. * Ignore the data which are not printed if directly printing the file * * @remarks * Only for xlsx file. */ getIgnoreNotPrinted() : boolean; /** * Ignore the data which are not printed if directly printing the file * * @remarks * Only for xlsx file. */ ignoreNotPrinted : boolean; /** * @deprecated Please use the 'ignoreNotPrinted' property instead. * Ignore the data which are not printed if directly printing the file * @param value - The value to set. * * @remarks * Only for xlsx file. */ setIgnoreNotPrinted(value: boolean) : void; /** * @deprecated Please use the 'checkDataValid' property instead. * Check whether data is valid in the template file. */ getCheckDataValid() : boolean; /** * Check whether data is valid in the template file. */ checkDataValid : boolean; /** * @deprecated Please use the 'checkDataValid' property instead. * Check whether data is valid in the template file. * @param value - The value to set. */ setCheckDataValid(value: boolean) : void; /** * @deprecated Please use the 'checkExcelRestriction' property instead. * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. */ getCheckExcelRestriction() : boolean; /** * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. */ checkExcelRestriction : boolean; /** * @deprecated Please use the 'checkExcelRestriction' property instead. * Whether check restriction of excel file when user modify cells related objects. * For example, excel does not allow inputting string value longer than 32K. * When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. * If this property is false, we will accept your input string value as the cell's value so that later * you can output the complete string value for other file formats such as CSV. * However, if you have set such kind of value that is invalid for excel file format, * you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file. * @param value - The value to set. */ setCheckExcelRestriction(value: boolean) : void; /** * @deprecated Please use the 'keepUnparsedData' property instead. * Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. * * @remarks * For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, * set this property as false may improve performance, especially when using it together with some kind of LoadFilter, */ getKeepUnparsedData() : boolean; /** * Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. * * @remarks * For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, * set this property as false may improve performance, especially when using it together with some kind of LoadFilter, */ keepUnparsedData : boolean; /** * @deprecated Please use the 'keepUnparsedData' property instead. * Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. * @param value - The value to set. * * @remarks * For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, * set this property as false may improve performance, especially when using it together with some kind of LoadFilter, */ setKeepUnparsedData(value: boolean) : void; /** * @deprecated Please use the 'loadFilter' property instead. * The filter to denote how to load data. */ getLoadFilter() : LoadFilter; /** * The filter to denote how to load data. */ loadFilter : LoadFilter; /** * @deprecated Please use the 'loadFilter' property instead. * The filter to denote how to load data. * @param value - The value to set. */ setLoadFilter(value: LoadFilter) : void; /** * @deprecated Please use the 'lightCellsDataHandler' property instead. * The data handler for processing cells data when reading template file. */ getLightCellsDataHandler() : LightCellsDataHandler; /** * The data handler for processing cells data when reading template file. */ lightCellsDataHandler : LightCellsDataHandler; /** * @deprecated Please use the 'lightCellsDataHandler' property instead. * The data handler for processing cells data when reading template file. * @param value - The value to set. */ setLightCellsDataHandler(value: LightCellsDataHandler) : void; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory mode for loaded workbook. * * @remarks * For more details about memory mode, please see . */ getMemorySetting() : MemorySetting; /** * Gets or sets the memory mode for loaded workbook. * * @remarks * For more details about memory mode, please see . */ memorySetting : MemorySetting; /** * @deprecated Please use the 'memorySetting' property instead. * Gets or sets the memory mode for loaded workbook. * @param value - The value to set. * * @remarks * For more details about memory mode, please see . */ setMemorySetting(value: MemorySetting) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. * @param value - The value to set. */ setWarningCallback(value: IWarningCallback) : void; /** * @deprecated Please use the 'warningCallback' property instead. * Gets or sets warning callback. */ getWarningCallback() : IWarningCallback; /** * Gets or sets warning callback. */ warningCallback : IWarningCallback; /** * @deprecated Please use the 'autoFitterOptions' property instead. * Gets and sets the auto fitter options * * @remarks * Only for xlsx ,spreadsheetML file now. */ getAutoFitterOptions() : AutoFitterOptions; /** * Gets and sets the auto fitter options * * @remarks * Only for xlsx ,spreadsheetML file now. */ autoFitterOptions : AutoFitterOptions; /** * @deprecated Please use the 'autoFitterOptions' property instead. * Gets and sets the auto fitter options * @param value - The value to set. * * @remarks * Only for xlsx ,spreadsheetML file now. */ setAutoFitterOptions(value: AutoFitterOptions) : void; /** * @deprecated Please use the 'autoFilter' property instead. * Indicates whether auto filtering the data when loading the files. * * @remarks * Sometimes although autofilter is set, the corresponding rows is not hidden in the file. * Now only works for SpreadSheetML file. */ getAutoFilter() : boolean; /** * Indicates whether auto filtering the data when loading the files. * * @remarks * Sometimes although autofilter is set, the corresponding rows is not hidden in the file. * Now only works for SpreadSheetML file. */ autoFilter : boolean; /** * @deprecated Please use the 'autoFilter' property instead. * Indicates whether auto filtering the data when loading the files. * @param value - The value to set. * * @remarks * Sometimes although autofilter is set, the corresponding rows is not hidden in the file. * Now only works for SpreadSheetML file. */ setAutoFilter(value: boolean) : void; /** * @deprecated Please use the 'fontConfigs' property instead. * Gets and sets individual font configs. * Only works for the which uses this to load. */ getFontConfigs() : IndividualFontConfigs; /** * Gets and sets individual font configs. * Only works for the which uses this to load. */ fontConfigs : IndividualFontConfigs; /** * @deprecated Please use the 'fontConfigs' property instead. * Gets and sets individual font configs. * Only works for the which uses this to load. * @param value - The value to set. */ setFontConfigs(value: IndividualFontConfigs) : void; /** * @deprecated Please use the 'ignoreUselessShapes' property instead. * Indicates whether ignoring useless shapes. * * @remarks * Only works for xlsx,xlsb, and xlsm files. * There are many overlapping identical shapes which are useless in some files, * we can ingore them when loading files. */ getIgnoreUselessShapes() : boolean; /** * Indicates whether ignoring useless shapes. * * @remarks * Only works for xlsx,xlsb, and xlsm files. * There are many overlapping identical shapes which are useless in some files, * we can ingore them when loading files. */ ignoreUselessShapes : boolean; /** * @deprecated Please use the 'ignoreUselessShapes' property instead. * Indicates whether ignoring useless shapes. * @param value - The value to set. * * @remarks * Only works for xlsx,xlsb, and xlsm files. * There are many overlapping identical shapes which are useless in some files, * we can ingore them when loading files. */ setIgnoreUselessShapes(value: boolean) : void; /** * @deprecated Please use the 'preservePaddingSpacesInFormula' property instead. * Indicates whether preserve those spaces and line breaks that are padded between formula tokens * while getting and setting formulas. * Default value is false. * * @remarks * After loading workbook from template file with this option, * will be set to the same value with this property. */ getPreservePaddingSpacesInFormula() : boolean; /** * Indicates whether preserve those spaces and line breaks that are padded between formula tokens * while getting and setting formulas. * Default value is false. * * @remarks * After loading workbook from template file with this option, * will be set to the same value with this property. */ preservePaddingSpacesInFormula : boolean; /** * @deprecated Please use the 'preservePaddingSpacesInFormula' property instead. * Indicates whether preserve those spaces and line breaks that are padded between formula tokens * while getting and setting formulas. * Default value is false. * @param value - The value to set. * * @remarks * After loading workbook from template file with this option, * will be set to the same value with this property. */ setPreservePaddingSpacesInFormula(value: boolean) : void; /** * Sets the default print paper size from default printer's setting. * @param type - The default paper size. * * @remarks * If there is no setting about paper size,MS Excel will use default printer's setting. */ setPaperSize(type: PaperSizeType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for loading text file. */ export class TxtLoadOptions extends AbstractTextLoadOptions { /** * Creates the options for loading text file. * * @remarks * The default load file type is CSV . */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: AbstractTextLoadOptions); /** * Creates the options for loading text file. * @param loadFormat - The loading format */ constructor(loadFormat: LoadFormat); /** * @deprecated Please use the 'separator' property instead. * Gets and sets character separator of text file. */ getSeparator() : string; /** * Gets and sets character separator of text file. */ separator : string; /** * @deprecated Please use the 'separator' property instead. * Gets and sets character separator of text file. * @param value - The value to set. */ setSeparator(value: string) : void; /** * @deprecated Please use the 'separatorString' property instead. * Gets and sets a string value as separator. */ getSeparatorString() : string; /** * Gets and sets a string value as separator. */ separatorString : string; /** * @deprecated Please use the 'separatorString' property instead. * Gets and sets a string value as separator. * @param value - The value to set. */ setSeparatorString(value: string) : void; /** * True means that the file contains several encoding. */ isMultiEncoded : boolean; /** * @deprecated Please use the 'isMultiEncoded' property instead. * True means that the file contains several encoding. * @param value - The value to set. */ setIsMultiEncoded(value: boolean) : void; /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". */ getHasFormula() : boolean; /** * Indicates whether the text is formula if it starts with "=". */ hasFormula : boolean; /** * @deprecated Please use the 'hasFormula' property instead. * Indicates whether the text is formula if it starts with "=". * @param value - The value to set. */ setHasFormula(value: boolean) : void; /** * @deprecated Please use the 'hasTextQualifier' property instead. * Whether there is text qualifier for cell value. Default is true. */ getHasTextQualifier() : boolean; /** * Whether there is text qualifier for cell value. Default is true. */ hasTextQualifier : boolean; /** * @deprecated Please use the 'hasTextQualifier' property instead. * Whether there is text qualifier for cell value. Default is true. * @param value - The value to set. */ setHasTextQualifier(value: boolean) : void; /** * @deprecated Please use the 'textQualifier' property instead. * Specifies the text qualifier for cell values. Default qualifier is '"'. * * @remarks * When setting this property, will become true automatically. */ getTextQualifier() : string; /** * Specifies the text qualifier for cell values. Default qualifier is '"'. * * @remarks * When setting this property, will become true automatically. */ textQualifier : string; /** * @deprecated Please use the 'textQualifier' property instead. * Specifies the text qualifier for cell values. Default qualifier is '"'. * @param value - The value to set. * * @remarks * When setting this property, will become true automatically. */ setTextQualifier(value: string) : void; /** * @deprecated Please use the 'treatConsecutiveDelimitersAsOne' property instead. * Whether consecutive delimiters should be treated as one. */ getTreatConsecutiveDelimitersAsOne() : boolean; /** * Whether consecutive delimiters should be treated as one. */ treatConsecutiveDelimitersAsOne : boolean; /** * @deprecated Please use the 'treatConsecutiveDelimitersAsOne' property instead. * Whether consecutive delimiters should be treated as one. * @param value - The value to set. */ setTreatConsecutiveDelimitersAsOne(value: boolean) : void; /** * @deprecated Please use the 'treatQuotePrefixAsValue' property instead. * Indicates whether the leading single quote sign should be taken as part of the value of one cell. * Default is true. If it is false, the leading single quote will be removed from corresponding cell's value * and will be set as true for the cell. */ getTreatQuotePrefixAsValue() : boolean; /** * Indicates whether the leading single quote sign should be taken as part of the value of one cell. * Default is true. If it is false, the leading single quote will be removed from corresponding cell's value * and will be set as true for the cell. */ treatQuotePrefixAsValue : boolean; /** * @deprecated Please use the 'treatQuotePrefixAsValue' property instead. * Indicates whether the leading single quote sign should be taken as part of the value of one cell. * Default is true. If it is false, the leading single quote will be removed from corresponding cell's value * and will be set as true for the cell. * @param value - The value to set. */ setTreatQuotePrefixAsValue(value: boolean) : void; /** * @deprecated Please use the 'extendToNextSheet' property instead. * Whether extends data to next sheet when the rows or columns of data exceed limit. * Default is false. * * @remarks * If this property is true, extra data will be put into next sheet behind current one * (if current sheet is the last one, new sheet will be appended to current workbook). * If this property is false, the data exceeding limit will be ignored. */ getExtendToNextSheet() : boolean; /** * Whether extends data to next sheet when the rows or columns of data exceed limit. * Default is false. * * @remarks * If this property is true, extra data will be put into next sheet behind current one * (if current sheet is the last one, new sheet will be appended to current workbook). * If this property is false, the data exceeding limit will be ignored. */ extendToNextSheet : boolean; /** * @deprecated Please use the 'extendToNextSheet' property instead. * Whether extends data to next sheet when the rows or columns of data exceed limit. * Default is false. * @param value - The value to set. * * @remarks * If this property is true, extra data will be put into next sheet behind current one * (if current sheet is the last one, new sheet will be appended to current workbook). * If this property is false, the data exceeding limit will be ignored. */ setExtendToNextSheet(value: boolean) : void; /** * @deprecated Please use the 'headerRowsCount' property instead. * The count of header rows to be repeated for extended sheets. * * @remarks * The header rows specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ getHeaderRowsCount() : number; /** * The count of header rows to be repeated for extended sheets. * * @remarks * The header rows specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ headerRowsCount : number; /** * @deprecated Please use the 'headerRowsCount' property instead. * The count of header rows to be repeated for extended sheets. * @param value - The value to set. * * @remarks * The header rows specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ setHeaderRowsCount(value: number) : void; /** * @deprecated Please use the 'headerColumnsCount' property instead. * The count of header columns to be repeated for extended sheets. * * @remarks * The header columns specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ getHeaderColumnsCount() : number; /** * The count of header columns to be repeated for extended sheets. * * @remarks * The header columns specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ headerColumnsCount : number; /** * @deprecated Please use the 'headerColumnsCount' property instead. * The count of header columns to be repeated for extended sheets. * @param value - The value to set. * * @remarks * The header columns specified by this property will be duplicated for those extended sheets. * This property only takes effect when is true. */ setHeaderColumnsCount(value: number) : void; /** * @deprecated Please use the 'maxRowCount' property instead. * The maximum count of rows to be imported for one sheet. * * @remarks * Those rows exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header rows(). * The maximum allowed value of it is the row limit of corresponding file format, such as for xlsx file it 1048576. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ getMaxRowCount() : number; /** * The maximum count of rows to be imported for one sheet. * * @remarks * Those rows exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header rows(). * The maximum allowed value of it is the row limit of corresponding file format, such as for xlsx file it 1048576. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ maxRowCount : number; /** * @deprecated Please use the 'maxRowCount' property instead. * The maximum count of rows to be imported for one sheet. * @param value - The value to set. * * @remarks * Those rows exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header rows(). * The maximum allowed value of it is the row limit of corresponding file format, such as for xlsx file it 1048576. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ setMaxRowCount(value: number) : void; /** * @deprecated Please use the 'maxColumnCount' property instead. * The maximum count of columns to be imported for one sheet. * * @remarks * Those columns exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header columns(). * The maximum value of it is the column limit of corresponding file format, such as for xlsx file it 16384. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ getMaxColumnCount() : number; /** * The maximum count of columns to be imported for one sheet. * * @remarks * Those columns exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header columns(). * The maximum value of it is the column limit of corresponding file format, such as for xlsx file it 16384. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ maxColumnCount : number; /** * @deprecated Please use the 'maxColumnCount' property instead. * The maximum count of columns to be imported for one sheet. * @param value - The value to set. * * @remarks * Those columns exceeding this limit will be ignored * or extended to next sheet according to . * This count includes the header columns(). * The maximum value of it is the column limit of corresponding file format, such as for xlsx file it 16384. * If this property has not been specified or the specified value is not positive, then the maximum limit will be used too. */ setMaxColumnCount(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents PivotTable condition formatting scope type. */ export enum PivotConditionFormatScopeType { /** * Indicates that conditional formatting is applied to the selected data fields. */ Data = 0, /** * Indicates that conditional formatting is applied to the selected PivotTable field intersections. */ Field = 1, /** * Indicates that conditional formatting is applied to the selected cells. */ Selection = 2, } /** * Represents a PivotFilter in PivotFilter Collection. */ export class PivotFilter { /** * @deprecated Please use the 'useWholeDay' property instead. * Indicates whether to use whole days in its date filtering criteria. */ getUseWholeDay() : boolean; /** * Indicates whether to use whole days in its date filtering criteria. */ useWholeDay : boolean; /** * @deprecated Please use the 'useWholeDay' property instead. * Indicates whether to use whole days in its date filtering criteria. * @param value - The value to set. */ setUseWholeDay(value: boolean) : void; /** * @deprecated Please use the 'autoFilter' property instead. * Gets the autofilter of the pivot filter. * * @remarks * NOTE: This method is now obsolete. Instead, * please use FilterLabel, FilterValue,FilterDate or FilterTop10 method. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FilterLabel, FilterValue,FilterDate or FilterTop10 method. */ getAutoFilter() : AutoFilter; /** * Gets the autofilter of the pivot filter. * * @remarks * NOTE: This method is now obsolete. Instead, * please use FilterLabel, FilterValue,FilterDate or FilterTop10 method. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FilterLabel, FilterValue,FilterDate or FilterTop10 method. */ readonly autoFilter : AutoFilter; /** * @deprecated Please use the 'filterType' property instead. * Gets the filter type of the pivot filter. */ getFilterType() : PivotFilterType; /** * Gets the filter type of the pivot filter. */ readonly filterType : PivotFilterType; /** * @deprecated Please use the 'fieldIndex' property instead. * Gets the index of source field which this pivot filter is applied to. */ getFieldIndex() : number; /** * Gets the index of source field which this pivot filter is applied to. */ readonly fieldIndex : number; /** * @deprecated Please use the 'filterCategory' property instead. * Gets the category of this filter. */ getFilterCategory() : FilterCategory; /** * Gets the category of this filter. */ readonly filterCategory : FilterCategory; /** * @deprecated Please use the 'value1' property instead. * Gets the string value1 of the label pivot filter. */ getValue1() : string; /** * Gets the string value1 of the label pivot filter. */ value1 : string; /** * @deprecated Please use the 'value1' property instead. * Gets the string value1 of the label pivot filter. * @param value - The value to set. */ setValue1(value: string) : void; /** * @deprecated Please use the 'value2' property instead. * Gets the string value2 of the label pivot filter. */ getValue2() : string; /** * Gets the string value2 of the label pivot filter. */ value2 : string; /** * @deprecated Please use the 'value2' property instead. * Gets the string value2 of the label pivot filter. * @param value - The value to set. */ setValue2(value: string) : void; /** * @deprecated Please use the 'measureFldIndex' property instead. * Gets the measure field index of the pivot filter. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotFilter.ValueFieldIndex property. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilter.ValueFieldIndex property. */ getMeasureFldIndex() : number; /** * Gets the measure field index of the pivot filter. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotFilter.ValueFieldIndex property. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilter.ValueFieldIndex property. */ measureFldIndex : number; /** * @deprecated Please use the 'measureFldIndex' property instead. * Gets the measure field index of the pivot filter. * @param value - The value to set. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotFilter.ValueFieldIndex property. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilter.ValueFieldIndex property. */ setMeasureFldIndex(value: number) : void; /** * @deprecated Please use the 'valueFieldIndex' property instead. * Gets the index of value field in the value region. */ getValueFieldIndex() : number; /** * Gets the index of value field in the value region. */ valueFieldIndex : number; /** * @deprecated Please use the 'valueFieldIndex' property instead. * Gets the index of value field in the value region. * @param value - The value to set. */ setValueFieldIndex(value: number) : void; /** * @deprecated Please use the 'measureCubeFieldIndex' property instead. * Specifies the index of the measure cube field. * this property is used only by filters in OLAP pivots and specifies on which measure a value filter should apply. */ getMeasureCubeFieldIndex() : number; /** * Specifies the index of the measure cube field. * this property is used only by filters in OLAP pivots and specifies on which measure a value filter should apply. */ readonly measureCubeFieldIndex : number; /** * @deprecated Please use the 'memberPropertyFieldIndex' property instead. * Gets the member property field index of the pivot filter. */ getMemberPropertyFieldIndex() : number; /** * Gets the member property field index of the pivot filter. */ memberPropertyFieldIndex : number; /** * @deprecated Please use the 'memberPropertyFieldIndex' property instead. * Gets the member property field index of the pivot filter. * @param value - The value to set. */ setMemberPropertyFieldIndex(value: number) : void; /** * @deprecated Please use the 'name' property instead. * Gets the name of the pivot filter. */ getName() : string; /** * Gets the name of the pivot filter. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets the name of the pivot filter. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'evaluationOrder' property instead. * Gets the Evaluation Order of the pivot filter. */ getEvaluationOrder() : number; /** * Gets the Evaluation Order of the pivot filter. */ evaluationOrder : number; /** * @deprecated Please use the 'evaluationOrder' property instead. * Gets the Evaluation Order of the pivot filter. * @param value - The value to set. */ setEvaluationOrder(value: number) : void; /** * Gets top 10 setting of the filter. */ getTop10Value() : Top10Filter; /** * Gets labels of the caption filter. */ getLabels() : string[]; /** * Gets values of the number filter. */ getNumberValues() : number[]; /** * Gets values of the number filter. */ getDateTimeValues() : Date[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a collection of all the PivotFilters. */ export class PivotFilterCollection implements Iterable { /** * Gets the pivotfilter object at the specific index. */ get(index: number) : PivotFilter; /** * Adds a PivotFilter Object to the specific type * @param fieldIndex - the PivotField index * @param type - the PivotFilter type * @returns * the index of the PivotFilter Object in this PivotFilterCollection. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods. * This method will be removed 12 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterCollection.AddValueFilter(),AddTop10Filter(),AddLabelFilter() and AddDateFilter() methods,instead. */ add(fieldIndex: number, type: PivotFilterType) : number; /** * Filters by values of data pivot field. * @param baseFieldIndex - The index of field in the source. * @param valueFieldIndex - The index of data field in the data region. * @param type - The type of filtering data. Only can be Count,Sum and Percent. * @param isTop - Indicates whether filter from top or bottom * @param itemCount - The item count */ addTop10Filter(baseFieldIndex: number, valueFieldIndex: number, type: PivotFilterType, isTop: boolean, itemCount: number) : PivotFilter; /** * Filters by values of data pivot field. * @param baseFieldIndex - The index of field in the source. * @param valueFieldIndex - The index of value field in the value region. * @param type - The type of filtering data. * @param value1 - The value of filter condition * @param value2 - The upper-bound value of between filter condition */ addValueFilter(baseFieldIndex: number, valueFieldIndex: number, type: PivotFilterType, value1: number, value2: number) : PivotFilter; /** * Filters by captions of row or column pivot field. * @param baseFieldIndex - The index of field in the source. * @param type - The type of filtering data. * @param label1 - The label of filter condition * @param label2 - The upper-bound label of between filter condition */ addLabelFilter(baseFieldIndex: number, type: PivotFilterType, label1: string, label2: string) : PivotFilter; /** * Filters by date setting of row or column pivot field. * @param baseFieldIndex - The index of field in the source. * @param type - The type of filtering data. * @param dateTime1 - The date label of filter condition * @param dateTime2 - The upper-bound date label of between filter condition */ addDateFilter(baseFieldIndex: number, type: PivotFilterType, dateTime1: Date, dateTime2: Date) : PivotFilter; /** * Clear PivotFilter from the specific PivotField * @param fieldIndex - the PivotField index */ clearFilter(fieldIndex: number) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the filter type of the pivot table. */ export enum PivotFilterType { /** * Indicates the "begins with" filter for field captions. */ CaptionBeginsWith = 0, /** * Indicates the "is between" filter for field captions. */ CaptionBetween = 1, /** * Indicates the "contains" filter for field captions. */ CaptionContains = 2, /** * Indicates the "ends with" filter for field captions. */ CaptionEndsWith = 3, /** * Indicates the "equal" filter for field captions. */ CaptionEqual = 4, /** * Indicates the "is greater than" filter for field captions. */ CaptionGreaterThan = 5, /** * Indicates the "is greater than or equal to" filter for field captions. */ CaptionGreaterThanOrEqual = 6, /** * Indicates the "is less than" filter for field captions. */ CaptionLessThan = 7, /** * Indicates the "is less than or equal to" filter for field captions. */ CaptionLessThanOrEqual = 8, /** * Indicates the "does not begin with" filter for field captions. */ CaptionNotBeginsWith = 9, /** * Indicates the "is not between" filter for field captions. */ CaptionNotBetween = 10, /** * Indicates the "does not contain" filter for field captions. */ CaptionNotContains = 11, /** * Indicates the "does not end with" filter for field captions. */ CaptionNotEndsWith = 12, /** * Indicates the "not equal" filter for field captions. */ CaptionNotEqual = 13, /** * Indicates the "count" filter. */ Count = 14, /** * Indicates the "between" filter for date values. */ DateBetween = 15, /** * Indicates the "equals" filter for date values. */ DateEqual = 16, /** * Indicates the "after" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.DateAfter instead. */ DateNewerThan = 17, /** * Indicates the "after" filter for date values. */ DateAfter = 17, /** * Indicates the "after or equal to" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.DateAfterOrEqual instead. */ DateNewerThanOrEqual = 18, /** * Indicates the "after or equal to" filter for date values. */ DateAfterOrEqual = 18, /** * Indicates the "not between" filter for date values. */ DateNotBetween = 19, /** * Indicates the "does not equal" filter for date values. */ DateNotEqual = 20, /** * Indicates the "before" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.DateBefore instead. */ DateOlderThan = 21, /** * Indicates the "before" filter for date values. */ DateBefore = 21, /** * Indicates the "before or equal to" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.DateBeforeOrEqual instead. */ DateOlderThanOrEqual = 22, /** * Indicates the "before or equal to" filter for date values. */ DateBeforeOrEqual = 22, /** * Indicates the "last month" filter for date values. */ LastMonth = 23, /** * Indicates the "last quarter" filter for date values. */ LastQuarter = 24, /** * Indicates the "last week" filter for date values. */ LastWeek = 25, /** * Indicates the "last year" filter for date values. */ LastYear = 26, /** * Indicates the "January" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.January instead. */ M1 = 27, /** * Indicates the "January" filter for date values. */ January = 27, /** * Indicates the "February" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.February instead. */ M2 = 28, /** * Indicates the "February" filter for date values. */ February = 28, /** * Indicates the "March" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.March instead. */ M3 = 29, /** * Indicates the "March" filter for date values. */ March = 29, /** * Indicates the "April" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.April instead. */ M4 = 30, /** * Indicates the "April" filter for date values. */ April = 30, /** * Indicates the "May" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.May instead. */ M5 = 31, /** * Indicates the "May" filter for date values. */ May = 31, /** * Indicates the "June" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.June instead. */ M6 = 32, /** * Indicates the "June" filter for date values. */ June = 32, /** * Indicates the "July" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.July instead. */ M7 = 33, /** * Indicates the "July" filter for date values. */ July = 33, /** * Indicates the "August" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.August instead. */ M8 = 34, /** * Indicates the "August" filter for date values. */ August = 34, /** * Indicates the "September" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.September instead. */ M9 = 35, /** * Indicates the "September" filter for date values. */ September = 35, /** * Indicates the "October" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.October instead. */ M10 = 36, /** * Indicates the "October" filter for date values. */ October = 36, /** * Indicates the "November" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.November instead. */ M11 = 37, /** * Indicates the "November" filter for date values. */ November = 37, /** * Indicates the "December" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.December instead. */ M12 = 38, /** * Indicates the "December" filter for date values. */ December = 38, /** * Indicates the "next month" filter for date values. */ NextMonth = 39, /** * Indicates the "next quarter" for date values. */ NextQuarter = 40, /** * Indicates the "next week" for date values. */ NextWeek = 41, /** * Indicates the "next year" filter for date values. */ NextYear = 42, /** * Indicates the "percent" filter for numeric values. */ Percent = 43, /** * Indicates the "first quarter" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.Quarter1 instead. */ Q1 = 44, /** * Indicates the "first quarter" filter for date values. */ Quarter1 = 44, /** * Indicates the "second quarter" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.Quarter2 instead. */ Q2 = 45, /** * Indicates the "second quarter" filter for date values. */ Quarter2 = 45, /** * Indicates the "third quarter" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.Quarter3 instead. */ Q3 = 46, /** * Indicates the "third quarter" filter for date values. */ Quarter3 = 46, /** * Indicates the "fourth quarter" filter for date values. * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotFilterType.Quarter4 instead. */ Q4 = 47, /** * Indicates the "fourth quarter" filter for date values. */ Quarter4 = 47, /** * Indicates the "sum" filter for numeric values. */ Sum = 48, /** * Indicates the "this month" filter for date values. */ ThisMonth = 49, /** * Indicates the "this quarter" filter for date values. */ ThisQuarter = 50, /** * Indicates the "this week" filter for date values. */ ThisWeek = 51, /** * Indicate the "this year" filter for date values. */ ThisYear = 52, /** * Indicates the "today" filter for date values. */ Today = 53, /** * Indicates the "tomorrow" filter for date values. */ Tomorrow = 54, /** * Indicates the PivotTable filter is unknown to the application. */ Unknown = 55, /** * Indicates the "Value between" filter for text and numeric values. */ ValueBetween = 56, /** * Indicates the "value equal" filter for text and numeric values. */ ValueEqual = 57, /** * Indicates the "value greater than" filter for text and numeric values. */ ValueGreaterThan = 58, /** * Indicates the "value greater than or equal to" filter for text and numeric values. */ ValueGreaterThanOrEqual = 59, /** * Indicates the "value less than" filter for text and numeric values. */ ValueLessThan = 60, /** * Indicates the "value less than or equal to" filter for text and numeric values. */ ValueLessThanOrEqual = 61, /** * Indicates the "value not between" filter for text and numeric values. */ ValueNotBetween = 62, /** * Indicates the "value not equal" filter for text and numeric values. */ ValueNotEqual = 63, /** * Indicates the "year-to-date" filter for date values. */ YearToDate = 64, /** * Indicates the "yesterday" filter for date values. */ Yesterday = 65, /** * No filter. */ None = 255, } /** * Represents a PivotTable Format Condition in PivotFormatCondition Collection. * * @remarks * NOTE: This class is now obsolete. Instead, * please use class. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotConditionalFormat class instead. */ export class PivotFormatCondition { /** * @deprecated Please use the 'scopeType' property instead. * Get and set scope type for the pivot table conditional format . */ getScopeType() : PivotConditionFormatScopeType; /** * Get and set scope type for the pivot table conditional format . */ scopeType : PivotConditionFormatScopeType; /** * @deprecated Please use the 'scopeType' property instead. * Get and set scope type for the pivot table conditional format . * @param value - The value to set. */ setScopeType(value: PivotConditionFormatScopeType) : void; /** * @deprecated Please use the 'ruleType' property instead. * Get and set rule type for the pivot table condition format . */ getRuleType() : PivotConditionFormatRuleType; /** * Get and set rule type for the pivot table condition format . */ ruleType : PivotConditionFormatRuleType; /** * @deprecated Please use the 'ruleType' property instead. * Get and set rule type for the pivot table condition format . * @param value - The value to set. */ setRuleType(value: PivotConditionFormatRuleType) : void; /** * @deprecated Please use the 'formatConditions' property instead. * Get conditions for the pivot table conditional format . */ getFormatConditions() : FormatConditionCollection; /** * Get conditions for the pivot table conditional format . */ readonly formatConditions : FormatConditionCollection; /** * Adds PivotTable conditional format limit in the data fields. * @param fieldName - The name of PivotField. */ addDataAreaCondition(fieldName: string) : void; /** * Adds PivotTable conditional format limit in the data fields. * @param dataField - The PivotField in the data fields. */ addDataAreaCondition(dataField: PivotField) : void; /** * Adds PivotTable conditional format limit in the row fields. * @param fieldName - The name of PivotField. */ addRowAreaCondition(fieldName: string) : void; /** * Adds PivotTable conditional format limit in the row fields. * @param rowField - The PivotField in the row fields. */ addRowAreaCondition(rowField: PivotField) : void; /** * Adds PivotTable conditional format limit in the column fields. * @param fieldName - The name of PivotField. */ addColumnAreaCondition(fieldName: string) : void; /** * Adds PivotTable conditional format limit in the column fields. * @param columnField - The PivotField in the column fields. */ addColumnAreaCondition(columnField: PivotField) : void; /** * Sets conditional areas of PivotFormatCondition object. */ setConditionalAreas() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents PivotTable Format Conditions. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotConditionalFormatCollection class. * This method will be removed 12 months later since December 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotConditionalFormatCollection class instead. */ export class PivotFormatConditionCollection implements Iterable { /** * Gets the pivot FormatCondition object at the specific index. * @returns * pivot FormatCondition object. */ get(index: number) : PivotFormatCondition; /** * @deprecated Please use the 'count' property instead. * Gets the count of conditional formats. */ getCount() : number; /** * Gets the count of conditional formats. */ readonly count : number; /** * Adds a pivot FormatCondition to the collection. * @returns * pivot FormatCondition object index. * * @remarks * not supported */ add() : number; /** * Remove a conditional formats. */ removeAt(index: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents number of items to retain per field. */ export enum PivotMissingItemLimitType { /** * The default number of unique items per PivotField allowed. */ Automatic = 0, /** * The maximum number of unique items per PivotField allowed (>32,500). */ Max = 1, /** * No unique items per PivotField allowed. */ None = 2, } /** * Represents the options of saving dif file. */ export class DifSaveOptions extends SaveOptions { /** * Creates the options for saving DIF file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents image save options. * For advanced usage, please use or . */ export class ImageSaveOptions extends SaveOptions { /** * Creates the options for saving image file. * * @remarks * The default type is Tiff. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * Creates the options for saving image file. * @param saveFormat - The file format. /// It should be one of following types: , , /// , , , /// or , /// otherwise the saved format will be set as automatically. */ constructor(saveFormat: SaveFormat); /** * @deprecated Please use the 'imageOrPrintOptions' property instead. * Additional image creation options. * * @remarks * For advanced usage, please use or . */ getImageOrPrintOptions() : ImageOrPrintOptions; /** * Additional image creation options. * * @remarks * For advanced usage, please use or . */ readonly imageOrPrintOptions : ImageOrPrintOptions; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Sorted value type. */ export enum SortOnType { /** * Sorts by cells' value. */ Value = 0, /** * Sorts by cells' color. */ CellColor = 1, /** * Sorts by cells' font color. */ FontColor = 2, /** * Sorts by conditional icon. */ Icon = 3, } /** * Describes a collection of CFValueObject. * Use only for icon sets. */ export class ConditionalFormattingValueCollection implements Iterable { /** * Get the CFValueObject element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : ConditionalFormattingValue; /** * Adds object. * @param type - The value type. * @param value - The value. * @returns * Returns the index of new object in the list. */ add(type: FormatConditionValueType, value: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Condition value type. */ export enum FormatConditionValueType { /** * The minimum/ midpoint / maximum value for the * gradient is determined by a formula. */ Formula = 0, /** * Indicates that the maximum value in the range shall be * used as the maximum value for the gradient. */ Max = 1, /** * Indicates that the minimum value in the range shall be * used as the minimum value for the gradient. */ Min = 2, /** * Indicates that the minimum / midpoint / maximum * value for the gradient is specified by a constant * numeric value. */ Number = 3, /** * Value indicates a percentage between the minimum * and maximum values in the range shall be used as the * minimum / midpoint / maximum value for the gradient. */ Percent = 4, /** * Value indicates a percentile ranking in the range shall * be used as the minimum / midpoint / maximum value * for the gradient. */ Percentile = 5, /** * Indicates that the Automatic maximum value in the range shall be * used as the Automatic maximum value for the gradient. */ AutomaticMax = 6, /** * Indicates that the Automatic minimum value in the range shall be * used as the Automatic minimum value for the gradient. */ AutomaticMin = 7, } /** * Icon set type for conditional formatting. * The threshold values for triggering the different icons within a set are * configurable, and the icon order is reversible. */ export enum IconSetType { /** * 3 arrows icon set. */ Arrows3 = 0, /** * 3 gray arrows icon set. */ ArrowsGray3 = 1, /** * 3 flags icon set. */ Flags3 = 2, /** * 3 signs icon set. */ Signs3 = 3, /** * 3 symbols icon set (circled). */ Symbols3 = 4, /** * 3 Symbols icon set (uncircled). */ Symbols32 = 5, /** * 3 traffic lights icon set (unrimmed). */ TrafficLights31 = 6, /** * 3 traffic lights icon set with thick black border. */ TrafficLights32 = 7, /** * 4 arrows icon set. */ Arrows4 = 8, /** * 4 gray arrows icon set. */ ArrowsGray4 = 9, /** * 4 ratings icon set. */ Rating4 = 10, /** * 4 'red to black' icon set. */ RedToBlack4 = 11, /** * 4 traffic lights icon set. */ TrafficLights4 = 12, /** * 5 arrows icon set. */ Arrows5 = 13, /** * 5 gray arrows icon set. */ ArrowsGray5 = 14, /** * 5 quarters icon set. */ Quarters5 = 15, /** * 5 rating icon set. */ Rating5 = 16, /** * 3 stars set */ Stars3 = 17, /** * 5 boxes set */ Boxes5 = 18, /** * 3 triangles set */ Triangles3 = 19, /** * None */ None = 20, /** * CustomSet. * This element is read-only. */ CustomSet = 21, /** * 3 smilies. * Only for .ods. */ Smilies3 = 22, /** * 3 color smilies. * Only for .ods. */ ColorSmilies3 = 23, } /** * Used in a FormatConditionType.TimePeriod conditional formatting rule. * These are dynamic time periods, which change based on * the date the conditional formatting is refreshed / applied. */ export enum TimePeriodType { /** * Today's date. */ Today = 0, /** * Yesterday's date. */ Yesterday = 1, /** * Tomorrow's date. */ Tomorrow = 2, /** * A date in the last seven days. */ Last7Days = 3, /** * A date occurring in this calendar month. */ ThisMonth = 4, /** * A date occurring in the last calendar month. */ LastMonth = 5, /** * A date occurring in the next calendar month. */ NextMonth = 6, /** * A date occurring this week. */ ThisWeek = 7, /** * A date occurring last week. */ LastWeek = 8, /** * A date occurring next week. */ NextWeek = 9, /** * A date occurring this year. * Only for .ods. */ ThisYear = 10, /** * A date occurring last year. * Only for .ods. */ LastYear = 11, /** * A date occurring next year. * Only for .ods. */ NextYear = 12, } /** * Describe the Top10 conditional formatting rule. * This conditional formatting rule highlights cells whose * values fall in the top N or bottom N bracket, as specified. */ export class Top10 { /** * Default Constructor. */ constructor(); /** * Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule. * Default value is false. */ isPercent : boolean; /** * @deprecated Please use the 'isPercent' property instead. * Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule. * Default value is false. * @param value - The value to set. */ setIsPercent(value: boolean) : void; /** * Get or set whether a "top/bottom n" rule is a "bottom n" rule. * Default value is false. */ isBottom : boolean; /** * @deprecated Please use the 'isBottom' property instead. * Get or set whether a "top/bottom n" rule is a "bottom n" rule. * Default value is false. * @param value - The value to set. */ setIsBottom(value: boolean) : void; /** * @deprecated Please use the 'rank' property instead. * Get or set the value of "n" in a "top/bottom n" conditional formatting rule. * If IsPercent is true, the value must between 0 and 100. * Otherwise it must between 0 and 1000. * Default value is 10. */ getRank() : number; /** * Get or set the value of "n" in a "top/bottom n" conditional formatting rule. * If IsPercent is true, the value must between 0 and 100. * Otherwise it must between 0 and 1000. * Default value is 10. */ rank : number; /** * @deprecated Please use the 'rank' property instead. * Get or set the value of "n" in a "top/bottom n" conditional formatting rule. * If IsPercent is true, the value must between 0 and 100. * Otherwise it must between 0 and 1000. * Default value is 10. * @param value - The value to set. */ setRank(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * The content disposition type. */ export enum ContentDisposition { /** */ Inline = 0, /** */ Attachment = 1, } /** * Signature in file. */ export class DigitalSignature { /** * Constructor of DigitalSignature. * @param rawData - A byte array containing data from an X.509 certificate. * @param password - The password required to access the X.509 certificate data. * @param comments - The purpose to signature. * @param signTime - The utc time when the document was signed. */ constructor(rawData: Uint8Array, password: string, comments: string, signTime: Date); /** * Constructor of DigitalSignature. * @param fileName - The name of a certificate file. * @param password - The password required to access the X.509 certificate data. * @param comments - The purpose to signature. * @param signTime - The utc time when the document was signed. */ constructor(fileName: string, password: string, comments: string, signTime: Date); /** * @deprecated Please use the 'comments' property instead. * The purpose to signature. */ getComments() : string; /** * The purpose to signature. */ comments : string; /** * @deprecated Please use the 'comments' property instead. * The purpose to signature. * @param value - The value to set. */ setComments(value: string) : void; /** * @deprecated Please use the 'signTime' property instead. * The time when the document was signed. */ getSignTime() : Date; /** * The time when the document was signed. */ signTime : Date; /** * @deprecated Please use the 'signTime' property instead. * The time when the document was signed. * @param value - The value to set. */ setSignTime(value: Date) : void; /** * @deprecated Please use the 'text' property instead. * Specifies the text of actual signature in the digital signature. * Default value is Empty. */ getText() : string; /** * Specifies the text of actual signature in the digital signature. * Default value is Empty. */ text : string; /** * @deprecated Please use the 'text' property instead. * Specifies the text of actual signature in the digital signature. * Default value is Empty. * @param value - The value to set. */ setText(value: string) : void; /** * @deprecated Please use the 'image' property instead. * Specifies an image for the digital signature. * Default value is null. */ getImage() : Uint8Array; /** * Specifies an image for the digital signature. * Default value is null. */ image : Uint8Array; /** * @deprecated Please use the 'image' property instead. * Specifies an image for the digital signature. * Default value is null. * @param value - The value to set. */ setImage(value: Uint8Array) : void; /** * If this digital signature is valid and the document has not been tampered with, * this value will be true. */ readonly isValid : boolean; /** * @deprecated Please use the 'xAdESType' property instead. * XAdES type. * Default value is None(XAdES is off). */ getXAdESType() : XAdESType; /** * XAdES type. * Default value is None(XAdES is off). */ xAdESType : XAdESType; /** * @deprecated Please use the 'xAdESType' property instead. * XAdES type. * Default value is None(XAdES is off). * @param value - The value to set. */ setXAdESType(value: XAdESType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Provides a collection of digital signatures attached to a document. */ export class DigitalSignatureCollection implements Iterable { /** * The constructor of DigitalSignatureCollection. */ constructor(); /** * Add one signature to DigitalSignatureCollection. * @param digitalSignature - Digital signature in collection. */ add(digitalSignature: DigitalSignature) : void; /** * Get the enumerator for DigitalSignatureCollection, * this enumerator allows iteration over the collection * @returns * The enumerator to iteration. */ getEnumerator() : DigitalSignatureEnumerator; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Options for encrypting and access permissions for a PDF document. * PDF/A does not allow security setting. */ export class PdfSecurityOptions { /** * The constructor of PdfSecurityOptions */ constructor(); /** * @deprecated Please use the 'userPassword' property instead. * Gets or sets the user password required for opening the encrypted PDF document. * * @remarks *

The owner password or user password will be required to open an encrypted PDF document for viewing.

*

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

*

Opening the document with the correct owner password allows full access to the document.

*

Opening the document with the correct user password (or opening a document that does not have a user password) * allows limited access as the permissions specified.

*/ getUserPassword() : string; /** * Gets or sets the user password required for opening the encrypted PDF document. * * @remarks *

The owner password or user password will be required to open an encrypted PDF document for viewing.

*

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

*

Opening the document with the correct owner password allows full access to the document.

*

Opening the document with the correct user password (or opening a document that does not have a user password) * allows limited access as the permissions specified.

*/ userPassword : string; /** * @deprecated Please use the 'userPassword' property instead. * Gets or sets the user password required for opening the encrypted PDF document. * @param value - The value to set. * * @remarks *

The owner password or user password will be required to open an encrypted PDF document for viewing.

*

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

*

Opening the document with the correct owner password allows full access to the document.

*

Opening the document with the correct user password (or opening a document that does not have a user password) * allows limited access as the permissions specified.

*/ setUserPassword(value: string) : void; /** * @deprecated Please use the 'ownerPassword' property instead. * Gets or sets the owner password for the encrypted PDF document. * * @remarks * The owner password allows the user to open an encrypted PDF document without any access restrictions specified. */ getOwnerPassword() : string; /** * Gets or sets the owner password for the encrypted PDF document. * * @remarks * The owner password allows the user to open an encrypted PDF document without any access restrictions specified. */ ownerPassword : string; /** * @deprecated Please use the 'ownerPassword' property instead. * Gets or sets the owner password for the encrypted PDF document. * @param value - The value to set. * * @remarks * The owner password allows the user to open an encrypted PDF document without any access restrictions specified. */ setOwnerPassword(value: string) : void; /** * @deprecated Please use the 'printPermission' property instead. * Indicates whether to allow to print the document. * * @remarks * Possibly not at the highest quality level, * depending on whether is also set. */ getPrintPermission() : boolean; /** * Indicates whether to allow to print the document. * * @remarks * Possibly not at the highest quality level, * depending on whether is also set. */ printPermission : boolean; /** * @deprecated Please use the 'printPermission' property instead. * Indicates whether to allow to print the document. * @param value - The value to set. * * @remarks * Possibly not at the highest quality level, * depending on whether is also set. */ setPrintPermission(value: boolean) : void; /** * @deprecated Please use the 'modifyDocumentPermission' property instead. * Indicates whether to allow to modify the contents of the document by operations other than those controlled * by , and . */ getModifyDocumentPermission() : boolean; /** * Indicates whether to allow to modify the contents of the document by operations other than those controlled * by , and . */ modifyDocumentPermission : boolean; /** * @deprecated Please use the 'modifyDocumentPermission' property instead. * Indicates whether to allow to modify the contents of the document by operations other than those controlled * by , and . * @param value - The value to set. */ setModifyDocumentPermission(value: boolean) : void; /** * @deprecated Please use the 'annotationsPermission' property instead. * Indicates whether to allow to add or modify text annotations, fill in interactive form fields. * * @remarks * if is also set, create or modify interactive form fields (including signature fields). */ getAnnotationsPermission() : boolean; /** * Indicates whether to allow to add or modify text annotations, fill in interactive form fields. * * @remarks * if is also set, create or modify interactive form fields (including signature fields). */ annotationsPermission : boolean; /** * @deprecated Please use the 'annotationsPermission' property instead. * Indicates whether to allow to add or modify text annotations, fill in interactive form fields. * @param value - The value to set. * * @remarks * if is also set, create or modify interactive form fields (including signature fields). */ setAnnotationsPermission(value: boolean) : void; /** * @deprecated Please use the 'fillFormsPermission' property instead. * Indicates whether to allow to fill in existing interactive form fields (including signature fields), * even if is clear. */ getFillFormsPermission() : boolean; /** * Indicates whether to allow to fill in existing interactive form fields (including signature fields), * even if is clear. */ fillFormsPermission : boolean; /** * @deprecated Please use the 'fillFormsPermission' property instead. * Indicates whether to allow to fill in existing interactive form fields (including signature fields), * even if is clear. * @param value - The value to set. */ setFillFormsPermission(value: boolean) : void; /** * @deprecated Please use the 'extractContentPermission' property instead. * Indicates whether to allow to copy or otherwise extract text and graphics from the document * by operations other than that controlled by . */ getExtractContentPermission() : boolean; /** * Indicates whether to allow to copy or otherwise extract text and graphics from the document * by operations other than that controlled by . */ extractContentPermission : boolean; /** * @deprecated Please use the 'extractContentPermission' property instead. * Indicates whether to allow to copy or otherwise extract text and graphics from the document * by operations other than that controlled by . * @param value - The value to set. */ setExtractContentPermission(value: boolean) : void; /** * @deprecated Please use the 'accessibilityExtractContent' property instead. * Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes). */ getAccessibilityExtractContent() : boolean; /** * Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes). */ accessibilityExtractContent : boolean; /** * @deprecated Please use the 'accessibilityExtractContent' property instead. * Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes). * @param value - The value to set. */ setAccessibilityExtractContent(value: boolean) : void; /** * @deprecated Please use the 'assembleDocumentPermission' property instead. * Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), * even if is clear. */ getAssembleDocumentPermission() : boolean; /** * Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), * even if is clear. */ assembleDocumentPermission : boolean; /** * @deprecated Please use the 'assembleDocumentPermission' property instead. * Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), * even if is clear. * @param value - The value to set. */ setAssembleDocumentPermission(value: boolean) : void; /** * @deprecated Please use the 'fullQualityPrintPermission' property instead. * Indicates whether to allow to print the document to a representation from * which a faithful digital copy of the PDF content could be generated. * * @remarks * When it is clear (and is set), printing is limited to a low level * representation of the appearance, possibly of degraded quality. */ getFullQualityPrintPermission() : boolean; /** * Indicates whether to allow to print the document to a representation from * which a faithful digital copy of the PDF content could be generated. * * @remarks * When it is clear (and is set), printing is limited to a low level * representation of the appearance, possibly of degraded quality. */ fullQualityPrintPermission : boolean; /** * @deprecated Please use the 'fullQualityPrintPermission' property instead. * Indicates whether to allow to print the document to a representation from * which a faithful digital copy of the PDF content could be generated. * @param value - The value to set. * * @remarks * When it is clear (and is set), printing is limited to a low level * representation of the appearance, possibly of degraded quality. */ setFullQualityPrintPermission(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the command type of header and footer. */ export enum HeaderFooterCommandType { /** * The text. */ Text = 0, /** * Current page number */ CurrentPage = 1, /** * Page count */ Pagecount = 2, /** * Current date */ CurrentDate = 3, /** * Current time */ CurrentTime = 4, /** * Sheet name */ SheetName = 5, /** * File name without path */ FileName = 6, /** * File path without file name */ FilePath = 7, /** * Picture */ Picture = 8, } /** * Represents the key of the data sorter. */ export class DataSorterKey { /** * @deprecated Please use the 'order' property instead. * Indicates the order of sorting. */ getOrder() : SortOrder; /** * Indicates the order of sorting. */ readonly order : SortOrder; /** * @deprecated Please use the 'index' property instead. * Gets the sorted column index(absolute position, column A is 0, B is 1, ...). */ getIndex() : number; /** * Gets the sorted column index(absolute position, column A is 0, B is 1, ...). */ readonly index : number; /** * @deprecated Please use the 'type' property instead. * Represents the type of sorting. */ getType() : SortOnType; /** * Represents the type of sorting. */ readonly type : SortOnType; /** * @deprecated Please use the 'iconSetType' property instead. * Represents the icon set type. * * @remarks * Only takes effect when is . */ getIconSetType() : IconSetType; /** * Represents the icon set type. * * @remarks * Only takes effect when is . */ readonly iconSetType : IconSetType; /** * @deprecated Please use the 'iconId' property instead. * Represents the id of the icon set type. * * @remarks * Only takes effect when is . */ getIconId() : number; /** * Represents the id of the icon set type. * * @remarks * Only takes effect when is . */ readonly iconId : number; /** * @deprecated Please use the 'color' property instead. * Gets the sorted color. * * @remarks * Only takes effect when is or . */ getColor() : Color; /** * Gets the sorted color. * * @remarks * Only takes effect when is or . */ readonly color : Color; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the light rig direction type. */ export enum LightRigDirectionType { /** * Bottom */ Bottom = 0, /** * Bottom left. */ BottomLeft = 1, /** * Bottom Right. */ BottomRight = 2, /** * Left. */ Left = 3, /** * Right. */ Right = 4, /** * Top. */ Top = 5, /** * Top left. */ TopLeft = 6, /** * Top Right. */ TopRight = 7, } /** * Enumerates the line end width of the shape border line. */ export enum MsoArrowheadLength { /** * Short line end length */ Short = 0, /** * Medium line end length */ Medium = 1, /** * Long line end length */ Long = 2, } /** * Enumerates the line end width of the shape border line. */ export enum MsoArrowheadWidth { /** * Short line end width. */ Narrow = 0, /** * Medium line end width. */ Medium = 1, /** * Wide line end width. */ Wide = 2, } /** * Represents the way the text vertical or horizontal overflow. */ export enum TextOverflowType { /** * Pay attention to top and bottom barriers. * Provide no indication that there is text which is not visible. */ Clip = 0, /** * Pay attention to top and bottom barriers. * Use an ellipsis to denote that there is text which is not visible. * Only for vertical overflow. */ Ellipsis = 1, /** * Overflow the text and pay no attention to top and bottom barriers. */ Overflow = 2, } /** * Provides utility methods for converting file format enums to strings or file extensions and back. */ export class FileFormatUtil { /** * Detects and returns the information about a format of an excel stored in a stream. * @param stream - * @returns * A object that contains the detected information. */ static detectFileFormat(stream: Uint8Array) : FileFormatInfo; /** * Detects and returns the information about a format of an excel stored in a stream. * @param stream - * @param password - The password for encrypted ooxml files. * @returns * Returns whether the password is corrected. */ static verifyPassword(stream: Uint8Array, password: string) : boolean; /** * Converting file format to save format. * @param format - The file format type. */ static fileFormatToSaveFormat(format: FileFormatType) : SaveFormat; /** * Converts a file name extension into a SaveFormat value. * @param extension - The file extension. Can be with or without a leading dot. Case-insensitive. * * @remarks * If the extension cannot be recognized, returns . */ static extensionToSaveFormat(extension: string) : SaveFormat; /** * Returns true if the extension is .xlt, .xltX, .xltm,.ots. * @param extension - */ static isTemplateFormat(extension: string) : boolean; /** * Converts a load format enumerated value into a file extension. * @param loadFormat - The loaded file format. * @returns * The returned extension is a lower-case string with a leading dot. * * @remarks * If it can not be converted, returns null. */ static loadFormatToExtension(loadFormat: LoadFormat) : string; /** * Converts a LoadFormat value to a SaveFormat value if possible. * @param loadFormat - The load format. * @returns * The save format. */ static loadFormatToSaveFormat(loadFormat: LoadFormat) : SaveFormat; /** * Converts a save format enumerated value into a file extension. * @param format - The save format. * @returns * The returned extension is a lower-case string with a leading dot. */ static saveFormatToExtension(format: SaveFormat) : string; /** * Converts a SaveFormat value to a LoadFormat value if possible. * @param saveFormat - The save format. * @returns * The load format */ static saveFormatToLoadFormat(saveFormat: SaveFormat) : LoadFormat; } /** * Represents the paste special type. */ export enum PasteType { /** * Copies all data of the range. */ All = 0, /** * It works as "All" behavior of MS Excel. */ Default = 1, /** * Copies all data of the range without the range. */ AllExceptBorders = 2, /** * It works as "All except borders" behavior of MS Excel. */ DefaultExceptBorders = 3, /** * Only copies the widths of the range. */ ColumnWidths = 4, /** * Only copies the heights of the range. */ RowHeights = 5, /** * Only copies comments in the range. */ Comments = 6, /** * Only copies formats in the range. */ Formats = 7, /** * Only copies formulas in the range. */ Formulas = 8, /** * Only copies formulas and number formats in the range. */ FormulasAndNumberFormats = 9, /** * Only copies validations in the range. */ Validation = 10, /** * Only copies values in the range. */ Values = 11, /** * Only copies values and formats in the range. */ ValuesAndFormats = 12, /** * Only copies values and number formats in the range. */ ValuesAndNumberFormats = 13, } /** * Represents the memory cache for some PivotTable reports. * * @remarks * All data will be gathered into this cache,and the pivot table only get data from this cache,not directly access data source. * If data source of some s are same, they will use a pivot cache. */ export class PivotCache { /** * Gets the . */ getSourceType() : PivotTableSourceType; /** * Release all resource. */ dispose() : void; /** * Refreshes data from the data source and calculates data for the view of all pivottables which data source is this pivot cache. * @param option - The options for refreshing data source of pivot table. * * @remarks * It's better that you can simply call to refresh all pivot tables and charts in the file. */ refresh(option: PivotTableRefreshOption) : PivotRefreshState; /** * Refreshes data from the data source and calculates data for the view of all pivottables which data source is this pivot cache. * * @remarks * If both table1 and table2 use this cache, the two table will calculated. * It's better that you can simply call to refresh all pivot tables and charts in the file. */ refresh() : PivotRefreshState; /** * Gets all pivot tables with this pivot cache. */ getPivotTables() : PivotTable[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the collection of memory caches from the PivotTable reports in a workbook. */ export class PivotCacheCollection implements Iterable { /** * Gets the pivot table cache at the specified index. */ get(index: number) : PivotCache; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents a collection of all the PivotField objects * in the PivotTable's specific PivotFields type. */ export class PivotFieldCollection implements Iterable { /** * Gets the PivotField Object at the specific index. */ get(index: number) : PivotField; /** * Gets the PivotField Object of the specific name. */ get(name: string) : PivotField; /** * @deprecated Please use the 'type' property instead. * Gets the PivotFields type. */ getType() : PivotFieldType; /** * Gets the PivotFields type. */ readonly type : PivotFieldType; /** * @deprecated Please use the 'count' property instead. * Gets the count of the pivotFields. */ getCount() : number; /** * Gets the count of the pivotFields. */ readonly count : number; /** * Gets an enumerator over the elements in this collection in proper sequence. * @returns * enumerator */ getEnumerator() : PivotFieldEnumerator; /** * Adds a PivotField Object to the specific type PivotFields. * @param baseFieldIndex - field index in the base PivotFields. * @returns * the index of the PivotField Object in this PivotFields. */ addByBaseIndex(baseFieldIndex: number) : number; /** * Adds a PivotField Object to the specific type PivotFields. * @param pivotField - a PivotField Object. * @returns * the index of the PivotField Object in this PivotFields. */ add(pivotField: PivotField) : number; /** * clear all fields of PivotFieldCollection */ clear() : void; /** * Moves the PivotField from current position to destination position * @param currPos - Current position of PivotField based on zero * @param destPos - Destination position of PivotField based on zero */ move(currPos: number, destPos: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents data display format in the PivotTable data field. */ export enum PivotFieldDataDisplayFormat { /** * Represents normal display format. */ Normal = 0, /** * Represents difference from display format. */ DifferenceFrom = 1, /** * Represents percentage of display format. */ PercentageOf = 2, /** * Represents percentage difference from display format. */ PercentageDifferenceFrom = 3, /** * Represents running total in display format. */ RunningTotalIn = 4, /** * Represents percentage of row display format. */ PercentageOfRow = 5, /** * Represents percentage of column display format. */ PercentageOfColumn = 6, /** * Represents percentage of total display format. */ PercentageOfTotal = 7, /** * Represents index display format. */ Index = 8, /** * Represents percentage of parent row total display format. */ PercentageOfParentRowTotal = 9, /** * Represents percentage of parent column total display format. */ PercentageOfParentColumnTotal = 10, /** * Represents percentage of parent total display format. */ PercentageOfParentTotal = 11, /** * Represents percentage of running total in display format. */ PercentageOfRunningTotalIn = 12, /** * Represents smallest to largest display format. */ RankSmallestToLargest = 13, /** * Represents largest to smallest display format. */ RankLargestToSmallest = 14, } /** * Summary description for PivotFieldSubtotalType. */ export enum PivotFieldSubtotalType { /** * Represents None subtotal type. */ None = 0, /** * Represents Automatic subtotal type. */ Automatic = 1, /** * Represents Sum subtotal type. */ Sum = 2, /** * Represents Count subtotal type. */ Count = 4, /** * Represents Average subtotal type. */ Average = 8, /** * Represents Max subtotal type. */ Max = 16, /** * Represents Min subtotal type. */ Min = 32, /** * Represents Product subtotal type. */ Product = 64, /** * Represents Count Nums subtotal type. */ CountNums = 128, /** * Represents Standard Deviation subtotal type. */ Stdev = 256, /** * Represents Standard Deviation of a Population subtotal type. */ Stdevp = 512, /** * Represents Variance subtotal type. */ Var = 1024, /** * Represents Variance of a Population subtotal type. */ Varp = 2048, } /** * Represents PivotTable field type. */ export enum PivotFieldType { /** * Presents base pivot field type. */ Undefined = 0, /** * Presents row pivot field type. */ Row = 1, /** * Presents column pivot field type. */ Column = 2, /** * Presents page pivot field type. */ Page = 4, /** * Presents data pivot field type. */ Data = 8, } /** * Represents group by type. */ export enum PivotGroupByType { /** * Group by numbers. * * @remarks * NOTE: This method is now obsolete. Instead, * please use PivotGroupByType.Numbers enum. * This method will be removed 12 months later since October 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotGroupByType.Numbers instead. */ RangeOfValues = 0, /** * Group by numbers. */ Numbers = 0, /** * Presents Seconds groupby type. */ Seconds = 1, /** * Presents Minutes groupby type. */ Minutes = 2, /** * Presents Hours groupby type. */ Hours = 3, /** * Presents Days groupby type. */ Days = 4, /** * Presents Months groupby type. */ Months = 5, /** * Presents Quarters groupby type. */ Quarters = 6, /** * Presents Years groupby type. */ Years = 7, } /** * Represents a item in a PivotField report. */ export class PivotItem { /** * Gets and Sets whether the pivot item is hidden. */ isHidden : boolean; /** * @deprecated Please use the 'isHidden' property instead. * Gets and Sets whether the pivot item is hidden. * @param value - The value to set. */ setIsHidden(value: boolean) : void; /** * @deprecated Please use the 'position' property instead. * Specifying the position index in all the PivotItems,not the PivotItems under the same parent node. */ getPosition() : number; /** * Specifying the position index in all the PivotItems,not the PivotItems under the same parent node. */ position : number; /** * @deprecated Please use the 'position' property instead. * Specifying the position index in all the PivotItems,not the PivotItems under the same parent node. * @param value - The value to set. */ setPosition(value: number) : void; /** * @deprecated Please use the 'positionInSameParentNode' property instead. * Specifying the position index in the PivotItems under the same parent node. */ getPositionInSameParentNode() : number; /** * Specifying the position index in the PivotItems under the same parent node. */ positionInSameParentNode : number; /** * @deprecated Please use the 'positionInSameParentNode' property instead. * Specifying the position index in the PivotItems under the same parent node. * @param value - The value to set. */ setPositionInSameParentNode(value: number) : void; /** * Gets and sets whether the detail of this pivot item is hidden. */ isDetailHidden : boolean; /** * @deprecated Please use the 'isDetailHidden' property instead. * Gets and sets whether the detail of this pivot item is hidden. * @param value - The value to set. */ setIsDetailHidden(value: boolean) : void; /** * Indicates whether this pivot item is a calculated formula item. */ readonly isCalculatedItem : boolean; /** * Indicates whether the item is removed from the data source. * * @remarks * True means this value has been removed from the data source. */ readonly isMissing : boolean; /** * @deprecated Please use the 'value' property instead. * Gets the value of the pivot item */ getValue() : Object; /** * Gets the value of the pivot item */ readonly value : Object; /** * @deprecated Please use the 'name' property instead. * Gets the name of the pivot item. */ getName() : string; /** * Gets the name of the pivot item. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets the name of the pivot item. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'index' property instead. * Gets the index of the pivot item in cache field. */ getIndex() : number; /** * Gets the index of the pivot item in cache field. */ index : number; /** * @deprecated Please use the 'index' property instead. * Gets the index of the pivot item in cache field. * @param value - The value to set. */ setIndex(value: number) : void; /** * Moves the item up or down * @param count - The number of moving up or down. /// Move the item up if this is less than zero; /// Move the item down if this is greater than zero. * @param isSameParent - Specifying whether moving operation is in the same parent node or not */ move(count: number, isSameParent: boolean) : void; /** * Gets the formula of this calculated item. * Only works when this item is calculated item. */ getFormula() : string; /** * Gets the string value of the pivot item * If the value is null, it will return "" */ getStringValue() : string; /** * Gets the double value of the pivot item * If the value is null or not number ,it will return 0 */ getDoubleValue() : number; /** * Gets the date time value of the pivot item * If the value is null ,it will return DateTime.MinValue */ getDateTimeValue() : Date; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all the objects in the PivotField. */ export class PivotItemCollection implements Iterable { /** * Gets the PivotItem Object at the specific index. */ get(index: number) : PivotItem; /** * Gets the by the specific name. */ get(itemValue: string) : PivotItem; /** * @deprecated Please use the 'count' property instead. * Gets the count of the pivot items. */ getCount() : number; /** * Gets the count of the pivot items. */ readonly count : number; /** * Gets an enumerator over the elements in this collection in proper sequence. * @returns * enumerator */ getEnumerator() : PivotItemEnumerator; /** * Directly swap two items. * @param index1 - * @param index2 - */ swapItem(index1: number, index2: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents base item Next/Previous/All position in the base field . * * @remarks * NOTE: This enum is now obsolete. Instead, * please use PivotItemPositionType enum instead. * This method will be removed 12 months later since June 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PivotItemPositionType enum instead. */ export enum PivotItemPosition { /** * Represents the previous pivot item in the PivotField. */ Previous = 0, /** * Represents the next pivot item in the PivotField. */ Next = 1, /** * Shows values as the different format based the index of pivot item in the PivotField. * * @remarks * Only for getting. */ Custom = 2, } /** * Represents the pivot page items * if the pivot table data source is consolidation ranges. * It only can contain up to 4 items. */ export class PivotPageFields { /** * Represents the pivot page field items. */ constructor(); /** * @deprecated Please use the 'pageFieldCount' property instead. * Gets the number of page fields. */ getPageFieldCount() : number; /** * Gets the number of page fields. */ readonly pageFieldCount : number; /** * Adds a page field. * @param pageItems - Page field item label */ addPageField(pageItems: string[]) : void; /** * Sets which item label in each page field to use to identify the data range. * The pageItemIndex.Length must be equal to PageFieldCount, so please add the page field first. * @param rangeIndex - The consolidation data range index. * @param pageItemIndex - The page item index in the each page field. /// pageItemIndex[2] = 1 means the second item in the third field to use to identify this range. /// pageItemIndex[1] = -1 means no item in the second field to use to identify this range /// and MS will auto create "blank" item in the second field to identify this range. */ addIdentify(rangeIndex: number, pageItemIndex: number[]) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents PivotTable auto format type. */ export enum PivotTableAutoFormatType { /** * Represents None format type. */ None = 0, /** * Represents Classic auto format type. */ Classic = 1, /** * Represents Report1 format type. */ Report1 = 2, /** * Represents Report2 format type. */ Report2 = 3, /** * Represents Report3 format type. */ Report3 = 4, /** * Represents Report4 format type. */ Report4 = 5, /** * Represents Report5 format type. */ Report5 = 6, /** * Represents Report6 format type. */ Report6 = 7, /** * Represents Report7 format type. */ Report7 = 8, /** * Represents Report8 format type. */ Report8 = 9, /** * Represents Report9 format type. */ Report9 = 10, /** * Represents Report10 format type. */ Report10 = 11, /** * Represents Table1 format type. */ Table1 = 12, /** * Represents Table2 format type. */ Table2 = 13, /** * Represents Table3 format type. */ Table3 = 14, /** * Represents Table4 format type. */ Table4 = 15, /** * Represents Table5 format type. */ Table5 = 16, /** * Represents Table6 format type. */ Table6 = 17, /** * Represents Table7 format type. */ Table7 = 18, /** * Represents Table8 format type. */ Table8 = 19, /** * Represents Table9 format type. */ Table9 = 20, /** * Represents Table10 format type. */ Table10 = 21, } /** * Represents the collection of all the PivotTable objects on the specified worksheet. */ export class PivotTableCollection implements Iterable { /** * Gets the PivotTable report by index. */ get(index: number) : PivotTable; /** * Gets the PivotTable report by pivottable's name. */ get(name: string) : PivotTable; /** * Gets the PivotTable report by pivottable's position. */ get(row: number, column: number) : PivotTable; /** * Performs application-defined tasks associated with freeing, releasing, or * resetting unmanaged resources. */ dispose() : void; /** * Adds a new PivotTable. * @param sourceData - The data for the new PivotTable cache. * @param destCellName - The cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @returns * The new added cache index. */ add(sourceData: string, destCellName: string, tableName: string) : number; /** * Adds a new PivotTable. * @param sourceData - The data for the new PivotTable cache. * @param destCellName - The cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @param useSameSource - Indicates whether using same data source when another existing pivot table has used this data source. /// If the property is true, it will save memory. * @returns * The new added cache index. */ add(sourceData: string, destCellName: string, tableName: string, useSameSource: boolean) : number; /** * Adds a new PivotTable. * @param sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8 * @param row - Row index of the cell in the upper-left corner of the PivotTable report's destination range. * @param column - Column index of the cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @returns * The new added cache index. */ add(sourceData: string, row: number, column: number, tableName: string) : number; /** * Adds a new PivotTable. * @param sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8 * @param row - Row index of the cell in the upper-left corner of the PivotTable report's destination range. * @param column - Column index of the cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @param useSameSource - Indicates whether using same data source when another existing pivot table has used this data source. /// If the property is true, it will save memory. * @returns * The new added cache index. */ add(sourceData: string, row: number, column: number, tableName: string, useSameSource: boolean) : number; /** * Adds a new PivotTable. * @param sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8 * @param row - Row index of the cell in the upper-left corner of the PivotTable report's destination range. * @param column - Column index of the cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @param useSameSource - Indicates whether using same data source when another existing pivot table has used this data source. /// If the property is true, it will save memory. * @param isXlsClassic - Indicates whether add classic pivot table of Excel 97-2003. * @returns * The new added cache index. */ add(sourceData: string, row: number, column: number, tableName: string, useSameSource: boolean, isXlsClassic: boolean) : number; /** * Adds a new PivotTable. * @param sourceData - The data cell range for the new PivotTable.Example : Sheet1!A1:C8 * @param cell - The cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @param useSameSource - Indicates whether using same data source when another existing pivot table has used this data source. /// If the property is true, it will save memory. * @param isXlsClassic - Indicates whether add classic pivot table of Excel 97-2003. * @returns * The new added cache index. */ add(sourceData: string, cell: string, tableName: string, useSameSource: boolean, isXlsClassic: boolean) : number; /** * Adds a new PivotTable based on another PivotTable. * @param pivotTable - The source pivotTable. * @param destCellName - The cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @returns * The new added PivotTable index. */ add(pivotTable: PivotTable, destCellName: string, tableName: string) : number; /** * Adds a new PivotTable based on another PivotTable. * @param pivotTable - The source pivotTable. * @param row - Row index of the cell in the upper-left corner of the PivotTable report's destination range. * @param column - Column index of the cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @returns * The new added PivotTable index. */ add(pivotTable: PivotTable, row: number, column: number, tableName: string) : number; /** * Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source. * @param sourceData - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"} * @param isAutoPage - Whether auto create a single page field. /// If true,the following param pageFields will be ignored. * @param pageFields - The pivot page field items. * @param destCellName - destCellName The name of the new PivotTable report. * @param tableName - the name of the new PivotTable report. * @returns * The new added PivotTable index. */ add(sourceData: string[], isAutoPage: boolean, pageFields: PivotPageFields, destCellName: string, tableName: string) : number; /** * Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source. * @param sourceData - The multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"} * @param isAutoPage - Whether auto create a single page field. /// If true,the following param pageFields will be ignored * @param pageFields - The pivot page field items. * @param row - Row index of the cell in the upper-left corner of the PivotTable report's destination range. * @param column - Column index of the cell in the upper-left corner of the PivotTable report's destination range. * @param tableName - The name of the new PivotTable report. * @returns * The new added PivotTable index. */ add(sourceData: string[], isAutoPage: boolean, pageFields: PivotPageFields, row: number, column: number, tableName: string) : number; /** * Clears all pivot tables. */ clear() : void; /** * Deletes the specified PivotTable and delete the PivotTable data * @param pivotTable - PivotTable object */ remove(pivotTable: PivotTable) : void; /** * Deletes the specified PivotTable * @param pivotTable - PivotTable object * @param keepData - Whether to keep the PivotTable data */ remove(pivotTable: PivotTable, keepData: boolean) : void; /** * Deletes the PivotTable at the specified index and delete the PivotTable data * @param index - the position index in PivotTable collection */ removeAt(index: number) : void; /** * Deletes the PivotTable at the specified index * @param index - the position index in PivotTable collection * @param keepData - Whether to keep the PivotTable data */ removeAt(index: number, keepData: boolean) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents data source type of the pivot table. */ export enum PivotTableSourceType { /** * Specifies that the source data is a range. */ Sheet = 1, /** * Specifies that external source data is used. */ External = 2, /** * Specifies that multiple consolidation ranges are used as the source data. */ Consolidation = 4, /** * The source data is populated from a temporary internal structure. */ Scenario = 8, /** * Unknown data source. */ Unknown = 9, } /** * Represents the pivot table style type. */ export enum PivotTableStyleType { /** */ None = 0, /** */ PivotTableStyleLight1 = 1, /** */ PivotTableStyleLight2 = 2, /** */ PivotTableStyleLight3 = 3, /** */ PivotTableStyleLight4 = 4, /** */ PivotTableStyleLight5 = 5, /** */ PivotTableStyleLight6 = 6, /** */ PivotTableStyleLight7 = 7, /** */ PivotTableStyleLight8 = 8, /** */ PivotTableStyleLight9 = 9, /** */ PivotTableStyleLight10 = 10, /** */ PivotTableStyleLight11 = 11, /** */ PivotTableStyleLight12 = 12, /** */ PivotTableStyleLight13 = 13, /** */ PivotTableStyleLight14 = 14, /** */ PivotTableStyleLight15 = 15, /** */ PivotTableStyleLight16 = 16, /** */ PivotTableStyleLight17 = 17, /** */ PivotTableStyleLight18 = 18, /** */ PivotTableStyleLight19 = 19, /** */ PivotTableStyleLight20 = 20, /** */ PivotTableStyleLight21 = 21, /** */ PivotTableStyleLight22 = 22, /** */ PivotTableStyleLight23 = 23, /** */ PivotTableStyleLight24 = 24, /** */ PivotTableStyleLight25 = 25, /** */ PivotTableStyleLight26 = 26, /** */ PivotTableStyleLight27 = 27, /** */ PivotTableStyleLight28 = 28, /** */ PivotTableStyleMedium1 = 29, /** */ PivotTableStyleMedium2 = 30, /** */ PivotTableStyleMedium3 = 31, /** */ PivotTableStyleMedium4 = 32, /** */ PivotTableStyleMedium5 = 33, /** */ PivotTableStyleMedium6 = 34, /** */ PivotTableStyleMedium7 = 35, /** */ PivotTableStyleMedium8 = 36, /** */ PivotTableStyleMedium9 = 37, /** */ PivotTableStyleMedium10 = 38, /** */ PivotTableStyleMedium11 = 39, /** */ PivotTableStyleMedium12 = 40, /** */ PivotTableStyleMedium13 = 41, /** */ PivotTableStyleMedium14 = 42, /** */ PivotTableStyleMedium15 = 43, /** */ PivotTableStyleMedium16 = 44, /** */ PivotTableStyleMedium17 = 45, /** */ PivotTableStyleMedium18 = 46, /** */ PivotTableStyleMedium19 = 47, /** */ PivotTableStyleMedium20 = 48, /** */ PivotTableStyleMedium21 = 49, /** */ PivotTableStyleMedium22 = 50, /** */ PivotTableStyleMedium23 = 51, /** */ PivotTableStyleMedium24 = 52, /** */ PivotTableStyleMedium25 = 53, /** */ PivotTableStyleMedium26 = 54, /** */ PivotTableStyleMedium27 = 55, /** */ PivotTableStyleMedium28 = 56, /** */ PivotTableStyleDark1 = 57, /** */ PivotTableStyleDark2 = 58, /** */ PivotTableStyleDark3 = 59, /** */ PivotTableStyleDark4 = 60, /** */ PivotTableStyleDark5 = 61, /** */ PivotTableStyleDark6 = 62, /** */ PivotTableStyleDark7 = 63, /** */ PivotTableStyleDark8 = 64, /** */ PivotTableStyleDark9 = 65, /** */ PivotTableStyleDark10 = 66, /** */ PivotTableStyleDark11 = 67, /** */ PivotTableStyleDark12 = 68, /** */ PivotTableStyleDark13 = 69, /** */ PivotTableStyleDark14 = 70, /** */ PivotTableStyleDark15 = 71, /** */ PivotTableStyleDark16 = 72, /** */ PivotTableStyleDark17 = 73, /** */ PivotTableStyleDark18 = 74, /** */ PivotTableStyleDark19 = 75, /** */ PivotTableStyleDark20 = 76, /** */ PivotTableStyleDark21 = 77, /** */ PivotTableStyleDark22 = 78, /** */ PivotTableStyleDark23 = 79, /** */ PivotTableStyleDark24 = 80, /** */ PivotTableStyleDark25 = 81, /** */ PivotTableStyleDark26 = 82, /** */ PivotTableStyleDark27 = 83, /** */ PivotTableStyleDark28 = 84, /** */ Custom = 85, } /** * Represents the filter of for . */ export class PivotAreaFilter { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'fieldIndex' property instead. * Gets the index of the field which this filter refers to. * A value of -2 indicates the values field. */ getFieldIndex() : number; /** * Gets the index of the field which this filter refers to. * A value of -2 indicates the values field. */ readonly fieldIndex : number; /** * @deprecated Please use the 'selected' property instead. * Indicates whether this field has selection. * Only works when the PivotTable is in Outline view. */ getSelected() : boolean; /** * Indicates whether this field has selection. * Only works when the PivotTable is in Outline view. */ selected : boolean; /** * @deprecated Please use the 'selected' property instead. * Indicates whether this field has selection. * Only works when the PivotTable is in Outline view. * @param value - The value to set. */ setSelected(value: boolean) : void; /** * Gets which subtotal is set for this filter. * @param subtotalType - The subtotal function type. */ isSubtotalSet(subtotalType: PivotFieldSubtotalType) : boolean; /** * Subtotal for the filter. * @param subtotalType - The subtotal function. * @param shown - Indicates if showing this subtotal data. */ setSubtotals(subtotalType: PivotFieldSubtotalType, shown: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the format defined in the PivotTable. */ export class PivotTableFormat { /** * @deprecated Please use the 'pivotArea' property instead. * Gets the pivot area. */ getPivotArea() : PivotArea; /** * Gets the pivot area. */ readonly pivotArea : PivotArea; /** * Gets the formatted style. */ getStyle() : Style; /** * Sets the style of the pivot area. * @param style - */ setStyle(style: Style) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Presents the selected area of the PivotTable. */ export class PivotArea { /** * Presents the selected area of the PivotTable. * @param table - */ constructor(table: PivotTable); /** * @deprecated Please use the 'filters' property instead. * Gets all filters for this PivotArea. */ getFilters() : PivotAreaFilterCollection; /** * Gets all filters for this PivotArea. */ readonly filters : PivotAreaFilterCollection; /** * @deprecated Please use the 'onlyData' property instead. * Indicates whether only the data values (in the data area of the view) for an item * selection are selected and does not include the item labels. */ getOnlyData() : boolean; /** * Indicates whether only the data values (in the data area of the view) for an item * selection are selected and does not include the item labels. */ onlyData : boolean; /** * @deprecated Please use the 'onlyData' property instead. * Indicates whether only the data values (in the data area of the view) for an item * selection are selected and does not include the item labels. * @param value - The value to set. */ setOnlyData(value: boolean) : void; /** * @deprecated Please use the 'onlyLabel' property instead. * Indicates whether only the data labels for an item selection are selected. */ getOnlyLabel() : boolean; /** * Indicates whether only the data labels for an item selection are selected. */ onlyLabel : boolean; /** * @deprecated Please use the 'onlyLabel' property instead. * Indicates whether only the data labels for an item selection are selected. * @param value - The value to set. */ setOnlyLabel(value: boolean) : void; /** * Indicates whether the row grand total is included. */ isRowGrandIncluded : boolean; /** * @deprecated Please use the 'isRowGrandIncluded' property instead. * Indicates whether the row grand total is included. * @param value - The value to set. */ setIsRowGrandIncluded(value: boolean) : void; /** * Indicates whether the column grand total is included. */ isColumnGrandIncluded : boolean; /** * @deprecated Please use the 'isColumnGrandIncluded' property instead. * Indicates whether the column grand total is included. * @param value - The value to set. */ setIsColumnGrandIncluded(value: boolean) : void; /** * @deprecated Please use the 'axisType' property instead. * Gets and sets the region of the PivotTable to which this rule applies. */ getAxisType() : PivotFieldType; /** * Gets and sets the region of the PivotTable to which this rule applies. */ axisType : PivotFieldType; /** * @deprecated Please use the 'axisType' property instead. * Gets and sets the region of the PivotTable to which this rule applies. * @param value - The value to set. */ setAxisType(value: PivotFieldType) : void; /** * @deprecated Please use the 'ruleType' property instead. * Gets and sets the type of selection rule. */ getRuleType() : PivotAreaType; /** * Gets and sets the type of selection rule. */ ruleType : PivotAreaType; /** * @deprecated Please use the 'ruleType' property instead. * Gets and sets the type of selection rule. * @param value - The value to set. */ setRuleType(value: PivotAreaType) : void; /** * Indicates whether the rule refers to an area that is in outline mode. */ isOutline : boolean; /** * @deprecated Please use the 'isOutline' property instead. * Indicates whether the rule refers to an area that is in outline mode. * @param value - The value to set. */ setIsOutline(value: boolean) : void; /** * Select the area with filters. * @param axisType - The region of the PivotTable to which this rule applies. * @param fieldPosition - Position of the field within the axis to which this rule applies. * @param selectionType - Specifies what can be selected in a PivotTable during a structured selection. */ select(axisType: PivotFieldType, fieldPosition: number, selectionType: PivotTableSelectionType) : void; /** * Select a field in the region as an area. * @param axisType - The region type. * @param fieldName - The name of pivot field. */ selectField(axisType: PivotFieldType, fieldName: string) : void; /** * Select a field in the region as an area. * @param axisType - The region type. * @param field - The pivot field. */ selectField(axisType: PivotFieldType, field: PivotField) : void; /** * Gets cell areas of this pivot area. */ getCellAreas() : CellArea[]; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describe the ColorScale conditional formatting rule. * This conditional formatting rule creates a gradated color scale on the cells. */ export class ColorScale { /** * @deprecated Please use the 'is3ColorScale' property instead. * Indicates whether conditional formatting is 3 color scale. */ getIs3ColorScale() : boolean; /** * Indicates whether conditional formatting is 3 color scale. */ is3ColorScale : boolean; /** * @deprecated Please use the 'is3ColorScale' property instead. * Indicates whether conditional formatting is 3 color scale. * @param value - The value to set. */ setIs3ColorScale(value: boolean) : void; /** * @deprecated Please use the 'minCfvo' property instead. * Get or set this ColorScale's min value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. */ getMinCfvo() : ConditionalFormattingValue; /** * Get or set this ColorScale's min value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. */ readonly minCfvo : ConditionalFormattingValue; /** * @deprecated Please use the 'midCfvo' property instead. * Get or set this ColorScale's mid value object. * Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it. */ getMidCfvo() : ConditionalFormattingValue; /** * Get or set this ColorScale's mid value object. * Cannot set CFValueObject with type FormatConditionValueType.Max or FormatConditionValueType.Min to it. */ readonly midCfvo : ConditionalFormattingValue; /** * @deprecated Please use the 'maxCfvo' property instead. * Get or set this ColorScale's max value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. */ getMaxCfvo() : ConditionalFormattingValue; /** * Get or set this ColorScale's max value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. */ readonly maxCfvo : ConditionalFormattingValue; /** * @deprecated Please use the 'minColor' property instead. * Get or set the gradient color for the minimum value in the range. */ getMinColor() : Color; /** * Get or set the gradient color for the minimum value in the range. */ minColor : Color; /** * @deprecated Please use the 'minColor' property instead. * Get or set the gradient color for the minimum value in the range. * @param value - The value to set. */ setMinColor(value: Color) : void; /** * @deprecated Please use the 'midColor' property instead. * Get or set the gradient color for the middle value in the range. */ getMidColor() : Color; /** * Get or set the gradient color for the middle value in the range. */ midColor : Color; /** * @deprecated Please use the 'midColor' property instead. * Get or set the gradient color for the middle value in the range. * @param value - The value to set. */ setMidColor(value: Color) : void; /** * @deprecated Please use the 'maxColor' property instead. * Get or set the gradient color for the maximum value in the range. */ getMaxColor() : Color; /** * Get or set the gradient color for the maximum value in the range. */ maxColor : Color; /** * @deprecated Please use the 'maxColor' property instead. * Get or set the gradient color for the maximum value in the range. * @param value - The value to set. */ setMaxColor(value: Color) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describes the values of the interpolation points in a gradient scale, dataBar or iconSet. */ export class ConditionalFormattingValue { /** * @deprecated Please use the 'value' property instead. * Get or set the value of this conditional formatting value object. * It should be used in conjunction with Type. * * @remarks * If the value is string and start with "=", it will be processed as a formula, * otherwise we will process it as a simple value. */ getValue() : Object; /** * Get or set the value of this conditional formatting value object. * It should be used in conjunction with Type. * * @remarks * If the value is string and start with "=", it will be processed as a formula, * otherwise we will process it as a simple value. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Get or set the value of this conditional formatting value object. * It should be used in conjunction with Type. * @param value - The value to set. * * @remarks * If the value is string and start with "=", it will be processed as a formula, * otherwise we will process it as a simple value. */ setValue(value: Object) : void; /** * @deprecated Please use the 'type' property instead. * Get or set the type of this conditional formatting value object. * Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max * will auto set "Value" to null. */ getType() : FormatConditionValueType; /** * Get or set the type of this conditional formatting value object. * Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max * will auto set "Value" to null. */ type : FormatConditionValueType; /** * @deprecated Please use the 'type' property instead. * Get or set the type of this conditional formatting value object. * Setting the type to FormatConditionValueType.Min or FormatConditionValueType.Max * will auto set "Value" to null. * @param value - The value to set. */ setType(value: FormatConditionValueType) : void; /** * Get or set the Greater Than Or Equal flag. * Use only for icon sets, determines whether this threshold value uses * the greater than or equal to operator. * 'false' indicates 'greater than' is used instead of 'greater than or equal to'. * Default value is true. */ isGTE : boolean; /** * @deprecated Please use the 'isGTE' property instead. * Get or set the Greater Than Or Equal flag. * Use only for icon sets, determines whether this threshold value uses * the greater than or equal to operator. * 'false' indicates 'greater than' is used instead of 'greater than or equal to'. * Default value is true. * @param value - The value to set. */ setIsGTE(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describe the DataBar conditional formatting rule. * This conditional formatting rule displays a gradated * data bar in the range of cells. */ export class DataBar { /** * @deprecated Please use the 'axisColor' property instead. * Gets the color of the axis for cells with conditional formatting as data bars. */ getAxisColor() : Color; /** * Gets the color of the axis for cells with conditional formatting as data bars. */ axisColor : Color; /** * @deprecated Please use the 'axisColor' property instead. * Gets the color of the axis for cells with conditional formatting as data bars. * @param value - The value to set. */ setAxisColor(value: Color) : void; /** * @deprecated Please use the 'axisPosition' property instead. * Gets or sets the position of the axis of the data bars specified by a conditional formatting rule. */ getAxisPosition() : DataBarAxisPosition; /** * Gets or sets the position of the axis of the data bars specified by a conditional formatting rule. */ axisPosition : DataBarAxisPosition; /** * @deprecated Please use the 'axisPosition' property instead. * Gets or sets the position of the axis of the data bars specified by a conditional formatting rule. * @param value - The value to set. */ setAxisPosition(value: DataBarAxisPosition) : void; /** * @deprecated Please use the 'barFillType' property instead. * Gets or sets how a data bar is filled with color. */ getBarFillType() : DataBarFillType; /** * Gets or sets how a data bar is filled with color. */ barFillType : DataBarFillType; /** * @deprecated Please use the 'barFillType' property instead. * Gets or sets how a data bar is filled with color. * @param value - The value to set. */ setBarFillType(value: DataBarFillType) : void; /** * @deprecated Please use the 'direction' property instead. * Gets or sets the direction the databar is displayed. */ getDirection() : TextDirectionType; /** * Gets or sets the direction the databar is displayed. */ direction : TextDirectionType; /** * @deprecated Please use the 'direction' property instead. * Gets or sets the direction the databar is displayed. * @param value - The value to set. */ setDirection(value: TextDirectionType) : void; /** * @deprecated Please use the 'barBorder' property instead. * Gets an object that specifies the border of a data bar. */ getBarBorder() : DataBarBorder; /** * Gets an object that specifies the border of a data bar. */ readonly barBorder : DataBarBorder; /** * @deprecated Please use the 'negativeBarFormat' property instead. * Gets the NegativeBarFormat object associated with a data bar conditional formatting rule. */ getNegativeBarFormat() : NegativeBarFormat; /** * Gets the NegativeBarFormat object associated with a data bar conditional formatting rule. */ readonly negativeBarFormat : NegativeBarFormat; /** * @deprecated Please use the 'minCfvo' property instead. * Get or set this DataBar's min value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. */ getMinCfvo() : ConditionalFormattingValue; /** * Get or set this DataBar's min value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Max to it. */ readonly minCfvo : ConditionalFormattingValue; /** * @deprecated Please use the 'maxCfvo' property instead. * Get or set this DataBar's max value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. */ getMaxCfvo() : ConditionalFormattingValue; /** * Get or set this DataBar's max value object. * Cannot set null or CFValueObject with type FormatConditionValueType.Min to it. */ readonly maxCfvo : ConditionalFormattingValue; /** * @deprecated Please use the 'color' property instead. * Get or set this DataBar's Color. */ getColor() : Color; /** * Get or set this DataBar's Color. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Get or set this DataBar's Color. * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'minLength' property instead. * Represents the min length of data bar . */ getMinLength() : number; /** * Represents the min length of data bar . */ minLength : number; /** * @deprecated Please use the 'minLength' property instead. * Represents the min length of data bar . * @param value - The value to set. */ setMinLength(value: number) : void; /** * @deprecated Please use the 'maxLength' property instead. * Represents the max length of data bar . */ getMaxLength() : number; /** * Represents the max length of data bar . */ maxLength : number; /** * @deprecated Please use the 'maxLength' property instead. * Represents the max length of data bar . * @param value - The value to set. */ setMaxLength(value: number) : void; /** * @deprecated Please use the 'showValue' property instead. * Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. * Default value is true. */ getShowValue() : boolean; /** * Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. * Default value is true. */ showValue : boolean; /** * @deprecated Please use the 'showValue' property instead. * Get or set the flag indicating whether to show the values of the cells on which this data bar is applied. * Default value is true. * @param value - The value to set. */ setShowValue(value: boolean) : void; /** * Render data bar in cell to image byte array. * @param cell - Indicate the data bar in which cell to be rendered * @param imgOpts - ImageOrPrintOptions contains some property of output image */ toImage(cell: Cell, imgOpts: ImageOrPrintOptions) : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describe the IconSet conditional formatting rule. * This conditional formatting rule applies icons to cells * according to their values. */ export class IconSet { /** * @deprecated Please use the 'cfIcons' property instead. * Get the from the collection */ getCfIcons() : ConditionalFormattingIconCollection; /** * Get the from the collection */ readonly cfIcons : ConditionalFormattingIconCollection; /** * @deprecated Please use the 'cfvos' property instead. * Get the CFValueObjects instance. */ getCfvos() : ConditionalFormattingValueCollection; /** * Get the CFValueObjects instance. */ readonly cfvos : ConditionalFormattingValueCollection; /** * @deprecated Please use the 'type' property instead. * Get or Set the icon set type to display. * Setting the type will auto check if the current Cfvos's count is * accord with the new type. If not accord, old Cfvos will be cleaned and * default Cfvos will be added. */ getType() : IconSetType; /** * Get or Set the icon set type to display. * Setting the type will auto check if the current Cfvos's count is * accord with the new type. If not accord, old Cfvos will be cleaned and * default Cfvos will be added. */ type : IconSetType; /** * @deprecated Please use the 'type' property instead. * Get or Set the icon set type to display. * Setting the type will auto check if the current Cfvos's count is * accord with the new type. If not accord, old Cfvos will be cleaned and * default Cfvos will be added. * @param value - The value to set. */ setType(value: IconSetType) : void; /** * Indicates whether the icon set is custom. * Default value is false. */ readonly isCustom : boolean; /** * @deprecated Please use the 'showValue' property instead. * Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. * Default value is true. */ getShowValue() : boolean; /** * Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. * Default value is true. */ showValue : boolean; /** * @deprecated Please use the 'showValue' property instead. * Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. * Default value is true. * @param value - The value to set. */ setShowValue(value: boolean) : void; /** * @deprecated Please use the 'reverse' property instead. * Get or set the flag indicating whether to reverses the default order of the icons in this icon set. * Default value is false. */ getReverse() : boolean; /** * Get or set the flag indicating whether to reverses the default order of the icons in this icon set. * Default value is false. */ reverse : boolean; /** * @deprecated Please use the 'reverse' property instead. * Get or set the flag indicating whether to reverses the default order of the icons in this icon set. * Default value is false. * @param value - The value to set. */ setReverse(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * A specified range to be allowed to edit when the sheet protection is ON. */ export class ProtectedRange { /** * @deprecated Please use the 'name' property instead. * Gets the Range title. This is used as a descriptor, not as a named range definition. */ getName() : string; /** * Gets the Range title. This is used as a descriptor, not as a named range definition. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets the Range title. This is used as a descriptor, not as a named range definition. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'cellArea' property instead. * Gets the object represents the cell area to be protected. */ getCellArea() : CellArea; /** * Gets the object represents the cell area to be protected. */ readonly cellArea : CellArea; /** * Indicates whether the worksheets is protected with password. */ readonly isProtectedWithPassword : boolean; /** * @deprecated Please use the 'password' property instead. * Represents the password to protect the range. */ getPassword() : string; /** * Represents the password to protect the range. */ password : string; /** * @deprecated Please use the 'password' property instead. * Represents the password to protect the range. * @param value - The value to set. */ setPassword(value: string) : void; /** * @deprecated Please use the 'securityDescriptor' property instead. * The security descriptor defines user accounts who may edit this range without providing a password to access the range. */ getSecurityDescriptor() : string; /** * The security descriptor defines user accounts who may edit this range without providing a password to access the range. */ securityDescriptor : string; /** * @deprecated Please use the 'securityDescriptor' property instead. * The security descriptor defines user accounts who may edit this range without providing a password to access the range. * @param value - The value to set. */ setSecurityDescriptor(value: string) : void; /** * Gets all referred areas. * @returns * Returns all referred areas. */ getAreas() : CellArea[]; /** * Adds a referred area to this * @param startRow - The start row. * @param startColumn - The start column. * @param endRow - The end row. * @param endColumn - The end column. */ addArea(startRow: number, startColumn: number, endRow: number, endColumn: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a collection of objects. */ export class ProtectedRangeCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : ProtectedRange; /** * Adds a item to the collection. * @param name - Range title. This is used as a descriptor, not as a named range definition. * @param startRow - Start row index of the range. * @param startColumn - Start column index of the range. * @param endRow - End row index of the range. * @param endColumn - End column index of the range. * @returns * object index. */ add(name: string, startRow: number, startColumn: number, endRow: number, endColumn: number) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents setting for filtering the range by color. */ export class ColorFilter { /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * @deprecated Please use the 'filterByFillColor' property instead. * Whether filter by the cell's fill color. * * @remarks * True: cell's fill color; False: cell's font color. */ getFilterByFillColor() : boolean; /** * Whether filter by the cell's fill color. * * @remarks * True: cell's fill color; False: cell's font color. */ filterByFillColor : boolean; /** * @deprecated Please use the 'filterByFillColor' property instead. * Whether filter by the cell's fill color. * @param value - The value to set. * * @remarks * True: cell's fill color; False: cell's font color. */ setFilterByFillColor(value: boolean) : void; /** * Gets the color of this filter. * @param sheets - */ getColor(sheets: WorksheetCollection) : Color; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; } /** * Represents the custom filter. */ export class CustomFilter { /** * @deprecated Please use the 'filterOperatorType' property instead. * Gets and sets the filter operator type. */ getFilterOperatorType() : FilterOperatorType; /** * Gets and sets the filter operator type. */ filterOperatorType : FilterOperatorType; /** * @deprecated Please use the 'filterOperatorType' property instead. * Gets and sets the filter operator type. * @param value - The value to set. */ setFilterOperatorType(value: FilterOperatorType) : void; /** * @deprecated Please use the 'criteria' property instead. * Gets and sets the criteria. */ getCriteria() : Object; /** * Gets and sets the criteria. */ criteria : Object; /** * @deprecated Please use the 'criteria' property instead. * Gets and sets the criteria. * @param value - The value to set. */ setCriteria(value: Object) : void; /** * Sets the filter criteria. * @param filterOperator - filter operator type * @param criteria - filter criteria value */ setCriteria(filterOperator: FilterOperatorType, criteria: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the custom filters. */ export class CustomFilterCollection implements Iterable { /** * Constructs new instance. * * @remarks * NOTE: This member is now obsolete. * Instead,please set FilterColumn.FilterType as FilterType.CustomFilters then get FilterColumn.CustomFilters. * This property will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FilterColumn.CustomFilters, instead. */ constructor(); /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * Gets the custom filter in the specific index. * @param index - The index. */ get(index: number) : CustomFilter; /** * @deprecated Please use the 'and' property instead. * Indicates whether the two criteria have an "and" relationship. */ getAnd() : boolean; /** * Indicates whether the two criteria have an "and" relationship. */ and : boolean; /** * @deprecated Please use the 'and' property instead. * Indicates whether the two criteria have an "and" relationship. * @param value - The value to set. */ setAnd(value: boolean) : void; /** * Filters a list with custom criteria. */ custom(operatorType1: FilterOperatorType, criteria1: Object, isAnd: boolean, operatorType2: FilterOperatorType, criteria2: Object) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the datetime group setting. */ export class DateTimeGroupItem { /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * @param type - * @param year - * @param month - * @param day - * @param hour - * @param minute - * @param second - */ constructor(type: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number); /** * @deprecated Please use the 'minValue' property instead. * Gets the min value. */ getMinValue() : Date; /** * Gets the min value. */ readonly minValue : Date; /** * @deprecated Please use the 'dateTimeGroupingType' property instead. * Gets and sets the group type. */ getDateTimeGroupingType() : DateTimeGroupingType; /** * Gets and sets the group type. */ dateTimeGroupingType : DateTimeGroupingType; /** * @deprecated Please use the 'dateTimeGroupingType' property instead. * Gets and sets the group type. * @param value - The value to set. */ setDateTimeGroupingType(value: DateTimeGroupingType) : void; /** * @deprecated Please use the 'year' property instead. * Gets and sets the year of the grouped date time. */ getYear() : number; /** * Gets and sets the year of the grouped date time. */ year : number; /** * @deprecated Please use the 'year' property instead. * Gets and sets the year of the grouped date time. * @param value - The value to set. */ setYear(value: number) : void; /** * @deprecated Please use the 'month' property instead. * Gets and sets the month of the grouped date time. */ getMonth() : number; /** * Gets and sets the month of the grouped date time. */ month : number; /** * @deprecated Please use the 'month' property instead. * Gets and sets the month of the grouped date time. * @param value - The value to set. */ setMonth(value: number) : void; /** * @deprecated Please use the 'day' property instead. * Gets and sets the day of the grouped date time. */ getDay() : number; /** * Gets and sets the day of the grouped date time. */ day : number; /** * @deprecated Please use the 'day' property instead. * Gets and sets the day of the grouped date time. * @param value - The value to set. */ setDay(value: number) : void; /** * @deprecated Please use the 'hour' property instead. * Gets and sets the hour of the grouped date time. */ getHour() : number; /** * Gets and sets the hour of the grouped date time. */ hour : number; /** * @deprecated Please use the 'hour' property instead. * Gets and sets the hour of the grouped date time. * @param value - The value to set. */ setHour(value: number) : void; /** * @deprecated Please use the 'minute' property instead. * Gets and sets the minute of the grouped date time. */ getMinute() : number; /** * Gets and sets the minute of the grouped date time. */ minute : number; /** * @deprecated Please use the 'minute' property instead. * Gets and sets the minute of the grouped date time. * @param value - The value to set. */ setMinute(value: number) : void; /** * @deprecated Please use the 'second' property instead. * Gets and sets the second of the grouped date time. */ getSecond() : number; /** * Gets and sets the second of the grouped date time. */ second : number; /** * @deprecated Please use the 'second' property instead. * Gets and sets the second of the grouped date time. * @param value - The value to set. */ setSecond(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; } /** * Specifies how to group dateTime values. */ export enum DateTimeGroupingType { /** * Group by day. */ Day = 0, /** * Group by hour. */ Hour = 1, /** * Group by Minute. */ Minute = 2, /** * Group by Month. */ Month = 3, /** * Group by Second. */ Second = 4, /** * Group by Year. */ Year = 5, } /** * Represents the dynamic filter. */ export class DynamicFilter { /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * @deprecated Please use the 'dynamicFilterType' property instead. * Gets and sets the type of this dynamic filter. */ getDynamicFilterType() : DynamicFilterType; /** * Gets and sets the type of this dynamic filter. */ dynamicFilterType : DynamicFilterType; /** * @deprecated Please use the 'dynamicFilterType' property instead. * Gets and sets the type of this dynamic filter. * @param value - The value to set. */ setDynamicFilterType(value: DynamicFilterType) : void; /** * @deprecated Please use the 'value' property instead. * Gets and sets the dynamic filter value. */ getValue() : Object; /** * Gets and sets the dynamic filter value. */ value : Object; /** * @deprecated Please use the 'value' property instead. * Gets and sets the dynamic filter value. * @param value - The value to set. */ setValue(value: Object) : void; /** * @deprecated Please use the 'maxValue' property instead. * Gets and sets the dynamic filter max value. */ getMaxValue() : Object; /** * Gets and sets the dynamic filter max value. */ maxValue : Object; /** * @deprecated Please use the 'maxValue' property instead. * Gets and sets the dynamic filter max value. * @param value - The value to set. */ setMaxValue(value: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; } /** * Dynamic filter type. */ export enum DynamicFilterType { /** * Shows values that are above average. */ AboveAverage = 0, /** * Shows values that are below average. */ BelowAverage = 1, /** * Shows last month's dates. */ LastMonth = 2, /** * Shows last quarter's dates. */ LastQuarter = 3, /** * Shows last week's dates. */ LastWeek = 4, /** * Shows last year's dates. */ LastYear = 5, /** * Shows the dates that are in January, regardless of year. */ January = 6, /** * Shows the dates that are in October, regardless of year. */ October = 7, /** * Shows the dates that are in November, regardless of year. */ November = 8, /** * Shows the dates that are in December, regardless of year. */ December = 9, /** * Shows the dates that are in February, regardless of year. */ February = 10, /** * Shows the dates that are in March, regardless of year. */ March = 11, /** * Shows the dates that are in April, regardless of year. */ April = 12, /** * Shows the dates that are in May, regardless of year. */ May = 13, /** * Shows the dates that are in June, regardless of year. */ June = 14, /** * Shows the dates that are in July, regardless of year. */ July = 15, /** * Shows the dates that are in August, regardless of year. */ August = 16, /** * Shows the dates that are in September, regardless of year. */ September = 17, /** * Shows next month's dates. */ NextMonth = 18, /** * Shows next quarter's dates. */ NextQuarter = 19, /** * Shows next week's dates. */ NextWeek = 20, /** * Shows next year's dates. */ NextYear = 21, /** * None. */ None = 22, /** * Shows the dates that are in the 1st quarter, regardless of year. */ Quarter1 = 23, /** * Shows the dates that are in the 2nd quarter, regardless of year. */ Quarter2 = 24, /** * Shows the dates that are in the 3rd quarter, regardless of year. */ Quarter3 = 25, /** * Shows the dates that are in the 4th quarter, regardless of year. */ Quarter4 = 26, /** * Shows this month's dates. */ ThisMonth = 27, /** * Shows this quarter's dates. */ ThisQuarter = 28, /** * Shows this week's dates. */ ThisWeek = 29, /** * Shows this year's dates. */ ThisYear = 30, /** * Shows today's dates. */ Today = 31, /** * Shows tomorrow's dates. */ Tomorrow = 32, /** * Shows the dates between the beginning of the year and today, inclusive. */ YearToDate = 33, /** * Shows yesterday's dates. */ Yesterday = 34, } /** * Represents the multiple filter collection. * * @remarks * NOTE: This class is now obsolete. * Instead,please use instead. * This property will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FilterColumn.FilterValueCollection, instead. */ export class MultipleFilterCollection implements Iterable { /** * Constructs one new instance. * * @remarks * NOTE: This member is now obsolete. * Instead,please set FilterColumn.FilterType as FilterType.MultipleFilters then get FilterColumn.MultipleFilters. * This property will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FilterColumn.MultipleFilters, instead. */ constructor(); /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * Gets or a string value. * @param index - */ get(index: number) : Object; /** * @deprecated Please use the 'count' property instead. * Gets the count of the filter values. */ getCount() : number; /** * Gets the count of the filter values. */ readonly count : number; /** * @deprecated Please use the 'matchBlank' property instead. * Indicates whether to filter by blank. */ getMatchBlank() : boolean; /** * Indicates whether to filter by blank. */ matchBlank : boolean; /** * @deprecated Please use the 'matchBlank' property instead. * Indicates whether to filter by blank. * @param value - The value to set. */ setMatchBlank(value: boolean) : void; /** * Adds a label filter criteria. * @param filter - The filter data. */ add(filter: string) : void; /** * Adds a date filter criteria value. * @param type - The type of date filter. * @param year - The year. * @param month - The month. * @param day - The day. */ add(type: DateTimeGroupingType, year: number, month: number, day: number) : void; /** * Adds a date time filter criteria value. * @param type - The type of date filter. * @param year - The year. * @param month - The month. * @param day - The day. * @param hour - The hour. * @param minute - The minute. * @param second - The second. */ add(type: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void; /** * Get the enumerator for filter value, */ getEnumerator() : FilterValueEnumerator; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * The filter type. */ export enum FilterType { /** * Filter by fill color of the cell. */ ColorFilter = 0, /** * Custom filter type. */ CustomFilters = 1, /** * Dynamic filter type. */ DynamicFilter = 2, /** * When multiple values are chosen to filter by, or when a group of date values are chosen to filter by, * this element groups those criteria together. */ MultipleFilters = 3, /** * Filter by icon of conditional formatting. */ IconFilter = 4, /** * Top 10 filter. */ Top10 = 5, /** * No filter. */ None = 6, } /** * Represents icon filter. */ export class IconFilter { /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * @deprecated Please use the 'iconSetType' property instead. * Gets and sets which icon set is used for this filter criteria. */ getIconSetType() : IconSetType; /** * Gets and sets which icon set is used for this filter criteria. */ iconSetType : IconSetType; /** * @deprecated Please use the 'iconSetType' property instead. * Gets and sets which icon set is used for this filter criteria. * @param value - The value to set. */ setIconSetType(value: IconSetType) : void; /** * @deprecated Please use the 'iconId' property instead. * Gets and sets Zero-based index of an icon in an icon set. */ getIconId() : number; /** * Gets and sets Zero-based index of an icon in an icon set. */ iconId : number; /** * @deprecated Please use the 'iconId' property instead. * Gets and sets Zero-based index of an icon in an icon set. * @param value - The value to set. */ setIconId(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; } /** * Represents the top N (percent or number of items) to filter by. */ export class Top10Filter { /** * Constructs from an Object convertible to this. * @param obj - The object. */ constructor(obj: Object); /** * Indicates whether or not to filter by top order */ isTop : boolean; /** * @deprecated Please use the 'isTop' property instead. * Indicates whether or not to filter by top order * @param value - The value to set. */ setIsTop(value: boolean) : void; /** * Indicates whether or not to filter by percent value of the column */ isPercent : boolean; /** * @deprecated Please use the 'isPercent' property instead. * Indicates whether or not to filter by percent value of the column * @param value - The value to set. */ setIsPercent(value: boolean) : void; /** * @deprecated Please use the 'items' property instead. * Gets and sets top or bottom value to use as the filter criteria. */ getItems() : number; /** * Gets and sets top or bottom value to use as the filter criteria. */ items : number; /** * @deprecated Please use the 'items' property instead. * Gets and sets top or bottom value to use as the filter criteria. * @param value - The value to set. */ setItems(value: number) : void; /** * @deprecated Please use the 'criteria' property instead. * The actual cell value in the range which is used to perform the comparison for this filter. * This is the cache value during the refresh process. * * @remarks * NOTE: This member is now obsolete. * Instead,please ignore this property. * This property will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Ignore this property. */ getCriteria() : Object; /** * The actual cell value in the range which is used to perform the comparison for this filter. * This is the cache value during the refresh process. * * @remarks * NOTE: This member is now obsolete. * Instead,please ignore this property. * This property will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Ignore this property. */ criteria : Object; /** * @deprecated Please use the 'criteria' property instead. * The actual cell value in the range which is used to perform the comparison for this filter. * This is the cache value during the refresh process. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. * Instead,please ignore this property. * This property will be removed 12 months later since October 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Ignore this property. */ setCriteria(value: Object) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Gets the Object. */ toObject() : Object; } /** * Represents all auto fitter options. */ export class AutoFitterOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ getDefaultEditLanguage() : DefaultEditLanguage; /** * Gets or sets default edit language. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ defaultEditLanguage : DefaultEditLanguage; /** * @deprecated Please use the 'defaultEditLanguage' property instead. * Gets or sets default edit language. * @param value - The value to set. * * @remarks * It may display/render different layouts for text paragraph when different edit languages is set. * Default is . */ setDefaultEditLanguage(value: DefaultEditLanguage) : void; /** * @deprecated Please use the 'autoFitMergedCellsType' property instead. * Gets and set the type of auto fitting row height of merged cells. * * @remarks * Excel defaults to ignore merged cells when fitting the row height, so Aspose.Cells works as MS Excel default. * Please set this type to change the way of auto fitting row height of merged cells. */ getAutoFitMergedCellsType() : AutoFitMergedCellsType; /** * Gets and set the type of auto fitting row height of merged cells. * * @remarks * Excel defaults to ignore merged cells when fitting the row height, so Aspose.Cells works as MS Excel default. * Please set this type to change the way of auto fitting row height of merged cells. */ autoFitMergedCellsType : AutoFitMergedCellsType; /** * @deprecated Please use the 'autoFitMergedCellsType' property instead. * Gets and set the type of auto fitting row height of merged cells. * @param value - The value to set. * * @remarks * Excel defaults to ignore merged cells when fitting the row height, so Aspose.Cells works as MS Excel default. * Please set this type to change the way of auto fitting row height of merged cells. */ setAutoFitMergedCellsType(value: AutoFitMergedCellsType) : void; /** * @deprecated Please use the 'onlyAuto' property instead. * Indicates whether only fit the rows which height are not customed. */ getOnlyAuto() : boolean; /** * Indicates whether only fit the rows which height are not customed. */ onlyAuto : boolean; /** * @deprecated Please use the 'onlyAuto' property instead. * Indicates whether only fit the rows which height are not customed. * @param value - The value to set. */ setOnlyAuto(value: boolean) : void; /** * @deprecated Please use the 'ignoreHidden' property instead. * Ignores the hidden rows/columns. */ getIgnoreHidden() : boolean; /** * Ignores the hidden rows/columns. */ ignoreHidden : boolean; /** * @deprecated Please use the 'ignoreHidden' property instead. * Ignores the hidden rows/columns. * @param value - The value to set. */ setIgnoreHidden(value: boolean) : void; /** * @deprecated Please use the 'maxRowHeight' property instead. * Gets and sets the max row height(in unit of Point) when autofitting rows. */ getMaxRowHeight() : number; /** * Gets and sets the max row height(in unit of Point) when autofitting rows. */ maxRowHeight : number; /** * @deprecated Please use the 'maxRowHeight' property instead. * Gets and sets the max row height(in unit of Point) when autofitting rows. * @param value - The value to set. */ setMaxRowHeight(value: number) : void; /** * @deprecated Please use the 'autoFitWrappedTextType' property instead. * Gets and sets the type of auto fitting wrapped text. */ getAutoFitWrappedTextType() : AutoFitWrappedTextType; /** * Gets and sets the type of auto fitting wrapped text. */ autoFitWrappedTextType : AutoFitWrappedTextType; /** * @deprecated Please use the 'autoFitWrappedTextType' property instead. * Gets and sets the type of auto fitting wrapped text. * @param value - The value to set. */ setAutoFitWrappedTextType(value: AutoFitWrappedTextType) : void; /** * @deprecated Please use the 'formatStrategy' property instead. * Gets and sets the formatted strategy. * * @remarks * The default value is CellStyle for performance. */ getFormatStrategy() : CellValueFormatStrategy; /** * Gets and sets the formatted strategy. * * @remarks * The default value is CellStyle for performance. */ formatStrategy : CellValueFormatStrategy; /** * @deprecated Please use the 'formatStrategy' property instead. * Gets and sets the formatted strategy. * @param value - The value to set. * * @remarks * The default value is CellStyle for performance. */ setFormatStrategy(value: CellValueFormatStrategy) : void; /** * @deprecated Please use the 'forRendering' property instead. * Indicates whether fit for rendering purpose. */ getForRendering() : boolean; /** * Indicates whether fit for rendering purpose. */ forRendering : boolean; /** * @deprecated Please use the 'forRendering' property instead. * Indicates whether fit for rendering purpose. * @param value - The value to set. */ setForRendering(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates chart data value */ export class ChartDataValue { /** * @deprecated Please use the 'valueType' property instead. * Gets the value type of the chart data. */ getValueType() : CellValueType; /** * Gets the value type of the chart data. */ readonly valueType : CellValueType; /** * @deprecated Please use the 'stringValue' property instead. * Gets the string value of the chart data. */ getStringValue() : string; /** * Gets the string value of the chart data. */ readonly stringValue : string; /** * @deprecated Please use the 'intValue' property instead. * Gets the Int value of the chart data. */ getIntValue() : number; /** * Gets the Int value of the chart data. */ readonly intValue : number; /** * @deprecated Please use the 'doubleValue' property instead. * Gets the double value of the chart data. */ getDoubleValue() : number; /** * Gets the double value of the chart data. */ readonly doubleValue : number; /** * @deprecated Please use the 'dateTimeValue' property instead. * Gets the DateTime value of the chart data. */ getDateTimeValue() : Date; /** * Gets the DateTime value of the chart data. */ readonly dateTimeValue : Date; /** * @deprecated Please use the 'boolValue' property instead. * Gets the boolean value of the chart data. */ getBoolValue() : boolean; /** * Gets the boolean value of the chart data. */ readonly boolValue : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Allowing user to set PDF conversion's Compatibility */ export enum PdfCompliance { /** * Pdf format compatible with PDF 1.4 * * @remarks * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since November 2023. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use PdfCompliance.Pdf14 instead. */ None = 0, /** * Pdf format compatible with PDF 1.4 */ Pdf14 = 0, /** * Pdf format compatible with PDF 1.5 */ Pdf15 = 3, /** * Pdf format compatible with PDF 1.6 */ Pdf16 = 4, /** * Pdf format compatible with PDF 1.7 */ Pdf17 = 5, /** * Pdf format compatible with PDF/A-1b(ISO 19005-1) */ PdfA1b = 1, /** * Pdf format compatible with PDF/A-1a(ISO 19005-1) */ PdfA1a = 2, /** * Pdf format compatible with PDF/A-2b(ISO 19005-2) */ PdfA2b = 6, /** * Pdf format compatible with PDF/A-2u(ISO 19005-2) */ PdfA2u = 7, /** * Pdf format compatible with PDF/A-2a(ISO 19005-2) */ PdfA2a = 8, /** * Pdf format compatible with PDF/A-3b(ISO 19005-3) */ PdfA3b = 9, /** * Pdf format compatible with PDF/A-3u(ISO 19005-3) */ PdfA3u = 10, /** * Pdf format compatible with PDF/A-3a(ISO 19005-3) */ PdfA3a = 11, } /** * Represents the directory type of the file name. */ export enum DirectoryType { /** * Represents an MS-DOS drive letter. It is followed by the drive letter. * Or UNC file names, such as \\server\share\myfile.xls */ Volume = 0, /** * Indicates that the source workbook is on the same drive as the dependent workbook (the drive letter is omitted) */ SameVolume = 1, /** * Indicates that the source workbook is in a subdirectory of the current directory. */ DownDirectory = 2, /** * Indicates that the source workbook is in the parent directory of the current directory. */ UpDirectory = 3, } /** * Represents a preset light right that can be applied to a shape */ export enum LightRigType { /** * Balanced */ Balanced = 0, /** * Bright room */ BrightRoom = 1, /** * Chilly */ Chilly = 2, /** * Contrasting */ Contrasting = 3, /** * Flat */ Flat = 4, /** * Flood */ Flood = 5, /** * Freezing */ Freezing = 6, /** * Glow */ Glow = 7, /** * Harsh */ Harsh = 8, /** * LegacyFlat1 */ LegacyFlat1 = 9, /** * LegacyFlat2 */ LegacyFlat2 = 10, /** * LegacyFlat3 */ LegacyFlat3 = 11, /** * LegacyFlat4 */ LegacyFlat4 = 12, /** * LegacyHarsh1 */ LegacyHarsh1 = 13, /** * LegacyHarsh2 */ LegacyHarsh2 = 14, /** * LegacyHarsh3 */ LegacyHarsh3 = 15, /** * LegacyHarsh4 */ LegacyHarsh4 = 16, /** * LegacyNormal1 */ LegacyNormal1 = 17, /** * LegacyNormal2 */ LegacyNormal2 = 18, /** * LegacyNormal3 */ LegacyNormal3 = 19, /** * LegacyNormal4 */ LegacyNormal4 = 20, /** * Morning */ Morning = 21, /** * Soft */ Soft = 22, /** * Sunrise */ Sunrise = 23, /** * Sunset */ Sunset = 24, /** * Three point */ ThreePoint = 25, /** * Two point */ TwoPoint = 26, /** * No light rig. */ None = 27, } /** * Represents the options for saving html file. */ export class HtmlSaveOptions extends SaveOptions { /** * Creates options for saving html file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * Creates options for saving htm file. * @param saveFormat - The file format. /// It should be one of following types: or , /// otherwise the saved format will be set as automatically. */ constructor(saveFormat: SaveFormat); /** * @deprecated Please use the 'ignoreInvisibleShapes' property instead. * Indicate whether exporting those not visible shapes * * @remarks * The default values is false. */ getIgnoreInvisibleShapes() : boolean; /** * Indicate whether exporting those not visible shapes * * @remarks * The default values is false. */ ignoreInvisibleShapes : boolean; /** * @deprecated Please use the 'ignoreInvisibleShapes' property instead. * Indicate whether exporting those not visible shapes * @param value - The value to set. * * @remarks * The default values is false. */ setIgnoreInvisibleShapes(value: boolean) : void; /** * @deprecated Please use the 'pageTitle' property instead. * The title of the html page. * Only for saving to html stream. */ getPageTitle() : string; /** * The title of the html page. * Only for saving to html stream. */ pageTitle : string; /** * @deprecated Please use the 'pageTitle' property instead. * The title of the html page. * Only for saving to html stream. * @param value - The value to set. */ setPageTitle(value: string) : void; /** * @deprecated Please use the 'attachedFilesDirectory' property instead. * The directory that the attached files will be saved to. * Only for saving to html stream. */ getAttachedFilesDirectory() : string; /** * The directory that the attached files will be saved to. * Only for saving to html stream. */ attachedFilesDirectory : string; /** * @deprecated Please use the 'attachedFilesDirectory' property instead. * The directory that the attached files will be saved to. * Only for saving to html stream. * @param value - The value to set. */ setAttachedFilesDirectory(value: string) : void; /** * @deprecated Please use the 'attachedFilesUrlPrefix' property instead. * Specify the Url prefix of attached files such as image in the html file. * Only for saving to html stream. */ getAttachedFilesUrlPrefix() : string; /** * Specify the Url prefix of attached files such as image in the html file. * Only for saving to html stream. */ attachedFilesUrlPrefix : string; /** * @deprecated Please use the 'attachedFilesUrlPrefix' property instead. * Specify the Url prefix of attached files such as image in the html file. * Only for saving to html stream. * @param value - The value to set. */ setAttachedFilesUrlPrefix(value: string) : void; /** * @deprecated Please use the 'defaultFontName' property instead. * Specify the default font name for exporting html, the default font will be used when the font of style is not existing, * If this property is null, Aspose.Cells will use universal font which have the same family with the original font, * the default value is null. */ getDefaultFontName() : string; /** * Specify the default font name for exporting html, the default font will be used when the font of style is not existing, * If this property is null, Aspose.Cells will use universal font which have the same family with the original font, * the default value is null. */ defaultFontName : string; /** * @deprecated Please use the 'defaultFontName' property instead. * Specify the default font name for exporting html, the default font will be used when the font of style is not existing, * If this property is null, Aspose.Cells will use universal font which have the same family with the original font, * the default value is null. * @param value - The value to set. */ setDefaultFontName(value: string) : void; /** * @deprecated Please use the 'addGenericFont' property instead. * Indicates whether to add a generic font to CSS font-family. * The default value is true */ getAddGenericFont() : boolean; /** * Indicates whether to add a generic font to CSS font-family. * The default value is true */ addGenericFont : boolean; /** * @deprecated Please use the 'addGenericFont' property instead. * Indicates whether to add a generic font to CSS font-family. * The default value is true * @param value - The value to set. */ setAddGenericFont(value: boolean) : void; /** * @deprecated Please use the 'worksheetScalable' property instead. * Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. */ getWorksheetScalable() : boolean; /** * Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. */ worksheetScalable : boolean; /** * @deprecated Please use the 'worksheetScalable' property instead. * Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. * @param value - The value to set. */ setWorksheetScalable(value: boolean) : void; /** * Indicates if exporting comments when saving file to html, the default value is false. */ isExportComments : boolean; /** * @deprecated Please use the 'isExportComments' property instead. * Indicates if exporting comments when saving file to html, the default value is false. * @param value - The value to set. */ setIsExportComments(value: boolean) : void; /** * @deprecated Please use the 'exportCommentsType' property instead. * Represents type of exporting comments to html files. */ getExportCommentsType() : PrintCommentsType; /** * Represents type of exporting comments to html files. */ exportCommentsType : PrintCommentsType; /** * @deprecated Please use the 'exportCommentsType' property instead. * Represents type of exporting comments to html files. * @param value - The value to set. */ setExportCommentsType(value: PrintCommentsType) : void; /** * @deprecated Please use the 'disableDownlevelRevealedComments' property instead. * Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. */ getDisableDownlevelRevealedComments() : boolean; /** * Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. */ disableDownlevelRevealedComments : boolean; /** * @deprecated Please use the 'disableDownlevelRevealedComments' property instead. * Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. * @param value - The value to set. */ setDisableDownlevelRevealedComments(value: boolean) : void; /** * Indicates whether exporting image files to temp directory. * Only for saving to html stream. */ isExpImageToTempDir : boolean; /** * @deprecated Please use the 'isExpImageToTempDir' property instead. * Indicates whether exporting image files to temp directory. * Only for saving to html stream. * @param value - The value to set. */ setIsExpImageToTempDir(value: boolean) : void; /** * @deprecated Please use the 'imageScalable' property instead. * Indicates whether using scalable unit to describe the image width * when using scalable unit to describe the column width. * The default value is true. */ getImageScalable() : boolean; /** * Indicates whether using scalable unit to describe the image width * when using scalable unit to describe the column width. * The default value is true. */ imageScalable : boolean; /** * @deprecated Please use the 'imageScalable' property instead. * Indicates whether using scalable unit to describe the image width * when using scalable unit to describe the column width. * The default value is true. * @param value - The value to set. */ setImageScalable(value: boolean) : void; /** * @deprecated Please use the 'widthScalable' property instead. * Indicates whether exporting column width in unit of scale to html. * The default value is false. */ getWidthScalable() : boolean; /** * Indicates whether exporting column width in unit of scale to html. * The default value is false. */ widthScalable : boolean; /** * @deprecated Please use the 'widthScalable' property instead. * Indicates whether exporting column width in unit of scale to html. * The default value is false. * @param value - The value to set. */ setWidthScalable(value: boolean) : void; /** * @deprecated Please use the 'exportSingleTab' property instead. * Indicates whether exporting the single tab when the file only has one worksheet. * The default value is false. */ getExportSingleTab() : boolean; /** * Indicates whether exporting the single tab when the file only has one worksheet. * The default value is false. */ exportSingleTab : boolean; /** * @deprecated Please use the 'exportSingleTab' property instead. * Indicates whether exporting the single tab when the file only has one worksheet. * The default value is false. * @param value - The value to set. */ setExportSingleTab(value: boolean) : void; /** * @deprecated Please use the 'exportImagesAsBase64' property instead. * Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ getExportImagesAsBase64() : boolean; /** * Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ exportImagesAsBase64 : boolean; /** * @deprecated Please use the 'exportImagesAsBase64' property instead. * Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. * @param value - The value to set. * * @remarks * When this property is set to true image data is exported directly on the * img elements and separate files are not created. */ setExportImagesAsBase64(value: boolean) : void; /** * @deprecated Please use the 'exportActiveWorksheetOnly' property instead. * Indicates if only exporting the active worksheet to html file. * If true then only the active worksheet will be exported to html file; * If false then the whole workbook will be exported to html file. * The default value is false. */ getExportActiveWorksheetOnly() : boolean; /** * Indicates if only exporting the active worksheet to html file. * If true then only the active worksheet will be exported to html file; * If false then the whole workbook will be exported to html file. * The default value is false. */ exportActiveWorksheetOnly : boolean; /** * @deprecated Please use the 'exportActiveWorksheetOnly' property instead. * Indicates if only exporting the active worksheet to html file. * If true then only the active worksheet will be exported to html file; * If false then the whole workbook will be exported to html file. * The default value is false. * @param value - The value to set. */ setExportActiveWorksheetOnly(value: boolean) : void; /** * @deprecated Please use the 'exportPrintAreaOnly' property instead. * Indicates if only exporting the print area to html file. The default value is false. */ getExportPrintAreaOnly() : boolean; /** * Indicates if only exporting the print area to html file. The default value is false. */ exportPrintAreaOnly : boolean; /** * @deprecated Please use the 'exportPrintAreaOnly' property instead. * Indicates if only exporting the print area to html file. The default value is false. * @param value - The value to set. */ setExportPrintAreaOnly(value: boolean) : void; /** * @deprecated Please use the 'exportArea' property instead. * Gets or Sets the exporting CellArea of current active Worksheet. * If you set this attribute, the print area of current active Worksheet will be omitted. * Only the specified area will be exported when saving the file to html. */ getExportArea() : CellArea; /** * Gets or Sets the exporting CellArea of current active Worksheet. * If you set this attribute, the print area of current active Worksheet will be omitted. * Only the specified area will be exported when saving the file to html. */ exportArea : CellArea; /** * @deprecated Please use the 'exportArea' property instead. * Gets or Sets the exporting CellArea of current active Worksheet. * If you set this attribute, the print area of current active Worksheet will be omitted. * Only the specified area will be exported when saving the file to html. * @param value - The value to set. */ setExportArea(value: CellArea) : void; /** * @deprecated Please use the 'parseHtmlTagInCell' property instead. * Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. * The default value is true. */ getParseHtmlTagInCell() : boolean; /** * Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. * The default value is true. */ parseHtmlTagInCell : boolean; /** * @deprecated Please use the 'parseHtmlTagInCell' property instead. * Indicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is. * The default value is true. * @param value - The value to set. */ setParseHtmlTagInCell(value: boolean) : void; /** * @deprecated Please use the 'htmlCrossStringType' property instead. * Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. * By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. * But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell. */ getHtmlCrossStringType() : HtmlCrossType; /** * Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. * By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. * But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell. */ htmlCrossStringType : HtmlCrossType; /** * @deprecated Please use the 'htmlCrossStringType' property instead. * Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. * By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. * But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell. * @param value - The value to set. */ setHtmlCrossStringType(value: HtmlCrossType) : void; /** * @deprecated Please use the 'hiddenColDisplayType' property instead. * Hidden column(the width of this column is 0) in excel,before save this into html format, * if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, * if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden" */ getHiddenColDisplayType() : HtmlHiddenColDisplayType; /** * Hidden column(the width of this column is 0) in excel,before save this into html format, * if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, * if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden" */ hiddenColDisplayType : HtmlHiddenColDisplayType; /** * @deprecated Please use the 'hiddenColDisplayType' property instead. * Hidden column(the width of this column is 0) in excel,before save this into html format, * if HtmlHiddenColDisplayType is "Remove",the hidden column would not been output, * if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden" * @param value - The value to set. */ setHiddenColDisplayType(value: HtmlHiddenColDisplayType) : void; /** * @deprecated Please use the 'hiddenRowDisplayType' property instead. * Hidden row(the height of this row is 0) in excel,before save this into html format, * if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, * if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden" */ getHiddenRowDisplayType() : HtmlHiddenRowDisplayType; /** * Hidden row(the height of this row is 0) in excel,before save this into html format, * if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, * if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden" */ hiddenRowDisplayType : HtmlHiddenRowDisplayType; /** * @deprecated Please use the 'hiddenRowDisplayType' property instead. * Hidden row(the height of this row is 0) in excel,before save this into html format, * if HtmlHiddenRowDisplayType is "Remove",the hidden row would not been output, * if the value is "Hidden", the row would been output,but was hidden,the default value is "Hidden" * @param value - The value to set. */ setHiddenRowDisplayType(value: HtmlHiddenRowDisplayType) : void; /** * @deprecated Please use the 'encoding' property instead. * If not set,use Encoding.UTF8 as default enconding type. */ getEncoding() : EncodingType; /** * If not set,use Encoding.UTF8 as default enconding type. */ encoding : EncodingType; /** * @deprecated Please use the 'encoding' property instead. * If not set,use Encoding.UTF8 as default enconding type. * @param value - The value to set. */ setEncoding(value: EncodingType) : void; /** * @deprecated Please use the 'filePathProvider' property instead. * Gets or sets the IFilePathProvider for exporting Worksheet to html separately. */ getFilePathProvider() : IFilePathProvider; /** * Gets or sets the IFilePathProvider for exporting Worksheet to html separately. */ filePathProvider : IFilePathProvider; /** * @deprecated Please use the 'filePathProvider' property instead. * Gets or sets the IFilePathProvider for exporting Worksheet to html separately. * @param value - The value to set. */ setFilePathProvider(value: IFilePathProvider) : void; /** * @deprecated Please use the 'imageOptions' property instead. * Get the ImageOrPrintOptions object before exporting */ getImageOptions() : ImageOrPrintOptions; /** * Get the ImageOrPrintOptions object before exporting */ readonly imageOptions : ImageOrPrintOptions; /** * @deprecated Please use the 'saveAsSingleFile' property instead. * Indicates whether save the html as single file. * The default value is false. * * @remarks * If there are multiple worksheets or other required resources such as pictures in the workbook, * commonly those worksheets and other resources need to be saved into separate files. * For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. * If so, user may set this property as true. */ getSaveAsSingleFile() : boolean; /** * Indicates whether save the html as single file. * The default value is false. * * @remarks * If there are multiple worksheets or other required resources such as pictures in the workbook, * commonly those worksheets and other resources need to be saved into separate files. * For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. * If so, user may set this property as true. */ saveAsSingleFile : boolean; /** * @deprecated Please use the 'saveAsSingleFile' property instead. * Indicates whether save the html as single file. * The default value is false. * @param value - The value to set. * * @remarks * If there are multiple worksheets or other required resources such as pictures in the workbook, * commonly those worksheets and other resources need to be saved into separate files. * For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. * If so, user may set this property as true. */ setSaveAsSingleFile(value: boolean) : void; /** * @deprecated Please use the 'showAllSheets' property instead. * Indicates whether showing all sheets when saving as a single html file. * * @remarks * Only works when is True. */ getShowAllSheets() : boolean; /** * Indicates whether showing all sheets when saving as a single html file. * * @remarks * Only works when is True. */ showAllSheets : boolean; /** * @deprecated Please use the 'showAllSheets' property instead. * Indicates whether showing all sheets when saving as a single html file. * @param value - The value to set. * * @remarks * Only works when is True. */ setShowAllSheets(value: boolean) : void; /** * @deprecated Please use the 'exportPageHeaders' property instead. * Indicates whether exporting page headers. * * @remarks * Only works when is True. */ getExportPageHeaders() : boolean; /** * Indicates whether exporting page headers. * * @remarks * Only works when is True. */ exportPageHeaders : boolean; /** * @deprecated Please use the 'exportPageHeaders' property instead. * Indicates whether exporting page headers. * @param value - The value to set. * * @remarks * Only works when is True. */ setExportPageHeaders(value: boolean) : void; /** * @deprecated Please use the 'exportPageFooters' property instead. * Indicates whether exporting page headers. * * @remarks * Only works when is True. */ getExportPageFooters() : boolean; /** * Indicates whether exporting page headers. * * @remarks * Only works when is True. */ exportPageFooters : boolean; /** * @deprecated Please use the 'exportPageFooters' property instead. * Indicates whether exporting page headers. * @param value - The value to set. * * @remarks * Only works when is True. */ setExportPageFooters(value: boolean) : void; /** * @deprecated Please use the 'exportHiddenWorksheet' property instead. * Indicating if exporting the hidden worksheet content.The default value is true. */ getExportHiddenWorksheet() : boolean; /** * Indicating if exporting the hidden worksheet content.The default value is true. */ exportHiddenWorksheet : boolean; /** * @deprecated Please use the 'exportHiddenWorksheet' property instead. * Indicating if exporting the hidden worksheet content.The default value is true. * @param value - The value to set. */ setExportHiddenWorksheet(value: boolean) : void; /** * @deprecated Please use the 'presentationPreference' property instead. * Indicating if html or mht file is presentation preference. * The default value is false. * if you want to get more beautiful presentation,please set the value to true. */ getPresentationPreference() : boolean; /** * Indicating if html or mht file is presentation preference. * The default value is false. * if you want to get more beautiful presentation,please set the value to true. */ presentationPreference : boolean; /** * @deprecated Please use the 'presentationPreference' property instead. * Indicating if html or mht file is presentation preference. * The default value is false. * if you want to get more beautiful presentation,please set the value to true. * @param value - The value to set. */ setPresentationPreference(value: boolean) : void; /** * @deprecated Please use the 'cellCssPrefix' property instead. * Gets and sets the prefix of the css name,the default value is "". */ getCellCssPrefix() : string; /** * Gets and sets the prefix of the css name,the default value is "". */ cellCssPrefix : string; /** * @deprecated Please use the 'cellCssPrefix' property instead. * Gets and sets the prefix of the css name,the default value is "". * @param value - The value to set. */ setCellCssPrefix(value: string) : void; /** * @deprecated Please use the 'tableCssId' property instead. * Gets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element * which has the specific TableCssId attribute. The default value is "". */ getTableCssId() : string; /** * Gets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element * which has the specific TableCssId attribute. The default value is "". */ tableCssId : string; /** * @deprecated Please use the 'tableCssId' property instead. * Gets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element * which has the specific TableCssId attribute. The default value is "". * @param value - The value to set. */ setTableCssId(value: string) : void; /** * Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. * The default value is false. */ isFullPathLink : boolean; /** * @deprecated Please use the 'isFullPathLink' property instead. * Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. * The default value is false. * @param value - The value to set. */ setIsFullPathLink(value: boolean) : void; /** * @deprecated Please use the 'exportWorksheetCSSSeparately' property instead. * Indicating whether export the worksheet css separately.The default value is false. */ getExportWorksheetCSSSeparately() : boolean; /** * Indicating whether export the worksheet css separately.The default value is false. */ exportWorksheetCSSSeparately : boolean; /** * @deprecated Please use the 'exportWorksheetCSSSeparately' property instead. * Indicating whether export the worksheet css separately.The default value is false. * @param value - The value to set. */ setExportWorksheetCSSSeparately(value: boolean) : void; /** * @deprecated Please use the 'exportSimilarBorderStyle' property instead. * Indicating whether exporting the similar border style when the border style is not supported by browsers. * If you want to import the html or mht file to excel, please keep the default value. * The default value is false. */ getExportSimilarBorderStyle() : boolean; /** * Indicating whether exporting the similar border style when the border style is not supported by browsers. * If you want to import the html or mht file to excel, please keep the default value. * The default value is false. */ exportSimilarBorderStyle : boolean; /** * @deprecated Please use the 'exportSimilarBorderStyle' property instead. * Indicating whether exporting the similar border style when the border style is not supported by browsers. * If you want to import the html or mht file to excel, please keep the default value. * The default value is false. * @param value - The value to set. */ setExportSimilarBorderStyle(value: boolean) : void; /** * @deprecated Please use the 'mergeEmptyTdForcely' property instead. * Indicates whether merging empty TD element forcedly when exporting file to html. * The size of html file will be reduced significantly after setting value to true. The default value is false. * If you want to import the html file to excel or export perfect grid lines when saving file to html, * please keep the default value. * @deprecated * Use HtmlSaveOptions.MergeEmptyTdType instead. */ getMergeEmptyTdForcely() : boolean; /** * Indicates whether merging empty TD element forcedly when exporting file to html. * The size of html file will be reduced significantly after setting value to true. The default value is false. * If you want to import the html file to excel or export perfect grid lines when saving file to html, * please keep the default value. * @deprecated * Use HtmlSaveOptions.MergeEmptyTdType instead. */ mergeEmptyTdForcely : boolean; /** * @deprecated Please use the 'mergeEmptyTdForcely' property instead. * Indicates whether merging empty TD element forcedly when exporting file to html. * The size of html file will be reduced significantly after setting value to true. The default value is false. * If you want to import the html file to excel or export perfect grid lines when saving file to html, * please keep the default value. * @param value - The value to set. * @deprecated * Use HtmlSaveOptions.MergeEmptyTdType instead. */ setMergeEmptyTdForcely(value: boolean) : void; /** * @deprecated Please use the 'mergeEmptyTdType' property instead. * The option to merge contiguous empty cells(empty td elements) * The default value is MergeEmptyTdType.Default. */ getMergeEmptyTdType() : MergeEmptyTdType; /** * The option to merge contiguous empty cells(empty td elements) * The default value is MergeEmptyTdType.Default. */ mergeEmptyTdType : MergeEmptyTdType; /** * @deprecated Please use the 'mergeEmptyTdType' property instead. * The option to merge contiguous empty cells(empty td elements) * The default value is MergeEmptyTdType.Default. * @param value - The value to set. */ setMergeEmptyTdType(value: MergeEmptyTdType) : void; /** * @deprecated Please use the 'exportCellCoordinate' property instead. * Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. * If you want to import the output html to excel, please keep the default value. */ getExportCellCoordinate() : boolean; /** * Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. * If you want to import the output html to excel, please keep the default value. */ exportCellCoordinate : boolean; /** * @deprecated Please use the 'exportCellCoordinate' property instead. * Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. * If you want to import the output html to excel, please keep the default value. * @param value - The value to set. */ setExportCellCoordinate(value: boolean) : void; /** * @deprecated Please use the 'exportExtraHeadings' property instead. * Indicates whether exporting extra headings when the length of text is longer than max display column. * The default value is false. If you want to import the html file to excel, please keep the default value. */ getExportExtraHeadings() : boolean; /** * Indicates whether exporting extra headings when the length of text is longer than max display column. * The default value is false. If you want to import the html file to excel, please keep the default value. */ exportExtraHeadings : boolean; /** * @deprecated Please use the 'exportExtraHeadings' property instead. * Indicates whether exporting extra headings when the length of text is longer than max display column. * The default value is false. If you want to import the html file to excel, please keep the default value. * @param value - The value to set. */ setExportExtraHeadings(value: boolean) : void; /** * @deprecated Please use the 'exportRowColumnHeadings' property instead. * Indicates whether exports sheet's row and column headings when saving to HTML files. * * @remarks * The default value is false. */ getExportRowColumnHeadings() : boolean; /** * Indicates whether exports sheet's row and column headings when saving to HTML files. * * @remarks * The default value is false. */ exportRowColumnHeadings : boolean; /** * @deprecated Please use the 'exportRowColumnHeadings' property instead. * Indicates whether exports sheet's row and column headings when saving to HTML files. * @param value - The value to set. * * @remarks * The default value is false. */ setExportRowColumnHeadings(value: boolean) : void; /** * @deprecated Please use the 'exportFormula' property instead. * Indicates whether exporting formula when saving file to html. The default value is true. * If you want to import the output html to excel, please keep the default value. */ getExportFormula() : boolean; /** * Indicates whether exporting formula when saving file to html. The default value is true. * If you want to import the output html to excel, please keep the default value. */ exportFormula : boolean; /** * @deprecated Please use the 'exportFormula' property instead. * Indicates whether exporting formula when saving file to html. The default value is true. * If you want to import the output html to excel, please keep the default value. * @param value - The value to set. */ setExportFormula(value: boolean) : void; /** * @deprecated Please use the 'addTooltipText' property instead. * Indicates whether adding tooltip text when the data can't be fully displayed. * The default value is false. */ getAddTooltipText() : boolean; /** * Indicates whether adding tooltip text when the data can't be fully displayed. * The default value is false. */ addTooltipText : boolean; /** * @deprecated Please use the 'addTooltipText' property instead. * Indicates whether adding tooltip text when the data can't be fully displayed. * The default value is false. * @param value - The value to set. */ setAddTooltipText(value: boolean) : void; /** * @deprecated Please use the 'exportGridLines' property instead. * Indicating whether exporting the gridlines.The default value is false. */ getExportGridLines() : boolean; /** * Indicating whether exporting the gridlines.The default value is false. */ exportGridLines : boolean; /** * @deprecated Please use the 'exportGridLines' property instead. * Indicating whether exporting the gridlines.The default value is false. * @param value - The value to set. */ setExportGridLines(value: boolean) : void; /** * @deprecated Please use the 'exportBogusRowData' property instead. * Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. */ getExportBogusRowData() : boolean; /** * Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. */ exportBogusRowData : boolean; /** * @deprecated Please use the 'exportBogusRowData' property instead. * Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. * @param value - The value to set. */ setExportBogusRowData(value: boolean) : void; /** * @deprecated Please use the 'excludeUnusedStyles' property instead. * Indicating whether excludes unused styles. * For the generated html files, excluding unused styles can make the file size smaller * without affecting the visual effects. So the default value of this property is true. * If user needs to keep all styles in the workbook for the generated html(such as the scenario that user * needs to restore the workbook from the generated html later), please set this property as false. */ getExcludeUnusedStyles() : boolean; /** * Indicating whether excludes unused styles. * For the generated html files, excluding unused styles can make the file size smaller * without affecting the visual effects. So the default value of this property is true. * If user needs to keep all styles in the workbook for the generated html(such as the scenario that user * needs to restore the workbook from the generated html later), please set this property as false. */ excludeUnusedStyles : boolean; /** * @deprecated Please use the 'excludeUnusedStyles' property instead. * Indicating whether excludes unused styles. * For the generated html files, excluding unused styles can make the file size smaller * without affecting the visual effects. So the default value of this property is true. * If user needs to keep all styles in the workbook for the generated html(such as the scenario that user * needs to restore the workbook from the generated html later), please set this property as false. * @param value - The value to set. */ setExcludeUnusedStyles(value: boolean) : void; /** * @deprecated Please use the 'exportDocumentProperties' property instead. * Indicating whether exporting document properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ getExportDocumentProperties() : boolean; /** * Indicating whether exporting document properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ exportDocumentProperties : boolean; /** * @deprecated Please use the 'exportDocumentProperties' property instead. * Indicating whether exporting document properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. * @param value - The value to set. */ setExportDocumentProperties(value: boolean) : void; /** * @deprecated Please use the 'exportWorksheetProperties' property instead. * Indicating whether exporting worksheet properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ getExportWorksheetProperties() : boolean; /** * Indicating whether exporting worksheet properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ exportWorksheetProperties : boolean; /** * @deprecated Please use the 'exportWorksheetProperties' property instead. * Indicating whether exporting worksheet properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. * @param value - The value to set. */ setExportWorksheetProperties(value: boolean) : void; /** * @deprecated Please use the 'exportWorkbookProperties' property instead. * Indicating whether exporting workbook properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ getExportWorkbookProperties() : boolean; /** * Indicating whether exporting workbook properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. */ exportWorkbookProperties : boolean; /** * @deprecated Please use the 'exportWorkbookProperties' property instead. * Indicating whether exporting workbook properties.The default value is true.If you want to import * the html or mht file to excel, please keep the default value. * @param value - The value to set. */ setExportWorkbookProperties(value: boolean) : void; /** * @deprecated Please use the 'exportFrameScriptsAndProperties' property instead. * Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. */ getExportFrameScriptsAndProperties() : boolean; /** * Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. */ exportFrameScriptsAndProperties : boolean; /** * @deprecated Please use the 'exportFrameScriptsAndProperties' property instead. * Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file * to excel, please keep the default value. * @param value - The value to set. */ setExportFrameScriptsAndProperties(value: boolean) : void; /** * @deprecated Please use the 'exportDataOptions' property instead. * Indicating the rule of exporting html file data.The default value is All. */ getExportDataOptions() : HtmlExportDataOptions; /** * Indicating the rule of exporting html file data.The default value is All. */ exportDataOptions : HtmlExportDataOptions; /** * @deprecated Please use the 'exportDataOptions' property instead. * Indicating the rule of exporting html file data.The default value is All. * @param value - The value to set. */ setExportDataOptions(value: HtmlExportDataOptions) : void; /** * @deprecated Please use the 'linkTargetType' property instead. * Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent. */ getLinkTargetType() : HtmlLinkTargetType; /** * Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent. */ linkTargetType : HtmlLinkTargetType; /** * @deprecated Please use the 'linkTargetType' property instead. * Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent. * @param value - The value to set. */ setLinkTargetType(value: HtmlLinkTargetType) : void; /** * Indicating whether the output HTML is compatible with IE browser. * The defalut value is false */ isIECompatible : boolean; /** * @deprecated Please use the 'isIECompatible' property instead. * Indicating whether the output HTML is compatible with IE browser. * The defalut value is false * @param value - The value to set. */ setIsIECompatible(value: boolean) : void; /** * @deprecated Please use the 'formatDataIgnoreColumnWidth' property instead. * Indicating whether show the whole formatted data of cell when overflowing the column. * If true then ignore the column width and the whole data of cell will be exported. * If false then the data will be exported same as Excel. * The default value is false. */ getFormatDataIgnoreColumnWidth() : boolean; /** * Indicating whether show the whole formatted data of cell when overflowing the column. * If true then ignore the column width and the whole data of cell will be exported. * If false then the data will be exported same as Excel. * The default value is false. */ formatDataIgnoreColumnWidth : boolean; /** * @deprecated Please use the 'formatDataIgnoreColumnWidth' property instead. * Indicating whether show the whole formatted data of cell when overflowing the column. * If true then ignore the column width and the whole data of cell will be exported. * If false then the data will be exported same as Excel. * The default value is false. * @param value - The value to set. */ setFormatDataIgnoreColumnWidth(value: boolean) : void; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving html file. * * @remarks * The default value is false. */ getCalculateFormula() : boolean; /** * Indicates whether to calculate formulas before saving html file. * * @remarks * The default value is false. */ calculateFormula : boolean; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving html file. * @param value - The value to set. * * @remarks * The default value is false. */ setCalculateFormula(value: boolean) : void; /** * Indicates whether JavaScript is compatible with browsers that do not support JavaScript. * The default value is true. */ isJsBrowserCompatible : boolean; /** * @deprecated Please use the 'isJsBrowserCompatible' property instead. * Indicates whether JavaScript is compatible with browsers that do not support JavaScript. * The default value is true. * @param value - The value to set. */ setIsJsBrowserCompatible(value: boolean) : void; /** * Indicates whether the output HTML is compatible with mobile devices. * The default value is false. */ isMobileCompatible : boolean; /** * @deprecated Please use the 'isMobileCompatible' property instead. * Indicates whether the output HTML is compatible with mobile devices. * The default value is false. * @param value - The value to set. */ setIsMobileCompatible(value: boolean) : void; /** * @deprecated Please use the 'cssStyles' property instead. * Gets or sets the additional css styles for the formatter. * Only works when is True. * * CssStyles="body { padding: 5px }"; * */ getCssStyles() : string; /** * Gets or sets the additional css styles for the formatter. * Only works when is True. * * CssStyles="body { padding: 5px }"; * */ cssStyles : string; /** * @deprecated Please use the 'cssStyles' property instead. * Gets or sets the additional css styles for the formatter. * Only works when is True. * * CssStyles="body { padding: 5px }"; * * @param value - The value to set. */ setCssStyles(value: string) : void; /** * @deprecated Please use the 'hideOverflowWrappedText' property instead. * Indicates whether to hide overflow text when the cell format is set to wrap text. * The default value is false */ getHideOverflowWrappedText() : boolean; /** * Indicates whether to hide overflow text when the cell format is set to wrap text. * The default value is false */ hideOverflowWrappedText : boolean; /** * @deprecated Please use the 'hideOverflowWrappedText' property instead. * Indicates whether to hide overflow text when the cell format is set to wrap text. * The default value is false * @param value - The value to set. */ setHideOverflowWrappedText(value: boolean) : void; /** * Indicates whether the table borders are collapsed. * The default value is true. */ isBorderCollapsed : boolean; /** * @deprecated Please use the 'isBorderCollapsed' property instead. * Indicates whether the table borders are collapsed. * The default value is true. * @param value - The value to set. */ setIsBorderCollapsed(value: boolean) : void; /** * @deprecated Please use the 'encodeEntityAsCode' property instead. * Indicates whether the html character entities are replaced with decimal code. * (e.g. "&nbsp;" is replaced with "&#160;"). * The default value is false. */ getEncodeEntityAsCode() : boolean; /** * Indicates whether the html character entities are replaced with decimal code. * (e.g. "&nbsp;" is replaced with "&#160;"). * The default value is false. */ encodeEntityAsCode : boolean; /** * @deprecated Please use the 'encodeEntityAsCode' property instead. * Indicates whether the html character entities are replaced with decimal code. * (e.g. "&nbsp;" is replaced with "&#160;"). * The default value is false. * @param value - The value to set. */ setEncodeEntityAsCode(value: boolean) : void; /** * @deprecated Please use the 'officeMathOutputMode' property instead. * Indicates how OfficeMath objects are exported to HTML, Default value is Image. */ getOfficeMathOutputMode() : HtmlOfficeMathOutputType; /** * Indicates how OfficeMath objects are exported to HTML, Default value is Image. */ officeMathOutputMode : HtmlOfficeMathOutputType; /** * @deprecated Please use the 'officeMathOutputMode' property instead. * Indicates how OfficeMath objects are exported to HTML, Default value is Image. * @param value - The value to set. */ setOfficeMathOutputMode(value: HtmlOfficeMathOutputType) : void; /** * @deprecated Please use the 'cellNameAttribute' property instead. * Specifies the attribute that indicates the CellName to be written. * (e.g. If the value is "id", then for cell "A1", the output will be:<td id='A1'>). * The default value is null. */ getCellNameAttribute() : string; /** * Specifies the attribute that indicates the CellName to be written. * (e.g. If the value is "id", then for cell "A1", the output will be:<td id='A1'>). * The default value is null. */ cellNameAttribute : string; /** * @deprecated Please use the 'cellNameAttribute' property instead. * Specifies the attribute that indicates the CellName to be written. * (e.g. If the value is "id", then for cell "A1", the output will be:<td id='A1'>). * The default value is null. * @param value - The value to set. */ setCellNameAttribute(value: string) : void; /** * @deprecated Please use the 'disableCss' property instead. * Indicates whether only inline styles are applied, without relying on CSS. * The default value is false. */ getDisableCss() : boolean; /** * Indicates whether only inline styles are applied, without relying on CSS. * The default value is false. */ disableCss : boolean; /** * @deprecated Please use the 'disableCss' property instead. * Indicates whether only inline styles are applied, without relying on CSS. * The default value is false. * @param value - The value to set. */ setDisableCss(value: boolean) : void; /** * @deprecated Please use the 'enableCssCustomProperties' property instead. * Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved. * The default value is false. */ getEnableCssCustomProperties() : boolean; /** * Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved. * The default value is false. */ enableCssCustomProperties : boolean; /** * @deprecated Please use the 'enableCssCustomProperties' property instead. * Optimize the output of html by using CSS custom properties. For example, for the scenario that there are multiple occurences for one base64 image, with custom property the image data only needs to be saved once so the performance of the resultant html can be improved. * The default value is false. * @param value - The value to set. */ setEnableCssCustomProperties(value: boolean) : void; /** * @deprecated Please use the 'htmlVersion' property instead. * Specifies version of HTML standard that should be used when saving the HTML format. * Default value is HtmlVersion.Default. */ getHtmlVersion() : HtmlVersion; /** * Specifies version of HTML standard that should be used when saving the HTML format. * Default value is HtmlVersion.Default. */ htmlVersion : HtmlVersion; /** * @deprecated Please use the 'htmlVersion' property instead. * Specifies version of HTML standard that should be used when saving the HTML format. * Default value is HtmlVersion.Default. * @param value - The value to set. */ setHtmlVersion(value: HtmlVersion) : void; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . */ getSheetSet() : SheetSet; /** * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . */ sheetSet : SheetSet; /** * @deprecated Please use the 'sheetSet' property instead. * Gets or sets the sheets to render. Default is all visible sheets in the workbook: . * @param value - The value to set. */ setSheetSet(value: SheetSet) : void; /** * @deprecated Please use the 'layoutMode' property instead. * Gets or sets the layout mode when saving to HTML. * The default value is */ getLayoutMode() : HtmlLayoutMode; /** * Gets or sets the layout mode when saving to HTML. * The default value is */ layoutMode : HtmlLayoutMode; /** * @deprecated Please use the 'layoutMode' property instead. * Gets or sets the layout mode when saving to HTML. * The default value is * @param value - The value to set. */ setLayoutMode(value: HtmlLayoutMode) : void; /** * @deprecated Please use the 'embeddedFontType' property instead. * Gets or sets the type of embedding font file into html file. * Default value is which indicates that no font will be embedded in html. */ getEmbeddedFontType() : HtmlEmbeddedFontType; /** * Gets or sets the type of embedding font file into html file. * Default value is which indicates that no font will be embedded in html. */ embeddedFontType : HtmlEmbeddedFontType; /** * @deprecated Please use the 'embeddedFontType' property instead. * Gets or sets the type of embedding font file into html file. * Default value is which indicates that no font will be embedded in html. * @param value - The value to set. */ setEmbeddedFontType(value: HtmlEmbeddedFontType) : void; /** * @deprecated Please use the 'exportNamedRangeAnchors' property instead. * Indicates whether to export anchor elements for named ranges when saving as HTML. * Default value is true. */ getExportNamedRangeAnchors() : boolean; /** * Indicates whether to export anchor elements for named ranges when saving as HTML. * Default value is true. */ exportNamedRangeAnchors : boolean; /** * @deprecated Please use the 'exportNamedRangeAnchors' property instead. * Indicates whether to export anchor elements for named ranges when saving as HTML. * Default value is true. * @param value - The value to set. */ setExportNamedRangeAnchors(value: boolean) : void; /** * @deprecated Please use the 'dataBarRenderMode' property instead. * Represents the mode of how to render DataBar when converting Excel files to html files. * Default value is . */ getDataBarRenderMode() : DataBarRenderMode; /** * Represents the mode of how to render DataBar when converting Excel files to html files. * Default value is . */ dataBarRenderMode : DataBarRenderMode; /** * @deprecated Please use the 'dataBarRenderMode' property instead. * Represents the mode of how to render DataBar when converting Excel files to html files. * Default value is . * @param value - The value to set. */ setDataBarRenderMode(value: DataBarRenderMode) : void; /** * @deprecated Please use the 'spaceMode' property instead. * Indicates how spaces are rendered in HTML output. * This option is currently applied only to numeric formats (e.g. accounting format). * The default value is . */ getSpaceMode() : HtmlSpaceMode; /** * Indicates how spaces are rendered in HTML output. * This option is currently applied only to numeric formats (e.g. accounting format). * The default value is . */ spaceMode : HtmlSpaceMode; /** * @deprecated Please use the 'spaceMode' property instead. * Indicates how spaces are rendered in HTML output. * This option is currently applied only to numeric formats (e.g. accounting format). * The default value is . * @param value - The value to set. */ setSpaceMode(value: HtmlSpaceMode) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a smart tag. */ export class SmartTag { /** * @deprecated Please use the 'deleted' property instead. * Indicates whether the smart tag is deleted. */ getDeleted() : boolean; /** * Indicates whether the smart tag is deleted. */ deleted : boolean; /** * @deprecated Please use the 'deleted' property instead. * Indicates whether the smart tag is deleted. * @param value - The value to set. */ setDeleted(value: boolean) : void; /** * @deprecated Please use the 'properties' property instead. * Gets and set the properties of the smart tag. */ getProperties() : SmartTagPropertyCollection; /** * Gets and set the properties of the smart tag. */ properties : SmartTagPropertyCollection; /** * @deprecated Please use the 'properties' property instead. * Gets and set the properties of the smart tag. * @param value - The value to set. */ setProperties(value: SmartTagPropertyCollection) : void; /** * @deprecated Please use the 'uri' property instead. * Gets the namespace URI of the smart tag. */ getUri() : string; /** * Gets the namespace URI of the smart tag. */ readonly uri : string; /** * @deprecated Please use the 'name' property instead. * Gets the name of the smart tag. */ getName() : string; /** * Gets the name of the smart tag. */ readonly name : string; /** * Change the name and the namespace URI of the smart tag. * @param uri - The namespace URI of the smart tag. * @param name - The name of the smart tag. */ setLink(uri: string, name: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all smart tags in the cell. */ export class SmartTagCollection implements Iterable { /** * Gets a object at the specific index * @param index - The index. * @returns * returns a object. */ get(index: number) : SmartTag; /** * @deprecated Please use the 'row' property instead. * Gets the row of the cell smart tags. */ getRow() : number; /** * Gets the row of the cell smart tags. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets the column of the cell smart tags. */ getColumn() : number; /** * Gets the column of the cell smart tags. */ readonly column : number; /** * Adds a smart tag. * @param uri - Specifies the namespace URI of the smart tag * @param name - Specifies the name of the smart tag. * @returns * The index of smart tag in the list. */ add(uri: string, name: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the options of the smart tag. */ export class SmartTagOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'embedSmartTags' property instead. * Indicates whether saving smart tags with the workbook. */ getEmbedSmartTags() : boolean; /** * Indicates whether saving smart tags with the workbook. */ embedSmartTags : boolean; /** * @deprecated Please use the 'embedSmartTags' property instead. * Indicates whether saving smart tags with the workbook. * @param value - The value to set. */ setEmbedSmartTags(value: boolean) : void; /** * @deprecated Please use the 'showType' property instead. * Represents the show type of smart tag. */ getShowType() : SmartTagShowType; /** * Represents the show type of smart tag. */ showType : SmartTagShowType; /** * @deprecated Please use the 'showType' property instead. * Represents the show type of smart tag. * @param value - The value to set. */ setShowType(value: SmartTagShowType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all object in the worksheet. */ export class SmartTagSetting implements Iterable { /** * Gets a object by the index. * @param index - The index of the object in the list. */ get(index: number) : SmartTagCollection; /** * Gets the object of the cell. * @param row - The row index of the cell. * @param column - The column index of the cell * @returns * Returns the object of the cell. * Returns null if there is no any smart tags on the cell. */ get(row: number, column: number) : SmartTagCollection; /** * Gets the object of the cell. * @param cellName - The name of the cell. * @returns * Returns the object of the cell. * Returns null if there is no any smart tags on the cell. */ get(cellName: string) : SmartTagCollection; /** * Adds a object to a cell. * @param row - The row of the cell. * @param column - The column of the cell. * @returns * Returns index of a object in the worksheet. */ add(row: number, column: number) : number; /** * Add a cell smart tags. * @param cellName - The name of the cell. */ add(cellName: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the property of the cell smart tag. */ export class SmartTagProperty { /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the property. */ getName() : string; /** * Gets and sets the name of the property. */ name : string; /** * @deprecated Please use the 'name' property instead. * Gets and sets the name of the property. * @param value - The value to set. */ setName(value: string) : void; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the property. */ getValue() : string; /** * Gets and sets the value of the property. */ value : string; /** * @deprecated Please use the 'value' property instead. * Gets and sets the value of the property. * @param value - The value to set. */ setValue(value: string) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all properties of cell smart tag. */ export class SmartTagPropertyCollection implements Iterable { /** * Default Constructor. */ constructor(); /** * Gets a object. * @param index - The index * @returns * Returns a object. */ get(index: number) : SmartTagProperty; /** * Gets a object by the name of the property. * @param name - The name of the property. * @returns * Returns a object. */ get(name: string) : SmartTagProperty; /** * Adds a property of cell's smart tag. * @param name - The name of the property * @param value - The value of the property. * @returns * return */ add(name: string, value: string) : number; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the show type of the smart tag. */ export enum SmartTagShowType { /** * Indicates that smart tags are enabled and shown */ All = 0, /** * Indicates that the smart tags are enabled but the indicator not be shown. */ NoSmartTagIndicator = 1, /** * Indicates that smart tags are disabled and not displayed. */ None = 2, } /** * Represents the options of saving ods file. */ export class OdsSaveOptions extends SaveOptions { /** * Creates the options of saving ods file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * Creates the options of saving ods file. * @param saveFormat - The file format. /// It should be , , /// or , /// otherwise the saved format will be set as automatically. */ constructor(saveFormat: SaveFormat); /** * @deprecated Please use the 'generatorType' property instead. * Gets and sets the generator of the ods file. */ getGeneratorType() : OdsGeneratorType; /** * Gets and sets the generator of the ods file. */ generatorType : OdsGeneratorType; /** * @deprecated Please use the 'generatorType' property instead. * Gets and sets the generator of the ods file. * @param value - The value to set. */ setGeneratorType(value: OdsGeneratorType) : void; /** * Indicates whether the ods file should be saved as ODF format version 1.1. Default is false. * * @remarks * NOTE: This member is now obsolete. Instead, * please use OdsSaveOptions.OdfStrictVersion property. * This method will be removed 12 months later since February 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use OdsSaveOptions.OdfStrictVersion property instead. */ isStrictSchema11 : boolean; /** * @deprecated Please use the 'isStrictSchema11' property instead. * Indicates whether the ods file should be saved as ODF format version 1.1. Default is false. * @param value - The value to set. * * @remarks * NOTE: This member is now obsolete. Instead, * please use OdsSaveOptions.OdfStrictVersion property. * This method will be removed 12 months later since February 2024. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use OdsSaveOptions.OdfStrictVersion property instead. */ setIsStrictSchema11(value: boolean) : void; /** * @deprecated Please use the 'odfStrictVersion' property instead. * Gets and sets the ODF version. */ getOdfStrictVersion() : OpenDocumentFormatVersionType; /** * Gets and sets the ODF version. */ odfStrictVersion : OpenDocumentFormatVersionType; /** * @deprecated Please use the 'odfStrictVersion' property instead. * Gets and sets the ODF version. * @param value - The value to set. */ setOdfStrictVersion(value: OpenDocumentFormatVersionType) : void; /** * @deprecated Please use the 'ignorePivotTables' property instead. * Indicates whether saving pivot tables. * * @remarks * The pivot table feature of OpenOffice has fewer settings compared to Excel, so their results of pivot table have many differences. * Sometimes it's better to ingore these pivot tables when saving .ods file. */ getIgnorePivotTables() : boolean; /** * Indicates whether saving pivot tables. * * @remarks * The pivot table feature of OpenOffice has fewer settings compared to Excel, so their results of pivot table have many differences. * Sometimes it's better to ingore these pivot tables when saving .ods file. */ ignorePivotTables : boolean; /** * @deprecated Please use the 'ignorePivotTables' property instead. * Indicates whether saving pivot tables. * @param value - The value to set. * * @remarks * The pivot table feature of OpenOffice has fewer settings compared to Excel, so their results of pivot table have many differences. * Sometimes it's better to ingore these pivot tables when saving .ods file. */ setIgnorePivotTables(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the paste special options. */ export class PasteOptions { /** * Default Constructor. */ constructor(); /** * @deprecated Please use the 'pasteType' property instead. * The paste special type. */ getPasteType() : PasteType; /** * The paste special type. */ pasteType : PasteType; /** * @deprecated Please use the 'pasteType' property instead. * The paste special type. * @param value - The value to set. */ setPasteType(value: PasteType) : void; /** * @deprecated Please use the 'shiftFormulasOfShapes' property instead. * Indicates whether to shift formulas of the shapes when copying ranges. */ getShiftFormulasOfShapes() : boolean; /** * Indicates whether to shift formulas of the shapes when copying ranges. */ shiftFormulasOfShapes : boolean; /** * @deprecated Please use the 'shiftFormulasOfShapes' property instead. * Indicates whether to shift formulas of the shapes when copying ranges. * @param value - The value to set. */ setShiftFormulasOfShapes(value: boolean) : void; /** * @deprecated Please use the 'skipBlanks' property instead. * Indicates whether skips blank cells. */ getSkipBlanks() : boolean; /** * Indicates whether skips blank cells. */ skipBlanks : boolean; /** * @deprecated Please use the 'skipBlanks' property instead. * Indicates whether skips blank cells. * @param value - The value to set. */ setSkipBlanks(value: boolean) : void; /** * @deprecated Please use the 'keepOldTables' property instead. * Keeps the tables in the destination range. */ getKeepOldTables() : boolean; /** * Keeps the tables in the destination range. */ keepOldTables : boolean; /** * @deprecated Please use the 'keepOldTables' property instead. * Keeps the tables in the destination range. * @param value - The value to set. */ setKeepOldTables(value: boolean) : void; /** * @deprecated Please use the 'onlyVisibleCells' property instead. * True means only copying visible cells. */ getOnlyVisibleCells() : boolean; /** * True means only copying visible cells. */ onlyVisibleCells : boolean; /** * @deprecated Please use the 'onlyVisibleCells' property instead. * True means only copying visible cells. * @param value - The value to set. */ setOnlyVisibleCells(value: boolean) : void; /** * @deprecated Please use the 'transpose' property instead. * True to transpose rows and columns when the range is pasted. The default value is False. */ getTranspose() : boolean; /** * True to transpose rows and columns when the range is pasted. The default value is False. */ transpose : boolean; /** * @deprecated Please use the 'transpose' property instead. * True to transpose rows and columns when the range is pasted. The default value is False. * @param value - The value to set. */ setTranspose(value: boolean) : void; /** * @deprecated Please use the 'operationType' property instead. * Gets and sets the operation type when pasting range. */ getOperationType() : PasteOperationType; /** * Gets and sets the operation type when pasting range. */ operationType : PasteOperationType; /** * @deprecated Please use the 'operationType' property instead. * Gets and sets the operation type when pasting range. * @param value - The value to set. */ setOperationType(value: PasteOperationType) : void; /** * @deprecated Please use the 'ignoreLinksToOriginalFile' property instead. * Ingore links to the original file. */ getIgnoreLinksToOriginalFile() : boolean; /** * Ingore links to the original file. */ ignoreLinksToOriginalFile : boolean; /** * @deprecated Please use the 'ignoreLinksToOriginalFile' property instead. * Ingore links to the original file. * @param value - The value to set. */ setIgnoreLinksToOriginalFile(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the options for saving pdf file. */ export class PdfSaveOptions extends PaginatedSaveOptions { /** * Creates the options for saving pdf file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: PaginatedSaveOptions); /** * @deprecated Please use the 'embedStandardWindowsFonts' property instead. * True to embed true type fonts. * Affects only ASCII characters 32-127. * Fonts for character codes greater than 127 are always embedded. * Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. * Default is true. */ getEmbedStandardWindowsFonts() : boolean; /** * True to embed true type fonts. * Affects only ASCII characters 32-127. * Fonts for character codes greater than 127 are always embedded. * Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. * Default is true. */ embedStandardWindowsFonts : boolean; /** * @deprecated Please use the 'embedStandardWindowsFonts' property instead. * True to embed true type fonts. * Affects only ASCII characters 32-127. * Fonts for character codes greater than 127 are always embedded. * Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. * Default is true. * @param value - The value to set. */ setEmbedStandardWindowsFonts(value: boolean) : void; /** * @deprecated Please use the 'bookmark' property instead. * Gets and sets the PdfBookmarkEntry object. */ getBookmark() : PdfBookmarkEntry; /** * Gets and sets the PdfBookmarkEntry object. */ bookmark : PdfBookmarkEntry; /** * @deprecated Please use the 'bookmark' property instead. * Gets and sets the PdfBookmarkEntry object. * @param value - The value to set. */ setBookmark(value: PdfBookmarkEntry) : void; /** * @deprecated Please use the 'compliance' property instead. * Gets or sets the PDF standards compliance level for output documents. * * @remarks * Default is Pdf17. */ getCompliance() : PdfCompliance; /** * Gets or sets the PDF standards compliance level for output documents. * * @remarks * Default is Pdf17. */ compliance : PdfCompliance; /** * @deprecated Please use the 'compliance' property instead. * Gets or sets the PDF standards compliance level for output documents. * @param value - The value to set. * * @remarks * Default is Pdf17. */ setCompliance(value: PdfCompliance) : void; /** * @deprecated Please use the 'securityOptions' property instead. * Set this options, when security is need in xls2pdf result. */ getSecurityOptions() : PdfSecurityOptions; /** * Set this options, when security is need in xls2pdf result. */ securityOptions : PdfSecurityOptions; /** * @deprecated Please use the 'securityOptions' property instead. * Set this options, when security is need in xls2pdf result. * @param value - The value to set. */ setSecurityOptions(value: PdfSecurityOptions) : void; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving pdf file. * * @remarks * The default value is false. */ getCalculateFormula() : boolean; /** * Indicates whether to calculate formulas before saving pdf file. * * @remarks * The default value is false. */ calculateFormula : boolean; /** * @deprecated Please use the 'calculateFormula' property instead. * Indicates whether to calculate formulas before saving pdf file. * @param value - The value to set. * * @remarks * The default value is false. */ setCalculateFormula(value: boolean) : void; /** * @deprecated Please use the 'pdfCompression' property instead. * Indicate the compression algorithm */ getPdfCompression() : PdfCompressionCore; /** * Indicate the compression algorithm */ pdfCompression : PdfCompressionCore; /** * @deprecated Please use the 'pdfCompression' property instead. * Indicate the compression algorithm * @param value - The value to set. */ setPdfCompression(value: PdfCompressionCore) : void; /** * @deprecated Please use the 'createdTime' property instead. * Gets and sets the time of generating the pdf document. * * @remarks * if it is not be set, it will be the time of generating the pdf. */ getCreatedTime() : Date; /** * Gets and sets the time of generating the pdf document. * * @remarks * if it is not be set, it will be the time of generating the pdf. */ createdTime : Date; /** * @deprecated Please use the 'createdTime' property instead. * Gets and sets the time of generating the pdf document. * @param value - The value to set. * * @remarks * if it is not be set, it will be the time of generating the pdf. */ setCreatedTime(value: Date) : void; /** * @deprecated Please use the 'producer' property instead. * Gets and sets producer of generated pdf document. * * @remarks * If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used. */ getProducer() : string; /** * Gets and sets producer of generated pdf document. * * @remarks * If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used. */ producer : string; /** * @deprecated Please use the 'producer' property instead. * Gets and sets producer of generated pdf document. * @param value - The value to set. * * @remarks * If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used. */ setProducer(value: string) : void; /** * @deprecated Please use the 'optimizationType' property instead. * Gets and sets pdf optimization type. * * @remarks * Default value is */ getOptimizationType() : PdfOptimizationType; /** * Gets and sets pdf optimization type. * * @remarks * Default value is */ optimizationType : PdfOptimizationType; /** * @deprecated Please use the 'optimizationType' property instead. * Gets and sets pdf optimization type. * @param value - The value to set. * * @remarks * Default value is */ setOptimizationType(value: PdfOptimizationType) : void; /** * @deprecated Please use the 'customPropertiesExport' property instead. * Gets or sets a value determining the way are exported to PDF file. Default value is None. */ getCustomPropertiesExport() : PdfCustomPropertiesExport; /** * Gets or sets a value determining the way are exported to PDF file. Default value is None. */ customPropertiesExport : PdfCustomPropertiesExport; /** * @deprecated Please use the 'customPropertiesExport' property instead. * Gets or sets a value determining the way are exported to PDF file. Default value is None. * @param value - The value to set. */ setCustomPropertiesExport(value: PdfCustomPropertiesExport) : void; /** * @deprecated Please use the 'exportDocumentStructure' property instead. * Indicates whether to export document structure. */ getExportDocumentStructure() : boolean; /** * Indicates whether to export document structure. */ exportDocumentStructure : boolean; /** * @deprecated Please use the 'exportDocumentStructure' property instead. * Indicates whether to export document structure. * @param value - The value to set. */ setExportDocumentStructure(value: boolean) : void; /** * @deprecated Please use the 'displayDocTitle' property instead. * Indicates whether the window's title bar should display the document title. * * @remarks * If false, the title bar should instead display the name of the PDF file. * Default value is false. */ getDisplayDocTitle() : boolean; /** * Indicates whether the window's title bar should display the document title. * * @remarks * If false, the title bar should instead display the name of the PDF file. * Default value is false. */ displayDocTitle : boolean; /** * @deprecated Please use the 'displayDocTitle' property instead. * Indicates whether the window's title bar should display the document title. * @param value - The value to set. * * @remarks * If false, the title bar should instead display the name of the PDF file. * Default value is false. */ setDisplayDocTitle(value: boolean) : void; /** * @deprecated Please use the 'fontEncoding' property instead. * Gets or sets embedded font encoding in pdf. * * @remarks * Default value is */ getFontEncoding() : PdfFontEncoding; /** * Gets or sets embedded font encoding in pdf. * * @remarks * Default value is */ fontEncoding : PdfFontEncoding; /** * @deprecated Please use the 'fontEncoding' property instead. * Gets or sets embedded font encoding in pdf. * @param value - The value to set. * * @remarks * Default value is */ setFontEncoding(value: PdfFontEncoding) : void; /** * @deprecated Please use the 'watermark' property instead. * Gets or sets watermark to output. */ getWatermark() : RenderingWatermark; /** * Gets or sets watermark to output. */ watermark : RenderingWatermark; /** * @deprecated Please use the 'watermark' property instead. * Gets or sets watermark to output. * @param value - The value to set. */ setWatermark(value: RenderingWatermark) : void; /** * @deprecated Please use the 'embedAttachments' property instead. * Indicates whether to embed attachment for Ole objects in Excel. * * @remarks * Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled. */ getEmbedAttachments() : boolean; /** * Indicates whether to embed attachment for Ole objects in Excel. * * @remarks * Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled. */ embedAttachments : boolean; /** * @deprecated Please use the 'embedAttachments' property instead. * Indicates whether to embed attachment for Ole objects in Excel. * @param value - The value to set. * * @remarks * Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled. */ setEmbedAttachments(value: boolean) : void; /** * @deprecated Please use the 'zoomBehavior' property instead. * Gets or sets the initial view mode when the generated PDF document is opened. * The default value is . */ getZoomBehavior() : PdfZoomBehavior; /** * Gets or sets the initial view mode when the generated PDF document is opened. * The default value is . */ zoomBehavior : PdfZoomBehavior; /** * @deprecated Please use the 'zoomBehavior' property instead. * Gets or sets the initial view mode when the generated PDF document is opened. * The default value is . * @param value - The value to set. */ setZoomBehavior(value: PdfZoomBehavior) : void; /** * @deprecated Please use the 'zoomFactor' property instead. * Gets or sets the zoom percentage used when * is . * * @remarks * This property is ignored unless * is . */ getZoomFactor() : number; /** * Gets or sets the zoom percentage used when * is . * * @remarks * This property is ignored unless * is . */ zoomFactor : number; /** * @deprecated Please use the 'zoomFactor' property instead. * Gets or sets the zoom percentage used when * is . * @param value - The value to set. * * @remarks * This property is ignored unless * is . */ setZoomFactor(value: number) : void; /** * Sets desired PPI(pixels per inch) of resample images and jpeg quality. * All images will be converted to JPEG with the specified quality setting, * and images that are greater than the specified PPI (pixels per inch) will be resampled. * @param desiredPPI - Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality. * @param jpegQuality - 0 - 100% JPEG quality. */ setImageResample(desiredPPI: number, jpegQuality: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a bevel of a shape */ export class Bevel { /** * @deprecated Please use the 'width' property instead. * Gets and sets the width of the bevel, or how far into the shape it is applied. * In unit of Points. */ getWidth() : number; /** * Gets and sets the width of the bevel, or how far into the shape it is applied. * In unit of Points. */ width : number; /** * @deprecated Please use the 'width' property instead. * Gets and sets the width of the bevel, or how far into the shape it is applied. * In unit of Points. * @param value - The value to set. */ setWidth(value: number) : void; /** * @deprecated Please use the 'height' property instead. * Gets and sets the height of the bevel, or how far above the shape it is applied. * In unit of Points. */ getHeight() : number; /** * Gets and sets the height of the bevel, or how far above the shape it is applied. * In unit of Points. */ height : number; /** * @deprecated Please use the 'height' property instead. * Gets and sets the height of the bevel, or how far above the shape it is applied. * In unit of Points. * @param value - The value to set. */ setHeight(value: number) : void; /** * @deprecated Please use the 'type' property instead. * Gets and sets the preset bevel type. */ getType() : BevelPresetType; /** * Gets and sets the preset bevel type. */ type : BevelPresetType; /** * @deprecated Please use the 'type' property instead. * Gets and sets the preset bevel type. * @param value - The value to set. */ setType(value: BevelPresetType) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents a preset for a type of bevel which can be applied to a shape in 3D. */ export enum BevelType { /** * No bevel */ None = 0, /** * Angle */ Angle = 1, /** * Art deco */ ArtDeco = 2, /** * Circle */ Circle = 3, /** * Convex */ Convex = 4, /** * Cool slant */ CoolSlant = 5, /** * Cross */ Cross = 6, /** * Divot */ Divot = 7, /** * Hard edge */ HardEdge = 8, /** * Relaxed inset */ RelaxedInset = 9, /** * Riblet */ Riblet = 10, /** * Slope */ Slope = 11, /** * Soft round */ SoftRound = 12, } /** * This class specifies the 3D shape properties for a chart element or shape. */ export class Format3D { /** * @deprecated Please use the 'topBevel' property instead. * Gets the object that holds the properties associated with defining a bevel on the top or front face of a shape. */ getTopBevel() : Bevel; /** * Gets the object that holds the properties associated with defining a bevel on the top or front face of a shape. */ readonly topBevel : Bevel; /** * @deprecated Please use the 'surfaceMaterialType' property instead. * Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. * Default value is PresetMaterialType.WarmMatte. */ getSurfaceMaterialType() : PresetMaterialType; /** * Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. * Default value is PresetMaterialType.WarmMatte. */ surfaceMaterialType : PresetMaterialType; /** * @deprecated Please use the 'surfaceMaterialType' property instead. * Gets and sets the material type which is combined with the lighting properties to give the final look and feel of a shape. * Default value is PresetMaterialType.WarmMatte. * @param value - The value to set. */ setSurfaceMaterialType(value: PresetMaterialType) : void; /** * @deprecated Please use the 'surfaceLightingType' property instead. * Gets and sets the lighting type which is to be applied to the scene of the shape. * Default value is LightRigType.ThreePoint. */ getSurfaceLightingType() : LightRigType; /** * Gets and sets the lighting type which is to be applied to the scene of the shape. * Default value is LightRigType.ThreePoint. */ surfaceLightingType : LightRigType; /** * @deprecated Please use the 'surfaceLightingType' property instead. * Gets and sets the lighting type which is to be applied to the scene of the shape. * Default value is LightRigType.ThreePoint. * @param value - The value to set. */ setSurfaceLightingType(value: LightRigType) : void; /** * @deprecated Please use the 'lightingAngle' property instead. * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. */ getLightingAngle() : number; /** * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. */ lightingAngle : number; /** * @deprecated Please use the 'lightingAngle' property instead. * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. * @param value - The value to set. */ setLightingAngle(value: number) : void; /** * Indicates if the shape has top bevel data. */ hasTopBevelData() : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies a glow effect, in which a color blurred outline * is added outside the edges of the object. */ export class GlowEffect { /** * @deprecated Please use the 'color' property instead. * Gets the color of the glow effect. */ getColor() : CellsColor; /** * Gets the color of the glow effect. */ color : CellsColor; /** * @deprecated Please use the 'color' property instead. * Gets the color of the glow effect. * @param value - The value to set. */ setColor(value: CellsColor) : void; /** * @deprecated Please use the 'size' property instead. * Gets and sets the radius of the glow, in unit of points. */ getSize() : number; /** * Gets and sets the radius of the glow, in unit of points. */ size : number; /** * @deprecated Please use the 'size' property instead. * Gets and sets the radius of the glow, in unit of points. * @param value - The value to set. */ setSize(value: number) : void; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of transparency of the glow effect. Range from 0.0 (opaque) to 1.0 (clear). */ getTransparency() : number; /** * Gets and sets the degree of transparency of the glow effect. Range from 0.0 (opaque) to 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of transparency of the glow effect. Range from 0.0 (opaque) to 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represent different algorithmic methods for setting all camera properties, including position. */ export enum PresetCameraType { /** */ IsometricBottomDown = 0, /** */ IsometricBottomUp = 1, /** */ IsometricLeftDown = 2, /** */ IsometricLeftUp = 3, /** */ IsometricOffAxis1Left = 4, /** */ IsometricOffAxis1Right = 5, /** */ IsometricOffAxis1Top = 6, /** */ IsometricOffAxis2Left = 7, /** */ IsometricOffAxis2Right = 8, /** */ IsometricOffAxis2Top = 9, /** */ IsometricOffAxis3Bottom = 10, /** */ IsometricOffAxis3Left = 11, /** */ IsometricOffAxis3Right = 12, /** */ IsometricOffAxis4Bottom = 13, /** */ IsometricOffAxis4Left = 14, /** */ IsometricOffAxis4Right = 15, /** */ IsometricRightDown = 16, /** */ IsometricRightUp = 17, /** */ IsometricTopDown = 18, /** */ IsometricTopUp = 19, /** */ LegacyObliqueBottom = 20, /** */ LegacyObliqueBottomLeft = 21, /** */ LegacyObliqueBottomRight = 22, /** */ LegacyObliqueFront = 23, /** */ LegacyObliqueLeft = 24, /** */ LegacyObliqueRight = 25, /** */ LegacyObliqueTop = 26, /** */ LegacyObliqueTopLeft = 27, /** */ LegacyObliqueTopRight = 28, /** */ LegacyPerspectiveBottom = 29, /** */ LegacyPerspectiveBottomLeft = 30, /** */ LegacyPerspectiveBottomRight = 31, /** */ LegacyPerspectiveFront = 32, /** */ LegacyPerspectiveLeft = 33, /** */ LegacyPerspectiveRight = 34, /** */ LegacyPerspectiveTop = 35, /** */ LegacyPerspectiveTopLeft = 36, /** */ LegacyPerspectiveTopRight = 37, /** */ ObliqueBottom = 38, /** */ ObliqueBottomLeft = 39, /** */ ObliqueBottomRight = 40, /** */ ObliqueLeft = 41, /** */ ObliqueRight = 42, /** */ ObliqueTop = 43, /** */ ObliqueTopLeft = 44, /** */ ObliqueTopRight = 45, /** */ OrthographicFront = 46, /** */ PerspectiveAbove = 47, /** */ PerspectiveAboveLeftFacing = 48, /** */ PerspectiveAboveRightFacing = 49, /** */ PerspectiveBelow = 50, /** */ PerspectiveContrastingLeftFacing = 51, /** */ PerspectiveContrastingRightFacing = 52, /** */ PerspectiveFront = 53, /** */ PerspectiveHeroicExtremeLeftFacing = 54, /** */ PerspectiveHeroicExtremeRightFacing = 55, /** */ PerspectiveHeroicLeftFacing = 56, /** */ PerspectiveHeroicRightFacing = 57, /** */ PerspectiveLeft = 58, /** */ PerspectiveRelaxed = 59, /** */ PerspectiveRelaxedModerately = 60, /** */ PerspectiveRight = 61, } /** * Represents preset shadow type. */ export enum PresetShadowType { /** * No shadow. */ NoShadow = 0, /** * Custom shadow. */ Custom = 1, /** * Outer shadow offset diagonal bottom right. */ OffsetDiagonalBottomRight = 2, /** * Outer shadow offset bottom. */ OffsetBottom = 3, /** * Outer shadow offset diagonal bottom left. */ OffsetDiagonalBottomLeft = 4, /** * Outer shadow offset right. */ OffsetRight = 5, /** * Outer shadow offset center. */ OffsetCenter = 6, /** * Outer shadow offset left. */ OffsetLeft = 7, /** * Outer shadow offset diagonal top right. */ OffsetDiagonalTopRight = 8, /** * Outer shadow offset top. */ OffsetTop = 9, /** * Outer shadow offset diagonal top left. */ OffsetDiagonalTopLeft = 10, /** * Inner shadow inside diagonal top Left. */ InsideDiagonalTopLeft = 11, /** * Inner shadow inside top. */ InsideTop = 12, /** * Inner shadow inside diagonal top right. */ InsideDiagonalTopRight = 13, /** * Inner shadow inside left. */ InsideLeft = 14, /** * Inner shadow inside center. */ InsideCenter = 15, /** * Inner shadow inside right. */ InsideRight = 16, /** * Inner shadow inside diagonal bottom left. */ InsideDiagonalBottomLeft = 17, /** * Inner shadow inside bottom. */ InsideBottom = 18, /** * Inner shadow inside diagonal bottom right. */ InsideDiagonalBottomRight = 19, /** * Outer shadow perspective diagonal upper left. */ PerspectiveDiagonalUpperLeft = 20, /** * Outer shadow perspective diagonal upper right. */ PerspectiveDiagonalUpperRight = 21, /** * Outer shadow below. */ Below = 22, /** * Outer shadow perspective diagonal lower left. */ PerspectiveDiagonalLowerLeft = 23, /** * Outer shadow perspective diagonal lower right. */ PerspectiveDiagonalLowerRight = 24, } /** * This class specifies a reflection effect. */ export class ReflectionEffect { /** * @deprecated Please use the 'type' property instead. * Gets and sets the preset reflection effect. */ getType() : ReflectionEffectType; /** * Gets and sets the preset reflection effect. */ type : ReflectionEffectType; /** * @deprecated Please use the 'type' property instead. * Gets and sets the preset reflection effect. * @param value - The value to set. */ setType(value: ReflectionEffectType) : void; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of the starting reflection transparency as a value from 0.0 (opaque) through 1.0 (clear). */ getTransparency() : number; /** * Gets and sets the degree of the starting reflection transparency as a value from 0.0 (opaque) through 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of the starting reflection transparency as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * @deprecated Please use the 'size' property instead. * Gets and sets the end position (along the alpha gradient ramp) of the end alpha value,in unit of percentage */ getSize() : number; /** * Gets and sets the end position (along the alpha gradient ramp) of the end alpha value,in unit of percentage */ size : number; /** * @deprecated Please use the 'size' property instead. * Gets and sets the end position (along the alpha gradient ramp) of the end alpha value,in unit of percentage * @param value - The value to set. */ setSize(value: number) : void; /** * @deprecated Please use the 'blur' property instead. * Gets and sets the blur radius,in unit of points. */ getBlur() : number; /** * Gets and sets the blur radius,in unit of points. */ blur : number; /** * @deprecated Please use the 'blur' property instead. * Gets and sets the blur radius,in unit of points. * @param value - The value to set. */ setBlur(value: number) : void; /** * @deprecated Please use the 'direction' property instead. * Gets and sets the direction of the alpha gradient ramp relative to the shape itself. */ getDirection() : number; /** * Gets and sets the direction of the alpha gradient ramp relative to the shape itself. */ direction : number; /** * @deprecated Please use the 'direction' property instead. * Gets and sets the direction of the alpha gradient ramp relative to the shape itself. * @param value - The value to set. */ setDirection(value: number) : void; /** * @deprecated Please use the 'distance' property instead. * Gets and sets how far to distance the shadow,in unit of points. */ getDistance() : number; /** * Gets and sets how far to distance the shadow,in unit of points. */ distance : number; /** * @deprecated Please use the 'distance' property instead. * Gets and sets how far to distance the shadow,in unit of points. * @param value - The value to set. */ setDistance(value: number) : void; /** * @deprecated Please use the 'fadeDirection' property instead. * Gets and sets the direction to offset the reflection. */ getFadeDirection() : number; /** * Gets and sets the direction to offset the reflection. */ fadeDirection : number; /** * @deprecated Please use the 'fadeDirection' property instead. * Gets and sets the direction to offset the reflection. * @param value - The value to set. */ setFadeDirection(value: number) : void; /** * @deprecated Please use the 'rotWithShape' property instead. * Gets and sets if the reflection should rotate with the shape. */ getRotWithShape() : boolean; /** * Gets and sets if the reflection should rotate with the shape. */ rotWithShape : boolean; /** * @deprecated Please use the 'rotWithShape' property instead. * Gets and sets if the reflection should rotate with the shape. * @param value - The value to set. */ setRotWithShape(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * This class specifies the shadow effect of the chart element or shape. */ export class ShadowEffect { /** * @deprecated Please use the 'presetType' property instead. * Gets and sets the preset shadow type of the shadow. */ getPresetType() : PresetShadowType; /** * Gets and sets the preset shadow type of the shadow. */ presetType : PresetShadowType; /** * @deprecated Please use the 'presetType' property instead. * Gets and sets the preset shadow type of the shadow. * @param value - The value to set. */ setPresetType(value: PresetShadowType) : void; /** * @deprecated Please use the 'color' property instead. * Gets and sets the color of the shadow. */ getColor() : CellsColor; /** * Gets and sets the color of the shadow. */ color : CellsColor; /** * @deprecated Please use the 'color' property instead. * Gets and sets the color of the shadow. * @param value - The value to set. */ setColor(value: CellsColor) : void; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). */ getTransparency() : number; /** * Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * @deprecated Please use the 'size' property instead. * Gets and sets the size of the shadow. Range from 0 to 2.0. * Meaningless in inner shadow. */ getSize() : number; /** * Gets and sets the size of the shadow. Range from 0 to 2.0. * Meaningless in inner shadow. */ size : number; /** * @deprecated Please use the 'size' property instead. * Gets and sets the size of the shadow. Range from 0 to 2.0. * Meaningless in inner shadow. * @param value - The value to set. */ setSize(value: number) : void; /** * @deprecated Please use the 'blur' property instead. * Gets and sets the blur of the shadow. Range from 0 to 100 points. */ getBlur() : number; /** * Gets and sets the blur of the shadow. Range from 0 to 100 points. */ blur : number; /** * @deprecated Please use the 'blur' property instead. * Gets and sets the blur of the shadow. Range from 0 to 100 points. * @param value - The value to set. */ setBlur(value: number) : void; /** * @deprecated Please use the 'angle' property instead. * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. */ getAngle() : number; /** * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. */ angle : number; /** * @deprecated Please use the 'angle' property instead. * Gets and sets the lighting angle. Range from 0 to 359.9 degrees. * @param value - The value to set. */ setAngle(value: number) : void; /** * @deprecated Please use the 'distance' property instead. * Gets and sets the distance of the shadow. Range from 0 to 200 points. */ getDistance() : number; /** * Gets and sets the distance of the shadow. Range from 0 to 200 points. */ distance : number; /** * @deprecated Please use the 'distance' property instead. * Gets and sets the distance of the shadow. Range from 0 to 200 points. * @param value - The value to set. */ setDistance(value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Describes surface appearance of a shape. */ export enum PresetMaterialType { /** * Clear */ Clear = 0, /** * Dark edge */ DarkEdge = 1, /** * Flat */ Flat = 2, /** * Legacy matte */ LegacyMatte = 3, /** * Legacy metal */ LegacyMetal = 4, /** * Legacy plastic */ LegacyPlastic = 5, /** * Legacy wireframe */ LegacyWireframe = 6, /** * Matte */ Matte = 7, /** * Metal */ Metal = 8, /** * Plastic */ Plastic = 9, /** * Powder */ Powder = 10, /** * Soft edge */ SoftEdge = 11, /** * Soft metal */ SoftMetal = 12, /** * Translucent powder */ TranslucentPowder = 13, /** * Warm matte */ WarmMatte = 14, } /** * Represents how to position two rectangles relative to each other. */ export enum RectangleAlignmentType { /** * Bottom */ Bottom = 0, /** * BottomLeft */ BottomLeft = 1, /** * BottomRight */ BottomRight = 2, /** * Center */ Center = 3, /** * Left */ Left = 4, /** * Right */ Right = 5, /** * Top */ Top = 6, /** * TopLeft */ TopLeft = 7, /** * TopRight */ TopRight = 8, } /** * This class specifies the visual shape properties for a chart element or shape. */ export class ShapePropertyCollection { /** * @deprecated Please use the 'glowEffect' property instead. * Represents a object that specifies glow effect for the chart element or shape. */ getGlowEffect() : GlowEffect; /** * Represents a object that specifies glow effect for the chart element or shape. */ readonly glowEffect : GlowEffect; /** * @deprecated Please use the 'format3D' property instead. * Represents a object that specifies 3D shape properties for the chart element or shape. */ getFormat3D() : Format3D; /** * Represents a object that specifies 3D shape properties for the chart element or shape. */ readonly format3D : Format3D; /** * @deprecated Please use the 'softEdgeRadius' property instead. * Gets and sets the radius of blur to apply to the edges, in unit of points. */ getSoftEdgeRadius() : number; /** * Gets and sets the radius of blur to apply to the edges, in unit of points. */ softEdgeRadius : number; /** * @deprecated Please use the 'softEdgeRadius' property instead. * Gets and sets the radius of blur to apply to the edges, in unit of points. * @param value - The value to set. */ setSoftEdgeRadius(value: number) : void; /** * @deprecated Please use the 'shadowEffect' property instead. * Represents a object that specifies shadow effect for the chart element or shape. */ getShadowEffect() : ShadowEffect; /** * Represents a object that specifies shadow effect for the chart element or shape. */ readonly shadowEffect : ShadowEffect; /** * Clears the glow effect of the shape. */ clearGlowEffect() : void; /** * Indicates if the shape has glow effect data. */ hasGlowEffect() : boolean; /** * Indicates if the shape has 3d format data. */ hasFormat3D() : boolean; /** * Clears the 3D shape properties of the shape. */ clearFormat3D() : void; /** * Clears the shadow effect of the chart element or shape. */ clearShadowEffect() : void; /** * Indicates if the shape has shadow effect data. */ hasShadowEffect() : boolean; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the scheme type of the font. */ export enum FontSchemeType { /** * None */ None = 0, /** * Major scheme. */ Major = 1, /** * Minor scheme. * * @remarks * The font's name will be automatically changed with the language. */ Minor = 2, } /** * Represents all referred cells and areas. */ export class ReferredAreaCollection implements Iterable { /** * @param index - */ get(index: number) : ReferredArea; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the format in which the workbook is saved. */ export enum SaveFormat { /** * Comma-Separated Values(CSV) text file. */ Csv = 1, /** * Comma-Separated Values(CSV) text file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Csv instead. */ CSV = 1, /** * Represents an xlsx file. */ Xlsx = 6, /** * Represents an xlsm file which enable macros. */ Xlsm = 7, /** * Represents an xltx file. */ Xltx = 8, /** * Represents an xltm file which enable macros. */ Xltm = 9, /** * Represents an xltm file which enable addin macros. */ Xlam = 10, /** * Tab-Separated Values(TSV) text file. */ Tsv = 11, /** * Tab-Separated Values(TSV) text file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use FileFormatType.Tsv instead. */ TSV = 11, /** * Represents a tab delimited text file, same with . */ TabDelimited = 11, /** * Represents a html file. */ Html = 12, /** * Represents a mhtml file. */ MHtml = 17, /** * Open Document Sheet(ODS) file. */ Ods = 14, /** * Open Document Sheet(ODS) file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Ods instead. */ ODS = 14, /** * Represents an Excel97-2003 xls file. */ Excel97To2003 = 5, /** * Represents an Excel 2003 xml file. */ SpreadsheetML = 15, /** * Represents an xlsb file. */ Xlsb = 16, /** * If saving the file to the disk,the file format accords to the extension of the file name. * If saving the file to the stream, the file format is xlsx. */ Auto = 0, /** * Represents unrecognized format, cannot be saved. */ Unknown = 255, /** * Represents a Pdf file. */ Pdf = 13, /** * XPS (XML Paper Specification) format. */ Xps = 20, /** * XPS (XML Paper Specification) format. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Xps instead. */ XPS = 20, /** * Represents a TIFF file. */ Tiff = 21, /** * Represents a TIFF file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Tiff instead. */ TIFF = 21, /** * SVG file. */ Svg = 28, /** * SVG file. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Svg instead. */ SVG = 28, /** * Data Interchange Format. */ Dif = 30, /** * Open Document Template Sheet(OTS) file. */ Ots = 31, /** * Excel 97-2003 template file. */ Xlt = 32, /** * Represents a simple xml file. */ Xml = 51, /** * Represents a numbers file. * * @remarks * Not supported. */ Numbers = 56, /** * Represents markdown document. */ Markdown = 57, /** * Represents OpenDocument Flat XML Spreadsheet (.fods) file format. */ Fods = 59, /** * Represents OpenDocument Flat XML Spreadsheet (.fods) file format. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Fods instead. */ FODS = 59, /** * Represents StarOffice Calc Spreadsheet (.sxc) file format. */ Sxc = 60, /** * Represents StarOffice Calc Spreadsheet (.sxc) file format. * NOTE: This member is now obsolete. Instead, * please use property. * This property will be removed 6 months later since April 2021. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SaveFormat.Sxc instead. */ SXC = 60, /** * Represents .pptx file. */ Pptx = 61, /** * Represents .docx file. */ Docx = 62, /** * Windows Enhanced Metafile. */ Emf = 258, /** * JPEG JFIF. */ Jpg = 261, /** * Portable Network Graphics. */ Png = 262, /** * Windows Bitmap */ Bmp = 263, /** * Gif */ Gif = 322, /** * Json */ Json = 513, /** * Sql */ SqlScript = 514, /** * Rrepesents XHtml file. * please use property. * This property will be removed 6 months later since March 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use HtmlVersion.XHtml instead. */ XHtml = 771, /** * Represents Epub file. */ Epub = 772, /** * Represents Azw3 file. */ Azw3 = 773, /** * PCL (Printer Command Language) */ Pcl = 1025, /** * OFD (Open Fixed-layout Document) */ Ofd = 1026, /** * Xbase Data file */ Dbf = 515, } /** * A sparkline represents a tiny chart or graphic in a worksheet cell that provides a visual representation of data. */ export class Sparkline { /** * @deprecated Please use the 'dataRange' property instead. * Represents the data range of the sparkline. */ getDataRange() : string; /** * Represents the data range of the sparkline. */ dataRange : string; /** * @deprecated Please use the 'dataRange' property instead. * Represents the data range of the sparkline. * @param value - The value to set. */ setDataRange(value: string) : void; /** * @deprecated Please use the 'row' property instead. * Gets the row index of the sparkline. */ getRow() : number; /** * Gets the row index of the sparkline. */ readonly row : number; /** * @deprecated Please use the 'column' property instead. * Gets the column index of the sparkline. */ getColumn() : number; /** * Gets the column index of the sparkline. */ readonly column : number; /** * Converts a sparkline to an image. * @param fileName - The image file name. * @param options - The image options */ toImage(fileName: string, options: ImageOrPrintOptions) : void; /** * Converts a sparkline to an image. * @param options - The image options. * @returns * The result stream. */ toImage(options: ImageOrPrintOptions) : Uint8Array; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the minimum and maximum value types for the sparkline vertical axis. */ export enum SparklineAxisMinMaxType { /** * Automatic for each sparkline. */ AutoIndividual = 0, /** * Same for all sparklines in the group. */ Group = 1, /** * Custom value for sparkline. */ Custom = 2, } /** * Encapsulates a collection of objects. */ export class SparklineCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : Sparkline; /** * Add a sparkline. * @param dataRange - Specifies the new data range of the sparkline. * @param row - The row index of the location. * @param column - The column index of the location. */ add(dataRange: string, row: number, column: number) : number; /** * Removes the sparkline * @param o - * * @remarks * NOTE: This member is now obsolete. Instead, * please use RemoveSparkline() method. * This method will be removed 6 months later since December 2025. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SparklineCollection.RemoveSparkline(Sparkline) method instead. */ remove(o: Object) : void; /** * Removes the sparkline * @param o - */ removeSparkline(o: Sparkline) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * is organized into a sparkline group. * A SparklineGroup contains a variable number of sparkline items. * A sparkline group specifies the type, display settings and axis settings for the sparklines. */ export class SparklineGroup { /** * @deprecated Please use the 'presetStyle' property instead. * Gets and sets the preset style type of the sparkline group. * * @remarks * If this property is set,these properties: SeriesColor,NegativePointsColor,HorizontalAxisColor,MarkersColor,FirstPointColor,LastPointColor,HighPointColor,LowPointColor will be covered. * So please set property first ,then set others. */ getPresetStyle() : SparklinePresetStyleType; /** * Gets and sets the preset style type of the sparkline group. * * @remarks * If this property is set,these properties: SeriesColor,NegativePointsColor,HorizontalAxisColor,MarkersColor,FirstPointColor,LastPointColor,HighPointColor,LowPointColor will be covered. * So please set property first ,then set others. */ presetStyle : SparklinePresetStyleType; /** * @deprecated Please use the 'presetStyle' property instead. * Gets and sets the preset style type of the sparkline group. * @param value - The value to set. * * @remarks * If this property is set,these properties: SeriesColor,NegativePointsColor,HorizontalAxisColor,MarkersColor,FirstPointColor,LastPointColor,HighPointColor,LowPointColor will be covered. * So please set property first ,then set others. */ setPresetStyle(value: SparklinePresetStyleType) : void; /** * @deprecated Please use the 'sparklines' property instead. * Gets the collection of object. */ getSparklines() : SparklineCollection; /** * Gets the collection of object. */ readonly sparklines : SparklineCollection; /** * @deprecated Please use the 'type' property instead. * Indicates the sparkline type of the sparkline group. */ getType() : SparklineType; /** * Indicates the sparkline type of the sparkline group. */ type : SparklineType; /** * @deprecated Please use the 'type' property instead. * Indicates the sparkline type of the sparkline group. * @param value - The value to set. */ setType(value: SparklineType) : void; /** * @deprecated Please use the 'plotEmptyCellsType' property instead. * Indicates how to plot empty cells. */ getPlotEmptyCellsType() : PlotEmptyCellsType; /** * Indicates how to plot empty cells. */ plotEmptyCellsType : PlotEmptyCellsType; /** * @deprecated Please use the 'plotEmptyCellsType' property instead. * Indicates how to plot empty cells. * @param value - The value to set. */ setPlotEmptyCellsType(value: PlotEmptyCellsType) : void; /** * @deprecated Please use the 'displayHidden' property instead. * Indicates whether to show data in hidden rows and columns. */ getDisplayHidden() : boolean; /** * Indicates whether to show data in hidden rows and columns. */ displayHidden : boolean; /** * @deprecated Please use the 'displayHidden' property instead. * Indicates whether to show data in hidden rows and columns. * @param value - The value to set. */ setDisplayHidden(value: boolean) : void; /** * @deprecated Please use the 'showHighPoint' property instead. * Indicates whether to highlight the highest points of data in the sparkline group. */ getShowHighPoint() : boolean; /** * Indicates whether to highlight the highest points of data in the sparkline group. */ showHighPoint : boolean; /** * @deprecated Please use the 'showHighPoint' property instead. * Indicates whether to highlight the highest points of data in the sparkline group. * @param value - The value to set. */ setShowHighPoint(value: boolean) : void; /** * @deprecated Please use the 'highPointColor' property instead. * Gets and sets the color of the highest points of data in the sparkline group. */ getHighPointColor() : CellsColor; /** * Gets and sets the color of the highest points of data in the sparkline group. */ highPointColor : CellsColor; /** * @deprecated Please use the 'highPointColor' property instead. * Gets and sets the color of the highest points of data in the sparkline group. * @param value - The value to set. */ setHighPointColor(value: CellsColor) : void; /** * @deprecated Please use the 'showLowPoint' property instead. * Indicates whether to highlight the lowest points of data in the sparkline group. */ getShowLowPoint() : boolean; /** * Indicates whether to highlight the lowest points of data in the sparkline group. */ showLowPoint : boolean; /** * @deprecated Please use the 'showLowPoint' property instead. * Indicates whether to highlight the lowest points of data in the sparkline group. * @param value - The value to set. */ setShowLowPoint(value: boolean) : void; /** * @deprecated Please use the 'lowPointColor' property instead. * Gets and sets the color of the lowest points of data in the sparkline group. */ getLowPointColor() : CellsColor; /** * Gets and sets the color of the lowest points of data in the sparkline group. */ lowPointColor : CellsColor; /** * @deprecated Please use the 'lowPointColor' property instead. * Gets and sets the color of the lowest points of data in the sparkline group. * @param value - The value to set. */ setLowPointColor(value: CellsColor) : void; /** * @deprecated Please use the 'showNegativePoints' property instead. * Indicates whether to highlight the negative values on the sparkline group with a different color or marker. */ getShowNegativePoints() : boolean; /** * Indicates whether to highlight the negative values on the sparkline group with a different color or marker. */ showNegativePoints : boolean; /** * @deprecated Please use the 'showNegativePoints' property instead. * Indicates whether to highlight the negative values on the sparkline group with a different color or marker. * @param value - The value to set. */ setShowNegativePoints(value: boolean) : void; /** * @deprecated Please use the 'negativePointsColor' property instead. * Gets and sets the color of the negative values on the sparkline group. */ getNegativePointsColor() : CellsColor; /** * Gets and sets the color of the negative values on the sparkline group. */ negativePointsColor : CellsColor; /** * @deprecated Please use the 'negativePointsColor' property instead. * Gets and sets the color of the negative values on the sparkline group. * @param value - The value to set. */ setNegativePointsColor(value: CellsColor) : void; /** * @deprecated Please use the 'showFirstPoint' property instead. * Indicates whether to highlight the first point of data in the sparkline group. */ getShowFirstPoint() : boolean; /** * Indicates whether to highlight the first point of data in the sparkline group. */ showFirstPoint : boolean; /** * @deprecated Please use the 'showFirstPoint' property instead. * Indicates whether to highlight the first point of data in the sparkline group. * @param value - The value to set. */ setShowFirstPoint(value: boolean) : void; /** * @deprecated Please use the 'firstPointColor' property instead. * Gets and sets the color of the first point of data in the sparkline group. */ getFirstPointColor() : CellsColor; /** * Gets and sets the color of the first point of data in the sparkline group. */ firstPointColor : CellsColor; /** * @deprecated Please use the 'firstPointColor' property instead. * Gets and sets the color of the first point of data in the sparkline group. * @param value - The value to set. */ setFirstPointColor(value: CellsColor) : void; /** * @deprecated Please use the 'showLastPoint' property instead. * Indicates whether to highlight the last point of data in the sparkline group. */ getShowLastPoint() : boolean; /** * Indicates whether to highlight the last point of data in the sparkline group. */ showLastPoint : boolean; /** * @deprecated Please use the 'showLastPoint' property instead. * Indicates whether to highlight the last point of data in the sparkline group. * @param value - The value to set. */ setShowLastPoint(value: boolean) : void; /** * @deprecated Please use the 'lastPointColor' property instead. * Gets and sets the color of the last point of data in the sparkline group. */ getLastPointColor() : CellsColor; /** * Gets and sets the color of the last point of data in the sparkline group. */ lastPointColor : CellsColor; /** * @deprecated Please use the 'lastPointColor' property instead. * Gets and sets the color of the last point of data in the sparkline group. * @param value - The value to set. */ setLastPointColor(value: CellsColor) : void; /** * @deprecated Please use the 'showMarkers' property instead. * Indicates whether to highlight each point in each line sparkline in the sparkline group. */ getShowMarkers() : boolean; /** * Indicates whether to highlight each point in each line sparkline in the sparkline group. */ showMarkers : boolean; /** * @deprecated Please use the 'showMarkers' property instead. * Indicates whether to highlight each point in each line sparkline in the sparkline group. * @param value - The value to set. */ setShowMarkers(value: boolean) : void; /** * @deprecated Please use the 'markersColor' property instead. * Gets and sets the color of points in each line sparkline in the sparkline group. */ getMarkersColor() : CellsColor; /** * Gets and sets the color of points in each line sparkline in the sparkline group. */ markersColor : CellsColor; /** * @deprecated Please use the 'markersColor' property instead. * Gets and sets the color of points in each line sparkline in the sparkline group. * @param value - The value to set. */ setMarkersColor(value: CellsColor) : void; /** * @deprecated Please use the 'seriesColor' property instead. * Gets and sets the color of the sparklines in the sparkline group. */ getSeriesColor() : CellsColor; /** * Gets and sets the color of the sparklines in the sparkline group. */ seriesColor : CellsColor; /** * @deprecated Please use the 'seriesColor' property instead. * Gets and sets the color of the sparklines in the sparkline group. * @param value - The value to set. */ setSeriesColor(value: CellsColor) : void; /** * @deprecated Please use the 'plotRightToLeft' property instead. * Indicates whether the plot data is right to left. */ getPlotRightToLeft() : boolean; /** * Indicates whether the plot data is right to left. */ plotRightToLeft : boolean; /** * @deprecated Please use the 'plotRightToLeft' property instead. * Indicates whether the plot data is right to left. * @param value - The value to set. */ setPlotRightToLeft(value: boolean) : void; /** * @deprecated Please use the 'lineWeight' property instead. * Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. */ getLineWeight() : number; /** * Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. */ lineWeight : number; /** * @deprecated Please use the 'lineWeight' property instead. * Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. * @param value - The value to set. */ setLineWeight(value: number) : void; /** * @deprecated Please use the 'horizontalAxisColor' property instead. * Gets and sets the color of the horizontal axis in the sparkline group. */ getHorizontalAxisColor() : CellsColor; /** * Gets and sets the color of the horizontal axis in the sparkline group. */ horizontalAxisColor : CellsColor; /** * @deprecated Please use the 'horizontalAxisColor' property instead. * Gets and sets the color of the horizontal axis in the sparkline group. * @param value - The value to set. */ setHorizontalAxisColor(value: CellsColor) : void; /** * @deprecated Please use the 'showHorizontalAxis' property instead. * Indicates whether to show the sparkline horizontal axis. * The horizontal axis appears if the sparkline has data that crosses the zero axis. */ getShowHorizontalAxis() : boolean; /** * Indicates whether to show the sparkline horizontal axis. * The horizontal axis appears if the sparkline has data that crosses the zero axis. */ showHorizontalAxis : boolean; /** * @deprecated Please use the 'showHorizontalAxis' property instead. * Indicates whether to show the sparkline horizontal axis. * The horizontal axis appears if the sparkline has data that crosses the zero axis. * @param value - The value to set. */ setShowHorizontalAxis(value: boolean) : void; /** * @deprecated Please use the 'horizontalAxisDateRange' property instead. * Represents the range that contains the date values for the sparkline data. */ getHorizontalAxisDateRange() : string; /** * Represents the range that contains the date values for the sparkline data. */ horizontalAxisDateRange : string; /** * @deprecated Please use the 'horizontalAxisDateRange' property instead. * Represents the range that contains the date values for the sparkline data. * @param value - The value to set. */ setHorizontalAxisDateRange(value: string) : void; /** * @deprecated Please use the 'verticalAxisMaxValueType' property instead. * Represents the vertical axis maximum value type. */ getVerticalAxisMaxValueType() : SparklineAxisMinMaxType; /** * Represents the vertical axis maximum value type. */ verticalAxisMaxValueType : SparklineAxisMinMaxType; /** * @deprecated Please use the 'verticalAxisMaxValueType' property instead. * Represents the vertical axis maximum value type. * @param value - The value to set. */ setVerticalAxisMaxValueType(value: SparklineAxisMinMaxType) : void; /** * @deprecated Please use the 'verticalAxisMaxValue' property instead. * Gets and sets the custom maximum value for the vertical axis. * * @remarks * If this property is set, will be . */ getVerticalAxisMaxValue() : number; /** * Gets and sets the custom maximum value for the vertical axis. * * @remarks * If this property is set, will be . */ verticalAxisMaxValue : number; /** * @deprecated Please use the 'verticalAxisMaxValue' property instead. * Gets and sets the custom maximum value for the vertical axis. * @param value - The value to set. * * @remarks * If this property is set, will be . */ setVerticalAxisMaxValue(value: number) : void; /** * @deprecated Please use the 'verticalAxisMinValueType' property instead. * Represents the vertical axis minimum value type. */ getVerticalAxisMinValueType() : SparklineAxisMinMaxType; /** * Represents the vertical axis minimum value type. */ verticalAxisMinValueType : SparklineAxisMinMaxType; /** * @deprecated Please use the 'verticalAxisMinValueType' property instead. * Represents the vertical axis minimum value type. * @param value - The value to set. */ setVerticalAxisMinValueType(value: SparklineAxisMinMaxType) : void; /** * @deprecated Please use the 'verticalAxisMinValue' property instead. * Gets and sets the custom minimum value for the vertical axis. * * @remarks * If this property is set, will be . */ getVerticalAxisMinValue() : number; /** * Gets and sets the custom minimum value for the vertical axis. * * @remarks * If this property is set, will be . */ verticalAxisMinValue : number; /** * @deprecated Please use the 'verticalAxisMinValue' property instead. * Gets and sets the custom minimum value for the vertical axis. * @param value - The value to set. * * @remarks * If this property is set, will be . */ setVerticalAxisMinValue(value: number) : void; /** * Resets the data range and location range of the sparkline group. * This method will clear original sparkline items in the group and creates new sparkline items for the new ranges. * @param dataRange - Specifies the new data range of the sparkline group. * @param isVertical - Specifies whether to plot the sparklines from the new data range by row or by column. * @param locationRange - Specifies where the sparklines to be placed. */ resetRanges(dataRange: string, isVertical: boolean, locationRange: CellArea) : void; /** * Sets the custom maximum value for the sparkline vertical axis with the specified axis value type. * @param type - Type that specifies how the axis maximum value is applied. * @param value - Custom maximum value of the vertical axis. /// Ignored if type is not */ setVerticalAxisMaxValue(type: SparklineAxisMinMaxType, value: number) : void; /** * Sets the custom minimum value for the sparkline vertical axis with the specified axis value type. * @param type - Type that specifies how the axis minimum value is applied. * @param value - Custom minimum value of the vertical axis. /// Ignored if type is not */ setVerticalAxisMinValue(type: SparklineAxisMinMaxType, value: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Encapsulates a collection of objects. */ export class SparklineGroupCollection implements Iterable { /** * Gets the element at the specified index. * @param index - The zero based index of the element. * @returns * The element at the specified index. */ get(index: number) : SparklineGroup; /** * Adds an with a to the collection. * @param type - Specifies the type of the Sparkline group. * @returns * object index. */ add(type: SparklineType) : number; /** * Adds an with some to the collection. * @param type - Specifies the type of the Sparkline group. * @param dataRange - Specifies the data range of the sparkline group. * @param isVertical - Specifies whether to plot the sparklines from the data range by row or by column. * @param locationRange - Specifies where the sparklines to be placed. * @returns * object index. * * @remarks * This method will create sparklines too. * If is true, the number of rows in dataRange and locationRange must be same. * If is false, the number of columns in dataRange and locationRange must be same. */ add(type: SparklineType, dataRange: string, isVertical: boolean, locationRange: CellArea) : number; /** * Clears the sparklines that are inside an area of cells. * @param cellArea - Specifies the area of cells * * @remarks * will be removed too if it does not contains any . */ clearSparklines(cellArea: CellArea) : void; /** * Clears the sparkline groups that overlap an area of cells. * @param cellArea - Specifies the area of cells */ clearSparklineGroups(cellArea: CellArea) : void; /** * Gets the number of elements contained in. */ readonly count : number; /** * @deprecated Please use the 'count' property instead. * Gets the number of elements contained in. */ getCount() : number; /** * Checks whether the implementation object is null. */ isNull() : boolean; /** * Returns an iterator over the items in the collection. * Enables use of `for...of`, spread syntax, and `Array.from()`. */ [Symbol.iterator](): Iterator; } /** * Represents the preset style types for sparkline. */ export enum SparklinePresetStyleType { /** * Style 1 */ Style1 = 0, /** * Style 2 */ Style2 = 1, /** * Style 3 */ Style3 = 2, /** * Style 4 */ Style4 = 3, /** * Style 5 */ Style5 = 4, /** * Style 6 */ Style6 = 5, /** * Style 7 */ Style7 = 6, /** * Style 8 */ Style8 = 7, /** * Style 9 */ Style9 = 8, /** * Style 10 */ Style10 = 9, /** * Style 11 */ Style11 = 10, /** * Style 12 */ Style12 = 11, /** * Style 13 */ Style13 = 12, /** * Style 14 */ Style14 = 13, /** * Style 15 */ Style15 = 14, /** * Style 16 */ Style16 = 15, /** * Style 17 */ Style17 = 16, /** * Style 18 */ Style18 = 17, /** * Style 19 */ Style19 = 18, /** * Style 20 */ Style20 = 19, /** * Style 21 */ Style21 = 20, /** * Style 22 */ Style22 = 21, /** * Style 23 */ Style23 = 22, /** * Style 24 */ Style24 = 23, /** * Style 25 */ Style25 = 24, /** * Style 26 */ Style26 = 25, /** * Style 27 */ Style27 = 26, /** * Style 28 */ Style28 = 27, /** * Style 29 */ Style29 = 28, /** * Style 30 */ Style30 = 29, /** * Style 31 */ Style31 = 30, /** * Style 32 */ Style32 = 31, /** * Style 33 */ Style33 = 32, /** * Style 34 */ Style34 = 33, /** * Style 35 */ Style35 = 34, /** * Style 36 */ Style36 = 35, /** * No preset style. */ Custom = 36, } /** * Represents the sparkline types. */ export enum SparklineType { /** * Line sparkline. */ Line = 0, /** * Column sparkline. */ Column = 1, /** * Represents a Win/Loss sparkline. * * @remarks * NOTE: This member is now obsolete. Instead, please use enum. * This property will be removed 12 months later since June 2026. * Aspose apologizes for any inconvenience you may have experienced. * @deprecated * Use SparklineType.WinLoss enum instead. */ Stacked = 2, /** * Represents a Win/Loss sparkline. */ WinLoss = 2, } /** * Represents the options for saving Excel 2003 spreadml file. */ export class SpreadsheetML2003SaveOptions extends SaveOptions { /** * Creates the options for saving Excel 2003 spreadml file. */ constructor(); /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: SaveOptions); /** * Causes child elements to be indented. * * @remarks * The default value is true. * If the value is false, it will reduce the size of the xml file */ isIndentedFormatting : boolean; /** * @deprecated Please use the 'isIndentedFormatting' property instead. * Causes child elements to be indented. * @param value - The value to set. * * @remarks * The default value is true. * If the value is false, it will reduce the size of the xml file */ setIsIndentedFormatting(value: boolean) : void; /** * @deprecated Please use the 'limitAsXls' property instead. * Limit as xls, the max row index is 65535 and the max column index is 255. */ getLimitAsXls() : boolean; /** * Limit as xls, the max row index is 65535 and the max column index is 255. */ limitAsXls : boolean; /** * @deprecated Please use the 'limitAsXls' property instead. * Limit as xls, the max row index is 65535 and the max column index is 255. * @param value - The value to set. */ setLimitAsXls(value: boolean) : void; /** * @deprecated Please use the 'exportColumnIndexOfCell' property instead. * The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. */ getExportColumnIndexOfCell() : boolean; /** * The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. */ exportColumnIndexOfCell : boolean; /** * @deprecated Please use the 'exportColumnIndexOfCell' property instead. * The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. * @param value - The value to set. */ setExportColumnIndexOfCell(value: boolean) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents all built-in style types. */ export enum BuiltinStyleType { /** */ TwentyPercentAccent1 = 30, /** */ TwentyPercentAccent2 = 34, /** */ TwentyPercentAccent3 = 38, /** */ TwentyPercentAccent4 = 42, /** */ TwentyPercentAccent5 = 46, /** */ TwentyPercentAccent6 = 50, /** */ FortyPercentAccent1 = 31, /** */ FortyPercentAccent2 = 35, /** */ FortyPercentAccent3 = 39, /** */ FortyPercentAccent4 = 43, /** */ FortyPercentAccent5 = 47, /** */ FortyPercentAccent6 = 51, /** */ SixtyPercentAccent1 = 32, /** */ SixtyPercentAccent2 = 36, /** */ SixtyPercentAccent3 = 40, /** */ SixtyPercentAccent4 = 44, /** */ SixtyPercentAccent5 = 48, /** */ SixtyPercentAccent6 = 52, /** */ Accent1 = 29, /** */ Accent2 = 33, /** */ Accent3 = 37, /** */ Accent4 = 41, /** */ Accent5 = 45, /** */ Accent6 = 49, /** */ Bad = 27, /** */ Calculation = 22, /** */ CheckCell = 23, /** */ Comma = 3, /** */ Comma1 = 6, /** */ Currency = 4, /** */ Currency1 = 7, /** */ ExplanatoryText = 53, /** */ Good = 26, /** */ Header1 = 16, /** */ Header2 = 17, /** */ Header3 = 18, /** */ Header4 = 19, /** */ Hyperlink = 8, /** */ FollowedHyperlink = 9, /** */ Input = 20, /** */ LinkedCell = 24, /** */ Neutral = 28, /** */ Normal = 0, /** */ Note = 10, /** */ Output = 21, /** */ Percent = 5, /** */ Title = 15, /** */ Total = 25, /** */ WarningText = 11, /** */ RowLevel = 1, /** */ ColumnLevel = 2, } /** * Represents all types of color. */ export class CellsColor { /** * Gets and set the color which should apply to cell or shape. * * @remarks * The expression of the color of the cell and the shape is different. * For example: the theme color with same tint value will be not same in the cell and the shape. */ isShapeColor : boolean; /** * @deprecated Please use the 'isShapeColor' property instead. * Gets and set the color which should apply to cell or shape. * @param value - The value to set. * * @remarks * The expression of the color of the cell and the shape is different. * For example: the theme color with same tint value will be not same in the cell and the shape. */ setIsShapeColor(value: boolean) : void; /** * @deprecated Please use the 'type' property instead. * The color type. */ getType() : ColorType; /** * The color type. */ readonly type : ColorType; /** * @deprecated Please use the 'themeColor' property instead. * Gets the theme color. Only applies for theme color type. */ getThemeColor() : ThemeColor; /** * Gets the theme color. Only applies for theme color type. */ themeColor : ThemeColor; /** * @deprecated Please use the 'themeColor' property instead. * Gets the theme color. Only applies for theme color type. * @param value - The value to set. */ setThemeColor(value: ThemeColor) : void; /** * @deprecated Please use the 'colorIndex' property instead. * Gets and sets the color index in the color palette. Only applies of indexed color. */ getColorIndex() : number; /** * Gets and sets the color index in the color palette. Only applies of indexed color. */ colorIndex : number; /** * @deprecated Please use the 'colorIndex' property instead. * Gets and sets the color index in the color palette. Only applies of indexed color. * @param value - The value to set. */ setColorIndex(value: number) : void; /** * @deprecated Please use the 'color' property instead. * Gets and sets the RGB color. */ getColor() : Color; /** * Gets and sets the RGB color. */ color : Color; /** * @deprecated Please use the 'color' property instead. * Gets and sets the RGB color. * @param value - The value to set. */ setColor(value: Color) : void; /** * @deprecated Please use the 'argb' property instead. * Gets and sets the color from a 32-bit ARGB value. */ getArgb() : number; /** * Gets and sets the color from a 32-bit ARGB value. */ argb : number; /** * @deprecated Please use the 'argb' property instead. * Gets and sets the color from a 32-bit ARGB value. * @param value - The value to set. */ setArgb(value: number) : void; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear). */ getTransparency() : number; /** * Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear). */ transparency : number; /** * @deprecated Please use the 'transparency' property instead. * Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear). * @param value - The value to set. */ setTransparency(value: number) : void; /** * Set the tint of the shape color * @param tint - */ setTintOfShapeColor(tint: number) : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the axis type. */ export enum AxisType { /** * Category axis */ Category = 0, /** * Value axis */ Value = 1, /** * Series axis */ Series = 2, } /** * Represents the category axis type. */ export enum CategoryType { /** * AutomaticScale */ AutomaticScale = 0, /** * CategoryScale */ CategoryScale = 1, /** * TimeScale */ TimeScale = 2, } /** * Represents the axis cross type. */ export enum CrossType { /** * Microsoft Excel sets the axis crossing point. */ Automatic = 0, /** * The axis crosses at the maximum value. */ Maximum = 1, /** * The axis crosses at the minimum value. */ Minimum = 2, /** * The axis crosses at the custom value. */ Custom = 3, } /** * Encapsulates the object that represents the plot area in a chart. */ export class PlotArea extends ChartFrame { /** * Constructs from a parent object convertible to this. * @param obj - The parent object. */ constructor(obj: ChartFrame); /** * Gets or sets the x coordinate of the upper left corner of the plot-area bounding box in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When X is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.XRatioToChart property, instead. */ getX() : number; /** * Gets or sets the x coordinate of the upper left corner of the plot-area bounding box in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When X is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.XRatioToChart property, instead. */ setX(value: number) : void; /** * Gets or sets the y coordinate of the upper top corner of the plot-area bounding box in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Y is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.YRatioToChart property, instead. */ getY() : number; /** * Gets or sets the y coordinate of the upper top corner of the plot-area bounding box in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Y is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.YRatioToChart property, instead. */ setY(value: number) : void; /** * Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Height is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.HeightRatioToChart property, instead. */ getHeight() : number; /** * Gets or sets the height of plot-area bounding box in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Height is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.HeightRatioToChart property, instead. */ setHeight(value: number) : void; /** * Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Width is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.WidthRatioToChart property, instead. */ getWidth() : number; /** * Gets or sets the width of plot-area bounding box in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When Width is set, the IsInnerMode property will be automatically set to false. * @deprecated * Use PlotArea.WidthRatioToChart property, instead. */ setWidth(value: number) : void; /** * @deprecated Please use the 'innerX' property instead. * Gets or sets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerX is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerXRatioToChart property, instead. */ getInnerX() : number; /** * Gets or sets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerX is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerXRatioToChart property, instead. */ innerX : number; /** * @deprecated Please use the 'innerX' property instead. * Gets or sets the x coordinate of the upper top corner of plot area in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerX is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerXRatioToChart property, instead. */ setInnerX(value: number) : void; /** * @deprecated Please use the 'innerY' property instead. * Gets or sets the x coordinate of the upper top corner of the plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerY is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerYRatioToChart property, instead. */ getInnerY() : number; /** * Gets or sets the x coordinate of the upper top corner of the plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerY is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerYRatioToChart property, instead. */ innerY : number; /** * @deprecated Please use the 'innerY' property instead. * Gets or sets the x coordinate of the upper top corner of the plot area in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerY is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerYRatioToChart property, instead. */ setInnerY(value: number) : void; /** * @deprecated Please use the 'innerHeight' property instead. * Gets or sets the height of the plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerHeight is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerHeightRatioToChart property, instead. */ getInnerHeight() : number; /** * Gets or sets the height of the plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerHeight is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerHeightRatioToChart property, instead. */ innerHeight : number; /** * @deprecated Please use the 'innerHeight' property instead. * Gets or sets the height of the plot area in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerHeight is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerHeightRatioToChart property, instead. */ setInnerHeight(value: number) : void; /** * @deprecated Please use the 'innerWidth' property instead. * Gets or sets the width of plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerWidth is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerWidthRatioToChart property, instead. */ getInnerWidth() : number; /** * Gets or sets the width of plot area in units of 1/4000 of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerWidth is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerWidthRatioToChart property, instead. */ innerWidth : number; /** * @deprecated Please use the 'innerWidth' property instead. * Gets or sets the width of plot area in units of 1/4000 of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The X, Y, Width and Height of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* Note: When InnerWidth is set, the IsInnerMode property will be automatically set to True. * @deprecated * Use PlotArea.InnerWidthRatioToChart property, instead. */ setInnerWidth(value: number) : void; /** * Gets or sets the x coordinate of the upper left corner of the plot area bounding box as a ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* XPixel = XRatioToChart * chart.ChartObject.Width. * Note: When XRatioToChart is set, the IsInnerMode property will be automatically set to false. */ getXRatioToChart() : number; /** * Gets or sets the x coordinate of the upper left corner of the plot area bounding box as a ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* XPixel = XRatioToChart * chart.ChartObject.Width. * Note: When XRatioToChart is set, the IsInnerMode property will be automatically set to false. */ setXRatioToChart(value: number) : void; /** * Gets or sets the y coordinate of the upper top corner of the plot-area bounding box as a ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* YPixel = YRatioToChart * chart.ChartObject.Width. * Note: When YRatioToChart is set, the IsInnerMode property will be automatically set to false. */ getYRatioToChart() : number; /** * Gets or sets the y coordinate of the upper top corner of the plot-area bounding box as a ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* YPixel = YRatioToChart * chart.ChartObject.Width. * Note: When YRatioToChart is set, the IsInnerMode property will be automatically set to false. */ setYRatioToChart(value: number) : void; /** * Gets or sets the height of the plot area bounding box in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* HeightPixel = HeightRatioToChart * chart.ChartObject.Width. * Note: When HeightRatioToChart is set, the IsInnerMode property will be automatically set to false. */ getHeightRatioToChart() : number; /** * Gets or sets the height of the plot area bounding box in units of the ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* HeightPixel = HeightRatioToChart * chart.ChartObject.Width. * Note: When HeightRatioToChart is set, the IsInnerMode property will be automatically set to false. */ setHeightRatioToChart(value: number) : void; /** * Gets or sets the width of plot-area bounding box in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* WidthPixel = WidthRatioToChart * chart.ChartObject.Width. * Note: When WidthRatioToChart is set, the IsInnerMode property will be automatically set to false. */ getWidthRatioToChart() : number; /** * Gets or sets the width of plot-area bounding box in units of the ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* WidthPixel = WidthRatioToChart * chart.ChartObject.Width. * Note: When WidthRatioToChart is set, the IsInnerMode property will be automatically set to false. */ setWidthRatioToChart(value: number) : void; /** * @deprecated Please use the 'innerXRatioToChart' property instead. * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerX in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerXRatioToChart is set, the IsInnerMode property will be automatically set to True. */ getInnerXRatioToChart() : number; /** * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerX in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerXRatioToChart is set, the IsInnerMode property will be automatically set to True. */ innerXRatioToChart : number; /** * @deprecated Please use the 'innerXRatioToChart' property instead. * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerX in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerXRatioToChart is set, the IsInnerMode property will be automatically set to True. */ setInnerXRatioToChart(value: number) : void; /** * @deprecated Please use the 'innerYRatioToChart' property instead. * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerY in Pixel = InnerYRatioToChart * chart.ChartObject.Width. * Note: When InnerYRatioToChart is set, the IsInnerMode property will be automatically set to True. */ getInnerYRatioToChart() : number; /** * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerY in Pixel = InnerYRatioToChart * chart.ChartObject.Width. * Note: When InnerYRatioToChart is set, the IsInnerMode property will be automatically set to True. */ innerYRatioToChart : number; /** * @deprecated Please use the 'innerYRatioToChart' property instead. * Gets or gets the x coordinate of the upper top corner of plot area in units of the ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerY in Pixel = InnerYRatioToChart * chart.ChartObject.Width. * Note: When InnerYRatioToChart is set, the IsInnerMode property will be automatically set to True. */ setInnerYRatioToChart(value: number) : void; /** * @deprecated Please use the 'innerHeightRatioToChart' property instead. * Gets or sets the height of plot area in units of ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerHeight in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerHeightRatioToChart is set, the IsInnerMode property will be automatically set to True. */ getInnerHeightRatioToChart() : number; /** * Gets or sets the height of plot area in units of ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerHeight in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerHeightRatioToChart is set, the IsInnerMode property will be automatically set to True. */ innerHeightRatioToChart : number; /** * @deprecated Please use the 'innerHeightRatioToChart' property instead. * Gets or sets the height of plot area in units of ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerHeight in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerHeightRatioToChart is set, the IsInnerMode property will be automatically set to True. */ setInnerHeightRatioToChart(value: number) : void; /** * @deprecated Please use the 'innerWidthRatioToChart' property instead. * Gets or sets the width of the plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerWidth in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerWidthRatioToChart is set, the IsInnerMode property will be automatically set to True. */ getInnerWidthRatioToChart() : number; /** * Gets or sets the width of the plot area in units of the ratio of the chart area. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerWidth in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerWidthRatioToChart is set, the IsInnerMode property will be automatically set to True. */ innerWidthRatioToChart : number; /** * @deprecated Please use the 'innerWidthRatioToChart' property instead. * Gets or sets the width of the plot area in units of the ratio of the chart area. * @param value - The value to set. * * @remarks *

The plot-area bounding box includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If the value is not created by MS Excel, please call Chart.Calculate() method before calling this method.

*

The XRatioToChart, YRatioToChart, WidthRatioToChart and HeightRatioToChart of PlotArea represents the plot-area * bounding box that includes the plot area, tick marks(tick labels), and a small border around the tick marks. * If you want to get actual size of plot area, you should call InnerXRatioToChart, InnerYRatioToChart, InnerWidthRatioToChart and * InnerHeightRatioToChart properties.

*

For excel 2007 or latter, the default value is zero. you should call get the value after calling Chart.Calculate().

* InnerWidth in Pixel = InnerXRatioToChart * chart.ChartObject.Width. * Note: When InnerWidthRatioToChart is set, the IsInnerMode property will be automatically set to True. */ setInnerWidthRatioToChart(value: number) : void; /** * Indicates whether the plot area is automatically sized. * * @remarks * NOTE: When IsAutomaticSize is set to True, the values you manually set for Width and Height will be disabled. */ isAutomaticSize() : boolean; /** * Indicates whether the plot area is automatically sized. * @param value - The value to set. * * @remarks * NOTE: When IsAutomaticSize is set to True, the values you manually set for Width and Height will be disabled. */ setIsAutomaticSize(value: boolean) : void; /** * Set the position of the plot area to automatic */ setPositionAuto() : void; /** * Checks whether the implementation object is null. */ isNull() : boolean; } /** * Represents the base unit for the category axis. */ export enum TimeUnit { /** * Days */ Days = 0, /** * Months */ Months = 1, /** * Years */ Years = 2, } /** * Represents all color type */ export enum ColorType { /** * Automatic color. */ Automatic = 0, /** * It's automatic color,but the displayed color depends the setting of the OS System. * * @remarks * Not supported. */ AutomaticIndex = 1, /** * The RGB color. */ RGB = 2, /** * The color index in the color palette. */ IndexedColor = 3, /** * The theme color. */ Theme = 4, } /** * Represents the master differential formatting records. */ export class DxfCollection implements Iterable